xerif

Wiki »

Überschriften » Historie » Revision 8

Revision 7 (Patrick Schulz, 26.04.2021 11:41) → Revision 8/25 (Patrick Schulz, 01.07.2021 11:43)

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: \title{…} 
   \tpTitle{…} \author{…} 
   \tpAuthor{…} \subtitle{…} 
   \tpSubtitle{…} \number{…} 
   \tpNumber{…} \toctitle{…} 
   \tpQuote{…} \tocauthor{…} 
   \tpQuoteSource{…} \runtitle{…} 
   %% Overrides für ToC-Entries: \quote{…} 
   \tpTocTitle{…} 
   \tpTocAuthor{…} 
   \tpTocSubtitle{…} 
   \tpTocNumber{…} 
   %% Overrides für Kolumnentitel: 
   \tpTRunTitle{…} 
   \tpRunAuthor{…} 
   \tpRunSubtitle{…} 
   \tpRunNumber{…} \quotesource{…} 
 \end{heading} 
 </code></pre> 

 * @<level>@ ist der Name der die Ü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 
 ** @notocnumber@: Unterdrückt Ausgabe der ÜS-Nummerierung im IHV 
 * Notwendig ist nur @\tpTitle{}@; @\title{}@; der Rest optional 
 * @\tpAuthor{}@ @\author{}@ ist der Abschnitts-/Kapitelautor 
 * @\tpSubtitle{}@ @\subtitle{}@ ist der Untertitel 
 * @\tpNumber{}@ @\number{}@ ist der ÜS-Zähler samt Präfix (z.B. "Kapitel 2", "2.1.2.3", "Anhang A", etc.) 
 * @\tpQuote{}@ @\runtitle{}@ Ausgabe der ÜS im Kolumnentitel. 
 ** Achtung: *Ob* die ÜS im Kolumnentitel erscheint, wird nach Verlagsvorgaben *styleseitig* festgelegt! Mit diesem Parameter lässt sich nur die Ausgabe überschreiben *falls* die ÜS in den Kolumnentitel geschrieben wird.  
 ** Fehlt die Angabe und die ÜS-Ebene erscheint im Koltitel, wird sie, je nach Style-Vorgaben, aus \title, \number und Autor zusammen gesetzt.  
 ** Wenn @\runtitle@ verwendet wird, wird der Kolumentitel genau so ausgegeben, wie er im Argument steht; es wird nichts automatisch ergänzt!  
 ** Wenn @\runtitle@ eine ÜS-Nummerierung enthält, so muss diese mittels @\protect\numberline{}@ ausgezeichnet werden. 
 ** Nach @\numberline{}@ niemals ein Whitespace! Abstände zwischen Zähler und Titel kommen aus dem Style. 
 * @\toctitle{}@ ist ein der Eintrag im IHV. fehlt dieser, wird, je nach style-Vorgaben, der IHV-Eintrag aus \title, \number, \author, etc. zusammen gesetzt. 
 ** Wie bei @\runtitle@ wird auch hier nichts generiert;  
 ** ÜS-Zähler müssen bei Bedarf konverterseitig via @\protect\numberline{}@ gesetzt werden. 
 * @\tocauthor{}@ Wenn laut style der Autorenname im IHV ausgegeben wird, kann dieser hiermit überschrieben werden 
 * @\quote{}@ Zitat unter ÜS 
 * @\tpQuoteSource{}@ @\quotesource{}@ Quelle des Zitats. Wird nur ausgewertet, wenn @\quote{}@ nicht leer ist / nicht fehlt. 
 * die Quelle dazu heading-Umgebung beinhaltet nur die Überschrift und das, was unmittelbar dazughegört. Alles, was Text ist (also bspw. der Inhalt einer section), muss hinter die Umgebung 

 In jedem Makro kann @\TitleBreak@ verwendet werden, was einen Zeilenumbruch an der Stelle erzeugt. 

 h2. Overrides für Inhaltsverzeichnisse und Kolumnentitel 

 *Zu den Makros @\tp<Makro>@ mit @<Makro> := (Author|Number|Subtitle|Title)@ gibt es je zwei Overrides: @\tpRun<Makro>@ und @\tpToc<Makro>@.  
 ** Fehlt das Override, wird der Inhalt von @\tp<Makro>@ für Kolumnentitel bzw. IHV-Eintrag verwendet. 
 ** Ist @\tp(Run|Toc)<Makro>{<Text>}@ gesetzt, wird @<text>@ statt der Inhalt von @\tp<Makro>@ verwendet. 
 ** Ist @\tp(Run|Toc)<Makro>{}@ gesetzt (also mit leerem Argument!), wird die Ausgabe des <Makro> in 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.