Skip to content

Clean up casing of "Modelica language specification"#3906

Open
henrikt-ma wants to merge 7 commits into
modelica:masterfrom
henrikt-ma:cleanup/contributors
Open

Clean up casing of "Modelica language specification"#3906
henrikt-ma wants to merge 7 commits into
modelica:masterfrom
henrikt-ma:cleanup/contributors

Conversation

@henrikt-ma
Copy link
Copy Markdown
Collaborator

This is a cleanup PR with three parts:

@henrikt-ma henrikt-ma requested a review from HansOlsson May 20, 2026 09:18
@henrikt-ma henrikt-ma requested a review from beutlich May 20, 2026 09:21
Copy link
Copy Markdown
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with most of the changes, but some need a bit of discussion.
As far as I can tell the changes in the document are not blocking for the 3.7 release (will have to investigate if we can include them on the maintenance branch as a sort of errata without requiring a new vote).

I agree that it is much better to directly state that members of MAP-Lang contributed instead of referring to an appendix for the list of contributors and in the appendix only state that members of MAP-Lang contributed.

Discussion part:
I agree that we should be fairly consistent for the "Modelica Specification" capitalization, but for title, h1-headings and #-heading I think there's a strong case that one should use title capitalization, i.e., write it as "Modelica Specification". But that should be a bit more consistent - I notice that we also use "Hybrid Models" based on title-capitalization.

Copy link
Copy Markdown
Member

@beutlich beutlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, not sure actually. For me it's always been Modelica Language, Modelica Specification, Modelica Conference, Modelica Design Meeting, Modelica Standard Library etc.

Repo name is ModelicaSpecification.

About text also is with capitals

grafik

@HansOlsson
Copy link
Copy Markdown
Collaborator

HansOlsson commented May 21, 2026

Hm, not sure actually. For me it's always been Modelica Language, Modelica Specification, Modelica Conference, Modelica Design Meeting, Modelica Standard Library etc.

Repo name is ModelicaSpecification.

Yes, thinking more I think that makes sense, as I see there are two related points:

  • Titles and headings should use title capitalization we see that used fairly consistently in both the specification text and in the tutorial.
  • It should be consistent, so if the title (due to the previous fact) is "Modelica Language Specification" (without quotes) one will refer to it in that way (without quotes) - and that may be spread to things that seem like titles even if they aren't.

(The second point differs from APA style; but those rules seems over-designed.)

@HansOlsson HansOlsson self-requested a review May 21, 2026 08:46
Copy link
Copy Markdown
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As indicated I believe it should use title case.

@henrikt-ma
Copy link
Copy Markdown
Collaborator Author

I have not updated based on the following reasoning:

  • It should now be Modelica Language Specification in title case when referring to the specification document; the name (title) of the document is Modelica Language Specification.
  • However, I'd say that Modelica is the name of the language, so when referring to the language it is fine to just say Modelica when it is clear from context that it is the language and not something else Modelica-related that is being referred to. When one wants to clarify/emphasize that it the language one is referring to, the language is not treated as part of the name: Modelica language. Similar constructs include Modelica semantics, Modelica syntax, and Modelica community.
  • The full name of MAP-Lang is Modelica Association Project Modelica Language, or Modelica Language (full title case) when the MAP qualification is clear from context.
  • Even though not affecting this PR, I would reason similar when it comes to the MSL: The full name of the library is the Modelica Standard Library. However, when just using the top-level package name to refer to the library, it becomes the Modelica library, just like they do it at https://github.com/modelica/ModelicaStandardLibrary/tree/master. For another example, the Buildings people also write Buildings library at https://github.com/lbl-srg/modelica-buildings.

@henrikt-ma henrikt-ma requested a review from HansOlsson May 26, 2026 06:04
@henrikt-ma
Copy link
Copy Markdown
Collaborator Author

henrikt-ma commented May 26, 2026

  • The full name of MAP-Lang is Modelica Association Project Modelica Language, or Modelica Language (full title case) when the MAP qualification is clear from context.

I realize that I made a mistake here. It is true that Modelica Language is the name of the project, but MAP-Lang reads out as Modelica Assocation Project Language

Edit: This triggered related PR: modelica/MAP-Lang_ProjectRules#10

@@ -1,17 +1,14 @@
Guiding Principles of the Modelica Language Development
--
# Guiding Principles of the Modelica language development
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Guiding Principles of the Modelica language development
# Guiding Principles of the Modelica Language Development

I view this as title case; so all major words should be capital.

Comment thread chapters/preface.tex
The text directly under the chapter headings are non-normative introductions to the chapters.

The Modelica language has been developed since 1996.
Modelica~1, the first version of Modelica, was released in September 1997, and had the language specification as a short appendix to the rationale.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting; I was surprised by it just being 1 - not 1.0; but the document itself had just a 1.

Copy link
Copy Markdown
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor issue remains I think

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Outdated references to cleared appendix D

3 participants