Projekt

Allgemein

Profil

Index Markup » Historie » Version 6

Martin Kraetke, 23.12.2021 12:38

1 1 Martin Kraetke
h1. Index Markup
2
3
h2. Word
4
5 6 Martin Kraetke
Transpect-tex provides four methods to encode an index. They can be combined with each other.
6 1 Martin Kraetke
7 4 Martin Kraetke
h3. (1) Word-Index 
8 1 Martin Kraetke
9 4 Martin Kraetke
Obviously, the native Word Index feature is supported. With the @\f@ switch, you can specify the index type.
10 2 Martin Kraetke
11 1 Martin Kraetke
!index.png!
12
13 4 Martin Kraetke
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.
14 1 Martin Kraetke
15 4 Martin Kraetke
If you create an index listing with Word, it does not initially contain index entries that have a certain index type with "\ f".
16 5 Martin Kraetke
But here are instructions on how to create an index listing for [[Indexverzeichnis-Typ| index entries with type]].
17 1 Martin Kraetke
18 6 Martin Kraetke
h3. (2) Encode index entries via character style
19 1 Martin Kraetke
20 6 Martin Kraetke
You can markup phrases with a specific character style to encode them as index entry. During the conversion, an index entry is created from a phrase which has the character style (@[a-z]{1,3}_index_mark@). Index entries that are already encoded with the Word index feature are ignored and not encoded twice.
21 1 Martin Kraetke
22 6 Martin Kraetke
h3. (3) List of index search terms
23 1 Martin Kraetke
24 6 Martin Kraetke
You can create a list of index search terms at the end of the document. During the conversion the converter searches for matches in the content and creates an index entry for each match. There are specific requirements on the list of index search terms. Each entry must have the paragraph style @[a-z]{1,3}_index_list@ and needs to be placed in a separate paragraph. Index entries that are already encoded via Word index feature (1) or character style (2) are ignored and not encoded twice. You can also use the character style @[a-z]{1,3}_index_name@ to mark only a part of the index search term, e.g. for John Doe, _Doe_ can be marked so that an index entry is also created for the phrase _Mr Doe_.
25 1 Martin Kraetke
26 6 Martin Kraetke
h3. (4) Static index
27 1 Martin Kraetke
28 6 Martin Kraetke
If you do not want to automatically search for entries in the text in the index, you can also insert a static index. You need to insert a list of index entries that yield the @index_static@ style. Page numbers in the form of @entry 144, 156, 192@ are linked to the page, i.e. you have to make sure that the page reference is correct!
29 1 Martin Kraetke
30
h3. Index-Überschriften und Index-Position steuern
31
32
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.
33
34
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.
35
36
37
h2. Hub
38
39
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:
40
41
<pre><code class="xml">
42
<indexterm remap="e" type="Tiere">
43
  <primary>Wolf</primary>
44
  <secondary>Lamm</secondary>
45
</indexterm></code></pre>
46
47
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.
48
49
<pre><code class="xml">
50
<index type="Tiere" remap="e">
51
  <title role="tsindexheadingTiere">Tiere</title>
52
</index>
53
</code></pre>
54
55
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.
56
57
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]].
58
59
<pre><code class="xml">
60
<index remap="c" type="Orte">
61
  <title role="tsindexheadingOrte">Ortsregister</title>
62
  <indexdiv>
63
    <title>B</title>
64
    <indexentry>
65
      <primaryie>Bertelé, <xref xlink:href="page-93"/>, <xref xlink:href="page-94"/></primaryie>
66
    </indexentry>
67
    <!-- (…) -->
68
  </indexdiv>
69
</index>
70
</code></pre>
71
72
73
h2. TeX
74
75
h3. Auszeichnung multipler Indexes und deren Überschriften
76
77
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.
78
79
h4. Deklaration der Index-Typen
80
81
Das Paket erlaubt mehrere Indexe. Diese werden mit dem \(re)newindex-Befehlen deklariert:
82
<pre><code class="text">
83
\newindex{<typ>}{<endung rohindex>}{<endung fertiger index>}{<Überschrift>}
84
</code></pre>
85
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.
86
87
Der Default- oder Hauptindex kriegt das Label @default@, dessen ÜS lässt sich wie folgt überdefinieren:
88
<pre><code class="text">
89
\renewindex{default}{idx}{ind}{Personenregister}
90
</code></pre>
91
Die Index-Einträge für diesen Index werden  mit 
92
<pre><code class="text">
93
\index{<Lemma>}
94
</code></pre>
95
deklariert. Ausgegeben wird der Hauptindex wird mit 
96
<pre><code class="text">
97
\printindex
98
</code></pre>
99
100
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:
101
<pre><code class="text">
102
\newindex{o}{o_idx}{o_ind}{Ortsverzeichnis}
103
</code></pre>
104
Die Index-Einträge würden dann mit 
105
<pre><code class="text">
106
\index[o]{<Term>}
107
</code></pre>
108
deklariert, der Index mit 
109
<pre><code class="text">
110
\printindex[o]
111
</code></pre>
112
ausgegeben.
113
114
h4. Aufruf des Index-Skripts
115
116
Mit dem optionalen Argument kann angegeben werden, welcher Index generiert werden soll. Wird das optionale Argument weggelassen, wird der Hauptindex erzeugt:
117
<pre><code class="text">
118
./index.sh <tex-Dateiname ohne Endung>
119
</code></pre>
120
Der Aufruf mit optionalen Argument erzeugt den Neben-Index, z.B.
121
<pre><code class="text">
122
./index.sh <tex-Dateiname ohne Endung> o
123
</code></pre>
124
würde das Ortsverzeichnis aus o.g. Beispiel erzeugen. Das Skript muss also für jeden Index einzeln aufgerufen werden.
125
126
h3. Generierung des Index
127
128
h4. Generieung der Indexe durch TeX
129
130
Heißt: Indexeinträge sind mittels \index[<typ>]{<Lemma>} in TeX kodiert.
131
132
<pre><code class="xml">
133
lualatex <tex-Dateiname>.tex     %% Initialer TeX-Lauf; einsammeln der ÜSen
134
lualatex <tex-Dateiname>.tex     %% Erzeugen des IHV; seitenzahlen verschieben sich ggf. 
135
lualatex <tex-Dateiname>.tex     %% Zur Sicherheit... 
136
./index.sh <tex-Dateiname>       %% OHNE Endung!
137
./index.sh <tex-Dateiname> <typ> %% Zweites, optionales Argument für Index-Typ anders als default, s.u.
138
lualatex  <tex-Dateiname>.tex    %% Index wird erstmalig ausgegeben, ÜS wird geschrieben
139
lualatex  <tex-Dateiname>.tex    %% ÜS(en) für Index(e) in IHV gerendert
140
lualatex  <tex-Dateiname>.tex    %% Zur Sicherheit...
141
</code></pre>
142
143
h4. Statische Index-Dateien
144
145
Heißt: @<basename>.<typ>_ind@ kommt vom Konverter
146
147
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.