Changes

Add svg - and remove unclear parts.
Closes #174

Update chapters/annotations.tex

Add comma

Co-Authored-By: Dietmar Winkler <dietmar.winkler@dwe.no>

Remove trailing whitespace

Update chapters/annotations.tex

Correct grammar.

Co-Authored-By: Thomas Beutlich <modelica@tbeu.de>

Remove double text.
Closes #2266
(minor part; for the main part it was decided to not make any change).

Remove "paste" from "copy and paste".
Closes #2260

Restrict 9.1.3 to normal connectors; so that expandable connector need not be balanced.

Trying to handle restriction for components of various specialized classes.
Closes #2235

Try to correct these regressions.
Note that the iterator-part may not be ideal; I understand that removing iterators from
the start of simple name lookup was a deliberate decision and I don't want to revert all of that.
Thus the new text is somewhat awkward.
Closes #2175

Revert regression for function arguments.
Closes #2176

Add proposed changes from svorkoetter

Tried to clarify copied a bit more.

Clearer that absolute size for svg.

Remove part about not modifiying constants, due to changes in Modelica 3.2.
Closes #1709

Don't write that model and class are the same
Closes #1345

Update ReadMe.md

Add link for component iterators MCP

Update ReadMe.md

Fix link

Make width and height code.

Just list SVG as supported.

Use better logo files and remove old unused ones. 

This saves almost 1 MB in size of the final document.
See also: https://github.com/modelica/MA-Logos/issues/2

Unify the url and fix copyright and registered mark.

Updating dead links and also use DOI whenever possible.

Change SIunits to Units.SI as is the case as of MSL v4.0.0

Question is that since MSL 4.0.0 is based on MLS v3.4 if this might also be backported to 3.4 spec, *if* there will be   maintenance update. 

Link to itea homepage instead of custom domain.

Move the logo from abstract to title page

It looked strange to have the logo appearing on the second page instead of the title page.

Fix syntax error.

Make logo on title page conditional for PDF only.

Typo

Allocate MCP number for "Multilingual support for Modelica"

removed 0035/Readme.md

Fix spelling

Improve so that .13 is a floating point number,  (#2491)

Closes #2122
* Improve so that .13 is a floating point number, and some minor corrections.
* Introduce UNSIGNED-REAL and UNSIGNED-NUMBER to be able say that 13 is not a floating point, but can still be used everywhere where numbers are expected (13. is a floating point number).
* Add more examples
* Simplify descriptive text as proposed with good link to grammar

Clarify conversions (#2522)

* Clarify needed defaults for old modifiers.
Closes #2517
* Clarify new modifiers
Closes #2519
* Clarify when to use convertElement and convertClass
Closes #2520
* Clarify goal of conversion
Closes #2514
* Add examples (including base-class variants)

Clean up use of quote symbols (#2508)

This fixes most of #2364 (carefully avoiding wording that would trigger GitHub action).

Summary of what this PR aims to cover:
- No upright quotes should appear outside of code snippets (`lstlisting` and `lstinline`).
- No quotes around inline code.
- Use `\lstinline` instead of quotes for inline code.
- Use `\emph` when there is a need to remind that something has a special meaning in the context of the specification (when the thing was introduced, it should have been marked with `\firstuse`, see below).
- Titles of publications, chapters, and sections in `\emph` instead of quotes.
- Use matching pairs of double quotes (“conceptual”) when using a word or phrase that is intentionally vague, lacking proper definition, or otherwise calls for the reader's imagination. 
- Single quotes around single special characters where needed to get more clear separation from surrounding text.  Example (somewhat damaged by GitHub's font):
  > …there is an operator ‘`0`’ defining the zero-value
- Filenames in `\filename` (pretty big risk of not having found all occurrences).
- Use of `\firstuse` instead of `\emph` when a term is introduced (pretty big risk of not having found all occurrences).
- Use of the `example` and `nonnormative` environments whenever possible with at most minimal changes to content, in order to avoid misuse of interleaved fragments in `\emph`, making the source code maintainable, avoiding lots of tiny errors in the markup, and correcting many places where formatting was missing between the `\emph` fragments.

Parts of #2364 not covered by this PR:
- Proper handling of references.
- Cleanup inside non-normative text that couldn't be converted to use the `nonnormative` environment due to not being a stand alone sequence of paragraphs.  This requires #2368.

Minor changes:
* Clean up use of ``...''
* Clean up related to " being used outside of code snippets
* Use \filename to markup some filenames
* Get rid of some meaningless uses of \textbf
* Improve markup in simple cases of non-normative text and examples
* More cleanup, with special attention to single quotes
* Typesetting \filename with \textsf instead of \textit
* Remove forgotten \emph inside nonnormative
* Say 'stronger requirement than being balanced'
* Remove LaTeX source comment replaced by #2510
* Don't write math-like equation as Modelica source listing
* Use \emph instead of \lstinline for 'platform' in context of LibraryDirectory
* Wrap 'enabled' in \emph instead of \lstinline
* Add double quotes around fragment of inline code when explaining multiple iterators
* Use '\textgreater{} 2' instead of '$> 2$'
* Write ="Hz" inside \lstinline instead of just 'Hz'
* Write \lstinline!unit="s"! instead of 'unit \emph{s}'
* Fix quoting of opening parenthesis character
* Use \filename instead of \lstinline for some modelica URIs
* Fix encoding of backslashes inside \filename
* Fix matching of single quotes
* Say \lstinline!'+'! instead of just \lstinline!+! when speaking of operator overloading
* Say 'positive edge of' instead of 'when ... becomes ...'
* Wrap content of \filename in \mbox to prevent hyphenation from injecting hyphens

Co-authored-by: HansOlsson <hans.olsson@3ds.com>

Rewrite in a better way. (#2527)

Closes #2524

Try to clarify aspect ratio. (#2528)

Closes #2515

Clarify that locally non-singular can combine to give a global singularity. (#2529)

Note that locally non-singular may combine to globally non-singular or globally singular;
and the latter is the exception that should be mentioned.
Closes #2510

Extend variability rules and fix invalid example (#2526)

* Fix and extend example on variability rules
* Clarify the role of rules based on expression variability
* Elaborate a little bit on the 'perfect matching rule'
* A variable declared with 'constant' prefix is unaffected by the initialization problem
Closes #2525

Dialog group default (#2530)

Specify that Dialog.group does not have a default in record.
Closes #2476

Clarify that the order of declaration matters for the parameter dialog. (#2534)

Closes #2310

Clarify convertClassIf (#2533)

Clarify literal values for convertClassIf (string and enumeration), and that Integer and Boolean is also allosed.
Closes #2451

Connector should not be able to inherit from expandable connector. (#2532)

Closes #2298

Uri clarification (#2531)

* Allow user defined fragments, and state that they may be renamed.
Closes #2445
* And follow URI-recommendation and use lower-case ("modelica://")

Co-authored-by: Dietmar Winkler <dietmar.winkler@dwe.no>

Factor out function-partial-application (#2490)

* Factor out function-partial-application
Closes #2250

Clarify symmetric, outerProduct, skew etc. (#2485)

* Clarify symmetric, outerProduct, skew etc.
Closes #2295

Update README.md (#2542)

Update links in readme for Modelica Spec 3.3
Closes #2541

Extend inverses, and slightly clarify. (#2478)

* Extend inverses, and slightly clarify.

Update to latexml 0.8.4 (#2546)

New latex ml (#2545)

* To Make it run with LaTeXML 0.8.4 with just minimal changes of css.
* Add label for preface.
* New naming of html-files, with links.

Fixes paths to symbolic links (#2548)

The upload of the files failed due to some symbolic links being broken.
Also note that the upload script reads symbolic links instead of
uploading them as they are.

Update README.md (#2550)

Remove reference to old patched LaTeXML

Move nonnormative content regarding 'revisions' to separate paragraph

This is just the first of many similar changes to come.  This commit mainly serves to populate the cleanup/nonnormative branch with some changes so that a pull request can be initiated.

Note that even this first change fixes a language syntax issue in addition that was missed due to the nonnormative content being in the middle of a paragraph.

Drop nonnormative mention of 'first quadrant coordinate system'

Update ReadMe.md (#2549)

* Update ReadMe.md
Add new MCP as planned.

Clean up non-normative content in annotations.tex

Enforce paragraph break at beginning and end of non-normative content

Give a non-normative reason for not allowing 'array()' or '{}'

The new formulation works better as a separate paragraph.

Clean up non-normative content in annotations.tex

Clean up non-normative content in syntax.tex

Clean up non-normative content in lexicalstructure.tex

New environment for non-normative content without delimiting paragraph breaks

When using the nonnormative* environment, it is the author's responsibility to ensure that the content doesn't mix with other paragraphs.  The main use at the moment is in tables, where there shouldn't be a paragraph break before the line break at the end of a table row.

Move highly redundant non-normative text regarding operator record to separate paragraph

Clean up non-normative content in classes.tex

Clean up non-normative content in connectors.tex

Clean up non-normative content in dae.tex

Remove misplaced paragraph breaks

If an empty line is desired for improved readability of the source, it needs to be commented-out.

Clean up non-normative content in equations.tex

Change emphasized text into non-normative

Fixes #2554

Clean up one case of non-normative content that wasn't formatted with \emph

Clean up non-normative content in functions.tex

Clean up non-normative content in inheritance.tex

Clean up non-normative content in interface.tex

Clean up non-normative content in operatorsandexpressions.tex

Clean up non-normative content in overloaded.tex

Clean up non-normative content in packages.tex

Turn some uses of \emph into \firstuse

Clean up non-normative content in scoping.tex

Clean up non-normative content in stream.tex

Clean up non-normative content in statemachines.tex

Clean up non-normative content in synchronous.tex

Clean up whitespace

Don't say that comments are set in italics

Comments set in italics are now formatted as non-normative content.  The few remaining comments that are not formatted as non-normative content have no special formatting at all.

Fix misc formatting found by looking at remaining instances of {[}

Don't use \emph directly as markup of table headings

This makes it easier to spot misuses of \emph, as well as giving us a single place for controlling the formatting of table headings.

Use non-breaking space in "FORTRAN 77"

Use \nameref instead of hardcoding titles after use of \autoref

Fixes #2559

Introduce \autonameref for combination of \autoref and \nameref

Use \autonameref instead of just \nameref

Add LaTeXML.cache to the files removed by 'make clean'

The need to remove this file was detected when encountering a problem after the upgrade to LaTeXML 0.8.4.

Tentatively remove all mathescape=true used with \lstinline

This is just to make the HTML build to work while investigating the problem with mathescape=true.  Obviously, if we don't find a solution, just removing mathescape=true won't be enough; we'll also need change the actual math parts into something else, and then we should take the opportunity to do this consistently.

Add chapters/*.tex (in addition to *.tex) to makefile dependencies

Split 'clean' make target into 'clean-pdf' and 'clean-html'

Generalize makefile rule to simplify building small test documents

Partially revert "Tentatively remove all mathescape=true used with \lstinline"

This reverts parts of commit c2996d80a20e1ece70dd76ad244f0e07332e7ff1 that don't break the LaTeXML build.

Workaround for \lstinline math breaking the LaTeXML build

Don't say 'five' when there are six items

Don't use \lstinline[mathescape=true] for grammar with pieces of math

Use proper ellipsis in syntax for array concatenation

Fix strange language "there are any"

Addressing PR review comment by Hans.

Change non-normative "For example, ..." to example

Addressing review comment by Hans.

Remove redundant non-normative text on extending from operator record

Addressing review comment by Hans.

Fix typo "leval" -> "legal"

Make non-normative statement about root finding more freestanding

Addressing review comment by Hans.

Write error condition in parenthesis instead of at start of sentence

Addressing review comment by Hans.

Another error condition in parenthesis instead of at start of sentence

Addressing review comment by Hans.

Fix grammar: "consist" -> "consists"

Addressing review comment by Hans.

Restore paragraph break between text and 'tabular' environment

Addressing review comment by Hans.

Remove "there" in "guarantee that there all"

Fixing error spotted by Hans.

Minor cleanup of listing for overdetermined connector example

Fix two cases of linking to the wrong section with the same title

This should make the links the same as in version 3.4.

Avoid use of \texttt in arrays.tex

Avoid use of \texttt in connectors.tex

Avoid use of \texttt in functions.tex

Avoid use of \texttt in stream.tex

To get consistent formatting of subscripted variables inside Modelica source code, this involves changes in many places besides those where there used to be a \texttt

Restore list of inequalities in 'Every solution of the implicit equation...'

It was a mistake to think that the last entry in this list was a typo.  In a subsequent commit, I'll suggest writing it in a way with less risk of misinterpretation.

Rewrite sequence of inequalities in a more compact and less confusing way

Say 'greater than' instead of '>' at border of text and math

Say just 'inStream' instead of 'the inStream operator'

Similarly also for actualSteram.

Cleanup some formatting of math in derivationofstream.tex

Use align* instead of eqnarray*

This gives more consistent spacing around the aligned equality operator, compared with all the other equation* environments.

More rephrasing of operator mentions

Following the style recentry introduced in stream.tex.

Don't use \textbf directly for glossary items

More operator mentions

Remove some empty lines at the bottom of tables

Remove inconsistent use of \textbf in dae.tex

In the past, these vector variables used to be formatted in boldface.  Now, I don't know how we want it, but this commit at least makes formatting consistent.

If we want boldface, we should use \mathbf.

Avoid \textbf for starting examples

Apply some math formatting

Remove empty parentheses that don't mean empty parentheses

This change is related to the other changes where operators with function calling syntax are mentioned.

Avoid \textbf when showing syntax of connect-equation

Change one \textbf into \lstinline

Don't use text escape with \textbf inside lstlisting

The use of boldface was inconsistent with the rest of the listing anyway.

Minor cleanup of ellipsis

Minor style improvement inside code listing comment

Customize 'description' environment so that \item style can replace direct use of \textbf

Remove unnecessary use of \textbf for itemize items

Since most of these should use math, it also looks better if none of the items use boldface.

Fix formatting of definition of 'cat'

Fix latexml issue with \neq in \lstinline math

Replace \textbf with \firstuse when making definitions for 'Protection' annotation

Remove unused one-off arguments to lstlisting, including emphstyle=\textbf

Remove some misplaced paragraph breaks right before itemize environments

Avoid use of \textbf in revisions.tex, using some \emph instead

Use \emph rather than \textbf to put emphasis on 'not'

Get rid of some redundant parentheses just filled with dots

This is similar to how we simplified 'the der() operator' to just 'der'.

Introduce \bibitemtitle to replace \textbf for titles in the bibliography

Replace some \textbf in tables with \tablehead

Remove stray non-normative closing bracket

Use \emph instead of \textbf on 'shall not'

Remove more parentheses with only dots inside

Move period out of \lstinline

Replace lots of \textbf with \lstinline

Remove left over "Equations:." before sequence of examples

This header-like paragraph dates from before each of the different examples at the end of the section was presented as an example on its own.

Remove \textbf from two cases where no special formatting fits

I considered \emph, but didn't find it appropriate.

Fix some formatting of examples and nonnormative content in tables

Use \firstuse instead of \textbf when introducing base clock partition types

Remove \textbf on 'active' where it is neither introduced nor deserving emphasis

This instance of 'active' doesn't seem to differ in any significant way from the other nearby uses of 'active' that have no special formatting.

Use \tablehead instead of \textbf for some kind of table title

Replace \textbf by \firstuse when terms are introduced in tables

Use item list instead of beginning each semiLinear rule with \textbf{Rule X}

Introduce \numbereddefinition instead of \textbf for numbered definitions

Use item list instead of \textbf for the only 'Proposition' there is

Remove \textbf on the single restriction that has it in a list of five

Remove exaggerated emphasis with \textbf in equation/variable balance examples

As it's clear from the context that these examples are all about these concepts anyway, it didn't seem motivated to make these terms stand out more with something like \emph.

Remove use of enumitem.sty to fix continuous integration builds

This leaves the 'description' lists with some poor formatting, which we should return to later.

Corrected examples

Note that AC_Plug was also corrected in the next "model"
Closes #2564

Correct name of input to integrand.

Closes #2563

Clarify variability guarantee

Closes #2553

Clarify pre for arrays

Closes #2556
Note I also changed another part of pre for typographic reasons.
Currently I see:
y(tUnknown node type: sup)
In case mathjax isn't active (seems to be the case locally)
tpre looks weird, so t^-^ seems like the safest solution.

Restore to non-generic makefile, needed for nmake

Allocate MCP number for "Generalized Modelica URIs for external resources"
Cherry-picked 3f1f738 and updated number.

Fix whitespace

Fix whitespace

Add comment

One more math as noted

Move details/recommendations for RealType and IntegerType to where they belong

Fixes #2552

Fix strange uses of \emph for external objects

Fixes #2557

Fix hybrid DAE discrete-time Real equation

Don't use function name subscripts formatted as variable names

Rewrite to avoid starting sentence with 'homotopy'

Fix issues found when looking for un-protected in-sentence periods

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

Change one instance of incorrect use of math into \lstinline

Fix misc styling of array reductions

Misc style cleanup of matrix and vector algebra functions and constructors

Add missing math styling on array concatenation helper variables

Clean up so-called "formal" definition of array concatenation

Set belowskip=0pt for code listings

I skimmed the document, and as far as I could tell, this always gives a better result.

Remove some excess space

Add comments regarding LaTeXML issue being fixed on 'master'

Use math also for the 'x1' and 'x2' of linspace

Remove asymmetric paragraph break in table

Similar sentences in other rows of the table are not written as separate paragraph, so this just makes the treatment equal across the table rows.

Insert comma after 'that is'

Add escape around 'and' that's considered natural language

This makes sense when thinking of this lstlisting as a quick and dirty way of writing an equation with lots of inline code, and then this 'and' would have been inside \text{...}.

Lots of more or less font markup related fixes to chapter 'Arrays'

I've now taken the time to go through this chapter more carefully than the other chapters, hoping that this will be possible to use as example when later returning to do more careful cleanup of the other chapters.

Don't use $* in recipe of makefile rule without %

This fixes a problem I'm having with building MLS.html locally.

Fix LaTeXML problems with unbalanced parentheses/brackets in math

Minor cleanup or range operator

Remove ':' at end of section headings

A heading is a heading even without a trailing colon.  Maybe the colons were a rest from a time when these weren't normal headings, but some sort of boldface at the start of a paragram...

Try to remove lstinline from section names

And no math in section-headings

Rewrite paragraph on lookup in import clasuses to improve readability in the presence of lots of punctuation symbols

Re-write the list of possible import clause forms as suggested by Hans

Reflow some lines on import clauses

Fix em-dash/comma mismatch

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.

Clarify scoping for component names

Resolve #2547

State that promote is part of Modelica

Resolve #2568

No deduction of iterator range from array in bus

Resolve #2560

Make mathescape=true by default

This significantly reduces the clutter around all the \lstinline where math is used.

Add SameName example in same style.

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.

Update chapters/scoping.tex

Clearer language

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

Update chapters/scoping.tex

Avoid "looking up"

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

Remove trailing ws

Update chapters/statements.tex

Use proposed ", where the expressions" instead of " - that"

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

Include proposed changes

Restore workarounds for LaTeXML issue 1274

Remove old statement that is now superfluous

Change Varying

Use grammar-language and consistent names

Replace class-name by type-specifier as in grammar

Use name of class instead of old grammar-name class-name; since these should name not type-specifier

Minor cleanup of connectorSizing

Stumbeling upon this when trying to understand MCP-0033 review comments.

Fix indentation of grammar in text

To correct issue found in:
https://github.com/modelica/ModelicaSpecification/pull/2598#pullrequestreview-436162361

Use amsthm.sty to define 'definition' environment

This may, we get a referencing mechanism that also works with LaTeXML.

Mark the end of a definition with \qed

This is a very simple solution to start with.  For PDF output, there are definitely more advanced variants to consider, but the question is what would also work well (look good) with LaTeXML.

Use 'definition' environment instead of "definition tables"

Use 'definition' environments instead of 'description' lists

Use 'definition' environment for the different kinds of discrete-time variables

It hurts a little to break the table apart, but I think it has to be done in the spirit of consistency.

Make ndims constant.

FixIssue

Use 'definition' environment for the two kinds of clock partition

Don't consider the three 'The input argument is a...' definitions

Clean up 'hold(u)'

Update chapters/operatorsandexpressions.tex

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

Tidy up function calls that are parameter expressions

Stumbled upon these when looking for specification of 'size'.

Improve readability of source of nested item list on expandable connectors

Also throwing in some missing \lstinline.

Say 'Error', not 'Not allowed' in listing comments

Fix \autoref case for 'figure'

Only affects 3 recently introduced occurrences of references to figures.

Prepare for future use of \subfloat

The most important part here is probably making other authors aware of the current LaTeXML issues when combined with \autoref.

Say 'hold extrapolation' instead of 'constant extrapolation'

Addressing comment that got lost in #2601.

Remove presumably unintended indentation inside lstlisting environments (#2595)

* Remove presumably unintended indentation inside lstlisting environments
* Cleanup related to \lstinline in examples of 'each'