Changes

Initial commit of documents for MCP-0033

Minor corrections, mostly language and formatting

Update the predefined plots to add HTML-caption, sub-plot title and optional identifier.
Closes #2363

Update predefined-plots.md

Batter -> Battery (twice)

Updates after demonstration of prototype

Clean up and updating proposal with features demonstrated at 100th design meeting

These changes are mainly about renaming and reorganizing features presented or planned at the previous design meeting.

References and comparisons to the current use of predefined plots in Wolfram SystemModeler have been removed.

The handling of axis boundaries have been defined by making the choice of unit explicit.

Fix broken markdown from previous commit

Drop the top level Figures container in favor of reusing Documentation

Having figures as part of the Documentation has become very natural now that they also include captions, and that part of the current content of the 'info' might end up being migrated to figure captions instead.

Second, the figures are expected to be heavily linked from the 'info', which is another reason for keeping them close together.

Third, this avoids the use of a container record with just a single record member.

Text markup for captions

Added example figure from the prototype

Update predefined-plots.md

Consistently using record constructors.

Clean up whitespace in example of Figure

Clarifications regarding Figure 'group'

Specifying behavior of undefined and empty Curve 'legend'

State uniqueness requirement for Figure and Plot 'identifier'

Clarify rules for Figure and Plot 'title', and relation to plot labels

Move preferredView and DocumentationClass to the more logical place "Annotations for the Graphical User Interface"

Initial conversion of the markdown content to latex and integration of the text

Describe all the attributes of Figure in the text

Explicitly point out all attributes where variable replacements might be used

Removing redundant statement regarding vendor annotations (they can appear anywhere in any annotation)

Be even more specific about where variable replacements can be used

Fix typo

Fix whitespace

Use the nonnormative macro

Restore list that was lost in translation from markdown

Remove outdated restriction to simulation models in ReadMe.md

Fix typo

Relax the uniqueness requirements of plot identifiers

Clarify the uniqueness of Figure and Plot identifiers

Move \doublelabel out of \subsection argument

Add link to collection of examples in ReadMe.md

Incorporate suggestions from #2578

Clarify that behavior is unspecified for:
 - Curves where x or y does not designate a variable
 - Unknown units or incompatible with the plotted variable

Clarify that leading and ending newlines are ignored in captions (#2581)

Make Figure title optional as decided at the 101th design meeting (#2580)

Fix typos and improved wording reported by @matlelenz

text graphical -> text graphical primitive

Use \lstinline on 'Plot' and 'title'

Co-authored-by: Otto Tronarp <otto@tronarp.se>

Elaborate on the inheritance of figures

Explain 'preferred' plot in a more open way

Addressing comment by @maltelenz.

Add missing 'as'

As suggested by @otronarp.

Co-authored-by: Otto Tronarp <otto@tronarp.se>

Remove empty line at beginning of file

Use pseudocode record for 'Documentation' annotation

Addressing review comment by @HansOlsson.

Clarify that it's an error if cref does not designate a scalar variable

Clarify the behavior for unknown and incompatible units

Fix broken merge

Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>

Move things related to Axis.label into the same paragraph

Clarify that Axis.unit is required when specifying axis bounds

Make Axis.unit default to "" (without yet specifying what the default means)

First try at defining the meaning of empty Axis.unit

Mandate that Axis.unit is used for axis tick labels

Separate meanings of presence of axis bounds and presence of Axis.unit

Ignore 'min' and 'max' when 'unit' is not recognized

Move MCP state to 'Under Evaluation'

Update table to follow new style

Fix three cases of 'parameter-expression' -> 'parameter expression'

Make assertion level a parameter expression

Change 'a discrete-time variables' -> 'a discrete-time variable'

Fixes #2699

Fix some white-space irregularities in the grammar

Fix more white-space irregularities

Partly fix white-space irregularities in lexer rules

Fix two more minor white-space irregularities

Update comment about LaTeXML issue being fixed on their 'master'

Fix typos in spec (#2695)

* Fix typo in operatorsandexpressions.tex
* Fixing little typos in spec

Deprecate byte order mark (#2696)

* Deprecate use of UTF-8 byte order mark
* Change 'whitespace' -> 'white-space' everywhere

Cleanup listings related to external-clauses (#2688)

* Improve readability of external-clauses
* Clean up whitespace in listings related to external functions
* Remove bad escaping in 'size\_t' inside lstlisting
* Suggest that we add syntax highlighting for 'size_t' in C
This would be similar to how we do syntax highlighting of certain recognized identifiers in Modelica, apart from the keywords.
* Indent 'external' with to same level as 'function'
The annotation of the external clause is indented one level deeper than the external-function-call, to avoid mixing it up with the function annotation.

Clarify that equations in discrete-time Real variables are only solved at events

Initial commit of documents for MCP-0033

Minor corrections, mostly language and formatting

Update the predefined plots to add HTML-caption, sub-plot title and optional identifier.
Closes #2363

Update predefined-plots.md

Batter -> Battery (twice)

Updates after demonstration of prototype

Clean up and updating proposal with features demonstrated at 100th design meeting

These changes are mainly about renaming and reorganizing features presented or planned at the previous design meeting.

References and comparisons to the current use of predefined plots in Wolfram SystemModeler have been removed.

The handling of axis boundaries have been defined by making the choice of unit explicit.

Fix broken markdown from previous commit

Drop the top level Figures container in favor of reusing Documentation

Having figures as part of the Documentation has become very natural now that they also include captions, and that part of the current content of the 'info' might end up being migrated to figure captions instead.

Second, the figures are expected to be heavily linked from the 'info', which is another reason for keeping them close together.

Third, this avoids the use of a container record with just a single record member.

Text markup for captions

Added example figure from the prototype

Update predefined-plots.md

Consistently using record constructors.

Clean up whitespace in example of Figure

Clarifications regarding Figure 'group'

Specifying behavior of undefined and empty Curve 'legend'

State uniqueness requirement for Figure and Plot 'identifier'

Clarify rules for Figure and Plot 'title', and relation to plot labels

Move preferredView and DocumentationClass to the more logical place "Annotations for the Graphical User Interface"

Initial conversion of the markdown content to latex and integration of the text

Describe all the attributes of Figure in the text

Explicitly point out all attributes where variable replacements might be used

Removing redundant statement regarding vendor annotations (they can appear anywhere in any annotation)

Be even more specific about where variable replacements can be used

Fix typo

Fix whitespace

Use the nonnormative macro

Restore list that was lost in translation from markdown

Remove outdated restriction to simulation models in ReadMe.md

Fix typo

Relax the uniqueness requirements of plot identifiers

Clarify the uniqueness of Figure and Plot identifiers

Move \doublelabel out of \subsection argument

Add link to collection of examples in ReadMe.md

Incorporate suggestions from #2578

Clarify that behavior is unspecified for:
 - Curves where x or y does not designate a variable
 - Unknown units or incompatible with the plotted variable

Clarify that leading and ending newlines are ignored in captions (#2581)

Make Figure title optional as decided at the 101th design meeting (#2580)

Fix typos and improved wording reported by @matlelenz

text graphical -> text graphical primitive

Use \lstinline on 'Plot' and 'title'

Co-authored-by: Otto Tronarp <otto@tronarp.se>

Elaborate on the inheritance of figures

Explain 'preferred' plot in a more open way

Addressing comment by @maltelenz.

Add missing 'as'

As suggested by @otronarp.

Co-authored-by: Otto Tronarp <otto@tronarp.se>

Remove empty line at beginning of file

Use pseudocode record for 'Documentation' annotation

Addressing review comment by @HansOlsson.

Clarify that it's an error if cref does not designate a scalar variable

Clarify the behavior for unknown and incompatible units

Fix broken merge

Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>

Move things related to Axis.label into the same paragraph

Clarify that Axis.unit is required when specifying axis bounds

Make Axis.unit default to "" (without yet specifying what the default means)

First try at defining the meaning of empty Axis.unit

Mandate that Axis.unit is used for axis tick labels

Separate meanings of presence of axis bounds and presence of Axis.unit

Ignore 'min' and 'max' when 'unit' is not recognized

Move MCP state to 'Under Evaluation'

Update table to follow new style

Fix three cases of 'parameter-expression' -> 'parameter expression'

Make assertion level a parameter expression

Change 'a discrete-time variables' -> 'a discrete-time variable'

Fixes #2699

Fix some white-space irregularities in the grammar

Fix more white-space irregularities

Partly fix white-space irregularities in lexer rules

Fix two more minor white-space irregularities

Update comment about LaTeXML issue being fixed on their 'master'

Fix typos in spec (#2695)

* Fix typo in operatorsandexpressions.tex
* Fixing little typos in spec

Deprecate byte order mark (#2696)

* Deprecate use of UTF-8 byte order mark
* Change 'whitespace' -> 'white-space' everywhere

Cleanup listings related to external-clauses (#2688)

* Improve readability of external-clauses
* Clean up whitespace in listings related to external functions
* Remove bad escaping in 'size\_t' inside lstlisting
* Suggest that we add syntax highlighting for 'size_t' in C
This would be similar to how we do syntax highlighting of certain recognized identifiers in Modelica, apart from the keywords.
* Indent 'external' with to same level as 'function'
The annotation of the external clause is indented one level deeper than the external-function-call, to avoid mixing it up with the function annotation.

Clarify that equations in discrete-time Real variables are only solved at events