Projekt

Allgemein

Profil

Formatvorlagen » Historie » Version 55

Marcus Hottenroth, 22.12.2023 12:41

1 1 Martin Kraetke
h1. Formatvorlagen
2
3 43 Martin Kraetke
{{toc}}
4
5 1 Martin Kraetke
h2. Präfix
6
7
Alle Formatvorlagennamen enthalten ein Präfix, welches den Verlag repräsentiert und mit einem Unterstrich abgetrennt wird.
8
9
Beispiel:
10 25 Martin Kraetke
* Präfix für Verlag (1-3 Buchstaben): z.B. @ts@ für _transcript_
11 1 Martin Kraetke
* Vollständiger Formatvorlagenname für @heading_1@: @ts_heading_1@
12
13
h2. Formatvorlagenkatalog
14
15
h3. Überschriften
16
17 5 Martin Kraetke
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 Standard-Formatvorlagen für Überschriften von Word werden auch ausgewertet, wobei @Überschrift 1@ der Formatvorlage @heading_part@, @Überschrift 2@ der @heading_1@ entspricht 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
| Kapitel-Autorenbeschreibung | @author_description@ | Vita/Beschreibung zu Autor*in des Kapitels | <pre><code>\begin{heading}{chapter}
64
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
137
h3. Kolumnentitel
138 34 Martin Kraetke
139
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. 
140
141 1 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
142 34 Martin Kraetke
| Kolumnentitel links | @headline_left@ | Überschreibung des automatisch erstellten linken Kolumnentitel |  \tpRunTitle |
143
| Kolumnentitel rechts | @headline_right@ | Überschreibung des automatisch erstellten rechten Kolumnentitel |\tpRunTitle|
144 1 Martin Kraetke
145 4 Martin Kraetke
146 1 Martin Kraetke
h3. Bilder
147
148
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. 
149 34 Martin Kraetke
150 45 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
151 53 Maren Pufe
| Abbildung | @figure@ | Bild | @\begin{figure}[h!]
152
\includegraphics{image.jpg}
153
\end{figure}@ |
154 34 Martin Kraetke
| Abbildung Layout A | @figure_A${Zahl}@ | Abbildung auf Satzbreite mit ${Zahl} von 1-3 Bildern nebeneinander  |   |
155 53 Maren Pufe
| Abbildung Layout B | @figure_B${Zahl}@ | Abbildung mit Abstand und ${Zahl} von 1-3 Bildern nebeneinander  |  |
156 4 Martin Kraetke
| Abbildung Layout C | @figure_C${Zahl}@ | Abbildung mit mehr Abstand und ${Zahl} von 1-3 Bildern nebeneinander    |  |
157 29 Martin Kraetke
|\5=.                                             |
158
| Legende | @figure_caption@ | Legende bzw. Beschreibung des Bildes |   @\caption{...}@ |
159
| Quelle | @figure_source@ | Quelle des Bildes |  @\capsource{...}@ |
160
161 34 Martin Kraetke
h3. Tabellen
162
163 29 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.
164 4 Martin Kraetke
165
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
166
| Tabellenkopf| @table_header@ | Absatzformat für Tabellenköpfe. In den Tabellenzellen anwenden. |  | 
167
| Legende | @table_caption@ | Titel der Tabelle | \begin{tpTable} → \tpCaption | 
168 34 Martin Kraetke
| Quelle | @table_legend@ | Legende der Tabelle (Längere Beschreibung) | \begin{tpTable} →\tpLegend |  
169
| Quelle | @table_source@ | Quelle der Tabelle | \begin{tpTable} →\tpSource |  
170 1 Martin Kraetke
| Quelle | @table_rotated@ | muss in dem Absatz vor der zu drehenden Tabelle stehen |  |  
171
| Quelle | @table_pagewrap@ | muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt) | |
172
173 54 Maren Pufe
h3. Listen
174 1 Martin Kraetke
175 34 Martin Kraetke
Einfache und nummerierte Listen werden heuristisch erkannt. Beschreibungslisten wie z.B. ein Abkürzungsverzeichnis werden mit folgendem Format ausgezeichnet. Wichtig ist das zwischen Begriff und Beschreibung _ein_ Tabulator gesetzt wird.
176 54 Maren Pufe
177 34 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
178 1 Martin Kraetke
| Zitat | @abbreviations@ | Beschreibungsliste|  @\begin{description} \item[begriff] ... \end{description}@  |
179
180
h3. Langzitat
181
182 5 Martin Kraetke
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitat-Formatvorlage werden in eine Langzitat-Umgebung zusammengefasst.
183 35 Martin Kraetke
184 34 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
185
| Zitat | @quotation@ | Zitat-Absatz |  @\begin{quotation}...\end{quotation}@  |
186
187
h3. Dialoge
188 5 Martin Kraetke
189 11 Martin Kraetke
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.
190
191 34 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
192
| Dialog | @dialogue@ | Dialog-Absatz |   @\begin{dialog}...\end{dialog}@  |
193 11 Martin Kraetke
| Sprecher*in |  | Sprecher*in |  @\item[speaker] ...@  |
194 5 Martin Kraetke
195
h3. Boxen / Kästen
196 34 Martin Kraetke
197
Der Anfang und das Ende einer Box wird jeweils mit einem Absatzformat markiert. Dabei darf kein anderer Text in dem Absatz stehen.
198 5 Martin Kraetke
199 11 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
200 5 Martin Kraetke
| Kasten mit Rahmen Beginn | @box_border_start@ | transparenter Kasten mit Rahmen Beginn  | @\begin{kastenlinie}...@  |
201 34 Martin Kraetke
| Kasten mit Rahmen Ende | @box_border_end@ | transparenter Kasten mit Rahmen Ende  | @...\end{kastenlinie}@  |
202
| Kasten schattiert Beginn | @box_grey_start@ | Kasten mit grauer Hinterlegung Beginn  | @\begin{kastengrau}...@  |
203
| Kasten schattiert Ende | @box_grey_end@ | Kasten mit grauer Hinterlegung Ende | @...\end{kastengrau}@  |
204 27 Maren Pufe
205 28 Maren Pufe
h3. Formeln
206 27 Maren Pufe
207
|_. Bezeichnung |_. Name |_. Beschreibung  |_. TeX |
208
| Formelabsatz | @formula@ | Absatz, der Formel enthält | @\begin{equation}...\end{equation}@  |
209
210
h3. Widmung
211
212
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
213
| Widmung | @dedication@ | Widmung |  @\dedication@  |
214
215
h3. Brief
216
217
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
218
| Briefabsatz | @letter@ | Absatz eines Briefes | @\begin{letter}...\end{letter}@  |
219
| Briefabsatz mit Abstand| @letter_spacing@ | Absatz eines Briefes  | @\item@  |
220
221
*Beispiel:* (vor \items und am Ende sollte kein '\\' stehen)
222
223
|_. HUB-XML|_. TeX|_. PDF|
224
|<pre>
225 28 Maren Pufe
<div role="letter">
226 11 Martin Kraetke
  <para role="letter">Lieber Briefreund</para>
227
  <para role="letter_spacing">Hier schreibe ich dir heute nun</para>
228
  <para role="letter">und hoffe dies und jenes.</para>
229
  <para role="letter">Der letzte Absatz hier.</para>
230
</div></pre>|<pre>\begin{letter}
231 36 Martin Kraetke
  Lieber Briefreund,
232
\item Hier schreibe ich dir heute nun\\
233 11 Martin Kraetke
  und hoffe dies und jenes.\\
234 14 Martin Kraetke
  Der letzte Absatz hier.
235
\end{letter}
236 21 Martin Kraetke
</pre> | <pre>
237 14 Martin Kraetke
  Lieber Briefreund,
238
239
  Hier schreibe ich dir heute nun
240
  und hoffe dies und jenes.
241
  Der letzte Absatz hier.</pre> |
242
243
h3. Bibliografie
244 24 Martin Kraetke
245 14 Martin Kraetke
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.
246
247
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
248
| Literatur | @literature@ | Literaturreferenz  | @\bibitem@  |
249 1 Martin Kraetke
250 21 Martin Kraetke
h3. Index und Indexkodierung
251
252
Register können über folgende vier Wege erstellt werden, die auch kombiniert werden können.
253
254
h4. (1) Word-Indexfunktion
255
256 37 Martin Kraetke
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@.
257
258
h4. (2) Auszeichnung der Indexeinträge via Zeichenformat
259
260
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.
261 38 Martin Kraetke
262 14 Martin Kraetke
h4. (3) Einfügen einer Konkordanzliste von Indexeinträgen
263 5 Martin Kraetke
264
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.
265
266
h4. (4) Einfügen eines statischen Index
267 38 Martin Kraetke
268
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!
269 46 Maren Pufe
270 38 Martin Kraetke
h4. Formatvorlagen
271 1 Martin Kraetke
272 30 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
273
| Registerüberschrift | @index_heading@ | Überschrift des Registers   | |
274
| Indexeintrag, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen |  | 
275
| Indexeintrag, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Indexeintrag aus der Konkordanzliste |  | 
276 39 Martin Kraetke
| 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 |  | 
277
| Indexeintrag, siehe (4) | @index_static@ | Statischer Indexeintrag. Seitenzahlen im Eintrag werden mit der Seitenzahl verlinkt. |  |
278 30 Martin Kraetke
279 14 Martin Kraetke
h3. Verzeichnisse
280 11 Martin Kraetke
281 40 Martin Kraetke
Es muss nur die Überschrift gesetzt werden. An dieser Stelle wird der Inhalt des Verzeichnisses automatisch ausgegeben.
282
283
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
284
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis  | @\listoffigures@  |
285
| Tabellenverzeichnis | @list_of_tables@ | Überschrift des Tabellenverzeichnis | @\listoftables@  |
286
| Endnotenverzeichnis | @list_of_endnotes@ | Überschrift des Endnotenverzeichnis  | @\printnotes@  |
287
288
h3. Zeilenumbrüche
289
290
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@.
291
292 41 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
293 42 Martin Kraetke
| Zeilenumbruch | @lineskip@ |  |  @\vskip 1\baselineskip@  |
294 1 Martin Kraetke
295
h3. Zeichenformate
296
297
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
298
|  | @nonlatin@ | Text der keine lateinischen Zeichen enthält |   @\unichar@  |
299
| Regular | @regular@ | Steilgestellter Text |    |
300
| Halbfett | @bold@ | Halbfetter Text |   @\textbf@ |
301
| Kursiv | @italic@ | Kursiver Text |   @\textit@  |
302
| Kapitälchen | @smallcaps@ | Kapitälchen |   @\textsc@  |
303
| Nicht umbrechender Leerraum | @space_nonbreaking@ |  |     |
304
| Schmales Leerzeichen | @space_thin@ |  |     |
305
| Gesperrt | @spaced@ | gesperrter Text |   @\so@  |
306
| Unterstrichen | @underline@ | unterstrichener Text |    @\ul@ |
307
| Durchgestrichen | @strike_trough@ | durchgestrichener Text  |   @\st@  |
308
| Hochgestellt | @superscript@ | wird via Mathmode automatisch erstellt |    @\textsuperscript@ |
309
| Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt |   @\textsubscript@ |