Überschriften » Historie » Revision 17
Revision 16 (Patrick Schulz, 08.10.2021 13:34) → Revision 17/25 (Martin Kraetke, 22.12.2021 15:27)
h1. Überschriften
h2. Überschriften im *transpect-tex Common Framework* ("transpect-headings.dtx":https://gitlab.le-tex.de/transpect-tex/transpect-tex/-/blob/master/src/transpect-headings.dtx)
<pre><code class="text">
\begin{heading}[<opt>]{<level>}
%% Eigentliche Überschrift: ÜS:
\tpTitle{…}
\tpAuthor{…}
\tpSubtitle{…}
\tpNumber{…}
\tpQuote{…}
\tpQuoteSource{…}
%% Overrides für ToC-Entries:
\tpTocTitle{…}
\tpTocAuthor{…}
\tpTocSubtitle{…}
\tpTocNumber{…}
%% Overrides für Kolumnentitel:
\tpRunTitle{…}
\tpRunAuthor{…}
\tpRunSubtitle{…}
\tpRunNumber{…}
\end{heading}
</code></pre>
* @<level>@ ist der Name der Überschrift-Ebene, ÜS-Ebene, z.B. chapter, section, subsubsection…
* @<opt>@ optionale Parameter für einzelne Überschriften. ÜSen. Wenn es keine gibt, eckige Klammern weglassen!
** @notoc@: Überschrift ÜS erzeugt keinen Eintrag im IHV
* Notwendig ist nur @\tpTitle{}@; der Rest optional
* @\tpAuthor{}@ ist der Abschnitts-/Kapitelautor
* @\tpSubtitle{}@ ist der Untertitel
* @\tpNumber{}@ ist der Überschrift-Zähler ÜS-Zähler samt Präfix (z.B. "Kapitel 2", "2.1.2.3", "Anhang A", etc.)
* @\tpQuote{}@ ist ein Zitat
* @\tpQuoteSource{}@ die Quelle dazu
* Mit v0.100 können Überschriften ÜSen auch automatisiert gezählt werden. Ist @\tpNumber@ gesetzt, wird die interne Zählung überschrieben und das automatische Weiterzählen für diese Überschrift ÜS ausgesetzt.
Spezielle Überschriften ÜSen haben weitere Datenfelder:
* @\tpAbstract{}@ Abstract
* @\tpAbstractTitle{}@ Überschrift ÜS des Abstracts, default: “Abstract”
* @\tpKeywords{}@ Schlagworte
* @\tpKeywordsTitle{}@ Überschrift für die Schlagworte, default: “Keywords”
* @\tpDOI{}@ DOI
* @\tpDOITitle{}@ Titel für die DOI Angabe, default: <leer>.
Diese "speziellen Überschriften" ÜSen" können von Projekt zu Projekt unterschiedlich heißen, qua Konvention heißt die Ebene aber i.d.R. @contribution@ und erbt ihre sonstigen Merkmale von @chapter@.
In jedem Makro kann @\TitleBreak@ verwendet werden, was einen Zeilenumbruch an der Stelle erzeugt.
h2. Overrides für Inhaltsverzeichnisse, Kolumnentitel und PDF-Bookmarks
*Zu den Makros @\tp<Makro>@ mit @<Makro> := (Author|Number|Subtitle|Title)@ gibt es je drei Overrides: @\tpRun<Makro>@ (für Kolumnen), @\tpToc<Makro>@ (für IHV), und @\tpBM<Makro>@ (für Bookmarks).
** Fehlt das Overridefür Kolumnentitel bzw. IHV, wird der Inhalt von @\tp<Makro>@ für Kolumnentitel bzw. IHV-Eintrag verwendet.
** Fehlt das Override für die Bookmarks, wird der Inhalt von @\tpToc<Makro>@ verwendet; gibt es die auch nicht, dann die von @\tp<Macro>@.
** Ist @\tp(Run|Toc|BM)<Makro>{<Text>}@ gesetzt, wird @<text>@ statt der Inhalt von @\tp(Toc)<Makro>@ verwendet.
** Ist @\tp(Run|Toc|BM)<Makro>{}@ gesetzt (also mit leerem Argument!), wird die Ausgabe des <Makro> in Kolumnentitel/IHV/Bookmarks komplett unterdrückt.
*Beispiel:*
<pre>
\begin{heading}{chapter}
\tpTitle{Ein Text}
\tpAuthor{Max Musterfrau}
\tpTocAuthor{Max Mustertransfrau}
\tpRunTitle{Ein Alternativtext}
\tpRunAuthor{}
\end{heading}
</pre>würde als Überschrift<pre>Max ÜS<pre>Max Musterfrau: Ein Text</pre> erzeugen. Als Toc-Eintrag würde<pre>Max Mustertransfrau: Ein Text</pre>ausgegeben, it dem Override für den Autorennamen. Als Kolumnentitel würde dann<pre>Ein Alternativtext</pre> ausgegeben. Der Autorenname wird im Kol-Titel unterdrückt, weil das Argument von @\tpRunAuthor@ in dem Fall leer ist.
h3. *Wichtige Anmerkung zu den PDF-Bookmarks*
In dem, was in den *Bookmarks* landet, darf *kein LaTeX-Markup* enthalten sein, da diese Inhalte 1:1 in den PDF-Code geschrieben werden! Sind Makros in einer Überschrift enthalten, wirft pdftex Fehler bei der PDF-Erzeugung aus und ignoriert die Makros, lässt ggf. aber Argumente dieser Makros stehen, z.B. @\foreignlanguage{english}{text}@ würde als Bookmark @"englishtext"@ erzeugen! Besonders kritisch ist dies, wenn Formeln in der Überschrift ÜS enthalten sind! Wenn in der Überschrift ÜS also tex-Markup (Mathe, foreignlanguage, aber auch Auszeichnungen wie @\textit@, etc.) enthalten ist, IMMER die BM-Overrides verwenden und dort nur reinen Text reinschreiben.
h2. Abbildungsverzeichnis und Tabellenverzeichnis
Diese beiden Verzeichnisse werden entsprechend der Hierarchiestufe als normale Heading ausgezeichnet und dann das Makro zum Erzeugen des Verzeichnisses ausgegeben.
<pre>
\begin{heading}{section}
\tpTitle{Abbildungsverzeichnis}
\tpTocTitle{Abbildungsverzeichnis}
\tpRunTitle{Frische Früchte, kaputte Körper}
\end{heading}
\listoffigures % oder \listoftables
</pre>