Changes

Call it 3.5; and add short revision list.

MissedCref

AddMinor

Working

Reorder

More

More

AllButOnePR

Correct

Reordered

ReorderedFunctions

MissedOrdering

Reorder

Add2177

Add2692

AddedMore

Don't treat 'nondiscrete' as keyword in listings

Make sure our language definitions for listings are actually being used

While this wasn't a problem for our 'FORTRAN77', our definition of 'C' was actually completely ignored in favor of some predefined dialect of C.

Be explicit about morekeywords class number being 1

This makes it consistent with how we define other languages.

Add missing language=C for \lstinline

Write T' as math to avoid syntax highlighting confusion

Make 'size_t' a class 3 keyword in C

This is consistent with how we highlight recognized identifiers such as 'Real' in Modelica listings.

Say 'variable value' instead of 'value-attribute'

While I can see how the term 'value-attribute' can be understood by looking at the definitions of the primitive types, the term isn't used anywhere else, and I think it is better if it is avoided here as well.

Suggestions for other ways of phrasing this are welcome.

Better integration of terms 'instantaneous equation/statement'

Use comments instead of text escape in array indexing listing

This makes the example more aligned with other examples, and thereby easier to read and understand.

Style 'nondiscrete' as keyword in revision history

Remove stray opening bracket in comment

Say 'value of the variable' instead

As suggested by Hans in review comment.

Update date and change to RC1.

3.5 soon to be released and now working on 3.6.

Use colon instead of dash when attaching 'th' to ordinals

Remove forgotten space in '3.6 -dev'

At least, the previous development version 3.5-dev didn't have this kind of space in the version.

Pass option 'pdfusetitle' to hyperref.sty

Fixes #2795.

Remove document title also from top page sidebar

Remove excessive indentation of sidebar on top page

Update comment regarding LaTeXML issue 1400 (now fixed)

Add keywords to generated PDF.
I don't know if they currently have any effect for LaTeXML - but no harm I guess.

Write "j'th" in listing comment

Drop the ':' in "$k$:th"

Fix typo in 'bibliograph'

Remove comment with definition of 'partial flattening' from old glossary

Fixes #2787.

Add 'MODELICAPATH' to the index

Add missing \lstinline

Remove use of the terms 'instantaneous equation' and 'instantaneous statement'

Say 'only during initialization' instead of 'at the initial time only'

Since the equations aren't active during the initial event iteration, it sounds a bit misleading (although not logically incorrect) to say that they are used at the initial time only.

Avoid overlong lines by:
* Reordering items in list.
* Rephrasing txt.

Better phrase.

Remove incorrect string quoting of '+' for string concatenation

Apply suggestion almost as discussed

Fix long lines and use \ldots for ellipsis in listings

Also trying to standardize the occasional use of '<describing text>' inside listings.

Add 'clocked when-clause' to document index

Use angle brackets for '<describing text>' in listings

This fixes at least the cases using \textless{}, but there could be more cases that didn't escape into text mode that have been missed.

Remove redundant comment with ellipsis character

Just say "dialog" instead of "parameter dialog" related to Dialog annotation

The Dialog annotation is more widely useful than just for parameters.

Not touching the revision history, where "parameter dialog" is still mentioned.

Really remove "Parameters" as default for 'group'

What we did in the past was just to remove it from the Dialog example.

Reorganize description of Dialog annotation

Fix link formatting

Remove Travis CI badge from README.md

Travis CI is no longer used for building the specification.

Merge descriptions of Dialog 'tab' and 'group'

Remove 'parameter' prefix from Dialog and Selector annotation pseudo code definitions

Say 'entire group' instead of 'parameter-group'

Clean up source line break

Allow sentences to start with inline listing to avoid unusual use of 'parameter'

Break out example of tool-specific choice of group

Fix title case in new section heading

Add links to MAP-LANG and MCPs to README

It was hard to find the Development process.

Update README.md

Remove "template to follow"

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

Fix typos in revisions notes of v3.5
(originally by Leo Gall on 3.5 branch.)

Update revisions.tex

Remove double word "use have"

Protect space after \LaTeX

Align duplicated parts of lexing rules

This isn't the first time we have issues with these being out of sync.  Hopefully, maintenance will become easier now with the duplicated part being a substring of the full lexing rules.

Remove HTML footer links to bibliography and index

Add logo to README.md

UseMacroAndProperReference

Minor cleanup of inline code and math for Derivative annotation

Avoid use of connectorSizing in example before it has been described

Show HTML footer link to document index as magnifying glass in page top right corner

Fine tune padding for correct centering of page header content

Avoid current HTML jump target being hidden behind page header

Stop saying that 'promote' isn't a Modelica function

Fixes #2843.

It's rather embarrassing that we missed this in #2590.

Fix formatting of 'STRING' and 'Q-IDENT'

Use table to present extended BNF

This is similar to how we present string escape sequences, with good formatting of the textual descriptions.

Of the two present spellings 'NONDIGIT' and 'NON-DIGIT', go with the latter

Remove obsolete comment about boldface lexical units

The comment was obsolete for two reasons:
- The boldface formatting was lost in the conversion to LaTeX.
- There are annotations making use of both S-CHAR, NON-DIGIT, and UNSIGNED-INTEGER, none of which were marked with boldface in 3.4.  With so many of the lexical units actually being used, there seems to be little value in marking them.

Rephrase sentence with 'IDENTs'

This seemed like a better fix than just changing to:
  \lstinline[language=grammar]!IDENT!s

Refer to Selector.caption as "a caption for display in the file dialog"

Say "a dialog is shown" instead of "a menu pops up"

Preferring "is shown" over "pops up", since the former is more general.

More systematic use of \lstinline for figure annotations Axis and Curve

Also fixing some issues with missing punctuation.

Break out presentation of item list from its first item

(This problem was present already in 3.4.)

Fix more formatting of "(:)" for flexible array dimension clarification

Add missing plural 's'

Clean up example "Variables with array dimensions"

Fixes #2855.

(I have checked that the longer lines don't wrap.)

Fine tune padding at top of HTML pages

Addressing change requested by Hans in review comment.

State that external objects must not depend on themselves.
Closes #2845

Specify inverse.

Describe derivative.

Update chapters/functions.tex

Ok

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

Specify noDerivative and zeroDerivative.
Closes #2840
(And using those formulas, but reworked based on the examples.)

ExtraStep

BumpCopyright

Revert "Use angle brackets for '<describing text>' in listings"

This reverts commit 219c56aa0b887e211dbdd8269cd32e877a33b82e.

Only some files are reverted.
Closes #2867

Update chapters/functions.tex

Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>

SpellCorrection

Update chapters/functions.tex

Adjustable parenthesis

Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>

Implies

Add offset in formula

Rename derivative

Update chapters/functions.tex

Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>

Update chapters/functions.tex

Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>

Optional semi-colon.

Update examples with semi-colon

Attempt to use fDer instead of f_der since the other option doesn't look nice in pdf.

UpdateReleaseInfo

Apply suggestions from code review

Based on review.

Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>

Revert "Add logo to README.md"

This reverts commit 7d04c273119887a284411f4dfafe553750108cfb.
Problem is that Python CI cannot handle it for specification.modelica.org
After that is corrected it should be re-applied.

Don't have ; in headings.

Example for SourceDirectory annotation.
Closes #2847

Add some extra words to avoid bad linebreaks.

Clarify that continuous-time algorithm as well.
Closes #2817
The initialization part anyway needs further clarification.

RemoveWS

Be more consistent with Modelica.StateGraph - and note that it may differ.
Also use MyCompositeStep - to avoid confusion with similar classes in MSL.

Avoid hard coded numbers.

Add logo to README.md

Seems that python require this.

Spelling

Clarify

Break down first items describing ExternalObject

Having separate items for the constructor and destructor makes the item list easier to organize and digest.

Fix white-space errors in recently introduced example on derivative

Don't call "over-optimize" when tools are clever

Add some text to example on derivative 'order'

Now as example

Based on the reformulation of "over-optimize", this has become more of a typical example than a non-normative explanation.

Add comments with TODOs after LaTeXML issue is fixed

Work around LaTeXML/MathJax issue with \emph in mathescape

Expect MathJax to become obsolete rather than workaround in LaTeXML

Consistent white-space when using 'derivative' annotation

Use 'aligned' instead of 'eqnarray*' to match style in other places

Use \mathit on multi-letter function names (maybe \lstinline would be better)

Use macros for standardized formatting of "derivative fractions"

Use \lstinline for function names referring to listing

Try to be a little bit more consistent with writing out "(t)"

Break too long line in listing

Add \, after comma in math

Say "colon" before (:) (that is, a colon inside parentheses)

If we'd like to avoid spelling out "colon", we should quote the colon rather than putting it inside parentheses.

Clarify that Figure.caption and identifiers have an empty default;
and special rules for empty identifiers.
Note that Plot.caption is not the empty string as default as there is a more complicated explanation.
Closes #2851

Better variant of difference equation vs. algorithm
Closes #2814

Create NewRelease.md

Update ReadMe.md

Fix description of "proposes to not inline"

This fixes a regression introduced after 3.4.

Update RationaleMCP/ReadMe.md

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

Based on review.

Update chapters/annotations.tex

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

BadBackslash

Hold old (#2893)

* Indicate that older issues are on hold, as decided on the latest meeting.
(And one more where the status just wasn't updated.)
I found public information for two of them in the svn-archive.
I deliberately only added the pdf and not the word-document.
The idea is portability for users and that it encourages converting them.
Technically 0012 should have been added on a branch, but do that when we start working on it.
* Changed to table-format to make it easier to see what is added.
I believe "On hold" is slightly better than "Suspended"; shorter and already part of development process.
* Add links to releases, and fix one entry.
* Use separate trees.

Update link for MCP-0029 to directory on MCP branch (#2899)

* Update link for MCP-0029 to directory on MCP branch
* Clean up white-space

Clarify discrete and remove odd statement about Pantelides. (#2887)

* Clarify discrete and remove odd statement about Pantelides.
Resolves parts of #2835
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>

Apply \smallifpdf after \ttfamily

This way, it becomes possible to both modify the default size of \ttfamily itself, and then possibly override this with \smallifpdf.

For the current teletype font we don't need this, but it has turned out to be useful in the evaluation of some other candidates.

Change to teletype font with more distinguishable boldface variant