Skip to content
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

Be clearer about showStartAttributes. #3604

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

Be clearer about showStartAttributes. #3604

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
70d40a5
Be clearer about showStartAttributes.
HansOlsson Nov 6, 2024
088b791
Update chapters/annotations.tex
HansOlsson Nov 7, 2024
fffff3f
Update chapters/annotations.tex
HansOlsson Nov 7, 2024
8ed17d8
Update chapters/annotations.tex
HansOlsson Nov 7, 2024
0439815
Update chapters/annotations.tex
HansOlsson Dec 5, 2024
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
6 changes: 5 additions & 1 deletion chapters/annotations.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1450,7 +1450,7 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
/*literal*/ constant String tab = "General";
/*literal*/ constant String group = "";
/*evaluable*/ parameter Boolean enable = true;
/*literal*/ constant Boolean showStartAttribute = false;
/*literal*/ constant Boolean showStartAttribute;
/*literal*/ constant Boolean colorSelector = false;
/*literal*/ constant Selector loadSelector;
/*literal*/ constant Selector saveSelector;
Expand All @@ -1465,6 +1465,7 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
end Selector;
\end{lstlisting}%
\annotationindex{Dialog}
Modifiable parameters (except for \lstinline!connectorSizing = true!), non-connector inputs, and short replace class definitions should normally be shown in the dialog even without this annotation.
HansOlsson marked this conversation as resolved.
Show resolved Hide resolved

For a short replaceable class definition only the fields \lstinline!tab!, \lstinline!group!, \lstinline!enable! and \lstinline!groupImage! are allowed.

Expand All @@ -1486,6 +1487,8 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
The \lstinline!showStartAttribute = true! is primarily intended for non-parameter values and avoids introducing a separate parameter for the \lstinline!start!-attribute of the variable.
\end{nonnormative}

If a non-parameter declaration has a modifier for the \lstinline!start!-attribute and does not have \lstinline!showStartAttribute = false!, the \lstinline!start!- and \lstinline!fixed!-attributes may also be shown.

If \lstinline!colorSelector = true!, it suggests the use of a color selector to pick an \textsc{rgb} color as a vector of three values in the range 0..255 (the color selector should be useable both for vectors of \lstinline!Integer! and \lstinline!Real!).

The presence of \lstinline!loadSelector! or \lstinline!saveSelector! specifying \fmtannotationindex{Selector} suggests the use of a file dialog to select a file.
Expand All @@ -1504,6 +1507,7 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
The background of the \lstinline!groupImage! and any image used in HTML-documentation is recommended to be transparent (intended to be a light color) or white.

The \lstinline!connectorSizing! is described separately in \cref{connector-sizing}.
A dialog annotation only containing \lstinline!showStartAttribute = false! and/or \lstinline!connectorSizing = true! does not indicate that the variable shall be shown.

\begin{example}
\begin{lstlisting}[language=modelica]
Expand Down