Projekt

Allgemein

Profil

Überschriften » Historie » Version 19

Patrick Schulz, 11.05.2022 12:49

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 17 Martin Kraetke
  %% Eigentliche Überschrift:
8 8 Patrick Schulz
  \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 17 Martin Kraetke
* @<level>@ ist der Name der Überschrift-Ebene, z.B. chapter, section, subsubsection…
28
* @<opt>@ optionale Parameter für einzelne Überschriften. Wenn es keine gibt, eckige Klammern weglassen!
29
** @notoc@: Überschrift erzeugt keinen Eintrag im IHV
30 18 Maren Pufe
** @noBM@: Überschrift erzeugt keinen Bookmark-Eintrag
31 8 Patrick Schulz
* Notwendig ist nur @\tpTitle{}@; der Rest optional
32
* @\tpAuthor{}@ ist der Abschnitts-/Kapitelautor
33
* @\tpSubtitle{}@ ist der Untertitel
34 17 Martin Kraetke
* @\tpNumber{}@ ist der Überschrift-Zähler samt Präfix (z.B. "Kapitel 2", "2.1.2.3", "Anhang A", etc.)
35 8 Patrick Schulz
* @\tpQuote{}@ ist ein Zitat
36
* @\tpQuoteSource{}@ die Quelle dazu
37 17 Martin Kraetke
* Mit v0.100 können Überschriften auch automatisiert gezählt werden. Ist @\tpNumber@ gesetzt, wird die interne Zählung überschrieben und das automatische Weiterzählen für diese Überschrift ausgesetzt.
38 1 Patrick Schulz
39 12 Patrick Schulz
40 17 Martin Kraetke
Spezielle Überschriften haben weitere Datenfelder:
41 12 Patrick Schulz
* @\tpAbstract{}@ Abstract
42 17 Martin Kraetke
* @\tpAbstractTitle{}@ Überschrift des Abstracts, default: “Abstract”
43 12 Patrick Schulz
* @\tpKeywords{}@ Schlagworte
44
* @\tpKeywordsTitle{}@ Überschrift für die Schlagworte, default: “Keywords”
45
* @\tpDOI{}@ DOI
46
* @\tpDOITitle{}@ Titel für die DOI Angabe, default: <leer>.
47
48 17 Martin Kraetke
Diese "speziellen Überschriften" 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@.
49 12 Patrick Schulz
50
51 19 Patrick Schulz
In jedem Makro kann @\tpBreak@ verwendet werden, um einen Zeilenumbruch an der Stelle zu erzwingen.
52 8 Patrick Schulz
53 14 Patrick Schulz
h2. Overrides für Inhaltsverzeichnisse, Kolumnentitel und PDF-Bookmarks
54 8 Patrick Schulz
55 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). 
56 15 Patrick Schulz
** Fehlt das Overridefür Kolumnentitel bzw. IHV, wird der Inhalt von @\tp<Makro>@ für Kolumnentitel bzw. IHV-Eintrag verwendet.
57 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>@.
58
** Ist @\tp(Run|Toc|BM)<Makro>{<Text>}@ gesetzt, wird @<text>@ statt der Inhalt von @\tp(Toc)<Makro>@ verwendet.
59
** Ist @\tp(Run|Toc|BM)<Makro>{}@ gesetzt (also mit leerem Argument!), wird die Ausgabe des <Makro> in Kolumnentitel/IHV/Bookmarks komplett unterdrückt.
60 8 Patrick Schulz
61 16 Patrick Schulz
*Beispiel:*
62 8 Patrick Schulz
<pre>
63
\begin{heading}{chapter}
64
  \tpTitle{Ein Text}
65
  \tpAuthor{Max Musterfrau}
66
  \tpTocAuthor{Max Mustertransfrau}
67
  \tpRunTitle{Ein Alternativtext}
68
  \tpRunAuthor{}
69
\end{heading}
70 17 Martin Kraetke
</pre>würde als Überschrift<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.
71 16 Patrick Schulz
72
73
h3. *Wichtige Anmerkung zu den PDF-Bookmarks*
74
75 17 Martin Kraetke
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 enthalten sind! Wenn in der Überschrift also tex-Markup (Mathe, foreignlanguage, aber auch Auszeichnungen wie @\textit@, etc.) enthalten ist, IMMER die BM-Overrides verwenden und dort nur reinen Text reinschreiben.
76 11 Martin Kraetke
77
h2. Abbildungsverzeichnis und Tabellenverzeichnis
78
79
Diese beiden Verzeichnisse werden entsprechend der Hierarchiestufe als normale Heading ausgezeichnet und dann das Makro zum Erzeugen des Verzeichnisses ausgegeben.
80
81
<pre>
82
\begin{heading}{section}
83
\tpTitle{Abbildungsverzeichnis}
84
\tpTocTitle{Abbildungsverzeichnis}
85
\tpRunTitle{Frische Früchte, kaputte Körper}
86
\end{heading}
87
88
\listoffigures % oder \listoftables
89
</pre>