Skip to content

Shorten identifier for two reasons #3685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Shorten identifier for two reasons #3685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c1522ae
Shorten identifier for two reasons:
HansOlsson May 5, 2025
c6f92b3
Merge branch 'master' into HTMLLayout2
HansOlsson May 9, 2025
6b2f943
ChangeToTopPackage
HansOlsson May 14, 2025
62d4f4a
Merge
HansOlsson May 14, 2025
7df7799
NonIt
HansOlsson May 14, 2025
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
2 changes: 1 addition & 1 deletion chapters/annotations.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2548,7 +2548,7 @@ \subsection{Licensing}\label{licensing}

\section{License Texts}\label{license-texts}

For a top-level class the {\lstinline!annotation(License="modelica:/ModelicaLibraryName/Resources/Licenses/MyLicense.txt")!}\annotationindex{License}, gives a license text file for the class.
For a top-level class the {\lstinline!annotation(License="modelica:/TopPackage/Resources/Licenses/MyLicense.txt")!}\annotationindex{License}, gives a license text file for the class.
The annotation may give a scalar string or an array of strings, where each string is a URI referencing a license text file, see \cref{external-resources}.
The license text files are human-readable files containing the license conditions.
If the annotation specifies an array of license text files the conditions in all of them must be satisfied (i.e., it is not intended for dual-licensing).
Expand Down
10 changes: 5 additions & 5 deletions chapters/functions.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2233,10 +2233,10 @@ \subsection{Annotations for External Functions}\label{annotations-for-external-l
\end{itemize}
\end{nonnormative}
\item
The {\lstinline!annotation(IncludeDirectory="modelica:/ModelicaLibraryName/Resources/Include")!}\annotationindex{IncludeDirectory}, used to specify a location for header files.
The {\lstinline!annotation(IncludeDirectory="modelica:/TopPackage/Resources/Include")!}\annotationindex{IncludeDirectory}, used to specify a location for header files.
The preceding one is the default and need not be specified; but another location could be specified by using an URI name for the include directory, see \cref{external-resources}.
\item
The {\lstinline!annotation(LibraryDirectory="modelica:/ModelicaLibraryName/Resources/Library")!}\annotationindex{LibraryDirectory}, used to specify a location for library files.
The {\lstinline!annotation(LibraryDirectory="modelica:/TopPackage/Resources/Library")!}\annotationindex{LibraryDirectory}, used to specify a location for library files.
The preceding one is the default and need not be specified; but another location could be specified by using an URI name for the library directory, see \cref{external-resources}.
Different versions of one object library can be provided (e.g., for Windows and for Linux) by providing a \emph{platform} directory below the {\lstinline!LibraryDirectory!}.
If no platform directory is present, the object library must be present in the {\lstinline!LibraryDirectory!}.
Expand All @@ -2252,11 +2252,11 @@ \subsection{Annotations for External Functions}\label{annotations-for-external-l
{\lstinline!"linux64"!} (Linux Intel 64 bit)
\end{itemize}
\item
The {\lstinline!annotation(SourceDirectory="modelica:/ModelicaLibraryName/Resources/Source")!}\annotationindex{SourceDirectory}, gives the location for source files.
The {\lstinline!annotation(SourceDirectory="modelica:/TopPackage/Resources/Source")!}\annotationindex{SourceDirectory}, gives the location for source files.
The preceding one is the default and need not be specified; but another location could be specified by using an URI name for the source directory, see \cref{external-resources}.
It is not specified how they are built.
\item
The {\lstinline!annotation(License="modelica:/ModelicaLibraryName/Resources/Licenses/MyLicense.txt")!}\annotationindex{License}, gives the license text file for the function.
The {\lstinline!annotation(License="modelica:/TopPackage/Resources/Licenses/MyLicense.txt")!}\annotationindex{License}, gives the license text file for the function.
It is analogous to the \lstinline!License! annotation for a top-level class, see \cref{license-texts}.
\end{itemize}

Expand All @@ -2272,7 +2272,7 @@ \subsection{Annotations for External Functions}\label{annotations-for-external-l
The directories may use symbolic links or use a text-file as described below: e.g., a text-file \filename{vs2008} containing the text \emph{../win32/vs2005} (or \emph{vs2005}) suggesting that it is compatible with vs2005.
\end{nonnormative}

The {\lstinline!ModelicaLibraryName!} used for {\lstinline!IncludeDirectory!}, {\lstinline!LibraryDirectory!}, and {\lstinline!SourceDirectory!} indicates the top-level class where the annotation is found in the Modelica source code.
The {\lstinline!TopPackage!} used for {\lstinline!IncludeDirectory!}, {\lstinline!LibraryDirectory!}, and {\lstinline!SourceDirectory!} indicates the top-level class where the annotation is found in the Modelica source code.

\begin{example}
Use of external functions and of object libraries:
Expand Down