Skip to content

Commit

Permalink
More systematic use of \lstinline for figure annotations Axis and Curve
Browse files Browse the repository at this point in the history
Also fixing some issues with missing punctuation.
  • Loading branch information
henrikt-ma committed Feb 15, 2021
1 parent bd035cc commit f005ac0
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -173,9 +173,10 @@ \subsubsection{Axis Properties}\label{axis-properties}

If a tool does not recognize the \lstinline!unit!, it is recommended to issue a warning and treat the \lstinline!unit! as if it was empty, as well as ignore any setting for \lstinline!min! and \lstinline!max!.

When an axis label isn't provided, the tool produces a default label. Providing the empty string as axis label means that no label should be shown. Variable replacements, as described in
\cref{variable-replacements}, can be used in the \lstinline!label! of \lstinline!Axis! The Modelica tool is responsible for showing the unit used for values at the axis tick marks, so the axis
\lstinline!label! shall not contain the unit.
When \lstinline!label! isn't provided, the tool produces a default label.
Providing the empty string as \lstinline!label! means that no label should be shown.
Variable replacements, as described in \cref{variable-replacements}, can be used in \lstinline!label!.
The Modelica tool is responsible for showing the unit used for values at the axis tick marks, so the axis \lstinline!label! shall not contain the unit.

\subsubsection{Plot Curves}\label{plot-curves}

Expand All @@ -192,11 +193,9 @@ \subsubsection{Plot Curves}\label{plot-curves}
It is an error if \lstinline!x! or \lstinline!y! does not designate a scalar variable.
When the \lstinline!unit! of an \lstinline!Axis! is non-empty, it is an error if the unit of the corresponding \lstinline!Curve! expression (i.e., a variable's \lstinline!unit!, or second for \lstinline!time!) is incompatible with the axis unit.

When \lstinline!legend! isn't provided, the tool produces a default based on
\lstinline!x! and/or \lstinline!y!. Providing the empty string as
\lstinline!legend! means that the curve shall be omitted from the plot legend.
Variable replacements, as described in \cref{variable-replacements}, can be
used in the \lstinline!legend! of \lstinline!Curve!
When \lstinline!legend! isn't provided, the tool produces a default based on \lstinline!x! and/or \lstinline!y!.
Providing the empty string as \lstinline!legend! means that the curve shall be omitted from the plot legend.
Variable replacements, as described in \cref{variable-replacements}, can be used in \lstinline!legend!.

\subsubsection{Escape sequences}\label{text-markup-escape-sequences}

Expand Down

0 comments on commit f005ac0

Please sign in to comment.