Index¶

Word¶

Es werden vier miteinander kombinierbare Varianten unterstützt, einen Index in Word zu kodieren:

(1) Word-Indexfunktion¶

Natürlich wird die reguläre Word-Indexfunktion unterstützt. Mit dem Schalter \f kann zudem der Indextyp angegeben werden:

Xerif erstellt das Indexverzeichnis aus den Indexeinträgen selbst. Die Funktion Index einfügen im Word-Ribbon Referenzen mit der man ein Word-Indexverzeichnis erstellen kann, dient also nur zur Kontrolle.

Wenn man mit Word ein Indexverzeichnis erstellt, enthält dieses zunächst nicht Indexeinträge, die mit "\f" einen bestimmten Indextyp haben.
Hier ist aber eine Anleitung, wie man für Indexeinträge mit Typ ein Index-Verzeichnis erstellen kann.

(2) Auszeichnen des Indexeintrags per Zeichenformat¶

Indexeinträge können festgelegt werden, indem Wörter oder Wortgruppen mit einem Zeichenformat (Regex: [a-z]{1,3}_index_mark) ausgezeichnet werden. Indexeinträge die bereits mit der Word-Indexfunktion kodiert wurden, werden ignoriert.

(3) Konkordanzliste¶

Indexeinträge können anhand einer Konkordanzliste automatisch kodiert werden. Dafür muss eine Liste von Indexeinträgen am Ende des Dokuments eingefügt werden. Überall wo im restlichen Dokument Wörter oder Wortgruppen aus dieser Liste gefunden werden, wird automatisch ein Indexeintrag kodiert. Dafür muss ein Indexeintrag mit dem Absatzformat (Regex: [a-z]{1,3}_index_list) verwendet werden. Jeder Eintrag muss in einem separaten Absatz stehen. Indexeinträge die bereits mit der Word-Indexfunktion oder via Zeichenformat index kodiert wurden, werden ignoriert.

(4) Statischer Index¶

Sollen nicht automatisch im Text Fundstellen für Einträge im Index gesucht werden, kann man auch einen statischen Index einfügen. Dafür zeichnet man einfach eine Liste mit Indexeinträgen mit dem Format index_static aus. Seitenzahlen in der Form Eintrag 144, 156, 192 werden dann nur mit der Seite verknüpft, d.h. hier muss man selbst dafür Sorge tragen, dass die Seitenreferenz auch richtig ist!

Index-Überschriften und Index-Position steuern¶

Man kann individuelle Index-Überschriften mit einem Absatzformat (Regex: [a-z]{1,3}_index_heading) auszeichnen. Der Index wird an der Stelle gerendert, wo die Überschrift im Dokument steht.

Bei Konkordanzlisten und statischen Registern muss die Überschrift über dem Index stehen und das Format (Regex: [a-z]{1,3}_index_heading) haben. Sonst funktioniert die Zuordnung nicht. Bei Indexen mit einem Typ muss der Typ als Zusatz am Absatzformat stehen, also z.B. [a-z]{1,3}_index_heading_Tiere. Wenn keine Index-Überschrift ausgezeichnet ist, wird ein Standardtext eingefügt (z.B. Index) und der Index am Ende des Dokuments eingefügt.

Hub¶

Es können alle vier Varianten einen Index zu erstellen miteinander kombiniert werden. Im Hub-Format erhalten Indexeinträge im Text ein remap-Attribut, was sie einem bestimmten Index zuordnet:

<indexterm remap="e" type="Tiere">
  <primary>Wolf</primary>
  <secondary>Lamm</secondary>
</indexterm>

Für jeden Index wird zudem ein <index>-Element erzeugt. Entweder steht das an der Stelle, wo die Indexüberschrift gesetzt wurde, oder am Ende. In dem Überschriftenformat kann man am Ende auch den Indextyp anhängen.

<index type="Tiere" remap="e">
  <title role="tsindexheadingTiere">Tiere</title>
</index>

Bei statischen Indexen wird davon ausgegangen, dass die Überschrift über den Indexeinträgen steht. Über den Formatzusatz kann hier aber auch der Typ des Indexes angegeben werden. Seitenzahlen werden später auf die Seite verlinkt.

Für statische Indexe wird schon bei der XML-Konvertierung eine passende .x_ind-Datei erzeugt. Bei dynamischen Indexen im Text muss diese erst noch über die index.sh erzeugt werden. Siehe dazu weiter unten Index.

<index remap="c" type="Orte">
  <title role="tsindexheadingOrte">Ortsregister</title>
  <indexdiv>
    <title>B</title>
    <indexentry>
      <primaryie>Bertelé, <xref xlink:href="page-93"/>, <xref xlink:href="page-94"/></primaryie>
    </indexentry>
    <!-- (…) -->
  </indexdiv>
</index>

TeX¶

Auszeichnung multipler Indexe und ihrer Überschriften¶

Wir verwenden das LaTeX-Paket index für die Rohindexerzeugung sowie Xindy zum Generieren des fertigen Registers.

Deklaration der Indextypen¶

Das Paket erlaubt mehrere Indexe. Diese werden mit dem \newindex- bzw. \renewindex-Befehl deklariert:

\newindex{<Typ>}{<Endung, Rohindex>}{<Endung, fertiger Index>}{<Überschrift>}

Damit der Skriptaufruf später korrekt funktioniert, müssen die beiden Endungen bei Nichtstandardtypen dem Schema <Typ>_idx (Rohindex) bzw. <Typ>_ind (fertiger Index) entsprechen.

Der Standard- oder Hauptindex bekommt das Label default, dessen Überschrift sich wie folgt überdefinieren lässt:

\renewindex{default}{idx}{ind}{Personenregister}

Die Indexeinträge für diesen Index werden mittels

\index{<Lemma>}

deklariert. Ausgegeben wird der Hauptindex über

\printindex

Soll zusätzlich zum Hauptindex bspw. ein Ortsverzeichnis erstellt werden, muss in der Präambel der TeX-Datei ein neuer Indextyp deklariert werden:

\newindex{o}{o_idx}{o_ind}{Ortsverzeichnis}

Die Indexeinträge werden dann über

\index[o]{<Begriff>}

deklariert, der Index selbst mittels

\printindex[o]

ausgegeben.

Aufruf des Indexskripts¶

Mit dem optionalen Argument kann angegeben werden, welcher Index generiert werden soll. Wird das optionale Argument weggelassen, wird der Hauptindex erzeugt:

bash ./index.sh <tex-Dateiname ohne Endung>

Der Aufruf mit optionalen Argument erzeugt den Nebenindex, z. B.

bash ./index.sh <tex-Dateiname ohne Endung> o

würde das als o angelegte Ortsverzeichnis aus obigem Beispiel erzeugen. Das Skript muss also für jeden Index einzeln aufgerufen werden.

Generierung des Index¶

Generierung der Indexe durch TeX¶

siehe Kompilierung

Statische Indexdateien¶

Im Falle eines statischen Index werden die Einträge über Indexdateien mit dem Namensschema <basename>.<typ>_ind geliefert. Der Kompilationsschritt des Aufrufens von index.sh darf dann nicht ausgeführt werden, da dieser die vorgefertigte(n) Indexdatei(en) überschreiben würde. Auch ein statischer Index erfordert im TeX-Dokument die Verwendung des \newindex{…}{…}{…}{…}-Makros in der Präambel, da \printindex[…] sonst einen Fehler wegen eines unbekannten Indextyps erzeugen würde.