Changes

Clarify variability of functions.
Closes #2538

ExplainVariability

ClarifyMore

Apply suggestions from code review

Apply suggestions.

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

Syntax highlighting.

Add new section with references to the implications.

Update chapters/interface.tex

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

Remove 'the' as suggested by Quentin

Apply suggestions from code review

Add space

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

Add crossreference

Reduce and add cross-refrence

Add style guide section on inline code at beginning of sentence

Closes #2943.

Move rule that constants must have declaration equation

Reference rule about constants having declaration equation

Reorder in increasing order of variability

Rules should generally be presented in this order, as the lower variabilities are included in the higher ones.

Update chapters/operatorsandexpressions.tex

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

Try to improve text for initialization.
Closes #2947

Change model to function and clean up line-breaks.
Closes #2963

Apply suggestions from code review

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

UseInlineCode

Correct double for introduced in #2916
Closes #2966

Remove copy-paste from unknown source. UseDriveLine is part of other example.
Closes #2968

Align keywords for 'grammar' with keywords for 'modelica'

Sentence-based line breaks in 'Derivative and Special Purpose Operators'

This commit only affects line breaks inside paragraphs of the LaTeX source code.

Fix typo

The typo is mentioned in #2953, but is not the point of the issue.

Add missing formatting of 'expr'

Move misplaced paragraph break

Update copies of 'equation' and 'statement' rules to match appendix

Add missing white-space in copies of 'for-index' rule

Misc minor white-space cleanup

Update copy of 'algorithm-section' rule to match appendix

Align formatting of grammar listings

amend misc white-space

Sentence-based line breaking in statements.tex

This file was already mostly in good shape, so this is a low hanging fruit.

Sentence-based line breaking in equations.tex

This file was already in pretty good shape, so this is a low hanging fruit.

Start bullet item with upper case letter

Make relevant part normative

Cross reference restriction on multiple extends-clauses

Shorten comment to fit line width

Also changing from quotes to braces around list of inputs.

Fix some formatting in scoping.tex

Fix indentation of the external-clause in the grammar

Add space around binary operator

Fix typo: 'subsample' -> 'subSample'

Say "class name of any extends-clause", non-normatively

Addressing review comment by Hans.

Do not incorrectly use import name
Closes #2974

And better line-break.

Add to index and have first use.

Complete transition to sentence-based line breaking in scoping.tex

Minor white-space styling in listings

Fix missing of 'missingInnerMessage'

Fix formatting related to lookup of non-operator function

Remove period at end of section heading

Add suggestions for start value and "a diagnostic".

Apply suggestions from code review

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

ClarifyDiscrete

Consistently use "a diagnostics"

Apply suggestion for formatting of 'component'

Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>

Update comments about LaTeXML issues that are now fixed on 'master'

Apply suggestions from code review

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

Actual definition of discrete-time variable.

Sentence linebreaks.
Add note that variability is differently defined for variables and expressions.

Fix trailing WS.

Consistently quote in grammar (and remove one spurious ;).
Note that some code fragments are Modelica and some "grammar"; that may be a bit confusing.
Closes #2988

Avoid just a '0' in \lstinline when generating HTML

Fixes #2991.  Actually, it's more of a temporary workaround and we'll have to return this once we've switched to a future version of LaTeXML where the upstream issue has been fixed.

Update comment after LaTeXML issue being fixed promptly on 'master'

TrailingWS

Cleanup

Turned equations into assignments in when-algorithm

Clarified

BasedOnReview

Apply suggestions from code review

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

LineParagraph

LineParagraph

Fix formatting of 'when', 'elsewhen', and 'when initial()'

Fix year in date reference

Apply suggestions from code review

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

Update chapters/classes.tex

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

Clean up indentation and capitalization in ExternalFunctions hierarchy

Introduce new listings language for file hierarchy listings

Fixes #3009.

Sentence-based line breaks and basic formatting

Fix style issues with unit syntax

Fix typo

Fix external function call

BeMoreSpecific

FixSpace

Improve start-value priority by considering parameters.
And add example.
Closes #3008

ForgotToSave

Space

Change "UNIT-PREFIX" -> "unit-prefix"

Change requested by Hans.

Updated priority to first use parameter-confidence, and update examples.

Get rid of 'filehierarchy' listings language in favor of plain tabbing

Switch to upright font shape for the entire file hierarchy tabbing

Update chapters/overloaded.tex

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

Move label to correct spot.

Based on suggestions.

Don't use '=' when defining parsing production rule

Define unit-symbol as non-empty sequence of some undefined unit-char

Rephrase "base version"

Fix formatting of 'micro'

[CI] Set a username before git commit (#3021)

Update copyright.tex

Remove dubious statements about people not being compensated, which was added in Spec 3.0 v47 described as 'Slighly improved the “copyright” notice'
@henrikt-ma

Add that purity does not influence this.

Avoid using grammar in this problematic construct.

Clarify as suggested.

Correct typo introduced in e81918c as part of #2907 and discussed in this PR.

Revert ca9f22e as part of #2923 to more clearly define discrete-time for variables.

Clarify

Spelling

FixWS

Update chapters/annotations.tex

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

Update chapters/annotations.tex

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

Non-normative explanation why impure don't matter.

Update chapters/functions.tex

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

Apply suggestions from code review

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

Simplified

Update chapters/operatorsandexpressions.tex

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

Deprecated feature for System Modeler

Update chapters/annotations.tex

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

add proposed clarification

Update chapters/operatorsandexpressions.tex

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

Refine index entries.

FirstStepInClarifyMath

FinalStepInClarifyMath

Update chapters/classes.tex

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

Reformulate the differentiability part.
Using allowed instead of defined, as tools should check that requirement.
Clarifying that der(vn)<>0 is just putting formula behind the text.

Minor language fix, and rearrange for consistent formatting and naming.

Add space for LaTeXML
Closes #3024

Silly workaround for 2nd issue

Fix two cases of 'parenthesis' -> 'parentheses'

Fixes #3026.

Change ':' non-associativity example to fit better in line

Considering that there's a binary range operator expression, I think this variant should work just as fine as the old one.

Remove unused parameter 'p' in example for 'smooth'

Sentence-based line breaking in operatorsandexpressions.tex

As the conversion is done by hand, this commit also includes a small number of other fixes of cleanup character.

UseHspaceInstead

Clarify array range operator.
Closes #3028

Apply suggestions from code review

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

Add note about workaround
Closes #3024

Fix two minor typos

Start description with Upper case

Ensure that Modelica code in HTML is actually in fixed-width "teletype" style.

Fix typo

Disable apostrophes around 'enables'

Restore sffamily

Improve comment

FinalFirstUse

Improve comment, and always small in LaTeXML

add comment

Sentence-based line breaking

Align with modelica.org and say we model 'cyber-physical systems'

Update mlsshared.sty

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

Update mlsshared.sty

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

Make use of component variability when defining expression variability

Remove empty line after 'tabbing' environment

Add paragraph breaks around tabbing environment for LaTeXML build

Fixes #3009.

Fix copy/paste error with '!' in argument to \firstuse

Fixes #3041.

Make \firstuse add to document index, with possibility to override

Remove forgotten debug prints

Update style guide on the use of \firstuse

Change section title to 'Continuous-Time and Non-Discrete-Time Expressions'

Change 'discrete expressions' -> 'discrete-time expressions'

Local changes to sentence-based line breaking

Fix missing cases of grammar inline code formatting

Put statement about the past in parentheses

Be more vague about appearance of Modelica keywords in grammar

Remove redundant explanation of what a keyword is from grammar

This belongs in chapter 'Lexical Structure'.

Be more vague about appearance of Modelica keywords in listings

Move explanation of what a keyword is to chapter 'Lexical Structure'

Makes the introducing easier to digest, and places explanation where one would expect it.

Remove keyword exceptions

These exceptions are just confusing as the grammar actually allows both 'der' and 'initial' (and also 'pure') to be used as the callee of a function call expression.

Describe appearance of recognized names

Describe appearance of Modelica before grammar

According to decreasing order of importance for readers.

Remove link from introduction to chapter 'Modelica Concrete Syntax'

In the introduction, it's better to just focus on notation.

Align README.md with introduction

Fix typo 'excapt' -> 'except'

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

Local changes to sentence-based line breaking

Move two sentences out of 'Some Definitions' in introduction

Allow derivatives to be referenced in figures

Clarify degree formatting, and as a recommendation restrict to NON-DIGIT.

Introduce notation by example

Remove excessive indexing of 'inverse' annotation

Apply suggestion using 'time' as example

Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>

Fix white-space

Move '(definite)' inside \firstuse

As suggested by Hans.

Change sentence with 'language built on acausal modeling'

Based on suggestion by Hans.

Combine first two sentences into one

This addresses Thomas concern about not inflicting on FMI's territory as Modelica Association's strongest standard for model exchange as measured by number of supporting tools.

Put commas around 'depending on context'

As suggested by Elena.

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

Remove $v''$ from example presentations of 'der(v, 2)'

Turn see-also index entry into textual cross-reference

As requested by Hans.

Update chapters/unitexpressions.tex

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

Use quotes and state that degC is only an example.

Fix typo 'inde' -> 'index'

Addressing commend by Hans.

Simplify examples of invalid code

As suggested by Hans.

Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>

Rephrase 'done this way' -> 'presented like this'

Saying we 'do' invalid code sounded a bit too informal.

Link directly to unicode.org skipping www.; it might redirect to home.unicode.org.

Simplify links; remove www. but include https:// so that it can be a normal url.

Remove www. prefix as doesn't seem needed.
Closes #3054

More stable links for openprod
Closes #3055

Downgrade

AlsoBibliography

https

Update chapters/unitexpressions.tex

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

ITEA4

Remove incorrect escaping of '&' in bibliography 'url' entry

Fixes #3056.

Replace overuse of inline code by math and vice versa

Finish transition to sentence-based line breaking in connectors.tex

Fix listing with bad line breaks in comments

It has been verified that the new lines aren't too long.

Better definition of comments.

AddIndex

ClarifyPureAsDiscussed

Add icon

Only recommend diagnostic in case a result trajectory is missing

As decided at phone meeting: https://github.com/modelica/ModelicaSpecification/pull/3046#discussion_r765023927

Reorganizing slightly to avoid paragraph with just a single sentence.

Apply suggestion for reducing amount of 'modeling'

According to phone meeting decision.

Co-authored-by: Thomas Beutlich <modelica@tbeu.de>

Remove repeated list of example application domains

Port new description of Modelica to README.md

Restore (R) in README.md

According to phone meeting decision.

Tweak CSS for :target:before

Fixes #2967.

Update chapters/equations.tex

Update chapters/equations.tex

Update chapters/unitexpressions.tex

Spelling out the decision.

Update chapters/lexicalstructure.tex

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

Update chapters/lexicalstructure.tex

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

Update chapters/lexicalstructure.tex

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

Update chapters/lexicalstructure.tex

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

Update chapters/functions.tex

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

Update chapters/functions.tex

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

Update chapters/annotations.tex

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

Update chapters/annotations.tex

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

Update chapters/annotations.tex

Update chapters/annotations.tex

Add some 'padding-top' to make item target visible under page header

Fix unresolved merge conflict

Use NON-DIGIT in grammar.

RemoveWS

RemoveWS2

RemoveRedundant

Update chapters/annotations.tex

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

Update chapters/annotations.tex

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

Update chapters/annotations.tex

Call the preferredView string the 'view'

Add alternative reading of 'info'

Increase sizes a bit, and use "smallifpdf" for comments.

Re-introduce repetition

Addressing feedback from Hans.

Restore

RestoreEnDash

Simplify

FixClasses

Name the HTML entry page 'index.html'

Utilize entry at 'index.html'

Update css/MLS.css

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

With proposed changes.

Break oversize listing line in AssertionLevel example

Space around binary operators

Break oversize listing lines in record constructor examples

Break oversize listing line in actualStream definition

Clean up listings in chapter 'State Machines'

Problems addressed include oversize listing lines, line breaks in odd places, and badly indented lines.

Break oversize listing lines in convertModifiers examples

Break oversize listing line in 'quadrature2'

Break oversize listing line in 'Placement'

Update status regarding LaTeXML issue 1719

Fix indentation of Ellipse pseudo-code record definition

Address fancyhdr warning about too small 'headheight'

Without this, I'm getting a warning from fancyhdr on every page, making all other messages drown completely in the fancyhdr noise.

Move setting of 'headheight' to a better place

KeepSemanticRestrictionOutOfHeading

AsProposed

SimplerThanProposedRestrictionIsImplicit

AsProposed

KeepSemanticRestrictionOutOfHeading

AsProposed

AsProposed

Simplify

SimplerSimilarToReinit

Simplify

AdditionalOnes

Removing indentation as requested by Hans

Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>

Update chapters/classes.tex

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

Update chapters/classes.tex

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

Update chapters/equations.tex

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

Update chapters/statements.tex

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

FromComments

ConsistentCapitalization

AvoidStartingWithAnnotation

NoDuplicate

AvoidStartingWithArrays

Add index entries

Simplify clumsy logic

Remove non-standard use of hard line breaks inside paragraph

Remove unnecessary splitting of source code lines

Fix oversize lines in listings

Sentence-based line breaking in dae.tex

Address comment about systematic formatting

Add reference kind to naked \ref

Sentence-based line breaking of overload.tex

Improve cross references

BasedOnFeedback

Remove odd like break in paragraph

Remove stray single quote

Clean up listings with bad indentation

Minor corrections with empty arrays

AsProposed

Update chapters/arrays.tex

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

Make conversion example clearer.
Closes #3081

BothChoices

BadInsteadOfMisspelling

Oops

AhThereItShouldBe

ChangeIndentation

LastOne

Drop redundant part of headings

The dropped parts are redundant in view of the heading one level above.

Simplify 'Enumeration Value' -> 'Enumeration' in headings

The shorter heading increases the visibility of the final "Integer", and I don't see any real risk of misinterpretation here.

An alternative improvement of this heading would have been to just change 'Values' -> 'Value'.

Reintroduce article in headings to emphasize example status

En-dash

Shorten long heading

This also avoid a lack of consistency in the use of 'and' compared to this heading:
- "Attributes start, fixed, nominal, and unbounded"

Remove redundant headings above small examples

If we want examples to have captions we should do this systematically, probably based on amsthm.sty.