Projekt

Allgemein

Profil

Überschriften » Historie » Version 16

Patrick Schulz, 08.10.2021 13:34

1 1 Patrick Schulz
h1. Überschriften
2
3 3 Patrick Schulz
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)
4 2 Patrick Schulz
5 1 Patrick Schulz
<pre><code class="text">
6
\begin{heading}[<opt>]{<level>}
7 8 Patrick Schulz
  %% Eigentliche ÜS:
8
  \tpTitle{…}
9
  \tpAuthor{…}
10
  \tpSubtitle{…}
11
  \tpNumber{…}
12
  \tpQuote{…}
13
  \tpQuoteSource{…}
14
  %% Overrides für ToC-Entries:
15
  \tpTocTitle{…}
16
  \tpTocAuthor{…}
17
  \tpTocSubtitle{…}
18
  \tpTocNumber{…}
19
  %% Overrides für Kolumnentitel:
20 13 Maren Pufe
  \tpRunTitle{…}
21 8 Patrick Schulz
  \tpRunAuthor{…}
22
  \tpRunSubtitle{…}
23
  \tpRunNumber{…}
24 1 Patrick Schulz
\end{heading}
25
</code></pre>
26
27 8 Patrick Schulz
* @<level>@ ist der Name der ÜS-Ebene, z.B. chapter, section, subsubsection…
28 1 Patrick Schulz
* @<opt>@ optionale Parameter für einzelne ÜSen. Wenn es keine gibt, eckige Klammern weglassen!
29
** @notoc@: ÜS erzeugt keinen Eintrag im IHV
30 8 Patrick Schulz
* Notwendig ist nur @\tpTitle{}@; der Rest optional
31
* @\tpAuthor{}@ ist der Abschnitts-/Kapitelautor
32
* @\tpSubtitle{}@ ist der Untertitel
33
* @\tpNumber{}@ ist der ÜS-Zähler samt Präfix (z.B. "Kapitel 2", "2.1.2.3", "Anhang A", etc.)
34
* @\tpQuote{}@ ist ein Zitat
35
* @\tpQuoteSource{}@ die Quelle dazu
36 10 Patrick Schulz
* 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.
37 1 Patrick Schulz
38 12 Patrick Schulz
39
Spezielle ÜSen haben weitere Datenfelder:
40
* @\tpAbstract{}@ Abstract
41
* @\tpAbstractTitle{}@ ÜS des Abstracts, default: “Abstract”
42
* @\tpKeywords{}@ Schlagworte
43
* @\tpKeywordsTitle{}@ Überschrift für die Schlagworte, default: “Keywords”
44
* @\tpDOI{}@ DOI
45
* @\tpDOITitle{}@ Titel für die DOI Angabe, default: <leer>.
46
47
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@.
48
49
50 1 Patrick Schulz
In jedem Makro kann @\TitleBreak@ verwendet werden, was einen Zeilenumbruch an der Stelle erzeugt.
51 8 Patrick Schulz
52 14 Patrick Schulz
h2. Overrides für Inhaltsverzeichnisse, Kolumnentitel und PDF-Bookmarks
53 8 Patrick Schulz
54 14 Patrick Schulz
*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). 
55 15 Patrick Schulz
** Fehlt das Overridefür Kolumnentitel bzw. IHV, wird der Inhalt von @\tp<Makro>@ für Kolumnentitel bzw. IHV-Eintrag verwendet.
56 14 Patrick Schulz
** Fehlt das Override für die Bookmarks, wird der Inhalt von @\tpToc<Makro>@ verwendet; gibt es die auch nicht, dann die von @\tp<Macro>@.
57
** Ist @\tp(Run|Toc|BM)<Makro>{<Text>}@ gesetzt, wird @<text>@ statt der Inhalt von @\tp(Toc)<Makro>@ verwendet.
58
** Ist @\tp(Run|Toc|BM)<Makro>{}@ gesetzt (also mit leerem Argument!), wird die Ausgabe des <Makro> in Kolumnentitel/IHV/Bookmarks komplett unterdrückt.
59 8 Patrick Schulz
60 16 Patrick Schulz
*Beispiel:*
61 8 Patrick Schulz
<pre>
62
\begin{heading}{chapter}
63
  \tpTitle{Ein Text}
64
  \tpAuthor{Max Musterfrau}
65
  \tpTocAuthor{Max Mustertransfrau}
66
  \tpRunTitle{Ein Alternativtext}
67
  \tpRunAuthor{}
68
\end{heading}
69 1 Patrick Schulz
</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.
70 16 Patrick Schulz
71
72
h3. *Wichtige Anmerkung zu den PDF-Bookmarks*
73
74
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 ÜS enthalten sind! Wenn in der Ü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.
75 11 Martin Kraetke
76
h2. Abbildungsverzeichnis und Tabellenverzeichnis
77
78
Diese beiden Verzeichnisse werden entsprechend der Hierarchiestufe als normale Heading ausgezeichnet und dann das Makro zum Erzeugen des Verzeichnisses ausgegeben.
79
80
<pre>
81
\begin{heading}{section}
82
\tpTitle{Abbildungsverzeichnis}
83
\tpTocTitle{Abbildungsverzeichnis}
84
\tpRunTitle{Frische Früchte, kaputte Körper}
85
\end{heading}
86
87
\listoffigures % oder \listoftables
88
</pre>