Projekt

Allgemein

Profil

Template Styles » Historie » Version 7

Martin Kraetke, 22.12.2021 12:35

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 5 Martin Kraetke
| part | @heading_part@ | Teil | \begin{heading}{part} |
23 1 Martin Kraetke
|\4=.                                             |
24 5 Martin Kraetke
| chapter | @heading_1@ | chapter, Überschrift 1. Ordnung  | \begin{heading}{chapter}... |
25
| chapter subheading | @subheading_1@ | subheading für chapter/Überschrift 2. Ordnung   | @\tpSubTitle{...}@ |
26 1 Martin Kraetke
| chapter author | @author@ | chapter author | @\tpAuthor{...}@ |
27 5 Martin Kraetke
| chapter author biography | @author_description@ | author biography included in a chapter | @\tpBio@ |
28
| chapter epigraph | @epigraph@, @epigraph@ | epigraph at chapter start | @\tpQuote{...}@ |
29 1 Martin Kraetke
| chapter epigraph source | @epigraph_source@, @epigraph_source@ | source or author of epigraph |   |
30
|\4=.                                             |
31 5 Martin Kraetke
| section 1. level | @heading_2@ | | @\begin{heading}{section}...@ |
32 1 Martin Kraetke
| section 1. level subheading | @subheading_2@ | subheading | |
33 5 Martin Kraetke
| section epigraph | @epigraph@ | section epigraph |  @\tpQuote{...}@ |
34 1 Martin Kraetke
|\4=.                                             |
35 5 Martin Kraetke
| section 2. level | @heading_3@ |  @\\begin{heading}{subsection}{...}@ |
36 1 Martin Kraetke
| section 2. level subheading  | @subheading_3@ | subheading | |
37
|\4=.                                             |
38 5 Martin Kraetke
| section 3. level | @heading_4@ | | @\begin{heading}{subsubsection}...@ |
39 1 Martin Kraetke
| section 3. level subheading  | @subheading_4@ | subheading |  |
40
|\4=.                                             |
41 5 Martin Kraetke
| section 4. level | @heading_5@ | | @\begin{heading}{paragraph}...@ |
42 1 Martin Kraetke
| 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 4 Martin Kraetke
| caption source | @figure_source@ | information about creator, copyright or other content which is different from the caption |  @\tpSource{...}@ |
72 1 Martin Kraetke
73 4 Martin Kraetke
h3. Tables
74 1 Martin Kraetke
75 4 Martin Kraetke
Tables are created with the Word default function. Table cell borders and background colors, row and column spans are kept for the output. For rotated tables, you need to apply a specific style. Tables can either be rotated or continued over several pages. 
76 1 Martin Kraetke
77
|_. Common Name |_. Style Name |_. Description |_. TeX |
78 4 Martin Kraetke
| Caption | @table_caption@ | Title or caption of the table |  | 
79
| Source | @table_source@ | Additional information that is placed below the table |  |  
80
| rotated table | @table_rotated@ | style needs to be applied on the paragraph before the table |  |  
81
| continued table | @table_pagewrap@ | style needs to be applied on the paragraph before the table |  |  
82 1 Martin Kraetke
83 4 Martin Kraetke
h3. Lists
84 1 Martin Kraetke
85 4 Martin Kraetke
Simple and numbered lists are heuristically detected by list marker and indent. Description lists like lists of abbreviations have a specific style. Description lists require that a single tab is placed between definition term and description.
86 1 Martin Kraetke
87
|_. Common Name |_. Style Name |_. Description |_. TeX |
88 4 Martin Kraetke
| description list | @abbreviations@ | list of abbreviations |  @\begin{description} \item[begriff] ... \end{description}@  |
89 1 Martin Kraetke
90 4 Martin Kraetke
h3. Long Quotations
91 1 Martin Kraetke
92 4 Martin Kraetke
Several consecutive citation paragraphs are combined automatically in a long citation environment. 
93 1 Martin Kraetke
94
|_. Common Name |_. Style Name |_. Description |_. TeX |
95 4 Martin Kraetke
| citation | @quotation@ | citation wrapper |  @\begin{quotation}...\end{quotation}@  |
96 1 Martin Kraetke
97 4 Martin Kraetke
h3. Dialogues
98 1 Martin Kraetke
99 4 Martin Kraetke
Several consecutive paragraphs that contain the dialog style are combined in a dialog wrapper. The speaker is automatically identified using a tactical symbol, usually a colon. The paragraph must begin with the speaker name. 
100 1 Martin Kraetke
101
|_. Common Name |_. Style Name |_. Description |_. TeX |
102 4 Martin Kraetke
| dialog | @dialogue@ | Dialog-Absatz |   @\begin{dialogue}...\end{dialogue}@  |
103
| speaker | colon: after speaker | speaker |  @\item[speaker] ...@  |
104 1 Martin Kraetke
105 4 Martin Kraetke
h3. Boxes
106 1 Martin Kraetke
107 4 Martin Kraetke
The beginning and the end of a box are each marked with specific paragraph styles for start end. No other text should appear in this paragraph, since they are removed in the process.
108 1 Martin Kraetke
109
|_. Common Name |_. Style Name |_. Description |_. TeX |
110 4 Martin Kraetke
| box with border start | @box_border_start@ | start marker of box with border | @\begin{kastenlinie}...@  |
111
| box with border end | @box_border_end@ | end marker of box with border | @...\end{kastenlinie}@  |
112
| box grey start | @box_grey_start@ | start marker of box with grey background | @\begin{kastengrau}...@  |
113
| box grey end | @box_grey_end@ | end marker of box with grey background  | @...\end{kastengrau}@  |
114 1 Martin Kraetke
115 4 Martin Kraetke
h3. Equations
116 1 Martin Kraetke
117 4 Martin Kraetke
Equations are automatically detected and converted to the proper markup. If you want to markup a simple text paragraph that may contain an equation as 
118
119 1 Martin Kraetke
|_. Common Name |_. Style Name |_. Description |_. TeX |
120 4 Martin Kraetke
| Equation paragraph | @formula@ | paragraph that contains equation | @\begin{equation}...\end{equation}@  |
121 1 Martin Kraetke
122 4 Martin Kraetke
h3. Dedication
123 1 Martin Kraetke
124
|_. Common Name |_. Style Name |_. Description |_. TeX |
125 4 Martin Kraetke
| Dedication | @dedication@ | Dedication |  @\dedication@  |
126 1 Martin Kraetke
127 4 Martin Kraetke
h3. Letter
128 1 Martin Kraetke
129
|_. Common Name |_. Style Name |_. Description |_. TeX |
130 4 Martin Kraetke
| Letter paragraph | @letter@ | paragraph of a letter | @\begin{letter}...\end{letter}@  |
131
| Letter paragraph with margin before | @letter_spacing@ | letter paragraph with margin before | @\item@  |
132 1 Martin Kraetke
133 4 Martin Kraetke
*Example:* before @\item@ and at the end there should be no @\\@
134 1 Martin Kraetke
135 4 Martin Kraetke
|_. HUB-XML |<pre>
136 1 Martin Kraetke
<div role="letter">
137 4 Martin Kraetke
  <para role="letter">Dear John Doe</para>
138
  <para role="letter_spacing">Here I am writing to you today</para>
139
  <para role="letter">and hope this and that.</para>
140
  <para role="letter">Give Jane my best regards.</para>
141
</div></pre> |
142
|_. TeX | <pre>\begin{letter}
143
  Dear John Doe,
144
\item Here I am writing to you today \\
145 6 Martin Kraetke
  and hope this and that.\\
146 4 Martin Kraetke
  Give Jane my best regards.
147 1 Martin Kraetke
\end{letter}
148 4 Martin Kraetke
</pre> |
149
|_. PDF| <pre>
150
  Dear John Doe,
151 1 Martin Kraetke
152 4 Martin Kraetke
  Here I am writing to you today
153
  and hope this and that.
154
  Give Jane my best regards.</pre> |
155 1 Martin Kraetke
156 7 Martin Kraetke
h3. Bibliography
157 1 Martin Kraetke
158 7 Martin Kraetke
A bibliography consists of consecutive paragraphs with references to literature. The paragraphs must be marked with the same style. If there is a regular heading above, this is automatically set as the heading of the bibliography. 
159 1 Martin Kraetke
160
|_. Common Name |_. Style Name |_. Description |_. TeX |
161 7 Martin Kraetke
| literature | @literature@ | bibliographical reference | @\bibitem@  |
162 1 Martin Kraetke
163
h3. Index und Indexkodierung
164
165
Register können über folgende vier Wege erstellt werden, die auch kombiniert werden können.
166
167
h4. (1) Word-Indexfunktion
168
169
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@.
170
171
h4. (2) Auszeichnung der Indexeinträge via Zeichenformat
172
173
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.
174
175
h4. (3) Einfügen einer Konkordanzliste von Indexeinträgen
176
177
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.
178
179
h4. (4) Einfügen eines statischen Index
180
181
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!
182
183
h4. Formatvorlagen
184
185
|_. Common Name |_. Style Name |_. Description |_. TeX |
186
| Registerüberschrift | @index_heading@ | Überschrift des Registers   | |
187
| Index entry, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen |  | 
188
| Index entry, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Index entry aus der Konkordanzliste |  | 
189
| 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 |  | 
190
| Index entry, siehe (4) | @index_static@ | Statischer Index entry. Seitenzahlen im Eintrag werden mit der Seitenzahl verlinkt. |  |
191
192
h3. Verzeichnisse
193
194
Es muss nur die Überschrift gesetzt werden. An dieser Stelle wird der Inhalt des Verzeichnisses automatisch ausgegeben.
195
196
|_. Common Name |_. Style Name |_. Description |_. TeX |
197
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis  | @\listoffigures@  |
198
| Tabellenverzeichnis | @list_of_figures@ | Überschrift des Tabellenverzeichnis | @\listoftables@  |
199
| Endnotenverzeichnis | @list_of_endnotes@ | Überschrift des Endnotenverzeichnis  | @\printnotes@  |
200
201
h3. Zeilenumbrüche
202
203
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@.
204
205
|_. Common Name |_. Style Name |_. Description |_. TeX |
206
| Zeilenumbruch | @lineskip@ |  |  @\vskip 1\baselineskip@  |
207
208
h3. Zeichenformate
209
210
|_. Common Name |_. Style Name |_. Description |_. TeX |
211
|  | @nonlatin@ | Text der keine lateinischen Zeichen enthält |   @\unichar@  |
212
| Regular | @regular@ | Steilgestellter Text |    |
213
| Halbfett | @bold@ | Halbfetter Text |   @\textbf@ |
214
| Kursiv | @italic@ | Kursiver Text |   @\textit@  |
215
| Kapitälchen | @smallcaps@ | Kapitälchen |   @\textsc@  |
216
| Nicht umbrechender Leerraum | @space_nonbreaking@ |  |     |
217
| Schmales Leerzeichen | @space_thin@ |  |     |
218
| Gesperrt | @spaced@ | gesperrter Text |   @\so@  |
219
| Unterstrichen | @underline@ | unterstrichener Text |    @\ul@ |
220
| Durchgestrichen | @strike_trough@ | durchgestrichener Text  |   @\st@  |
221
| Hochgestellt | @superscript@ | wird via Mathmode automatisch erstellt |    @\textsuperscript@ |
222
| Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt |   @\textsubscript@ |