.Modelica.UsersGuide.Conventions.Documentation.Format.Code

Information

Modelica code conventions of class and instance names, parameters and variables are specified separately. In this section it is summarized how to refer to Modelica code in the HTML documentation.

1. For constants, parameters and variables in code segments <code> and </code> should to be used, e.g.,
   parameter Modelica.Units.SI.Time tStart "Start time"
2. Write multi or single line code segments as quoted preformatted text, i.e., embedded within <blockquote><pre> and </pre></blockquote> tags.
3. Multi line or single line code shall not be additionally indented.
4. Inline code segments may be typeset with <code> and </code>.
5. In code segments use bold to emphasize Modelica keywords.

Examples

Example 1

<blockquote><pre>
<strong>connector</strong> Frame
   ...
   <strong>flow</strong> SI.Force f[3] <strong>annotation</strong>(unassignedMessage="...");
<strong>end</strong> Frame;
</pre></blockquote>

appears as

connector Frame
   ...
   flow SI.Force f[3] annotation(unassignedMessage="...");
end Frame;

Example 2

<blockquote><pre>
<strong>parameter</strong> Modelica.Units.SI.Conductance G=1 "Conductance";
</pre></blockquote>

appears as

parameter Modelica.Units.SI.Conductance G=1 "Conductance";