Glossar & Abkürzungen

Die Toolchain unterstützt Sie in der Pflege eines einheitlichen Glossars und Abkürzungsverzeichnisses für alle Ausgabeformate. In der PDF wird können Sie das Glossar und das Abkürzungsverzeichnis einfügen und es werden die Begriffe und Abkürzungen im Text automatisch verlinkt. In den Web-Ansichten wird das Glossar und das Abkürzungsverzeichnis automatisch in abbr-Tags (HTML-Tag zur Erläuterung von Begriffen und Abkürzungen) umgewandelt und verlinkt.

Format

Das Glossar und das Abkürzungsverzeichnis werden in einer YAML-Datei gepflegt. Die Datei muss im Wurzelverzeichnis des Dokuments (z. B. /dokument) liegen und den Namen glossar.yaml bzw. abkuerzungen.yaml haben.

Jeder Begriff oder jede Abkürzung wird in der Datei als Schlüssel-Wert-Paar definiert. Der Schlüssel ist der Begriff oder die Abkürzung und der Wert ist die Erläuterung. Beides wird durch einen Doppelpunkt getrennt.

Zu beachten

• Die Datei muss im YAML-Format vorliegen.
• Die Datei muss den Dateinamen glossar.yaml bzw. abkuerzungen.yaml haben.
• Die Datei muss im Wurzelverzeichnis des Dokuments liegen.
• Schlüssel dürfen nicht mit Umlauten oder nicht lateinischen Zeichen beginnen. Umlaute können aber wie in IT-Lösung im Schlüssel enthalten sein. (siehe auch bekannte Fehler)
• Es werden Markdown-Links [Beschreibung](https://...) unterstützt.
• Es werden keine weiteren Formatierungen unterstützt.

Beispiel

Einbindung in den Text

Um das Glossar und das Abkürzungsverzeichnis in die PDF-Ausgabe einzufügen, müssen Sie die folgenden Befehle in die entsprechenden Dateien einfügen: