Projekt

Allgemein

Profil

Index » Historie » Version 7

Martin Kraetke, 18.02.2021 17:10

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