abbreviations.yaml Format
Referenz des einheitlichen Formats für Glossar-Einträge und Abkürzungen.
Dateipfad
| Modus | Pfad |
|---|---|
| Einzelsprache | dokument/abbreviations.yaml |
| Mehrsprachig | dokument/{locale}/abbreviations.yaml (z. B. dokument/de/abbreviations.yaml) |
Legacy-Dateien (glossar.yaml, abkuerzungen.yaml) im Root werden weiterhin als Fallback geladen und gemergt.
Formate
Einfaches Format (flach)
Jeder Schlüssel ist der erkannte Begriff, der Wert die Definition.
Erweitertes Format (Objekt)
Felder
| Feld | Typ | Required | Beschreibung |
|---|---|---|---|
value | string | ja | Definition des Begriffs |
type | string | nein | "glossary" oder leer. Wird von der CI/LaTeX-Pipeline genutzt, von DWT ignoriert. |
variants | string[] | nein | Alternative Schreibweisen, die ebenfalls im Text erkannt werden (z. B. Pluralformen, Genitiv) |
Beide Formate können in derselben Datei gemischt werden.
Verarbeitung
Begriffserkennung
Ein Remark-Plugin durchsucht jede Markdown-Datei nach definierten Begriffen. Erkannte Begriffe werden als <abbr>-Elemente gerendert:
- Tooltip: Beim Hovern erscheint die Definition
- Glossar-Link: Per
data-canonical-Attribut wird auf den Anker in der Glossar-Seite verlinkt - Varianten: Alle in
variantsdefinierten Schreibweisen werden ebenfalls erkannt und auf den kanonischen Eintrag verlinkt
Glossar-Seite
Die CLI generiert automatisch eine Glossar-Seite (/glossar) mit allen Einträgen in alphabetischer Reihenfolge. Die Seite kann über --hide-glossary-page-in-menu aus der Navigation ausgeblendet werden.
| Modus | Generierte Datei |
|---|---|
| Einzelsprache | glossary.ts |
| Mehrsprachig | glossary-{locale}.ts pro Sprache |
Locale-Erkennung
Bei mehrsprachigen Projekten wird die Sprache aus dem Dateipfad abgeleitet (/de/seite.mdx → Locale de). Das Plugin lädt die abbreviations.yaml des entsprechenden Locale-Ordners.
Migration von Legacy-Dateien
| Alt | Neu |
|---|---|
glossar.yaml | abbreviations.yaml (Einträge mit type: glossary) |
abkuerzungen.yaml | abbreviations.yaml (Einträge ohne type) |
Beide Legacy-Dateien werden weiterhin geladen. Für neue Projekte wird das einheitliche abbreviations.yaml-Format empfohlen.