Skip to content

Commit

Permalink
Move nonnormative content regarding 'revisions' to separate paragraph
Browse files Browse the repository at this point in the history
This is just the first of many similar changes to come.  This commit mainly serves to populate the cleanup/nonnormative branch with some changes so that a pull request can be initiated.

Note that even this first change fixes a language syntax issue in addition that was missed due to the nonnormative content being in the middle of a paragraph.
  • Loading branch information
henrikt-ma committed Apr 22, 2020
1 parent c836805 commit 356c139
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ \section{Annotations for Documentation}\doublelabel{annotations-for-documentatio
\end{lstlisting}
The \lstinline!Documentation! annotation can contain the \lstinline!info! annotation
giving a textual description, the \lstinline!revisions! annotation giving a list
of revisions and other annotations defined by a tool {[}\emph{The
\lstinline!revisions! documentation may be omitted in printed documentation}{]}.
of revisions and other annotations defined by a tool.
How the tool interprets the information in \lstinline!Documentation! is
unspecified. Within a string of the \lstinline!Documentation! annotation, the
tags \lstinline!<HTML>! and \lstinline!</HTML>! or
Expand All @@ -61,6 +60,10 @@ \section{Annotations for Documentation}\doublelabel{annotations-for-documentatio
<a href="modelica://MultiBody.Tutorial">MultiBody.Tutorial</a>
\end{lstlisting}

\begin{nonnormative}
The \lstinline!revisions! documentation may be omitted in printed documentation.
\end{nonnormative}

Together with scheme \lstinline!Modelica! the (URI) fragment specifiers
\lstinline!#diagram!, \lstinline!#info!, \lstinline!#text!, \lstinline!#icon! may be used to reference different
layers. User-defined fragment specifiers (anchors) may also be used, and they may be renamed
Expand Down

0 comments on commit 356c139

Please sign in to comment.