Skip to content

Add more abbrivations; add/fix links to abbrivations/glossary#2112

Open
Tc-Fast wants to merge 1 commit intomodelica:mainfrom
Tc-Fast:broken_glossary_links
Open

Add more abbrivations; add/fix links to abbrivations/glossary#2112
Tc-Fast wants to merge 1 commit intomodelica:mainfrom
Tc-Fast:broken_glossary_links

Conversation

@Tc-Fast
Copy link
Contributor

@Tc-Fast Tc-Fast commented Feb 3, 2026

Since we changed the glossary, some links are broken. They should be fixed now or be removed.
Also I found some more abbreviations, not listed in the abbreviations table.
I linked all abbreviations in the documentation text (except the very common ones like "FMU" and "FMI").
I linked many references to the glossary (except the very common ones like "importer", etc.).

@Tc-Fast Tc-Fast requested a review from chrbertsch February 3, 2026 07:32
@Tc-Fast Tc-Fast force-pushed the broken_glossary_links branch 2 times, most recently from f5d5cbb to b183224 Compare February 3, 2026 07:42
@Tc-Fast Tc-Fast force-pushed the broken_glossary_links branch from b183224 to e4f941b Compare February 3, 2026 07:45
Copy link
Collaborator

@t-sommer t-sommer left a comment

Choose a reason for hiding this comment

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

I think the proposed use of xrefs is too excessive. It makes the text hard to read if words like XML, API, ZIP, etc. that the average reader is familiar with are turned into hyperlinks.

@chrbertsch
Copy link
Collaborator

Discussion: remove links to some common abbreviations. e.g. ZIP file.
Klaus: Explain e.g. vECU in more detail
Torsten: rule of thumb: if the first hit of Wikipedia gives the right definition, we can leave it out

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.

3 participants