Projekt

Allgemein

Profil

Index Markup » Historie » Version 2

Martin Kraetke, 22.12.2021 18:28

1 1 Martin Kraetke
h1. Index Markup
2
3
h2. Word
4
5
Es werden vier miteinander kombinierbare Varianten unterstützt, einen Index in Word zu kodieren:
6
7
h3. (1) Word-Indexfunktion
8
9
Natürlich wird die reguläre Word-Indexfunktion unterstützt, Mit dem Schalter @\f@ kann zudem der Indextyp angegeben werden:
10
11 2 Martin Kraetke
12
13
14 1 Martin Kraetke
15
transpect 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.
16
17
Wenn man mit Word ein Indexverzeichnis erstellt, enthält dieses zunächst nicht Indexeinträge, die mit "\f" einen bestimmten Indextyp haben. 
18
Hier ist aber eine Anleitung, wie man für [[Indexverzeichnis-Typ|Indexeinträge mit Typ ein Index-Verzeichnis erstellen]] kann.
19
20
h3. (2) Auszeichnen des Indexeintrags per Zeichenformat
21
22
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.
23
24
h3. (3) Konkordanzliste
25
26
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.
27
28
h3. (4) Statischer Index
29
30
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!
31
32
h3. Index-Überschriften und Index-Position steuern
33
34
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.
35
36
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.
37
38
39
h2. Hub
40
41
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:
42
43
<pre><code class="xml">
44
<indexterm remap="e" type="Tiere">
45
  <primary>Wolf</primary>
46
  <secondary>Lamm</secondary>
47
</indexterm></code></pre>
48
49
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.
50
51
<pre><code class="xml">
52
<index type="Tiere" remap="e">
53
  <title role="tsindexheadingTiere">Tiere</title>
54
</index>
55
</code></pre>
56
57
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.
58
59
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]].
60
61
<pre><code class="xml">
62
<index remap="c" type="Orte">
63
  <title role="tsindexheadingOrte">Ortsregister</title>
64
  <indexdiv>
65
    <title>B</title>
66
    <indexentry>
67
      <primaryie>Bertelé, <xref xlink:href="page-93"/>, <xref xlink:href="page-94"/></primaryie>
68
    </indexentry>
69
    <!-- (…) -->
70
  </indexdiv>
71
</index>
72
</code></pre>
73
74
75
h2. TeX
76
77
h3. Auszeichnung multipler Indexes und deren Überschriften
78
79
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.
80
81
h4. Deklaration der Index-Typen
82
83
Das Paket erlaubt mehrere Indexe. Diese werden mit dem \(re)newindex-Befehlen deklariert:
84
<pre><code class="text">
85
\newindex{<typ>}{<endung rohindex>}{<endung fertiger index>}{<Überschrift>}
86
</code></pre>
87
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.
88
89
Der Default- oder Hauptindex kriegt das Label @default@, dessen ÜS lässt sich wie folgt überdefinieren:
90
<pre><code class="text">
91
\renewindex{default}{idx}{ind}{Personenregister}
92
</code></pre>
93
Die Index-Einträge für diesen Index werden  mit 
94
<pre><code class="text">
95
\index{<Lemma>}
96
</code></pre>
97
deklariert. Ausgegeben wird der Hauptindex wird mit 
98
<pre><code class="text">
99
\printindex
100
</code></pre>
101
102
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:
103
<pre><code class="text">
104
\newindex{o}{o_idx}{o_ind}{Ortsverzeichnis}
105
</code></pre>
106
Die Index-Einträge würden dann mit 
107
<pre><code class="text">
108
\index[o]{<Term>}
109
</code></pre>
110
deklariert, der Index mit 
111
<pre><code class="text">
112
\printindex[o]
113
</code></pre>
114
ausgegeben.
115
116
h4. Aufruf des Index-Skripts
117
118
Mit dem optionalen Argument kann angegeben werden, welcher Index generiert werden soll. Wird das optionale Argument weggelassen, wird der Hauptindex erzeugt:
119
<pre><code class="text">
120
./index.sh <tex-Dateiname ohne Endung>
121
</code></pre>
122
Der Aufruf mit optionalen Argument erzeugt den Neben-Index, z.B.
123
<pre><code class="text">
124
./index.sh <tex-Dateiname ohne Endung> o
125
</code></pre>
126
würde das Ortsverzeichnis aus o.g. Beispiel erzeugen. Das Skript muss also für jeden Index einzeln aufgerufen werden.
127
128
h3. Generierung des Index
129
130
h4. Generieung der Indexe durch TeX
131
132
Heißt: Indexeinträge sind mittels \index[<typ>]{<Lemma>} in TeX kodiert.
133
134
<pre><code class="xml">
135
lualatex <tex-Dateiname>.tex     %% Initialer TeX-Lauf; einsammeln der ÜSen
136
lualatex <tex-Dateiname>.tex     %% Erzeugen des IHV; seitenzahlen verschieben sich ggf. 
137
lualatex <tex-Dateiname>.tex     %% Zur Sicherheit... 
138
./index.sh <tex-Dateiname>       %% OHNE Endung!
139
./index.sh <tex-Dateiname> <typ> %% Zweites, optionales Argument für Index-Typ anders als default, s.u.
140
lualatex  <tex-Dateiname>.tex    %% Index wird erstmalig ausgegeben, ÜS wird geschrieben
141
lualatex  <tex-Dateiname>.tex    %% ÜS(en) für Index(e) in IHV gerendert
142
lualatex  <tex-Dateiname>.tex    %% Zur Sicherheit...
143
</code></pre>
144
145
h4. Statische Index-Dateien
146
147
Heißt: @<basename>.<typ>_ind@ kommt vom Konverter
148
149
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.