Projekt

Allgemein

Profil

Formatvorlagen » Historie » Version 65

Marcus Hottenroth, 27.12.2023 07:36

1 1 Martin Kraetke
h1. Formatvorlagen
2
3 43 Martin Kraetke
{{toc}}
4
5 1 Martin Kraetke
h2. Präfix
6
7 61 Marcus Hottenroth
Alle Formatvorlagennamen enthalten ein Präfixkürzel, das den Verlag identifiziert und mit einem Unterstrich vom restlichen Formatvorlagennamen abgetrennt wird.
8 1 Martin Kraetke
9
Beispiel:
10 61 Marcus Hottenroth
* Präfix für Verlag (1-3 Buchstaben): z. B. @ts@ für _transcript_
11
* vollständiger Formatvorlagenname für @heading_1@: @ts_heading_1@
12 1 Martin Kraetke
13
h2. Formatvorlagenkatalog
14
15
h3. Überschriften
16
17 62 Marcus Hottenroth
Die Nummerierung der Überschriften wird aus der Word-Datei übernommen, da Autoren teilweise sehr heterogene Nummerierungsschemata verwenden. Daher muss auf Nummerierungsfehler im Manuskript geachtet werden. Die in Word vorhandenen Standardformatvorlagen für Überschriften werden ebenfalls ausgewertet, wobei @Überschrift 1@ der Formatvorlage @heading_part@ entspricht, @Überschrift 2@ der Vorlage @heading_1@ usw.
18 1 Martin Kraetke
19 34 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
20 55 Marcus Hottenroth
| Buchtitel | @book_title@ | Buchtitel |  <pre><code>\begin{tpMeta}
21
22
  \tpTitle{…}
23
24
\end{tpMeta}</pre></code> |
25 1 Martin Kraetke
|\5=.                                             |
26 55 Marcus Hottenroth
| Teil | @heading_part@ | Teil | <pre><code>\begin{heading}{part}
27
28
\end{heading}</pre></code> |
29 1 Martin Kraetke
|\5=.                                             |
30
| Kapitel | @heading_1@ | Kapitel, Überschrift 1. Ordnung  |  |
31 55 Marcus Hottenroth
| Kapitel-Unterüberschrift | @subheading_1@ | Unterüberschrift für Kapitel/Überschrift 2. Ordnung   | <pre><code>\begin{heading}{chapter}
32
33
  \tpSubtitle{…}
34
35
\end{heading}</pre></code> |
36
| Kapitel-Autor | @author@ | Autor*in des Kapitels | <pre><code>\begin{heading}{…}
37
38
  \tpAuthorNameList{…}
39
40
\end{heading}</pre></code>
41
alternativ:
42
<pre><code>
43
\begin{heading}{…}
44
45
\begin{tpAuthor}
46
  \tpFullName{…}
47
\end{tpAuthor}
48
49
\end{heading}
50
</pre></code>
51
oder
52
<pre><code>
53
\begin{heading}{…}
54
55
\begin{tpAuthor}
56
  \tpFirstName{…}
57
  \tpMidName{…}
58
  \tpLastName{…}
59
\end{tpAuthor}
60
61
\end{heading}
62
</pre></code>|
63 60 Marcus Hottenroth
| Kapitel-Autorenbeschreibung | @author_description@ | Vita/Beschreibung zu Autor/-in des Kapitels | <pre><code>\begin{heading}{chapter}
64 55 Marcus Hottenroth
65
  \begin{tpAuthor}
66
67
    \tpBio{…}
68
69
  \end{tpAuthor}
70
71
\end{heading}
72
</pre></code>|
73
| Kapitel-Motto | @motto@, @epigraph@ | Motto zum Kapitelbeginn  | <pre><code>\begin{heading}{chapter}
74
75
  \begin{tpQuote}
76
    \tpQuoteText{…}
77
    \tpQuoteSource{…}
78
  \end{tpQuote}
79
80
\end{heading}</pre></code> |
81
| Kapitel-Motto-Quelle | @motto_source@, @epigraph_source@ | Quelle/Autor*in des Mottos | @\tpQuoteSource{…}@ (s. o.)|
82 1 Martin Kraetke
|\5=.                                             |
83 55 Marcus Hottenroth
| Abschnitt 1. Ebene | @heading_2@ | | <pre><code>\begin{heading}{section}
84
85
  \tpTitle{…}
86
87
\end{heading}</pre></code> |
88
| Abschnitt 1. Ebene Unterüberschrift | @subheading_2@ | Unterüberschrift | <pre><code>\begin{heading}{section}
89
90
  \tpSubtitle{…}
91
92
\end{heading}</pre></code> |
93
| Abschnitt Motto | @motto@ | Motto zu Beginn des Abschnitts | s. Kapitel-Motto |
94 1 Martin Kraetke
|\5=.                                             |
95 55 Marcus Hottenroth
| Abschnitt 2. Ebene | @heading_3@ | | <pre><code>\begin{heading}{subsection}
96
97
  \tpTitle{…}
98
99
\end{heading}</pre></code> |
100
| Abschnitt 2. Ebene Unterüberschrift  | @subheading_3@ | Unterüberschrift | <pre><code>\begin{heading}{subsection}
101
102
  \tpSubtitle{…}
103
104
\end{heading}</pre></code>|
105 1 Martin Kraetke
|\5=.                                             |
106 55 Marcus Hottenroth
| Abschnitt 3. Ebene | @heading_4@ | | <pre><code>\begin{heading}{subsubsection}
107
108
  \tpTitle{…}
109
110
\end{heading}</pre></code> |
111
| Abschnitt 3. Ebene Unterüberschrift  | @subheading_4@ | Unterüberschrift | <pre><code>\begin{heading}{subsubsection}
112
113
  \tpSubtitle{…}
114
115
\end{heading}</pre></code> |
116 49 Martin Kraetke
|\5=.                                             |
117 55 Marcus Hottenroth
| Abschnitt 4. Ebene | @heading_5@ | | <pre><code>\begin{heading}{praragraph}
118
119
  \tpTitle{…}
120
121
\end{heading}</pre></code> |
122
| Abschnitt 4. Ebene Unterüberschrift  | @subheading_5@ | Unterüberschrift | <pre><code>\begin{heading}{paragraph}
123
124
  \tpSubtitle{…}
125
126
\end{heading}</pre></code> |
127 50 Maren Pufe
|\5=.                                             |
128 55 Marcus Hottenroth
| Spitzmarke | @headword@ | Zwischenüberschrift, erscheint nicht im IHV | <pre><code>\begin{heading}{subparagraph}
129
130
  \tpTitle{…}
131
132
\end{heading}</pre></code> |
133
| Frontmatter _n_-te Ebene (1 ≤ _n_ ≤ 5) | @frontmatter_n@ (1 ≤ @n@ ≤ 5) | Frontmatterüberschrift| s. Hauptüberschriften; Frontmatterüberschriften erscheinen nach dem Switch @\frontmatter@ |
134
| Backmatter _n_-te Ebene (1 ≤ _n_ ≤ 5) | @backmatter_n@ (1 ≤ @n@ ≤ 5) | Backmatterüberschrift | analog zu Frontmatterüberschriften; erscheinen nach dem Switch @\backmatter@ |
135
136 3 Martin Kraetke
h3. Kolumnentitel
137 34 Martin Kraetke
138
Kolumentitel werden je nach Layout automatisch ausgegeben. Falls individuelle bzw. verkürzte Kolumnentitel notwendig sind, können folgende Formate nach der Kapitelüberschrift verwendet werden. 
139
140 1 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
141 56 Marcus Hottenroth
| Kolumnentitel links | @headline_left@   | Überschreibung des automatisch erstellten linken Kolumnentitels  | @\tpRunTitle@ |
142
| Kolumnentitel rechts | @headline_right@ | Überschreibung des automatisch erstellten rechten Kolumnentitels | @\tpRunTitle@ |
143 4 Martin Kraetke
144 1 Martin Kraetke
h3. Bilder
145
146
Bilder müssen in einen separaten Absatz mit einer bestimmten Formatvorlage gesetzt werden. Es darf kein Text in dem Absatz vorhanden sein. Pro Bild muss ein separater Absatz verwendet werden. 
147 34 Martin Kraetke
148 45 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
149 57 Marcus Hottenroth
| Abbildung | @figure@ | Bild | <pre><code>\begin{tpFigure}
150
  \tpNumber{…}
151
  \tpListofNumber{…}
152
  \tpLegend{…}
153
  \tpCaption{…}
154
  \tpSource{…}
155
  \tpFig{\includegraphics{image.jpg}}
156
\end{tpFigure}</code></pre> |
157
| Abbildung mit Layout/Klasse A, B, C etc. | @figure_A${Zahl}@, @figure_B${Zahl}@, @figure_C${Zahl}@ etc. | Erscheinungsbild von der Definition im Stylefile abhängig; @${Zahl}@ entspricht der jeweiligen Teilabbildung | <pre><code>\begin{tpFigure}[class=…]
158
159
\end{tpFigure}</code></pre> |
160
| Abbildung mit Positionsangabe |    | Position entspricht den aus Standard-TeX bekannten (@h@, @h!@, @t@, @b@, @p@) | <pre><code>\begin{tpFigure}[float-pos=…]
161
162 58 Marcus Hottenroth
\end{tpFigure}</code></pre> |
163 53 Maren Pufe
|\5=.                                             |
164 57 Marcus Hottenroth
| Abbildungsnummer | @figure_number@ | Nummer der Abbildung | @\tpNumber{…}@ |
165
| Abbildungsverzeichnisnummer |  | von der eigentlichen Nummer (@tpNumber@) abweichende Nummer für das Abbildungsverzeichnis | @\tpListofNumber{…}@ |
166
| Bildunterschrift | @figure_caption@ | Beschreibung des Bildes | @\tpCaption{…}@ |
167
| Legende | @figure_legend@ | Legende bzw. Anmerkungen zum Bild | @\tpCaption{…}@ |
168
| Quelle | @figure_source@ | Quelle des Bildes |  @\tpSource{…}@ |
169 34 Martin Kraetke
170
h3. Tabellen
171 29 Martin Kraetke
172 4 Martin Kraetke
Für Tabellen muss die Word-Standardfunktion verwendet werden. Die horizontale (nicht vertikale, tbd) Ausrichtung wird übernommen. Tabellenlinien werden im Template eingerichtet. Überspannungen von Zeilen und Spalten werden mitgeführt.
173
174
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
175 59 Marcus Hottenroth
| Tabelle | @table@ | — | <pre><code>\begin{tpTable}
176
  \tpNumber{…}
177
  \tpListofNumber{…}
178
  \tpCaption{…}
179
  \tpSource{…}
180
  \tpLegend{…}
181
\end{tpTable}</code></pre> |  
182
| Tabellenkopf| @table_header@ | Absatzformat für Tabellenköpfe; in den Tabellenzellen anwenden |  | 
183
| Querformattabelle | @table_rotated@ | muss in dem Absatz vor der zu drehenden Tabelle stehen | <pre><code>\begin{tpTable}[orientation=landscape]
184
185
\end{tpTable}</code></pre> |  
186
| erzwungener Seitenumbruch | @table_pagewrap@ | muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt, doch dieses Verhalten kann überschrieben werden); entspr. TeX-Code steht innerhalb der Zeile, nach welcher umbrochen werden soll | @\doTableBreak@ |
187
||
188
| Tabellennummer | @table_number@ | Nummer der Tabelle | @\tpNumber{…}@ |
189
| Tabellenverzeichnisnummer |  | von der eigentlichen Nummer (@tpNumber@) abweichende Nummer für das Tabellenverzeichnis | @\tpListofNumber{…}@ |
190
| Tabellenunterschrift/-titel | @table_caption@ | Titel bzw. Unterschrift der Tabelle, je nach Layoutdefinition | @\tpCaption{…}@ | 
191
| Legende | @table_legend@ | Legende oder Anmerkungen zur Tabelle | @\tpLegend@ |  
192 63 Marcus Hottenroth
| Quelle | @table_source@ | Quelle der Tabelle | @\tpSource@ |
193 54 Maren Pufe
194 1 Martin Kraetke
h3. Listen
195 34 Martin Kraetke
196 64 Marcus Hottenroth
Einfache und nummerierte Listen werden heuristisch erkannt. Beschreibungslisten, wie z. B. ein Abkürzungsverzeichnis, werden mit folgendem Format ausgezeichnet. Wichtig ist, dass zwischen Begriff und Beschreibung _ein_ Tabulator gesetzt wird.
197 34 Martin Kraetke
198 1 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
199 64 Marcus Hottenroth
| Zitat | @abbreviations@ | Beschreibungsliste| <pre><code>\begin{description}
200
  \item[…] …
201
\end{description}</code></pre> |
202 1 Martin Kraetke
203
h3. Langzitat
204 5 Martin Kraetke
205 65 Marcus Hottenroth
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitatformatvorlage werden zu einer Langzitatumgebung zusammengefasst.
206 34 Martin Kraetke
207 1 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
208 65 Marcus Hottenroth
| Zitat | @quotation@ | Zitat-Absatz |  <pre><code>\begin{quotation}
209
210
\end{quotation}</code></pre> |
211 34 Martin Kraetke
212 5 Martin Kraetke
h3. Dialoge
213 11 Martin Kraetke
214
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Dialog-Formatvorlage werden in eine Dialog-Umgebung zusammengefasst. Die Auszeichnung der Sprecher*in erfolgt automatisch über ein taktisches Zeichen, üblicherweise den Doppelpunkt. Ideal ist auch eine Abgrenzung per Tabulator. Der Absatz muss mit der Sprecher*in beginnen.
215 34 Martin Kraetke
216
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
217 11 Martin Kraetke
| Dialog | @dialogue@ | Dialog-Absatz |   @\begin{dialog}...\end{dialog}@  |
218 5 Martin Kraetke
| Sprecher*in |  | Sprecher*in |  @\item[speaker] ...@  |
219
220 34 Martin Kraetke
h3. Boxen / Kästen
221
222 5 Martin Kraetke
Der Anfang und das Ende einer Box wird jeweils mit einem Absatzformat markiert. Dabei darf kein anderer Text in dem Absatz stehen.
223 11 Martin Kraetke
224 5 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
225 34 Martin Kraetke
| Kasten mit Rahmen Beginn | @box_border_start@ | transparenter Kasten mit Rahmen Beginn  | @\begin{kastenlinie}...@  |
226
| Kasten mit Rahmen Ende | @box_border_end@ | transparenter Kasten mit Rahmen Ende  | @...\end{kastenlinie}@  |
227
| Kasten schattiert Beginn | @box_grey_start@ | Kasten mit grauer Hinterlegung Beginn  | @\begin{kastengrau}...@  |
228 27 Maren Pufe
| Kasten schattiert Ende | @box_grey_end@ | Kasten mit grauer Hinterlegung Ende | @...\end{kastengrau}@  |
229 28 Maren Pufe
230 27 Maren Pufe
h3. Formeln
231
232
|_. Bezeichnung |_. Name |_. Beschreibung  |_. TeX |
233
| Formelabsatz | @formula@ | Absatz, der Formel enthält | @\begin{equation}...\end{equation}@  |
234
235
h3. Widmung
236
237
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
238
| Widmung | @dedication@ | Widmung |  @\dedication@  |
239
240
h3. Brief
241
242
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
243
| Briefabsatz | @letter@ | Absatz eines Briefes | @\begin{letter}...\end{letter}@  |
244
| Briefabsatz mit Abstand| @letter_spacing@ | Absatz eines Briefes  | @\item@  |
245
246
*Beispiel:* (vor \items und am Ende sollte kein '\\' stehen)
247
248
|_. HUB-XML|_. TeX|_. PDF|
249 28 Maren Pufe
|<pre>
250 11 Martin Kraetke
<div role="letter">
251
  <para role="letter">Lieber Briefreund</para>
252
  <para role="letter_spacing">Hier schreibe ich dir heute nun</para>
253
  <para role="letter">und hoffe dies und jenes.</para>
254
  <para role="letter">Der letzte Absatz hier.</para>
255 36 Martin Kraetke
</div></pre>|<pre>\begin{letter}
256
  Lieber Briefreund,
257 11 Martin Kraetke
\item Hier schreibe ich dir heute nun\\
258 14 Martin Kraetke
  und hoffe dies und jenes.\\
259
  Der letzte Absatz hier.
260 21 Martin Kraetke
\end{letter}
261 14 Martin Kraetke
</pre> | <pre>
262
  Lieber Briefreund,
263
264
  Hier schreibe ich dir heute nun
265
  und hoffe dies und jenes.
266
  Der letzte Absatz hier.</pre> |
267
268 24 Martin Kraetke
h3. Bibliografie
269 14 Martin Kraetke
270
Eine Bibliografie besteht aus direkt aufeinanderfolgenden Absätzen mit Literaturreferenzen. Die Absätze müssen mit derselben Formatvorlage ausgezeichnet sein. Wenn darüber eine reguläre Überschrift steht, wird diese automatisch als Überschrift der Bibliografie gesetzt.
271
272
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
273 1 Martin Kraetke
| Literatur | @literature@ | Literaturreferenz  | @\bibitem@  |
274 21 Martin Kraetke
275
h3. Index und Indexkodierung
276
277
Register können über folgende vier Wege erstellt werden, die auch kombiniert werden können.
278
279
h4. (1) Word-Indexfunktion
280 37 Martin Kraetke
281
Im Word-Ribbon @Referenzen@ können für markierte Wörter Indexeinträge festgelegt werden. Dafür markiert man ein Word und klickt auf die Schaltfläche @Index markieren@.
282
283
h4. (2) Auszeichnung der Indexeinträge via Zeichenformat
284
285 38 Martin Kraetke
Indexeinträge können festgelegt werden, indem Wörter oder Wortgruppen mit dem Format @index_mark@ ausgezeichnet werden. Indexeinträge die bereits mit der Word-Indexfunktion kodiert wurden, werden ignoriert.
286 14 Martin Kraetke
287 5 Martin Kraetke
h4. (3) Einfügen einer Konkordanzliste von Indexeinträgen
288
289
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 @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.
290
291 38 Martin Kraetke
h4. (4) Einfügen eines statischen Index
292
293 46 Maren Pufe
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!
294 38 Martin Kraetke
295 1 Martin Kraetke
h4. Formatvorlagen
296 30 Martin Kraetke
297
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
298
| Registerüberschrift | @index_heading@ | Überschrift des Registers   | |
299
| Indexeintrag, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen |  | 
300 39 Martin Kraetke
| Indexeintrag, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Indexeintrag aus der Konkordanzliste |  | 
301
| Indexeintrag Suchbegriff | @index_name@ | Zeichenformat, muss innerhalb von @index_list@ verwendet werden um den Index-Suchbegriff separat auszuzeichnen, z.B. kann bei _Max Mustermann_ das _Mustermann_ ausgezeichnet werden, damit auch bei _Herr Mustermann_ Indexeintrag erstellt wird |  | 
302 30 Martin Kraetke
| Indexeintrag, siehe (4) | @index_static@ | Statischer Indexeintrag. Seitenzahlen im Eintrag werden mit der Seitenzahl verlinkt. |  |
303 14 Martin Kraetke
304 11 Martin Kraetke
h3. Verzeichnisse
305 40 Martin Kraetke
306
Es muss nur die Überschrift gesetzt werden. An dieser Stelle wird der Inhalt des Verzeichnisses automatisch ausgegeben.
307
308
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
309
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis  | @\listoffigures@  |
310
| Tabellenverzeichnis | @list_of_tables@ | Überschrift des Tabellenverzeichnis | @\listoftables@  |
311
| Endnotenverzeichnis | @list_of_endnotes@ | Überschrift des Endnotenverzeichnis  | @\printnotes@  |
312
313
h3. Zeilenumbrüche
314
315
Leere Absätze werden automatisch entfernt. Für die Steuerung der Anzahl der Zeilenumbrüche sollte man daher leere Absätze mit dem Format @lineskip@ auszeichnen, wobei man die Anzahl der gewünschten Umbrüche am Ende des Formatnamens angibt, z.B. @lineskip3@ für 3 Umbrüche. Ein normaler Umbruch (Shift+Enter) wird zu einem @\newline@.
316 41 Martin Kraetke
317 42 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
318 1 Martin Kraetke
| Zeilenumbruch | @lineskip@ |  |  @\vskip 1\baselineskip@  |
319
320
h3. Zeichenformate
321
322
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
323
|  | @nonlatin@ | Text der keine lateinischen Zeichen enthält |   @\unichar@  |
324
| Regular | @regular@ | Steilgestellter Text |    |
325
| Halbfett | @bold@ | Halbfetter Text |   @\textbf@ |
326
| Kursiv | @italic@ | Kursiver Text |   @\textit@  |
327
| Kapitälchen | @smallcaps@ | Kapitälchen |   @\textsc@  |
328
| Nicht umbrechender Leerraum | @space_nonbreaking@ |  |     |
329
| Schmales Leerzeichen | @space_thin@ |  |     |
330
| Gesperrt | @spaced@ | gesperrter Text |   @\so@  |
331
| Unterstrichen | @underline@ | unterstrichener Text |    @\ul@ |
332
| Durchgestrichen | @strike_trough@ | durchgestrichener Text  |   @\st@  |
333
| Hochgestellt | @superscript@ | wird via Mathmode automatisch erstellt |    @\textsuperscript@ |
334
| Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt |   @\textsubscript@ |