############################################################
# @(#) Indizes, Dirk Hagedorn, 10.11.1995
############################################################

!subsubnode Indizes

!index !/index
!index (!/idx ...)

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

Der Befehl zur Angabe eines Indexeintrags lautet folgendermaßen:

!begin_quote
!begin_verbatim
!index Indexeintrag
!end_verbatim
!end_quote

Der Indexeintrag erscheint dann im Index von (!LaTeX), im Index des mit
Plain-(!TeX) bearbeiteten Texinfo-Files, im Index des
ST-Guide-Hypertextes sowie im Stichwortverzeichnis der Textverarbeitung,
mit der man die RTF-Datei importiert. Bei WinHelp erscheint der
Indexeintrag im Suchen-Dialog.

Um einen mehrstufigen Indexeintrag anzulegen, benutzt man ein
doppeltes Ausrufezeichen als Trennung der einzelnen Stufen.
Es werden bis zu drei Stufen unterstützt. Mehrstufige Indizes sollte
man dann einsetzen, falls man davon ausgehen kann, daß der Leser bei
der Suche nach einem Wort auf verschiedene Art und Weise im
Indexregister nachschaut.

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

!begin_quote
!begin_verbatim
!index Zeilenabstand
!index Abstand !! Zeilen
!end_verbatim
!end_quote


!smallskip

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:

!begin_quote
!begin_verbatim
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
!end_verbatim
!end_quote


!smallskip

(!HINTS)

!begin_enumerate

!index !/no_index
!item Die Umwandlung von Indizes läßt sich durch den Schalter
(!I)!/no_index(!i) im Vorspann unterbinden.

!index !/use_nodes_inside_index
!index !/use_label_inside_index
!index !/use_alias_inside_index

!item 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
(!I)!/use_nodes_inside_index(!i),
(!I)!/use_label_inside_index(!i) und
(!I)!/use_alias_inside_index(!i) im Vorspann setzen.

!index !/ignore_index

!item Steht in einem Kapitel der Schalter (!I)!/ignore_index(!i), so
gelangt die Überschrift nicht in den Index. Auch dann nicht, wenn man
den Schalter (!I)!/use_nodes_inside_index(!i) verwendet.

!index Makeindex

!item Wenn man nach (!LaTeX) umwandelt und Index-Befehle verwendet, so
fügt UDO in das (!LaTeX)-File die für das Programm ""Makeindex""
nötige Befehle ein. Sonderzeichen in den Indizes werden bereits speziell für
Makeindex angepaßt.

!item Die jeweiligen Parameter werden also durch eckige Klammern eingefaßt. Falls
man in einem Parameter eine schließende eckige oder runde Klammer benutzen
möchte, so muß 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:

!begin_quote
!begin_verbatim
Falsch:  (!idx [Copyright (c) 1995] )
Richtig: (!idx [Copyright (c!) 1995] )
!end_verbatim
!end_quote

!end_enumerate

