Projekt

Allgemein

Profil

Überschriften » Historie » Version 8

Patrick Schulz, 01.07.2021 11:43
Bitte erst global umsetzen, wenn das common-Framework in den Master-Branch gemergt ist!

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
  \tpTRunTitle{…}
21
  \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 1 Patrick Schulz
37
In jedem Makro kann @\TitleBreak@ verwendet werden, was einen Zeilenumbruch an der Stelle erzeugt.
38 8 Patrick Schulz
39
h2. Overrides für Inhaltsverzeichnisse und Kolumnentitel
40
41
*Zu den Makros @\tp<Makro>@ mit @<Makro> := (Author|Number|Subtitle|Title)@ gibt es je zwei Overrides: @\tpRun<Makro>@ und @\tpToc<Makro>@. 
42
** Fehlt das Override, wird der Inhalt von @\tp<Makro>@ für Kolumnentitel bzw. IHV-Eintrag verwendet.
43
** Ist @\tp(Run|Toc)<Makro>{<Text>}@ gesetzt, wird @<text>@ statt der Inhalt von @\tp<Makro>@ verwendet.
44
** Ist @\tp(Run|Toc)<Makro>{}@ gesetzt (also mit leerem Argument!), wird die Ausgabe des <Makro> in Kolumnentitel/IHV unterdrückt.
45
46
Beispiel:
47
<pre>
48
\begin{heading}{chapter}
49
  \tpTitle{Ein Text}
50
  \tpAuthor{Max Musterfrau}
51
  \tpTocAuthor{Max Mustertransfrau}
52
  \tpRunTitle{Ein Alternativtext}
53
  \tpRunAuthor{}
54
\end{heading}
55
</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.