Conventions

Conventions

Package Contents

Documentation

HTML documentation

Terms

Terms and spelling

ModelicaCode

Modelica code

UsersGuide

User's Guide

Icons

Icon design

Information

This information is part of the Modelica Standard Library maintained by the Modelica Association.

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

  1. Conventions of the Modelica code
  2. Consistent HTML documentation
  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 simple partial interface models.
    • BaseClasses containing partial models with physical equations other than trivial and balance equations.
    • Types containing type, enumeration and choice definitions.
  4. These packages should appear in the listed order.