> ## Documentation Index
> Fetch the complete documentation index at: https://docs.autype.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Abbreviations Panel

> Define abbreviation expansions that are used throughout your document and appear in the List of Abbreviations.

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

<Frame>
  <img src="https://mintcdn.com/centerbit/xsS3MEtCpKEJ0qMD/images/application/sidebar-abbreviations/sidebar-abbreviations-panel.png?fit=max&auto=format&n=xsS3MEtCpKEJ0qMD&q=85&s=3fb024df120af6c810c14debd316d4f7" alt="Abbreviations sidebar panel" width="1660" height="1274" data-path="images/application/sidebar-abbreviations/sidebar-abbreviations-panel.png" />
</Frame>

***

## Adding an abbreviation

Click the **Add** button in the top-right corner of the panel to open the dialog.

<Frame>
  <img src="https://mintcdn.com/centerbit/xsS3MEtCpKEJ0qMD/images/application/sidebar-abbreviations/add-abbreviation-modal.png?fit=max&auto=format&n=xsS3MEtCpKEJ0qMD&q=85&s=8e28d7184035f68dd9dce245caf7e828" alt="Add abbreviation dialog" width="798" height="567" data-path="images/application/sidebar-abbreviations/add-abbreviation-modal.png" />
</Frame>

Each abbreviation has two fields:

| Field            | Description          | Example                             |
| ---------------- | -------------------- | ----------------------------------- |
| **Abbreviation** | The short form (key) | `API`, `HTML`, `GmbH`               |
| **Full Text**    | The expanded meaning | `Application 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**:

```markdown theme={null}
The ~API~ provides access to all resources.
According to the ~WHO~, regular exercise is recommended.
```

<Warning>
  Do not confuse with strikethrough (`~~text~~` — double tildes). Abbreviations use **single** tildes: `~API~`.
</Warning>

Abbreviations also work inside formatted text:

```markdown theme={null}
**The ~WHO~ recommends this approach.**
*According to the ~EU~ directive...*
```

<Tip>
  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.
</Tip>

***

## 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 <Icon icon="trash-2" size={16} /> 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 <Icon icon="list-tree" size={16} /> **Indices** button in the [toolbar](/getting-started/editor/editor-overview#toolbar) and select **List of Abbreviations**.

The directive syntax is:

```markdown theme={null}
::loa{title="List of Abbreviations"}
```

### Attributes

| Attribute   | Values                     | Description                    |
| ----------- | -------------------------- | ------------------------------ |
| `title`     | String                     | Title displayed above the list |
| `sortOrder` | `alphabetical`, `document` | Sort order of abbreviations    |

* **`alphabetical`** — sort abbreviations A–Z (default)
* **`document`** — list abbreviations in the order they first appear in the document

<Note>
  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.
</Note>