Changes

Use pure math instead of \lstinline for math-like content

As a variable in Modelica isn't referred to using explicit application to a time argument, the presentation of the different kinds of discrete-time variables isn't suitable for \lstinline.

Clarify caption: the value of a clock variable isn't defined

Remove superflous emphasis

These words don't really seem to correspond to something deserving emphasis, and removing the emphasis makes the definition more readable.

Use equally sized figures for the different kinds of discrete-time variables

This is a preparation for having these side by side as subfigures, as the non-conforming layout of the old figures didn't look good at all with the graphics appearing so close together.

As a bonus, the new figures also come as SVG, which makes them crisp and scalable also in the LaTeXML build.

Use math for the points of a Bezier spline

Use scalable graphics for Bezier spline

Make sure all figures have a caption

This commit makes the first use of the cleveref package, which we should consider using everywhere instead of \autoref.

Put figure captions below the figure

Styling of captions

This separates the captions from the surrounding text.

Mention that LaTeXML issue with subfig.sty is fixed on master

Fix language

Try to fix CI build by installing packages caption.sty and cleveref.sty

Change: Allow empty quoted identifier.
Cleanups:
- Add " to Q-CHAR
- Unify Q-IDENT variants
Closes #2612

Bump Docker latexml image

New image is built using the updated Dockerfile.incremental, which should be consistent with what was already in Dockerfile.

Use scalable graphics for subtype relation

Fix typos in subtype figure caption

Remove no longer used bitmap images

The removal of these files really belongs to commit "Use equally sized figures for the different kinds of discrete-time variables".

Use scalable graphics for inside/outside connector example

End all captions with period

Use open en-dash instead of open em-dash

This is how it's done on 'master'.

Use scalable graphics for synchronous example

Use scalable graphics for MODELICAPATH

Changing the test "ComplexNumbers" -> "ComplexNumbers.mo", based on the interpretation of the strings as filenames, not class names.

Use scalable graphics for overconstrained connection graph

Fix failed attempt to format 'k' as subscript

Use scalable graphics for fluid connection set

Rename figure 'image2.png' -> 'diagram_examples.png'

Remove stray extra 'q' in subscripts of figure 15.1

Fixes #2641.

Improve math formatting in derivationofstream.tex

Use scalable graphics for common mixing enthalpy

Use scalable graphics for inStream rationale

Use scalable graphics for fluid connections with sensor

Fixes #2643.

Note, however, that the figure will probably need another update when fixing #2644.

Small fixes to math notation in derivationofstream.tex

Clarify elsewhen initial
Closes #2636

Update chapters/equations.tex

Remove double space.

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

Fix incorrect use of "discrete states"

Give proper name to section introducing 'clocked state variable'

Clarify definition of 'clocked state variable'

Some \lstinline cleanup in definition of 'previous'

Use scalable graphics for state machine transition examples

Fixes #2649.

The fix for #2649 is to remove the bar on the priority "5".

Use scalable graphics for hierarchical state machine

Also updating the other state machine figure with the same style.

Create LICENSE.md

Add license.

Closes #2292

Note that:
- I could find neither an official text-version of this, nor an official markdown version.
- The official instructions state that you should link as above (but in html); and does not say that you should copy the text.

Specify that chapter introductions are non-normative.

Split of terminology as separate section.

Remove normative text (already part of equations-chapter),
and replace it with some relevant introduction.

No need to mark the start as non-normative anymore.

Split of normative part.

Minor state machine figure updates

Use scalable graphics for the state machine behavior plot

Replace PNG variant of Modelica_Language by SVG

Set 'height' instead of 'scale' for image in page header

The image is 67.3mm high, so the old scale 0.1 is approximaged by scaled height 6.5mm.

Include screen shots with 'scale' instead of 'width' and 'height' for consistent scaling

Add comment about LaTeXML issue being fixed on 'master'

Reformulate to have a non-normative introduction, followed by an actual normative part.

Switch from table to item-list after latexml bug was corrected.

Fix reference to table.

Mark entire introduction to array chapter as non-normative.
As far as I could see all the normative parts were duplicated from the chapter
and thus redundant.

Move non-normative motivation for package to start of chapter,
and move up most definitions as discussed.

Reorder sections in package-chapter as discussed.

Remove extra label.

Use \emph instead of all upper case letters

Address GitHub warning about incorrect pair of double quotes

Improve inclusion of image in preface

This includes not calling it a "figure" when no figure float is used.

Remove nonnormative unclear text

Rewrite synchronous rationale to be positive (#2656)

* Move synchronous introduction right under chapter; and rewrite slightly.
* Reformulate the rationale to be positive.
* With corrected review comments.
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>

Closes #2512

Fix duplicated paragraph after resolving merge conflict

First attempt at environments for operator/function definitions, with application to 'previous'

Sample application to 'Numeric Functions and Conversion Functions'

Remove some unintentional paragraph breaks around displayed equations

Sample application to base-clock conversion operators

Alternative approach to avoid overuse of tables, applied to event-related operators

Add Git ignore patterns for LaTexML-generated build directories

More use of math for operator formal parameters

Break too long \lstinline line

Update name and add link for MCP-0037

Use latexmk
Found when looking at C++-standard, https://github.com/cplusplus/draft/blob/master/source/Makefile

Use "discrete-time variable" consistently. (#2646)

* Use "discrete-time variable" consistently, and some minor cleanup.
Closes #2640

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

Update all existing sample applications according to discussion with Hans

Add ltx-article.css to Git ignore patterns

Remove controversial part of merged with #2646

In the phone meeting leading to the merging of #2646, this controversial part was not discussed.  A new issue will be created for putting it back.

Change small tables of arithmetic operators from 'longtable' to 'tabular'

This removes the last uses of 'longtable' in this chapter.

Don't end small table entries in period

Clean up table of Clock constructors

Use 'list' instead of 'longtable' for crazy indentation of definitions of 'incidence(e)'

Uniform structure of paragraph before tables of operators/functions

Clean up table of sub-clock conversion operators

Use new, lighter, style for table of solver methods

Clean up table of additional clock utility operators

Use 'list'-based environment instead of 'longtable' for contributors

Clean up tables for state machines

Replace 'p{11cm}' column format by 'l'

Every row has content in this column meant to fit in a single line.

Don't use 'longtable' for collection of all keywords

With the way table content is organized into columns, it makes no sense to let this table be split across pages.

Use new table style for string escape sequences

Use 'itemize' instead of 'longtable' for notation in dae.tex

This avoids the need to use a paragraph column adapted for a fixed paper size.

Basic cleanup of table for overconstrained connections

Structure 'Annotations for Code Generation' similar to operators

Use 'itemize' instead of 'longtable' for definitions of specialized classes

Clean up table of inheritance rules

Clean up table and listings in 'Merging of Modifications'

Say, for example, "C type", not "C-type"

Clean up tables in 'External Function Interface'

Minor math cleanup

Allow Dialog for classes as well, with restriction. (#2618)

* Allow Dialog for classes as well, with restriction.
Closes #2617

With some cleanup of text.

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

Update convertMessage to handle elements.
Closes #2516

Clean up a couple of tables related to arrays

Clean up array and element-wise operator tables

Avoid paragraph columns in operator precedence table

Remove vertical lines in operator precedence table

Clean up definition of 'promote'

Clean up whitespace in array function example

Clean up last tables of array operators and functions

Don't load unused package 'longtable'

Matrix/vector algebra functions return reals

This follows from #622 and reverts dc7ad4e3

No need to say Real/Integer - Real is enough

Minor cleanup of listing for 'cross'

Add files for editing files using Sublime Text (#2674)

* Add files for editing files using Sublime Text

Forbid mixing clocks (#2670)

Closes #2365

Specifically:
* Forbids noClock between different base-clocks.
* Forbids system of equations between different sub-clocks.

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

Change notation for mass flow rate from \dot{m} to \tilde{m}. (#2645)

* Change notation for mass flow rate from \dot{m} to \tilde{m}.
The reason is that it's the sum of mass flow rates that give \dot{m}
and the terms are not mass-derivatives.
Closes #2644

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

Specify that each is wrt enclosing array for its position (#2648)

* Clarify that each is enclosing wrt its position.
* Add example.
Closes #2630

Reorder rows of external function type mapping table

Addressing comment from Hans.

Partition table of 'Utility Functions for Reporting Errors' in three sections

Consistent use of comments between arguments to \lstdefinelanguage

Remove periods (.) from 'alsoletter'

Add line break before long \lstinline

Move comments above synchronous solver method equations

Force normal font weight in <th> elements

The <th> are produced by LaTeXML in somewhat mysterious ways, and this really messes up the look of tables due to the default browser behavior of using bold font weight for these elements.  This commit is a workaround for this styling problem.

Fix issue with syntax highlighting of 'getInstanceName' and 'terminal'

Add syntax highlighting of synchronous operators

Don't use \nameref* in LaTeXML build

Don't exclude directory 'css' from Sublime Text project

With the addition of MLS.css to this directory, there is at least one file that is meant for manual editing.  If there are files in this directory that shouldn't med edited manually, it could be the case that they should be removed from the directory, or that we should have different directories for the ones we should edit manually and the ones we shouldn't.

Restrict use of 'size' on components of expandable connectors (#2596)

Implements the part of the decision in #2560 that wasn't included in #2589.
* Restrict use of 'size' on components of expandable connectors
* Tidy up function calls that are parameter expressions; 
* Improve readability of source of nested item list on expandable connectors; Stumbled upon these when looking for specification of 'size'.
* Also throwing in some missing \lstinline.
* Say 'Error', not 'Not allowed' in listing comments
* Restrict uses of sizeless array components of expandable connectors

Clarify HTML encoded contents. (#2672)

* Clarify HTML encoded contents.
Closes #2593

Get rid of \autoref uses introduced by merge with 'central/master'

Don't we have jobs running that should catch this before it ends up on 'master'?

Teach Jenkins about MLS.css

Adjust monospace font size in LaTeXML build

Remove CSS files that are identical to the default ones from LaTeXML

Since LaTeXML may improve the default CSS files, having copies of these in our repository is just asking for conflicts.  When we want to style things different than the default, we should try to accomplish this using our own MLS.css instead.

Migrate modifications of LaTeXML.css to MLS.css

Keeping our own styling in a separate file will help when the CSS files one gets by default from LaTeXML are improved.

Scale down non-mathescape math in CSS instead of scaling up monospace

The default ratio between normal and monospace font size is actually quite nice.

Add comment regarding problem with labels on the LaTeXML 'master' branch

Fix build break by changing \autoref -> \cref (#2679)

Add missing period at end of last sentence in abstract (#2677)

Add workaround for LaTeXML issue leaving a ']' after abstract (#2678)

* Add workaround for LaTeXML issue leaving a ']' after abstract

Add enumeration and within as keywords, since it looked odd in the keyword table.

Better non-normative text for empty function calls.
The previous text contradicted the statements about functions with no outputs
in the pure chapter.

Use \lstinline on 'homotopy'

With change of styling, 'the ... operator' got redundant and was removed in all places but one.

Clean up whitespace in listing related to pure functions

Add missing \lstinline for 'homotopy'