Skip to content

Commit

Permalink
Use cleveref.sty instead of \autoref
Browse files Browse the repository at this point in the history
  • Loading branch information
@henrikt-ma
henrikt-ma committed Jul 7, 2020
1 parent 7de7439 commit 03a40f0
Show file tree
Hide file tree
Showing 26 changed files with 791 additions and 785 deletions.
2 changes: 1 addition & 1 deletion chapters/abstract.tex
View file
Expand Up @@ -47,7 +47,7 @@
or omissions is assumed.

The contributors to this and to previous versions of this document are
listed in \autoref{modelica-revision-history}. All contributors worked voluntarily and without
listed in \cref{modelica-revision-history}. All contributors worked voluntarily and without
compensation.

\tableofcontents
42 changes: 21 additions & 21 deletions chapters/annotations.tex
View file
Expand Up @@ -4,12 +4,12 @@ \chapter{Annotations}\doublelabel{annotations}
Annotations are intended for storing extra information about a model,
such as graphics, documentation or versioning, etc. A Modelica tool is
free to define and use other annotations, in addition to those defined
here, according to \autoref{vendor-specific-annotations}. The only requirement is that any tool
here, according to \cref{vendor-specific-annotations}. The only requirement is that any tool
shall save files with all annotations from this chapter and all
vendor-specific annotations intact. To ensure this, annotations must be
represented with constructs according to the Modelica grammar (for
replaceable class declarations with a constraining-clause also refer to
\autoref{constraining-clause-annotations}). The specification in this document defines the
\cref{constraining-clause-annotations}). The specification in this document defines the
semantic meaning if a tool implements any of these annotations.

\section{Vendor-Specific Annotations}\doublelabel{vendor-specific-annotations}
Expand Down Expand Up @@ -53,9 +53,9 @@ \section{Annotations for Documentation}\doublelabel{annotations-for-documentatio
tags \lstinline!<HTML>! and \lstinline!</HTML>! or
\lstinline!<html>! and \lstinline!</html>! define
optionally begin and end of content that is HTML encoded. For external
links see \autoref{external-resources}. Links to Modelica classes may be defined with
links see \cref{external-resources}. Links to Modelica classes may be defined with
the HTML link command using scheme \lstinline!Modelica!
(using its lower case form in the URI, see \autoref{external-resources}), e.g.,
(using its lower case form in the URI, see \cref{external-resources}), e.g.,
\begin{lstlisting}[language=modelica]
<a href="modelica://MultiBody.Tutorial">MultiBody.Tutorial</a>
\end{lstlisting}
Expand Down Expand Up @@ -436,7 +436,7 @@ \subsubsection{Coordinate Systems}\doublelabel{coordinate-systems}
\item
The coordinate systems of the first base-class where the extent on the
extends-clause specifies a null-region (if any). Note that null-region
is the default for base-classes, see \autoref{extends-clause}.
is the default for base-classes, see \cref{extends-clause}.
\item
The default coordinate system CoordinateSystem(extent=\{\{-100,
-100\}, \{100, 100\}\}).
Expand Down Expand Up @@ -508,7 +508,7 @@ \subsubsection{Graphical Properties}\doublelabel{graphical-properties}
P\textsubscript{34} and P\textsubscript{4}.

The values of the \lstinline!EllipseClosure! enumeration specify if and how the
endpoints of an elliptical arc are to be joined (see \autoref{ellipse} Ellipse).
endpoints of an elliptical arc are to be joined (see \cref{ellipse} Ellipse).

\begin{lstlisting}[language=modelica]
type Arrow = enumeration(None, Open, Filled, Half);
Expand Down Expand Up @@ -592,7 +592,7 @@ \subsection{Component Instance}\doublelabel{component-instance}

\subsection{Extends clause}\doublelabel{extends-clause}

Each extends-clause (and short-class-definition, as stated in \autoref{annotations-for-graphical-objects})
Each extends-clause (and short-class-definition, as stated in \cref{annotations-for-graphical-objects})
may have layer specific annotations which describe
the rendering of the base class' icon and diagram layers in the
subclass.
Expand All @@ -618,7 +618,7 @@ \subsection{Extends clause}\doublelabel{extends-clause}
default), the base class contents is mapped to the same coordinates in
the derived class, and the coordinate system (including
preserveAspectRatio) can be inherited as described in
\autoref{coordinate-systems}.
\cref{coordinate-systems}.
\item
If the extent of the extends-clause defines a non-null region, the
base class coordinate system is mapped to the region specified by the
Expand Down Expand Up @@ -907,7 +907,7 @@ \subsubsection{Bitmap}\doublelabel{bitmap}

When the attribute \lstinline!fileName! is specified, the string refers to an
external file containing image data. The mapping from the string to the
file is specified for some URIs in \autoref{external-resources}. The supported file
file is specified for some URIs in \cref{external-resources}. The supported file
formats include \lstinline!PNG!, \lstinline!BMP!, \lstinline!JPEG!,
and \lstinline!SVG!.

Expand Down Expand Up @@ -1083,7 +1083,7 @@ \section{Annotations for the Graphical User Interface}\doublelabel{annotations-f

When an \lstinline!outer! component of the class does not have a corresponding \lstinline!inner!
component, the literal string message may be used as part of a diagnostic message (together with appropriate context), see
\autoref{instance-hierarchy-name-lookup-of-inner-declarations}.
\cref{instance-hierarchy-name-lookup-of-inner-declarations}.

\begin{example}
\begin{lstlisting}[language=modelica]
Expand Down Expand Up @@ -1216,7 +1216,7 @@ \section{Annotations for the Graphical User Interface}\doublelabel{annotations-f
annotation should be useable both for vectors of Integers and Reals).

The annotation \lstinline!groupImage! references an image using an URI (see
\autoref{external-resources}), and the image is intended to be shown together with the
\cref{external-resources}), and the image is intended to be shown together with the
parameter-group (only one image per group is supported). Disabling the
input field will not disable the image.

Expand Down Expand Up @@ -1477,7 +1477,7 @@ \subsection{Version Handling}\doublelabel{version-handling}
to-tag is missing this is the \lstinline!CURRENT-VERSION-NUMBER!) of the current
class by applying the given conversion rules. The script consists of
an unordered sequence of \lstinline!conversionRule();! (and optionally Modelica
comments). The \lstinline!conversionRule! functions are defined in \autoref{conversion-rules}.
comments). The \lstinline!conversionRule! functions are defined in \cref{conversion-rules}.

\begin{nonnormative}
The to-tag is added for clarity and optionally allows a tool to convert in multiple steps.
Expand Down Expand Up @@ -1539,7 +1539,7 @@ \subsubsection{Conversion rules}\doublelabel{conversion-rules}
\end{nonnormative}

These functions can be called with literal strings or array of strings
and vectorize according to \autoref{scalar-functions-applied-to-array-arguments}.
and vectorize according to \cref{scalar-functions-applied-to-array-arguments}.

All of these convert-functions only use inheritance among user
models, and not in the library that is used for the conversion -- thus
Expand Down Expand Up @@ -1817,7 +1817,7 @@ \subsection{Version Date and Build Information}\doublelabel{version-date-and-bui
\begin{itemize}
\item
\lstinline!version! is the version number of the released library,
see \autoref{version-handling}.
see \cref{version-handling}.
\item
\lstinline!versionDate! is the date in UTC format (according to ISO
8601) when the library was released. This string is updated by the
Expand Down Expand Up @@ -1937,13 +1937,13 @@ \subsection{Protection of Classes}\doublelabel{protection-of-classes}
\lstinline!Access.icon!\\
The class can be instantiated and public parameter, constant, input,
output variables as well as public connectors can be accessed, as well
as the icon annotation, as defined in \autoref{annotations-for-graphical-objects} (the declared
as the icon annotation, as defined in \cref{annotations-for-graphical-objects} (the declared
information of these elements can be shown). Additionally, the class
name and its description text can be accessed.
\item
\lstinline!Access.documentation!\\
Same as \lstinline!Access.icon! and additionally the documentation annotation (as
defined in \autoref{annotations-for-documentation}) can be accessed. HTML-generation in the
defined in \cref{annotations-for-documentation}) can be accessed. HTML-generation in the
documentation annotation is normally performed before encryption, but
the generated HTML is intended to be used with the encrypted package.
Thus the HTML-generation should use the same access as the encrypted
Expand Down Expand Up @@ -2151,20 +2151,20 @@ \section{Annotations for Functions}\doublelabel{annotations-for-functions}

\subsection{Function Derivative Annotations}\doublelabel{function-derivative-annotations}

See \autoref{using-the-derivative-annotation}
See \cref{using-the-derivative-annotation}

\subsection{Inverse Function Annotation}\doublelabel{inverse-function-annotation}

See \autoref{declaring-inverses-of-functions}.
See \cref{declaring-inverses-of-functions}.

\subsection{External Function Annotations}\doublelabel{external-function-annotations}

See \autoref{annotations-for-external-libraries-and-include-files}.
See \cref{annotations-for-external-libraries-and-include-files}.

\section{Annotation Choices for Modifications and Redeclarations}\doublelabel{annotation-choices-for-modifications-and-redeclarations}

See \autoref{annotation-choices-for-suggested-redeclarations-and-modifications}.
See \cref{annotation-choices-for-suggested-redeclarations-and-modifications}.

\section{Annotation for External Libraries and Include Files}\doublelabel{annotation-for-external-libraries-and-include-files}

See \autoref{annotations-for-external-libraries-and-include-files}.
See \cref{annotations-for-external-libraries-and-include-files}.

0 comments on commit 03a40f0

Please sign in to comment.