Skip to content
Merged
Show file tree
Hide file tree
Changes from 76 commits
Commits
Show all changes
80 commits
Select commit Hold shift + click to select a range
b68df7d
Avoid use of \texttt in arrays.tex
henrikt-ma Jun 1, 2020
694794c
Avoid use of \texttt in connectors.tex
henrikt-ma Jun 1, 2020
ade428d
Avoid use of \texttt in functions.tex
henrikt-ma Jun 1, 2020
a48d597
Avoid use of \texttt in stream.tex
henrikt-ma Jun 1, 2020
97e9d1b
Restore list of inequalities in 'Every solution of the implicit equat…
henrikt-ma Jun 2, 2020
470724d
Rewrite sequence of inequalities in a more compact and less confusing…
henrikt-ma Jun 2, 2020
adb76ee
Say 'greater than' instead of '>' at border of text and math
henrikt-ma Jun 2, 2020
12e5f46
Say just 'inStream' instead of 'the inStream operator'
henrikt-ma Jun 2, 2020
adb0972
Cleanup some formatting of math in derivationofstream.tex
henrikt-ma Jun 2, 2020
2bcbe16
Use align* instead of eqnarray*
henrikt-ma Jun 2, 2020
e923755
More rephrasing of operator mentions
henrikt-ma Jun 2, 2020
5d9fa9d
Don't use \textbf directly for glossary items
henrikt-ma Jun 2, 2020
b59318d
More operator mentions
henrikt-ma Jun 2, 2020
5d74a8e
Remove some empty lines at the bottom of tables
henrikt-ma Jun 2, 2020
9e3eb85
Remove inconsistent use of \textbf in dae.tex
henrikt-ma Jun 2, 2020
862d926
Avoid \textbf for starting examples
henrikt-ma Jun 2, 2020
16f659f
Apply some math formatting
henrikt-ma Jun 2, 2020
ca5afe9
Remove empty parentheses that don't mean empty parentheses
henrikt-ma Jun 2, 2020
19dec4e
Avoid \textbf when showing syntax of connect-equation
henrikt-ma Jun 2, 2020
53d8c7d
Change one \textbf into \lstinline
henrikt-ma Jun 2, 2020
8907459
Don't use text escape with \textbf inside lstlisting
henrikt-ma Jun 2, 2020
d00b7cd
Minor cleanup of ellipsis
henrikt-ma Jun 2, 2020
35874f6
Minor style improvement inside code listing comment
henrikt-ma Jun 3, 2020
7d466da
Customize 'description' environment so that \item style can replace d…
henrikt-ma Jun 3, 2020
1d34f0e
Remove unnecessary use of \textbf for itemize items
henrikt-ma Jun 3, 2020
f3efe1f
Fix formatting of definition of 'cat'
henrikt-ma Jun 3, 2020
e9a451c
Fix latexml issue with \neq in \lstinline math
henrikt-ma Jun 3, 2020
29aec56
Replace \textbf with \firstuse when making definitions for 'Protectio…
henrikt-ma Jun 3, 2020
b984de6
Remove unused one-off arguments to lstlisting, including emphstyle=\t…
henrikt-ma Jun 3, 2020
a790321
Remove some misplaced paragraph breaks right before itemize environments
henrikt-ma Jun 3, 2020
b9bbf28
Avoid use of \textbf in revisions.tex, using some \emph instead
henrikt-ma Jun 3, 2020
009ff7e
Use \emph rather than \textbf to put emphasis on 'not'
henrikt-ma Jun 3, 2020
4c1b9cb
Get rid of some redundant parentheses just filled with dots
henrikt-ma Jun 3, 2020
27b450d
Introduce \bibitemtitle to replace \textbf for titles in the bibliogr…
henrikt-ma Jun 3, 2020
1d14b07
Replace some \textbf in tables with \tablehead
henrikt-ma Jun 3, 2020
d780a86
Remove stray non-normative closing bracket
henrikt-ma Jun 3, 2020
f3277e4
Use \emph instead of \textbf on 'shall not'
henrikt-ma Jun 3, 2020
b2b83d0
Remove more parentheses with only dots inside
henrikt-ma Jun 3, 2020
5c6e174
Move period out of \lstinline
henrikt-ma Jun 3, 2020
ecc6111
Replace lots of \textbf with \lstinline
henrikt-ma Jun 3, 2020
28f3c60
Remove \textbf from two cases where no special formatting fits
henrikt-ma Jun 7, 2020
cc46a8e
Fix some formatting of examples and nonnormative content in tables
henrikt-ma Jun 7, 2020
a1290c5
Use \firstuse instead of \textbf when introducing base clock partitio…
henrikt-ma Jun 7, 2020
7d68fbd
Remove \textbf on 'active' where it is neither introduced nor deservi…
henrikt-ma Jun 7, 2020
4a979d8
Use \tablehead instead of \textbf for some kind of table title
henrikt-ma Jun 7, 2020
3e94d51
Replace \textbf by \firstuse when terms are introduced in tables
henrikt-ma Jun 7, 2020
9e19079
Use item list instead of beginning each semiLinear rule with \textbf{…
henrikt-ma Jun 7, 2020
b0548ba
Introduce \numbereddefinition instead of \textbf for numbered definit…
henrikt-ma Jun 7, 2020
2ce6fa1
Use item list instead of \textbf for the only 'Proposition' there is
henrikt-ma Jun 7, 2020
a6e2871
Remove \textbf on the single restriction that has it in a list of five
henrikt-ma Jun 7, 2020
7d24d5d
Remove exaggerated emphasis with \textbf in equation/variable balance…
henrikt-ma Jun 7, 2020
5889480
Remove use of enumitem.sty to fix continuous integration builds
henrikt-ma Jun 7, 2020
9d8f0dd
Fix strange uses of \emph for external objects
henrikt-ma Jun 12, 2020
0edfe79
Fix hybrid DAE discrete-time Real equation
henrikt-ma Jun 12, 2020
670478f
Don't use function name subscripts formatted as variable names
henrikt-ma Jun 12, 2020
9aa9b3c
Rewrite to avoid starting sentence with 'homotopy'
henrikt-ma Jun 12, 2020
a9f34b9
Fix issues found when looking for un-protected in-sentence periods
henrikt-ma Jun 12, 2020
e143772
Change one instance of incorrect use of math into \lstinline
henrikt-ma Jun 16, 2020
32f8c4f
Fix misc styling of array reductions
henrikt-ma Jun 16, 2020
6f85e67
Misc style cleanup of matrix and vector algebra functions and constru…
henrikt-ma Jun 16, 2020
a1c6a50
Add missing math styling on array concatenation helper variables
henrikt-ma Jun 16, 2020
bf340da
Clean up so-called "formal" definition of array concatenation
henrikt-ma Jun 16, 2020
3c4dd00
Set belowskip=0pt for code listings
henrikt-ma Jun 16, 2020
223d09f
Remove some excess space
henrikt-ma Jun 16, 2020
59e5204
Use math also for the 'x1' and 'x2' of linspace
henrikt-ma Jun 17, 2020
319b786
Remove asymmetric paragraph break in table
henrikt-ma Jun 17, 2020
7047859
Insert comma after 'that is'
henrikt-ma Jun 17, 2020
572d1a9
Add escape around 'and' that's considered natural language
henrikt-ma Jun 17, 2020
d56fd72
Lots of more or less font markup related fixes to chapter 'Arrays'
henrikt-ma Jun 17, 2020
91e5dfb
Merge branch 'master' into cleanup/font-markup
henrikt-ma Jun 17, 2020
d7a838d
Fix LaTeXML problems with unbalanced parentheses/brackets in math
henrikt-ma Jun 17, 2020
531dd8c
Minor cleanup or range operator
henrikt-ma Jun 17, 2020
2c10df2
Remove ':' at end of section headings
henrikt-ma Jun 17, 2020
5699472
Merge remote-tracking branch 'central/master' into cleanup/font-markup
henrikt-ma Jun 18, 2020
7cbb535
Try to remove lstinline from section names
HansOlsson Jun 11, 2020
984b2a4
And no math in section-headings
HansOlsson Jun 11, 2020
df1a917
Rewrite paragraph on lookup in import clasuses to improve readability…
henrikt-ma Jun 18, 2020
4e3fdda
Re-write the list of possible import clause forms as suggested by Hans
henrikt-ma Jun 18, 2020
19f9ce0
Reflow some lines on import clauses
henrikt-ma Jun 18, 2020
601c5fd
Fix em-dash/comma mismatch
henrikt-ma Jun 18, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 24 additions & 28 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,6 @@ \section{Annotations for Code Generation}\doublelabel{annotations-for-code-gener
the output should generate an event when it changes.
\end{nonnormative}
\\ \hline

\end{longtable}
\begin{lstlisting}[language=grammar]
smoothOrder-annotation:
Expand All @@ -240,7 +239,7 @@ \section{Annotations for Code Generation}\doublelabel{annotations-for-code-gener
\begin{nonnormative}
This means that the function is at least C\textsuperscript{smoothOrder}. \lstinline!smoothOrder = 1! means that
the function can be differentiated at least once in order that all output arguments are still continuous, provided
the input arguments are continuous. If a tool needs the derivative of a function, e.g. for index reduction or to
the input arguments are continuous. If a tool needs the derivative of a function, e.g.\ for index reduction or to
compute an analytic Jacobian, the function can be differentiated analytically at least \lstinline!smoothOrder! times.
\end{nonnormative}

Expand Down Expand Up @@ -341,7 +340,7 @@ \section{Annotations for Graphical Objects}\doublelabel{annotations-for-graphica
\end{nonnormative}

These Icon, Diagram, and Documentation annotations are only allowed
directly in classes (e.g. not on components or connections). The allowed
directly in classes (e.g.\ not on components or connections). The allowed
annotations for a short class definition is the union of the allowed
annotations in classes and on extends-clauses.

Expand Down Expand Up @@ -395,7 +394,7 @@ \subsubsection{Coordinate Systems}\doublelabel{coordinate-systems}
application may use a different default value of \lstinline!initialScale!.

The attribute \lstinline!grid! specifies the spacing between grid points which can
be used by tools for alignment of points in the coordinate system, e.g. ``snap-to-grid''.
be used by tools for alignment of points in the coordinate system, e.g.\ ``snap-to-grid''.
Its use and default value is tool-dependent.

\begin{lstlisting}[language=modelica]
Expand All @@ -412,7 +411,7 @@ \subsubsection{Coordinate Systems}\doublelabel{coordinate-systems}
\begin{lstlisting}[language=modelica]
CoordinateSystem(extent = {{-10, -10}, {10, 10}});
\end{lstlisting}
i.e. a coordinate system with width 20 units and height 20 units.
i.e.\ a coordinate system with width 20 units and height 20 units.
\end{example}

The coordinate systems for the icon and diagram layers are by default
Expand Down Expand Up @@ -666,7 +665,7 @@ \subsection{Connections}\doublelabel{connections1}
connection line. It has the following definition (\emph{it is not equal
to the Text-primitive as part of graphics -- the differences are marked as bold lines}):
% NOTE: Technically just the names - not the entire lines are marked in bold
\begin{lstlisting}[language=modelica,escapechar=!,emph={horizontalAlignment,string,index}, emphstyle=\textbf]
\begin{lstlisting}[language=modelica]
record Text
extends GraphicItem;
extends FilledShape;
Expand Down Expand Up @@ -862,7 +861,7 @@ \subsubsection{Text}\doublelabel{text}
\item
\%\% replaced by \%
\item
\%name replaced by the name of the component (i.e. the identifier for
\%name replaced by the name of the component (i.e.\ the identifier for
it in in the enclosing class).
\item
\%class replaced by the name of the class (only the last part of the hierarchical name).
Expand Down Expand Up @@ -1129,7 +1128,7 @@ \section{Annotations for the Graphical User Interface}\doublelabel{annotations-f
definition of "structurally inconsistent" see the article:
\href{http://epubs.siam.org/doi/abs/10.1137/0909014}{Pantelides C.C.:
The Consistent Initialization of Differential-Algebraic Systems, SIAM
J. Sci. and Stat. Comput. Volume 9, Issue 2, pp. 213--231 (March
J.\ Sci.\ and Stat.\ Comput.\ Volume 9, Issue 2, pp. 213--231 (March
1988)}}. A "default connection" is constructed by instantiating the
respective \lstinline!model! or \lstinline!block! and for every input \lstinline!u! providing an equation
\lstinline!0=f(u)!, and for every (potential,flow) pair of the form \lstinline!(v,i)!, providing
Expand Down Expand Up @@ -1539,7 +1538,7 @@ \subsubsection{Conversion rules}\doublelabel{conversion-rules}
corresponding to the old version.

\begin{nonnormative}
Whenever possible tools should preserve the original style of the model, e.g. use of imports.
Whenever possible tools should preserve the original style of the model, e.g.\ use of imports.
\end{nonnormative}

These functions can be called with literal strings or array of strings
Expand All @@ -1550,7 +1549,7 @@ \subsubsection{Conversion rules}\doublelabel{conversion-rules}
conversions of base-classes will require multiple conversion-calls; this
ensures that the conversion is independent of the new library structure.
The class-name used as argument to \lstinline!convertElement! and \lstinline!convertModifiers!
is similarly the old name of the class, i.e. the name before it is
is similarly the old name of the class, i.e.\ the name before it is
possibly converted by \lstinline!convertClass!.

\begin{nonnormative}
Expand Down Expand Up @@ -1588,7 +1587,7 @@ \subsubsection{Conversion rules}\doublelabel{conversion-rules}

The old element should be of a \lstinline!Boolean!, \lstinline!Integer!, \lstinline!String!, or enumeration
type and the match is based on the literal value of the modifier.
For string elements the value argument to \lstinline!convertClassIf! shall be up-quoted, e.g. \lstinline!"\"My String\""!,
For string elements the value argument to \lstinline!convertClassIf! shall be up-quoted, e.g.\ \lstinline!"\"My String\""!,
and for enumeration literals only the enumeration literal part of the old value matters, e.g., \lstinline!red!
for \lstinline!"Colors.red"!.

Expand Down Expand Up @@ -1689,7 +1688,7 @@ \subsubsection{Conversion rules}\doublelabel{conversion-rules}
connector \lstinline!B! is connected, there will be a parameter for enabling connector \lstinline!B!, and the conversion ensures that
each component of model \lstinline!A! will have this parameter set accordingly.

In case a parameter is simply renamed it is preferable to use \lstinline!convertElement!, since that also handles e.g. binding equations
In case a parameter is simply renamed it is preferable to use \lstinline!convertElement!, since that also handles e.g.\ binding equations
using the parameter.
\end{nonnormative}

Expand Down Expand Up @@ -1852,7 +1851,7 @@ \subsection{Version Date and Build Information}\doublelabel{version-date-and-bui
\end{nonnormative}
\item
\lstinline!revisionId! is a tool specific revision identifier
possibly generated by a source code management system (e.g. Subversion
possibly generated by a source code management system (e.g.\ Subversion
or CVS). This information allows to exactly identify the library
source code in the source code management system.
\end{itemize}
Expand Down Expand Up @@ -1892,32 +1891,29 @@ \section{Annotations for Access Control to Protect Intellectual Property}\double
different encryption formats.
\end{nonnormative}

\textbf{Definitions:}
Definitions:
\begin{longtable}[]{|p{2.5cm}|p{12cm}|}
\hline
\tablehead{Term} & \tablehead{Description}\\ \hline
\endhead
\textbf{Protection} & Define what parts of a class are visible.\\
\firstuse{Protection} & Define what parts of a class are visible.\\
\hline
\textbf{Obfuscation} & Changing a Modelica class or generated code so that it is difficult to inspect by a user
(e.g. by automatically renaming variables to non-meaningful names).\\
\firstuse{Obfuscation} & Changing a Modelica class or generated code so that it is difficult to inspect by a user
(e.g.\ by automatically renaming variables to non-meaningful names).\\
\hline
\textbf{Encryption} & Encoding of a model or a package in a form so that
\firstuse{Encryption} & Encoding of a model or a package in a form so that
the modeler cannot inspect any content of a class without an appropriate
key. An encrypted package that has the \lstinline!Protection! annotation is
read-only; the way to modify it is to generate a new encrypted version.\\
\hline
\textbf{Licensing} & Restrict the use of an encrypted package for particular users for a specified period of time.\\
\firstuse{Licensing} & Restrict the use of an encrypted package for particular users for a specified period of time.\\
\hline

\end{longtable}

In this section annotations are defined for protection and
licensing. Obfuscation and encryption are not standardized.
protection and licensing are both defined inside the
\lstinline!Protection! annotation:
\begin{lstlisting}[language=modelica]
annotation(Protection(...));
In this section annotations are defined for protection and licensing. Obfuscation and encryption are not standardized.
Protection and licensing are both defined inside the \lstinline!Protection! annotation:
\begin{lstlisting}[language=modelica,mathescape=true]
annotation(Protection($\ldots$));
\end{lstlisting}

\subsection{Protection of Classes}\doublelabel{protection-of-classes}
Expand Down Expand Up @@ -1969,7 +1965,7 @@ \subsection{Protection of Classes}\doublelabel{protection-of-classes}
the class, or part of the class, can be copied.
\item
\lstinline!Access.packageText!\\
Same as \lstinline!Access.diagram! (note: \textbf{not} including all rights of
Same as \lstinline!Access.diagram! (note: \emph{not} including all rights of
\lstinline!Access.nonPackageDuplicate!) and additionally the whole class
definition can be accessed (but that text cannot be copied, i.e., you can see but not copy the source code).
\item
Expand Down Expand Up @@ -2090,7 +2086,7 @@ \subsection{Licensing}\doublelabel{licensing}

record License
String licensee ="" "Optional string to show information about the licensee";
String id[:] "Unique machine identifications, e.g. MAC addresses";
String id[:] "Unique machine identifications, e.g.\ MAC addresses";
String features[:] =fill("", 0) "Activated library license features";
String startDate ="" "Optional start date in UTCformat YYYY-MM-DD";
String expirationDate="" "Optional expiration date in UTCformat YYYY-MM-DD";
Expand Down
Loading