Formatvorlagen » Historie » Revision 80
Revision 79 (Marcus Hottenroth, 27.12.2023 08:38) → Revision 80/83 (Moritz Hüper, 15.02.2024 10:14)
h1. Formatvorlagen
{{toc}}
h2. Präfix
Alle Formatvorlagennamen enthalten ein Präfixkürzel, das den Verlag identifiziert und mit einem Unterstrich vom restlichen Formatvorlagennamen abgetrennt wird.
Beispiel:
* Präfix für Verlag (1–3 Buchstaben): z. B. @ts@ für _transcript_
* vollständiger Formatvorlagenname für @heading_1@: @ts_heading_1@
h2. Formatvorlagenkatalog
h3. Überschriften
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 in Word vorhandenen Standardformatvorlagen für Überschriften werden ebenfalls ausgewertet, wobei @Überschrift 1@ der Formatvorlage @heading_part@ entspricht, @Überschrift 2@ der Vorlage @heading_1@ usw.
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
| Buchtitel | @book_title@ | Buchtitel | <pre><code>\begin{tpMeta}
…
\tpTitle{…}
…
\end{tpMeta}</pre></code> |
|\5=. |
| Teil | @heading_part@ | Teil | <pre><code>\begin{heading}{part}
…
\end{heading}</pre></code> |
|\5=. |
| Kapitel | @heading_1@ | Kapitel, Überschrift 1. Ordnung | |
| Kapitel-Unterüberschrift | @subheading_1@ | Unterüberschrift für Kapitel/Überschrift 2. Ordnung | <pre><code>\begin{heading}{chapter}
…
\tpSubtitle{…}
…
\end{heading}</pre></code> |
| Kapitel-Autor | @author@ | Autor*in des Kapitels | <pre><code>\begin{heading}{…}
…
\tpAuthorNameList{…}
…
\end{heading}</pre></code>
alternativ:
<pre><code>
\begin{heading}{…}
…
\begin{tpAuthor}
\tpFullName{…}
\end{tpAuthor}
…
\end{heading}
</pre></code>
oder
<pre><code>
\begin{heading}{…}
…
\begin{tpAuthor}
\tpFirstName{…}
\tpMidName{…}
\tpLastName{…}
\end{tpAuthor}
…
\end{heading}
</pre></code>|
| Kapitel-Autorenbeschreibung | @author_description@ | Vita/Beschreibung zu Autor/-in des Kapitels | <pre><code>\begin{heading}{chapter}
…
\begin{tpAuthor}
…
\tpBio{…}
…
\end{tpAuthor}
…
\end{heading}
</pre></code>|
| Kapitel-Motto | @motto@, @epigraph@ | Motto zum Kapitelbeginn | <pre><code>\begin{heading}{chapter}
…
\begin{tpQuote}
\tpQuoteText{…}
\tpQuoteSource{…}
\end{tpQuote}
…
\end{heading}</pre></code> |
| Kapitel-Motto-Quelle | @motto_source@, @epigraph_source@ | Quelle/Autor*in des Mottos | @\tpQuoteSource{…}@ (s. o.)|
|\5=. |
| Abschnitt 1. Ebene | @heading_2@ | | <pre><code>\begin{heading}{section}
…
\tpTitle{…}
…
\end{heading}</pre></code> |
| Abschnitt 1. Ebene Unterüberschrift | @subheading_2@ | Unterüberschrift | <pre><code>\begin{heading}{section}
…
\tpSubtitle{…}
…
\end{heading}</pre></code> |
| Abschnitt Motto | @motto@ | Motto zu Beginn des Abschnitts | s. Kapitel-Motto |
|\5=. |
| Abschnitt 2. Ebene | @heading_3@ | | <pre><code>\begin{heading}{subsection}
…
\tpTitle{…}
…
\end{heading}</pre></code> |
| Abschnitt 2. Ebene Unterüberschrift | @subheading_3@ | Unterüberschrift | <pre><code>\begin{heading}{subsection}
…
\tpSubtitle{…}
…
\end{heading}</pre></code>|
|\5=. |
| Abschnitt 3. Ebene | @heading_4@ | | <pre><code>\begin{heading}{subsubsection}
…
\tpTitle{…}
…
\end{heading}</pre></code> |
| Abschnitt 3. Ebene Unterüberschrift | @subheading_4@ | Unterüberschrift | <pre><code>\begin{heading}{subsubsection}
…
\tpSubtitle{…}
…
\end{heading}</pre></code> |
|\5=. |
| Abschnitt 4. Ebene | @heading_5@ | | <pre><code>\begin{heading}{praragraph}
…
\tpTitle{…}
…
\end{heading}</pre></code> |
| Abschnitt 4. Ebene Unterüberschrift | @subheading_5@ | Unterüberschrift | <pre><code>\begin{heading}{paragraph}
…
\tpSubtitle{…}
…
\end{heading}</pre></code> |
|\5=. |
| Spitzmarke | @headword@ | Zwischenüberschrift, erscheint nicht im IHV | <pre><code>\begin{heading}{subparagraph}
…
\tpTitle{…}
…
\end{heading}</pre></code> |
| Frontmatter _n_-te Ebene (1 ≤ _n_ ≤ 5) | @frontmatter_n@ (1 ≤ @n@ ≤ 5) | Frontmatterüberschrift| s. Hauptüberschriften; Frontmatterüberschriften erscheinen nach dem Switch @\frontmatter@ |
| Backmatter _n_-te Ebene (1 ≤ _n_ ≤ 5) | @backmatter_n@ (1 ≤ @n@ ≤ 5) | Backmatterüberschrift | analog zu Frontmatterüberschriften; erscheinen nach dem Switch @\backmatter@ |
h3. Kolumnentitel
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.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Kolumnentitel links | @headline_left@ | Überschreibung des automatisch erstellten linken Kolumnentitels | @\tpRunTitle@ |
| Kolumnentitel rechts | @headline_right@ | Überschreibung des automatisch erstellten rechten Kolumnentitels | @\tpRunTitle@ |
h3. Bilder
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.
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
| Abbildung | @figure@ | Bild | <pre><code>\begin{tpFigure}
\tpNumber{…}
\tpListofNumber{…}
\tpLegend{…}
\tpCaption{…}
\tpSource{…}
\tpFig{\includegraphics{image.jpg}}
\end{tpFigure}</code></pre> |
| Abbildung mit Layout/Klasse A, B, C etc. | @figure_A${Zahl}@, @figure_B${Zahl}@, @figure_C${Zahl}@ etc. | Erscheinungsbild von der Definition im Stylefile abhängig; @${Zahl}@ entspricht der jeweiligen Teilabbildung | <pre><code>\begin{tpFigure}[class=…]
…
\end{tpFigure}</code></pre> |
| Abbildung mit Positionsangabe | | Position entspricht den aus Standard-TeX bekannten (@h@, @h!@, @t@, @b@, @p@) | <pre><code>\begin{tpFigure}[float-pos=…]
…
\end{tpFigure}</code></pre> |
|\5=.|
| Abbildungsnummer | @figure_number@ | Nummer der Abbildung | @\tpNumber{…}@ |
| Abbildungsverzeichnisnummer | | von der eigentlichen Nummer (@tpNumber@) abweichende Nummer für das Abbildungsverzeichnis | @\tpListofNumber{…}@ |
| Bildunterschrift | @figure_caption@ | Beschreibung des Bildes | @\tpCaption{…}@ |
| Legende | @figure_legend@ | Legende bzw. Anmerkungen zum Bild | @\tpCaption{…}@ |
| Quelle | @figure_source@ | Quelle des Bildes | @\tpSource{…}@ |
h3. Tabellen
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.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Tabelle | @table@ | — | <pre><code>\begin{tpTable}
\tpNumber{…}
\tpListofNumber{…}
\tpCaption{…}
\tpSource{…}
\tpLegend{…}
\end{tpTable}</code></pre> |
| Tabellenkopf| @table_header@ | Absatzformat für Tabellenköpfe; in den Tabellenzellen anwenden | |
| Querformattabelle | @table_rotated@ | muss in dem Absatz vor der zu drehenden Tabelle stehen | <pre><code>\begin{tpTable}[orientation=landscape]
…
\end{tpTable}</code></pre> |
| erzwungener Seitenumbruch | @table_pagewrap@ | muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt, doch dieses Verhalten kann überschrieben werden); entspr. TeX-Code steht innerhalb der Zeile, nach welcher umbrochen werden soll | @\doTableBreak@ |
|\5=.|
| Tabellennummer | @table_number@ | Nummer der Tabelle | @\tpNumber{…}@ |
| Tabellenverzeichnisnummer | | von der eigentlichen Nummer (@tpNumber@) abweichende Nummer für das Tabellenverzeichnis | @\tpListofNumber{…}@ |
| Tabellenunterschrift/-titel | @table_caption@ | Titel bzw. Unterschrift der Tabelle, je nach Layoutdefinition | @\tpCaption{…}@ |
| Legende | @table_legend@ | Legende oder Anmerkungen zur Tabelle | @\tpLegend@ |
| Quelle | @table_source@ | Quelle der Tabelle | @\tpSource@ |
h3. Listen
Einfache und nummerierte Listen werden heuristisch erkannt. Beschreibungslisten, wie z. B. ein Abkürzungsverzeichnis, werden mit folgendem Format ausgezeichnet. Wichtig ist, dass zwischen Begriff und Beschreibung _ein_ Tabulator gesetzt wird.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Zitat | @abbreviations@ | Beschreibungsliste| <pre><code>\begin{description}
\item[…] …
\end{description}</code></pre> |
h3. Langzitat
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitatformatvorlage werden zu einer Langzitatumgebung zusammengefasst.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Zitat | @quotation@ | Zitat-Absatz | <pre><code>\begin{quotation}
…
\end{quotation}</code></pre> |
h3. Dialoge
Mehrere unmittelbar aufeinanderfolgende Absätze mit der Dialogformatvorlage werden zu einer Dialogumgebung zusammengefasst. Die Auszeichnung der Sprecher erfolgt automatisch über ein taktisches Zeichen, üblicherweise den Doppelpunkt. Ideal ist eine Abgrenzung per Tabulator. Der Absatz muss mit dem/der Sprecher/-in beginnen.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Dialog | @dialogue@ | Dialogabsatz | <pre><code>\begin{dialog}
…
\end{dialog}</code></pre> |
| Sprecher/-in | | Sprecher/-in (@${Sprecher}@) | <pre><code>\begin{dialog}
\item[${Sprecher}] …
\end{dialog}</code></pre> |
h3. Boxen/Kästen
Der Anfang und das Ende einer Box wird jeweils mit einem Absatzformat markiert. Dabei darf kein anderer Text in dem Absatz stehen.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Kasten mit Rahmen, Beginn | @box_border_start@ | Beginn eines Kastens mit Rahmen und transparentem Hintergrund | <pre><code>\begin{kastenlinie}
…</code></pre> |
| Kasten mit Rahmen, Ende | @box_border_end@ | Endes eines Kastens mit Rahmen und transparentem Hintergrund | <pre><code> …
\end{kastenlinie}</code></pre> |
| Kasten mit Schattierung, Beginn | @box_grey_start@ | Beginn eines Kastens mit grauer Hinterlegung | <pre><code>\begin{kastengrau}
…</code></pre> |
| Kasten mit Schattierung, Ende | @box_grey_end@ | Eine eines Kastens mit grauer Hinterlegung | <pre><code> …
\end{kastengrau}</code></pre> |
h3. Formeln
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Formelabsatz | @formula@ | Absatz, der eine Formel enthält | <pre><code>\begin{equation}
…
\end{equation}</code></pre> |
h3. Widmung
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Widmung | @dedication@ | Widmung | <pre><code>\begin{tpMeta}
…
\tpDedication{…}
…
\end{tpMeta}</code></pre> |
h3. Brief
*Möglicherweise obsolet. @Konverterbetreuer: Bitte prüfen.*
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Briefabsatz | @letter@ | Absatz eines Briefes | <pre><code>\begin{letter}
…
\end{letter}</code></pre> |
| Briefabsatz mit Abstand| @letter_spacing@ | Absatz eines Briefes | @\item@ |
*Beispiel* (vor @\items@ und am Ende sollte kein @\\@ stehen)
|_. HUB-XML|_. TeX|_. PDF|
|<pre>
<div role="letter">
<para role="letter">Lieber Briefreund</para>
<para role="letter_spacing">Hier schreibe ich dir heute nun</para>
<para role="letter">und hoffe dies und jenes.</para>
<para role="letter">Der letzte Absatz hier.</para>
</div></pre>|<pre>\begin{letter}
Lieber Briefreund,
\item Hier schreibe ich dir heute nun\\
und hoffe dies und jenes.\\
Der letzte Absatz hier.
\end{letter}
</pre> | <pre>
Lieber Briefreund,
Hier schreibe ich dir heute nun
und hoffe dies und jenes.
Der letzte Absatz hier.</pre> |
h3. Bibliographie
Eine Bibliographie besteht aus direkt aufeinanderfolgenden Absätzen mit Literaturreferenzen. Diese Absätze müssen mit derselben Formatvorlage ausgezeichnet sein. Wenn darüber eine reguläre Überschrift steht, wird diese automatisch als Überschrift der Bibliographie gesetzt.
|_. Bezeichnung |_. Name |_. Beschreibung|_. TeX |
| Literatur | @literature@ | Literaturreferenz | <pre><code>\begin{thebibliography}
…
\bibitem[…]{…} …
…
\end{thebibliography}</code></pre> |
h3. Index und Indexkodierung
weitere Informationen dazu auch hier: https://redmine.le-tex.de/projects/transpect-typesetter/wiki/Index#Index-%C3%9Cberschriften-und-Index-Position-steuern
Register können über folgende vier Wege, die auch kombiniert werden können, erstellt werden:
h4. (1) Word-Indexfunktion
Im Word-Ribbon @Referenzen@ können für markierte Wörter Indexeinträge festgelegt werden. Dafür markiert man ein Wort 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 Indexeintrag erzeugt. 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.
h4. (4) Einfügen eines statischen Index
Soll im Text nicht automatisch nach Einträgen für einen 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, was bedeutet, dass man hier selbst dafür Sorge tragen muss, dass die Seitenreferenz auch richtig ist!
h4. Formatvorlagen
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Registerüberschrift | @index_heading@ | Überschrift des Registers | |
| Indexeintrag, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen | @\index[…]{…}@ |
| Indexeintrag, siehe (3) | @index_list@ | Absatzformat, ein Absatz repräsentiert einen Indexeintrag aus der Konkordanzliste | |
| Indexeintrag Suchbegriff | @index_name@ | Zeichenformat; muss innerhalb von @index_list@ verwendet werden, um den Indexsuchbegriff separat auszuzeichnen, z. B. kann bei _Max Mustermann_ der Teil _Mustermann_ ausgezeichnet werden, damit auch bei _Herr Mustermann_ ein Indexeintrag erstellt wird | |
| Indexeintrag, siehe (4) | @index_static@ | Statischer Indexeintrag; Seitenzahlen im Eintrag werden als Link auf die entsprechende Seite ausgegeben | |
h3. Verzeichnisse
Das Setzen einer Überschrift erfolgt separat über eine der Formatvorlagen für Überschriften respektive @begin{heading}{…} … \end{heading}@. Anschließend wird der Inhalt des Verzeichnisses über das entsprechende Makro ausgegeben.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Abbildungsverzeichnis | @list_of_figures@ | Überschrift des Abbildungsverzeichnis | @\listoffigures@ |
| Tabellenverzeichnis | @list_of_tables@ | Ü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@.
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| Zeilenumbruch | @lineskip@ | | @\vskip1\baselineskip@ |
h3. Zeichenformate
|_. Bezeichnung |_. Name |_. Beschreibung |_. TeX |
| | @nonlatin@ | Text, der keine lateinischen Zeichen enthält | @\unichar{…}@ |
| Recte | @regular@ | Steilgestellter Text | Makro: @\textup{…}@; Schalter: @{\upshape …}@ |
| Halbfett | @bold@ | Halbfetter Text | Makro: @\textbf{…}@; Schalter: @{\bfshape }@ |
| Kursiv | @italic@ | Kursiver Text | Makro: @\textit{…}@; Schalter: @{\itshape …}@ |
| Kapitälchen | @smallcaps@ | Kapitälchen | Makro: @\textsc{…}@; Schalter: @{\scshape …}@ |
| Nicht umbrechender Leerraum | @space_nonbreaking@ | | @~@ |
| Schmales Leerzeichen | @space_thin@ | | @\,@ |
| Sperrtext | @spaced@ | gesperrter Text | @\so{…}@ |
| Unterstrichen | @underline@ | unterstrichener Text | @\ul{…}@ |
| Durchgestrichen | @strike_trough@ | durchgestrichener Text | @\st{…}@ |
| Hochgestellt | @superscript@ | wird via Mathemodus automatisch erstellt | @\textsuperscript{…}@ |
| Tiefgestellt | @subscript@ | wird via Mathemodus automatisch erstellt | @\textsubscript{…}@ |