Skip to content

Documentation in the application on mouse over

Here's below a proposition for generating a structured documentation of the GUI directly both accessible in the GUI and in the documentation.

I propose that help text can be display on mouse over on texts on which an help is available. I see that the i18n files are nested objects structuring the translated labels. This structure can also be used for structuring the GUI documentation.

I propose to add a "HELP" section at the root of the i18n file, and, if we want to have a mouse hover help, for example, on the displayed message SIDENAV.RESET_SESSION in the GUI, we create a message HELP.SIDENAV.RESET_SESSION.

In the Angular code, we can maybe create our own TranslateService service inheriting from the Angular one, and overwrite the translate method. This method, instead of returning only the translated terms, could return the translation embedded in a <span> tag containing a popover or a mouse hover function displaying the text grabbed from HELP.xxx if this latter exists in the i18n file.

For the documentation part, I propose to use Quarto for generating the documentation. This technology allows to generate the doc in HTML and PDF for variety of sources. The documentation could be directly generated by browsing the HELP.xxx structured data in i18n files. This task should be described and done in another issue once the documentation will be started.