Template Styles » Historie » Revision 4
Revision 3 (Martin Kraetke, 21.12.2021 16:18) → Revision 4/20 (Martin Kraetke, 21.12.2021 19:33)
h1. Template Styles
{{toc}}
h2. Prefix
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.
Example:
* Prefix for publisher (1-3 characters): e.g. @ts@ for _transcript publishers_
* Full style name for @heading_1@: @ts_heading_1@
h2. Style Names
h3. Headings
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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| book title | @book_title@ | Book title| @\title{...}@ |
|\4=. |
| part | @heading_part@ | Teil | @\part{...}@ |
|\4=. |
| chapter | @heading_1@ | chapter, Überschrift 1. Ordnung | |
| chapter subheading | @subheading_1@ | subheading für chapter/Überschrift 2. Ordnung | @\tpTitle{...}@ |
| chapter author | @author@ | chapter author | @\tpAuthor{...}@ |
| chapter author biography | @author_description@ | author biography included in a chapter | @\authorbio@ |
| chapter epigraph | @epigraph@, @epigraph@ | epigraph at chapter start | @\chapterquote{...}@ |
| chapter epigraph source | @epigraph_source@, @epigraph_source@ | source or author of epigraph | |
|\4=. |
| section 1. level | @heading_2@ | | @\section{...}@ |
| section 1. level subheading | @subheading_2@ | subheading | |
| section epigraph | @epigraph@ | section epigraph | @\secquote{...}@ |
|\4=. |
| section 2. level | @heading_3@ | @\subsection{...}@ |
| section 2. level subheading | @subheading_3@ | subheading | |
|\4=. |
| section 3. level | @heading_4@ | | @\subsubsection{...}@ |
| section 3. level subheading | @subheading_4@ | subheading | |
|\4=. |
| section 4. level | @heading_5@ | | @\paragraph{...}@ |
| section 4. level subheading | @subheading_5@ | subheading | |
|\4=. |
| bridgehead | @headword@ | bridgehead, not included in ToC | @\subparagraph{...}@ |
h3. Running Headers
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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| running header short | @headline_short@ | override for automatically generated running header. | @\chaptermark{}@ |
h3. Figures
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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Figure | @figure@ | Figure | @\begin{tpFigure}[<options>]
\tpCaption{<caption>}
\tpSource{<Quelle>}
\tpLegend{<Legende>}
\tpNumber{<Nummer>}
\tpFig{\includegraphics[<optionen>]{<pfad>}}
\end{tpFigure}@ |
|_\4=. multiple figures with specific layouts |
| figure (layout A) | @figure_A${Zahl}@ | image with ${number} 1 to 3 images side by side column width | @\begin{tpFigure}[class=a]@ |
| figure (layout B) | @figure_B${Zahl}@ | image with ${number} 1 to 3 images side by side with margin | @\begin{tpFigure}[class=b]@ |
| figure (layout C) | @figure_C${Zahl}@ | image with ${number} 1 to 3 images side by side with more margin | @\begin{tpFigure}[class=c]@ |
|\4=. |
| caption | @figure_caption@ | caption or description of the image | @\tpCaption{...}@ |
| caption source | @figure_source@ | information about creator, copyright or other content which is different from the caption Quelle des Bildes | @\tpSource{...}@ |
h3. Tables Tabellen
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.
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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Caption Legende | @table_caption@ | Title or caption of the table Legende bzw. Beschreibung der Tabelle | |
| Source Quelle | @table_source@ | Additional information that is placed below the table Quelle der Tabelle | |
| rotated table Quelle | @table_rotated@ | style needs to be applied on the paragraph before the table muss in dem Absatz vor der zu drehenden Tabelle stehen | |
| continued table Quelle | @table_pagewrap@ | style needs to be applied on the paragraph before the table muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt) | |
h3. Lists Listen
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. 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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| description list Zitat | @abbreviations@ | list of abbreviations | Beschreibungsliste| @\begin{description} \item[begriff] ... \end{description}@ |
h3. Long Quotations Langzitat
Several consecutive citation paragraphs are combined automatically Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitat-Formatvorlage werden in a long citation environment.
eine Langzitat-Umgebung zusammengefasst.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| citation Zitat | @quotation@ | citation wrapper Zitat-Absatz | @\begin{quotation}...\end{quotation}@ |
h3. Dialogues Dialoge
Several consecutive paragraphs that contain the dialog style are combined Mehrere unmittelbar aufeinanderfolgende Absätze mit der Dialog-Formatvorlage werden in a dialog wrapper. The speaker is automatically identified using a tactical symbol, usually a colon. The paragraph must begin with the speaker name.
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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| dialog Dialog | @dialogue@ | Dialog-Absatz | @\begin{dialogue}...\end{dialogue}@ |
| speaker Sprecher*in | colon: after speaker | speaker Sprecher*in | @\item[speaker] ...@ |
h3. Boxes Boxen / Kästen
The beginning and the end of a box are each marked with specific paragraph styles for start end. No other text should appear Der Anfang und das Ende einer Box wird jeweils mit einem Absatzformat markiert. Dabei darf kein anderer Text in this paragraph, since they are removed in the process. dem Absatz stehen.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| box with border start Kasten mit Rahmen Beginn | @box_border_start@ | start marker of box with border transparenter Kasten mit Rahmen Beginn | @\begin{kastenlinie}...@ |
| box with border end Kasten mit Rahmen Ende | @box_border_end@ | end marker of box with border transparenter Kasten mit Rahmen Ende | @...\end{kastenlinie}@ |
| box grey start Kasten schattiert Beginn | @box_grey_start@ | start marker of box with grey background Kasten mit grauer Hinterlegung Beginn | @\begin{kastengrau}...@ |
| box grey end Kasten schattiert Ende | @box_grey_end@ | end marker of box with grey background Kasten mit grauer Hinterlegung Ende | @...\end{kastengrau}@ |
h3. Equations Formeln
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
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Equation paragraph Formelabsatz | @formula@ | paragraph that contains equation Absatz, der Formel enthält | @\begin{equation}...\end{equation}@ |
h3. Dedication Widmung
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Dedication Widmung | @dedication@ | Dedication Widmung | @\dedication@ |
h3. Letter Brief
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Letter paragraph Briefabsatz | @letter@ | paragraph of a letter Absatz eines Briefes | @\begin{letter}...\end{letter}@ |
| Letter paragraph with margin before | Briefabsatz mit Abstand| @letter_spacing@ | letter paragraph with margin before Absatz eines Briefes | @\item@ |
*Example:* before @\item@ and at the end there should be no @\\@ *Beispiel:* (vor \items und am Ende sollte kein '\\' stehen)
|_. HUB-XML HUB-XML|_. TeX|_. PDF|
|<pre>
<div role="letter">
<para role="letter">Dear John Doe</para> role="letter">Lieber Briefreund</para>
<para role="letter_spacing">Here I am writing to you today</para> role="letter_spacing">Hier schreibe ich dir heute nun</para>
<para role="letter">and hope this and that.</para> role="letter">und hoffe dies und jenes.</para>
<para role="letter">Give Jane my best regards.</para> role="letter">Der letzte Absatz hier.</para>
</div></pre> |
|_. TeX | <pre>\begin{letter} </div></pre>|<pre>\begin{letter}
Dear John Doe, Lieber Briefreund,
\item Here I am writing to you today \\ Hier schreibe ich dir heute nun\\
nd hope this and that.\\ und hoffe dies und jenes.\\
Give Jane my best regards. Der letzte Absatz hier.
\end{letter}
</pre> |
|_. PDF| <pre>
Dear John Doe, Lieber Briefreund,
Here I am writing to you today Hier schreibe ich dir heute nun
and hope this and that. und hoffe dies und jenes.
Give Jane my best regards.</pre> Der letzte Absatz hier.</pre> |
h3. Bibliografie
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.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Literatur | @literature@ | Literaturreferenz | @\bibitem@ |
h3. Index und Indexkodierung
Register können über folgende vier Wege erstellt werden, die auch kombiniert werden können.
h4. (1) Word-Indexfunktion
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@.
h4. (2) Auszeichnung der Indexeinträge via Zeichenformat
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.
h4. (3) Einfügen einer Konkordanzliste von Indexeinträgen
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.
h4. (4) Einfügen eines statischen Index
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!
h4. Formatvorlagen
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Registerüberschrift | @index_heading@ | Überschrift des Registers | |
| Index entry, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen | |
| Index entry, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Index entry aus der Konkordanzliste | |
| 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 | |
| Index entry, siehe (4) | @index_static@ | Statischer Index entry. Seitenzahlen im Eintrag werden mit der Seitenzahl verlinkt. | |
h3. Verzeichnisse
Es muss nur die Überschrift gesetzt werden. An dieser Stelle wird der Inhalt des Verzeichnisses automatisch ausgegeben.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis | @\listoffigures@ |
| Tabellenverzeichnis | @list_of_figures@ | Überschrift des Tabellenverzeichnis | @\listoftables@ |
| Endnotenverzeichnis | @list_of_endnotes@ | Überschrift des Endnotenverzeichnis | @\printnotes@ |
h3. Zeilenumbrüche
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@.
|_. Common Name |_. Style Name |_. Description |_. TeX |
| Zeilenumbruch | @lineskip@ | | @\vskip 1\baselineskip@ |
h3. Zeichenformate
|_. Common Name |_. Style Name |_. Description |_. TeX |
| | @nonlatin@ | Text der keine lateinischen Zeichen enthält | @\unichar@ |
| Regular | @regular@ | Steilgestellter Text | |
| Halbfett | @bold@ | Halbfetter Text | @\textbf@ |
| Kursiv | @italic@ | Kursiver Text | @\textit@ |
| Kapitälchen | @smallcaps@ | Kapitälchen | @\textsc@ |
| Nicht umbrechender Leerraum | @space_nonbreaking@ | | |
| Schmales Leerzeichen | @space_thin@ | | |
| Gesperrt | @spaced@ | gesperrter Text | @\so@ |
| Unterstrichen | @underline@ | unterstrichener Text | @\ul@ |
| Durchgestrichen | @strike_trough@ | durchgestrichener Text | @\st@ |
| Hochgestellt | @superscript@ | wird via Mathmode automatisch erstellt | @\textsuperscript@ |
| Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt | @\textsubscript@ |