LaTeX-Wörterbuch: Abkürzungsverzeichnis
Um ein einfaches Abkürzungsverzeichnis zu erstellen, bietet sich das acronym-Paket an.
Für umfangreichere Verzeichnisse empfiehlt sich das Paket glossaries, da es gleichzeitig die automatische Sortierung ermöglicht und Symbolverzeichnisse sowie ein Glossar unterstützt. Das ältere Paket nomencl kann Doppelnennungen im Verzeichnis hervorrufen wenn Abkürzungen innerhalb von Umgebungen genutzt werden und ist daher nicht zu empfehlen.
Im Folgenden wird die Syntax des acronym-Pakets beschrieben.
Einbindung
Bearbeiten\usepackage[''Optionen'']{acronym}
Für Optionen sind mögliche Werte:
- footnote -- die Langform als Fußnote ausgeben
- nohyperlinks -- wenn hyperref geladen ist, wird die Verlinkung unterbunden
- printonlyused -- nur Abkürzungen auflisten, die tatsächlich verwendet werden.
- Im printonlyused-Modus kann zusätzlich noch die Option withpage verwendet werden. Hierdurch wird im Abkürzungsverzeichnis zusätzlich die Seitenzahl, auf welcher die Abkürzung als erstes verwendet wurde, ausgegeben.
- smaller -- Text soll kleiner erscheinen, das Paket relsize wird vorausgesetzt
- dua -- es wird immer die Langform ausgegeben
- nolist -- es wird keine Liste mit allen Abkürzungen ausgegeben
Optionen sind optional.
Verzeichnis
Bearbeiten\begin{acronym}[Bash]
\acro{KDE}{K Desktop Environment}
\acro{SQL}{Structured Query Language}
\acro{Bash}{Bourne-again shell}
\acro{JDK}{Java Development Kit}
\acro{VM}{Virtuelle Maschine}
\acro{I2C}[I²C]{Inter-Integrated Circuit}
\end{acronym}
Dazu kann ein Kurzname zwischen der Abkürzung und der Langform angegeben werden (wie z.B. bei I²C). Dies ist nötig bei z.B. mathematischen Zeichen, da in der Abkürzung nur normale Zeichen eingesetzt werden dürfen. Der zugehörige Aufruf sieht wie gewohnt aus: \ac{I2C}, im erzeugten Dokument erscheint für die Abkürzung der Kurzname I²C.
Nach \begin{acronym} kann in eckigen Klammern ein Ausdruck angegeben werden. Nach der Länge dieses Ausdrucks wird der Einzug der ausgeschriebenen Abkürzungen gesetzt. Hier empfiehlt es sich, die längste Abkürzung zu verwenden um einen gleichmäßigen Einzug bei allen Abkürzungen zu erhalten.
Verwendung im Text
BearbeitenHier nur die wichtigsten Beispiele:
\ac{KDE} % K Desktop Environment (KDE)
Gibt bei der ersten Verwendung die Langform mit der Abkürzung in Klammern aus, ab dann stets die Kurzform.
\acs{KDE} % KDE
Gibt die Abkürzung aus.
\acf{KDE} % K Desktop Environment (KDE)
Gibt die Langform und die Kurzform aus.
\acl{KDE} % K Desktop Environment
Gibt nur die Langform ohne die Kurzform aus.
Analog zu den obigen Befehlen kann man den Plural auch entsprechend anzeigen:
\acp{KDE} % K Desktop Environments (KDEs)
\acsp{KDE} % KDEs
\acfp{KDE} % K Desktop Environments (KDEs)
\aclp{KDE} % K Desktop Environments
Falls der Plural nicht auf -s endet, so kann man diesen mit folgendem Befehl festlegen:
\acrodefplural{VM}[VMs]{Virtuelle Maschinen}
Quellen
Bearbeiten- Dokumentation (PDF, englisch)