Note, in the html documentation of any Modelica library, the headings "h1, h2, h3" should not be used, because they are utilized from the automatically generated documentation/headings. Additional headings in the html documentation should start with "h4".
In the Modelica package the following conventions are used:
- Class and instance names are written in upper and lower case
letters, e.g., "ElectricCurrent". An underscore is only used
at the end of a name to characterize a lower or upper index,
- Class names start always with an upper case letter.
- Instance names, i.e., names of component instances and
of variables (with the exception of constants),
start usually with a lower case letter with only
a few exceptions if this is common sense
(such as "T" for a temperature variable).
- Constant names, i.e., names of variables declared with the
"constant" prefix, follow the usual naming conventions
(= upper and lower case letters) and start usually with an
upper case letter, e.g. UniformGravity, SteadyState.
- The two connectors of a domain that have identical declarations
and different icons are usually distinguished by "_a", "_b"
or "_p", "_n", e.g., Flange_a/Flange_b, HeatPort_a, HeatPort_b.
- The instance name of a component is always displayed in its icon
(= text string "%name") in blue color. A connector class has the instance
name definition in the diagram layer and not in the icon layer.
Parameter values, e.g., resistance, mass, gear ratio, are displayed
in the icon in black color in a smaller font size as the instance name.
- A main package has usually the following subpackages:
- UsersGuide containing an overall description of the library and how to use it.
- Examples containing models demonstrating the usage of the library.
- Interfaces containing connectors and partial models.
- Types containing type, enumeration and choice definitions.