Skip to main content
The Abbreviations panel lets you define short forms and their full-text expansions. When your document is rendered, abbreviations are automatically expanded on their first occurrence — the full text is written out followed by the abbreviation in parentheses. All subsequent occurrences display only the abbreviation. For example, if you define API → Application Programming Interface and use ~API~ multiple times in your text:
  • First occurrence → Application Programming Interface (API)
  • All following occurrences → API
Abbreviations sidebar panel

​
Adding an abbreviation

Click the Add button in the top-right corner of the panel to open the dialog.
Add abbreviation dialog
Each abbreviation has two fields:
FieldDescriptionExample
AbbreviationThe short form (key)API, HTML, GmbH
Full TextThe expanded meaningApplication Programming Interface

​
Key rules

  • Must start with a letter (including Unicode letters like ä, ö, ü, é)
  • Can contain letters and numbers after the first character
  • No spaces or special characters allowed
  • Keys are case-sensitive — WHO and who are different abbreviations
  • Duplicate keys are not allowed

​
Using abbreviations in your document

To reference an abbreviation in your text, wrap the key in single tildes: 
The ~API~ provides access to all resources.
According to the ~WHO~, regular exercise is recommended.
Do not confuse with strikethrough (~~text~~ — double tildes). Abbreviations use single tildes: ~API~.
Abbreviations also work inside formatted text: 
**The ~WHO~ recommends this approach.**
*According to the ~EU~ directive...*
You can quickly copy the syntax for any abbreviation by hovering over it in the panel and clicking the copy button. This copies ~KEY~ to your clipboard.

​
Managing abbreviations

  • Edit — click on any abbreviation in the list to edit its key or full text inline
  • Delete — hover over an abbreviation and click the delete button
  • Abbreviations are displayed sorted alphabetically by key

​
List of Abbreviations

You can insert an automatic List of Abbreviations into your document that collects all used abbreviations into a formatted table. To insert one, use the Indices button in the toolbar and select List of Abbreviations. The directive syntax is: 
::loa{title="List of 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
Only abbreviations that are actually used in the document (referenced with ~KEY~) will appear in the List of Abbreviations. Abbreviations that are defined but never referenced are not included.