escet issueshttps://gitlab.eclipse.org/eclipse/escet/escet/-/issues2024-03-26T13:05:43Zhttps://gitlab.eclipse.org/eclipse/escet/escet/-/issues/793Add ESCET logo to ESCET IDE launchers for Linux and macOS2024-03-26T13:05:43ZDennis HendriksAdd ESCET logo to ESCET IDE launchers for Linux and macOSWe added it for the Windows launcher in #791.
Next steps:
* [ ] For Linux, we need an XPM icon. Add the icon to the `misc/escet-logo` folder and to the product.
* [ ] For macOS, we need an ICNS icon. Add the icon to the `misc/escet-logo...We added it for the Windows launcher in #791.
Next steps:
* [ ] For Linux, we need an XPM icon. Add the icon to the `misc/escet-logo` folder and to the product.
* [ ] For macOS, we need an ICNS icon. Add the icon to the `misc/escet-logo` folder and to the product.
Both should contain the ESCET logo in various resolutions.
See also:
* https://gitlab.eclipse.org/eclipse/escet/escet/-/merge_requests/840#note_1986938 for how it looks on Windows.
* https://gitlab.eclipse.org/eclipse/escet/escet/-/merge_requests/840#note_1986935 for the formats the Windows icon contains.
* https://gitlab.eclipse.org/eclipse/escet/escet/-/merge_requests/840#note_1986942 for some ideas on which tools to use to make the icons for Linux/macOS.https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/748Eclipse ESCET IDE help only partially honors stylesheets2024-01-27T13:31:15ZDennis HendriksEclipse ESCET IDE help only partially honors stylesheetsEclipse ESCET general toolkit documentation on the website:
![website](/uploads/121b9d43a58c2928a90431dac558014d/website.png)
Eclipse ESCET general toolkit documentation in the Eclipse ESCET IDE. Notice the lack of yellow colors, but t...Eclipse ESCET general toolkit documentation on the website:
![website](/uploads/121b9d43a58c2928a90431dac558014d/website.png)
Eclipse ESCET general toolkit documentation in the Eclipse ESCET IDE. Notice the lack of yellow colors, but the presence of the external link icon (both are in our custom CSS styling):
![ecilpse-help-in-eclipse](/uploads/2745d4de102ef513eb5744bc79cd6122/ecilpse-help-in-eclipse.png)
Eclipse ESCET general toolkit documentation in the browser, but served by the local server running in Eclipse, the same one that shows the help within Eclipse. Notice the yellow colors, etc:
![eclipse-help-in-browser](/uploads/241db872afb1de61e5ecf33c549282f2/eclipse-help-in-browser.png)
I don't know what is causing this problem. It may or may not be the same cause as for #722.https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/722Eclipse ESCET IDE help rendering broken on Windows 112024-03-10T15:33:03ZDennis HendriksEclipse ESCET IDE help rendering broken on Windows 11I get the following for our v2.0-RC1 release on Windows 11:
![image](/uploads/be054d882335d89256e8b5741bfe06d4/image.png)
A colleague pointed out to me that there may be an issue with the Eclipse internal browser. Apparently it refuses...I get the following for our v2.0-RC1 release on Windows 11:
![image](/uploads/be054d882335d89256e8b5741bfe06d4/image.png)
A colleague pointed out to me that there may be an issue with the Eclipse internal browser. Apparently it refuses to load scripts and style sheets.https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/721Show build id and progress on ESCET IDE splash screen2024-03-14T08:35:21ZDennis HendriksShow build id and progress on ESCET IDE splash screenWe do not currently show the progress on the splash screen. We also do not show the build id.
Splash screen documentation, including showing progress information:
* Some basic information: https://www.davidpace.de/adding-custom-splash-s...We do not currently show the progress on the splash screen. We also do not show the build id.
Splash screen documentation, including showing progress information:
* Some basic information: https://www.davidpace.de/adding-custom-splash-screens-for-eclipse-products/
* Some official documentation: https://wiki.eclipse.org/Platform-releng/Updating_Branding
Information about showing the build id:
* Example: https://git.eclipse.org/c/platform/eclipse.platform.git/tree/platform/org.eclipse.sdk/plugin_customization.ini
* Forum post: https://www.eclipse.org/forums/index.php/t/164911/https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/720ESCET startup screen upside down on macOS 14 (Sonoma)2023-12-21T22:03:48ZMartijn GoordenESCET startup screen upside down on macOS 14 (Sonoma)When starting up ESCET, the [splash image](product/org.eclipse.escet.product.branding/splash.bmp) is shown before the pop-up window asking for the workspace. After choosing an appropriate workspace, this splash image is shown again until...When starting up ESCET, the [splash image](product/org.eclipse.escet.product.branding/splash.bmp) is shown before the pop-up window asking for the workspace. After choosing an appropriate workspace, this splash image is shown again until the full Eclipse window is shown. (If a default workspace is selected, still two splash windows are used by Eclipse.)
On my MacBook Pro, the second splash image is shown upside down (mirrored along x-axis) and inappropriately cropped.
![Screenshot_2023-12-21_at_11.16.28](/uploads/a6de96a9e9b6c161d90865c56e3f467f/Screenshot_2023-12-21_at_11.16.28.png)
I get this behavior for all ESCET versions all the way back to v0.2. And my suspicion is that this is Eclipse platform related.https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/662Exit code 23 and 24 should not restart command line applications2023-10-12T10:54:57ZDennis HendriksExit code 23 and 24 should not restart command line applicationsThis behavior was introduced when fixing our command line scripts in !656 for #89. The special handling of exit codes 23 and 24 is a feature of the Eclipse launcher. We asked about disabling this special handling on the Equinox forum: ht...This behavior was introduced when fixing our command line scripts in !656 for #89. The special handling of exit codes 23 and 24 is a feature of the Eclipse launcher. We asked about disabling this special handling on the Equinox forum: https://www.eclipse.org/forums/index.php/mn/msg/1113735/1/on/0/?SQ=8c6bc00c7709967220cd9710cad81cc8. Ideally, we get a way to disable it, such that we can always return the proper exit code, and not have some exit codes restart the application.https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/38Improve AsciiDoc-generated documentation HTML style2024-03-10T08:30:02ZDennis HendriksImprove AsciiDoc-generated documentation HTML styleWe now generate multi-page HTML from HTML files generated by AsciiDoctor (#36). We want to improve the HTML style of the generated HTML pages:
* [ ] Custom stylesheet:
* [x] Make a custom AsciiDoctor stylesheet, based on the default A...We now generate multi-page HTML from HTML files generated by AsciiDoctor (#36). We want to improve the HTML style of the generated HTML pages:
* [ ] Custom stylesheet:
* [x] Make a custom AsciiDoctor stylesheet, based on the default AsciiDoctor stylesheet. (!750)
* [ ] Style it more like the ESCET website:
* [x] Switch to sans serif font. (!750)
* [ ] Ensure the chosen font makes it easy to distinguish l/1, 0/O, etc.
* [x] Give the different docsets a color scheme more similar to their corresponding website. (!750)
* [x] Fix styling issues:
* [x] Literal text in tables doesn't have a gray background as outside tables. (!750)
* [x] Fix `kbd` style issue (#395). (!750)
* [ ] Styling improvements:
* [~] No section anchor links in HTML output, even though enabled. (was solved a while ago)
* [~] Reduce the large vertical spacing between lines, especially for code blocks. (doesn't seem present anymore)
* [~] Use slightly darker code block background to make it pop out a bit more. (doesn't seem needed anymore)
* [~] Link style in general could be improved. (no idea anymore what was meant here)
* [~] Justify text. (tried it, but it looks ugly)
* [~] Improve table style. (no idea anymore what was meant here)
* [x] Hover over code block shows e.g. 'CHI' in capitals. (!750)
* [ ] Let browser decide column widths. Use `\[%autowidth.stretch\]` or `\[%autowidth\]` for tables (not recognized by docbook converter used for PDF generation). Or, just override the column width with CSS to be automatic.
* [x] Distinguish internal vs external links. (!750)
* [x] Don't wrap code blocks, but show a scrollbar instead. Do still wrap inline literal text. (!750)
* [x] Improve `menu` and `btn` macro styles. (!750)
* [x] TOC structure/styling improvements:
* [x] Put a symbol before each TOC item. The current indentation doesn't make it very clear what are different pages, especially with longer and wrapping section names. (!750)
* [x] Make TOC interactive with collapse/expand (fold/unfold) interactivity. The current TOC of the CIF documentation is very long, so navigating is becomes cumbersome and users use page search to find things. Going to another page you lose where you are. It is then cumbersome to go to a sibling page, for instance. (!750)
* [x] Fix TOC highlighting and expanding for current section on a page (rather than the entire page). (!759)
* [x] Fix TOC links for virtual sections (non-page, non-section ones). They are wrappers only in the TOC. Not actual sections on the pages themselves. Typically they are italic/bold texts, with or without an id to link to. (!761)
* [x] Ensure that virtual TOC entries are taken into account for breadcrumbs. (!763)
* [x] Animate TOC collapse/expand. (!767)
* [x] Generated JS code needs a license header. (!794)
* [x] Syntax highlighting: (#740)
* [~] Enable syntax highlighting, for built-in languages. (was solved a while ago)
* [x] Enable syntax highlighting, for Eclipse ESCET languages, so syntax coloring for Chi, CIF, SeText, ToolDef, console, SVG, BNF, etc.
* [ ] PDF styling:
* [ ] Reconsider whether we want to keep the PDF output at all. Does anybody use it? It takes a long time to render during builds.
* [ ] Enable PDF section numbers for all sections, even though not in the TOC (for all levels).
* [ ] Let PDF renderer decide table column widths by itself.
* [ ] Use recommended syntax highlighter, Rouge. See also #740.
* [x] Code improvements:
* [x] `AsciiDocHtmlModifier` has two times `Renamed` that should be `Rename` in comments. (!768)
**Old ideas**
* **Bootstrap theme**
* *Old text*:
The idea would be to base the documentation on [Bootstrap](https://getbootstrap.com/) if possible, to match the static website pages. It is also generally nicer and more modern. We could look whether there are any AsciiDoc Bootstrap-based themes/styles.
The approach could be to:
* First switch to a new theme/style.
* And then fine-tune that global style to our own liking. These can happen incrementally, with one or a few changes per branch. E.g., adding syntax highlighting can be separate from table styles, for instance.
This would be in line with https://gitlab.eclipse.org/eclipse/escet/escet/-/issues/373#note_828292.
* *Rejected*:
I investigated this, but the AsciiDoctor skins that are based on Bootstrap don't have a TOC, etc. I think it is better to stay close to the default theme, but customize that to be more like the ESCET website. I've experimented with this over the past days, and it works quite well.
* **Inspiration other websites**
* *Old text*:
Some inspiration can be obtained here:
* https://cstweb.wtb.tue.nl/4tc00/index.html
* https://cstweb.wtb.tue.nl/cif/trunk-r9682/lang/tut/index.html (no longer online)
Also, compare styling to old Sphinx/RST HTML styling.
* *Rejected*:
The new idea is to take inspiration from the ESCET website itself. And from online sources, but not necessarily only the ones listed here.
* **Official Eclipse fonts**
* *Old text*:
Eclipse officially uses Libre Franklin as website font, see https://www.eclipse.org/legal/documents/eclipse_foundation_branding_guidelines.pdf
* *Rejected*:
We don't have to use the same font. It is probably best to stick with a well-known universally-used webfont, that renders similarly across platforms and browsers.
* **Deeper nested headings**
* *Old text*:
Currently no styling for 'h7' to 'h9' tags (we have no h10). Only 'h1' through 'h6' are official HTML and have styling. Not needed if we do multi-HTML output first.
* *Rejected*:
AsciiDoc and HTML don't support 'h7' and further'. Also, we don't need it anymore, as we have multi-page HTML now.
* **Old TOC ideas**
* *Old text*:
Bootstrap seems to support folding nav sidebars, see e.g. https://getbootstrap.com/docs/5.1/components/navs-tabs/. Not sure whether this requires completely generating different HTML from the AsciiDoc sources or not.
Ensure that for longer TOCs and with multi-html page output (see #36) the TOC scrolls to the currently visible HTML page. And maybe even to the correct section.
* *Rejected*:
The idea is not to use Bootstrap anymore. Scrolling is not necessary if the TOC is by default collapsed except for the 'trail' to the currently shown page. Then the TOC is so short that it fits on most screens most of the time, as there are not many root items, and the expanded items are not that numerous.