Skip to content

Commit

Permalink
Based on review.
Browse files Browse the repository at this point in the history
  • Loading branch information
HansOlsson committed Mar 16, 2021
1 parent 991023b commit 461be2c
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,12 @@ \subsection{Annotations for Figures}\label{annotations-for-figures}
described in \cref{variable-replacements}, can be used in the
\lstinline!title! of \lstinline!Figure! and \lstinline!Plot!.

The \lstinline!identifier! in \lstinline!Figure! and \lstinline!Plot! is an optional \lstinline!String! identifier, and is intended to identify the
\lstinline!Figure! and \lstinline!Plot! for programmatic access. The \lstinline!figures! annotation is inherited in the sense that each class has
a collection of figures comprised by the contents of the \lstinline!figures! annotation in the class itself, as well as the \lstinline!figures! annotations
from any base classes. A \lstinline!Figure! must be uniquely identified by its \lstinline!identifier! and a class having it in its collection. This
means that a \lstinline!Figure! \lstinline!identifier! must be unique among all \lstinline!Figure! annotations within the same \lstinline!figures!
annotation as well as among all \lstinline!figures! annotations from inherited classes. A \lstinline!Plot! \lstinline!identifier! on the other hand
is only required to be unique among the \lstinline!plots! in the the same \lstinline!Figure! annotation.
If the identifier is an empty string it cannot be used for programmatic access and is exempt from the uniqueness requirement.
The \lstinline!identifier! in \lstinline!Figure! and \lstinline!Plot! is a \lstinline!String! identifier, and is intended to identify the \lstinline!Figure! and \lstinline!Plot! for programmatic access.
The \lstinline!figures! annotation is inherited in the sense that each class has a collection of figures comprised by the contents of the \lstinline!figures! annotation in the class itself, as well as the \lstinline!figures! annotations from any base classes.
A \lstinline!Figure! must be uniquely identified by its \lstinline!identifier! and a class having it in its collection.
This means that a \lstinline!Figure! \lstinline!identifier! must be unique among all \lstinline!Figure! annotations within the same \lstinline!figures! annotation as well as among all \lstinline!figures! annotations from inherited classes.
A \lstinline!Plot! \lstinline!identifier! on the other hand is only required to be unique among the \lstinline!plots! in the the same \lstinline!Figure! annotation.
If the identifier is an empty string it cannot be used for programmatic access and is exempt from the uniqueness requirements.

\begin{nonnormative}
For \lstinline!Figure!, this makes it possible to reference the plot from a
Expand Down

0 comments on commit 461be2c

Please sign in to comment.