Integrate html documentation directly in the library

changed milestone to %ThermoSysPro v4.1

added UX/UI enhancement labels

added Phimeca label

Markdown could also be used for documentation in models in recent Dymola versions (since 2023x?). In case Markdown is chosen, it has to be checked:

• Whether it is or will be supported by OpenModelica.
• Whether the Markdown implementation in Dymola (and OpenModelica) supports the present content format of the documentation of ThermoSysPro (tables...).

Tables, equations and figures (relative modelica path to be used: "modelica://ThermoSysPro/...") are supported by Dymola (at least 2024x).

There are some advances on the OpenModelica support :

Markdown support in documentation rendering of OMEdit · Issue #9284 · OpenModelica/OpenModelica (github.com)

Maybe (as noted in the OpenModelica issue), it will be part of Modelica specifications in the future...

changed milestone to %ThermoSysPro v4.2

For information, the documentation of the following model is properly displayed in recent versions of Dymola, including equations, tables and images (the file image.png is located in the package directory Test_image and referenced via a Modelica relative URl):

within Test_image;
model Test_markdown

  annotation (Documentation(info="# Markdown test model

Model to test Markdown documentation

## First points 

### Some maths

The *main* equation would be: \\\\(W_{TH}=\\alpha S(T_1-T_2)\\\\)

If you want to give it **more** importance (centered on its own line):

$$W_{TH}=hS(T_1-T_2)$$

### Some tables

Parameters | Description | Unit
---: | :--- | :---:
 \\\\(\\alpha\\\\) | Coefficient | \\\\(W/m^2K\\\\)
S | Exchange surface |\\\\(m^2\\\\)


## Some images

Using a *Modelica* relative path

![Test image](modelica://Test_image/image.png)

", revisions="First Trial
"));
end Test_markdown;

This example can be used to develop documentation in ThermoSysPro components.