Projekt

Allgemein

Profil

Template Styles » Historie » Version 3

Martin Kraetke, 21.12.2021 16:18

1 1 Martin Kraetke
h1. Template Styles
2
3
{{toc}}
4
5
h2. Prefix
6
7
All style names contain a prefix that represents the publisher and is separated by an underscore. The table below shows only the style name without the prefix. The prefix is part of the customer-specific configuration.
8
9
Example:
10
* Prefix for publisher (1-3 characters): e.g. @ts@ for _transcript publishers_
11
* Full style name for @heading_1@: @ts_heading_1@
12
13
h2. Style Names
14
15
h3. Headings
16
17
The numbering of the headings is taken from the Word file, since authors sometimes use very heterogeneous numbering schemes. Therefore, one must watch out for numbering errors in the manuscript. The standard styles for headings from Word are also evaluated, whereby @Heading 1@ corresponds to the style @heading_part@, @Heading 2@ corresponds to @heading_1@ etc.
18
19
|_. Common Name |_. Style Name |_. Description |_. TeX |
20
| book title | @book_title@ | Book title|  @\title{...}@ |
21
|\4=.                                             |
22
| part | @heading_part@ | Teil | @\part{...}@ |
23
|\4=.                                             |
24
| chapter | @heading_1@ | chapter, Überschrift 1. Ordnung  |  |
25
| chapter subheading | @subheading_1@ | subheading für chapter/Überschrift 2. Ordnung   | @\tpTitle{...}@ |
26
| chapter author | @author@ | chapter author | @\tpAuthor{...}@ |
27
| chapter author biography | @author_description@ | author biography included in a chapter | @\authorbio@ |
28
| chapter epigraph | @epigraph@, @epigraph@ | epigraph at chapter start | @\chapterquote{...}@ |
29
| chapter epigraph source | @epigraph_source@, @epigraph_source@ | source or author of epigraph |   |
30
|\4=.                                             |
31
| section 1. level | @heading_2@ | | @\section{...}@ |
32
| section 1. level subheading | @subheading_2@ | subheading | |
33
| section epigraph | @epigraph@ | section epigraph |  @\secquote{...}@ |
34
|\4=.                                             |
35
| section 2. level | @heading_3@ |  @\subsection{...}@ |
36
| section 2. level subheading  | @subheading_3@ | subheading | |
37
|\4=.                                             |
38
| section 3. level | @heading_4@ | | @\subsubsection{...}@ |
39
| section 3. level subheading  | @subheading_4@ | subheading |  |
40
|\4=.                                             |
41
| section 4. level | @heading_5@ | | @\paragraph{...}@ |
42
| section 4. level subheading  | @subheading_5@ | subheading |  |
43
|\4=.                                             |
44
| bridgehead | @headword@ | bridgehead, not included in ToC | @\subparagraph{...}@ |
45
46
h3. Running Headers
47
48
Running headers are automatically generated depending on the layout and the customer-specific configuration. If individual or shortened running headers are required, the following style can be used after the part, chapter or section heading. 
49
50
|_. Common Name |_. Style Name |_. Description |_. TeX |
51
| running header short | @headline_short@ | override for automatically generated running header. | @\chaptermark{}@ |
52
53
h3. Figures
54
55
Figures must be placed in a separate paragraph with a specific paragraph style. There must not be text in the paragraph. For each additional image, a separate paragraph must be used. Figure captions and caption source must be set below the image in separate paragraphs.
56
57
|_. Common Name |_. Style Name |_. Description |_. TeX |
58
| Figure | @figure@ | Figure | @\begin{tpFigure}[<options>]
59
  \tpCaption{<caption>}
60
  \tpSource{<Quelle>}
61
  \tpLegend{<Legende>}
62
  \tpNumber{<Nummer>}
63
  \tpFig{\includegraphics[<optionen>]{<pfad>}}
64
\end{tpFigure}@ |
65
|_\4=. multiple figures with specific layouts |
66 3 Martin Kraetke
| figure (layout A) | @figure_A${Zahl}@ | image with ${number} 1 to 3 images side by side column width | @\begin{tpFigure}[class=a]@  |
67
| figure (layout B) | @figure_B${Zahl}@ | image with ${number} 1 to 3 images side by side with margin | @\begin{tpFigure}[class=b]@ |
68
| figure (layout C) | @figure_C${Zahl}@ | image with ${number} 1 to 3 images side by side with more margin   | @\begin{tpFigure}[class=c]@ |
69 1 Martin Kraetke
|\4=.                                             |
70
| caption | @figure_caption@ | caption or description of the image |   @\tpCaption{...}@ |
71
| caption source | @figure_source@ | Quelle des Bildes |  @\tpSource{...}@ |
72
73
h3. Tabellen
74
75
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.
76
77
|_. Common Name |_. Style Name |_. Description |_. TeX |
78
| Legende | @table_caption@ | Legende bzw. Beschreibung der Tabelle |  | 
79
| Quelle | @table_source@ | Quelle der Tabelle |  |  
80
| Quelle | @table_rotated@ | muss in dem Absatz vor der zu drehenden Tabelle stehen |  |  
81
| Quelle | @table_pagewrap@ | muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt) |  |  
82
83
h3. Listen
84
85
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.
86
87
|_. Common Name |_. Style Name |_. Description |_. TeX |
88
| Zitat | @abbreviations@ | Beschreibungsliste|  @\begin{description} \item[begriff] ... \end{description}@  |
89
90
h3. Langzitat
91
92
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitat-Formatvorlage werden in eine Langzitat-Umgebung zusammengefasst.
93
94
|_. Common Name |_. Style Name |_. Description |_. TeX |
95
| Zitat | @quotation@ | Zitat-Absatz |  @\begin{quotation}...\end{quotation}@  |
96
97
h3. Dialoge
98
99
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. Der Absatz muss mit der Sprecher*in beginnen.
100
101
|_. Common Name |_. Style Name |_. Description |_. TeX |
102
| Dialog | @dialogue@ | Dialog-Absatz |   @\begin{dialogue}...\end{dialogue}@  |
103
| Sprecher*in |  | Sprecher*in |  @\item[speaker] ...@  |
104
105
h3. Boxen / Kästen
106
107
Der Anfang und das Ende einer Box wird jeweils mit einem Absatzformat markiert. Dabei darf kein anderer Text in dem Absatz stehen.
108
109
|_. Common Name |_. Style Name |_. Description |_. TeX |
110
| Kasten mit Rahmen Beginn | @box_border_start@ | transparenter Kasten mit Rahmen Beginn  | @\begin{kastenlinie}...@  |
111
| Kasten mit Rahmen Ende | @box_border_end@ | transparenter Kasten mit Rahmen Ende  | @...\end{kastenlinie}@  |
112
| Kasten schattiert Beginn | @box_grey_start@ | Kasten mit grauer Hinterlegung Beginn  | @\begin{kastengrau}...@  |
113
| Kasten schattiert Ende | @box_grey_end@ | Kasten mit grauer Hinterlegung Ende | @...\end{kastengrau}@  |
114
115
h3. Formeln
116
117
|_. Common Name |_. Style Name |_. Description |_. TeX |
118
| Formelabsatz | @formula@ | Absatz, der Formel enthält | @\begin{equation}...\end{equation}@  |
119
120
h3. Widmung
121
122
|_. Common Name |_. Style Name |_. Description |_. TeX |
123
| Widmung | @dedication@ | Widmung |  @\dedication@  |
124
125
h3. Brief
126
127
|_. Common Name |_. Style Name |_. Description |_. TeX |
128
| Briefabsatz | @letter@ | Absatz eines Briefes | @\begin{letter}...\end{letter}@  |
129
| Briefabsatz mit Abstand| @letter_spacing@ | Absatz eines Briefes  | @\item@  |
130
131
*Beispiel:* (vor \items und am Ende sollte kein '\\' stehen)
132
133
|_. HUB-XML|_. TeX|_. PDF|
134
|<pre>
135
<div role="letter">
136
  <para role="letter">Lieber Briefreund</para>
137
  <para role="letter_spacing">Hier schreibe ich dir heute nun</para>
138
  <para role="letter">und hoffe dies und jenes.</para>
139
  <para role="letter">Der letzte Absatz hier.</para>
140
</div></pre>|<pre>\begin{letter}
141
  Lieber Briefreund,
142
\item Hier schreibe ich dir heute nun\\
143
  und hoffe dies und jenes.\\
144
  Der letzte Absatz hier.
145
\end{letter}
146
</pre> | <pre>
147
  Lieber Briefreund,
148
149
  Hier schreibe ich dir heute nun
150
  und hoffe dies und jenes.
151
  Der letzte Absatz hier.</pre> |
152
153
h3. Bibliografie
154
155
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.
156
157
|_. Common Name |_. Style Name |_. Description |_. TeX |
158
| Literatur | @literature@ | Literaturreferenz  | @\bibitem@  |
159
160
h3. Index und Indexkodierung
161
162
Register können über folgende vier Wege erstellt werden, die auch kombiniert werden können.
163
164
h4. (1) Word-Indexfunktion
165
166
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@.
167
168
h4. (2) Auszeichnung der Indexeinträge via Zeichenformat
169
170
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.
171
172
h4. (3) Einfügen einer Konkordanzliste von Indexeinträgen
173
174
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 Index entry kodiert. Dafür muss ein Index entry 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.
175
176
h4. (4) Einfügen eines statischen Index
177
178
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!
179
180
h4. Formatvorlagen
181
182
|_. Common Name |_. Style Name |_. Description |_. TeX |
183
| Registerüberschrift | @index_heading@ | Überschrift des Registers   | |
184
| Index entry, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen |  | 
185
| Index entry, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Index entry aus der Konkordanzliste |  | 
186
| Index entry 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_ Index entry erstellt wird |  | 
187
| Index entry, siehe (4) | @index_static@ | Statischer Index entry. Seitenzahlen im Eintrag werden mit der Seitenzahl verlinkt. |  |
188
189
h3. Verzeichnisse
190
191
Es muss nur die Überschrift gesetzt werden. An dieser Stelle wird der Inhalt des Verzeichnisses automatisch ausgegeben.
192
193
|_. Common Name |_. Style Name |_. Description |_. TeX |
194
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis  | @\listoffigures@  |
195
| Tabellenverzeichnis | @list_of_figures@ | Überschrift des Tabellenverzeichnis | @\listoftables@  |
196
| Endnotenverzeichnis | @list_of_endnotes@ | Überschrift des Endnotenverzeichnis  | @\printnotes@  |
197
198
h3. Zeilenumbrüche
199
200
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@.
201
202
|_. Common Name |_. Style Name |_. Description |_. TeX |
203
| Zeilenumbruch | @lineskip@ |  |  @\vskip 1\baselineskip@  |
204
205
h3. Zeichenformate
206
207
|_. Common Name |_. Style Name |_. Description |_. TeX |
208
|  | @nonlatin@ | Text der keine lateinischen Zeichen enthält |   @\unichar@  |
209
| Regular | @regular@ | Steilgestellter Text |    |
210
| Halbfett | @bold@ | Halbfetter Text |   @\textbf@ |
211
| Kursiv | @italic@ | Kursiver Text |   @\textit@  |
212
| Kapitälchen | @smallcaps@ | Kapitälchen |   @\textsc@  |
213
| Nicht umbrechender Leerraum | @space_nonbreaking@ |  |     |
214
| Schmales Leerzeichen | @space_thin@ |  |     |
215
| Gesperrt | @spaced@ | gesperrter Text |   @\so@  |
216
| Unterstrichen | @underline@ | unterstrichener Text |    @\ul@ |
217
| Durchgestrichen | @strike_trough@ | durchgestrichener Text  |   @\st@  |
218
| Hochgestellt | @superscript@ | wird via Mathmode automatisch erstellt |    @\textsuperscript@ |
219
| Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt |   @\textsubscript@ |