diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbookreportarticle-experts.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbookreportarticle-experts.tex | 893 |
1 files changed, 416 insertions, 477 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbookreportarticle-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbookreportarticle-experts.tex index 2123ff47c17..0b7d34490f6 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbookreportarticle-experts.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbookreportarticle-experts.tex @@ -1,6 +1,6 @@ % ====================================================================== % scrbookreportarticle-experts.tex -% Copyright (c) Markus Kohm, 2001-2016 +% Copyright (c) Markus Kohm, 2001-2017 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % scrbookreportarticle-experts.tex -% Copyright (c) Markus Kohm, 2001-2016 +% Copyright (c) Markus Kohm, 2001-2017 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -48,7 +48,7 @@ % ============================================================================ \KOMAProvidesFile{scrbookreportarticle-experts.tex}% - [$Date: 2016-06-14 09:45:01 +0200 (Tue, 14 Jun 2016) $ + [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $ KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl for experts)] @@ -60,6 +60,11 @@ Paket \Package{scrextend}} \labelbase{maincls-experts} +\BeginIndexGroup +\BeginIndex{Class}{scrartcl} +\BeginIndex{Class}{scrbook} +\BeginIndex{Class}{scrreprt} +\BeginIndex{Package}{scrextend} In diesem Kapitel finden Sie zusätzliche Informationen zu den \KOMAScript-Klassen \Class{scrbook}, \Class{scrreprt} und \Class{scrartcl} und einigen Anweisungen, die auch in \Package{scrextend} vorhanden sind. @@ -104,11 +109,9 @@ gedacht sind, sind sie kürzer gefasst. % \seclabel{identification} \begin{Declaration} - \Macro{KOMAClassName}\\ + \Macro{KOMAClassName} \Macro{ClassName} \end{Declaration} -\BeginIndex{Cmd}{KOMAClassName}% -\BeginIndex{Cmd}{ClassName}% In \Macro{KOMAClassName} ist der Name der aktuell verwendeten \KOMAScript-Klasse abgelegt. Will man also wissen, ob eine oder welche \KOMAScript-Klasse verwendet wird, so kann man einfach auf diese Anweisung @@ -116,22 +119,22 @@ testen. Demgegenüber gibt \Macro{ClassName} Auskunft, welche Standardklasse durch diese \KOMAScript-Klasse ersetzt wird. Es\textnote{Achtung!} sei in diesem Zusammenhang darauf hingewiesen, dass -demgegenüber die Existenz von \Macro{KOMAScript}\IndexCmd{KOMAScript} nicht -als Indiz für die Verwendung einer \KOMAScript-Klasse dienen kann. Zum einen -definieren alle \KOMAScript-Pakete diese Anweisung, zum anderen können auch -andere Pakete es für sinnvoll erachten, das \KOMAScript-Piktogramm unter -diesem Namen zu definieren.% -\EndIndex{Cmd}{ClassName}% -\EndIndex{Cmd}{KOMAClassName}% +demgegenüber die Existenz von +\DescRef{scrbase.cmd.KOMAScript}\IndexCmd{KOMAScript} nicht als Indiz für die +Verwendung einer \KOMAScript-Klasse dienen kann. Zum einen definieren alle +\KOMAScript-Pakete diese Anweisung, zum anderen können auch andere Pakete es +für sinnvoll erachten, das \KOMAScript-Piktogramm unter diesem Namen zu +definieren.% +\EndIndexGroup + % \subsection{Einträge ins Inhaltsverzeichnis} % \seclabel{toc} \begin{Declaration} \Macro{addtocentrydefault}\Parameter{Ebene}\Parameter{Nummer}% - \Parameter{Überschrift} + \Parameter{Überschrift} \end{Declaration} -\BeginIndex{Cmd}{addtocentrydefault}% Die\ChangedAt{v3.08}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} \KOMAScript-Klassen verwenden \Macro{addcontentsline}\IndexCmd{addcontentsline}% @@ -154,7 +157,8 @@ soll. In der Voreinstellung wird dies mit \begin{quote}\small\raggedright \Macro{addcontentsline}\PParameter{toc}\Parameter{Ebene}% \PParameter{\%\\ - \quad\Macro{protect}\Macro{nonumberline} \PName{Überschrift}\%\\ + \quad\Macro{protect}\DescRef{tocbasic.cmd.nonumberline} + \PName{Überschrift}\%\\ } \end{quote} erreicht. Ist das Argument jedoch nicht leer, so soll ein nummerierter Eintrag @@ -163,7 +167,7 @@ der Voreinstellung verwendet \KOMAScript{} \begin{quote}\small\raggedright \Macro{addcontentsline}\PParameter{toc}\Parameter{Ebene}% \PParameter{\%\\ - \quad\Macro{protect}\Macro{numberline}\Parameter{Nummer}% + \quad\Macro{protect}\DescRef{tocbasic.cmd.numberline}\Parameter{Nummer}% \PName{Überschrift}\%\\ } \end{quote} @@ -172,7 +176,7 @@ zur Erzeugung dieses Eintrags. Paketautoren und Autoren von Wrapper-Klassen können diese Anweisung umdefinieren, um Einfluss auf die Einträge zu nehmen. So\textnote{Beispiel} wäre beispielsweise denkbar mit -\begin{lstcode}[belowskip=\dp\strutbox plus 1pt] +\begin{lstcode} \renewcommand{\addtocentrydefault}[3]{% \ifstr{#3}{}{% }{% @@ -189,50 +193,37 @@ erst gar nicht vorgenommen werden. Eine solche Änderung ist in der Praxis jedoch nicht notwendig, da die Unterdrückung leerer Einträge bereits auf andere Weise in die \KOMAScript-Klassen eingebaut ist. Siehe hierzu auch die Erklärung zu den Gliederungsbefehlen in \autoref{sec:maincls.structure} ab -\autopageref{desc:maincls.cmd.part}.% +\DescPageRef{maincls.cmd.part}.% % -\EndIndex{Cmd}{addtocentrydefault} +\EndIndexGroup + \begin{Declaration} - \Macro{addparttocentry}\Parameter{Nummer}\Parameter{Überschrift}\\ - \Macro{addchaptertocentry}\Parameter{Nummer}\Parameter{Überschrift}\\ - \Macro{addsectiontocentry}\Parameter{Nummer}\Parameter{Überschrift}\\ - \Macro{addsubsectiontocentry}\Parameter{Nummer}\Parameter{Überschrift}\\ - \Macro{addsubsubsectiontocentry}\Parameter{Nummer}\Parameter{Überschrift}\\ - \Macro{addparagraphtocentry}\Parameter{Nummer}\Parameter{Überschrift}\\ + \Macro{addparttocentry}\Parameter{Nummer}\Parameter{Überschrift} + \Macro{addchaptertocentry}\Parameter{Nummer}\Parameter{Überschrift} + \Macro{addsectiontocentry}\Parameter{Nummer}\Parameter{Überschrift} + \Macro{addsubsectiontocentry}\Parameter{Nummer}\Parameter{Überschrift} + \Macro{addsubsubsectiontocentry}\Parameter{Nummer}\Parameter{Überschrift} + \Macro{addparagraphtocentry}\Parameter{Nummer}\Parameter{Überschrift} \Macro{addsubparagraphtocentry}\Parameter{Nummer}\Parameter{Überschrift} \end{Declaration}% -\BeginIndex{Cmd}{addparttocentry}% -\BeginIndex{Cmd}{addchaptertocentry}% -\BeginIndex{Cmd}{addsectiontocentry}% -\BeginIndex{Cmd}{addsubsectiontocentry}% -\BeginIndex{Cmd}{addsubsubsectiontocentry}% -\BeginIndex{Cmd}{addparagraphtocentry}% -\BeginIndex{Cmd}{addsubparagraphtocentry}% Auch \ChangedAt{v3.08}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} die oben dokumentierte Anweisung -\Macro{addtocentrydefault}\IndexCmd{addtocentrydefault}% -\important{\Macro{addtocentrydefault}} wird von den \KOMAScript-Klassen nur -dann direkt aufgerufen, wenn für die angegebene \PName{Ebene} keine direkte -Anweisung definiert oder diese +\DescRef{\LabelBase.cmd.addtocentrydefault}\IndexCmd{addtocentrydefault}% +\important{\DescRef{\LabelBase.cmd.addtocentrydefault}} wird von den +\KOMAScript-Klassen nur dann direkt aufgerufen, wenn für die angegebene +\PName{Ebene} keine direkte Anweisung definiert oder diese \Macro{relax}\IndexCmd{relax}\important{\Macro{relax}} ist. In der Voreinstellung sind die angegebenen Anweisungen alle so definiert, dass sie -ihre \PName{Ebene} und die Argumente direkt an \Macro{addtocentrydefault} -weiter geben.% +ihre \PName{Ebene} und die Argumente direkt an +\DescRef{\LabelBase.cmd.addtocentrydefault} weiter geben.% % -\EndIndex{Cmd}{addsubparagraphtocentry}% -\EndIndex{Cmd}{addsubsubsectiontocentry}% -\EndIndex{Cmd}{addparagraphtocentry}% -\EndIndex{Cmd}{addsubsectiontocentry}% -\EndIndex{Cmd}{addsectiontocentry}% -\EndIndex{Cmd}{addchaptertocentry}% -\EndIndex{Cmd}{addparttocentry}% +\EndIndexGroup \begin{Declaration} \Macro{raggedchapterentry} \end{Declaration} -\BeginIndex{Cmd}{raggedchapterentry}% Bei früheren\ChangedAt{v3.21}{\Class{scrbook}\and \Class{scrreprt}} Version von \KOMAScript{} gab es die Möglichkeit das \Macro{raggedchapterentry} als \Macro{raggedright} zu definieren, um den Text der Kapiteleinträge ins @@ -259,20 +250,18 @@ Ergebnissen. Empfohlen wird, eventuell gewünschten Flattersatz für Verzeichniseinträge stattdessen über die genannte Eigenschaft des Verzeichniseintragsstils \PValue{tocline} zu wählen.% -\EndIndex{Cmd}{raggedchapterentry} +\EndIndexGroup % \subsection{Schrifteinstellungen} % \seclabel{fonts} \begin{Declaration} - \Macro{@fontsizefilebase}\\ + \Macro{@fontsizefilebase} \Macro{changefontsizes}\Parameter{Schriftgröße} \end{Declaration} -\BeginIndex{Cmd}{@fontsizefilebase}% -\BeginIndex{Cmd}{changefontsizes}% Der\iffree{ in \autoref{sec:maincls-experts.addInfos}}{} auf -\autopageref{desc:maincls-experts.option.fontsize} für die +\DescPageRef{maincls-experts.option.fontsize} für die Schriftgrößendateien angegebene Präfix \File{scrsize}, ist lediglich die Voreinstellung für das interne Makro \Macro{@fontsizefilebase}\IndexCmd{@fontsizefilebase}, die verwendet wird, @@ -283,26 +272,25 @@ verwenden. Ebenso\textnote{Tipp!} können Autoren von Wrapper-Klassen die \emph{fallback}-Lösung dadurch ändern oder abschalten, dass sie das Macro \Macro{changefontsizes}\important{\Macro{changefontsizes}}, das als Argument die gewünschte \PName{Schriftgröße} erwartet, umdefinieren.% -\EndIndex{Cmd}{changefontsizes}% -\EndIndex{Cmd}{@fontsizefilebase}% +\EndIndexGroup \begin{Declaration} - \Macro{newkomafont}\OParameter{Warnung}\Parameter{Element}\Parameter{Voreinstellung}\\ + \Macro{newkomafont}\OParameter{Warnung}\Parameter{Element} + \Parameter{Voreinstellung} \Macro{aliaskomafont}\Parameter{Aliasname}\Parameter{Element} \end{Declaration} -\BeginIndex{Cmd}{newkomafont}% -\BeginIndex{Cmd}{aliaskomafont}% Experten können mit \Macro{newkomafont} eine \PName{Voreinstellung} für die Schrift eines \PName{Element}s definieren. Anschließend kann diese -Voreinstellung mit den Anweisungen \Macro{setkomafont} und -\Macro{addtokomafont} (siehe \autoref{sec:maincls.textmarkup}, -\autopageref{desc:maincls.cmd.setkomafont}) verändert werden. Natürlich wird -diese Schrift damit noch lange nicht verwendet. Der Experte muss selbst Sorge -dafür tragen, dass er an den entsprechenden Stellen die Anweisung -\Macro{usekomafont}\important{\Macro{usekomafont}}\IndexCmd{usekomafont} -(siehe \autopageref{desc:maincls.cmd.usekomafont}) für dieses Element in -seinen Definitionen einbaut. +Voreinstellung mit den Anweisungen \DescRef{maincls.cmd.setkomafont} und +\DescRef{maincls.cmd.addtokomafont} (siehe \autoref{sec:maincls.textmarkup}, +\DescPageRef{maincls.cmd.setkomafont}) verändert werden. Natürlich wird diese +Schrift damit noch lange nicht verwendet. Der Experte muss selbst Sorge dafür +tragen, dass er an den entsprechenden Stellen die Anweisung +\DescRef{maincls.cmd.usekomafont}% +\important{\DescRef{maincls.cmd.usekomafont}}\IndexCmd{usekomafont} (siehe +\DescPageRef{maincls.cmd.usekomafont}) für dieses Element in seinen +Definitionen einbaut. Das optionale Argument \PName{Warnung} definiert eine Warnmeldung. Diese wird bei den \KOMAScript-Klassen per \Macro{ClassWarning} oder beim Paket @@ -322,22 +310,19 @@ Benutzerfreundlichkeit erhöht werden, indem einem Element all die Namen als Alias zugeordnet werden, die unterschiedliche Benutzer intuitiv wählen würden. \KOMAScript{} selbst macht von dieser Möglichkeit reichen Gebrauch. % -\EndIndex{Cmd}{aliaskomafont}% -\EndIndex{Cmd}{newkomafont}% +\EndIndexGroup \begin{Declaration} - \Macro{addtokomafontrelaxlist}\Parameter{Makro}\\ + \Macro{addtokomafontrelaxlist}\Parameter{Makro} \Macro{addtokomafontgobblelist}\Parameter{Makro} \end{Declaration} -\BeginIndex{Cmd}{addtokomafontrelaxlist}% -\BeginIndex{Cmd}{addtokomafontgobblelist}% Wie bereits in \autoref{part:forAuthors} der Anleitung erklärt, dürfen in den Schrifteinstellungen der Elemente nur Befehle zur Wahl der Größe, Familie, Codierung, Strichstärke, Form und Farbe enthalten sein. Dabei erfolgt schon die Änderung der Farbe bei \LaTeX{} nicht transparent und kann damit -unerwünschte Effekte hervorrufen, wenn man \Macro{usekomafont} an ungünstiger -Stelle verwendet. +unerwünschte Effekte hervorrufen, wenn man \DescRef{maincls.cmd.usekomafont} +an ungünstiger Stelle verwendet. Nun neigen Anwender dazu, in die Schrifteinstellungen auch ganz andere, teilweise sehr kritische Dinge zu packen, beispielsweise ein @@ -351,24 +336,25 @@ jedoch nicht. In Einzelfällen war es innerhalb von \KOMAScript{} notwendig, die Umschaltung wirklich auf Schrifteinstellungen zu beschränken. Dies erfolgt dann -beispielsweise mit \Macro{usefontofkomafont}\IndexCmd{usefontofkomafont}% +beispielsweise mit +\DescRef{maincls.cmd.usefontofkomafont}\IndexCmd{usefontofkomafont}% \IndexCmd{usesizeofkomafont}\IndexCmd{useencodingofkomafont}% \IndexCmd{usefamilyofkomafont}\IndexCmd{useseriesofkomafont}% -\IndexCmd{useshapeofkomafont} statt \Macro{usekomafont} (siehe +\IndexCmd{useshapeofkomafont} statt \DescRef{maincls.cmd.usekomafont} (siehe \autoref{sec:maincls.textmarkup}, -\autopageref{desc:maincls.cmd.usefontofkomafont}). +\DescPageRef{maincls.cmd.usefontofkomafont}). -Die Anweisung \Macro{usefontofkomafont} und ihre Geschwister haben allerdings -ihre Grenzen. Daher darf die vermeintliche Schrifteinstellung eines Elements -keinesfalls ein voll expandierbares Argument erwarten. Genau das ist aber -beispielsweise bei \Macro{MakeUppercase} der +Die Anweisung \DescRef{maincls.cmd.usefontofkomafont} und ihre Geschwister +haben allerdings ihre Grenzen. Daher darf die vermeintliche Schrifteinstellung +eines Elements keinesfalls ein voll expandierbares Argument erwarten. Genau +das ist aber beispielsweise bei \Macro{MakeUppercase} der Fall. Daher\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}} verwaltet \KOMAScript{} eine interne Liste von Makros, -die innerhalb von \Macro{usefontofkomafont} und ihren Geschwistern zu -\Macro{relax} werden sollen. In der Voreinstellung sind das unter anderem: -\Macro{normalcolor}, \Macro{MakeUppercase} und -\Macro{MakeLowercase}. Weitere Anweisungen können mit -\Macro{addtokomafontrelaxlist} einzeln hinzugefügt werden. + \Class{scrartcl}} verwaltet \KOMAScript{} eine interne Liste von Makros, die +innerhalb von \DescRef{maincls.cmd.usefontofkomafont} und ihren Geschwistern +zu \Macro{relax} werden sollen. In der Voreinstellung sind das unter anderem: +\Macro{normalcolor}, \Macro{MakeUppercase} und \Macro{MakeLowercase}. Weitere +Anweisungen können mit \Macro{addtokomafontrelaxlist} einzeln hinzugefügt +werden. Es ist zu beachten, dass das angegebene \PName{Makro} wirklich stur auf \Macro{relax} gesetzt wird. Irgendwelche Argumente innerhalb der @@ -382,47 +368,46 @@ hinzuzufügen! Soll\ChangedAt{v3.19}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} hingegen ein \PName{Makro} innerhalb -\Macro{usefontofkomafont} und ihren Geschwistern einschließen eines einzelnen -Arguments des Makros ignoriert werden, so ist stattdessen +\DescRef{maincls.cmd.usefontofkomafont} und ihren Geschwistern einschließen +eines einzelnen Arguments des Makros ignoriert werden, so ist stattdessen \Macro{addtokomafontgobblelist} zu verwenden. Ein Beispiel dafür ist die Anweisung \Macro{color}, die einschließlich des Namens der Farbe ignoriert werden muss und deshalb bereits in der Voreinstellung Teil dieser Liste ist.% -\EndIndex{Cmd}{addtokomafontgobblelist}% -\EndIndex{Cmd}{addtokomafontrelaxlist}% +\EndIndexGroup \begin{Declaration} \Macro{IfExistskomafont}\Parameter{Element}\Parameter{Dann-Code}% - \Parameter{Sonst-Code} + \Parameter{Sonst-Code} \end{Declaration} -\BeginIndex{Cmd}{IfExistskomafont}% Da\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}\and \Class{scrlttr2}} die Schrift mancher Elemente erst ab bestimmten Versionen von \KOMAScript{} geändert werden können, ist es manchmal sinnvoll, vorher testen zu können, ob ein \PName{Element} mit dieser Möglichkeit überhaupt existiert. Die Anweisung führt den \PName{Dann-Code} -genau dann aus, wenn das \PName{Element} über \Macro{newkomafont} oder -\Macro{aliaskomafont} definiert wurde und daher auch mit \Macro{setkomafont} -oder \Macro{addtokomafont} geändert und mit den \Macro{use\dots - komafont}-Anweisungen abgefragt werden kann. Anderenfalls wird der -\PName{Sonst-Code} ausgeführt.% -\EndIndex{Cmd}{IfExistskomafont}% +genau dann aus, wenn das \PName{Element} über +\DescRef{\LabelBase.cmd.newkomafont} oder +\DescRef{\LabelBase.cmd.aliaskomafont} definiert wurde und daher auch mit +\DescRef{maincls.cmd.setkomafont} oder \DescRef{maincls.cmd.addtokomafont} +geändert und mit den \Macro{use\dots komafont}-Anweisungen abgefragt werden +kann. Anderenfalls wird der \PName{Sonst-Code} ausgeführt.% +\EndIndexGroup % \subsection{Absatzmarkierung} % \seclabel{parskip} \begin{Declaration} - \Macro{setparsizes}\Parameter{Einzug}\Parameter{Abstand}%^^A - \Parameter{Endzeilenleerraum} + \Macro{setparsizes}\Parameter{Einzug}\Parameter{Abstand} + \Parameter{Endzeilenleerraum} \end{Declaration} -\BeginIndex{Cmd}{setparsizes}% \KOMAScript{} bietet mit dieser Anweisung die Möglichkeit, sowohl den Absatzeinzug, als auch den Absatzabstand und den Freiraum am Ende der letzten Zeile des Absatzes einzustellen. Diese Anweisung ist immer dann zu verwenden, -wenn die Änderungen auch bei Einstellung \OptionValue{parskip}{relative} -beachtet werden sollen. \KOMAScript{}\textnote{Beispiel} selbst verwendet sie -beispielsweise in der Form -\begin{lstcode}[belowskip=\dp\strutbox plus 1ex] +wenn die Änderungen auch bei Einstellung +\OptionValueRef{maincls}{parskip}{relative} beachtet werden +sollen. \KOMAScript{}\textnote{Beispiel} selbst verwendet sie beispielsweise +in der Form +\begin{lstcode} \setparsizes{0pt}{0pt}{0pt plus 1fil} \end{lstcode} um sowohl den Einzug als auch den Abstand abzuschalten und am Ende des @@ -431,7 +416,7 @@ wenn ein Absatz nur aus einer Box besteht, die ohne Abstand nach oben oder unten gesetzt werden soll und die gesamte Spaltenbreite einnimmt. Soll demgegenüber die Box nur die gesamte Breite einnehmen, jedoch mit der aktuellen Einstellung bezüglich des Absatzabstandes gesetzt werden, so ist -\begin{lstcode}[belowskip=\dp\strutbox plus 1ex] +\begin{lstcode} \setlength{\parfillskip}{0pt plus 1fil} \end{lstcode} vorzuziehen. @@ -445,11 +430,12 @@ Werte nicht zwischenzeitlich geändert wurden. Dies sollte ein Grund mehr sein, nicht an \KOMAScript{} vorbei die Einstellungen zu ändern. Die Neuberechnung wird bei einer Kompatibilitätseinstellung zu einer früheren Version (siehe \autoref{sec:maincls.compatibilityOptions}, -\autopageref{desc:maincls.option.version}, Option -\Option{version}\IndexOption{version}\important{\OptionValue{version}{3.17}}) +\DescPageRef{maincls.option.version}, Option +\DescRef{maincls.option.version}% +\IndexOption{version}\important{\OptionValueRef{maincls}{version}{3.17}}) deaktiviert.% % -\EndIndex{Cmd}{setparsizes}% +\EndIndexGroup % \subsection{Zähler} % \seclabel{counter} @@ -460,15 +446,11 @@ deaktiviert.% % \seclabel{sections} \begin{Declaration} - \Macro{DeclareSectionCommand}\OParameter{Einstellungen}\Parameter{Name}\\ - \Macro{DeclareNewSectionCommand}\OParameter{Einstellungen}\Parameter{Name}\\ - \Macro{RedeclareSectionCommand}\OParameter{Einstellungen}\Parameter{Name}\\ + \Macro{DeclareSectionCommand}\OParameter{Einstellungen}\Parameter{Name} + \Macro{DeclareNewSectionCommand}\OParameter{Einstellungen}\Parameter{Name} + \Macro{RedeclareSectionCommand}\OParameter{Einstellungen}\Parameter{Name} \Macro{ProvideSectionCommand}\OParameter{Einstellungen}\Parameter{Name} \end{Declaration} -\BeginIndex{Cmd}{DeclareSectionCommand}% -\BeginIndex{Cmd}{DeclareNewSectionCommand}% -\BeginIndex{Cmd}{RedeclareSectionCommand}% -\BeginIndex{Cmd}{ProvideSectionCommand}% Mit\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} diesen Anweisungen kann ein neuer Gliederungsbefehl \Macro{\PName{Name}} definiert oder der vorhandene Gliederungsbefehl @@ -485,15 +467,15 @@ folgenden Stile zur Verfügung: \Class{scrreprt}}Stil\textnote{Gliederungsstil \PValue{chapter}}\Index{Gliederung>Stil>~\PValue{chapter}} einer Kapitelüberschrift. Dieser Stil wird in der Voreinstellung für - \Macro{chapter}\IndexCmd{chapter} und indirekt für - \Macro{addchap}\IndexCmd{addchap} verwendet. Neue Überschriften in diesem + \DescRef{maincls.cmd.chapter}\IndexCmd{chapter} und indirekt für + \DescRef{maincls.cmd.addchap}\IndexCmd{addchap} verwendet. Neue Überschriften in diesem Stil können definiert werden, haben dann aber nicht automatisch auch eine \Macro{add\dots}-Variante. Für die Konfiguration des vorhandenen oder neuer Überschriften stehen zusätzlich die Eigenschaften aus \autoref{tab:maincls-experts.declarechapterstyle.keys}, \autopageref{tab:maincls-experts.declarechapterstyle.keys} zur - Verfügung. Die\textnote{Achtung!} Anweisung \Macro{addchap} wird ebenso wie - die Sternformen automatisch zusammen mit \Macro{chapter} umkonfiguriert und + Verfügung. Die\textnote{Achtung!} Anweisung \DescRef{maincls.cmd.addchap} wird ebenso wie + die Sternformen automatisch zusammen mit \DescRef{maincls.cmd.chapter} umkonfiguriert und kann nicht unabhängig davon verändert werden. Es ist zu beachten, dass dieser Stil von \Class{scrartcl}\OnlyAt{\Class{scrbook}\and \Class{scrreprt}} nicht bereitgestellt wird. @@ -501,7 +483,7 @@ folgenden Stile zur Verfügung: \Class{scrreprt}\and \Class{scrartcl}}Stil\textnote{Gliederungsstil \PValue{part}}\Index{Gliederung>Stil>~\PValue{part}} einer Teileüberschrift. Dieser Stil wird in der Voreinstellung für - \Macro{part}\IndexCmd{part} und indirekt für + \DescRef{maincls.cmd.part}\IndexCmd{part} und indirekt für \Macro{addpart}\IndexCmd{addpart} verwendet. Neue Überschriften in diesem Stil können definiert werden, haben dann aber nicht automatisch auch eine \Macro{add\dots}-Variante. Für die Konfiguration des vorhandenen oder neuer @@ -509,15 +491,15 @@ folgenden Stile zur Verfügung: \autoref{tab:maincls-experts.declarepartstyle.keys}, \autopageref{tab:maincls-experts.declarepartstyle.keys} zur Verfügung. Die\textnote{Achtung!} Anweisung \Macro{addpart} wird ebenso wie - die Sternformen automatisch zusammen mit \Macro{part} umkonfiguriert und + die Sternformen automatisch zusammen mit \DescRef{maincls.cmd.part} umkonfiguriert und kann nicht unabhängig davon verändert werden. \item[\PValue{section}:] Stil\textnote{Gliederungsstil \PValue{section}}\Index{Gliederung>Stil>~\PValue{section}} einer Abschnittsüberschrift. Dieser Stil wird derzeit für - \Macro{section}\IndexCmd{section}, \Macro{subsection}\IndexCmd{subsection}, - \Macro{subsubsection}\IndexCmd{subsubsection}, - \Macro{paragraph}\IndexCmd{paragraph} und - \Macro{subparagraph}\IndexCmd{subparagraph} verwendet. Neue Überschriften in + \DescRef{maincls.cmd.section}\IndexCmd{section}, \DescRef{maincls.cmd.subsection}\IndexCmd{subsection}, + \DescRef{maincls.cmd.subsubsection}\IndexCmd{subsubsection}, + \DescRef{maincls.cmd.paragraph}\IndexCmd{paragraph} und + \DescRef{maincls.cmd.subparagraph}\IndexCmd{subparagraph} verwendet. Neue Überschriften in diesem Stil können definiert werden. Für die Konfigurierung der vorhandenen oder neuer Überschriften stehen zusätzlich die Eigenschaften aus \autoref{tab:maincls-experts.declaresectionstyle.keys}, @@ -528,12 +510,12 @@ folgenden Stile zur Verfügung: gilt auch, falls ein Befehl, der bisher kein Gliederungsbefehl war, mit \Macro{RedeclareSectionCommand} zu einem Gliederungsbefehl umdefiniert wird. Die\textnote{Achtung!} Anweisung \Macro{addsec} wird ebenso wie die - Sternformen automatisch zusammen mit \Macro{section} umkonfiguriert und kann + Sternformen automatisch zusammen mit \DescRef{maincls.cmd.section} umkonfiguriert und kann nicht unabhängig davon verändert werden. Bei der Definition eines Gliederungsbefehls in diesem Stil wird gleichzeitig ein gleichnamiges - Element angelegt, dessen Schrifteinstellung mit \Macro{setkomafont} und - \Macro{addtokomafont} (siehe \autoref{sec:maincls.textmarkup}, - \autopageref{desc:maincls.cmd.setkomafont}) geändert werden kann, falls ein + Element angelegt, dessen Schrifteinstellung mit \DescRef{maincls.cmd.setkomafont} und + \DescRef{maincls.cmd.addtokomafont} (siehe \autoref{sec:maincls.textmarkup}, + \DescPageRef{maincls.cmd.setkomafont}) geändert werden kann, falls ein solches Element noch nicht existiert. \end{labeling} @@ -546,97 +528,68 @@ folgenden Stile zur Verfügung: \begin{tabularx}{\linewidth}{llX} \toprule \PName{Schlüssel} & \PName{Wert} & Bedeutung \\ - \midrule - \PValue{counterwithin} & \PName{Zählername} & - Der zur Gliederungsebene gehörende - Zähler soll vom als Wert angegebenen - Zähler abhängig sein. Wird - \PName{Zählername} über - \Macro{stepcounter} oder - \Macro{refstepsounter} erhöht, so - wird der zur Gliederungsebene - gehörende Zähler auf 0 - zurückgesetzt. Darüber hinaus wird - \Macro{the\PName{Zählername}} - gefolgt von einem Punkt in - der Ausgabe des zur Gliederungsebene - gehörenden Zählers vorangestellt.\\ + \midrule \PValue{counterwithin} & \PName{Zählername} & Der zur + Gliederungsebene gehörende Zähler soll vom als Wert angegebenen Zähler + abhängig sein. Wird \PName{Zählername} über \Macro{stepcounter} oder + \Macro{refstepsounter} erhöht, so wird der zur Gliederungsebene gehörende + Zähler auf 0 zurückgesetzt. Darüber hinaus wird + \Macro{the\PName{Zählername}} gefolgt von einem Punkt in der Ausgabe des + zur Gliederungsebene + gehörenden Zählers vorangestellt.\\ \ChangedAt{v3.19}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartl}}% - \PValue{counterwithout} & \PName{Zählername} & - Hebt eine früher vorgenommene - \PValue{counterwithin}-Einstellung - auf und ist daher nur bei Änderung - vorhandener Gliederungsbefehle - sinnvoll.\\ - \PValue{expandtopt} & \PName{Schalter} & - Ist dieser Schalter aktiv, so werden - alle in den \PName{Einstellungen} - nachfolgend angegebenen Werte - für Längen vollständig expandiert, - ausgewertet und in \texttt{pt} - umgerechnet gespeichert. - Ist der Schalter nicht aktiv, so - werden alle nachfolgend angegebenen - Werte für Längen nur testweise - expandiert und ausgewertet aber - lediglich expandiert gespeichert. - Es werden die Werte für einfache - Schalter aus - \autoref{tab:truefalseswitch}, - \autopageref{tab:truefalseswitch} - verstanden.\\ - \PValue{level} & \PName{Ganzzahl} & Nummerischer Wert der - Gliederungsebene (siehe Zähler - \Counter{secnumdepth}, - \autoref{sec:maincls.structure}, - \autopageref{desc:maincls.counter.secnumdepth}); - der Wert sollte eindeutig sein. \\ - \PValue{style} & \PName{Name} & Legt den Stil der Überschriften - fest.\\ + \PValue{counterwithout} & \PName{Zählername} & Hebt eine früher + vorgenommene \PValue{counterwithin}-Einstellung auf und ist daher nur bei + Änderung vorhandener Gliederungsbefehle + sinnvoll.\\ + \PValue{expandtopt} & \PName{Schalter} & Ist dieser Schalter aktiv, so + werden alle in den \PName{Einstellungen} nachfolgend angegebenen Werte für + Längen vollständig expandiert, ausgewertet und in \texttt{pt} umgerechnet + gespeichert. Ist der Schalter nicht aktiv, so werden alle nachfolgend + angegebenen Werte für Längen nur testweise expandiert und ausgewertet aber + lediglich expandiert gespeichert. Es werden die Werte für einfache + Schalter aus \autoref{tab:truefalseswitch}, + \autopageref{tab:truefalseswitch} + verstanden.\\ + \PValue{level} & \PName{Ganzzahl} & Nummerischer Wert der Gliederungsebene + (siehe Zähler \DescRef{maincls.counter.secnumdepth}, + \autoref{sec:maincls.structure}, + \DescPageRef{maincls.counter.secnumdepth}); + der Wert sollte eindeutig sein. \\ + \PValue{style} & \PName{Name} & Legt den Stil der Überschriften + fest.\\ \ChangedAt[2016/03]{v3.20}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% - \PValue{tocstyle} & \PName{Name} & Legt den Stil der - Verzeichniseinträge fest. Es können - alle bisher definierten - Verzeichniseintragsstile (siehe - \autoref{sec:tocbasic.tocstyle}) - verwendet werden. Ein leerer - \PName{Name} verhindert die - Definition des Befehls für - Verzeichniseinträge.\\ + \PValue{tocstyle} & \PName{Name} & Legt den Stil der Verzeichniseinträge + fest. Es können alle bisher definierten Verzeichniseintragsstile (siehe + \autoref{sec:tocbasic.tocstyle}) verwendet werden. Ein leerer \PName{Name} + verhindert die Definition des Befehls für + Verzeichniseinträge.\\ \ChangedAt[2016/03]{v3.20}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% - \PValue{toc\PName{Option}} & \PName{Wert} - & Weitere Optionen in Abhängigkeit vom - via \Option{tocstyle} gewählten - Verzeichniseintragsstil. Siehe dazu - \autoref{sec:tocbasic.tocstyle} ab - \autopageref{sec:tocbasic.tocstyle}. - Für die von \Package{tocbasic} - vordefinierten - Verzeichniseintragsstile finden sich - die als \PName{Option} verwendbaren - Attribute in - \autoref{tab:tocbasic.tocstyle.attributes}, - ab - \autopageref{tab:tocbasic.tocstyle.attributes}.\\ + \PValue{toc\PName{Option}} & \PName{Wert} & Weitere Optionen in + Abhängigkeit vom via \Option{tocstyle} gewählten + Verzeichniseintragsstil. Siehe dazu \autoref{sec:tocbasic.tocstyle} ab + \autopageref{sec:tocbasic.tocstyle}. Für die von \Package{tocbasic} + vordefinierten Verzeichniseintragsstile finden sich die als \PName{Option} + verwendbaren Attribute in \autoref{tab:tocbasic.tocstyle.attributes}, ab + \autopageref{tab:tocbasic.tocstyle.attributes}.\\ % \PValue{tocindent} & \PName{Länge} & Der horizontale Einzug des zum % Gliederungsbefehls gehörenden % Eintrags ins Inhaltsverzeichnis, % falls ein solcher abhängig von - % \Counter{tocdepth} (siehe + % \DescRef{maincls.counter.tocdepth} (siehe % \autoref{sec:maincls.toc}, - % \autopageref{desc:maincls.counter.tocdepth}) + % \DescPageRef{maincls.counter.tocdepth}) % erzeugt wird.\\ % \PValue{toclevel} & \PName{Ganzzahl} & % Die Ebene des zum Gliederungsbefehl % gehörenden Eintrags ins % Inhaltsverzeichnis, falls diese von % \PValue{level} abweichen soll - % (siehe auch \Counter{tocdepth} in + % (siehe auch \DescRef{maincls.counter.tocdepth} in % \autoref{sec:maincls.toc}, - % \autopageref{desc:maincls.counter.tocdepth}). \\ + % \DescPageRef{maincls.counter.tocdepth}). \\ % \PValue{tocnumwidth} & \PName{Länge}& Die Breite, die für die % Gliederungsnummer im zum % Gliederungsbefehl gehörenden Eintrag @@ -675,14 +628,16 @@ folgenden Stile zur Verfügung: \PValue{font} & \PName{Schrifteinstellung} & Die Fonteinstellungen, die zusätzlich zum Element - \FontElement{disposition} bei der - Ausgabe der Überschrift verwendet - werden sollen. Hier sind alle - Einstellungen erlaubt, die auch über - \Macro{setkomafont} und - \Macro{addtokomafont} für das - Element des Gliederungsbefehls - erlaubt sind.\\ + \DescRef{maincls.fontelement.disposition} + bei der Ausgabe der Überschrift + verwendet werden sollen. Hier sind + alle Einstellungen erlaubt, die auch + über + \DescRef{maincls.cmd.setkomafont} + und + \DescRef{maincls.cmd.addtokomafont} + für das Element des + Gliederungsbefehls erlaubt sind.\\ \PValue{indent} & \PName{Länge} & Einzug vom linken Rand vor der Ausgabe der Nummer und des Textes der Überschrift.\\ @@ -710,18 +665,25 @@ folgenden Stile zur Verfügung: eingefügt. Negative Werte bedeuten in diesem Fall, dass der Absatz nach der Überschrift ohne horizontalen - Einzug gesetzt werden soll.\\ + Einzug gesetzt werden soll. Bei + Einstellungen der Klassen-Option + \DescRef{maincls.option.version} auf + einen kleineren Wert als 3.22 gibt + es auch mit positiven Werten keinen + Einzug.\\ \PValue{font} & \PName{Schrifteinstellung} & Die Fonteinstellungen, die zusätzlich zum Element - \FontElement{disposition} bei der - Ausgabe der Überschrift verwendet - werden sollen. Hier sind alle - Einstellungen erlaubt, die auch über - \Macro{setkomafont} und - \Macro{addtokomafont} für das - Element des Gliederungsbefehls - erlaubt sind.\\ + \DescRef{maincls.fontelement.disposition} + bei der Ausgabe der Überschrift + verwendet werden sollen. Hier sind + alle Einstellungen erlaubt, die auch + über + \DescRef{maincls.cmd.setkomafont} + und + \DescRef{maincls.cmd.addtokomafont} + für das Element des + Gliederungsbefehls erlaubt sind.\\ \PValue{innerskip} & \PName{Länge} & Der vertikale Abstand zwischen Präfixzeile und Text der Überschrift, falls eine Präfixzeile @@ -738,15 +700,17 @@ folgenden Stile zur Verfügung: \PValue{prefixfont} & \PName{Schrifteinstellung} & Die Fonteinstellungen, die zusätzlich zum Element - \FontElement{disposition} und dem - Element des Gliederungsbefehls bei - der Ausgabe einer Präfixzeile in der - Überschrift verwendet werden - sollen. Hier sind alle - Einstellungen erlaubt, die auch über - \Macro{setkomafont} und - \Macro{addtokomafont} für das - Element der Präfixzeile des + \DescRef{maincls.fontelement.disposition} + und dem Element des + Gliederungsbefehls bei der Ausgabe + einer Präfixzeile in der Überschrift + verwendet werden sollen. Hier sind + alle Einstellungen erlaubt, die auch + über + \DescRef{maincls.cmd.setkomafont} + und + \DescRef{maincls.cmd.addtokomafont} + für das Element der Präfixzeile des Gliederungsbefehls erlaubt sind.\\ \bottomrule \end{tabularx} @@ -765,24 +729,20 @@ folgenden Stile zur Verfügung: \PValue{afterskip} & \PName{Länge} & Der Betrag gibt den vertikalen Abstand nach der Überschrift an.\\ \PValue{beforeskip} & \PName{Länge} & Der Betrag gibt den vertikalen - Abstand vor der Überschrift an. Ist - der Wert negativ, so wird also - trotzdem ein positiver Abstand - eingefügt. Negative Werte bedeuten - in diesem Fall, dass der Absatz nach - der Überschrift ohne horizontalen - Einzug gesetzt werden soll.\\ + Abstand vor der Überschrift an.\\ \PValue{font} & \PName{Schrifteinstellung} & Die Fonteinstellungen, die zusätzlich zum Element - \FontElement{disposition} bei der - Ausgabe der Überschrift verwendet - werden sollen. Hier sind alle - Einstellungen erlaubt, die auch über - \Macro{setkomafont} und - \Macro{addtokomafont} für das - Element des Gliederungsbefehls - erlaubt sind.\\ + \DescRef{maincls.fontelement.disposition} + bei der Ausgabe der Überschrift + verwendet werden sollen. Hier sind + alle Einstellungen erlaubt, die auch + über + \DescRef{maincls.cmd.setkomafont} + und + \DescRef{maincls.cmd.addtokomafont} + für das Element des + Gliederungsbefehls erlaubt sind.\\ \PValue{innerskip} & \PName{Länge} & %\OnlyAt{\Class{scrbook}\and % \Class{scrreprt}}% Der vertikale Abstand zwischen @@ -808,15 +768,17 @@ folgenden Stile zur Verfügung: \PValue{prefixfont} & \PName{Schrifteinstellung} & Die Fonteinstellungen, die zusätzlich zum Element - \FontElement{disposition} und dem - Element des Gliederungsbefehls bei - der Ausgabe einer Präfixzeile in der - Überschrift verwendet werden - sollen. Hier sind alle - Einstellungen erlaubt, die auch über - \Macro{setkomafont} und - \Macro{addtokomafont} für das - Element der Präfixzeile des + \DescRef{maincls.fontelement.disposition} + und dem Element des + Gliederungsbefehls bei der Ausgabe + einer Präfixzeile in der Überschrift + verwendet werden sollen. Hier sind + alle Einstellungen erlaubt, die auch + über + \DescRef{maincls.cmd.setkomafont} + und + \DescRef{maincls.cmd.addtokomafont} + für das Element der Präfixzeile des Gliederungsbefehls erlaubt sind.\\ \bottomrule \end{tabularx} @@ -881,9 +843,9 @@ der Verzeichniseinträge siehe \autoref{sec:tocbasic.tocstyle} ab Seite \autopageref{sec:tocbasic.tocstyle}. \begin{Example} - Aus unerfindlichen Gründen sollen die Überschriften von \Macro{paragraph} + Aus unerfindlichen Gründen sollen die Überschriften von \DescRef{maincls.cmd.paragraph} nicht mehr als Spitzmarken, sondern als Überschriften ähnlich - \Macro{subsubsection} umdefiniert werden. Dabei soll über der Überschrift + \DescRef{maincls.cmd.subsubsection} umdefiniert werden. Dabei soll über der Überschrift ein kleiner Abstand von 10\,pt und unter der Überschrift kein zusätzlicher Abstand eingefügt werden. Das wäre bereits mit \begin{lstcode} @@ -901,10 +863,10 @@ der Verzeichniseinträge siehe \autoref{sec:tocbasic.tocstyle} ab Seite Überschrift in der Form einer Spitzmarke. Der kleinste positive Wert ist 1\,sp. - In der Regel ist es für den vertikalen Ausgleich (siehe \Macro{flushbottom}, - \autoref{sec:maincls.typearea}, \autopageref{desc:maincls.cmd.flushbottom}) - besser, wenn man die Abstände mit etwas Spielraum, dem sogenannten Leim, - versieht: + In der Regel ist es für den vertikalen Ausgleich (siehe + \DescRef{maincls.cmd.flushbottom}, \autoref{sec:maincls.typearea}, + \DescPageRef{maincls.cmd.flushbottom}) besser, wenn man die Abstände + mit etwas Spielraum, dem sogenannten Leim, versieht: \begin{lstcode} \RedeclareSectionCommand[% beforeskip=-10pt plus -2pt minus -1pt,% @@ -920,11 +882,11 @@ der Verzeichniseinträge siehe \autoref{sec:tocbasic.tocstyle} ab Seite Dass im Beispiel tatsächlich nur die Schlüssel \PValue{beforeskip} und \PValue{afterskip} verwendet werden mussten, liegt daran, dass seit -\KOMAScript{} v3.15 \Macro{paragraph} intern bereits mit +\KOMAScript{} v3.15 \DescRef{maincls.cmd.paragraph} intern bereits mit \Macro{DeclareSectionCommand} definiert wird und daher die übrigen Einstellungen unverändert übernommen werden können. Die Originaldefinition von -\Macro{paragraph} entspricht bei \Class{scrartcl}: -\begin{lstcode}[belowskip=\dp\strutbox] +\DescRef{maincls.cmd.paragraph} entspricht bei \Class{scrartcl}: +\begin{lstcode} \DeclareSectionCommand[% level=4, indent=0pt, @@ -939,15 +901,16 @@ Einstellungen unverändert übernommen werden können. Die Originaldefinition von Bei \Class{scrreprt} und \Class{scrbook} werden teilweise abweichende Werte verwendet. -Für \Macro{chapter} sind einige Einstellungen für die Überschriften von Option -\Option{headings} (siehe \autoref{sec:maincls.structure}, -\autopageref{desc:maincls.option.headings}) abhängig. Diese abhängigen -Einstellungen sind in \autoref{tab:maincls.chapter.skips} zu finden. Eine -Übersicht über alle Voreinstellungen bietet -\autoref{tab:maincls.section.defaults}. Es ist zu beachten, dass dabei -\PValue{1ex} und \Length{baselineskip} von der voreingestellten Größe der -Überschrift beziehungsweise des Inhaltsverzeichniseintrags abhängig -sind. Weitere Voreinstellungen\ChangedAt[2016/03]{v3.20}{\Class{scrbook}\and +Für \DescRef{maincls.cmd.chapter} sind einige Einstellungen für die +Überschriften von Option \DescRef{maincls.option.headings} (siehe +\autoref{sec:maincls.structure}, \DescPageRef{maincls.option.headings}) +abhängig. Diese abhängigen Einstellungen sind in +\autoref{tab:maincls.chapter.skips} zu finden. Eine Übersicht über alle +Voreinstellungen bietet \autoref{tab:maincls.section.defaults}. Es ist zu +beachten, dass dabei \PValue{1ex} und \Length{baselineskip} von der +voreingestellten Größe der Überschrift beziehungsweise des +Inhaltsverzeichniseintrags abhängig sind. Weitere +Voreinstellungen\ChangedAt[2016/03]{v3.20}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} für die Stile der Verzeichniseinträge sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \autopageref{sec:tocbasic.tocstyle} zu entnehmen. @@ -955,10 +918,10 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \begin{table} \centering \caption{Voreinstellungen für die Kapitelüberschriften von \Class{scrbook} - und \Class{scrreprt} in Abhängigkeit von Option \Option{headings}} + und \Class{scrreprt} in Abhängigkeit von Option \DescRef{maincls.option.headings}} \label{tab:maincls.chapter.skips} \begin{tabular}{ll} - \multicolumn{2}{@{}l}{\bfseries Mit \OptionValue{headings}{big}:}\\ + \multicolumn{2}{@{}l}{\bfseries Mit \OptionValueRef{maincls}{headings}{big}:}\\ \toprule Einstellung & voreingestellter Wert \\ \midrule @@ -966,10 +929,10 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab & \PValue{1.725\Length{baselineskip} plus .115\Length{baselineskip} minus .192\Length{baselineskip}} \\ \PValue{beforeskip} - & \PValue{3.3\Length{baselineskip}+\Length{parskip}} \\ + & \PValue{-3.3\Length{baselineskip}-\Length{parskip}} \\ \PValue{font} & \Macro{huge} \\ \bottomrule\\ - \multicolumn{2}{@{}l}{\bfseries Mit \OptionValue{headings}{normal}:}\\ + \multicolumn{2}{@{}l}{\bfseries Mit \OptionValueRef{maincls}{headings}{normal}:}\\ \toprule Einstellung & voreingestellter Wert \\ \midrule @@ -977,10 +940,10 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab & \PValue{1.5\Length{baselineskip} plus .1\Length{baselineskip} minus .167\Length{baselineskip}} \\ \PValue{beforeskip} - & \PValue{3\Length{baselineskip}+\Length{parskip}} \\ + & \PValue{-3\Length{baselineskip}-\Length{parskip}} \\ \PValue{font} & \Macro{LARGE} \\ \bottomrule\\ - \multicolumn{2}{@{}l}{\bfseries Mit \OptionValue{headings}{small}:}\\ + \multicolumn{2}{@{}l}{\bfseries Mit \OptionValueRef{maincls}{headings}{small}:}\\ \toprule Einstellung & voreingestellter Wert \\ \midrule @@ -988,7 +951,7 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab & \PValue{1.35\Length{baselineskip} plus .09\Length{baselineskip} minus .15\Length{baselineskip}} \\ \PValue{beforeskip} - & \PValue{2.8\Length{baselineskip}+\Length{parskip}} \\ + & \PValue{-2.8\Length{baselineskip}-\Length{parskip}} \\ \PValue{font} & \Macro{Large} \\ \bottomrule \end{tabular} @@ -1008,19 +971,20 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \raggedleft\dots\\ \endfoot \endlastfoot - \Macro{part}: \\* + \DescRef{maincls.cmd.part}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule \PValue{afterskip} & \PValue{0pt plus 1fil} \\ \PValue{beforeskip} & \PValue{0pt plus 1fil + \Length{baselineskip}} \\ - \PValue{font} & siehe Element \FontElement{part}, + \PValue{font} & siehe Element \DescRef{maincls.fontelement.part}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{innerskip} & \PValue{20pt} \\ \PValue{level} & -1 \\ - \PValue{prefixfont} & siehe Element \FontElement{partnumber}, + \PValue{prefixfont} & siehe Element + \DescRef{maincls.fontelement.partnumber}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{tocindent} & \PValue{0pt} \\ @@ -1030,19 +994,20 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \bottomrule \end{tabularx} \\ \addlinespace[\normalbaselineskip] - \Macro{chapter}: \\* + \DescRef{maincls.cmd.chapter}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule \PValue{afterskip} & siehe \autoref{tab:maincls.chapter.skips} \\ \PValue{beforeskip} & siehe \autoref{tab:maincls.chapter.skips} \\ - \PValue{font} & siehe Element \FontElement{chapter}, + \PValue{font} & siehe Element \DescRef{maincls.fontelement.chapter}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{innerskip} & \PValue{0pt} \\ \PValue{level} & 0 \\ - \PValue{prefixfont} & siehe Element \FontElement{chapterprefix}, + \PValue{prefixfont} & siehe Element + \DescRef{maincls.fontelement.chapterprefix}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{tocindent} & \PValue{0pt} \\ @@ -1052,14 +1017,14 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \bottomrule \end{tabularx} \\ \addlinespace[\normalbaselineskip] - \Macro{section}: \\* + \DescRef{maincls.cmd.section}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule \PValue{afterskip} & \PValue{2.3ex plus .2ex} \\ \PValue{beforeskip} & \PValue{-3.5ex plus -1ex minus -.2ex} \\ - \PValue{font} & siehe Element \FontElement{section}, + \PValue{font} & siehe Element \DescRef{maincls.fontelement.section}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{indent} & \PValue{0pt} \\ @@ -1071,14 +1036,15 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \bottomrule \end{tabularx} \\ \addlinespace[\normalbaselineskip] - \Macro{subsection}: \\* + \DescRef{maincls.cmd.subsection}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule\nopagebreak \PValue{afterskip} & \PValue{1.5ex plus .2ex} \\ \PValue{beforeskip} & \PValue{-3.25ex plus -1ex minus -.2ex} \\ - \PValue{font} & siehe Element \FontElement{subsection}, + \PValue{font} & siehe Element + \DescRef{maincls.fontelement.subsection}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{indent} & \PValue{0pt} \\ @@ -1090,14 +1056,15 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \bottomrule \end{tabularx} \\ \addlinespace[\normalbaselineskip] - \Macro{subsubsection}: \\* + \DescRef{maincls.cmd.subsubsection}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule\nopagebreak \PValue{afterskip} & \PValue{1.5ex plus .2ex} \\ \PValue{beforeskip} & \PValue{-3.25ex plus -1ex minus -.2ex} \\ - \PValue{font} & siehe Element \FontElement{subsubsection}, + \PValue{font} & siehe Element + \DescRef{maincls.fontelement.subsubsection}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{indent} & \PValue{0pt} \\ @@ -1109,14 +1076,15 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \bottomrule \end{tabularx} \\ \addlinespace[\normalbaselineskip] - \Macro{paragraph}: \\* + \DescRef{maincls.cmd.paragraph}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule\nopagebreak \PValue{afterskip} & \PValue{-1em} \\ \PValue{beforeskip} & \PValue{3.25ex plus 1ex minus .2ex} \\ - \PValue{font} & siehe Element \FontElement{paragraph}, + \PValue{font} & siehe Element + \DescRef{maincls.fontelement.paragraph}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{indent} & \PValue{0pt} \\ @@ -1128,14 +1096,15 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \bottomrule \end{tabularx} \\ \addlinespace[\normalbaselineskip] - \Macro{subparagraph}: \\* + \DescRef{maincls.cmd.subparagraph}: \\* \begin{tabularx}{\linewidth}{ll} \toprule Einstellung & voreingestellter Wert \\ \midrule\nopagebreak \PValue{afterskip} & \PValue{-1em} \\ \PValue{beforeskip} & \PValue{3.25ex plus 1ex minus .2ex} \\ - \PValue{font} & siehe Element \FontElement{subparagraph}, + \PValue{font} & siehe Element + \DescRef{maincls.fontelement.subparagraph}, \autoref{tab:maincls.structureElementsFont}, \autopageref{tab:maincls.structureElementsFont} \\ \PValue{indent} & \Macro{scr@parindent} \\ @@ -1149,26 +1118,19 @@ sind \autoref{sec:tocbasic.tocstyle}\important{\Package{tocbasic}} ab \end{longtable} %end{table} % -\EndIndex{Cmd}{ProvideSectionCommand}% -\EndIndex{Cmd}{RedeclareSectionCommand}% -\EndIndex{Cmd}{DeclareNewSectionCommand}% -\EndIndex{Cmd}{DeclareSectionCommand}% +\EndIndexGroup \begin{Declaration} \Macro{DeclareSectionCommands}\OParameter{Einstellungen}% - \Parameter{Namensliste}\\ + \Parameter{Namensliste} \Macro{DeclareNewSectionCommands}\OParameter{Einstellungen}% - \Parameter{Namensliste}\\ + \Parameter{Namensliste} \Macro{RedeclareSectionCommands}\OParameter{Einstellungen}% - \Parameter{Namensliste}\\ + \Parameter{Namensliste} \Macro{ProvideSectionCommands}\OParameter{Einstellungen}% \Parameter{Namensliste} \end{Declaration} -\BeginIndex{Cmd}{DeclareSectionCommands}% -\BeginIndex{Cmd}{DeclareNewSectionCommands}% -\BeginIndex{Cmd}{RedeclareSectionCommands}% -\BeginIndex{Cmd}{ProvideSectionCommands}% Mit\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} diesen Anweisungen können gleich eine ganze Reihe von Gliederungsbefehlen definiert oder geändert werden. Dabei ist @@ -1192,42 +1154,32 @@ Werte von \PValue{level} und \PValue{toclevel} um den Wert von \PValue{increaselevel} erhöht. Wurde die Einstellung \PValue{increaselevel} ohne Wertzuweisung verwendet, so wird der Wert 1 angenommen. % -\EndIndex{Cmd}{ProvideSectionCommands}% -\EndIndex{Cmd}{RedeclareSectionCommands}% -\EndIndex{Cmd}{DeclareNewSectionCommands}% -\EndIndex{Cmd}{DeclareSectionCommands}% +\EndIndexGroup \begin{Declaration} - \Macro{chapterheadstartvskip}\\ - \Macro{chapterheadmidvskip}\\ - \Macro{chapterheadendvskip}\\ - \Macro{partheadstartvskip}\\ - \Macro{partheadmidvskip}\\ - \Macro{partheadendvskip}\\ + \Macro{chapterheadstartvskip} + \Macro{chapterheadmidvskip} + \Macro{chapterheadendvskip} + \Macro{partheadstartvskip} + \Macro{partheadmidvskip} + \Macro{partheadendvskip} \Macro{partheademptypage} \end{Declaration} -\BeginIndex{Cmd}{chapterheadstartvskip}% -\BeginIndex{Cmd}{chapterheadsmidvskip}% -\BeginIndex{Cmd}{chapterheadendvskip}% -\BeginIndex{Cmd}{partheadstartvskip}% -\BeginIndex{Cmd}{partheadmidvskip}% -\BeginIndex{Cmd}{partheadendvskip}% -\BeginIndex{Cmd}{partheademptypage}% -Diese\important[i]{\Macro{chapter}\\ - \Macro{part}\\ - \Macro{addchap}\\ +Diese\important[i]{\DescRef{maincls.cmd.chapter}\\ + \DescRef{maincls.cmd.part}\\ + \DescRef{maincls.cmd.addchap}\\ \Macro{addpart}} Anweisungen werden innerhalb der Definition der -Überschriften \Macro{chapter}\IndexCmd{chapter}, \Macro{part}, -\Macro{addchap}, \Macro{addpart} und deren Sternvarianten verwendet. Dabei ist +Überschriften \DescRef{maincls.cmd.chapter}\IndexCmd{chapter}, \DescRef{maincls.cmd.part}, +\DescRef{maincls.cmd.addchap}, \Macro{addpart} und deren Sternvarianten verwendet. Dabei ist \Macro{chapterheadstartvskip} eine Anweisung, die dafür vorgesehen ist, vor der Kapitelüberschrift einen vertikalen Abstand einzufügen. Entsprechend ist \Macro{chapterheadendvskip} eine Anweisung, die dafür vorgesehen ist, nach der Kapitelüberschrift einen vertikalen Abstand einzufügen. Bei\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}} Kapitelüberschriften mit eigener Nummernzeile (siehe Option -\Option{chapterprefix} in \autoref{sec:maincls.structure}, -\autopageref{desc:maincls.option.chapterprefix}) wird zwischen der +\DescRef{maincls.option.chapterprefix} in \autoref{sec:maincls.structure}, +\DescPageRef{maincls.option.chapterprefix}) wird zwischen der Nummernzeile und der eigentlichen Überschrift außerdem \Macro{chapterheadmidvskip} ausgeführt. @@ -1245,8 +1197,8 @@ gegebenenfalls für die leere Seite nach der Überschrift verwendet. Die Voreinstellungen für diese sieben Anweisungen sind seit \KOMAScript~3.15\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}} von der Einstellung von Option \Option{headings} (siehe -\autoref{sec:maincls.structure}, \autopageref{desc:maincls.option.headings}) + \Class{scrartcl}} von der Einstellung von Option \DescRef{maincls.option.headings} (siehe +\autoref{sec:maincls.structure}, \DescPageRef{maincls.option.headings}) unabhängig. Die Original-Definitionen für die Kapitelüberschriften ab \KOMAScript~3.17\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} entsprechen:\IndexLength{@tempskipa} @@ -1256,28 +1208,32 @@ unabhängig. Die Original-Definitionen für die Kapitelüberschriften ab \newcommand*{\chapterheadendvskip}{\vskip\@tempskipa} \end{lstcode} Diese werden auch bei jeder Verwendung von Option -\OptionValue{headings}{big}\IndexOption{headings}, -\OptionValue{headings}{normal} oder \OptionValue{headings}{small} reaktiviert. - -Die Anweisung \Macro{chapter} setzt die interne Länge \Length{@tempskipa} vor -Aufruf von \Macro{chapterheadstartvskip} automatisch auf den Wert, der sich -aus der -\Macro{DeclareSectionCommand}-Einstellung\IndexCmd{DeclareSectionCommand} -\PValue{beforeskip} ergibt. Entsprechendes geschieht vor dem Aufruf von -\Macro{chapterheadendvskip} mit dem Wert, der sich aus der -\Macro{DeclareSectionCommand}-Einstellung \PValue{afterskip} ergibt, und vor -dem Aufruf von \Macro{chapterheadmidvskip} mit dem Wert, der sich aus -\Macro{DeclareSectionCommand}-Einstellung \PValue{innerskip} ergibt. Werden -\Macro{chapterheadstartvskip}, \Macro{chapterheadmidvskip} oder +\OptionValueRef{maincls}{headings}{big}\IndexOption{headings}, +\OptionValueRef{maincls}{headings}{normal} oder +\OptionValueRef{maincls}{headings}{small} reaktiviert. + +Die Anweisung \DescRef{maincls.cmd.chapter} setzt die interne Länge +\Length{@tempskipa} vor Aufruf von \Macro{chapterheadstartvskip} automatisch +auf den Wert, der sich aus der +\DescRef{\LabelBase.cmd.DeclareSectionCommand}-Einstellung% +\IndexCmd{DeclareSectionCommand} \PValue{beforeskip} ergibt. Entsprechendes +geschieht vor dem Aufruf von \Macro{chapterheadendvskip} mit dem Wert, der +sich aus der \DescRef{\LabelBase.cmd.DeclareSectionCommand}-Einstellung +\PValue{afterskip} ergibt, und vor dem Aufruf von \Macro{chapterheadmidvskip} +mit dem Wert, der sich aus +\DescRef{\LabelBase.cmd.DeclareSectionCommand}-Einstellung \PValue{innerskip} +ergibt. Werden \Macro{chapterheadstartvskip}, \Macro{chapterheadmidvskip} oder \Macro{chapterheadendvskip} umdefiniert und sollen die Abstände weiterhin -beispielsweise mit \Macro{RedeclareSectionCommand} konfigurierbar sein, so -sollte man in der neuen Definition ebenfalls \Length{@tempskipa} verwenden. - -Da die Voreinstellungen für die Abstände von \Macro{part} nicht von Option -\Option{headings} abhängen, werden auch die zugehörigen Anweisungen von dieser -Option nicht neu definiert. Ihre\ChangedAt{v3.17}{\Class{scrbook}\and - \Class{scrreprt}\and \Class{scrartcl}} Original-Definitionen entsprechen bei -\Class{scrbook} und \Class{scrreprt}: +beispielsweise mit \DescRef{\LabelBase.cmd.RedeclareSectionCommand} +konfigurierbar sein, so sollte man in der neuen Definition ebenfalls +\Length{@tempskipa} verwenden. + +Da die Voreinstellungen für die Abstände von \DescRef{maincls.cmd.part} nicht +von Option \DescRef{maincls.option.headings} abhängen, werden auch die +zugehörigen Anweisungen von dieser Option nicht neu +definiert. Ihre\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and + \Class{scrartcl}} Original-Definitionen entsprechen bei \Class{scrbook} und +\Class{scrreprt}: \begin{lstcode} \newcommand*{\partheadstartvskip}{% \null\vskip-\baselineskip\vskip\@tempskipa @@ -1303,43 +1259,39 @@ und bei \Class{scrartcl}: } \end{lstcode} Auch hier wird \Length{@tempskipa}\IndexLength{@tempskipa} vor der Verwendung -der Befehle innerhalb von \Macro{part} entsprechend der Einstellungen von -\Macro{DeclareSectionCommand}\IndexCmd{DeclareSectionCommand} gesetzt. - -Da\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}} die Abstände über, innerhalb und unter den Überschriften -wesentlich einfacher mit \Macro{RedeclareSectionCommand} eingestellt werden +der Befehle innerhalb von \DescRef{maincls.cmd.part} entsprechend der +Einstellungen von +\DescRef{\LabelBase.cmd.DeclareSectionCommand}\IndexCmd{DeclareSectionCommand} +gesetzt. + +Da\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} +die Abstände über, innerhalb und unter den Überschriften wesentlich einfacher +mit \DescRef{\LabelBase.cmd.RedeclareSectionCommand} eingestellt werden können, wird nicht empfohlen zu diesem Zweck stattdessen die hier beschriebenen Anweisungen umzudefinieren. Sie sollten für tiefgreifendere -Änderungen reserviert bleiben, die nicht über \Macro{RedeclareSectionCommand} -zu erreichen sind. Auf\textnote{Beispiel!} \cite{homepage} findet sich dazu -es ein Beispiel, bei dem durch Umdefinierung von \Macro{chapterheadstartvskip} -und \Macro{chapterheadendvskip} Linien über und unter der Kapitelüberschrift +Änderungen reserviert bleiben, die nicht über +\DescRef{\LabelBase.cmd.RedeclareSectionCommand} zu erreichen sind. +Auf\textnote{Beispiel!} \cite{homepage} findet sich dazu es ein Beispiel, bei +dem durch Umdefinierung von \Macro{chapterheadstartvskip} und +\Macro{chapterheadendvskip} Linien über und unter der Kapitelüberschrift gesetzt werden.% % -\EndIndex{Cmd}{partheademptypage}% -\EndIndex{Cmd}{partheadendvskip}% -\EndIndex{Cmd}{partheadmidvskip}% -\EndIndex{Cmd}{partheadstartvskip}% -\EndIndex{Cmd}{chapterheadendvskip}% -\EndIndex{Cmd}{chapterheadstartvskip}% +\EndIndexGroup \begin{Declaration} \Macro{chapterlineswithprefixformat}% - \Parameter{Ebene}\Parameter{Nummer}\Parameter{Text}\\ + \Parameter{Ebene}\Parameter{Nummer}\Parameter{Text} \Macro{chapterlinesformat}% \Parameter{Ebene}\Parameter{Nummer}\Parameter{Text} \end{Declaration} -\BeginIndex{Cmd}{chapterlineswithprefixformat}% -\BeginIndex{Cmd}{chapterlinesformat}% Diese\ChangedAt{v3.19}{\Class{scrbook}\and \Class{scrreprt}} beiden Anweisungen werden von Überschriften des Stils \PValue{chapter}\textnote{Gliederungsstil \PValue{chapter}}\Index{Gliederung>Stil>~\PValue{chapter}} in Abhängigkeit -von Option \Option{chapterprefix}\IndexOption{chapterprefix}% -\textnote{\Option{chapterprefix}} (siehe \autoref{sec:maincls.structure}, -\autopageref{desc:maincls.option.chapterprefix}) verwendet. Dabei gibt +von Option \DescRef{maincls.option.chapterprefix}\IndexOption{chapterprefix}% +\textnote{\DescRef{maincls.option.chapterprefix}} (siehe \autoref{sec:maincls.structure}, +\DescPageRef{maincls.option.chapterprefix}) verwendet. Dabei gibt \Macro{chapterlineswithprefixformat} die Ausgabe bei aktivierter Option vor, während \Macro{chapterlinesformat} die Ausgabe bei deaktivierter Option bestimmt. @@ -1352,7 +1304,7 @@ ein komplett leeres Argument, enthält also auch keine Formatierungsanweisungen. Vordefiniert sind die beiden Anweisungen mit: -\begin{lstcode}[belowskip=\dp\strutbox plus 1pt] +\begin{lstcode} \newcommand{\chapterlinesformat}[3]{% \@hangfrom{#2}{#3}% } @@ -1390,10 +1342,11 @@ bisher eher spartanisch. Allerdings fällt Ihnen nach einiger Zeit auf, dass mit dieser Umdefinierung die Überschriften wieder im Blocksatz gesetzt werden. Das liegt daran, dass \Macro{parbox} sein Argument so setzt. Um dies zu korrigieren, fügen Sie die - Anweisung \Macro{raggedchapter} (siehe \autoref{sec:maincls.structure}, - \autopageref{desc:maincls.cmd.raggedchapter}), die automatisch bereits vor - \Macro{chapterlinesformat} und \Macro{chapterlineswithprefixformat} - aufgerufen wird, in die Definitionen ein: + Anweisung \DescRef{maincls.cmd.raggedchapter} (siehe + \autoref{sec:maincls.structure}, \DescPageRef{maincls.cmd.raggedchapter}), + die automatisch bereits vor \Macro{chapterlinesformat} und + \Macro{chapterlineswithprefixformat} aufgerufen wird, in die Definitionen + ein: \begin{lstcode} \makeatletter \renewcommand{\chapterlinesformat}[3]{% @@ -1431,9 +1384,9 @@ von \PName{Text} so, dass darin kein Seitenumbruch stattfinden darf. Gleichzeitig endet \PName{Text} immer mit einem internen Absatz, \Macro{@par}. -Die Anweisung \Macro{raggedchapter} ist übrigens nicht Bestandteil von -\PName{Text}, weil anderenfalls beispielsweise die Verwendung von -\Macro{MakeUppercase} innerhalb der Umdefinierung von +Die Anweisung \DescRef{maincls.cmd.raggedchapter} ist übrigens nicht +Bestandteil von \PName{Text}, weil anderenfalls beispielsweise die Verwendung +von \Macro{MakeUppercase} innerhalb der Umdefinierung von \Macro{chapterlinesformat} oder \Macro{chapterlineswithprefixformat} erheblich erschwert wäre. Dennoch sei darauf hingewiesen, dass typografischen Regeln zufolge Versalsatz mit gängigen Fonts immer der Sperrung und des Ausgleichs @@ -1445,20 +1398,19 @@ erforderlich. Erst, wenn der Anwender mehrere Anweisungen im Stil \PValue{chapter} definiert und man innerhalb der Definition nach den Anweisungen unterscheiden will, kann dies über \PName{Ebene} erfolgen. Dabei ist \PName{Ebene} der vom Namen der Anweisung abgeleitete Name der -Gliederungsebene. Bei \Macro{chapter}, \Macro{chapter*}, \Macro{addchap} und -\Macro{addchap*} ist \PName{Ebene} daher einheitlich \PValue{chapter}.% -\EndIndex{Cmd}{chapterlinesformat}% -\EndIndex{Cmd}{chapterlineswithprefixformat}% +Gliederungsebene. Bei \DescRef{maincls.cmd.chapter}, +\DescRef{maincls.cmd.chapter*}, \DescRef{maincls.cmd.addchap} und +\DescRef{maincls.cmd.addchap*} ist \PName{Ebene} daher einheitlich +\PValue{chapter}.% +\EndIndexGroup \begin{Declaration} \Macro{sectionlinesformat}% - \Parameter{Ebene}\Parameter{Einzug}\Parameter{Nummer}\Parameter{Text}\\ + \Parameter{Ebene}\Parameter{Einzug}\Parameter{Nummer}\Parameter{Text} \Macro{sectioncatchphraseformat}% \Parameter{Ebene}\Parameter{Einzug}\Parameter{Nummer}\Parameter{Text} \end{Declaration} -\BeginIndex{Cmd}{sectionlinesformat}% -\BeginIndex{Cmd}{sectioncatchphraseformat}% Diese\ChangedAt{v3.19}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} beiden Anweisungen werden von Überschriften des Stils \PValue{section}\textnote{Gliederungsstil @@ -1480,7 +1432,7 @@ nummerierten Überschriften ist \PName{Nummer} ein komplett leeres Argument, enthält also auch keine Formatierungsanweisungen. Vordefiniert sind die beiden Anweisungen als: -\begin{lstcode}[belowskip=\dp\strutbox plus 1pt] +\begin{lstcode} \newcommand{\sectionlinesformat}[4]{% \@hangfrom{\hskip #2#3}{#4}% } @@ -1534,32 +1486,30 @@ Das erste Argument, \PName{Ebene}, wird von den Anweisungen in der Voreinstellung nicht verwendet. Wie das Beispiel zeigt, kann es aber sehr gut dazu verwendet werden, nach unterschiedlichen Gliederungsebenen im gemeinsamen Stil \PValue{section} zu unterscheiden.% -\EndIndex{Cmd}{sectioncatchphraseformat}% -\EndIndex{Cmd}{sectionlinesformat}% +\EndIndexGroup \begin{Declaration} - \Macro{SecDef}\Parameter{Sternanweisung}\Parameter{Normalanweisung}\\ + \Macro{SecDef}\Parameter{Sternanweisung}\Parameter{Normalanweisung} \Macro{scr@startsection}\Parameter{Name}\Parameter{Ebene}% - \Parameter{Einzug}\Parameter{Abstand davor}\Parameter{Abstand danach}\\ - \hphantom{\XMacro{scr@startsection}}\Parameter{Stilanweisungen}% - \OParameter{Kurzform}\Parameter{Überschrift}\\ + \Parameter{Einzug}\Parameter{Abstand davor}\Parameter{Abstand danach} + \Parameter{Stilanweisungen}% + \OParameter{Kurzform}\Parameter{Überschrift} + \labelsuffix[*]% \Macro{scr@startsection}\Parameter{Name}\Parameter{Ebene}% - \Parameter{Einzug}\Parameter{Abstand davor}\Parameter{Abstand danach}\\ - \hphantom{\XMacro{scr@startsection}}\Parameter{Stilanweisungen}% - \texttt{*}\Parameter{Überschrift}\\ - \Macro{At@startsection}\Parameter{Code}\\ - \Macro{Before@ssect}\Parameter{Code}\\ + \Parameter{Einzug}\Parameter{Abstand davor} + \Parameter{Abstand danach} + \Parameter{Stilanweisungen}% + \nobreak\texttt{*}\Parameter{Überschrift} + \labelsuffix + \Macro{At@startsection}\Parameter{Code} + \Macro{Before@ssect}\Parameter{Code} \Macro{Before@sect}\Parameter{Code} \end{Declaration} -\BeginIndex{Cmd}{At@startsection}% -\BeginIndex{Cmd}{Before@ssect}% -\BeginIndex{Cmd}{Before@sect}% -\BeginIndex{Cmd}{scr@startsection}% Wie\ChangedAt[2014/09]{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} bereits in \autoref{sec:maincls.structure} bei der Beschreibung zu den Gliederungsbefehlen ab -\autopageref{desc:maincls.cmd.chapter} erklärt, verfügt \KOMAScript{} +\DescPageRef{maincls.cmd.chapter} erklärt, verfügt \KOMAScript{} bezüglich des optionalen Arguments der Gliederungsbefehle über erweiterte Möglichkeiten. Um dies möglich zu machen, war es notwendig, einige Anweisungen des \LaTeX-Kerns zu ersetzen. Dazu gehören auch die Anweisungen @@ -1584,9 +1534,9 @@ könnte. \KOMAScript{} selbst verwendet intern \Macro{SecDef} und \Macro{scr@startsection} an Stelle von \Macro{secdef} und \Macro{@startsection} beispielsweise bei den Gliederungsbefehlen, die mit -\Macro{DeclareSectionCommand} definiert werden. Eine nachträgliche -Umdefinierung von \Macro{secdef} und \Macro{@startsection} hat daher keine -Auswirkungen auf diese Gliederungsbefehle. +\DescRef{\LabelBase.cmd.DeclareSectionCommand} definiert werden. Eine +nachträgliche Umdefinierung von \Macro{secdef} und \Macro{@startsection} hat +daher keine Auswirkungen auf diese Gliederungsbefehle. Als Ersatz für die Umdefinierung der Anweisungen bietet \KOMAScript{} die Möglichkeit, zusätzlichen \PName{Code} in die Ausführung der @@ -1611,10 +1561,7 @@ Die Anweisungen \Macro{At@startsection}, \Macro{Before@sect}, \Macro{Before@ssect} sind als Anweisungen für Paketautoren entworfen und für diese zur Verwendung freigegeben.% % -\EndIndex{Cmd}{scr@startsection}% -\EndIndex{Cmd}{Before@sect}% -\EndIndex{Cmd}{Before@ssect}% -\EndIndex{Cmd}{At@startsection}% +\EndIndexGroup % \subsection{Anhang} % \seclabel{appendix} @@ -1622,33 +1569,33 @@ diese zur Verwendung freigegeben.% \begin{Declaration} \Macro{appendixmore} \end{Declaration}% -\BeginIndex{Cmd}{appendixmore}% Bei den {\KOMAScript}-Klassen gibt es innerhalb der Anweisung -\Macro{appendix}\IndexCmd{appendix}\important{\Macro{appendix}} eine +\DescRef{maincls.cmd.appendix}% +\IndexCmd{appendix}\important{\DescRef{maincls.cmd.appendix}} eine Besonderheit. Ist nämlich \Macro{appendixmore} definiert, so wird diese -Anweisung von \Macro{appendix} ebenfalls ausgeführt. Intern wird dies von den -{\KOMAScript}-Klassen \Class{scrbook}\OnlyAt{\Class{scrbook}\and +Anweisung von \DescRef{maincls.cmd.appendix} ebenfalls ausgeführt. Intern wird +dies von den {\KOMAScript}-Klassen \Class{scrbook}\OnlyAt{\Class{scrbook}\and \Class{scrreprt}} und \Class{scrreprt} für die Realisierung der Layoutoption -\Option{appendixprefix} genutzt (siehe \autoref{sec:maincls.structure}, -\autopageref{desc:maincls.option.appendixprefix}). Dies\textnote{Achtung!} -sollten Sie unbedingt beachten, falls Sie selbst das Makro -\Macro{appendixmore} definieren oder umdefinieren wollen. Ist diese -Option verwendet, so erhalten Sie bei -\verb|\newcommand{\appendixmore}{|\dots\verb|}| eine Fehlermeldung. Dadurch -soll verhindert werden, dass Sie die Optionen außer Kraft setzen, ohne es zu -merken. +\DescRef{maincls.option.appendixprefix} genutzt (siehe +\autoref{sec:maincls.structure}, +\DescPageRef{maincls.option.appendixprefix}). Dies\textnote{Achtung!} sollten +Sie unbedingt beachten, falls Sie selbst das Makro \Macro{appendixmore} +definieren oder umdefinieren wollen. Ist diese Option verwendet, so erhalten +Sie bei \verb|\newcommand{\appendixmore}{|\dots\verb|}| eine Fehlermeldung. +Dadurch soll verhindert werden, dass Sie die Optionen außer Kraft setzen, ohne +es zu merken. \begin{Example} Sie wollen nicht, dass bei Verwendung der Klasse \Class{scrbook} oder \Class{scrreprt} im Hauptteil die Kapitel mit einer Präfixzeile versehen - werden (siehe Layoutoption \Option{chapterprefix} + werden (siehe Layoutoption \DescRef{maincls.option.chapterprefix} in \autoref{sec:maincls.structure}, - \autopageref{desc:maincls.option.chapterprefix}). Damit die Konsistenz + \DescPageRef{maincls.option.chapterprefix}). Damit die Konsistenz gewahrt bleibt, wollen Sie auch nicht, dass eine solche Zeile im Anhang verwendet wird. Stattdessen soll in den Anhängen direkt vor dem Kapitelbuchstaben das Wort »Anhang« in der jeweiligen Sprache stehen. Dies soll auch für die Kolumnentitel gelten. Also verwenden Sie nicht die - Layoutoption \Option{appendixprefix}, sondern + Layoutoption \DescRef{maincls.option.appendixprefix}, sondern definieren in der Dokumentpräambel: \begin{lstcode} \newcommand*{\appendixmore}{% @@ -1658,8 +1605,8 @@ merken. \appendixname~\thechapter\autodot\enskip}} \end{lstcode} Sollten Sie später dann doch noch entscheiden, dass Sie die Option - \Option{appendixprefix} verwenden wollen, so erhalten Sie aufgrund - der dann bereits definierten Anweisung \Macro{appendixmore} eine + \DescRef{maincls.option.appendixprefix} verwenden wollen, so erhalten Sie + aufgrund der dann bereits definierten Anweisung \Macro{appendixmore} eine Fehlermeldung. Damit wird verhindert, dass obige Definition unbemerkt die Einstellungen überschreibt, die Sie per Option getroffen haben. @@ -1677,28 +1624,23 @@ merken. Die Erklärungen zu den in diesem Beispiel umdefinierten Anweisungen finden Sie in \autoref{sec:maincls.structure}, - \autopageref{desc:maincls.cmd.chapterformat} und - \autopageref{desc:maincls.cmd.chaptermarkformat}. + \DescPageRef{maincls.cmd.chapterformat} und + \DescPageRef{maincls.cmd.chaptermarkformat}. \end{Example}% % -\EndIndex{Cmd}{appendixmore}% +\EndIndexGroup % \subsection{Literaturverzeichnis} % \seclabel{bibliography} \begin{Declaration} - \Macro{newbibstyle}\OParameter{Elternstil}\Parameter{Name}%^^A - \Parameter{Anweisungen}\\ - \Macro{newblock}\\ - \Macro{@openbib@code}\\ - \Macro{bib@beginhook}\\ + \Macro{newbibstyle}\OParameter{Elternstil}\Parameter{Name}% + \Parameter{Anweisungen} + \Macro{newblock} + \Macro{@openbib@code} + \Macro{bib@beginhook} \Macro{bib@endhook} \end{Declaration} -\BeginIndex{Cmd}{newbibstyle}% -\BeginIndex{Cmd}{newblock}% -\BeginIndex{Cmd}{@openbib@code}% -\BeginIndex{Cmd}{bib@beginhook}% -\BeginIndex{Cmd}{bib@endhook}% Schon die Standardklassen\textnote{Standardklassen} kennen zur Unterteilung der Einträge in das Literaturverzeichnis die Anweisung \Macro{newblock}. Was diese Anweisung genau macht, hängt dabei von den Klassenoptionen ab. Wird die @@ -1717,9 +1659,9 @@ umdefiniert. Stattdessen wird mit \Macro{newbibstyle} der Stil \PName{Anweisungen}, die dabei in der Implementierung angegeben wurden, beinhalten die gewünschten Umdefinierung von \Macro{@openbib@code} und von \Macro{newblock}. Wird nun mit Hilfe der Option -\OptionValue{bibliography}{openstyle}% +\OptionValueRef{maincls}{bibliography}{openstyle}% \IndexOption{bibliography~=\PValue{openstyle}}% -\important{\OptionValue{bibliography}{openstyle}} dieser +\important{\OptionValueRef{maincls}{bibliography}{openstyle}} dieser Literaturverzeichnisstil gewählt, so werden die \PName{Anweisungen} unmittelbar ausgeführt, also \Macro{@openbib@code} und \Macro{newblock} umdefiniert. @@ -1730,12 +1672,12 @@ werden. Die Anweisung \Macro{bib@beginhook} wird unmittelbar nach der Überschrift und der Präambel des Literaturverzeichnisses, aber noch vor der Liste mit den Literatureinträgen ausgeführt. Die Anweisung \Macro{bib@endhook} wird direkt nach dieser Liste am Ende des Literaturverzeichnisses -ausgeführt. Im Falle eines mit \Macro{BreakBibliography} (siehe +ausgeführt. Im Falle eines mit \DescRef{maincls.cmd.BreakBibliography} (siehe \autoref{sec:maincls.bibliography}, -\autopageref{desc:maincls.cmd.BreakBibliography}) unterbrochenen +\DescPageRef{maincls.cmd.BreakBibliography}) unterbrochenen Literaturverzeichnisses werden diese Anweisungen außerdem am Anfang und Ende -jedes Teil, also unmittelbar vor und nach \Macro{BreakBibliography} -ausgeführt. +jedes Teil, also unmittelbar vor und nach +\DescRef{maincls.cmd.BreakBibliography} ausgeführt. Die Anweisungen \Macro{newblock}, \Macro{@openbib@code}, \Macro{bib@beginhook} und \Macro{bib@endhook} werden bei der Verwendung eines @@ -1749,23 +1691,24 @@ keinesfalls mit \Macro{newcommand}, sondern mit definiert werden sollten. Setzt der Anwender mit den Anweisungen -\Macro{AtEndBibliography}%\important[i]{\Macro{AtEndBibliography}\\ -% \Macro{AfterBibliographyPreamble}}% Passt blöder Weise nicht! +\DescRef{maincls.cmd.AtEndBibliography}%\important[i]{\DescRef{maincls.cmd.AtEndBibliography}\\ +% \DescRef{maincls.cmd.AfterBibliographyPreamble}}% Passt blöder Weise nicht! \IndexCmd{AtEndBibliography} und -\Macro{AfterBibliographyPreamble}\IndexCmd{AfterBibliographyPreamble} weitere -\PName{Anweisungen} für die Ausführung nach der Präambel und am Ende des -Literaturverzeichnisses, so werden die mit \Macro{AfterBibliographyPreamble} -festgelegten \PName{Anweisungen} einmalig am Anfang des -Literaturverzeichnisses nach \Macro{bib@beginhook} und die mit -\Macro{AtEndBibliography} festgelegten \PName{Anweisungen} einmalig am Ende -des Literaturverzeichnisses vor \Macro{bib@endhook} ausgeführt. +\DescRef{maincls.cmd.AfterBibliographyPreamble}% +\IndexCmd{AfterBibliographyPreamble} weitere \PName{Anweisungen} für die +Ausführung nach der Präambel und am Ende des Literaturverzeichnisses, so +werden die mit \DescRef{maincls.cmd.AfterBibliographyPreamble} festgelegten +\PName{Anweisungen} einmalig am Anfang des Literaturverzeichnisses nach +\Macro{bib@beginhook} und die mit \DescRef{maincls.cmd.AtEndBibliography} +festgelegten \PName{Anweisungen} einmalig am Ende des Literaturverzeichnisses +vor \Macro{bib@endhook} ausgeführt. Mit\textnote{Beispiel!} Hilfe des Pakets \Package{multicol}\IndexPackage{multicol}\important{\Package{multicol}} (siehe \cite{package:multicol}) könnte man beispielsweise einen Literaturstil für ein zweispaltiges Literaturverzeichnis definieren: % Umbruchkorrektur: listings korrigiert -\begin{lstcode}[belowskip=\dp\strutbox plus 1ex] +\begin{lstcode} \newbibstyle{twocolumstyle}{% \renewcommand*{\bib@beginhook}{\begin{multicols}{2}}% \renewcommand*{\bib@endhook}{\end{multicols}}}% @@ -1774,26 +1717,23 @@ Soll es außerdem eine \emph{open}-Variante davon geben, kann man hier die Möglichkeiten der Vererbung verwenden und bei der Definition einen Elternstil mit angeben: % Umbruchkorrektur: listings korrigiert -\begin{lstcode}[belowskip=\dp\strutbox plus 1ex] +\begin{lstcode} \newbibstyle{twocolumopenstyle}[openstyle]{% \renewcommand*{\bib@beginhook}{\begin{multicols}{2}}% \renewcommand*{\bib@endhook}{\end{multicols}}}% \end{lstcode} Die Auswahl eines dieser neuen Stile erfolgt dann einfach wieder über die -Option \Option{bibliography}. +Option \DescRef{maincls.option.bibliography}. % -\EndIndex{Cmd}{bib@endhook}% -\EndIndex{Cmd}{bib@beginhook}% -\EndIndex{Cmd}{@openbib@code}% -\EndIndex{Cmd}{newblock}% -\EndIndex{Cmd}{newbibstyle}% - +\EndIndexGroup \section{Mehr oder weniger obsolete Optionen und Anweisungen} \seclabel{obsolete} \LoadNonFree{scrbookreportarticle-experts}{4} +% +\EndIndexGroup \endinput @@ -1807,14 +1747,13 @@ Option \Option{bibliography}. % LocalWords: Sternvarianten Kapitelüberschrift Standardklassen Paketautoren % LocalWords: Klassenoptionen Gliederungsbefehlen Namensliste umzudefinieren - -% LocalWords: Inhaltsverzeichniseintrags Abstandsanweisungen Sternformen -% LocalWords: Teilüberschriften Benutzerfreundlichkeit Absatzmarkierung -% LocalWords: umkonfiguriert Teileüberschrift Abschnittsüberschrift -% LocalWords: Absolutwert Gliederungsbefehls Präfixzeile Schrifteinstellung -% LocalWords: Zählername Spitzmarke Kolumnentitels Schrifteinstellungen -% LocalWords: Strichstärke expandierbar expandierbaren expandierbares -% LocalWords: spartanisch Kapitelstil Spitzmarken Formatierungsanweisungen -% LocalWords: Kapitelüberschriften Gliederungsebenen Verzeichniseinträge -% LocalWords: Verzeichniseintragsstile Gliederungsbefehl Verzeichniseintrag -% LocalWords: Verzeichniseintrags Verzeichniseintragsstilen +% LocalWords: Inhaltsverzeichniseintrags Abstandsanweisungen Sternformen +% LocalWords: Teilüberschriften Benutzerfreundlichkeit Absatzmarkierung +% LocalWords: umkonfiguriert Teileüberschrift Abschnittsüberschrift +% LocalWords: Absolutwert Gliederungsbefehls Präfixzeile Schrifteinstellung +% LocalWords: Zählername Spitzmarke Kolumnentitels Schrifteinstellungen +% LocalWords: Strichstärke expandierbar expandierbaren expandierbares +% LocalWords: spartanisch Kapitelstil Spitzmarken Formatierungsanweisungen +% LocalWords: Kapitelüberschriften Gliederungsebenen Verzeichniseinträge +% LocalWords: Verzeichniseintragsstile Gliederungsbefehl Verzeichniseintrag +% LocalWords: Verzeichniseintrags Verzeichniseintragsstilen |