Akronyme und Symbolverzeichnisse
Ein Entwurf mit glossaries-extra oder eine von Hand gepflegte Liste, wenn das genügt.
Akronyme und Symbolverzeichnisse
Lange Dokumente sammeln Abkürzungen an, und die Konventionen dazu sind streng. Ein Akronym wird bei der ersten Verwendung ausgeschrieben, danach abgekürzt, und eine Abschlussarbeit braucht meist ein Abkürzungsverzeichnis im Vorspann. Von Hand gepflegt, scheitert das auf vorhersehbare Weise. Sie vertauschen zwei Kapitel, die erste Verwendung wandert, und plötzlich steht „ML“ drei Seiten vor „machine learning (ML)“. Das Paket glossaries-extra verfolgt die erste Verwendung für Sie.
Der automatisierte Weg
\usepackage[acronym]{glossaries-extra}\makeglossaries\newacronym{ml}{ML}{machine learning}Die Option acronym aktiviert die Unterstützung für Akronyme, und \makeglossaries schaltet den Mechanismus ein, der beim Kompilieren die Einträge sammelt. Jedes \newacronym nimmt drei Argumente: einen Schlüssel, den Sie im Text tippen, die Kurzform und die Langform. Definieren Sie alle in der Präambel oder in einer separaten Datei, die Sie mit \input einbinden, damit sie an einer Stelle liegen.
Im Haupttext tippen Sie das Akronym selbst nie:
\gls{ml} on first use expands; later uses stay short.\printglossariesDas erste \gls{ml} im Dokument gibt „machine learning (ML)“ aus, jedes spätere nur „ML“. Weil das Paket die Verwendung verfolgt und nicht die Position im Quelltext, folgt die ausgeschriebene Form der ersten Verwendung, egal wohin Ihre Umstrukturierung sie verschiebt. \printglossaries gibt die gesammelte Abkürzungsliste dort aus, wo Sie den Befehl platzieren, üblicherweise nach dem Inhaltsverzeichnis. Verwandte Befehle decken die Grammatik ab: \glspl für den Plural, \Gls für den großgeschriebenen Satzanfang.
Der Haken liegt im Build. Zwischen den LaTeX-Durchläufen muss das Hilfsprogramm makeglossaries laufen, um die Einträge zu sortieren und zu formatieren, sonst gibt \printglossaries stillschweigend nichts aus. Vollständige latexmk-Setups erledigen das automatisch. Einfachere Pipelines tun das womöglich nicht, und glossaries-extra bietet dafür eine Ausweichlösung. Wenn Ihre Liste hartnäckig nicht erscheint, ist der fehlende Lauf des Hilfsprogramms der erste Verdächtige, noch weit vor einem Fehler in Ihrem Dokument.
Der Weg von Hand
Für eine einfache Liste von Symbolen genügt oft eine von Hand gepflegte description-Umgebung:
\section*{Notation}\begin{description} \item[$\eta$] learning rate \item[$\theta$] model parameters\end{description}Jedes \item[...] gibt sein Argument in eckigen Klammern als fette Bezeichnung aus, gefolgt von der Erklärung, und genau diese Form hat ein Notationsverzeichnis. Es gibt keine Verfolgung der ersten Verwendung, aber ein Symbolverzeichnis braucht selten eine; Symbole werden ohnehin dort definiert, wo sie in der Mathematik zum ersten Mal auftauchen.
Der ehrliche Rat lautet: Wählen Sie das Werkzeug passend zum Umfang. Ein Paper mit fünf Akronymen lässt sich leichter von Hand verwalten. Eine Abschlussarbeit mit 200 Seiten und vierzig Akronymen nicht, und dort zahlt sich der Einrichtungsaufwand des Pakets um ein Vielfaches aus. Die Lektion zu Listen behandelt die description-Umgebung ausführlicher.