Projekt

Allgemein

Profil

Formatvorlagen » Historie » Version 33

Martin Kraetke, 21.12.2021 15:07

1 1 Martin Kraetke
h1. Formatvorlagen
2
3
h2. Präfix
4
5
Alle Formatvorlagennamen enthalten ein Präfix, welches den Verlag repräsentiert und mit einem Unterstrich abgetrennt wird.
6
7
Beispiel:
8 25 Martin Kraetke
* Präfix für Verlag (1-3 Buchstaben): z.B. @ts@ für _transcript_
9 1 Martin Kraetke
* Vollständiger Formatvorlagenname für @heading_1@: @ts_heading_1@
10
11
h2. Formatvorlagenkatalog
12
13
h3. Überschriften
14
15 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.
16 1 Martin Kraetke
17
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
18 33 Martin Kraetke
| Buchtitel | @book_title@ | Buchtitel |  | @\title{...}@ |
19 4 Martin Kraetke
| Teil | @heading_part@ | Teil | | @\part{...}@ |
20 2 Martin Kraetke
|\5=.                                             |
21 5 Martin Kraetke
| Kapitel | @heading_1@ | Kapitel, Überschrift 1. Ordnung  | | |
22
| Kapitel-Unterüberschrift | @subheading_1@ | Unterüberschrift für Kapitel/Überschrift 2. Ordnung  | | @\chapter{...}@ |
23 4 Martin Kraetke
| Kapitel-Autor | @author@ | Autor*in des Kapitels | | @\author{...}@ |
24 5 Martin Kraetke
| Kapitel-Autorenbeschreibung | @author_description@ | Vita/Beschreibung zu Autor*in des Kapitels | | @\authorbio@ |
25 31 Martin Kraetke
| Kapitel-Motto | @motto@, @epigraph@ | Motto zum Kapitelbeginn | | @\chapterquote{...}@ |
26 32 Martin Kraetke
| Kapitel-Motto-Quelle | @motto_source@, @epigraph_source@ | Quelle/Autor*in des Mottos | |  |
27 1 Martin Kraetke
|\5=.                                             |
28 5 Martin Kraetke
| Abschnitt 1. Ebene | @heading_2@ | | | @\section{...}@ |
29
| Abschnitt 1. Ebene Unterüberschrift | @subheading_2@ | Unterüberschrift | | |
30 8 Martin Kraetke
| Abschnitt Motto | @motto@ | Motto zu Beginn des Abschnitts | | @\secquote{...}@ |
31 2 Martin Kraetke
|\5=.                                             |
32 5 Martin Kraetke
| Abschnitt 2. Ebene | @heading_3@ | | | @\subsection{...}@ |
33
| Abschnitt 2. Ebene Unterüberschrift  | @subheading_3@ | Unterüberschrift | | |
34 2 Martin Kraetke
|\5=.                                             |
35 5 Martin Kraetke
| Abschnitt 3. Ebene | @heading_4@ | | | @\subsubsection{...}@ |
36
| Abschnitt 3. Ebene Unterüberschrift  | @subheading_4@ | Unterüberschrift | |  |
37 2 Martin Kraetke
|\5=.                                             |
38 5 Martin Kraetke
| Abschnitt 4. Ebene | @heading_5@ | | | @\paragraph{...}@ |
39
| Abschnitt 4. Ebene Unterüberschrift  | @subheading_5@ | Unterüberschrift | |  |
40 13 Martin Kraetke
|\5=.                                             |
41
| Spitzmarke | @headword@ | Zwischenüberschrift, erscheint nicht im IVZ | | @\subparagraph{...}@ |
42 1 Martin Kraetke
43
h3. Kolumnentitel
44
45
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. 
46
47
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
48
| Kolumnentitel links | @headline_left@ | Überschreibung des automatisch erstellten linken Kolumnentitel | | @def\partmarkoverride{Wert}@ |
49
| Kolumnentitel rechts | @headline_right@ | Überschreibung des automatisch erstellten rechten Kolumnentitel | | @\chaptermark{Wert}@ |
50
51
h3. Bilder
52
53 3 Martin Kraetke
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. 
54
55 1 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
56 3 Martin Kraetke
| Abbildung | @figure@ | Bild |  | @\begin{figure}[h!]
57
\includegraphics{image.jpg}
58
\end{figure}@ |
59 12 Martin Kraetke
| Abbildung Layout A | @figure_A${Zahl}@ | Abbildung auf Satzbreite mit ${Zahl} von 1-3 Bildern nebeneinander  |  |  |
60
| Abbildung Layout B | @figure_B${Zahl}@ | Abbildung mit Abstand und ${Zahl} von 1-3 Bildern nebeneinander  |  |  |
61
| Abbildung Layout C | @figure_C${Zahl}@ | Abbildung mit mehr Abstand und ${Zahl} von 1-3 Bildern nebeneinander   |  |  |
62 1 Martin Kraetke
|\5=.                                             |
63 10 Martin Kraetke
| Legende | @figure_caption@ | Legende bzw. Beschreibung des Bildes |   | @\caption{...}@ |
64 4 Martin Kraetke
| Quelle | @figure_source@ | Quelle des Bildes |  | @\capsource{...}@ |
65 1 Martin Kraetke
66 4 Martin Kraetke
h3. Tabellen
67 1 Martin Kraetke
68
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.
69
70
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
71
| Legende | @table_caption@ | Legende bzw. Beschreibung der Tabelle |  |  |
72
| Quelle | @table_source@ | Quelle der Tabelle |  |  |
73 23 Martin Kraetke
| Quelle | @table_rotated@ | muss in dem Absatz vor der zu drehenden Tabelle stehen |  |  |
74 26 Martin Kraetke
| Quelle | @table_pagewrap@ | muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt) |  |  |
75 4 Martin Kraetke
76 29 Martin Kraetke
h3. Listen
77
78
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.
79
80
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
81
| Zitat | @abbreviations@ | Beschreibungsliste|  | @\begin{description} \item[begriff] ... \end{description}@  |
82
83 4 Martin Kraetke
h3. Langzitat
84
85
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitat-Formatvorlage werden in eine Langzitat-Umgebung zusammengefasst.
86
87
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
88
| Zitat | @quotation@ | Zitat-Absatz |  | @\begin{quotation}...\end{quotation}@  |
89 1 Martin Kraetke
90
h3. Dialoge
91
92 6 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. Der Absatz muss mit der Sprecher*in beginnen.
93 1 Martin Kraetke
94
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
95
| Dialog | @dialogue@ | Dialog-Absatz |  | @\begin{dialogue}...\end{dialogue}@  |
96
| Sprecher*in |  | Sprecher*in |  | @\item[speaker] ...@  |
97
98
h3. Boxen / Kästen
99
100
Der Anfang und das Ende einer Box wird jeweils mit einem Absatzformat markiert. Dabei darf kein anderer Text in dem Absatz stehen.
101 5 Martin Kraetke
102
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
103
| Kasten mit Rahmen Beginn | @box_border_start@ | transparenter Kasten mit Rahmen Beginn |  | @\begin{kastenlinie}...@  |
104
| Kasten mit Rahmen Ende | @box_border_end@ | transparenter Kasten mit Rahmen Ende |  | @...\end{kastenlinie}@  |
105
| Kasten schattiert Beginn | @box_grey_start@ | Kasten mit grauer Hinterlegung Beginn |  | @\begin{kastengrau}...@  |
106
| Kasten schattiert Ende | @box_grey_end@ | Kasten mit grauer Hinterlegung Ende |  | @...\end{kastengrau}@  |
107
108 11 Martin Kraetke
h3. Formeln
109
110
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
111
| Formelabsatz | @formula@ | Absatz, der Formel enthält |  | @\begin{equation}...\end{equation}@  |
112
113 5 Martin Kraetke
h3. Widmung
114
115
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
116
| Widmung | @dedication@ | Widmung |  | @\dedication@  |
117
118 11 Martin Kraetke
h3. Brief
119 5 Martin Kraetke
120 11 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
121
| Briefabsatz | @letter@ | Absatz eines Briefes |  | @\begin{letter}...\end{letter}@  |
122 27 Maren Pufe
| Briefabsatz mit Abstand| @letter_spacing@ | Absatz eines Briefes |  | @\item@  |
123
124 28 Maren Pufe
*Beispiel:* (vor \items und am Ende sollte kein '\\' stehen)
125 27 Maren Pufe
126
|_. HUB-XML|_. TeX|_. PDF|
127
|<pre>
128
<div role="letter">
129
  <para role="letter">Lieber Briefreund</para>
130
  <para role="letter_spacing">Hier schreibe ich dir heute nun</para>
131
  <para role="letter">und hoffe dies und jenes.</para>
132
  <para role="letter">Der letzte Absatz hier.</para>
133
</div></pre>|<pre>\begin{letter}
134
  Lieber Briefreund,
135
\item Hier schreibe ich dir heute nun\\
136
  und hoffe dies und jenes.\\
137
  Der letzte Absatz hier.
138
\end{letter}
139
</pre> | <pre>
140
  Lieber Briefreund,
141
142
  Hier schreibe ich dir heute nun
143
  und hoffe dies und jenes.
144 28 Maren Pufe
  Der letzte Absatz hier.</pre> |
145 11 Martin Kraetke
146
h3. Bibliografie
147
148
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.
149
150
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
151
| Literatur | @literature@ | Literaturreferenz |  | @\bibitem@  |
152
153 14 Martin Kraetke
h3. Index und Indexkodierung
154
155 21 Martin Kraetke
Register können über folgende vier Wege erstellt werden, die auch kombiniert werden können.
156 14 Martin Kraetke
157
h4. (1) Word-Indexfunktion
158
159
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@.
160
161
h4. (2) Auszeichnung der Indexeinträge via Zeichenformat
162
163 24 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.
164 14 Martin Kraetke
165
h4. (3) Einfügen einer Konkordanzliste von Indexeinträgen
166
167
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.
168 1 Martin Kraetke
169 21 Martin Kraetke
h4. (4) Einfügen eines statischen Index
170
171
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!
172
173
h4. Formatvorlagen
174
175 14 Martin Kraetke
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
176
| Registerüberschrift | @index_heading@ | Überschrift des Registers |   |
177 24 Martin Kraetke
| Indexeintrag, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen |  | |
178 17 Martin Kraetke
| Indexeintrag, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Indexeintrag aus der Konkordanzliste |  | |
179 1 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 |  | |
180 21 Martin Kraetke
| Indexeintrag, siehe (4) | @index_static@ | Statischer Indexeintrag. Seitenzahlen im Eintrag werden mit der Seitenzahl verlinkt. |  | |
181 14 Martin Kraetke
182 5 Martin Kraetke
h3. Verzeichnisse
183
184
Es muss nur die Überschrift gesetzt werden. An dieser Stelle wird der Inhalt des Verzeichnisses automatisch ausgegeben.
185
186
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
187
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis |  | @\listoffigures@  |
188
| Tabellenverzeichnis | @list_of_figures@ | Überschrift des Tabellenverzeichnis |  | @\listoftables@  |
189 11 Martin Kraetke
| Endnotenverzeichnis | @list_of_endnotes@ | Überschrift des Endnotenverzeichnis |  | @\printnotes@  |
190 1 Martin Kraetke
191 30 Martin Kraetke
h3. Zeilenumbrüche
192
193
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@.
194
195
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
196
| Zeilenumbruch | @lineskip@ |  |  | @\vskip 1\baselineskip@  |
197
198 14 Martin Kraetke
h3. Zeichenformate
199 11 Martin Kraetke
200
|_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX |
201
|  | @nonlatin@ | Text der keine lateinischen Zeichen enthält |  | @\unichar@  |
202
| Regular | @regular@ | Steilgestellter Text |  |  |
203
| Halbfett | @bold@ | Halbfetter Text |  | @\textbf@ |
204
| Kursiv | @italic@ | Kursiver Text |  | @\textit@  |
205
| Kapitälchen | @smallcaps@ | Kapitälchen |  | @\textsc@  |
206
| Nicht umbrechender Leerraum | @space_nonbreaking@ |  |  |   |
207
| Schmales Leerzeichen | @space_thin@ |  |  |   |
208 19 Martin Kraetke
| Gesperrt | @spaced@ | gesperrter Text |  | @\so@  |
209
| Unterstrichen | @underline@ | unterstrichener Text |  |  @\ul@ |
210
| Durchgestrichen | @strike_trough@ | durchgestrichener Text  |  | @\st@  |
211
| Hochgestellt | @superscript@ | wird via Mathmode automatisch erstellt |  |  @$^{}$@ |
212
| Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt |  |  @$_{}$@ |