Start
LaTeX
Projekte
Datenschutz
Impressum
LaTeX Extra > LaTeX Pakete > Listofsymbols Die Seite als PDF Listofsymbols Paket
1 listofsymbols - Symbolverzeichnis mit LaTeX
Das Paket listofsymbols stellt eine Möglichkeit dar in LaTeX ein Symbolverzeichnis zu erstellen.
Das Paket listofsymbols benötigt seinerseits noch die Pakete ifthen und clac. Um alle vorhanden Optionen verwenden zu können benötigt es zudem die Pakete nomencl und xspace.
1.1 Einbinden des Paketes
Eingebunden wird das Paket wie folgt:
\usepackage{listofsymbols}
1.2 Mögliche Optionen
Beim Einbinden werden bereits die drei Optionen draft, nopageno und usexspace per default gesetzt. Daneben gibt es noch fünf andere Optionen, sodass es insgesamt acht Optionen für das Paket gibt. Da sich die Optionen aber zum Teil gegenseitig ausschließen sind maximal drei Optionen gleichzeitig möglich.
- draft Die draft Option wird standardmäßig gesetzt. Entspricht einem Entwurfmodus, was bedeutet das unter anderem die Befehle für die Symbole in der Symbolübersicht auftauchen und hinter der Bezeichnung List of Symbols das Wort draft geklammert erscheint. Im Verzeichnis selbst werden die Symbole markiert ob sie verwendet wurden (yes) oder nicht (no).
- final Wird final als Option gesetzt dann werden nur die verwendeten Symbole angezeigt. Auch wird das Wort draft unterdrückt, wie auch die Befehle für die Symbole und ob diese gesetzt wurden.
- Final Die Option Final wirkt ähnlich wie final mit dem Unterschied, dass die vom Paket erzeugten Zusatzdatei (.sym und .sub) nicht mehr verändert werden.
- nomencl Bei Verwendung dieser Option wird das Symbolverzeichnis mit dem Paket nomencl gesetzt.
Von den Optionen draft, final, Final und nomencl kann jeweils nur eine zur gleichen Zeit gesetzt werden.
- nopageno Die Option nopageno wird standardmäßig gesetzt. Sie hat dabei die Wirkung, dass keine Seitenzahlen im Verzeichnis angezeigt werden.
- pageno Die Option pageno fügt im Verzeichnis die Seitenzahl der Seite ein auf der das Symbol definiert wurde.
Es kann entweder nopageno oder pageno gesetzt werden.
- usexspace Die Option usexspace wird standardmäßig gesetzt. Sie fügt automatisch einen Abstand hinter dem Symbol im Text ein.
- noxspace Wird die Option noxspace gesetzt wird kein automatischer Abstand hinter dem Symbol gesetzt. Das führt dazu, dass das nachfolgende Wort mit dem Symbol verschmelzen kann. Daher muss hier von Hand einen Abstand einfügen.
Sinnvollerweis kann nur entweder usexspace oder noxspace gesetzt werden.
Es ergeben sich zwar insgesamt 16 verschiedene mögliche Kombinationen wovon für den überwiegenden Teil der Anwender nur drei von Interesse sind.
\usepackage[]{listofsymbols}
\usepackage[final]{listofsymbols}
\usepackage[Final]{listofsymbols}
1.3 Symbole erstellen
Die Symbole werden mittels des Befehls newsym innerhalb einer eigenen Umgebung (symdef) erstellt. Diese kann sowohl vor als auch nach \begin{document} eingefügt werden. Alternativ kann die Umgebung auch in eine seperate Datei ausgelagert werden.
\opensymdef
\newsym[Beschreibung]{Symbolbefehl}{Symbol}
\closesymdef
- Die Beschreibung erscheint später im Verzeichnis. Wenn die Beschreibung weggelassen wird, erscheint bei final beziehungsweise Final kein Eintrag im Symbolverzeichnis. Dies gilt auch für den Fall, dass das Symbol verwendet wurde.
- Der Symbolbefehl kann selbst frei gewählt werden.
- Die Ausgabe des Symbols erfolgt innerhalb des ensuremath Befehls, das bedeutet vereinfacht gesagt, die Ausgabe des Symbols sollte sich wie innerhalb einer Mathematikumgebung verhalten.
1.3.1 Beispiel
Das folgende Beispiel zeigt den Aufbau einer Symdef Umgebung und wie die Symbole definiert werden können. Die verwendeten Befehle setzen das einbinden von amsmath und amssymb voraus!
\opensymdef
\newsym[Menge aller natürlichen Zahlen ohne die Null]{symnz}{\mathbb{N}}
\newsym[Menge aller natürlichen Zahlen einschließlich Null]{symnzmn}{\mathbb{N}_{0}}
\newsym[Menge aller ganzen Zahlen]{GZ}{\mathbb{Z}}
\newsym[Menge aller rationalen Zahlen]{RatZ}{\mathbb{Q}}
\newsym[Menge aller reellen Zahlen]{RZ}{\mathbb{R}}
\newsym[Aufrechter Buchstabe]{AB}{\text{A}}
\closesymdef
1.3.2 Symbolverzeichnis einfügen
Im Dokument selbst erscheint das Symbolverzeichnis an der Stelle wo der Befehl listofsymbols eingefügt worden ist. Dieser darf sich nicht innerhalb der Symdef Umgebung befinden.
Soll die Bezeichnung von List of Symbols auf Symbolverzeichnis geändert werden, kann dies wie folgt beschrieben umgesetzt werden:
\renewcommand{\symheadingname}{Symbolverzeichnis}
2 Symbolverzeichnis erstellen
- Zu Beginn werden die Symbole innerhalb der Symdef Umgebung definiert. An der gewünschten Stelle wird das Symbolverzeichnis eingefügt. Die jeweiligen Symbolbefehle werden innerhalb des Dokumentes gesetzt. In dieser Phase sollte die Option draft gesetzt sein beziehungsweise keine der anderen.
- Wenn das Dokument fertig ist, wird die Option auf final gesetzt und mindestens einmal kompiliert.
- Danach kann die automatisch angelegte .sym Datei bearbeitet und wenn gewünscht sortiert werden.
- Abschließend wird die Option Final gesetzt und mindestens einmal kompiliert. Wird eine andere Option final oder draft gesetzt wird die .sym Datei wieder überschrieben.
2.1 Beispiel
\documentclass[ngerman]{article}
\usepackage{babel}
...
\usepackage{amsmath,amssymb}
...
\usepackage[]{listofsymbols}
...
\begin{document}
\opensymdef
\newsym[Menge aller natürlichen Zahlen ohne die Null]{symnz}{\mathbb{N}}
\newsym[Menge aller natürlichen Zahlen einschließlich Null]{symnzmn}{\mathbb{N}_{0}}
\newsym[Menge aller ganzen Zahlen]{GZ}{\mathbb{Z}}
\newsym[Menge aller rationalen Zahlen]{RatZ}{\mathbb{Q}}
\newsym[Menge aller reellen Zahlen]{RZ}{\mathbb{R}}
\newsym[Aufrechter Buchstabe]{AB}{\text{A}}
\closesymdef
\renewcommand{\symheadingname}{Symbolverzeichnis}
\listofsymbols
Text ... Text
mehr Text ... mehr Text
\end{document}
Hinweis: Bei der Verwendung des ß innerhalb des Beschreibungstextes kann es Fehlermeldung der folgenden Art geben:
! Undefined control sequence.
...
...lichen Zahlen einschlie\T1\ss lich Null
Eine Lösung hierfür ist, dass der Ausgabefehler erst einmal ignoriert wird. Wenn das Dokument fertig ist wird die .sym Datei bearbeitet und der \T1\ss Fehler durch ß ersetzt. Die .sym Datei danach abspeichern. Anschliessend die Option auf Final setzen. Kompilieren und fertig.
Quelle: http://mirrors.ctan.org/macros/latex/contrib/listofsymbols/listofsymbols.pdf
Wir verwenden Cookies. Wenn Sie weiter auf unseren Seiten surfen, stimmen Sie der Nutzung von Cookies zu. mehr Informationen hier