.Modelica.UsersGuide.Conventions

Information

A Modelica main package should be compliant with the UsersGuide stated in this documentation:

1. Conventions of the Modelica code
2. Consistent HTML documentation UsersGuide
3. Structure to be provided by a main package
   • User's Guide
   • Examples containing models demonstrating the usage of the library.
   • Components -- in case of a complex library a more detailed structure can be established.
   • Sensors
   • Sources
   • Interfaces containing connectors and partial models.
   • Types containing type, enumeration and choice definitions.
4. These packages should appear in the listed order.

Contents

Name	Description
Documentation	HTML documentation
Terms	Terms and spelling
ModelicaCode	Modelica code
UsersGuide	User's Guide
Icons	Icon design