Projekt

Allgemein

Profil

Formatvorlagen » Historie » Revision 34

Revision 33 (Martin Kraetke, 21.12.2021 15:07) → Revision 34/82 (Martin Kraetke, 21.12.2021 15:12)

h1. Formatvorlagen 

 h2. Präfix 

 Alle Formatvorlagennamen enthalten ein Präfix, welches den Verlag repräsentiert und mit einem Unterstrich 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 Standard-Formatvorlagen für Überschriften von Word werden auch ausgewertet, wobei @Überschrift 1@ der Formatvorlage @heading_part@, @Überschrift 2@ der @heading_1@ entspricht usw. 

 |_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX | 
 | Buchtitel | @book_title@ | Buchtitel |    | @\title{...}@ | 
 |\5=.                                               | 
 | Teil | @heading_part@ | Teil | | @\part{...}@ | 
 |\5=.                                               | 
 | Kapitel | @heading_1@ | Kapitel, Überschrift 1. Ordnung    |    | | 
 | Kapitel-Unterüberschrift | @subheading_1@ | Unterüberschrift für Kapitel/Überschrift 2. Ordnung        | | @\chapter{...}@ | 
 | Kapitel-Autor | @author@ | Autor*in des Kapitels | | @\author{...}@ | 
 | Kapitel-Autorenbeschreibung | @author_description@ | Vita/Beschreibung zu Autor*in des Kapitels | | @\authorbio@ | 
 | Kapitel-Motto | @motto@, @epigraph@ | Motto zum Kapitelbeginn    | | @\chapterquote{...}@ | 
 | Kapitel-Motto-Quelle | @motto_source@, @epigraph_source@ | Quelle/Autor*in des Mottos |     |    | 
 |\5=.                                               | 
 | Abschnitt 1. Ebene | @heading_2@ | | | @\section{...}@ | 
 | Abschnitt 1. Ebene Unterüberschrift | @subheading_2@ | Unterüberschrift | | | 
 | Abschnitt Motto | @motto@ | Motto zu Beginn des Abschnitts |    | @\secquote{...}@ | 
 |\5=.                                               | 
 | Abschnitt 2. Ebene | @heading_3@ |    | | @\subsection{...}@ | 
 | Abschnitt 2. Ebene Unterüberschrift    | @subheading_3@ | Unterüberschrift | | | 
 |\5=.                                               | 
 | Abschnitt 3. Ebene | @heading_4@ | | | @\subsubsection{...}@ | 
 | Abschnitt 3. Ebene Unterüberschrift    | @subheading_4@ | Unterüberschrift | |    | 
 |\5=.                                               | 
 | Abschnitt 4. Ebene | @heading_5@ | | | @\paragraph{...}@ | 
 | Abschnitt 4. Ebene Unterüberschrift    | @subheading_5@ | Unterüberschrift | |    | 
 |\5=.                                               | 
 | Spitzmarke | @headword@ | Zwischenüberschrift, erscheint nicht im IVZ | | @\subparagraph{...}@ | 

 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 Beschreibung|_. XML |_. TeX | 
 | Kolumnentitel links | @headline_left@ | Überschreibung des automatisch erstellten linken Kolumnentitel |    | @def\partmarkoverride{Wert}@ | 
 | Kolumnentitel rechts | @headline_right@ | Überschreibung des automatisch erstellten rechten Kolumnentitel | | @\chaptermark{Wert}@ | 

 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|_. XML |_. TeX | 
 | Abbildung | @figure@ | Bild |    | @\begin{figure}[h!] 
 \includegraphics{image.jpg} 
 \end{figure}@ | 
 | Abbildung Layout A | @figure_A${Zahl}@ | Abbildung auf Satzbreite mit ${Zahl} von 1-3 Bildern nebeneinander    |        |    | 
 | Abbildung Layout B | @figure_B${Zahl}@ | Abbildung mit Abstand und ${Zahl} von 1-3 Bildern nebeneinander    |    |    | 
 | Abbildung Layout C | @figure_C${Zahl}@ | Abbildung mit mehr Abstand und ${Zahl} von 1-3 Bildern nebeneinander          |    |    | 
 |\5=.                                               | 
 | Legende | @figure_caption@ | Legende bzw. Beschreibung des Bildes |     | @\caption{...}@ | 
 | Quelle | @figure_source@ | Quelle des Bildes |    | @\capsource{...}@ | 

 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 Beschreibung|_. XML |_. TeX | 
 | Legende | @table_caption@ | Legende bzw. Beschreibung der Tabelle |    |  
    | 
 | Quelle | @table_source@ | Quelle der Tabelle |    |   
    | 
 | Quelle | @table_rotated@ | muss in dem Absatz vor der zu drehenden Tabelle stehen |    |   
    | 
 | Quelle | @table_pagewrap@ | muss in dem Absatz vor der zu auf mehrere Seiten zu umbrechenden Tabelle stehen (Tabellenkopf wird wiederholt) |    |   

    | 

 h3. Listen 

 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. 

 |_. Bezeichnung |_. Name |_. Beschreibung Beschreibung|_. XML |_. TeX | 
 | Zitat | @abbreviations@ | Beschreibungsliste|    | @\begin{description} \item[begriff] ... \end{description}@    | 

 h3. Langzitat 

 Mehrere unmittelbar aufeinanderfolgende Absätze mit der Langzitat-Formatvorlage werden in eine Langzitat-Umgebung zusammengefasst. 

 |_. Bezeichnung |_. Name |_. Beschreibung Beschreibung|_. XML |_. TeX | 
 | Zitat | @quotation@ | Zitat-Absatz |    | @\begin{quotation}...\end{quotation}@    | 

 h3. Dialoge 

 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. 

 |_. Bezeichnung |_. Name |_. Beschreibung Beschreibung|_. XML |_. TeX | 
 | Dialog | @dialogue@ | Dialog-Absatz |        | @\begin{dialogue}...\end{dialogue}@    | 
 | Sprecher*in |    | Sprecher*in |    | @\item[speaker] ...@    | 

 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|_. XML |_. TeX | 
 | Kasten mit Rahmen Beginn | @box_border_start@ | transparenter Kasten mit Rahmen Beginn |    | @\begin{kastenlinie}...@    | 
 | Kasten mit Rahmen Ende | @box_border_end@ | transparenter Kasten mit Rahmen Ende |    | @...\end{kastenlinie}@    | 
 | Kasten schattiert Beginn | @box_grey_start@ | Kasten mit grauer Hinterlegung Beginn |    | @\begin{kastengrau}...@    | 
 | Kasten schattiert Ende | @box_grey_end@ | Kasten mit grauer Hinterlegung Ende |    | @...\end{kastengrau}@    | 

 h3. Formeln 

 |_. Bezeichnung |_. Name |_. Beschreibung    Beschreibung|_. XML |_. TeX | 
 | Formelabsatz | @formula@ | Absatz, der Formel enthält |    | @\begin{equation}...\end{equation}@    | 

 h3. Widmung 

 |_. Bezeichnung |_. Name |_. Beschreibung Beschreibung|_. XML |_. TeX | 
 | Widmung | @dedication@ | Widmung |    | @\dedication@    | 

 h3. Brief 

 |_. Bezeichnung |_. Name |_. Beschreibung Beschreibung|_. XML |_. TeX | 
 | Briefabsatz | @letter@ | Absatz eines Briefes |    | @\begin{letter}...\end{letter}@    | 
 | 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. 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. 

 |_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. 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 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. 

 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 

 |_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX | 
 | Registerüberschrift | @index_heading@ | Überschrift des Registers |     | 
 | Indexeintrag, siehe (2) | @index_mark@ | Zeichenformat zur Kodierung von Indexeinträgen |    | | 
 | 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 Index-Suchbegriff separat auszuzeichnen, z.B. kann bei _Max Mustermann_ das _Mustermann_ ausgezeichnet werden, damit auch bei _Herr Mustermann_ Indexeintrag erstellt wird |    | | 
 | Indexeintrag, siehe (4) | @index_static@ | Statischer Indexeintrag. 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. 

 |_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. 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@. 

 |_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. TeX | 
 | Zeilenumbruch | @lineskip@ |    |    | @\vskip 1\baselineskip@    | 

 h3. Zeichenformate 

 |_. Bezeichnung |_. Name |_. Beschreibung|_. XML |_. 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 |    |    @$^{}$@ | 
 | Tiefgestellt | @subscript@ | wird via Mathmode automatisch erstellt |    |    @$_{}$@ |