With separation of normal and structural parameters, it seems possible to give a more imperative meaning of Evaluate, removing some room for ambiguities and unexpected differences between tools.
Two minor changes (in both files). The reason for specifying ISO 639-1 is that there's also ISO 639-2. https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes has 'de' as ISO 639-1 and 'deu', 'ger' as various ISO 639-2 codes, and ISO 639-3. Additionally https://www.loc.gov/standards/iso639-2/php/English_list.php there's gsw (Swiss German), nds (Low German), ...
Move description to synopsis. I use the same introductory text as Documentation, in order to clarify that the annotation has the same name as the record.
Add issue-column as well. I know that in most new cases it is a Pull-Request not an Issue, but the point is to use it for discussion so it doesn't matter.
Also removing the redundant parenthesis around links due to: - No need to highlight links when separate columns - Slightly less text which helps when adding more - The automatically generated link (for the new issues) are in this form
Remove arrayLayout since most tools have not implemented it. (#3196)
* Remove arrayLayout since most tools have not implemented it. As far as currently known no library uses it. Closes #3189 * EndExample Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Describe new annotation for checking number of connections. * Do not require that conditionally active connectors are connected; reverting #178 Closes #3117 * Apply suggestions from code review * Removed elided code as suggested, and indicate that something is missing. Also reduce to one flange-connector. * Remove 2nd one; turn into separate PR. Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Fix obsolete hard-coded cross-references from normal text to list items
Besides avoiding the bad use of hard-coded references, this fixes the problem that the references assume alphabetical enumeration, while the referenced enumeration is numeric.
Reformulate by adding definition. Additionally explain non-normatively why they are called 'state'. And remove 'state' from definition of previous (it makes the definition circular and isn't really true when previous is applied to a parameter).
Clarify role of protected components passed to external functions
Closes #3188. Note that the resolution is not according to the generalization that was first proposed in the issue, but on the contrary clearly rules out such a generalization.
* Clarify type compatible for records. Closes #3145 * Line based sentences. * Including feedback Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com> Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Extend choicesAllMatching to records. Closes #321 * Clarify that choicesAllMatching is valid in just two cases. And also specify that only recommend to present choices anyway for replaceable.
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com> Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
Change 'length modifier' -> 'length field specifier'
It seems unnecessary to use 'modifier', which generally has a very precise meaning in the specification, and isn't the term which seems to be standard when talking about format specifiers.
* Create README.md * Add from old svn-server * Added experience in Dymola. * Added user experience * As discussed at the meeting. * Clarified experience. * Removed empty-variant. The meeting otherwise found it ok. * Add semantics of break. * Clarify that it is legal despite the rules for balanced models. * Update chapters/inheritance.tex * Update RationaleMCP/0009/README.md * Correct rule for modifiers so that we can add equations in modifiers on base-classes. Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
Selective Model Extension (with specification text) (#3166)
MCP-0032: Initial commit. * MCP0032: Added summary of the discussions and decisions of the 99th Modelica Design Meeting. * MCP0032: Finished summary of the 99th Modelica Design Meeting. * MCP0032: Added next examples library version with final deselection syntax. * MCP0032: Added summary of the discussions and decisions at the 100th Modelica Design Meeting. * MCP0032: Added next examples library version with final deselection syntax. * MCP/0032: Update with latest feedback from the MAP-Lang meeting on 2021-09-18 and Elena Shmoylova (mostly clarification of rule 2.1 of "Semantic rules"-Section: deselected components must be models, blocks or connectors and deselecting a component also deselects all its connections). * Incorporated feedback from Leonardo Laguna Ruiz and Henrik Tidefelt (Wolfram Research, Inc., [System Modeler](https://www.wolfram.com/system-modeler/)) and Elena Shmoylova (Waterloo Maple Inc.) given on [GitHub](https://github.com/modelica/ModelicaSpecification/issues/3005), resulting in the new _"Non-normative explanation of some interesting consequences of the semantic rules"_ Section. * Correction annotation->annotation-clause outside of grammar-chapter. One related to MCP - rest unrelated; so we might cherry pick and add them to master. Co-authored-by: Christoff Bürger <Christoff.Buerger@gmail.com> Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com> Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Split the restrictions for when-equations into two lists, since they are different forms. The problem was introduced in Modelica 2.0 when the new restrictions were added. Closes #3291
In order to support search and copying of ligatures. Closes #3286 It may be that we need to install additional packages on the docker-image (cmap and one more).
It seems we don't use virtual fonts so the more complicated solution isn't needed. Note that an alternative would be to use mmap, which also adds math-handling. It has the nice benefit that symbols like \in and \bigcup are automatically handled by copy-paste. However, since it doesn't handle fractions it seems unclear if it is worth it.
* Missing type specifier in example Missing type specifier in the example for Removing modifiers. * Restore newline at end of file Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Remove "extends FilledShape" from Text-definitions. Closes# 2157 It has been deprecated for quite some time, and my proposal is that we either do it now or just after releasing 3.6.
* Search and replace fixes. Closes #3235 * Additional ones. Note that I replaced the use of colon before an example with ",". Clearly "e.g.,:" would seem excessive, and it wasn't clear that "e.g.:" is really correct (and it is at least rare). https://en.wikipedia.org/wiki/Colon_(punctuation) indicates that the part before colon should be a complete sentence and these abbrevs. aren't. * Update chapters/classes.tex * Apply suggestions from code review Restore case * Add it to the style guide as well. * Comma Before according to review * One more missing comma before * Better explanation of when to use comma * Apply suggestions from code review * Additional missing comma before. Note that one sentence was rewritten to add a parenthesis around the example-text.
Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
* More advanced elaboration. Specifically this allows hieararchical additions in buses - if the penultimate component is potentially present. Closes #3147 * Apply suggestions from code review
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com> Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
* Deprecate fake packages for lookup. Closes #3263 * Update chapters/scoping.tex * Separate out the deprecated case more clearly, and add explanation for "operator". * Keep calling it "requirements" * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Clarify encapsulated. Change grammar for two reasons: * It is type-specifier not IDENT * For encapsulated we really need the leading "." which is part of type-specifier. Closes #3270 * Clarify composite name lookup (related to encapsulated). * Clearer on global name lookup. * Consistent use of terminology. * Update chapters/classes.tex Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* 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>
Don't say that end is a function call, and be a bit clearer. (#3361)
* Don't say that end is a function call, and be a bit clearer. Closes #3351 * Update chapters/operatorsandexpressions.tex Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
This is just a rough manual conversion of the following file to get the MCP branch started: - https://svn.modelica.org/projects/MCP/MAinternal/MCP-0029_LicenseExport/MCP-0029_LicenseExport_Overview.pdf
Add minor specification text corresponding to what has been implemented. Since it can also occur at top-level packages we should likely add that as well
Specify how to handle invalid choices, #3311. I understand that it is different from the text in #3311 - but thinking about possible implementations I'm not sure which variant is best.
Give example of 'quoted identifier' to for two reasons
Reasons: 1) The quoted space illustrates why this wouldn't work for the simple %par form. 2) The quoted '}' is a reminder that finding the end of %{par} is not simply a matter of finding the first '}'.
Allow finding 'short class definition' in the document index
In order to make the index entry point to a good location, I needed to rephrase the paragraph slightly. I'd say breaking the sentence in two, like this, was good for readability anyway.
Clarify that there is no restriction for the text. Having a requirement that prevents a tool from just showing the text may have a bad performance impact.
* Clarify overdetermined connectors in general. * And new handling of redundant connections. Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com> Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
* Attempting to rename clocked. * Since discretized is part of clocked. * Better formatting to make it readable. * Try to be clear with sub-clock/base-clock. * Be clear with partitions, found when adding sub-clock/base-clock. * Introducing discretized. * Major change with new separatio of different kinds of paritions. * Cleaned up. * Clean up index. * Use sub-partition and base-partition. * Add conversion operators (the term, not the individual ones) to index. * Line break and explain clock vs clocked partition. Closes #3091
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com> Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
* Rename continuous-time partition to unclocked partition. At first non-clocked was considered, but it is used in logical circuits for something different. * Apply suggestions from code review Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
* Add proposed texts. The explanation for enable=false was simplified to just say "parameters not used". The reason is that there can be multiple reasons for not using a parameter in a configuration: - Propagated to disabled component - Different initialization, xi_start in Modelica.Blocks.Continuous.LimPID - Other configurations, dp_small in Modelica.Fluid.Fittings.BaseClasses.QuadraticTurbulent.BaseModel
(The models don't use this at the moment, and I don't think that these specific models should do it, but perhaps similar ones.)
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* GeneralizePostfixAccess * Using "an" for output-expression-list. * SpaceForClarity * New explanation of postfix operations that makes more sense. * Be clear about component references. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Clarify that component references work in this form. It is a clarification, since it already states that they are component-references and the quoted part includes it.
See https://github.com/modelica/ModelicaStandardLibrary/issues/4494
I was confused by the previous text and almost thought it was an error in the source. I believe this is as clear and it preserves the two important parts of the previous change: embedded space (required quoted identifier) and embedded } (more complicated quoting). It does not include a hierarchical name as that it is now explained separately. Should thus be merged after #3592 Not needed, but I think it avoids issue.
Be consistent for file extensions. In #3588 I realized that it's a bit unclear if the file extension starts with the dot or after the dot. https://en.wikipedia.org/wiki/Filename_extension isn't clear either Alternatively we could have the part after the dot, this is just to make it consistent
Specify that comments on choices shall not be copied. Closes #3397 Note that line 309 already contain "When present, the description-string of a modifier overrides the existing description."
Cleanup of attribute formatting and fix missing inline math (#3597)
* Sentence-based line breaks in derivationofstream.tex * Apply correct styling of min/max-attributes * Sentence-based line breaks in statemachines.tex * Apply correct styling of some more attributes * Restore missing line math Fixes #3596.
The scope creep (this is not about fixing styling of attributes) is unfortunate, but a consequence of still having some chapters which have not been converted to sentence-based line breaks.
* Add suspended hyphenation
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Based on comments in #3597 Clean up text, and restore some missing math. Merging the derivation and the stream-chapter would be a larger effort. * Update chapters/derivationofstream.tex Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Use space, not hyphen, in 'file system' There were already examples of this form in the document, and it is hard to find the form 'file-system' in other sources. * Source code readability * Clarifications of stored-definition Fixes #3466. * Don't hyphenate 'class-hierarchy' * Rephrase with 'whose name… matches' Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Update "parameter" to "evaluable" in connectors.tex
Changes in #3582 affected only equations.tex. I thought we should check connect.tex as well. I believe those are all instances where "parameter" should be "evaluable."
Be clearer in definition of Inf and avoid relying on Modelica.Constants. (#3612)
* Be clearer in definition of Inf and avoid relying on Modelica.Constants. * Avoid introducing another constant. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com> * Clarified logic further. * Based on feedback. * Be consistent for integer * Simpler text * Clearer * Indentation of comments
Describe lookup of annotation enumeration types (#3621)
* Describe lookup of annotation enumeration types Fixes #3620. For a better presentation, the content of 'Other Predefined Types' is reordered a bit, so that the true built-in enumeration types are presented next to each other, and the related but not truly built-in types are mentioned last. * Describe semantic restrictions of annotation syntax Fixes #3615. * Remove remark about possible shadowing issues in actual implementations * Omit "very" * Add cross reference for 'class-modification' * Remove labels on sections which shouldn't be referenced Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Default Icon; more or less according to decision. (#3624)
* More or less according to decision. Introducing a name for it to make it easier to refer to, and to break up the long sentence. Closes #3613 * Update chapters/annotations.tex Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Specify that annotations shall only be used where appropriate (#3642)
* Specify that annotations shall only be used where their semantics is defined. Closes #3638 * Update chapters/annotations.tex Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Use overview table for graphical user interface annotations * Rewrite broken reference to preferredView 'view' * Use overview table for usage restriction annotations Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com> * Reformulate as 'may at most be connected once'
Start clearing up annotation syntax for functions. (#3617)
* Start clearing up annotation syntax for functions. * Replace defaults in declarations by texts. Also provide smarter default for LateInline. Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Make it explicit that tools can show the value of variables for asserts (#3641)
* Make it explicit that tools can show the value of variables. See: https://github.com/modelica/ModelicaStandardLibrary/pull/4519 and https://github.com/modelica/ModelicaStandardLibrary/issues/4399
The reason for "may" is: - To not require the value to be duplicated, for cases such as: https://github.com/modelica/ModelicaStandardLibrary/issues/4399 - Support even smarter debugging.
I thought it was sufficiently important to make it normative.
* Reformulate to be clearer what is recommended for tools and users.
* Apply suggestions from code review
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Avoid confusing reuse of 'x' in spatialDistribution description (#3649)
* Avoid confusing reuse of 'x' in spatialDistribution description * Avoid ".0" in math * Fix half-baked partial derivative as suggested * Remove invalid relation between x and \xi * Add missing 't' arguments Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Be consistent with example. * Skip unneeded indentation. * Remove incorrect referene. * Try to be clearer. * Default for dates. * Rename class a suggested. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
I think this just clarifies the current text which had "expand into scalar equations"; but didn't consider that the original could be a record equation. I don't see a need to specify something special for inlining as it is just one case of expanding - and the current text also prohibits a=cat(1,a[2:end],{1}); We could change to "into e.g., scalar equations" - but it seems a bit excessive. Closes #3662
Move an example explanation from its current location after the 2nd example in the Merging of Modifications subsection to the 1st example where it actually applies.
Sentence-based line breaks and small fixes in inheritance.tex (#3682)
* Change to sentence-based line breaks in inheritance.tex * Break out comment from bottom of listing * Shorten too long comment in listing to fit page width
Describe common ways of using ModelicaUtilities.h (#3455)
* Describe common ways of using ModelicaUtilities.h * Mention that the MSL has an instance of ModelicaUtilities.h * Fix grammar and rewrite more clearly * Apply suggestion 'independently of Modelica tools' Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Skip all of the changes of font-size, it seemed to cause more problems. (#3664)
* Skip all of the changes of font-size, it seemed to cause more problems. * Restore as comments - but have "NOT ACTIVE" at the start to reduce confusion.
Clarify division and introduce element-wise (#3714)
* Give reference for division (and exponentiation). Closes #3710 * Reorder operations in list. The reason for this is that the text below should preferably use the same order, and to me "multiplication, addition, and subtraction" or "exponentiation and division" just looks wrong. Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Make it easier to see which operators that are not allowed inside functions (#3717)
* Make it easier to see which operators that are not allowed inside functions Fixes #3280. * Fix bad double negation * Extend list of examples of disallowed operators As suggested by Hans. * Repeat that when-statements are not allowed in function bodies As suggested by Hans. * Improve language As suggested by Hans. Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Have one clear definition of equation count. Closes #3703 I'm fully aware that there's a push to not scalarize, it is not intended to prevent that - only to define the size.
Use modern table presentation for choices and choicesAllMatching (#3741)
* Use modern table presentation for choices and choicesAllMatching * Reformulate slightly Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Clarify strange sentence #3729 And also unify noEvent-handling: I assume that the previous text was a bit odd since it talked about "event-generating" to avoid stating that it only applied outside of noEvent; I thus found it necessary to add a noEvent-context for the new text. And unfortunately the noEvent-part had to be unified. Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Apply modern table presentation to Versions (#3737)
* Apply modern table presentation to Versions * Improve annotation readability * Fix grammar of 'conversion-rule' * Add semicolon after 'version' * Rewrite bad sentence for version-annotation as two sentences * Change PACKAGE-VERSION-STRING -> PACKAGE-VERSION Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Seems general consensus that is good enough * Update README.md Add link to tutorial * Add files via upload Add figures from 1.4 rationale, and fig5 from 1.4 tutorial. * Create and Update Tutorial.md Manually converted from pfd-document. Add contents Add spaces Replace file mapping and MODELICAPATH by references. - Basically the file mapping was too messy to quickly clean up for me. We could re-add it someone has the time. - The MODELICAPATH information was outdated. We no longer recommend relying on an environment variable (since that creates a mess with multiple tool). Update to Modelica 2 graphical annotations. Remove most of the graphical annotations, since those details don't fit with a tutorial. Remove changes, and update references. The enable-attribute does not exist, and they are now called "conditional components" not "conditional models". Having a more detailed tutorial for state-machines would be good. Be consistent with the Modelica standard library. Updated link-references, internally, to spec, and to MSL. Minor cleanup Also propose if-equations, since if-expressions seems like a bad solution. Introduce if-equations as a better alternative, and also update explanation to explain why. Use if-equation for pendulum as well. Add images Missed language setting Indicate that it isn't just 1.4. Use ElectricPotential instead of Voltage in the connectors. Fix indentation Modelica.SIunits -> Modelica.Units.SI and specific changes. Convert to code. Updated some bad code to current Modelica. Referencing SCCS and old version systems isn't good. And saying that the history information is _comparable_ to version control systems no longer seem relevant with good version control systems. so just deleted. Sensible reference. Closes #3674 Adds a list of new features, and notes that the tutorial is up-to-date, but doesn't explain newer features. Update Minor text change, and Replaced examples-link to first workshop by link to all proceedings. Update homotopy with doi-link RelativeLinks CleanUpLinks SentenceBasedLineBreaks FixLists FixLongLines Have refences on a separate line. That makes it easier to generate pdf of the document. NoFancyQuote Factor out listings part so that it can be re-used Merge #3665 into this branch. A bit more complicated due to restructuring. Replace fake-enumeration example by two cases that make sense. They are based on real types: Modelica.Mechanics.MultiBody.Types.Axis Modelica.Blocks.Types.FilterType But simplified. Note that enumerations were added in Modelica 2.0, after the tutorial. SwiftlyAddingBlankSpace --------- Co-authored-by: Thomas Beutlich <modelica@tbeu.de>
Gather all specification of interval() at first tick under 'interval' (#3761)
* Remove excessive empty lines * Move sentence in rational interval clock text into example Based on positive reaction to https://github.com/modelica/ModelicaSpecification/issues/3751#issuecomment-3352385221. * Move all specification of interval() at first tick into one place Fixes #3751. * Change initial 'interval()' for rational interval clock Per request from Hans.
Make the grammar more consistent, and explain rewrite based on feedback. (#3757)
* Make the grammar more consistent, and explain rewrite based on feedback. * Nonnormative * AddWS * Update chapters/syntax.tex * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
The links were no longer working, when the branches are merged. Changing to using the folder on master in that case, and changing header to "Documents". We _could_ make a clearer distinction, or have a separate column for just the branch - but that's mostly internal and for external use this should suffice. (Similarly removing the documents-folder once merged doesn't make sense for external use.)
* Proposal for improving pure situation, to ensure that current MSL is valid and that users can update. Closes #3719 Note that in addition to the changes in the issue reordered the items and changed "must" to "should" for the deprecated semantic, and clearly indicated that the exception is the deprecated case. (Having a "must"-requirement and then have exceptions for it just seems wrong.) Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Discrete-time variability based on GenerateEvents (#3610)
* Add variability change for these functions. * After some thinking I believe this is how we handle multiple outputs. So, an Integer output will be discrete-time, but a Real output still non-discrete time (assuming the inputs are non-discrete time). * To handle the other case for GenerateEvents-functions. * Forgot variability for inputs previously. * State that variables in functions being discrete-time is a bit more complicated, with link. * Add examples. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Describe 'delay' as event-generating operator (#3730)
* Describe 'delay' as event-generating operator * Remove obsolete table entry * Generalize 'delay' to discrete-valued types * Clarify event generation for discontinuities in non-discrete-time input * Define 'delay' variability in the natural way based on first argument * Add missing \mathit around variable name Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Correcting the issues in #3732 * Rename "number of variables" to "number of potential variables" to reduce confusion. * Break tie for input/output causality. * For N2 case. * Update chapters/classes.tex * TheRestrictionForOverdetermined
Generalize modern table presentation with application to Protection (#3770)
* Generalize modern table presentation with application to Protection * Remove redundant addition of 'preferredView' to document index * Modern table presentation for graphical objects IN PROGRESS * Don't use "Annot.SubAnnot" notation in annotation synopsis * Present Documentation similarly to Protection * Improve structure of the 'figures' annotation presentation * Fix typo * Don't end paragraph with a colon * Further improve introduction to Placement * Don't repeat specification in section introduction * Non-normative rationale for iconTransformation
* Specifying solvability requirement for non-Real equations. Closes #3779 * Be clearer for multi-returning functions. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Change from parameter to evaluable. Closes #3799 Note that there's one remaing parameter that also should be changed, but it is part of #3798 * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Fix language mistakes in "left hand side" and "similarly as" (#3817)
* Systematic hyphenation of 'left-hand side' and 'right-hand side' * Systematically change "similarly as" -> "similarly to" * Say 'for variability as if' * Say 'using bar directly in a model' * Say 'Similar to locally balanced' Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Add example for subSample,superSample for non-clock * UseInteger * Move description. * Example for shiftSample * Forgot end * Add back-sample signal example. * Apply suggestions from code review * Make example non-normative. And description of example for event-clocks. I didn't use the simpler "Event clocks cannot be super-sampled:" * Change to just numbers, not formatted as Modelica. * ClarifyThatTime * MoveIntoExample Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Main part of using start or fallback-value for inputs. * WS * Exception for fallback value. * Try to add some language indicating that it depends. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* In the previous text it looked as if "potential" was redundant, now it is instead formulated to first define "potential" variable and then use it. * Cleaner handling of degrees of freedom with focus on the important case. Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Systematic hyphenation of 'left-hand side' and 'right-hand side' * Systematically change "similarly as" -> "similarly to" * Initial work on defining local balance per type * Restore rule for outer components * Say "locally balanced for Real" * Merge items and simplify language Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Minor cleanup * Clean up record definition of the Text for connection lines * Clarify where 'rotation' and 'origin' are coming from * Clean up example by not explaining deprecated behavior * Remove deprecations and introduce TextAlignment.Automatic * Improve sentence about forbidden TextAlignment.Automatic * Skip the word "other"
* Introduce heading * Split into two sub-sections to make it even easier. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Clarify events in algorithms, and add examples. (#3837)
* Clarify events in algorithms, and add examples. * Split example in two, and explain that same for for-equation. * Apply suggestions from code review Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
* Allow der-operator in the left-hand-side syntactically also for algorithms. * Also specify semantics of assignment to derivatives. * Based on feedback. * AsSuggested
Linkable grammar productions and lexical units (#3863)
* Make grammar productions linkable * Remove leading white-space * Change UNSIGNED-NUMBER -> unsigned-number Upper case names should be reserved for lexical tokens * Link references to grammar productions * Fix dangling reference to 'comment' production * Make lexical units linkable in the same way as grammar productions * Fix malformed references to grammar productions * Avoid duplicating within-clause grammar * Avoid duplicating function call grammar * Avoid repeating connect-equation grammar * Don't repeat component declaration grammar * Don't repeat grammar for component clauses and class definitions * Don't repeat grammar for external function declaration * Don't repeat definition of the IDENT lexical unit * Don't repeat grammar of relational and logical expressions * Don't repeat grammar for extends-clause * Avoid repeating grammar for redeclare extends, and clean up examples * Don't repeat grammar for constraining-clause * Don't repeat grammar for der-class-specifier * Don't repeat grammar for equation section * Don't repeat grammar for for-equation * Don't repeat grammar for connect-equation * Don't repeat grammar for if-equation * Don't repeat grammar for when-equation
* Insert empty lines for better source code readability
* Don't repeat grammar for algorithm section
* Don't repeat grammar for for-statement
* Update outdated duplicated grammar
* Don't repeat grammar for while-statement
* Use 'grammar' language for grammar listing
* Don't repeat grammar for if-statement
* Don't repeat grammar for when-statement
* Insert empty lines for source code readability
* Remove weird grammar examples of "for-clause prefixes"
Based on discussion with Hans.
* Avoid abuse of grammar in presentation of for-index constructs
* Improve description of simple equality equation, with reference to grammar
* Improve description of simple assignment statement, with reference to grammar
* Don't repeat grammar for multi-output assignment
* Use Modelica instead of grammar in listing showing break-statement
* Update grammar listings in notation section
* smoothOrder should be UNSIGNED-INTEGER
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* smoothOrder() should be UNSIGNED-INTEGER
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Derivative constraint 'order' should be UNSIGNED-INTEGER
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Fix typo 'equatins' -> 'equations'
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
* Clarify which 'name'
---------
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Non-normatively give rough explanation of 'tunable parameter' (#3867)
* Non-normatively give rough explanation of 'tunable parameter' * Fix typo * Give some examples of reasons for not being tunable * Clean up "User Input" and cross-reference tunable parameters
* See if we can just remove the MathJax. The alternative would be to improve the logic as most browsers now are MathML capable. * For some reason CI doesn't use Makefile... * AndFeathers
