Skip to content

Commit

Permalink
Use the nonnormative macro
Browse files Browse the repository at this point in the history
  • Loading branch information
otronarp committed Feb 11, 2020
1 parent bae3410 commit d996f3f
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,14 @@ \subsection{Annotations for Figures\doublelabel{annotations-for-figures}}
optional, and is intended for programmatic access. An \lstinline!identifier!
must be unique within the class containing the \lstinline!figures! annotation,
without considering whether it belongs to \lstinline!Figure! or
\lstinline!Plot!. {[}\emph{For \lstinline!Figure!, this makes it possible to
reference the plot from a tool-specific scripting environment. For \lstinline!Plot!, this makes it possible to reference
the plot in the figure caption, which becomes useful when the \lstinline!Figure!
contains more than one \lstinline!Plot!.}{]}
\lstinline!Plot!.

\begin{nonnormative}
For \lstinline!Figure!, this makes it possible to reference the plot from a
tool-specific scripting environment. For \lstinline!Plot!, this makes it
possible to reference the plot in the figure caption, which becomes useful when
the \lstinline!Figure! contains more than one \lstinline!Plot!.
\end{nonnormative}

Every \lstinline!Plot! has an automatically generated \emph{label} which is
required to be shown as soon as at least one \lstinline!Plot! in the
Expand Down Expand Up @@ -231,13 +235,15 @@ \subsubsection{Text Markup in Captions}\doublelabel{text-markup-in-captions}
The styling of the link text and the link action is left for each Modelica tool
to decide.

{[}\emph{For example,} \lstinline!%(inertia1.w)! \emph{could be displayed as the text
\begin{nonnormative}
For example, \lstinline!%(inertia1.w)! could be displayed as the text
\lstinline!inertia1.w! formatted with upright monospaced font, and have a pop-up
menu attached with menu items for plotting the variable, setting its start
value, or investigating the equation system from which it is solved. On the
other hand,} \lstinline!%[angular velocity](inertia1.w)! \emph{could be formatted in
other hand, \lstinline!%[angular velocity](inertia1.w)! could be formatted in
the same style as the surrounding text, except some non-intrusive visual clue
about it being linked.}{]}
about it being linked.
\end{nonnormative}

A sequence of one or more newlines (encoded either literally or using the \lstinline!\n!
escape sequence) means a paragraph break. (A line break within a paragraph is
Expand Down

0 comments on commit d996f3f

Please sign in to comment.