From 4026dd6a00533e12d25b423fb3987ed3d9540f49 Mon Sep 17 00:00:00 2001 From: Henrik Tidefelt Date: Fri, 10 Dec 2021 15:17:20 +0100 Subject: [PATCH 1/3] Call the preferredView string the 'view' --- chapters/annotations.tex | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/chapters/annotations.tex b/chapters/annotations.tex index 29114fcba..05a5389ce 100644 --- a/chapters/annotations.tex +++ b/chapters/annotations.tex @@ -1130,11 +1130,11 @@ \section{Annotations for the Graphical User Interface}\label{annotations-for-the This section describes the annotations that are used to define properties of the graphical user interface. \begin{lstlisting}[language=modelica] -annotation(preferredView = $\mathit{layer}$) +annotation(preferredView = $\mathit{view}$) \end{lstlisting} The \fmtannotationindex{preferredView} annotation defines the default view when selecting the class. -The $\mathit{layer}$ is a \lstinline!String! literal where \lstinline!"info"! means information layer, i.e., the documentation of the class, \lstinline!"diagram"! means diagram layer, \lstinline!"icon" means icon layer, and \lstinline!"text"! means the Modelica text layer. +The $\mathit{view}$ is a \lstinline!String! literal where \lstinline!"info"! means class documentation, \lstinline!"diagram"! means class diagram, \lstinline!"icon" means class icon, and \lstinline!"text"! means Modelica source code. \begin{lstlisting}[language=grammar] documentation-class-annotation: From a383bf751a5c0b26a417b149acd63ab710655c3d Mon Sep 17 00:00:00 2001 From: Henrik Tidefelt Date: Fri, 10 Dec 2021 15:38:23 +0100 Subject: [PATCH 2/3] Add alternative reading of 'info' --- chapters/annotations.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/annotations.tex b/chapters/annotations.tex index 05a5389ce..c38bd98b9 100644 --- a/chapters/annotations.tex +++ b/chapters/annotations.tex @@ -1134,7 +1134,7 @@ \section{Annotations for the Graphical User Interface}\label{annotations-for-the \end{lstlisting} The \fmtannotationindex{preferredView} annotation defines the default view when selecting the class. -The $\mathit{view}$ is a \lstinline!String! literal where \lstinline!"info"! means class documentation, \lstinline!"diagram"! means class diagram, \lstinline!"icon" means class icon, and \lstinline!"text"! means Modelica source code. +The $\mathit{view}$ is a \lstinline!String! literal where \lstinline!"info"! means class documentation (``information''), \lstinline!"diagram"! means class diagram, \lstinline!"icon" means class icon, and \lstinline!"text"! means Modelica source code. \begin{lstlisting}[language=grammar] documentation-class-annotation: From 9422b47b4f050cb420b004d4a7aa9e00863e7911 Mon Sep 17 00:00:00 2001 From: Henrik Tidefelt Date: Fri, 10 Dec 2021 16:30:02 +0100 Subject: [PATCH 3/3] Re-introduce repetition Addressing feedback from Hans. --- chapters/annotations.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/annotations.tex b/chapters/annotations.tex index c38bd98b9..59eac5729 100644 --- a/chapters/annotations.tex +++ b/chapters/annotations.tex @@ -1134,7 +1134,7 @@ \section{Annotations for the Graphical User Interface}\label{annotations-for-the \end{lstlisting} The \fmtannotationindex{preferredView} annotation defines the default view when selecting the class. -The $\mathit{view}$ is a \lstinline!String! literal where \lstinline!"info"! means class documentation (``information''), \lstinline!"diagram"! means class diagram, \lstinline!"icon" means class icon, and \lstinline!"text"! means Modelica source code. +The $\mathit{view}$ is a \lstinline!String! literal where \lstinline!"info"! means class documentation (``information''), \lstinline!"diagram"! means diagram view, \lstinline!"icon" means icon view, and \lstinline!"text"! means Modelica source code (``text''). \begin{lstlisting}[language=grammar] documentation-class-annotation: