xerif

h1. Index Markup

h2. Word

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

h3. (1) Word-Index 

Obviously, the native Word Index feature is supported. With the @\f@ switch, you can specify the index type.

!index.png!

The index listing is generated based upon the marked index entries in the main text. The Word feature _Insert index_ in the ribbon entitled _References_ shall be used only for your own control. It is removed during the process.

If you create an index listing with Word, it does not initially contain index entries that have a certain index type with "\ f".

But here are instructions on how to create an index listing for [[index directory type | index entries with type]].

h3. (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.

h3. (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.

h3. (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!

h3. 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.

h2. 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:

<pre><code class="xml">

<indexterm remap="e" type="Tiere">

  <primary>Wolf</primary>

  <secondary>Lamm</secondary>

</indexterm></code></pre>

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.

<pre><code class="xml">

<index type="Tiere" remap="e">

  <title role="tsindexheadingTiere">Tiere</title>

</index>

</code></pre>

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#Aufruf-des-Index-Skripts]].

<pre><code class="xml">

<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>

</code></pre>

h2. TeX

h3. Auszeichnung multipler Indexes und deren Überschriften

Wir verwenden das LaTeX-Paket "index":https://mirror.dogado.de/tex-archive/macros/latex/contrib/index/index.pdf für die Rohindexerzeugung, sowie Xindy zum Generieren des fertigen Registers.

h4. Deklaration der Index-Typen

Das Paket erlaubt mehrere Indexe. Diese werden mit dem \(re)newindex-Befehlen deklariert:

<pre><code class="text">

\newindex{<typ>}{<endung rohindex>}{<endung fertiger index>}{<Überschrift>}

</code></pre>

Damit der Skriptaufruf später korrekt funktioniert, müssen die beiden Endungen bei *nicht-default-Typen* dem Schema @<typ>_idx@ (Rohindex) bzw. @<typ>_ind@ (fertiger Index) entsprechen.

Der Default- oder Hauptindex kriegt das Label @default@, dessen ÜS lässt sich wie folgt überdefinieren:

<pre><code class="text">

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

</code></pre>

Die Index-Einträge für diesen Index werden  mit 

<pre><code class="text">

\index{<Lemma>}

</code></pre>

deklariert. Ausgegeben wird der Hauptindex wird mit 

<pre><code class="text">

\printindex

</code></pre>

Angenommen, wir wollen zusätzlich zu diesem noch ein Ortsverzeichnis, dann müssen wir in der Präambel der tex-Datei einen neuen Index-Typ deklarieren:

<pre><code class="text">

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

</code></pre>

Die Index-Einträge würden dann mit 

<pre><code class="text">

\index[o]{<Term>}

</code></pre>

deklariert, der Index mit 

<pre><code class="text">

\printindex[o]

</code></pre>

ausgegeben.

h4. Aufruf des Index-Skripts

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

<pre><code class="text">

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

</code></pre>

Der Aufruf mit optionalen Argument erzeugt den Neben-Index, z.B.

<pre><code class="text">

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

</code></pre>

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

h3. Generierung des Index

h4. Generieung der Indexe durch TeX

Heißt: Indexeinträge sind mittels \index[<typ>]{<Lemma>} in TeX kodiert.

<pre><code class="xml">

lualatex <tex-Dateiname>.tex     %% Initialer TeX-Lauf; einsammeln der ÜSen

lualatex <tex-Dateiname>.tex     %% Erzeugen des IHV; seitenzahlen verschieben sich ggf. 

lualatex <tex-Dateiname>.tex     %% Zur Sicherheit... 

./index.sh <tex-Dateiname>       %% OHNE Endung!

./index.sh <tex-Dateiname> <typ> %% Zweites, optionales Argument für Index-Typ anders als default, s.u.

lualatex  <tex-Dateiname>.tex    %% Index wird erstmalig ausgegeben, ÜS wird geschrieben

lualatex  <tex-Dateiname>.tex    %% ÜS(en) für Index(e) in IHV gerendert

lualatex  <tex-Dateiname>.tex    %% Zur Sicherheit...

</code></pre>

h4. Statische Index-Dateien

Heißt: @<basename>.<typ>_ind@ kommt vom Konverter

Bei statischen Indexes darf die @index.sh@ *nicht aufgerufen* werden, da sonst die *ind-Dateien überschrieben würden! Alle anderen Schritte sind dieselben; @\(re)newindex{}{}{}{}@ muss auch hier verwendet werden. Zum einen für die ÜSen, und zum anderen damit @\printindex[<typ>]@ keine "unknown index type"-Fehler auswirft.