Start36 (#3330)

* Update copyright year. * Add new revision section. * Update status for MCPs. (Yes, I know that the tag doesn't yet exist - but I think this is easier.) * Adding new index entries. There are a lot more things we could add, but these are primarily adding new indices for existing entries (even if they are very different). * Use smarter macro and give hints for finding pull requests. * Clean up introduction, sentence based lines and skip www. --------- Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
modelica · Feb 28, 2023 · c125834 · c125834
1 parent 3f4875d
commit c125834
Show file tree

Hide file tree

Showing 9 changed files with 302 additions and 13 deletions.
diff --git a/MLS.tex b/MLS.tex
@@ -11,7 +11,7 @@
 
 % Define title for use by LaTeXML.
 % An extended title is defined separately in the 'titlepage'.
-\newcommand{\mlsversion}{3.6-dev}
+\newcommand{\mlsversion}{3.6}
 \newcommand{\mlsdate}{\today}
 \title{Modelica\textsuperscript{\textregistered} Language Specification version~\mlsversion}
 

diff --git a/RationaleMCP/Hints.md b/RationaleMCP/Hints.md
@@ -0,0 +1,13 @@
+Hints for generating a release.
+
+Currently there are no automated procedures for generating the revision-history.
+
+For the MCPs it is good to list additional pull requests considered, they can be found in GitHub's Pull Request list by searching for:
+```
+-base:master -base:maint/ is:merged
+```
+This can either be combined with limiting it to one MCP `label:MCP0035` or excluding some (earlier and later) MCPs `-label:MCP0031 -label:MCP0033`.
+Additionally it is good to list all pull request merged into the main branch after the latest release:
+```
+base:master merged:>=2020-12-31
+```
diff --git a/RationaleMCP/ReadMe.md b/RationaleMCP/ReadMe.md
@@ -24,10 +24,10 @@ but the rest of the development on a branch/pull-request before being accepted.
 |Active|0038|Initialization of Clocked Partitions|[MCP/0038](https://github.com/modelica/ModelicaSpecification/tree/MCP/0038/RationaleMCP/0038)||
 |Active|0037|Generalized Modelica URIs|[MCP/0037](https://github.com/modelica/ModelicaSpecification/tree/MCP/0037/RationaleMCP/0037)|https://github.com/modelica/ModelicaSpecification/pull/2663|
 |Active|0036|Setting states|[MCP/0036](https://github.com/modelica/ModelicaSpecification/tree/MCP/0036/RationaleMCP/0036)|https://github.com/modelica/ModelicaSpecification/pull/3164|
-|Active|0035|Multilingual support of Modelica|[MCP/0035](https://github.com/modelica/ModelicaSpecification/tree/MCP/0035/RationaleMCP/0035)|https://github.com/modelica/ModelicaSpecification/pull/2956|
+|Accepted in [3.6](https://github.com/modelica/ModelicaSpecification/releases/tag/v3.6)|0035|Multilingual support of Modelica|[MCP/0035](https://github.com/modelica/ModelicaSpecification/tree/MCP/0035/RationaleMCP/0035)|https://github.com/modelica/ModelicaSpecification/pull/2956|
 |Active|0034|Ternary|[MCP/0034](https://github.com/modelica/ModelicaSpecification/tree/MCP/0034/RationaleMCP/0034)|https://github.com/modelica/ModelicaSpecification/pull/2477|
 |Added in [3.5](https://github.com/modelica/ModelicaSpecification/releases/tag/v3.5)|0033|Annotations for Predefined Plots|[MCP/0033](https://github.com/modelica/ModelicaSpecification/tree/MCP/0033/RationaleMCP/0033)||
-|Active|0032|Selective Model Extension|[MCP/0032](https://github.com/modelica/ModelicaSpecification/tree/MCP/0032/RationaleMCP/0032)|https://github.com/modelica/ModelicaSpecification/pull/3166|
+|Accepted in [3.6](https://github.com/modelica/ModelicaSpecification/releases/tag/v3.6)|0032|Selective Model Extension|[MCP/0032](https://github.com/modelica/ModelicaSpecification/tree/MCP/0032/RationaleMCP/0032)|https://github.com/modelica/ModelicaSpecification/pull/3166|
 |Active|0031|Flat Modelica and MLS modularization|[MCP/0031](https://github.com/modelica/ModelicaSpecification/tree/MCP/0031/RationaleMCP/0031)|
 |On hold|0030|IsClocked Operator||[#2238](https://github.com/modelica/ModelicaSpecification/issues/2238)|
 |Active|0029|License Export|[MCP/0029](https://github.com/modelica/ModelicaSpecification/tree/MCP/0029/RationaleMCP/0029)||
@@ -50,7 +50,7 @@ but the rest of the development on a branch/pull-request before being accepted.
 |Active|0012|Calling blocks as functions|[MCP/0012](https://github.com/modelica/ModelicaSpecification/tree/MCP/0012/RationaleMCP/0012)||
 |On hold|0011|Allow user-defined functions in reductions|||
 |On hold|0010|Adding guards to reductions|||
-|Active|0009|Undefined modification|[MCP/0009](https://github.com/modelica/ModelicaSpecification/tree/MCP/0009/RationaleMCP/0009)|https://github.com/modelica/ModelicaSpecification/pull/3167|
+|Accepted in [3.6](https://github.com/modelica/ModelicaSpecification/releases/tag/v3.6)|0009|Undefined modification|[MCP/0009](https://github.com/modelica/ModelicaSpecification/tree/MCP/0009/RationaleMCP/0009)|https://github.com/modelica/ModelicaSpecification/pull/3167|
 |On hold|0008|Custom annotations|||
 |On hold|0007|Match expressions|||
 |On hold|0006|Atomic blocks|||

diff --git a/chapters/copyright.tex b/chapters/copyright.tex
@@ -1,4 +1,4 @@
-Copyright \textcopyright{} 1998-2021, Modelica Association (\url{https://modelica.org})
+Copyright \textcopyright{} 1998-2023, Modelica Association (\url{https://modelica.org})
 
 All rights reserved.
 Reproduction or use of editorial or pictorial content is permitted, i.e., this document can be freely distributed especially electronically, provided the copyright notice and these conditions are retained.

diff --git a/chapters/inheritance.tex b/chapters/inheritance.tex
@@ -567,7 +567,7 @@ \subsection{Final Element Modification Prevention}\label{final-element-modificat
 \end{example}
 
 \subsection{Removing Modifiers -- break}\label{removing-modifiers-break}
-Modifications may contain the special keyword \lstinline!break! instead of an expression.
+Modifications may contain the special keyword \lstinline!break!\index{break@\robustinline{break}!removing modifier} instead of an expression.
 The intention of \lstinline!break! is to remove the value.
 
 The modifiers using \lstinline!break! are merged using the same rule as other modifications, and follow the same restrictions so they cannot override a final modifier.
@@ -1149,7 +1149,8 @@ \subsection{Annotations for Redeclaration and Modification}\label{annotation-cho
 parameter Boolean useHeatPort = false annotation(choices(checkBox = true));
 \end{lstlisting}
 \end{example}
-\section{Selective Model Extension}\label{selective-model-extension}
+
+\section{Selective Model Extension}\label{selective-model-extension}\index{deselection!selective model extension}
 \begin{nonnormative}
 The goal of selective model extension is to enable unforeseen structural variability without requiring deliberately prepared base-models, \textcite{Buerger2019SelectiveModel}.
 
@@ -1167,6 +1168,7 @@ \section{Selective Model Extension}\label{selective-model-extension}
   $\ldots$
 end C;
 \end{lstlisting}
+\index{break@\robustinline{break}!deselection}
 The semantic rules are:
 \begin{enumerate}
 \item The deselection \lstinline!break $D$! is applied before any other, non selective model extension related, modifications of \lstinline!B! in \lstinline!C!.

diff --git a/chapters/introduction.tex b/chapters/introduction.tex
@@ -93,7 +93,7 @@ \section{Some Definitions}\label{some-definitions}
 The model can be analyzed in ways other than simulation, e.g., linearization, and parameter estimation, but they are not described in the specification.
 \end{nonnormative}
 
-\begin{definition}[Translation]\index{translation}
+\begin{definition}[Translation]\index{translation!of simulation model}
 Translation is the process of preparing a Modelica simulation model for simulation, starting with flattening but not including the simulation itself.
 \end{definition}
 

diff --git a/chapters/packages.tex b/chapters/packages.tex
@@ -322,7 +322,7 @@ \section{External Resources}\label{external-resources}
 The references \filename{modelica://Modelica.Mechanics/C.jpg} and \filename{modelica://Modelica/C.jpg} must also refer to two distinct resources.
 \end{example}
 
-\section{Multilingual Descriptions}\label{multilingual-descriptions}
+\section{Multilingual Descriptions}\label{multilingual-descriptions}\index{translation!multilingual libraries}
 
 \begin{nonnormative}
 Descriptive texts in a model or library are usually formulated in English.