Überschriften » Historie » Revision 14
Revision 13 (Maren Pufe, 17.09.2021 07:26) → Revision 14/25 (Patrick Schulz, 08.10.2021 13:26)
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 Ü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 ÜS-Ebene, z.B. chapter, section, subsubsection…
* @<opt>@ optionale Parameter für einzelne ÜSen. Wenn es keine gibt, eckige Klammern weglassen!
** @notoc@: Ü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 Ü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 ÜSen auch automatisiert gezählt werden. Ist @\tpNumber@ gesetzt, wird die interne Zählung überschrieben und das automatische Weiterzählen für diese ÜS ausgesetzt.
Spezielle ÜSen haben weitere Datenfelder:
* @\tpAbstract{}@ Abstract
* @\tpAbstractTitle{}@ Ü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 Ü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, Inhaltsverzeichnisse und Kolumnentitel und PDF-Bookmarks
*Zu den Makros @\tp<Makro>@ mit @<Makro> := (Author|Number|Subtitle|Title)@ gibt es je drei zwei Overrides: @\tpRun<Makro>@ (für Kolumnen), @\tpToc<Makro>@ (für IHV), und @\tpBM<Makro>@ (für Bookmarks). @\tpToc<Makro>@.
** Fehlt das Override, 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>}@ @\tp(Run|Toc)<Makro>{<Text>}@ gesetzt, wird @<text>@ statt der Inhalt von @\tp(Toc)<Makro>@ @\tp<Makro>@ verwendet.
** Ist @\tp(Run|Toc|BM)<Makro>{}@ @\tp(Run|Toc)<Makro>{}@ gesetzt (also mit leerem Argument!), wird die Ausgabe des <Makro> in Kolumnentitel/IHV/Bookmarks komplett Kolumnentitel/IHV 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 Ü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.
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>