Skip to main content
Abbreviations let you mark short forms in your text. They are collected automatically and can be rendered as a List of Abbreviations.

​
Syntax

Wrap an abbreviation in single tildes: 
The ~WHO~ recommends regular exercise.
The ~EU~ has strict data protection laws (~GDPR~).

​
Rules

  • Must start with a letter (including Unicode letters like ä, ö, ü, é, etc.)
  • Can contain letters and numbers after the first character
  • Case-sensitive: ~WHO~ and ~who~ are different abbreviations
  • Examples: ~WHO~, ~GDPR~, ~API~, ~REST~, ~KfW~, ~GmbH~
Do not confuse with strikethrough (~~text~~ — double tildes). Abbreviations use single tildes.

​
Abbreviations inside formatted text

Abbreviations work inside bold, italic, and other formatting marks: 
**The ~WHO~ recommends this approach.**
*According to the ~EU~ directive...*

​
List of Abbreviations

Generate an automatic list of all abbreviations used in the document: 
::listOfAbbreviations{title="List of Abbreviations"}
Short alias: 
::loa{title="Abbreviations"}

​
Attributes

AttributeValuesDescription
titleStringTitle displayed above the list
sortOrderalphabetical, documentSort order of abbreviations
  • alphabetical — sort abbreviations A–Z (default)
  • document — list abbreviations in the order they first appear in the document

​
Example

::loa{title="Abkürzungsverzeichnis" sortOrder=alphabetical}
The abbreviation definitions (what each abbreviation stands for) are managed in your document settings, not in the Markdown source. The ~ABK~ syntax only marks where abbreviations are used.