Handbuch UDO > Die UDO-Syntax > Verschiedenes Index

Indizes

Um in einem Quelltext Einträge für ein Indexregister anzugeben, gibt es den Befehl !index und die Platzhalter (!idx) und (!index). Indizes können und sollten mehrfach angegeben werden.

Der Befehl zur Angabe eines Indexeintrags lautet folgendermaßen:

!index Indexeintrag

Der Indexeintrag erscheint dann im Index von LaTeX, im Index der mit Plain-TeX bearbeiteten Texinfo-Datei, im Index des ST-Guide-Hypertextes sowie im Stichwortverzeichnis der Textverarbeitung, mit der Sie die RTF-Datei importieren. Bei WinHelp erscheint der Indexeintrag im Suchen-Dialog.

Um einen mehrstufigen Indexeintrag anzulegen, benutzen Sie ein doppeltes Ausrufezeichen als Trennung der einzelnen Stufen. Es werden bis zu drei Stufen unterstützt. Mehrstufige Indizes sollten Sie dann einsetzen, falls Sie davon ausgehen können, dass die Leserin/der Leser bei der Suche nach einem Wort auf verschiedene Art und Weise im Indexregister nachschaut.

Falls Sie denken, dass der Leser bei der Suche nach dem Wort Zeilenabstand im Index auch unter Abstand nachschauen wird, sollten Sie beide Indexeinträge vornehmen.

!index Zeilenabstand
!index Abstand !! Zeilen

Bei der Platzhalterversion können zwischen einem und vier Parameter benutzt werden. Die folgenden Beispiele zeigen, wie die Umsetzung nach LaTeX, WinHelp und RTF erfolgt:

UDO:	ein `(!idx)` `[Index]`
LaTeX:	ein Index\index{Index}
RTF:	ein {\xe\v Index}Index
Win:	ein {K{\footnote K Index}}Index
sonst:	ein Index

UDO:	ein `(!idx)` `[Wort] [Index]`
LaTeX:	ein Wort\index{Index}
RTF:	ein {\xe\v Index}Wort
Win:	ein {K{\footnote K Index}}Wort
sonst:	ein Wort

UDO:	ein `(!idx)` `[Wort] [Index] [Subindex]`
LaTeX:	ein Wort\index{Index!Subindex}
RTF:	ein {\xe\v Index, Subindex}Wort
Win:	ein {K{\footnote K Index, Subindex}}Wort
sonst:	ein Wort

UDO:	ein `(!idx)` `[Wort] [Index] [Subindex] [Subsubindex]`
LaTeX:	ein Wort\index{Index!Subindex!Subsubindex}
RTF:	ein {\xe\v Index, Subindex, Subsubindex}Wort
Win:	ein {K{\footnote K Index, Subindex, Subsubindex}}Wort
sonst:	ein Wort

Hinweise:

Die Umwandlung von Indizes lässt sich durch den Schalter !no_index im Vorspann unterbinden.
Kapitelüberschriften, Labels und Aliase gelangen standardmäßig bei keinem Format in den Index. Sie können dies allerdings automatisch von UDO erledigen lassen, indem Sie die Schalter !use_nodes_inside_index, !use_label_inside_index und !use_alias_inside_index im Vorspann setzen.
Steht in einem Kapitel der Schalter !ignore_index, gelangt die Überschrift nicht in den Index. Auch dann nicht, wenn Sie den Schalter !use_nodes_inside_index verwenden.
Wenn Sie nach LaTeX umwandeln und Index-Befehle verwenden, so fügt UDO in die LaTeX-Datei die für das Programm Makeindex nötige Befehle ein. Sonderzeichen in den Indizes werden bereits speziell für Makeindex angepasst.
Die jeweiligen Parameter werden also durch eckige Klammern eingefasst. Falls Sie in einem Parameter eine schließende eckige oder runde Klammer benutzen möchten, muss deren Wirkung mit einem Ausrufezeichen aufgehoben werden. Geschieht dies nicht, so denkt UDO, der Parameter oder der Index-Befehl wäre bereits beendet. Ein Beispiel:
```
Falsch:  (!idx [Copyright (c) 1995])
Richtig: (!idx [Copyright (c!) 1995])
```