Projekt

Allgemein

Profil

Template Styles » Historie » Version 15

Martin Kraetke, 04.04.2022 17:32

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 15 Martin Kraetke
| Table Header | @table_header@ | Paragraph style for table headers. Needs to be applied in the table cell |  | 
79 4 Martin Kraetke
| Caption | @table_caption@ | Title or caption of the table |  | 
80
| Source | @table_source@ | Additional information that is placed below the table |  |  
81
| rotated table | @table_rotated@ | style needs to be applied on the paragraph before the table |  |  
82
| continued table | @table_pagewrap@ | style needs to be applied on the paragraph before the table |  |  
83 1 Martin Kraetke
84 4 Martin Kraetke
h3. Lists
85 1 Martin Kraetke
86 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.
87 1 Martin Kraetke
88
|_. Common Name |_. Style Name |_. Description |_. TeX |
89 4 Martin Kraetke
| description list | @abbreviations@ | list of abbreviations |  @\begin{description} \item[begriff] ... \end{description}@  |
90 1 Martin Kraetke
91 4 Martin Kraetke
h3. Long Quotations
92 1 Martin Kraetke
93 4 Martin Kraetke
Several consecutive citation paragraphs are combined automatically in a long citation environment. 
94 1 Martin Kraetke
95
|_. Common Name |_. Style Name |_. Description |_. TeX |
96 4 Martin Kraetke
| citation | @quotation@ | citation wrapper |  @\begin{quotation}...\end{quotation}@  |
97 1 Martin Kraetke
98 4 Martin Kraetke
h3. Dialogues
99 1 Martin Kraetke
100 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. 
101 1 Martin Kraetke
102
|_. Common Name |_. Style Name |_. Description |_. TeX |
103 4 Martin Kraetke
| dialog | @dialogue@ | Dialog-Absatz |   @\begin{dialogue}...\end{dialogue}@  |
104
| speaker | colon: after speaker | speaker |  @\item[speaker] ...@  |
105 1 Martin Kraetke
106 4 Martin Kraetke
h3. Boxes
107 1 Martin Kraetke
108 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.
109 1 Martin Kraetke
110
|_. Common Name |_. Style Name |_. Description |_. TeX |
111 4 Martin Kraetke
| box with border start | @box_border_start@ | start marker of box with border | @\begin{kastenlinie}...@  |
112
| box with border end | @box_border_end@ | end marker of box with border | @...\end{kastenlinie}@  |
113
| box grey start | @box_grey_start@ | start marker of box with grey background | @\begin{kastengrau}...@  |
114
| box grey end | @box_grey_end@ | end marker of box with grey background  | @...\end{kastengrau}@  |
115 1 Martin Kraetke
116 4 Martin Kraetke
h3. Equations
117 1 Martin Kraetke
118 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 
119
120 1 Martin Kraetke
|_. Common Name |_. Style Name |_. Description |_. TeX |
121 4 Martin Kraetke
| Equation paragraph | @formula@ | paragraph that contains equation | @\begin{equation}...\end{equation}@  |
122 1 Martin Kraetke
123 4 Martin Kraetke
h3. Dedication
124 1 Martin Kraetke
125
|_. Common Name |_. Style Name |_. Description |_. TeX |
126 4 Martin Kraetke
| Dedication | @dedication@ | Dedication |  @\dedication@  |
127 1 Martin Kraetke
128 4 Martin Kraetke
h3. Letter
129 1 Martin Kraetke
130
|_. Common Name |_. Style Name |_. Description |_. TeX |
131 4 Martin Kraetke
| Letter paragraph | @letter@ | paragraph of a letter | @\begin{letter}...\end{letter}@  |
132
| Letter paragraph with margin before | @letter_spacing@ | letter paragraph with margin before | @\item@  |
133 1 Martin Kraetke
134 4 Martin Kraetke
*Example:* before @\item@ and at the end there should be no @\\@
135 1 Martin Kraetke
136 4 Martin Kraetke
|_. HUB-XML |<pre>
137 1 Martin Kraetke
<div role="letter">
138 4 Martin Kraetke
  <para role="letter">Dear John Doe</para>
139
  <para role="letter_spacing">Here I am writing to you today</para>
140
  <para role="letter">and hope this and that.</para>
141
  <para role="letter">Give Jane my best regards.</para>
142
</div></pre> |
143
|_. TeX | <pre>\begin{letter}
144
  Dear John Doe,
145
\item Here I am writing to you today \\
146 6 Martin Kraetke
  and hope this and that.\\
147 4 Martin Kraetke
  Give Jane my best regards.
148 1 Martin Kraetke
\end{letter}
149 4 Martin Kraetke
</pre> |
150
|_. PDF| <pre>
151
  Dear John Doe,
152 1 Martin Kraetke
153 4 Martin Kraetke
  Here I am writing to you today
154
  and hope this and that.
155
  Give Jane my best regards.</pre> |
156 1 Martin Kraetke
157 7 Martin Kraetke
h3. Bibliography
158 1 Martin Kraetke
159 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. 
160 1 Martin Kraetke
161
|_. Common Name |_. Style Name |_. Description |_. TeX |
162 7 Martin Kraetke
| literature | @literature@ | bibliographical reference | @\bibitem@  |
163 1 Martin Kraetke
164 8 Martin Kraetke
h3. Index 
165 1 Martin Kraetke
166 8 Martin Kraetke
Indices can be created in the following four ways, which can also be combined.
167 1 Martin Kraetke
168 8 Martin Kraetke
h4. (1) Word index function 
169 1 Martin Kraetke
170 8 Martin Kraetke
Index entries can be made for selected words in the Word ribbon @References@. Mark a word and click the @Mark Entry@ button. Further information can be found in the "Microsoft Word documentation":https://support.microsoft.com/en-us/office/create-and-update-an-index-cc502c71-a605-41fd-9a02-cda9d14bf073
171 1 Martin Kraetke
172 8 Martin Kraetke
h4. (2) Marking of index terms via character format
173 1 Martin Kraetke
174 8 Martin Kraetke
Index entries can be specified by marking up words or phrases with the @index_mark@ format. Index entries that have already been coded with the Word index function are ignored. 
175 1 Martin Kraetke
176 8 Martin Kraetke
h4. (3) Insert a concordance list of index entries 
177 1 Martin Kraetke
178 8 Martin Kraetke
Index entries can be automatically encoded using a concordance list. To do this, a list of index entries must be added at the end of the document. Wherever in the rest of the document words or phrases from this list are found, an index entry is automatically encoded. An index entry with the paragraph format @index_list@ must be used for this. Each entry must be in a separate paragraph. Index entries that have already been coded with the Word index function or via the @index@ character format are ignored.
179 1 Martin Kraetke
180 8 Martin Kraetke
h4. (4) Insert a static index 
181 1 Martin Kraetke
182 13 Martin Kraetke
If you do not want to automatically search for entries in the text in the index, you can also insert a static index. Simply insert a list of index entries with the @index_static@ format. Page numbers in the form @My Entry 144, 156, 192 @ are then linked to the page, i.e. you have to make sure that the page reference is correct!
183 1 Martin Kraetke
184 8 Martin Kraetke
h4. Index styles
185 1 Martin Kraetke
186
|_. Common Name |_. Style Name |_. Description |_. TeX |
187 8 Martin Kraetke
| Index heading | @index_heading@ | Heading of index | |
188
| Index entry, see (2) | @index_mark@ | Character style for encoding an index entry in the content |  | 
189
| Index entry, see (3) | @index_list@ | paragraph style for an index entry in a concordance list |  | 
190
| Index entry search term | @index_name@ | Character style, must be used within @index_list@ to mark the index search term separately, e.g. for _John Doe_, _Doe_ can be marked so that an index entry is also created for _Mr Doe_ |  | 
191 1 Martin Kraetke
| Index entry, see (4) | @index_static@ | Index entry in a static index list. if you insert a page number, a page reference is automatically created |  |
192 14 Martin Kraetke
| Index type suffix (4) | @index_*_(person/location/subject)@ | suffix to add to any of the index styles above which specifies a certain index type. Needed if you want to print multiple indices in one document. |  |
193 1 Martin Kraetke
194 9 Martin Kraetke
h3. Listings
195 1 Martin Kraetke
196 9 Martin Kraetke
To create the following listings, you only need to place the heading with a specific style. The contents of the listng is automatically generated. 
197 1 Martin Kraetke
198
|_. Common Name |_. Style Name |_. Description |_. TeX |
199 9 Martin Kraetke
| List of Figures | @list_of_figures@ | Heading of the LoF | @\listoffigures@  |
200
| List of Tables | @list_of_figures@ | Heading of the LoT | @\listoftables@  |
201
| Endnotes | @list_of_endnotes@ | Endnotes heading | @\printnotes@  |
202 1 Martin Kraetke
203 10 Martin Kraetke
h3. Line breaks
204 1 Martin Kraetke
205 10 Martin Kraetke
Empty paragraphs are automatically removed. To control the number of line breaks, you should mark empty paragraphs with the @lineskip@ style. You can specify the number of breaks at the end of the style name, e.g. @lineskip3@ for three breaks. A normal break (Shift + Enter) is converted to @\newline@. 
206 1 Martin Kraetke
207
|_. Common Name |_. Style Name |_. Description |_. TeX |
208 10 Martin Kraetke
| line break | @lineskip@ |  |  @\vskip 1\baselineskip@  |
209
210 12 Martin Kraetke
h3. Character styles
211 1 Martin Kraetke
212
|_. Common Name |_. Style Name |_. Description |_. TeX |
213 11 Martin Kraetke
| non-latin | @nonlatin@ | |   @\unichar@  |
214
| regular | @regular@ | |    |
215
| bold | @bold@ | |   @\textbf@ |
216
| itaklic | @italic@ | |   @\textit@  |
217
| small caps | @smallcaps@ | |   @\textsc@  |
218
| non breaking space | @space_nonbreaking@ |  |     |
219
| thin space | @space_thin@ |  |     |
220
| spaced | @spaced@ |  |   @\so@  |
221
| underline | @underline@ |  |    @\ul@ |
222
| linethrough | @strike_trough@ |  |   @\st@  |
223
| superscript | @superscript@ | |    @\textsuperscript@ |
224
| subscript | @subscript@ | |   @\textsubscript@ |