summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex')
-rw-r--r--macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex1677
1 files changed, 914 insertions, 763 deletions
diff --git a/macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex b/macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex
index ebc8861e1f..da1b344524 100644
--- a/macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex
+++ b/macros/latex/contrib/koma-script/source-doc/ngerman/tocbasic.tex
@@ -1,6 +1,6 @@
% ======================================================================
% tocbasic.tex
-% Copyright (c) Markus Kohm, 2002-2018
+% Copyright (c) Markus Kohm, 2002-2019
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% tocbasic.tex
-% Copyright (c) Markus Kohm, 2002-2018
+% Copyright (c) Markus Kohm, 2002-2019
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -40,13 +40,13 @@
%
% ----------------------------------------------------------------------
%
-% Paket tocbasic für Paket- und Klassenautoren
+% Paket tocbasic für Paket- und Klassenautoren
% Verwaltet von Markus Kohm
%
% ======================================================================
\KOMAProvidesFile{tocbasic.tex}
- [$Date: 2018-08-31 09:11:20 +0200 (Fri, 31 Aug 2018) $
+ [$Date: 2019-10-09 15:19:04 +0200 (Wed, 09 Oct 2019) $
KOMA-Script guide (package tocbasic)]
\chapter{Verzeichnisse verwalten mit Hilfe von \Package{tocbasic}}
@@ -58,60 +58,60 @@
\BeginIndex{}{Dateierweiterung}%
\index{Dateiendung|see{Dateierweiterung}}%|
Der Hauptzweck des Pakets \Package{tocbasic} besteht darin, Paket- und
-Klassenautoren die Möglichkeit zu geben, eigene Verzeichnisse vergleichbar mit
+Klassenautoren die Möglichkeit zu geben, eigene Verzeichnisse vergleichbar mit
dem Abbildungs- und Tabellenverzeichnis zu erstellen und dabei Klassen und
-anderen Paketen einen Teil der Kontrolle über diese Verzeichnisse zu
-erlauben. Dabei sorgt das Paket \Package{tocbasic} auch dafür, dass diese
+anderen Paketen einen Teil der Kontrolle über diese Verzeichnisse zu
+erlauben. Dabei sorgt das Paket \Package{tocbasic} auch dafür, dass diese
Verzeichnisse von \Package{babel}\IndexPackage{babel} (siehe
-\cite{package:babel}) bei der Sprachumschaltung mit berücksichtigt
-werden. Durch Verwendung von \Package{tocbasic} soll dem Paketautor die Mühe
+\cite{package:babel}) bei der Sprachumschaltung mit berücksichtigt
+werden. Durch Verwendung von \Package{tocbasic} soll dem Paketautor die Mühe
genommen werden, selbst solche Anpassungen an andere Pakete oder an Klassen
-vornehmen zu müssen.
+vornehmen zu müssen.
Als kleiner Nebeneffekt kann das Paket auch verwendet werden, um neue
-Gleitumgebungen oder den Gleitumgebungen ähnliche nicht gleitende Umgebungen
-für Konsultationsobjekte zu definieren. Näheres dazu wird nach der Erklärung
+Gleitumgebungen oder den Gleitumgebungen ähnliche nicht gleitende Umgebungen
+für Konsultationsobjekte zu definieren. Näheres dazu wird nach der Erklärung
der grundlegenden Anweisungen in den folgenden vier Abschnitten durch ein
Beispiel in \autoref{sec:tocbasic.example} verdeutlicht, das in kompakter Form
noch einmal in \autoref{sec:tocbasic.declarenewtoc} aufgegriffen wird.
-\KOMAScript{} verwendet \Package{tocbasic} sowohl für das Inhaltsverzeichnis
-als auch für die bereits erwähnten Verzeichnisse für Abbildungen und Tabellen.
+\KOMAScript{} verwendet \Package{tocbasic} sowohl für das Inhaltsverzeichnis
+als auch für die bereits erwähnten Verzeichnisse für Abbildungen und Tabellen.
\section{Grundlegende Anweisungen}
\seclabel{basics}
Die grundlegenden Anweisungen dienen in erster Linie dazu, eine Liste aller
-bekannten Dateierweiterungen\textnote{Dateierweiterung, Verzeichnis}, die für
-Verzeichnisse stehen, zu verwalten. Einträge in Dateien mit solchen
+bekannten Dateierweiterungen\textnote{Dateierweiterung, Verzeichnis}, die für
+Verzeichnisse stehen, zu verwalten. Einträge in Dateien mit solchen
Dateierweiterungen werden typischerweise mit
\Macro{addtocontents}\important{\Macro{addtocontents},
\DescRef{\LabelBase.cmd.addxcontentsline}} oder
-\DescRef{\LabelBase.cmd.addxcontentsline} vorgenommen. Darüber hinaus gibt es
-Anweisungen, mit denen Aktionen für all diese Dateierweiterungen durchgeführt
-werden können. Außerdem gibt es Anweisungen, um Einstellungen für die Datei
-vorzunehmen, die zu einer gegebenen Dateierweiterung gehört. Typischerweise
+\DescRef{\LabelBase.cmd.addxcontentsline} vorgenommen. Darüber hinaus gibt es
+Anweisungen, mit denen Aktionen für all diese Dateierweiterungen durchgeführt
+werden können. Außerdem gibt es Anweisungen, um Einstellungen für die Datei
+vorzunehmen, die zu einer gegebenen Dateierweiterung gehört. Typischerweise
hat so eine Dateierweiterung auch einen
Besitzer\textnote{Dateibesitzer}. Dieser Besitzer kann eine Klasse oder ein
-Paket oder ein Bezeichner sein, den der Autor der Klasse oder des Pakets, das
-\Package{tocbasic} verwendet, frei gewählt hat. \KOMAScript{} selbst verwendet
-beispielsweise den Besitzer \PValue{float} für die Dateierweiterungen
-\File{lof} und \File{lot}, die für das Abbildungs- und das Tabellenverzeichnis
-stehen. Für das Inhaltsverzeichnis verwendet \KOMAScript{} als Besitzer den
-Dateinamen der Klasse.
+Paket oder die Bezeichnung einer Kategorie sein, die der Autor der Klasse oder
+des Pakets, das \Package{tocbasic} verwendet, frei gewählt hat. \KOMAScript{}
+selbst verwendet beispielsweise die Kategorie \PValue{float} für die
+Dateierweiterungen \File{lof} und \File{lot}, die für das Abbildungs- und das
+Tabellenverzeichnis stehen. Für das Inhaltsverzeichnis verwendet \KOMAScript{}
+als Besitzer den Dateinamen der Klasse.
\begin{Declaration}
\Macro{ifattoclist}\Parameter{Dateierweiterung}
\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
-Mit dieser Anweisung wird überprüft, ob die \PName{Dateierweiterung} bereits
+Mit dieser Anweisung wird überprüft, ob die \PName{Dateierweiterung} bereits
in der Liste der bekannten Dateierweiterungen vorhanden ist oder nicht. Ist
-die \PName{Dateierweiterung} bereits über diese Liste bekannt, so wird der
-\PName{Dann-Teil} ausgeführt. Anderenfalls wird der \PName{Sonst-Teil}
-ausgeführt.
+die \PName{Dateierweiterung} bereits über diese Liste bekannt, so wird der
+\PName{Dann-Teil} ausgeführt. Anderenfalls wird der \PName{Sonst-Teil}
+ausgeführt.
\begin{Example}
- Angenommen, Sie wollen wissen, ob die Dateierweiterung »\File{foo}« bereits
+ Angenommen, Sie wollen wissen, ob die Dateierweiterung »\File{foo}« bereits
verwendet wird, um in diesem Fall eine Fehlermeldung auszugeben, weil diese
damit nicht mehr verwendet werden kann:
\begin{lstcode}
@@ -136,34 +136,34 @@ ausgeführt.
\begin{Declaration}
\Macro{addtotoclist}\OParameter{Besitzer}\Parameter{Dateierweiterung}
\end{Declaration}
-Diese Anweisung fügt die \PName{Dateierweiterung} der Liste der bekannten
+Diese Anweisung fügt die \PName{Dateierweiterung} der Liste der bekannten
Dateierweiterungen hinzu. Ist die \PName{Dateierweiterung} bereits bekannt, so
wird hingegen ein Fehler gemeldet, um die doppelte Verwendung derselben
\PName{Dateierweiterung} zu verhindern.
Wenn das optionale Argument \OParameter{Besitzer} angegeben wurde, wird der
-angegebene \PName{Besitzer} für diese Dateierweiterung mit gespeichert. Wurde
+angegebene \PName{Besitzer} für diese Dateierweiterung mit gespeichert. Wurde
das optionale Argument weggelassen, dann versucht \Package{tocbasic} den
Dateinamen der aktuell abgearbeiteten Klasse oder des Pakets herauszufinden
und als \PName{Besitzer} zu speichern. Dies\textnote{Achtung!} funktioniert
-nur, wenn \Macro{addtotoclist} während des Ladens der Klasse oder des Pakets
-aufgerufen wird. Es funktioniert nicht, wenn \Macro{addtotoclist} erst später
+nur, wenn \Macro{addtotoclist} während des Ladens der Klasse oder des Pakets
+aufgerufen wird. Es funktioniert nicht, wenn \Macro{addtotoclist} erst später
aufgrund der Verwendung einer Anweisung durch den Benutzer aufgerufen wird. In
-diesem Fall wird als \PName{Besitzer} »\PValue{.}« eingetragen.
+diesem Fall wird als \PName{Besitzer} »\PValue{.}« eingetragen.
Beachten\textnote{Achtung!} Sie, dass ein leeres Argument \PName{Besitzer}
nicht das Gleiche ist wie das Weglassen des kompletten optionalen Arguments
-einschließlich der eckigen Klammern. Ein leeres Argument würde auch einen
+einschließlich der eckigen Klammern. Ein leeres Argument würde auch einen
leeren \PName{Besitzer} ergeben.
\begin{Example}
- Angenommen, Sie wollen die Dateierweiterung »\File{foo}« der Liste der
- bekannten Dateierweiterungen hinzufügen, während Ihr Paket mit dem
- Dateinamen »\File{bar.sty}« geladen wird:
+ Angenommen, Sie wollen die Dateierweiterung »\File{foo}« der Liste der
+ bekannten Dateierweiterungen hinzufügen, während Ihr Paket mit dem
+ Dateinamen »\File{bar.sty}« geladen wird:
\begin{lstcode}
\addtotoclist{foo}
\end{lstcode}
- Dies fügt die Dateierweiterung »\PValue{foo}« mit dem Besitzer
- »\PValue{bar.sty}« der Liste der bekannten Dateierweiterung hinzu, wenn diese
+ Dies fügt die Dateierweiterung »\PValue{foo}« mit dem Besitzer
+ »\PValue{bar.sty}« der Liste der bekannten Dateierweiterung hinzu, wenn diese
Erweiterung nicht bereits in der Liste ist. Wenn die verwendete
Klasse oder ein anderes Paket diese Dateierweiterung schon angemeldet hat,
erhalten Sie den Fehler:
@@ -173,8 +173,8 @@ leeren \PName{Besitzer} ergeben.
See the tocbasic package documentation for explanation.
Type H <return> for immediate help.
\end{lstoutput}
- Wenn Sie dann tatsächlich die Taste »\texttt{H}«, gefolgt von der
- Return-Taste drücken, erhalten Sie als Hilfe:
+ Wenn Sie dann tatsächlich die Taste »\texttt{H}«, gefolgt von der
+ Return-Taste drücken, erhalten Sie als Hilfe:
\begin{lstoutput}
File extension `foo' is already used by a toc-file, while bar.sty
tried to use it again for a toc-file.
@@ -190,75 +190,75 @@ leeren \PName{Besitzer} ergeben.
\newcommand*{\createnewlistofsomething}[1]{%
\addtotoclist[bar.sty]{#1}%
% Weitere Aktionen, um dieses Verzeichnis
- % verfügbar zu machen
+ % verfügbar zu machen
}
\end{lstcode}
Wenn jetzt der Anwender diese Anweisung aufruft, beispielsweise mit
\begin{lstcode}
\createnewlistofsomething{foo}
\end{lstcode}
- dann wird die Dateierweiterung »\PValue{foo}« ebenfalls mit dem Besitzer
- »\PValue{bar.sty}« zur Liste der bekannten Dateierweiterungen hinzugefügt
+ dann wird die Dateierweiterung »\PValue{foo}« ebenfalls mit dem Besitzer
+ »\PValue{bar.sty}« zur Liste der bekannten Dateierweiterungen hinzugefügt
oder aber ein Fehler gemeldet, wenn diese Dateierweiterung bereits verwendet
wird.
\end{Example}
-Sie können als \PName{Besitzer} angeben, was immer Sie wollen, aber es sollte
+Sie können als \PName{Besitzer} angeben, was immer Sie wollen, aber es sollte
eindeutig sein! Wenn Sie beispielsweise der Autor des Pakets \Package{float}
-wären, könnten Sie als \PName{Besitzer} auch »\PValue{float}« anstelle von
-»\PValue{float.sty}« angeben. In diesem Fall würden die
+wären, könnten Sie als \PName{Besitzer} auch die Kategorie »\PValue{float}«
+anstelle von »\PValue{float.sty}« angeben. In diesem Fall würden die
\KOMAScript-Optionen\important{\DescRef{maincls.option.listof}}%
-\IndexOption{listof~=\PName{Einstellung}} für das Verzeichnis der Abbildungen
+\IndexOption{listof~=\PName{Einstellung}} für das Verzeichnis der Abbildungen
und das Verzeichnis der Tabellen auch Ihre Verzeichnisse betreffen, die zum
Zeitpunkt der Verwendung der jeweiligen Option bereits zur Liste der bekannten
-Dateierweiterungen hinzugefügt sind. Das liegt daran, dass \KOMAScript{} die
-Dateierweiterungen »\PValue{lof}« für das Abbildungsverzeichnis und
-»\PValue{lot}« für das Tabellenverzeichnis mit dem Besitzer »\PValue{float}«
-anmeldet und die Optionen für diese Besitzer setzt.
+Dateierweiterungen hinzugefügt sind. Das liegt daran, dass \KOMAScript{} die
+Dateierweiterungen »\PValue{lof}« für das Abbildungsverzeichnis und
+»\PValue{lot}« für das Tabellenverzeichnis mit der Kategorie »\PValue{float}«
+als \PName{Besitzer} anmeldet und die Optionen für diesen Besitzer setzt.
Das Paket \hyperref[cha:scrhack]{\Package{scrhack}}\IndexPackage{scrhack}%
-\important{ \hyperref[cha:scrhack]{\Package{scrhack}}} enthält übrigens
-Patches für mehrere Pakete wie \Package{float} oder \Package{listings}, die
+\important{ \hyperref[cha:scrhack]{\Package{scrhack}}} enthält übrigens
+Patches für mehrere Pakete wie \Package{float} oder \Package{listings}, die
eigene Verzeichnisse bereitstellen. Bei Verwendung von
\hyperref[cha:scrhack]{\Package{scrhack}} wird dann unter anderem die
jeweilige Dateierweiterung der Liste der bekannten Dateierweiterungen
-hinzugefügt. Dabei wird als \PName{Besitzer} ebenfalls »\PValue{float}«
-verwendet. Dies ist sozusagen der grundlegende Baustein, um die Möglichkeiten
-von \Package{tocbasic} und der \KOMAScript-Klassen auch für diese
-Verzeichnisse nutzen zu können.%
+hinzugefügt. Dabei wird als \PName{Besitzer} ebenfalls »\PValue{float}«
+verwendet. Dies ist sozusagen der grundlegende Baustein, um die Möglichkeiten
+von \Package{tocbasic} und der \KOMAScript-Klassen auch für diese
+Verzeichnisse nutzen zu können.%
\EndIndexGroup
\begin{Declaration}
\Macro{AtAddToTocList}\OParameter{Besitzer}\Parameter{Anweisungen}
\end{Declaration}
-Auf diese Weise können die \PName{Anweisungen} zu einer internen Liste von
-Anweisungen hinzugefügt werden, die immer dann auszuführen sind, wenn eine
+Auf diese Weise können die \PName{Anweisungen} zu einer internen Liste von
+Anweisungen hinzugefügt werden, die immer dann auszuführen sind, wenn eine
Dateierweiterung mit dem angegebenen \PName{Besitzer} zur Liste der bekannten
-Dateierweiterungen hinzugefügt wird. Bezüglich des optionalen Arguments wird
-wie in der Erklärung von \DescRef{\LabelBase.cmd.addtotoclist} beschrieben
+Dateierweiterungen hinzugefügt wird. Bezüglich des optionalen Arguments wird
+wie in der Erklärung von \DescRef{\LabelBase.cmd.addtotoclist} beschrieben
verfahren. Wird das optionale Argument leer gelassen, werden in diesem Fall
-die Aktionen unabhängig vom Besitzer immer ausgeführt, wenn die
-Dateierweiterung zu der Liste der bekannten Dateierweiterungen hinzugefügt
-wird. Während der Ausführung der \PName{Anweisungen} ist außerdem
+die Aktionen unabhängig vom Besitzer immer ausgeführt, wenn die
+Dateierweiterung zu der Liste der bekannten Dateierweiterungen hinzugefügt
+wird. Während der Ausführung der \PName{Anweisungen} ist außerdem
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
-Dateierweiterung, die gerade hinzugefügt wird.
+Dateierweiterung, die gerade hinzugefügt wird.
\begin{Example}
\Package{tocbasic} selbst verwendet
- % Umbruchkorrektur (schließende Klammer verschoben)
+ % Umbruchkorrektur (schließende Klammer verschoben)
\begin{lstcode}
\AtAddToTocList[]{%
\expandafter\tocbasic@extend@babel
\expandafter{\@currext}}
\end{lstcode}
um jede Dateierweiterung zu der in \Package{tocbasic} vorhandenen
- Erweiterung für das Paket \Package{babel} hinzuzufügen.
+ Erweiterung für das Paket \Package{babel} hinzuzufügen.
\end{Example}
Die\textnote{Achtung!} zweimalige Verwendung von \Macro{expandafter} ist im
Beispiel erforderlich, weil das Argument von
\DescRef{\LabelBase.cmd.tocbasic@extend@babel} zwingend bereits expandiert
-sein muss. Siehe dazu auch die Erklärung zu
+sein muss. Siehe dazu auch die Erklärung zu
\DescRef{\LabelBase.cmd.tocbasic@extend@babel} in
\autoref{sec:tocbasic.internals},
\DescPageRef{\LabelBase.cmd.tocbasic@extend@babel}.
@@ -271,28 +271,28 @@ sein muss. Siehe dazu auch die Erklärung zu
\end{Declaration}
Man kann eine \PName{Dateierweiterung} auch wieder aus der Liste der bekannten
Dateierweiterungen entfernen. Ist das optionale Argument \OParameter{Besitzer}
-angegeben, so wird die Dateierweiterung nur entfernt, wenn sie für den
+angegeben, so wird die Dateierweiterung nur entfernt, wenn sie für den
angegebenen \PName{Besitzer} angemeldet wurde. Wie der Besitzer beim Weglassen
-des optionalen Argument bestimmt wird, ist der Erklärung zu
+des optionalen Argument bestimmt wird, ist der Erklärung zu
\DescRef{\LabelBase.cmd.addtotoclist} zu entnehmen. Wird ein leerer
\PName{Besitzer} angegeben, findet kein Besitzertest statt, sondern die
-\PName{Dateierweiterung} wird unabhängig vom Besitzer entfernt.%
+\PName{Dateierweiterung} wird unabhängig vom Besitzer entfernt.%
\EndIndexGroup
\begin{Declaration}
\Macro{doforeachtocfile}\OParameter{Besitzer}\Parameter{Anweisungen}
\end{Declaration}
-Bisher haben Sie nur Anweisungen kennengelernt, die für Klassen- und
-Paketautoren zwar zusätzliche Sicherheit, aber auch eher zusätzlichen Aufwand
-bedeuten. Mit \Macro{doforeachtocfile} kann man die erste Ernte dafür
-einfahren. Diese Anweisung erlaubt es die angegebenen \PName{Anweisungen} für
-jede von dem \PName{Besitzer} angemeldete Dateierweiterung
-auszuführen. Während der Ausführung der \PName{Anweisungen} ist
+Bisher haben Sie nur Anweisungen kennengelernt, die für Klassen- und
+Paketautoren zwar zusätzliche Sicherheit, aber auch eher zusätzlichen Aufwand
+bedeuten. Mit \Macro{doforeachtocfile} kann man die erste Ernte dafür
+einfahren. Diese Anweisung erlaubt es die angegebenen \PName{Anweisungen} für
+jede mit dem \PName{Besitzer} angemeldete Dateierweiterung
+auszuführen. Während der Ausführung der \PName{Anweisungen} ist
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die aktuell
verarbeitete Dateierweiterung. Wird das optionale Argument
\OParameter{Besitzer} weggelassen, so werden alle Dateierweiterungen
-unabhängig vom Besitzer abgearbeitet. Ein leeres optionales Argument würde
+unabhängig vom Besitzer abgearbeitet. Ein leeres optionales Argument würde
hingegen nur die Dateierweiterungen mit leerem Besitzer verarbeiten.
\begin{Example}
Wenn Sie die Liste aller bekannten Dateierweiterungen auf das Terminal und
@@ -300,16 +300,16 @@ hingegen nur die Dateierweiterungen mit leerem Besitzer verarbeiten.
\begin{lstcode}
\doforeachtocfile{\typeout{\@currext}}
\end{lstcode}
- möglich. Sollen hingegen nur die Dateierweiterungen des Besitzer
- »\PValue{foo}« ausgegeben werden, geht das einfach mit:
+ möglich. Sollen hingegen nur die Dateierweiterungen des Besitzer
+ »\PValue{foo}« ausgegeben werden, geht das einfach mit:
\begin{lstcode}
\doforeachtocfile[foo]{\typeout{\@currext}}
\end{lstcode}
\end{Example}
Die \KOMAScript-Klassen \Class{scrbook} und \Class{scrreprt} verwenden die
-Anweisung, um für Verzeichnisse, für die Eigenschaft \PValue{chapteratlist}
-gesetzt ist, optional einen vertikalen Abstand oder die Kapitelüberschrift in
-das Verzeichnis einzutragen. Wie Sie diese Eigenschaft setzen können, ist
+Anweisung, um für Verzeichnisse, für die Eigenschaft \PValue{chapteratlist}
+gesetzt ist, optional einen vertikalen Abstand oder die Kapitelüberschrift in
+das Verzeichnis einzutragen. Wie Sie diese Eigenschaft setzen können, ist
in \autoref{sec:tocbasic.toc} ab \DescPageRef{\LabelBase.cmd.setuptoc} zu
finden.%
\EndIndexGroup
@@ -318,22 +318,22 @@ finden.%
\begin{Declaration}
\Macro{tocbasicautomode}
\end{Declaration}
-Diese Anweisung definiert das vom \LaTeX-Kern für Klassen- und Paketautoren
+Diese Anweisung definiert das vom \LaTeX-Kern für Klassen- und Paketautoren
bereitgestellte
\Macro{@starttoc}\IndexCmd{@starttoc}\important{\Macro{\@starttoc}} so um,
dass bei jedem Aufruf von \Macro{@starttoc} die dabei angegebene
-Dateierweiterung in die Liste der bekannten Dateierweiterungen eingefügt wird,
-soweit sie dort noch nicht vorhanden ist. Außerdem wird dann
+Dateierweiterung in die Liste der bekannten Dateierweiterungen eingefügt wird,
+soweit sie dort noch nicht vorhanden ist. Außerdem wird dann
\DescRef{\LabelBase.cmd.tocbasic@starttoc} anstelle von \Macro{@starttoc}
-verwendet. Näheres zu \DescRef{\LabelBase.cmd.tocbasic@starttoc} und
+verwendet. Näheres zu \DescRef{\LabelBase.cmd.tocbasic@starttoc} und
\Macro{@starttoc} ist \autoref{sec:tocbasic.internals},
\DescPageRef{\LabelBase.cmd.tocbasic@starttoc} zu entnehmen.
Mit Hilfe von \Macro{tocbasicautomode} wird also jedes Verzeichnis, das mit
Hilfe von \Macro{@starttoc} erstellt wird, automatisch unter die Kontrolle von
-\Package{tocbasic} gestellt. Ob das zum gewünschten Ergebnis führt, hängt
+\Package{tocbasic} gestellt. Ob das zum gewünschten Ergebnis führt, hängt
jedoch sehr von den jeweiligen Verzeichnissen ab. Immerhin funktioniert damit
-schon einmal die Erweiterung für das \Package{babel}-Paket für alle
+schon einmal die Erweiterung für das \Package{babel}-Paket für alle
Verzeichnisse. Es ist jedoch vorzuziehen, wenn der Paketautor selbst
\Package{tocbasic} explizit verwendet. Er kann dann auch die weiteren Vorteile
nutzen, die ihm das Paket bietet und die in den nachfolgenden Abschnitten
@@ -346,10 +346,10 @@ beschrieben werden.%
Im vorherigen Abschnitt haben Sie erfahren, wie eine Liste bekannter
Dateierweiterungen verwaltet werden kann\iffree{ und wie automatisch Anweisungen
- beim Hinzufügen von Dateierweiterungen zu dieser Liste ausgeführt werden
- können}{}. Des Weiteren haben Sie eine Anweisung kennengelernt, mit der man
-für jede einzelne bekannte Dateierweiterung oder einen spezifischen Teil davon
-Anweisungen ausführen kann. In diesem Abschnitt werden Sie Anweisungen
+ beim Hinzufügen von Dateierweiterungen zu dieser Liste ausgeführt werden
+ können}{}. Des Weiteren haben Sie eine Anweisung kennengelernt, mit der man
+für jede einzelne bekannte Dateierweiterung oder einen spezifischen Teil davon
+Anweisungen ausführen kann. In diesem Abschnitt werden Sie Anweisungen
kennenlernen, die sich auf die Datei beziehen, die mit dieser Dateierweiterung
verbunden ist.
@@ -363,8 +363,8 @@ Die Anweisung \Macro{addtoeachtocfile} schreibt \PName{Inhalt} mit Hilfe von
\PName{Besitzer} in der Liste der bekannten Dateierweiterungen \iffree{zu
finden ist}{steht}. Wird das optionale Argument weggelassen, wird in jede
Datei aus der Liste der bekannten Dateierweiterungen geschrieben.\iffree{ Der
- konkrete Dateiname setzt sich dabei übrigens aus \Macro{jobname} und der
- Dateierweiterung zusammen.}{} Während des Schreibens von \PName{Inhalt} ist
+ konkrete Dateiname setzt sich dabei übrigens aus \Macro{jobname} und der
+ Dateierweiterung zusammen.}{} Während des Schreibens von \PName{Inhalt} ist
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
Dateierweiterung der Datei, in die aktuell geschrieben wird.
\begin{Example}
@@ -375,8 +375,8 @@ Dateierweiterung der Datei, in die aktuell geschrieben wird.
\protect\addvspace{\protect\baselineskip}%
}%
\end{lstcode}
- Wenn Sie das hingegen nur für die Dateien mit dem definierten Besitzer
- »\PValue{foo}« machen wollen, verwenden Sie:
+ Wenn Sie das hingegen nur für die Dateien mit dem definierten Besitzer
+ »\PValue{foo}« machen wollen, verwenden Sie:
\begin{lstcode}
\addtoeachtocfile[foo]{%
\protect\addvspace{\protect\baselineskip}%
@@ -385,7 +385,7 @@ Dateierweiterung der Datei, in die aktuell geschrieben wird.
\end{Example}%
\iffree{Anweisungen, die nicht bereits beim Schreiben expandiert werden
sollen, sind wie bei \Macro{addtocontents} mit \Macro{protect} zu
- schützen.}{}%
+ schützen.}{}%
\EndIndexGroup
@@ -393,38 +393,38 @@ Dateierweiterung der Datei, in die aktuell geschrieben wird.
\Macro{addxcontentsline}\Parameter{Dateierweiterung}\Parameter{Ebene}
\OParameter{Gliederungsnummer}\Parameter{Inhalt}
\end{Declaration}
-Diese\ChangedAt{v3.12}{\Package{tocbasic}} Anweisung ähnelt sehr der Anweisung
+Diese\ChangedAt{v3.12}{\Package{tocbasic}} Anweisung ähnelt sehr der Anweisung
\Macro{addcontentsline}\IndexCmd{addcontentsline} aus dem
-\LaTeX-Kern. Allerdings besitzt sie ein zusätzliches optionales Argument für
-die \PName{Gliederungsnummer} des Eintrags, während diese bei
+\LaTeX-Kern. Allerdings besitzt sie ein zusätzliches optionales Argument für
+die \PName{Gliederungsnummer} des Eintrags, während diese bei
\Macro{addcontentsline} im Argument \PName{Inhalt} mit angegeben wird. Sie
-wird verwendet, um nummerierte oder nicht nummerierte Einträge in das über die
+wird verwendet, um nummerierte oder nicht nummerierte Einträge in das über die
\PName{Dateierweiterung} spezifizierte Verzeichnis aufzunehmen. Dabei ist
\PName{Ebene} der symbolische Name der Gliederungsebene und \PName{Inhalt} der
entsprechende Eintrag. Die Seitenzahl wird automatisch bestimmt.
Im Unterschied zu \Macro{addcontentsline} testet \Macro{addxcontentsline}
-zunächst, ob Anweisung \Macro{add\PName{Ebene}\PName{Dateierweiterung}entry}
-definiert ist. In diesem Fall wird sie für den Eintrag verwendet, wobei
+zunächst, ob Anweisung \Macro{add\PName{Ebene}\PName{Dateierweiterung}entry}
+definiert ist. In diesem Fall wird sie für den Eintrag verwendet, wobei
\PName{Gliederungsnummer} als optionales Argument und \PName{Inhalt} als
-obligatorisches Argument übergeben wird. Ein Beispiel für eine solche
-Anweisung, die von den \KOMAScript-Klassen bereitgestellt wird, wäre
+obligatorisches Argument übergeben wird. Ein Beispiel für eine solche
+Anweisung, die von den \KOMAScript-Klassen bereitgestellt wird, wäre
\DescRef{maincls-experts.cmd.addparttocentry} (siehe
-\autoref{sec:maincls-experts.experts},
+\autoref{sec:maincls-experts.toc},
\DescPageRef{maincls-experts.cmd.addparttocentry}). Ist die entsprechende
Anweisung nicht definiert, wird stattdessen die interne Anweisung
-\DescRef{\LabelBase.cmd.tocbasic@addxcontentsline} verwendet. Diese erhält
+\DescRef{\LabelBase.cmd.tocbasic@addxcontentsline} verwendet. Diese erhält
alle vier Argumente als obligatorische Argumente und verwendet dann
-seinerseits \Macro{addcontentsline}, um den gewünschten Eintrag
-vorzunehmen. Näheres zu \DescRef{\LabelBase.cmd.tocbasic@addxcontentsline} ist
+seinerseits \Macro{addcontentsline}, um den gewünschten Eintrag
+vorzunehmen. Näheres zu \DescRef{\LabelBase.cmd.tocbasic@addxcontentsline} ist
\autoref{sec:tocbasic.internals},
\DescPageRef{\LabelBase.cmd.tocbasic@addxcontentsline} zu entnehmen.
-Ein Vorteil der Verwendung von \Macro{addxcontentsline} gegenüber
+Ein Vorteil der Verwendung von \Macro{addxcontentsline} gegenüber
\Macro{addcontentsline} ist zum einen, dass die Eigenschaft
\PValue{numberline} (siehe \DescPageRef{\LabelBase.cmd.setuptoc}) beachtet
-wird. Zum anderen kann die Form der Einträge über die Definition
-entsprechender, für die \PName{Ebene} und \PName{Dateierweiterung}
+wird. Zum anderen kann die Form der Einträge über die Definition
+entsprechender, für die \PName{Ebene} und \PName{Dateierweiterung}
spezifischer Anweisungen konfiguriert werden.%
%
\EndIndexGroup
@@ -438,7 +438,7 @@ spezifischer Anweisungen konfiguriert werden.%
\Macro{addcontentslinetoeachtocfile}\OParameter{Besitzer}
\Parameter{Ebene}\Parameter{Inhalt}%
\end{Declaration}
-Diese beiden Anweisungen stehen in direkter Beziehung zu dem oben erklärten
+Diese beiden Anweisungen stehen in direkter Beziehung zu dem oben erklärten
\DescRef{\LabelBase.cmd.addxcontentsline}\ChangedAt{v3.12}{\Package{tocbasic}}
beziehungsweise zum im \LaTeX-Kern definierten \Macro{addcontentsline}. Der
Unterschied besteht darin, dass diese Anweisungen \PName{Inhalt} nicht nur in
@@ -448,26 +448,26 @@ Dateien aus der Liste der bekannten Dateierweiterungen schreibt.
\begin{Example}
Angenommen, Sie sind Klassen-Autor und wollen den Kapiteleintrag nicht nur in
das Inhaltsverzeichnis, sondern in alle Verzeichnisdateien schreiben. Nehmen
- wir weiter an, dass aktuell \PValue{\#1} den Titel enthält, der geschrieben
+ wir weiter an, dass aktuell \PValue{\#1} den Titel enthält, der geschrieben
werden soll.
\begin{lstcode}
\addxcontentslinetoeachtocfile{chapter}%
[\thechapter]{#1}
\end{lstcode}
- In diesem Fall soll natürlich die aktuelle Kapitelnummer direkt beim
+ In diesem Fall soll natürlich die aktuelle Kapitelnummer direkt beim
Schreiben in die Verzeichnisdatei expandiert werden, weshalb sie nicht mit
- \Macro{protect} vor der Expansion geschützt wurde.
+ \Macro{protect} vor der Expansion geschützt wurde.
\end{Example}
-Während des Schreibens von \PName{Inhalt} ist auch hier, wie schon bei
+Während des Schreibens von \PName{Inhalt} ist auch hier, wie schon bei
\DescRef{\LabelBase.cmd.addtoeachtocfile},
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
Dateierweiterung der Datei, in die aktuell geschrieben wird.%
Die Anweisung\ChangedAt{v3.12}{\Package{tocbasic}}
-\Macro{addxcontentslinetoeachtocfile} ist wann immer möglich gegenüber
+\Macro{addxcontentslinetoeachtocfile} ist wann immer möglich gegenüber
\Macro{addcontentslinetoeachtocfile} vorzuziehen, da die Erweiterungen von
-\DescRef{\LabelBase.cmd.addxcontentsline} nur damit Anwendung finden. Näheres
-zu diesen Erweiterungen und Vorteilen ist in der vorausgehenden Erklärung von
+\DescRef{\LabelBase.cmd.addxcontentsline} nur damit Anwendung finden. Näheres
+zu diesen Erweiterungen und Vorteilen ist in der vorausgehenden Erklärung von
\DescRef{\LabelBase.cmd.addxcontentsline} zu finden.%
%
\EndIndexGroup
@@ -481,12 +481,12 @@ zu diesen Erweiterungen und Vorteilen ist in der vorausgehenden Erklärung von
\end{Declaration}
Mit diesen Anweisungen werden die Verzeichnisse
ausgegeben. Die\important{\Macro{listoftoc*}} Sternvariante \Macro{listoftoc*}
-benötigt als einziges Argument die \PName{Dateierweiterung} der Datei mit den
-Daten zu dem Verzeichnis. Die Anweisung setzt zunächst die vertikalen und
-horizontalen Abstände, die innerhalb von Verzeichnissen gelten sollen, führt
-die Anweisungen aus, die vor dem Einlesen der Datei ausgeführt werden sollen,
-liest dann die Datei und führt zum Schluss die Anweisungen aus, die nach dem
-Einlesen der Datei ausgeführt werden sollen. Damit kann \Macro{listoftoc*} als
+benötigt als einziges Argument die \PName{Dateierweiterung} der Datei mit den
+Daten zu dem Verzeichnis. Die Anweisung setzt zunächst die vertikalen und
+horizontalen Abstände, die innerhalb von Verzeichnissen gelten sollen, führt
+die Anweisungen aus, die vor dem Einlesen der Datei ausgeführt werden sollen,
+liest dann die Datei und führt zum Schluss die Anweisungen aus, die nach dem
+Einlesen der Datei ausgeführt werden sollen. Damit kann \Macro{listoftoc*} als
direkter Ersatz der \LaTeX-Kern-Anweisung
\Macro{@starttoc}\IndexCmd{@starttoc}\important{\Macro{@starttoc}} verstanden
werden.
@@ -494,38 +494,38 @@ werden.
Die\important{\Macro{listoftoc}} Version von \Macro{listoftoc} ohne Stern
setzt das komplette Verzeichnis und veranlasst auch einen optionalen Eintrag
in das Inhaltsverzeichnis und den Kolumnentitel. Ist das optionale Argument
-\OParameter{Titel} gegeben, so wird diese Angabe sowohl als Überschrift als
+\OParameter{Titel} gegeben, so wird diese Angabe sowohl als Ãœberschrift als
auch als optionaler Eintrag in das Inhaltsverzeichnis und den Kolumnentitel
verwendet. Ist das Argument \PName{Titel} lediglich leer, so wird auch eine
leere Angabe verwendet. Wird\textnote{Achtung!} hingegen das komplette
-Argument einschließlich der eckigen Klammern weggelassen, so wird die
+Argument einschließlich der eckigen Klammern weggelassen, so wird die
Anweisung \Macro{listof\PName{Dateierweiterung}name} verwendet, wenn diese
definiert ist. Ist sie nicht definiert, wird ein Standard-Ersatzname verwendet
und eine Warnung ausgegeben.
Die\important{\Macro{listofeachtoc}} Anweisung \Macro{listofeachtoc} gibt alle
-Verzeichnisse des angegebenen Besitzers oder alle Verzeichnisse aller
+Verzeichnisse mit dem angegebenen Besitzer oder alle Verzeichnisse aller
bekannten Dateinamenerweiterungen aus. Dabei\textnote{Achtung!} sollte
\Macro{listof\PName{Dateierweiterung}name} definiert sein, damit der korrekte
Titel ausgegeben werden kann.
Da\textnote{Tipp!} eventuell auch der Anwender selbst
\Macro{listoftoc} ohne optionales Argument oder \Macro{listofeachtoc} verwenden
-könnte, wird empfohlen \Macro{listof\PName{Dateierweiterung}name} immer
+könnte, wird empfohlen \Macro{listof\PName{Dateierweiterung}name} immer
passend zu definieren.
\begin{Example}
- Angenommen, Sie haben ein neues »Verzeichnis der Algorithmen« mit der
- Dateierweiterung »\PValue{loa}« und wollen dieses anzeigen lassen:
+ Angenommen, Sie haben ein neues »Verzeichnis der Algorithmen« mit der
+ Dateierweiterung »\PValue{loa}« und wollen dieses anzeigen lassen:
\begin{lstcode}
\listoftoc[Verzeichnis der Algorithmen]{loa}
\end{lstcode}
- erledigt das für Sie. Wollen Sie das Verzeichnis hingegen ohne Überschrift
- ausgegeben haben, dann genügt:
+ erledigt das für Sie. Wollen Sie das Verzeichnis hingegen ohne Überschrift
+ ausgegeben haben, dann genügt:
\begin{lstcode}
\listoftoc*{loa}
\end{lstcode}
- Im zweiten Fall würde natürlich auch ein optional aktivierter Eintrag in das
- Inhaltsverzeichnis nicht gesetzt. Näheres zur Eigenschaft des Eintrags in
+ Im zweiten Fall würde natürlich auch ein optional aktivierter Eintrag in das
+ Inhaltsverzeichnis nicht gesetzt. Näheres zur Eigenschaft des Eintrags in
das Inhaltsverzeichnis ist bei der Anweisung
\DescRef{\LabelBase.cmd.setuptoc}, \DescPageRef{\LabelBase.cmd.setuptoc} zu
finden.
@@ -536,12 +536,12 @@ passend zu definieren.
Verzeichnis der Algorithmen%
}
\end{lstcode}
- definiert haben, genügt auch:
+ definiert haben, genügt auch:
\begin{lstcode}
\listoftoc{loa}
\end{lstcode}
- um ein Verzeichnis mit der gewünschten Überschrift zu erzeugen. Für den
- Anwender ist es eventuell einprägsamer, wenn Sie dann außerdem noch
+ um ein Verzeichnis mit der gewünschten Überschrift zu erzeugen. Für den
+ Anwender ist es eventuell einprägsamer, wenn Sie dann außerdem noch
\begin{lstcode}
\newcommand*{\listofalgorithms}{\listoftoc{loa}}
\end{lstcode}
@@ -549,24 +549,24 @@ passend zu definieren.
\end{Example}
Da\textnote{Achtung!} \LaTeX{} bei der Ausgabe eines Verzeichnisses auch
-gleich eine neue Verzeichnisdatei zum Schreiben öffnet, kann der Aufruf jeder
+gleich eine neue Verzeichnisdatei zum Schreiben öffnet, kann der Aufruf jeder
dieser Anweisungen zu einer Fehlermeldung der Art
\begin{lstoutput}
! No room for a new \write .
\ch@ck ...\else \errmessage {No room for a new #3}
\fi
\end{lstoutput}
-führen, wenn keine Schreibdateien mehr zur Verfügung stehen. Abhilfe kann in
+führen, wenn keine Schreibdateien mehr zur Verfügung stehen. Abhilfe kann in
diesem Fall das Laden des in \autoref{cha:scrwfile} beschriebenen Pakets
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}
bieten.
Das Paket \hyperref[cha:scrhack]{\Package{scrhack}}\IndexPackage{scrhack}%
-\important{ \hyperref[cha:scrhack]{\Package{scrhack}}} enthält übrigens
-Patches für mehrere Pakete wie \Package{float} oder \Package{listings}, damit
+\important{ \hyperref[cha:scrhack]{\Package{scrhack}}} enthält übrigens
+Patches für mehrere Pakete wie \Package{float} oder \Package{listings}, damit
deren Verzeichnisbefehle \Macro{listoftoc} verwenden. Dadurch stehen viele
-Möglichkeiten von \Package{tocbasic} und den \KOMAScript-Klassen auch für
-deren Verzeichnisse zur Verfügung.%
+Möglichkeiten von \Package{tocbasic} und den \KOMAScript-Klassen auch für
+deren Verzeichnisse zur Verfügung.%
\EndIndexGroup
@@ -575,15 +575,15 @@ deren Verzeichnisse zur Verfügung.%
\Parameter{Anweisungen}
\Macro{AfterStartingTOC}\OParameter{Dateierweiterung}\Parameter{Anweisungen}
\end{Declaration}
-Manchmal ist es nützlich, wenn unmittelbar vor dem Einlesen der Datei mit den
-Verzeichnisdaten \PName{Anweisungen} ausgeführt werden können. Mit Hilfe von
-\Macro{BeforeStartingTOC} können Sie eine solche Ausführung
-wahlweise für eine einzelne \PName{Dateierweiterung} oder alle Dateien, die
+Manchmal ist es nützlich, wenn unmittelbar vor dem Einlesen der Datei mit den
+Verzeichnisdaten \PName{Anweisungen} ausgeführt werden können. Mit Hilfe von
+\Macro{BeforeStartingTOC} können Sie eine solche Ausführung
+wahlweise für eine einzelne \PName{Dateierweiterung} oder alle Dateien, die
mit Hilfe von \DescRef{\LabelBase.cmd.listoftoc*},
\DescRef{\LabelBase.cmd.listoftoc} oder \DescRef{\LabelBase.cmd.listofeachtoc}
-eingelesen werden, erreichen. Ebenso können Sie \PName{Anweisungen} nach dem
-Einlesen der Datei ausführen, wenn Sie diese mit \Macro{AfterStartingTOC}
-definieren. Während der Ausführung der \PName{Anweisungen} ist
+eingelesen werden, erreichen. Ebenso können Sie \PName{Anweisungen} nach dem
+Einlesen der Datei ausführen, wenn Sie diese mit \Macro{AfterStartingTOC}
+definieren. Während der Ausführung der \PName{Anweisungen} ist
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
Dateierweiterung der Datei, die eingelesen wird bzw. gerade eingelesen wurde.
@@ -598,35 +598,35 @@ ist in \autoref{sec:scrwfile.clonefilefeature} auf
\Macro{BeforeTOCHead}\OParameter{Dateierweiterung}\Parameter{Anweisungen}
\Macro{AfterTOCHead}\OParameter{Dateierweiterung}\Parameter{Anweisungen}
\end{Declaration}
-Es können auch \PName{Anweisungen} definiert werden, die unmittelbar vor oder
-nach dem Setzen der Überschrift bei Verwendung von
+Es können auch \PName{Anweisungen} definiert werden, die unmittelbar vor oder
+nach dem Setzen der Ãœberschrift bei Verwendung von
\DescRef{\LabelBase.cmd.listoftoc} oder \DescRef{\LabelBase.cmd.listofeachtoc}
-ausgeführt werden. Bezüglich des optionalen Arguments und der Bedeutung von
+ausgeführt werden. Bezüglich des optionalen Arguments und der Bedeutung von
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} gilt, was
bereits bei \DescRef{\LabelBase.cmd.BeforeStartingTOC} und
-\DescRef{\LabelBase.cmd.AfterStartingTOC} oben erklärt wurde.%
+\DescRef{\LabelBase.cmd.AfterStartingTOC} oben erklärt wurde.%
\EndIndexGroup
\begin{Declaration}
\Macro{MakeMarkcase}
\end{Declaration}
-Wann immer \Package{tocbasic} eine Marke für einen Kolumnentitel setzt,
+Wann immer \Package{tocbasic} eine Marke für einen Kolumnentitel setzt,
erfolgt dies als Argument der Anweisung \Macro{MakeMarkcase}. Diese Anweisung
-ist dazu gedacht, bei Bedarf die Groß-/Kleinschreibung des Kolumnentitels zu
-ändern. In der Voreinstellung ist diese Anweisung bei Verwendung einer
+ist dazu gedacht, bei Bedarf die Groß-/Kleinschreibung des Kolumnentitels zu
+ändern. In der Voreinstellung ist diese Anweisung bei Verwendung einer
\KOMAScript-Klasse
\Macro{@firstofone}\IndexCmd{@firstofone}\important{\Macro{@firstofone}}, also
-das unveränderte Argument selbst. Bei Verwendung einer anderen Klasse ist
+das unveränderte Argument selbst. Bei Verwendung einer anderen Klasse ist
\Macro{MakeMarkcase} im Gegensatz dazu
\Macro{MakeUppercase}\IndexCmd{MakeUppercase}\important{\Macro{MakeUppercase}}.
Die Anweisung wird von \Package{tocbasic} jedoch nur definiert, wenn sie
-nicht bereits definiert ist. Sie kann also in einer Klasse in der gewünschten
+nicht bereits definiert ist. Sie kann also in einer Klasse in der gewünschten
Weise vorbelegt werden und wird dann von \Package{tocbasic} nicht umdefiniert,
sondern verwendet wie vorgefunden.
\begin{Example}
- Sie wollen aus unerfindlichen Gründen, dass die Kolumnentitel in Ihrer
- Klasse in Kleinbuchstaben ausgegeben werden. Damit dies auch für die
+ Sie wollen aus unerfindlichen Gründen, dass die Kolumnentitel in Ihrer
+ Klasse in Kleinbuchstaben ausgegeben werden. Damit dies auch für die
Kolumnentitel gilt, die von \Package{tocbasic} gesetzt werden, definieren
Sie:
\begin{lstcode}
@@ -636,20 +636,20 @@ sondern verwendet wie vorgefunden.
Erlauben\textnote{Tipp!} Sie mir einen Hinweis zu \Macro{MakeUppercase}. Diese
Anweisung ist zum einen nicht voll expandierbar. Das bedeutet, dass sie im
-Zusammenspiel mit anderen Anweisungen zu Problemen führen kann. Zum anderen
+Zusammenspiel mit anderen Anweisungen zu Problemen führen kann. Zum anderen
sind sich alle Typografen einig, dass beim Versalsatz, also beim Satz
-kompletter Wörter oder Passagen in Großbuchstaben, Sperrung unbedingt
+kompletter Wörter oder Passagen in Großbuchstaben, Sperrung unbedingt
notwendig ist. Dabei darf jedoch kein fester Abstand zwischen den Buchstaben
verwendet werden. Vielmehr muss zwischen unterschiedlichen Buchstaben auch ein
unterschiedlicher Abstand gesetzt werden, weil sich unterschiedliche
Buchstabenkombinationen unterschiedlich verhalten. Gleichzeitig bilden einige
-Buchstaben von sich aus bereits Löcher, was bei der Sperrung ebenfalls zu
-berücksichtigen ist. Pakete wie \Package{ulem} oder \Package{soul} können das
+Buchstaben von sich aus bereits Löcher, was bei der Sperrung ebenfalls zu
+berücksichtigen ist. Pakete wie \Package{ulem} oder \Package{soul} können das
ebenso wenig leisten wie der Befehl \Macro{MakeUppercase} selbst. Auch die
automatische Sperrung mit Hilfe des \Package{microtype}-Pakets ist
-diesbezüglich nur eine näherungsweise Notlösung, da die von der konkreten
-Schrift abhängige Form der Buchstaben auch hier nicht näher betrachtet
-wird. Da\textnote{Empfehlung} Versalsatz also eher etwas für absolute
+diesbezüglich nur eine näherungsweise Notlösung, da die von der konkreten
+Schrift abhängige Form der Buchstaben auch hier nicht näher betrachtet
+wird. Da\textnote{Empfehlung} Versalsatz also eher etwas für absolute
Experten ist und fast immer Handarbeit bedeutet, wird Laien empfohlen, darauf
zu verzichten oder ihn nur vorsichtig und nicht an so exponierter Stelle
wie dem Kolumnentitel zu verwenden.%
@@ -659,17 +659,22 @@ wie dem Kolumnentitel zu verwenden.%
\begin{Declaration}
\Macro{deftocheading}\Parameter{Dateierweiterung}\Parameter{Definition}
\end{Declaration}
-Das Paket \Package{tocbasic} enthält eine Standarddefinition für das Setzen
-von Überschriften von Verzeichnissen. Diese Standarddefinition ist durch
+Das Paket \Package{tocbasic} enthält eine Standarddefinition für das Setzen
+von Ãœberschriften von Verzeichnissen. Diese Standarddefinition ist durch
verschiedene Eigenschaften, die bei der Anweisung
-\DescRef{\LabelBase.cmd.setuptoc} erläutert werden, konfigurierbar. Sollte
-diese Möglichkeit einmal nicht ausreichen, so besteht die Möglichkeit, mit
-\Macro{deftocheading} eine alternative Überschriftenanweisung für ein
+\DescRef{\LabelBase.cmd.setuptoc} erläutert werden, konfigurierbar. Sollte
+diese Möglichkeit einmal nicht ausreichen, so besteht die Möglichkeit, mit
+\Macro{deftocheading} eine alternative Überschriftenanweisung für ein
Verzeichnis mit einer bestimmten \PName{Dateierweiterung} zu definieren. Die
Definition kann als einzigen Parameter \PValue{\#1} enthalten. Beim Aufruf der
Anweisung innerhalb von \DescRef{\LabelBase.cmd.listoftoc} oder
-\DescRef{\LabelBase.cmd.listofeachtoc} wird für dieses Argument dann der Titel
-für das Verzeichnis übergeben.%
+\DescRef{\LabelBase.cmd.listofeachtoc} wird für dieses Argument dann der Titel
+für das Verzeichnis übergeben.
+
+Die \PName{Definition} ist dann selbstverständlich auch für die Auswertung
+weiterer Eigenschaften, die sich auf die Ãœberschrift beziehen,
+verantwortlich. Das gilt insbesondere für die nachfolgend erklärten
+Eigenschaften \PValue{leveldown}, \PValue{numbered} und \PValue{totoc}.%
\EndIndexGroup
@@ -679,77 +684,82 @@ für das Verzeichnis übergeben.%
\Macro{unsettoc}\Parameter{Dateierweiterung}
\Parameter{Liste von Eigenschaften}
\end{Declaration}
-Mit diesen beiden Anweisungen können \PName{Eigenschaften} für eine
-\PName{Dateierweiterung} bzw. das Verzeichnis, das dazu gehört, gesetzt und
-gelöscht werden. Die \PName{Liste von Eigenschaften} ist dabei eine durch
+Mit diesen beiden Anweisungen können \PName{Eigenschaften} für eine
+\PName{Dateierweiterung} bzw. das Verzeichnis, das dazu gehört, gesetzt und
+gelöscht werden. Die \PName{Liste von Eigenschaften} ist dabei eine durch
Komma getrennte Folge von \PName{Eigenschaften}. Das Paket
\Package{tocbasic} wertet folgende Eigenschaften aus:
\begin{description}\setkomafont{descriptionlabel}{}%
\item[\PValue{leveldown}] bedeutet, dass das Verzeichnis nicht mit der
obersten Gliederungsebene unterhalb von \DescRef{maincls.cmd.part} -- wenn
vorhanden \DescRef{maincls.cmd.chapter}, sonst \DescRef{maincls.cmd.section}
- -- erstellt wird, sondern mit einer Überschrift der nächst tieferen
+ -- erstellt wird, sondern mit einer Überschrift der nächst tieferen
Gliederungsebene. Diese Eigenschaft wird von der internen
- Überschriftenanweisung ausgewertet. Wird\textnote{Achtung!} hingegen eine
- eigene Überschriftenanweisung mit \DescRef{\LabelBase.cmd.deftocheading}
+ Ãœberschriftenanweisung ausgewertet. Wird\textnote{Achtung!} hingegen eine
+ eigene Ãœberschriftenanweisung mit \DescRef{\LabelBase.cmd.deftocheading}
definiert, liegt die Auswertung der Eigenschaft in der Verantwortung dessen,
der die Definition vornimmt. Die \KOMAScript-Klassen setzen diese
Eigenschaft bei Verwendung der Option
\OptionValueRef{maincls}{listof}{leveldown}%
\important{\OptionValueRef{maincls}{listof}{leveldown}}%
- \IndexOption{listof~=\textKValue{leveldown}} für alle Dateierweiterungen des
- Besitzers \PValue{float}.
+ \IndexOption{listof~=\textKValue{leveldown}} für alle Dateierweiterungen mit
+ dem Besitzer \PValue{float}.
\item[\PValue{nobabel}] bedeutet, dass die normalerweise automatisch
- verwendete Erweiterung für die Sprachumschaltung mit
- \Package{babel}\IndexPackage{babel} für diese Dateierweiterung nicht
- verwendet wird. Diese Eigenschaft sollte nur für Verzeichnisse verwendet
+ verwendete Erweiterung für die Sprachumschaltung mit
+ \Package{babel}\IndexPackage{babel} für diese Dateierweiterung nicht
+ verwendet wird. Diese Eigenschaft sollte nur für Verzeichnisse verwendet
werden, die nur in einer festen Sprache erstellt werden, in denen also
- Sprachumschaltungen im Dokument nicht zu berücksichtigen sind. Sie wird
- außerdem vom Paket
- \Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile} für
+ Sprachumschaltungen im Dokument nicht zu berücksichtigen sind. Sie wird
+ außerdem vom Paket
+ \Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile} für
Klonziele verwendet, da die Erweiterungen dort bereits durch das Klonen
- selbst aus der Klonquelle übernommen werden.
+ selbst aus der Klonquelle übernommen werden.
Es ist zu beachten\textnote{Achtung!}, dass die Eigenschaft bereits vor dem
- Hinzufügen der Dateierweiterung zu der Liste der bekannten
+ Hinzufügen der Dateierweiterung zu der Liste der bekannten
Dateierweiterungen gesetzt sein muss, damit sie eine Wirkung hat.
+\item[\PValue{noindent}]\ChangedAt{v3.27}{\Package{tocbasic}} veranlasst alle
+ von \KOMAScript{} bereitgestellten Verzeichniseintragsstile die Eigenschaft
+ \PValue{indent} (siehe \autoref{tab:tocbasic.tocstyle.attributes},
+ \autopageref{tab:tocbasic.tocstyle.attributes.indent}) zu ignorieren und
+ stattdessen den Einzug zu deaktivieren.
\item[\PValue{noparskipfake}] verhindert\ChangedAt{v3.17}{\Package{tocbasic}},
- dass vor dem Abschalten des Absatzabstandes für die Verzeichnisse ein
- letztes Mal ein expliziter Absatzabstand eingefügt wird. Dies führt in der
+ dass vor dem Abschalten des Absatzabstandes für die Verzeichnisse ein
+ letztes Mal ein expliziter Absatzabstand eingefügt wird. Dies führt in der
Regel dazu, dass bei Dokumenten mit Absatzabstand der Abstand zwischen
- Überschrift und ersten Verzeichniseintrag\index{Verzeichnis>Eintrag} kleiner
- wird als zwischen Überschriften und normalem Text. Normalerweise erhält man
+ Ãœberschrift und ersten Verzeichniseintrag\index{Verzeichnis>Eintrag} kleiner
+ wird als zwischen Überschriften und normalem Text. Normalerweise erhält man
daher ohne diese Eigenschaft eine einheitlichere Formatierung.
\item[\PValue{noprotrusion}] verhindert\ChangedAt{v3.10}{\Package{tocbasic}}
das Abschalten des optischen Randausgleichs in den Verzeichnissen. Optischer
- Randausgleich wird standardmäßig abgeschaltet, wenn das Paket
+ Randausgleich wird standardmäßig abgeschaltet, wenn das Paket
\Package{microtype}\IndexPackage{microtype} oder ein anderes Paket, das die
Anweisung \Macro{microtypesetup}\IndexCmd{microtypesetup} bereitstellt,
geladen ist. Wenn also optischer Randausgleich in den Verzeichnissen
- gewünscht wird, dann muss diese Eigenschaft aktiviert
+ gewünscht wird, dann muss diese Eigenschaft aktiviert
werden. Es\textnote{Achtung!} ist jedoch zu beachten, dass der optische
- Randausgleich in Verzeichnissen häufig zu einem falschen Ergebnis
- führt. Dies ist ein bekanntes Problem des optischen Randausgleichs.
+ Randausgleich in Verzeichnissen häufig zu einem falschen Ergebnis
+ führt. Dies ist ein bekanntes Problem des optischen Randausgleichs.
\item[\PValue{numbered}] bedeutet, dass das Verzeichnis nummeriert und damit
ebenfalls in das Inhaltsverzeichnis aufgenommen werden soll. Diese
- Eigenschaft wird von der internen Überschriftenanweisung ausgewertet. Wird
- hingegen eine eigene Überschriftenanweisung mit
+ Eigenschaft wird von der internen Ãœberschriftenanweisung ausgewertet. Wird
+ hingegen eine eigene Ãœberschriftenanweisung mit
\DescRef{\LabelBase.cmd.deftocheading} definiert, liegt die Auswertung der
Eigenschaft in der Verantwortung dessen, der die Definition vornimmt. Die
\KOMAScript-Klassen setzen diese Eigenschaft bei Verwendung der Option
\OptionValueRef{maincls}{listof}{numbered}%
\important{\OptionValueRef{maincls}{listof}{numbered}}%
- \IndexOption{listof~=\textKValue{numbered}} für alle Dateierweiterungen des
- Besitzers \Package{float}.
+ \IndexOption{listof~=\textKValue{numbered}} für alle Dateierweiterungen mit
+ dem Besitzer \Package{float}.
\item[\PValue{numberline}] \ChangedAt{v3.12}{\Package{tocbasic}}%
- bedeutet, dass all diejenigen Einträge, die mit Hilfe der Anweisung
+ bedeutet, dass all diejenigen Einträge, die mit Hilfe der Anweisung
\DescRef{\LabelBase.cmd.addxcontentsline} oder der Anweisung
- \DescRef{\LabelBase.cmd.addxcontentslinetoeachtocfile} vorgenommen werden, wobei das optionale Argument für die Nummer fehlt
- oder leer ist, mit einer leeren
- \DescRef{\LabelBase.cmd.numberline}-Anweisung versehen werden. Das führt in
- der Regel dazu, dass diese Einträge nicht linksbündig mit der Nummer,
- sondern mit dem Text der nummerierten Einträge gleicher Ebene gesetzt
- werden. Bei\ChangedAt{v3.20}{\Package{tocbasic}} Verwendung des
+ \DescRef{\LabelBase.cmd.addxcontentslinetoeachtocfile} vorgenommen werden,
+ wobei das optionale Argument für die Nummer fehlt oder leer ist, mit einer
+ leeren \DescRef{\LabelBase.cmd.numberline}-Anweisung versehen werden. Das
+ führt in der Regel dazu, dass diese Einträge nicht linksbündig mit der
+ Nummer, sondern mit dem Text der nummerierten Einträge gleicher Ebene
+ gesetzt werden. Bei\ChangedAt{v3.20}{\Package{tocbasic}} Verwendung des
Verzeichniseintragsstils \PValue{tocline} kann die Eigenschaft weitere
Auswirkungen haben. Siehe dazu die Stil-Eigenschaften
\Option{breakafternumber} und \Option{entrynumberformat} in
@@ -759,20 +769,20 @@ Komma getrennte Folge von \PName{Eigenschaften}. Das Paket
Die \KOMAScript-Klassen setzen diese Eigenschaft bei Verwendung der Option
\OptionValueRef{maincls}{listof}{numberline}%
\important{\OptionValueRef{maincls}{listof}{numberline}}%
- \IndexOption{listof~=\textKValue{numberline}} für die Dateierweiterungen des
- Besitzers \PValue{float} und bei Verwendung der Option
+ \IndexOption{listof~=\textKValue{numberline}} für die Dateierweiterungen mit
+ dem Besitzer \PValue{float} und bei Verwendung der Option
\OptionValueRef{maincls}{toc}{numberline}%
\important{\OptionValueRef{maincls}{toc}{numberline}}%
- \IndexOption{toc~=\textKValue{numberline}} für die Dateierweiterung
+ \IndexOption{toc~=\textKValue{numberline}} für die Dateierweiterung
\PValue{toc}. Entsprechend wird die Eigenschaft bei Verwendung von Option
\OptionValueRef{maincls}{listof}{nonumberline}%
\important{\OptionValueRef{maincls}{listof}{nonumberline}}%
\IndexOption{listof~=\textKValue{nonumberline}} oder
\OptionValueRef{maincls}{toc}{nonumberline}%
\important{\OptionValueRef{maincls}{toc}{nonumberline}}%
- \IndexOption{toc~=\textKValue{nonumberline}} wieder zurückgesetzt.
+ \IndexOption{toc~=\textKValue{nonumberline}} wieder zurückgesetzt.
\item[\PValue{onecolumn}] \leavevmode\ChangedAt{v3.01}{\Package{tocbasic}}%
- bedeutet, dass für dieses Verzeichnis automatisch der \LaTeX-interne
+ bedeutet, dass für dieses Verzeichnis automatisch der \LaTeX-interne
Einspaltenmodus mit \Macro{onecolumn}\IndexCmd{onecolumn} verwendet
wird. Dies\textnote{Achtung!} gilt jedoch nur, falls dieses Verzeichnis
nicht mit der oben beschriebenen Eigenschaft
@@ -780,32 +790,32 @@ Komma getrennte Folge von \PName{Eigenschaften}. Das Paket
nach unten verschoben wurde. Die \KOMAScript-Klassen \Class{scrbook} und
\Class{scrreprt} setzen diese Eigenschaft per
\DescRef{\LabelBase.cmd.AtAddToTocList} (siehe
- \DescPageRef{\LabelBase.cmd.AtAddToTocList}) für alle Verzeichnisse mit dem
+ \DescPageRef{\LabelBase.cmd.AtAddToTocList}) für alle Verzeichnisse mit dem
Besitzer \PValue{float} oder mit sich selbst als Besitzer. Damit werden
beispielsweise das Inhaltsverzeichnis, das Abbildungsverzeichnis und das
Tabellenverzeichnis bei diesen beiden Klassen automatisch einspaltig
gesetzt. Der Mehrspaltenmodus des
\Package{multicol}-Pakets\IndexPackage{multicol} ist von der Eigenschaft
- ausdrücklich nicht betroffen.
+ ausdrücklich nicht betroffen.
\item[\PValue{totoc}] bedeutet, dass der Titel des Verzeichnisses in das
Inhaltsverzeichnis aufgenommen werden soll. Diese Eigenschaft wird von der
- internen Überschriftenanweisung ausgewertet. Wird\textnote{Achtung!} mit
+ internen Ãœberschriftenanweisung ausgewertet. Wird\textnote{Achtung!} mit
\DescRef{\LabelBase.cmd.deftocheading}\important{\DescRef{\LabelBase.cmd.deftocheading}}%
- \IndexCmd{deftocheading} hingegen eine eigene Überschriftenanweisung
+ \IndexCmd{deftocheading} hingegen eine eigene Ãœberschriftenanweisung
definiert, liegt die Auswertung der Eigenschaft in der Verantwortung dessen,
der die Definition vornimmt. Die \KOMAScript-Klassen setzen diese
Eigenschaft bei Verwendung der Option
\OptionValueRef{maincls}{listof}{totoc}%
\important{\OptionValueRef{maincls}{listof}{totoc}}%
- \IndexOption{listof~=\textKValue{totoc}} für alle Dateierweiterungen des
- Besitzers \Package{float}.
+ \IndexOption{listof~=\textKValue{totoc}} für alle Dateierweiterungen mit dem
+ Besitzer \Package{float}.
\end{description}
Die \KOMAScript-Klassen kennen eine weitere Eigenschaft:
\begin{description}\setkomafont{descriptionlabel}{}
-\item[\PValue{chapteratlist}] sorgt dafür, dass in dieses Verzeichnis bei
- jedem neuen Kapitel eine optionale Gliederung eingefügt wird. In der
+\item[\PValue{chapteratlist}] sorgt dafür, dass in dieses Verzeichnis bei
+ jedem neuen Kapitel eine optionale Gliederung eingefügt wird. In der
Voreinstellung ist diese Untergliederung dann ein vertikaler
- Abstand. Näheres zu den Möglichkeiten ist Option
+ Abstand. Näheres zu den Möglichkeiten ist Option
\DescRef{maincls.option.listof}%
\IndexOption{listof~=\PName{Einstellung}}%
\important{\DescRef{maincls.option.listof}} in
@@ -813,8 +823,8 @@ Die \KOMAScript-Klassen kennen eine weitere Eigenschaft:
entnehmen.
\end{description}
\begin{Example}
- Da \KOMAScript{} für das Abbildungs- und das Tabellenverzeichnis auf
- \Package{tocbasic} aufbaut, gibt es nun eine weitere Möglichkeit, jegliche
+ Da \KOMAScript{} für das Abbildungs- und das Tabellenverzeichnis auf
+ \Package{tocbasic} aufbaut, gibt es nun eine weitere Möglichkeit, jegliche
Kapiteluntergliederung dieser Verzeichnisse zu verhindern:
\begin{lstcode}
\unsettoc{lof}{chapteratlist}
@@ -822,14 +832,14 @@ Die \KOMAScript-Klassen kennen eine weitere Eigenschaft:
\end{lstcode}
Wollen Sie hingegen, dass das von Ihnen definierte Verzeichnis mit der
- Dateierweiterung »\PValue{loa}« ebenfalls von der Kapiteluntergliederung der
+ Dateierweiterung »\PValue{loa}« ebenfalls von der Kapiteluntergliederung der
\KOMAScript-Klassen betroffen ist, so verwenden Sie
\begin{lstcode}
\setuptoc{loa}{chapteratlist}
\end{lstcode}
-Wollen Sie außerdem, dass bei Klassen, die \DescRef{maincls.cmd.chapter} als
+Wollen Sie außerdem, dass bei Klassen, die \DescRef{maincls.cmd.chapter} als
oberste Gliederungsebene verwenden, das Verzeichnis automatisch einspaltig
-gesetzt wird, so verwenden Sie zusätzlich
+gesetzt wird, so verwenden Sie zusätzlich
\begin{lstcode}
\ifundefinedorrelax{chapter}{}{%
\setuptoc{loa}{onecolumn}%
@@ -843,12 +853,12 @@ gesetzt wird, so verwenden Sie zusätzlich
Sollte\textnote{Tipp!} Ihr Paket mit einer anderen Klasse verwendet werden,
so schadet es trotzdem nicht, dass Sie diese Eigenschaften setzen, im
Gegenteil: Wertet eine andere Klasse diese Eigenschaften ebenfalls aus, so
- nutzt Ihr Paket automatisch die Möglichkeiten jener Klasse.
+ nutzt Ihr Paket automatisch die Möglichkeiten jener Klasse.
\end{Example}
-Wie Sie hier sehen, unterstützt ein Paket, das \Package{tocbasic} verwendet,
-bereits ohne nennenswerten Aufwand diverse Möglichkeiten für die dadurch
+Wie Sie hier sehen, unterstützt ein Paket, das \Package{tocbasic} verwendet,
+bereits ohne nennenswerten Aufwand diverse Möglichkeiten für die dadurch
realisierten Verzeichnisse, die sonst einigen Implementierungsaufwand
-bedeuten würden und deshalb in vielen Paketen leider fehlen.%
+bedeuten würden und deshalb in vielen Paketen leider fehlen.%
\EndIndexGroup
@@ -856,46 +866,46 @@ bedeuten würden und deshalb in vielen Paketen leider fehlen.%
\Macro{iftocfeature}\Parameter{Dateierweiterung}\Parameter{Eigenschaft}
\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
-Hiermit kann man für jede \PName{Eigenschaft} feststellen, ob sie für eine
+Hiermit kann man für jede \PName{Eigenschaft} feststellen, ob sie für eine
\PName{Dateierweiterung} gesetzt ist. Ist dies der Fall, wird der
-\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Das kann
-beispielsweise nützlich sein, wenn Sie eigene Überschriftenanweisungen mit
+\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Das kann
+beispielsweise nützlich sein, wenn Sie eigene Überschriftenanweisungen mit
\DescRef{\LabelBase.cmd.deftocheading} definieren, aber die oben beschriebenen
Eigenschaften \PValue{totoc}, \PValue{numbered} oder \PValue{leveldown}
-unterstützen wollen.
+unterstützen wollen.
%
\EndIndexGroup
-\section{Konfiguration von Verzeichniseinträgen}
+\section{Konfiguration von Verzeichniseinträgen}
\seclabel{tocstyle}
\BeginIndexGroup
\BeginIndex{}{Verzeichnis>Eintrag}
-Neben\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} den eigentlichen
-Verzeichnissen und den zugehörigen Hilfsdateien kann man mit dem Paket
-\Package{tocbasic} ab Version~3.20 auch Einfluss auf die Verzeichniseinträge
-nehmen. Dazu können neue Stile definiert werden. Es stehen aber auch mehrere
-vordefinierte Stile zur Verfügung. Mittelfristig wird \Package{tocbasic} das
-nie offiziell gewordene \KOMAScript-Paket \Package{tocstyle} ablösen. Die
-\KOMAScript-Klassen selbst bauen seit Version~3.20 ebenfalls vollständig auf
-die von \Package{tocbasic} bereitgestellten Stile für Verzeichniseinträge.
+Neben\ChangedAt{v3.20}{\Package{tocbasic}} den eigentlichen
+Verzeichnissen und den zugehörigen Hilfsdateien kann man mit dem Paket
+\Package{tocbasic} ab Version~3.20 auch Einfluss auf die Verzeichniseinträge
+nehmen. Dazu können neue Stile definiert werden. Es stehen aber auch mehrere
+vordefinierte Stile zur Verfügung. Mittelfristig wird \Package{tocbasic} das
+nie offiziell gewordene \KOMAScript-Paket \Package{tocstyle} ablösen. Die
+\KOMAScript-Klassen selbst bauen seit Version~3.20 ebenfalls vollständig auf
+die von \Package{tocbasic} bereitgestellten Stile für Verzeichniseinträge.
\begin{Declaration}
\Counter{tocdepth}
\end{Declaration}
-Verzeichniseinträge sind normalerweise hierarchisch geordnet. Dazu wird jeder
-Eintragsebene ein nummerischer Wert zu geordnet. Je höher dieser Wert, desto
+Verzeichniseinträge sind normalerweise hierarchisch geordnet. Dazu wird jeder
+Eintragsebene ein nummerischer Wert zu geordnet. Je höher dieser Wert, desto
tiefer in der Hierarchie liegt die Ebene. Bei den Standardklassen hat die
-Ebene für Teile beispielsweise den Wert -1 und die Ebene für Kapitel den Wert
-0. Über den \LaTeX-Zähler \Counter{tocdepth} wird bestimmt, bis zu welcher
-Ebene Einträge im Verzeichnis ausgegeben werden.
+Ebene für Teile beispielsweise den Wert -1 und die Ebene für Kapitel den Wert
+0. Über den \LaTeX-Zähler \Counter{tocdepth} wird bestimmt, bis zu welcher
+Ebene Einträge im Verzeichnis ausgegeben werden.
Bei \Class{book} ist \Counter{tocdepth} beispielsweise mit 2 voreingestellt,
-es werden also die Einträge der Ebenen \PValue{part}, \PValue{chapter},
+es werden also die Einträge der Ebenen \PValue{part}, \PValue{chapter},
\PValue{section} und \PValue{subsection} ausgeben. Tiefere Ebenen wie
\PValue{subsubsection}, deren nummerischer Wert 3 ist, werden nicht
-ausgegeben. Trotzdem sind die Einträge in der Hilfsdatei für das
+ausgegeben. Trotzdem sind die Einträge in der Hilfsdatei für das
Inhaltsverzeichnis vorhanden.
Die von \Package{tocbasic} definierten Eintragsstile beachten, abgesehen von
@@ -909,27 +919,27 @@ Die von \Package{tocbasic} definierten Eintragsstile beachten, abgesehen von
\Macro{numberline}\Parameter{Gliederungsnummer}
\Macro{usetocbasicnumberline}\OParameter{Code}
\end{Declaration}
-Zwar\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} definiert bereits der
-\LaTeX-Kern eine Anweisung \Macro{numberline}, diese ist allerdings für die
+Zwar\ChangedAt{v3.20}{\Package{tocbasic}} definiert bereits der
+\LaTeX-Kern eine Anweisung \Macro{numberline}, diese ist allerdings für die
Anforderungen von \Package{tocbasic} nicht ausreichend. Deshalb definiert
\Package{tocbasic} eigene Anweisungen und setzt \Macro{numberline} bei Bedarf
-mit Hilfe von \Macro{usetocbasicnumberline} für die einzelnen
-Verzeichniseinträge entsprechend. Eine Umdefinierung von \Macro{numberline}
-ist daher bei Verwendung von \Package{tocbasic} oftmals wirkungslos und führt
+mit Hilfe von \Macro{usetocbasicnumberline} für die einzelnen
+Verzeichniseinträge entsprechend. Eine Umdefinierung von \Macro{numberline}
+ist daher bei Verwendung von \Package{tocbasic} oftmals wirkungslos und führt
teilweise auch zu Warnungen.
Man kann auch die Definition von \Package{tocbasic} generell nutzen, indem man
-bereits in der Dokumentpräambel \Macro{usetocbasicnumberline} aufruft. Die
-Anweisung versucht zunächst zu ermitteln, ob in der aktuellen Definition
+bereits in der Dokumentpräambel \Macro{usetocbasicnumberline} aufruft. Die
+Anweisung versucht zunächst zu ermitteln, ob in der aktuellen Definition
wichtige interne Anweisungen von \Package{tocbasic} verwendet werden. Ist dies
-nicht der Fall, wird \Macro{numberline} entsprechend umdefiniert und zusätzlich
-\PName{Code} ausgeführt. Ist kein optionales Arguments angegeben, wird
-stattdessen via \Macro{PackageInfo} eine Meldung über die erfolgte
-Umdefinierung ausgegeben. Diese Meldung kann man einfach unterdrücken, indem
+nicht der Fall, wird \Macro{numberline} entsprechend umdefiniert und zusätzlich
+\PName{Code} ausgeführt. Ist kein optionales Arguments angegeben, wird
+stattdessen via \Macro{PackageInfo} eine Meldung über die erfolgte
+Umdefinierung ausgegeben. Diese Meldung kann man einfach unterdrücken, indem
ein leeres optionales Argument angegeben wird.
Es\textnote{Achtung!} ist zu beachten, dass \Macro{usetocbasicnumberline} den
-internen Schalter \Macro{if@tempswa} global verändern kann!%
+internen Schalter \Macro{if@tempswa} global verändern kann!%
\EndIndexGroup
@@ -939,16 +949,16 @@ internen Schalter \Macro{if@tempswa} global verändern kann!%
\Macro{DeclareTOCStyleEntries}\OParameter{Optionenliste}\Parameter{Stil}
\Parameter{Liste von Eintragsebenen}
\end{Declaration}
-Über\ChangedAt{v3.20}{\Package{tocbasic}} diese Anweisungen werden
-die Verzeichniseinträge für bestimmte \PName{Eintragsebenen} deklariert
+Ãœber\ChangedAt{v3.20}{\Package{tocbasic}} diese Anweisungen werden
+die Verzeichniseinträge für bestimmte \PName{Eintragsebenen} deklariert
oder konfiguriert. Dabei ist die \PName{Eintragsebene} der Name der jeweiligen
-Eintragsebene, beispielsweise \PValue{section} für einen zur gleichnamigen
-Gliederungsebene gehörenden Eintrag ins Inhaltsverzeichnis oder
-\PValue{figure} für den Eintrag einer Abbildung ins
+Eintragsebene, beispielsweise \PValue{section} für einen zur gleichnamigen
+Gliederungsebene gehörenden Eintrag ins Inhaltsverzeichnis oder
+\PValue{figure} für den Eintrag einer Abbildung ins
Abbildungsverzeichnis. Jeder \PName{Eintragsebene} wird ein bestimmter
\PName{Stil} zugeordnet, der zum Zeitpunkt der Deklaration bereits definiert
-sein muss. Über die \PName{Optionenliste} können die verschiedenen, meist vom
-\PName{Stil} abhängenden Eigenschaften des Eintrags festgelegt werden.
+sein muss. Über die \PName{Optionenliste} können die verschiedenen, meist vom
+\PName{Stil} abhängenden Eigenschaften des Eintrags festgelegt werden.
Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\begin{description}\setkomafont{descriptionlabel}{}
@@ -956,20 +966,20 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\PValue{dottedtocline}. Klassenautoren, die \Package{tocbasic} verwenden,
wird empfohlen, diesen Stil mit Hilfe von
\DescRef{\LabelBase.cmd.CloneTOCEntryStyle} auf den
- Standardverzeichniseintragsstil der Klasse zu ändern. Bei den
+ Standardverzeichniseintragsstil der Klasse zu ändern. Bei den
\KOMAScript-Klassen wird \PValue{default} beispielsweise zu einem Klon von
Stil \PValue{tocline}.
\item[\PValue{dottedtocline}] entspricht dem Stil, der von den Standardklassen
- \Class{book} und \Class{report} für die Inhaltsverzeichniseinträge der
+ \Class{book} und \Class{report} für die Inhaltsverzeichniseinträge der
Ebenen \PValue{section} bis \PValue{subparagraph} und bei allen
- Standardklassen für die Einträge in das Abbildungs- und das
+ Standardklassen für die Einträge in das Abbildungs- und das
Tabellenverzeichnis bekannt ist. Er kennt nur drei\important{\PValue{level},
- \PValue{indent}, \PValue{numwidth}} Eigenschaften. Die Einträge werden
+ \PValue{indent}, \PValue{numwidth}} Eigenschaften. Die Einträge werden
um \PValue{indent} von links eingezogen in der aktuellen Schrift
ausgegeben. \DescRef{\LabelBase.cmd.numberline} wird nicht umdefiniert. Die
Breite der Nummer wird von \PValue{numwidth} bestimmt. Bei mehrzeiligen
- Einträgen wird der Einzug ab der zweiten Zeile um \PValue{numwidth}
- erhöht. Die Seitenzahl wird mit \Macro{normalfont} ausgegeben. Eintragstext
+ Einträgen wird der Einzug ab der zweiten Zeile um \PValue{numwidth}
+ erhöht. Die Seitenzahl wird mit \Macro{normalfont} ausgegeben. Eintragstext
und Seitenzahl werden durch eine punktierte Linie
verbunden. \autoref{fig:tocbasic.dottedtocline} illustriert die
Eigenschaften des Stils.
@@ -987,7 +997,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\setlength{\parindent}{-3.2em}%
\addtolength{\parfillskip}{-2.55em}%
\makebox[3.2em][l]{1.1.10}%
- Überschrift im Verzeichniseintragsstil \PValue{dottedtocline} mit
+ Ãœberschrift im Verzeichniseintragsstil \PValue{dottedtocline} mit
mehr als einer Zeile%
\leaders\hbox{$\csname m@th\endcsname
\mkern 4.5mu\hbox{.}\mkern 4.5mu$}\hfill\nobreak
@@ -1020,39 +1030,39 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\PValue{dottedtocline}}
\label{fig:tocbasic.dottedtocline}
\end{figure}
-\item[\PValue{gobble}] ist der denkbar einfachste Stil. Einträge in diesem
- Stil werden unabhängig von allen Einstellungen für
+\item[\PValue{gobble}] ist der denkbar einfachste Stil. Einträge in diesem
+ Stil werden unabhängig von allen Einstellungen für
\DescRef{\LabelBase.counter.tocdepth}%
\IndexCounter{tocdepth}\important{\DescRef{\LabelBase.counter.tocdepth}}
- nicht ausgegeben sondern sozusagen verschluckt. Dennoch verfügt er über die
+ nicht ausgegeben sondern sozusagen verschluckt. Dennoch verfügt er über die
Standardeigenschaft \PValue{level}, die jedoch nie ausgewertet wird.
\item[\PValue{largetocline}] entspricht dem Stil, der von den Standardklassen
- für die Ebene \PValue{part} bekannt ist. Er kennt
+ für die Ebene \PValue{part} bekannt ist. Er kennt
nur\important{\PValue{level}, \PValue{indent}} die Eigenschaften
\PName{level} und \PName{indent}. Letzteres ist gleichsam eine Abweichung
- von den Standardklassen, die selbst keinen Einzug der \PValue{part}-Einträge
- unterstützen.
+ von den Standardklassen, die selbst keinen Einzug der \PValue{part}-Einträge
+ unterstützen.
- Vor dem Eintrag wird ein Seitenumbruch erleichtert. Die Einträge werden um
+ Vor dem Eintrag wird ein Seitenumbruch erleichtert. Die Einträge werden um
\PValue{indent} von links eingezogen und mit den Schrifteinstellungen
\Macro{large}\Macro{bfseries} ausgegeben. Sollte
\DescRef{\LabelBase.cmd.numberline} verwendet werden, so ist die
Nummernbreite fest auf 3\Unit{em}
eingestellt. \DescRef{\LabelBase.cmd.numberline} wird nicht umdefiniert. Die
- Standardklassen verwenden für \PName{part}-Einträge kein
- \DescRef{\LabelBase.cmd.numberline}. Der Wert hat bei mehrzeiligen Einträgen
+ Standardklassen verwenden für \PName{part}-Einträge kein
+ \DescRef{\LabelBase.cmd.numberline}. Der Wert hat bei mehrzeiligen Einträgen
auch keine Auswirkung auf den Einzug ab der zweiten Zeile.
\autoref{fig:tocbasic.largetocline} illustriert die
Eigenschaften
- des Stils. Dabei wird auch auf"|fällig, dass der Stil einige Ungereimtheiten
- der Standardklassen übernommen hat, beispielsweise der fehlende Einzug ab
- der zweiten Zeile bei mehrzeiligen Einträgen und zwei unterschiedliche Werte
- für \Macro{@pnumwidth}, die aus einer Abhängigkeit von der Schriftgröße
+ des Stils. Dabei wird auch auf"|fällig, dass der Stil einige Ungereimtheiten
+ der Standardklassen übernommen hat, beispielsweise der fehlende Einzug ab
+ der zweiten Zeile bei mehrzeiligen Einträgen und zwei unterschiedliche Werte
+ für \Macro{@pnumwidth}, die aus einer Abhängigkeit von der Schriftgröße
resultieren. Daraus resultiert auch der Umstand, dass im Extremfall der Text
- der Überschrift der Seitenzahl zu nahe kommen kann. Es ist zu beachten, dass
+ der Ãœberschrift der Seitenzahl zu nahe kommen kann. Es ist zu beachten, dass
die in der Abbildung gezeigte Breite der Gliederungsnummer nur dann
- Verwendung findet, wenn auch tatsächlich \DescRef{\LabelBase.cmd.numberline}
+ Verwendung findet, wenn auch tatsächlich \DescRef{\LabelBase.cmd.numberline}
verwendet wird. Die Standardklassen setzen hingegen einen festen Abstand von
1\Unit{em} nach der Nummer.
\begin{figure}
@@ -1066,7 +1076,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\parbox[t]{\dimexpr \linewidth-1.55em\relax}{%
\makebox[3em][l]{\large\bfseries I}%
\large\bfseries
- Überschrift im Verzeichniseintragsstil \PValue{largetocline} mit
+ Ãœberschrift im Verzeichniseintragsstil \PValue{largetocline} mit
mehr als einer Zeile\hfill
\makebox[0pt][l]{\normalsize\normalfont
\makebox[1.55em][r]{\large\bfseries 1}}%
@@ -1090,39 +1100,40 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\PValue{largetocline}}
\label{fig:tocbasic.largetocline}
\end{figure}
-\item[\PValue{tocline}] ist ein flexibler Stil, der in der Voreinstellung für
- alle Einträge der \KOMAScript-Klassen verwendet wird. Entsprechend
+\item[\PValue{tocline}] ist ein flexibler Stil, der in der Voreinstellung für
+ alle Einträge der \KOMAScript-Klassen verwendet wird. Entsprechend
definieren diese Klassen auch die Klone \PValue{part}, \PValue{chapter} und
\PValue{section} beziehungsweise \PValue{section} und \PValue{subsection}
- mit Hilfe dieses Stils, ändern dann jedoch den \PName{Initialisierungscode}
+ mit Hilfe dieses Stils, ändern dann jedoch den \PName{Initialisierungscode}
der Klone so ab, dass sie unterschiedliche Voreinstellungen besitzen.
Der Stil kennt neben der Standardeigenschaft \PValue{level} noch
- 16\important{\PValue{level}, \PValue{beforeskip}, \PValue{breakafternumber},
+ 18\important{\PValue{level}, \PValue{beforeskip}, \PValue{breakafternumber},
\PValue{dynnumwidth}, \PValue{entryformat}, \PValue{entrynumberformat},
\PValue{indent}, \PValue{linefill}, \PValue{numsep}, \PValue{numwidth},
\PValue{onstarthigherlevel}, \PValue{onstartlowerlevel},
\PValue{onstartsamelevel}, \PValue{pagenumberbox},
- \PValue{pagenumberformat}, \PValue{raggedentrytext},
- \PValue{raggedpagenumber}} weitere Eigenschaften. Die Voreinstellungen all
- dieser Eigenschaften werden abhängig vom Namen der \PName{Eintragsebene}
- bestimmt und orientieren sich dann an den Ergebnissen der
- Standardklassen. Es ist daher möglich, nach Laden von \Package{tocbasic} den
- Stil der Inhaltsverzeichniseinträge der Standardklassen mit
- \DescRef{\LabelBase.cmd.DeclareTOCEntryStyle} in \PValue{tocline} zu ändern,
- ohne dass dies unmittelbar zu größeren Veränderungen im Aussehen der
- Inhaltsverzeichniseinträge führt. So kann man gezielt nur die Eigenschaften
- ändern, die für erwünschte Änderungen notwendig sind. Dasselbe gilt für
- Abbildungs- und Tabellenverzeichnis der Standardklassen.%
-
- Aufgrund der hohen Flexibilität kann dieser Stil prinzipiell die Stile
+ \PValue{pagenumberformat}, \PValue{pagenumberwidth},
+ \PValue{raggedentrytext}, \PValue{raggedpagenumber}, \PValue{rightindent}}
+ weitere Eigenschaften. Die Voreinstellungen all dieser Eigenschaften werden
+ abhängig vom Namen der \PName{Eintragsebene} bestimmt und orientieren sich
+ dann an den Ergebnissen der Standardklassen. Es ist daher möglich, nach
+ Laden von \Package{tocbasic} den Stil der Inhaltsverzeichniseinträge der
+ Standardklassen mit \DescRef{\LabelBase.cmd.DeclareTOCEntryStyle} in
+ \PValue{tocline} zu ändern, ohne dass dies unmittelbar zu größeren
+ Veränderungen im Aussehen der Inhaltsverzeichniseinträge führt. So kann man
+ gezielt nur die Eigenschaften ändern, die für erwünschte Änderungen
+ notwendig sind. Dasselbe gilt für Abbildungs- und Tabellenverzeichnis der
+ Standardklassen.%
+
+ Aufgrund der hohen Flexibilität kann dieser Stil prinzipiell die Stile
\PValue{dottedtocline}, \PValue{undottedtocline} und \PValue{largetocline}
- ersetzen, bedarf dann jedoch teilweise eines höheren Aufwands bei der
+ ersetzen, bedarf dann jedoch teilweise eines höheren Aufwands bei der
Konfiguration.
- \autoref{fig:tocbasic.tocline} illustriert einige Längen-Eigenschaften des
+ \autoref{fig:tocbasic.tocline} illustriert einige Längen-Eigenschaften des
Stils. Die weiteren sind in \autoref{tab:tocbasic.tocstyle.attributes}, ab
- \autopageref{tab:tocbasic.tocstyle.attributes} erklärt.
+ \autopageref{tab:tocbasic.tocstyle.attributes} erklärt.
\begin{figure}
\centering
\resizebox{.8\linewidth}{!}{%
@@ -1148,7 +1159,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\setlength{\parindent}{-3em}%
\addtolength{\parfillskip}{-2.55em}%
\makebox[3em][l]{\large\bfseries I.}%
- \textbf{\large Überschrift eines Teil-Eintrags im Stil
+ \textbf{\large Ãœberschrift eines Teil-Eintrags im Stil
\PValue{tocline} zur Demonstration mit mehr als einer Zeile}%
\hfill
\makebox[1.55em][r]{\bfseries 12}\large
@@ -1179,7 +1190,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\setlength{\parindent}{-1.5em}%
\addtolength{\parfillskip}{-2.55em}%
\makebox[1.5em][l]{\bfseries 1.}%
- \textbf{Überschrift eines Kapiteleintrags im Stil
+ \textbf{Ãœberschrift eines Kapiteleintrags im Stil
\PValue{tocline} zur Demonstration mit mehr als einer Zeile}%
\hfill
\makebox[1.55em][r]{\bfseries 12}%
@@ -1216,7 +1227,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\setlength{\parindent}{-2.3em}%
\addtolength{\parfillskip}{-2.55em}%
\makebox[2.3em][l]{1.1.}%
- Überschrift eines Abschnitteintrags im Stil
+ Ãœberschrift eines Abschnitteintrags im Stil
\PValue{tocline} zur Demonstration mit mehr als einer Zeile%
\leaders\hbox{$\csname m@th\endcsname
\mkern 4.5mu\hbox{.}\mkern 4.5mu$}\hfill\nobreak
@@ -1230,7 +1241,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\setlength{\parindent}{-3.2em}%
\addtolength{\parfillskip}{-2.55em}%
\makebox[3.2em][l]{1.1.10.}%
- Überschrift eines Unterabschnitteintrags im Stil
+ Ãœberschrift eines Unterabschnitteintrags im Stil
\PValue{tocline} mit mehr als einer Zeile%
\leaders\hbox{$\csname m@th\endcsname
\mkern 4.5mu\hbox{.}\mkern 4.5mu$}\hfill\nobreak
@@ -1267,19 +1278,35 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\PValue{tocline}}
\label{fig:tocbasic.tocline}
\end{figure}
+\item[\PValue{toctext}]\ChangedAt{v3.27}{\Package{tocbasic}}%
+ stellt eine Besonderheit dar. Während alle anderen Stile je Eintrag einen
+ Absatz erzeugen, wird hier für alle aufeinanderfolgenden Einträge dieses
+ Stils nur ein einziger Absatz erzeugt. Für die Konfigurierung stehen neben
+ der Standardeigenschaft \PValue{level} mit 13\important{\PValue{afterpar},
+ \PValue{entryformat}, \PValue{entrynumberformat}, \PValue{indent},
+ \PValue{numsep}, \PValue{onendentry}, \PValue{onendlastentry},
+ \PValue{onstartentry}, \PValue{onstartfirstentry},
+ \PValue{pagenumberformat}, \PValue{prepagenumber}, \PValue{raggedright},
+ \PValue{rightindent}} weiteren Eigenschaften fast so viele Möglichkeiten
+ wie bei \PValue{tocline} zur Verfügung. Dieser Stil ist aber zwingend darauf
+ angewiesen, dass am Anfang aller anderen Stile und auch am Ende des
+ Verzeichnisses ein noch nicht beendeter Absatz tasächlich beendet
+ wird. Daher sollten Einträge dieses Stils nicht mit Einträgen oder
+ Verzeichnissen kombiniert werden, die an \Package{tocbasic} vorbei erzeugt
+ werden.
\item[\PValue{undottedtocline}] entspricht dem Stil, der von den
- Standardklassen \Class{book} und \Class{report} für die Ebene
- \PValue{chapter} und von \Class{article} für die Ebene \PValue{section}
+ Standardklassen \Class{book} und \Class{report} für die Ebene
+ \PValue{chapter} und von \Class{article} für die Ebene \PValue{section}
bekannt ist. Er kennt\important{\PValue{level}, \PValue{indent},
\PValue{numwidth}} nur drei Eigenschaften.
Vor dem Eintrag wird ein Seitenumbruch erleichtert und ein vertikaler
- Abstand eingefügt. Die Einträge werden um \PValue{indent} von links
+ Abstand eingefügt. Die Einträge werden um \PValue{indent} von links
eingezogen in \Macro{bfseries} ausgegeben. Dies ist gleichsam eine
- Abweichung von den Standardklassen, die selbst keinen Einzug für Einträge
+ Abweichung von den Standardklassen, die selbst keinen Einzug für Einträge
der genannten Ebenen bieten. \DescRef{\LabelBase.cmd.numberline} wird nicht
umdefiniert. Die Breite der Nummer wird von \PValue{numwidth} bestimmt. Bei
- mehrzeiligen Einträgen wird der Einzug ab der zweiten Zeile um
- \PValue{numwidth} erhöht. \autoref{fig:tocbasic.undottedtocline} illustriert
+ mehrzeiligen Einträgen wird der Einzug ab der zweiten Zeile um
+ \PValue{numwidth} erhöht. \autoref{fig:tocbasic.undottedtocline} illustriert
die Eigenschaften des Stils.
\begin{figure}
\centering
@@ -1293,7 +1320,7 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\makebox[1.5em][l]{\bfseries 1}%
\parbox[t]{\dimexpr \linewidth-4.05em\relax}{%
\bfseries
- Überschrift im Verzeichniseintragsstil \PValue{undottedtocline} mit
+ Ãœberschrift im Verzeichniseintragsstil \PValue{undottedtocline} mit
mehr als einer Zeile%
}%
\raisebox{-\baselineskip}{\makebox[2.55em][r]{\bfseries 3}}%
@@ -1316,220 +1343,293 @@ Derzeit werden von \Package{tocbasic} die folgenden Eintragsstile definiert:
\end{tikzpicture}%
}
\caption{Illustration einiger Attribute des Verzeichniseintragsstils
- \PValue{undottedtocline} am Beispiel einer Kapitelüberschrift}
+ \PValue{undottedtocline} am Beispiel einer Kapitelüberschrift}
\label{fig:tocbasic.undottedtocline}
\end{figure}
\end{description}
-Eine Erklärung zu den Eigenschaften der von \Package{tocbasic} definierten
+Eine Erklärung zu den Eigenschaften der von \Package{tocbasic} definierten
Stile findet sich in \autoref{tab:tocbasic.tocstyle.attributes}.
-Bei\ChangedAt{v3.21}{\Package{tocbasic}} Verwendung der Eigenschaften
-als Optionen für
-\DescRef{\LabelBase.cmd.DeclareNewTOC}\IndexCmd{DeclareNewTOC} (siehe
-\DescPageRef{\LabelBase.cmd.DeclareNewTOC}) sind die Namen der Eigenschaften
-mit dem Präfix \PValue{tocentry}, also beispielsweise \Option{tocentrylevel}
-anstelle von \PValue{level}, zu
-verwenden. Bei\ChangedAt{v3.20}{\Package{tocbasic}} Verwendung als
-Optionen für \DescRef{maincls-experts.cmd.DeclareSectionCommand}%
+Neben\ChangedAt{v3.27}{\Package{tocbasic}} der normalen Zuweisung eines Wertes
+in der Form \Option{\PName{Schlüssel}=\PName{Wert}} verstehen beide Befehle für
+die durch \KOMAScript{} definierten Stile für alle Optionen auch die
+Zuweisungen in der Form \Option{\PName{Schlüssel}:=\PName{Eintragsebene}}. In
+diesem Fall wird die aktuell gültige Einstellung für \PName{Eintragsebene}
+kopiert, soweit diese verfügbar ist. Es kann also beispielsweise mit
+\OptionValue{indent:}{figure} der Einzug für \PValue{figure}-Einträge kopiert
+werden. Für Optionen, die eine Länge oder einen Integer als \PName{Wert}
+erwarten, gibt es außerdem die Möglichkeit mit
+\Option{\PName{Schlüssel}+=\PName{Wert}} den \PName{Wert} zur aktuell gültigen
+Einstellung zu addieren. Für eine Substraktion kann ein negativer \PName{Wert}
+verwendet werden. Mit \OptionValue{indent+}{1cm} könnte so beispielsweise der
+Einzug um 1\Unit{cm} erhöht werden.
+
+Bei\ChangedAt{v3.21}{\Package{tocbasic}} Verwendung der Eigenschaften als
+Optionen für \DescRef{\LabelBase.cmd.DeclareNewTOC}\IndexCmd{DeclareNewTOC}
+(siehe \DescPageRef{\LabelBase.cmd.DeclareNewTOC}) sind die Namen der
+Eigenschaften mit dem Präfix \PValue{tocentry}, also beispielsweise
+\Option{tocentrylevel} anstelle von \PValue{level}, zu verwenden. Die zuvor
+beschriebene Kopiermöglichkeit mit \Option{:=} ist hierbei ebenfalls
+verfügbar. Die Addition mit Hilfe von \Option{+=} wird derzeit jedoch nicht
+unterstützt.
+
+Bei\ChangedAt{v3.20}{\Package{tocbasic}} Verwendung als Optionen
+für \DescRef{maincls-experts.cmd.DeclareSectionCommand}%
\IndexCmd{DeclareSectionCommand}\IndexCmd{DeclareNewSectionCommand}%
\IndexCmd{RedeclareSectionCommand}\IndexCmd{ProvideSectionCommand} (siehe
\DescPageRef{maincls-experts.cmd.DeclareSectionCommand}) und verwandten
-Anweisungen sind die Namen der Eigenschaften mit dem Präfix \PValue{toc} zu
+Anweisungen sind die Namen der Eigenschaften mit dem Präfix \PValue{toc} zu
versehen, also beispielsweise \Option{toclevel} anstelle von \PValue{level} zu
-verwenden.
+verwenden. Hierbei existiert derzeit weder die Kopiermöglichkeit mit
+\Option{:=} noch die Addition mit \Option{+=}.
-Letztlich führt der Aufruf von \Macro{DeclareTOCStyleEntry} zur Definition der
+Letztlich führt der Aufruf von \Macro{DeclareTOCStyleEntry} zur Definition der
Anweisung \Macro{l@\PName{Eintragsebene}}.
\begin{desclist}
\desccaption{%
- Attribute für die vordefinierten Verzeichniseintragsstile von
+ Attribute für die vordefinierten Verzeichniseintragsstile von
\Package{tocbasic}%
\label{tab:tocbasic.tocstyle.attributes}%
}{%
Attribute der Verzeichniseintragsstile (\emph{Fortsetzung})%
}%
- \entry{\OptionVName{beforeskip}{Länge}}{%
+ \entry{\OptionVName{afterpar}{Code}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Der angegebene \PName{Code} wird nach dem Ende des Absatzes ausgeführt, in
+ dem ein Eintrag mit dem Stil \PValue{toctext} ausgegeben wird. Verfügen
+ mehrere Einträge über solche Einstellungen, so werden diese in der
+ Reihenfolge der Einträge ausgeführt.%
+ }%
+ \entry{\OptionVName{beforeskip}{Länge}}{%
Vertikaler Abstand, der vor einem Eintrag dieser Ebene im Stil
- \PValue{tocline} eingefügt wird (siehe \autoref{fig:tocbasic.tocline}). Der
- Abstand wird je nach Ebene mit \Macro{vskip} oder \Macro{addvspace}
- eingefügt, so dass diesbezüglich möglichst Kompatibilität zu den
- Standardklassen und früheren Versionen von \KOMAScript{} besteht.
+ \PValue{tocline} eingefügt wird (siehe
+ \autoref{fig:tocbasic.tocline}). Der Abstand wird je nach Ebene mit
+ \Macro{vskip} oder \Macro{addvspace} eingefügt, so dass diesbezüglich
+ möglichst Kompatibilität zu den Standardklassen und früheren Versionen von
+ \KOMAScript{} besteht.
Bei der \PName{Eintragsebene} \PValue{part} wird das Attribut mit
\texttt{2.25em plus 1pt} initialisiert, bei \PValue{chapter} mit
\texttt{1em plus 1pt}. Ist noch keine \PName{Eintragsebene}
- \PValue{chapter} bekannt, wird stattdessen für \PValue{section}
+ \PValue{chapter} bekannt, wird stattdessen für \PValue{section}
\texttt{1em plus 1pt} verwendet. Ansonsten wird \PValue{section} wie alle
anderen Ebenen mit \texttt{0pt plus .2pt} initialisiert.%
}%
\entry{\OptionVName{breakafternumber}{Schalter}}{%
- \PName{Schalter} ist einer der Werte für einfache Schalter aus
+ \PName{Schalter} ist einer der Werte für einfache Schalter aus
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. Ist der
Schalter beim Stil \PValue{tocline} aktiviert, so wird nach der mit
\DescRef{\LabelBase.cmd.numberline}\IndexCmd{numberline} gesetzten Nummer
- eine neue Zeile begonnen, die erneut linksbündig mit der Nummer beginnt.
+ eine neue Zeile begonnen, die erneut linksbündig mit der Nummer beginnt.
In der Voreinstellung ist die Eigenschaft im Stil \PValue{tocline} nicht
gesetzt.
Ist %\textnote{Achtung!}
- für ein Verzeichnis mit \DescRef{\LabelBase.cmd.setuptoc} die Eigenschaft
+ für ein Verzeichnis mit \DescRef{\LabelBase.cmd.setuptoc} die Eigenschaft
\Option{numberline} gesetzt (siehe \autoref{sec:tocbasic.toc},
\DescPageRef{\LabelBase.cmd.setuptoc}), wie dies bei den
\KOMAScript-Klassen und Verwendung deren Option
\OptionValueRef{maincls}{toc}{numberline}%
- \IndexOption{toc~=\textKValue{numberline}} der Fall ist, führt dies auch
- dazu, dass bei nicht nummerierten Einträgen dennoch die Zeile mit der dann
+ \IndexOption{toc~=\textKValue{numberline}} der Fall ist, führt dies auch
+ dazu, dass bei nicht nummerierten Einträgen dennoch die Zeile mit der dann
leeren Nummer in der Formatierung von \Option{entrynumberformat} gesetzt
wird.%
}%
\entry{\OptionVName{dynnumwidth}{Schalter}}{%
- \PName{Schalter} ist einer der Werte für einfache Schalter aus
+ \PName{Schalter} ist einer der Werte für einfache Schalter aus
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. Ist der
Schalter beim Stil \PValue{tocline} aktiviert, gibt die Eigenschaft
- \PValue{numwidth} nur noch einen Minimalwert an. Übertrifft die beim
+ \PValue{numwidth} nur noch einen Minimalwert an. Ãœbertrifft die beim
letzten \LaTeX-Lauf ermittelte maximale Breite der Eintragsnummern
- gleicher Ebene zuzüglich des Wertes von \PValue{numsep} diesen
+ gleicher Ebene zuzüglich des Wertes von \PValue{numsep} diesen
Minimalwert, so wird stattdessen der ermittelte Wert verwendet.%
}%
\entry{\OptionVName{entryformat}{Befehl}}{%
- Über diese Eigenschaft kann die Formatierung des gesamten Eintrags
- verändert werden. Der dabei als Wert angegebene \PName{Befehl} hat genau
+ Ãœber diese Eigenschaft kann die Formatierung des gesamten Eintrags
+ verändert werden. Der dabei als Wert angegebene \PName{Befehl} hat genau
ein Argument zu erwarten. Dieses Argument ist nicht zwingend voll
expandierbar. Befehle wie \Macro{MakeUppercase}, die ein voll
- expandierbares Argument erwarten, dürfen an dieser Stelle also nicht
- verwendet werden. Font-Änderungen über \Option{entryformat} erfolgen
+ expandierbares Argument erwarten, dürfen an dieser Stelle also nicht
+ verwendet werden. Font-Änderungen über \Option{entryformat} erfolgen
ausgehend von \Macro{normalfont}\Macro{normalsize}. Es wird darauf
hingewiesen, dass die Ausgabe von \Option{linefill} und der Seitenzahl
- unabhängig von \Option{entryformat} sind. Siehe dazu auch die Eigenschaft
+ unabhängig von \Option{entryformat} sind. Siehe dazu auch die Eigenschaft
\Option{pagenumberformat}.
- Initialisiert wird die Eigenschaft für die \PName{Eintragsebene}
- \PValue{part} mit der Ausgabe des übergebenen Argument in
- \Macro{large}\Macro{bfseries} und für \PValue{chapter} in
+ Initialisiert wird die Eigenschaft für die \PName{Eintragsebene}
+ \PValue{part} mit der Ausgabe des übergebenen Argument in
+ \Macro{large}\Macro{bfseries} und für \PValue{chapter} in
\Macro{bfseries}. Falls bei der Initialisierung von \PValue{section} noch
- keine Ebene \PValue{chapter} existiert, wird auch für diese Ebene
+ keine Ebene \PValue{chapter} existiert, wird auch für diese Ebene
\Macro{bfseries} verwendet. Bei allen anderen Ebenen wird das Argument
- unverändert ausgegeben.%
+ unverändert ausgegeben.%
}%
\entry{\OptionVName{entrynumberformat}{Befehl}}{%
- Über diese Eigenschaft kann die Formatierung der mit
- \DescRef{\LabelBase.cmd.numberline} gesetzten Eintragsnummer verändert
+ Ãœber diese Eigenschaft kann die Formatierung der mit
+ \DescRef{\LabelBase.cmd.numberline} gesetzten Eintragsnummer verändert
werden. Der dabei als Wert angegebene \PName{Befehl} hat genau ein
- Argument zu erwarten. Font-Änderungen erfolgen ausgehend von der
+ Argument zu erwarten. Font-Änderungen erfolgen ausgehend von der
Eigenschaft \Option{entryformat}.
- Initialisiert wird die Eigenschaft mit Ausgabe des übergebenen
- Arguments. Die Eintragsnummer wird also unverändert ausgegeben.
+ Initialisiert wird die Eigenschaft mit Ausgabe des übergebenen
+ Arguments. Die Eintragsnummer wird also unverändert ausgegeben.
Ist %\textnote{Achtung!}
- für ein Verzeichnis mit \DescRef{\LabelBase.cmd.setuptoc} die Eigenschaft
+ für ein Verzeichnis mit \DescRef{\LabelBase.cmd.setuptoc} die Eigenschaft
\Option{numberline} gesetzt (siehe \autoref{sec:tocbasic.toc},
\DescPageRef{\LabelBase.cmd.setuptoc}), wie dies bei den
\KOMAScript-Klassen und Verwendung deren Option
\OptionValueRef{maincls}{toc}{numberline}%
- \IndexOption{toc~=\textKValue{numberline}} der Fall ist, führt dies auch
- dazu, dass bei nicht nummerierten Einträgen \PName{Befehl} dennoch
- ausgeführt wird.%
+ \IndexOption{toc~=\textKValue{numberline}} der Fall ist, führt dies auch
+ dazu, dass bei nicht nummerierten Einträgen \PName{Befehl} dennoch
+ ausgeführt wird.%
}%
- \entry{\OptionVName{indent}{Länge}}{%
- Horizontaler Abstand des Eintrags vom linken Rand (siehe
- \autoref{fig:tocbasic.dottedtocline} und \autoref{fig:tocbasic.tocline}).
-
- Beim Stil \PValue{tocline} wird für alle Eintragsebenen, deren Name mit
- »\texttt{sub}« beginnt, eine Initialisierung mit
- \PValue{indent}+\PValue{numwidth} der gleichnamigen Eintragsebene ohne
- diesen Präfix vorgenommen, falls eine solche Ebene mit entsprechenden
- Eigenschaften existiert. Bei den Stilen \PValue{dottedtocline},
- \PValue{undottedtocline} und \PValue{tocline} findet für die
- Eintragsebenen \PValue{part} bis \PValue{subparagraph} sowie
- \PValue{figure} und \PValue{table} eine Initialisierung mit Werten
+ \entry{%
+ \OptionVName{indent}{Länge}%
+ {\phantomsection\label{tab:tocbasic.tocstyle.attributes.indent}}%
+ }{%
+ Beim\ChangedAt{v3.27}{\Package{tocbasic}} Stil \PValue{toctext} ist
+ \PName{Länge} der horizontale Abstand des Absatzes vom linken Rand. Haben
+ die unterschiedlichen Einträge des Absatzes unterschiedliche
+ Einstellungen, so gewinnt der letzte Eintrag. Bei den übrigen Stilen ist
+ \PValue{Länge} entsprechend der horizontale Abstand des Eintrags vom
+ linken Rand (siehe \autoref{fig:tocbasic.dottedtocline} und
+ \autoref{fig:tocbasic.tocline}).
+
+ Bei den Stilen \PValue{tocline} und \PValue{toctext} wird für alle
+ Eintragsebenen, deren Name mit »\texttt{sub}« beginnt, eine
+ Initialisierung mit \PValue{indent}+\PValue{numwidth} der gleichnamigen
+ Eintragsebene ohne diesen Präfix vorgenommen, falls eine solche Ebene mit
+ entsprechenden Eigenschaften existiert. Bei den Stilen
+ \PValue{dottedtocline}, \PValue{undottedtocline} und \PValue{tocline}
+ findet für die Eintragsebenen \PValue{part} bis \PValue{subparagraph}
+ sowie \PValue{figure} und \PValue{table} eine Initialisierung mit Werten
entsprechend der Standardklassen statt. Alle anderen Ebenen erhalten keine
- Initialisierung. Für sie ist eine explizite Angabe daher bei der ersten
- Verwendung zwingend.%
+ Initialisierung. Für sie ist eine explizite Angabe daher bei der ersten
+ Verwendung zwingend.
+
+ Ist für ein Verzeichnis die Eigenschaft \PValue{noindent} via
+ \DescRef{\LabelBase.cmd.setuptoc} gesetzt, so ignorieren die Einträge bei
+ allen von \KOMAScript{} bereitgestellten Stilen diesen Wert und verwenden
+ stattdessen 0\Unit{pt}. Der Einzug wird also deaktiviert.%
}%
\entry{\OptionVName{level}{Integer}}{%
- Nummerischer Wert der \PName{Eintragsebene}. Tatsächlich angezeigt werden
- nur Einträge, deren nummerische Ebene nicht größer als Zähler
+ Nummerischer Wert der \PName{Eintragsebene}. Tatsächlich angezeigt werden
+ nur Einträge, deren nummerische Ebene nicht größer als Zähler
\DescRef{\LabelBase.counter.tocdepth}%
%\important{\DescRef{\LabelBase.counter.tocdepth}}
\IndexCounter{tocdepth}
ist.
- Diese Eigenschaft ist für alle Stile zwingend und wird bei der
+ Diese Eigenschaft ist für alle Stile zwingend und wird bei der
Definition eines Stils automatisch definiert.
- Beim Stil \PValue{tocline} findet für alle Eintragsebenen, deren Name
- mit »\texttt{sub}« beginnt, eine Initialisierung entsprechend dem
- um eins erhöhten Wert einer gleichnamigen Eintragsebene ohne
- diesen Präfix statt, falls eine solche Ebene existiert. Bei den Stilen
- \PValue{dottedtocline}, \PValue{largetocline}, \PValue{tocline} und
- \PValue{undottedtocline} findet für die \PName{Eintragsebene}
- \PValue{part}, \PValue{chapter}, \PValue{section}, \PValue{subsection},
- \PValue{subsubsection}, \PValue{paragraph}, \PValue{subparagraph},
- \PValue{figure} und \PValue{table} automatisch eine Initialisierung
- aufgrund des Namens statt. Für andere Ebenen findet eine Initialisierung
- mit dem Wert der Gliederungsebene statt, falls kompatibel zu den
- \KOMAScript-Klassen \Macro{\PName{Eintragsebene}numdepth} definiert
- ist.%
+ Beim Stil \PValue{tocline} und \PValue{toctext} findet für alle
+ Eintragsebenen, deren Name mit »\texttt{sub}« beginnt, eine
+ Initialisierung entsprechend dem um eins erhöhten Wert einer gleichnamigen
+ Eintragsebene ohne diesen Präfix statt, falls eine solche Ebene
+ existiert. Bei den Stilen \PValue{dottedtocline}, \PValue{largetocline},
+ \PValue{tocline}, \PValue{toctext} und \PValue{undottedtocline} findet für
+ die \PName{Eintragsebene} \PValue{part}, \PValue{chapter},
+ \PValue{section}, \PValue{subsection}, \PValue{subsubsection},
+ \PValue{paragraph}, \PValue{subparagraph}, \PValue{figure} und
+ \PValue{table} automatisch eine Initialisierung aufgrund des Namens
+ statt. Für andere Ebenen findet eine Initialisierung mit dem Wert der
+ Gliederungsebene statt, falls kompatibel zu den \KOMAScript-Klassen
+ \Macro{\PName{Eintragsebene}numdepth} definiert ist.%
}%
\entry{\OptionVName{linefill}{Code}}{%
Beim Stil \PValue{tocline} kann zwischen dem Ende des Eintragstextes und
- der Seitenzahl die Art der Füllung verändert werden. Die Eigenschaft
- \PName{linefill} erhält als Wert direkt den gewünschten \PName{Code}.
- Für \PName{Eintragsebene} \PValue{part} und \PValue{chapter} wird die
- Eigenschaft mit \Macro{hfill} initialisiert. Dadurch rückt die Seitenzahl
+ der Seitenzahl die Art der Füllung verändert werden. Die Eigenschaft
+ \PName{linefill} erhält als Wert direkt den gewünschten \PName{Code}. Für
+ \PName{Eintragsebene} \PValue{part} und \PValue{chapter} wird die
+ Eigenschaft mit \Macro{hfill} initialisiert. Dadurch rückt die Seitenzahl
an den rechten Rand. Ist bisher keine \PName{Eintragsebene}
- \PValue{chapter} definiert, so gilt dies auch für \PValue{section}. Alle
- anderen Ebenen werden mit \DescRef{\LabelBase.cmd.TOCLineLeaderFill} (siehe
- \DescPageRef{\LabelBase.cmd.TOCLineLeaderFill}) initialisiert.
+ \PValue{chapter} definiert, so gilt dies auch für \PValue{section}. Alle
+ anderen Ebenen werden mit \DescRef{\LabelBase.cmd.TOCLineLeaderFill}
+ (siehe \DescPageRef{\LabelBase.cmd.TOCLineLeaderFill}) initialisiert.
- Wird \PName{Code} angegeben, der nicht automatisch zu einer Füllung des
- Abstandes führt, sollte übrigens auch die Eigenschaft
+ Wird \PName{Code} angegeben, der nicht automatisch zu einer Füllung des
+ Abstandes führt, sollte übrigens auch die Eigenschaft
\PValue{raggedpagenumber} gesetzt werden, damit es nicht zu
- »\texttt{underfull \Macro{hbox}}«-Meldungen kommt.%
+ »\texttt{underfull \Macro{hbox}}«-Meldungen kommt.%
}%
- \entry{\OptionVName{numsep}{Länge}}{%
+ \entry{\OptionVName{numsep}{Länge}}{%
Der Stil \PValue{tocline} versucht sicherzustellen, dass zwischen der
Nummer und dem Text eines Eintrags mindestens ein Abstand von
- \PName{Länge} eingehalten wird. Bei aktiviertem \PValue{dynnumwidth} kann
- die für die Nummer reservierte Breite \PValue{numwidth} entsprechend
+ \PName{Länge} eingehalten wird. Bei aktiviertem \PValue{dynnumwidth} kann
+ die für die Nummer reservierte Breite \PValue{numwidth} entsprechend
korrigiert werden. Bei nicht aktiviertem \PValue{dynnumwidth} wird
hingegen lediglich eine Warnung ausgegeben, wenn diese Bedingung nicht
eingehalten wird.
+ Der\ChangedAt{v3.27}{\Package{tocbasic}} Stil \PValue{toctext} fügt
+ dagegen immer einen Abstand dieser \PName{Länge} nach der Nummer des
+ Eintrags ein.
+
Die Eigenschaft wird mit einem Wert von 0,4\Unit{em} initialisiert.%
}%
- \entry{\OptionVName{numwidth}{Länge}}{%
- Für die Nummer eines Eintrags reservierte Breite (siehe
+ \entry{\OptionVName{numwidth}{Länge}}{%
+ Für die Nummer eines Eintrags reservierte Breite (siehe
\autoref{fig:tocbasic.dottedtocline} bis
\autoref{fig:tocbasic.undottedtocline}). Dieser Wert wird bei den
Stilen \PValue{dottedtocline}, \PValue{tocline} und
\PValue{undottedtocline} ab der zweiten Zeile eines Eintrags zum linken
Einzug hinzugerechnet.
- Beim Stil \PValue{tocline} wird für alle Eintragsebenen, deren Name mit
- »\texttt{sub}« beginnt, eine Initialisierung mit dem Wert der
- gleichnamigen Eintragsebene ohne diesen Präfix zuzüglich 0,9\Unit{em}
- vorgenommen, falls eine solche Ebene mit entsprechender
- Eigenschaften existiert. Bei den Stilen \PValue{dottedtocline},
- \PValue{undottedtocline} und \PValue{tocline} findet für die
- Eintragsebenen \PValue{part} bis \PValue{subparagraph} sowie
- \PValue{figure} und \PValue{table} eine Initialisierung mit Werten
- entsprechend der Standardklassen statt. Alle anderen Ebenen erhalten keine
- Initialisierung. Für sie ist eine explizite Angabe daher bei der
- ersten Verwendung zwingend.%
+ Beim Stil \PValue{tocline} wird für alle Eintragsebenen, deren Name mit
+ »\texttt{sub}« beginnt, eine Initialisierung mit dem Wert der
+ gleichnamigen Eintragsebene ohne diesen Präfix zuzüglich 0,9\Unit{em}
+ vorgenommen, falls eine solche Ebene mit entsprechender Eigenschaft
+ existiert. Bei den Stilen \PValue{dottedtocline}, \PValue{undottedtocline}
+ und \PValue{tocline} findet für die Eintragsebenen \PValue{part} bis
+ \PValue{subparagraph} sowie \PValue{figure} und \PValue{table} eine
+ Initialisierung mit Werten entsprechend der Standardklassen statt. Alle
+ anderen Ebenen erhalten keine Initialisierung. Für sie ist eine explizite
+ Angabe daher bei der ersten Verwendung zwingend.%
+ }%
+ \entry{\OptionVName{onendentry}{Code}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Führt den angegebenen \PName{Code} unmittelbar nach einem Eintrag im Stil
+ \PValue{toctext} aus, sofern es nicht der letzte Eintrag im Absatz
+ ist. Der Anwender muss unbedingt sicherstellen, dass \PName{Code} auf
+ keinen Fall zum Beenden des Absatzes führt.
+
+ Hinweis: Tatsächlich wird der \PName{Code} gar nicht am Ende des Eintrags,
+ sondern vor dem nächsten Eintrag im Stil \PValue{toctext} ausgeführt.%
+ }%
+ \entry{\OptionVName{onendlastentry}{Code}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Führt den angegebenen \PName{Code} unmittelbar vor dem Ende des Absatzes
+ mit dem Eintrag im Stil \PValue{toctext} aus, sofern es sich um den
+ letzten Eintrag im Absatz handelt. Der Anwender sollte sicherstellen, dass
+ \PName{Code} nicht zum Beenden des Absatzes führt.%
+ }%
+ \entry{\OptionVName{onstartentry}{Code}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Führt den angegebenen \PName{Code} unmittelbar vor dem Eintrag im Stil
+ \PValue{toctext} aus, sofern es sich nicht um den ersten Eintrag im Absatz
+ handelt. Der Anwender muss unbedingt sicherstellen, dass \PName{Code} auf
+ keinen Fall zum Beenden des Absatzes führt.%
+ }%
+ \entry{\OptionVName{onstartfirstentry}{Code}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Führt den angegebenen \PName{Code} unmittelbar vor dem Eintrag im Stil
+ \PValue{toctext} aus, sofern es sich um den ersten Eintrag im Absatz
+ handelt. Der Anwender sollte sicherstellen, dass \PName{Code} den
+ Absatz nicht bereits beginnt.%
}%
\entry{\OptionVName{onstarthigherlevel}{Code}}{%
Der Stil \PValue{tocline} kann zu Beginn eines Eintrags eine Aktion in
- Abhängigkeit davon ausführen, ob der zuletzt gesetzte Eintrag einen
- höheren, denselben oder einen niedrigeren \PName{level}-Wert
- hatte. Im Falle, dass der aktuelle Eintrag einen größeren
- \PName{level}-Wert besitzt, in der Hierarchie der Einträge also tiefer
- steht, wird der über diese Eigenschaft angegebene \PName{Code} ausgeführt.
+ Abhängigkeit davon ausführen, ob der zuletzt gesetzte Eintrag einen
+ höheren, denselben oder einen niedrigeren \PName{level}-Wert hatte. Im
+ Falle, dass der aktuelle Eintrag einen größeren \PName{level}-Wert
+ besitzt, in der Hierarchie der Einträge also tiefer steht, wird der über
+ diese Eigenschaft angegebene \PName{Code} ausgeführt.
- Die Erkennung funktioniert übrigens nur, solange sich \Macro{lastpenalty}
- seit dem letzten Eintrag nicht geändert hat.
+ Die Erkennung funktioniert übrigens nur, solange sich \Macro{lastpenalty}
+ seit dem letzten Eintrag nicht geändert hat.
Initialisiert wird die Eigenschaft mit
\DescRef{\LabelBase.cmd.LastTOCLevelWasLower} (siehe
@@ -1537,90 +1637,123 @@ Anweisung \Macro{l@\PName{Eintragsebene}}.
}%
\entry{\OptionVName{onstartlowerlevel}{Code}}{%
Der Stil \PValue{tocline} kann zu Beginn eines Eintrags eine Aktion in
- Abhängigkeit davon ausführen, ob der zuletzt gesetzte Eintrag einen
- höheren, denselben oder einen niedrigeren \PName{level}-Wert hatte. Im
+ Abhängigkeit davon ausführen, ob der zuletzt gesetzte Eintrag einen
+ höheren, denselben oder einen niedrigeren \PName{level}-Wert hatte. Im
Falle, dass der aktuelle Eintrag einen kleineren \PName{level}-Wert
- besitzt, in der Hierarchie der Einträge also höher steht, wird der über
- diese Eigenschaft angegebene \PName{Code} ausgeführt.
+ besitzt, in der Hierarchie der Einträge also höher steht, wird der über
+ diese Eigenschaft angegebene \PName{Code} ausgeführt.
- Die Erkennung funktioniert übrigens nur, solange sich \Macro{lastpenalty}
- seit dem letzten Eintrag nicht geändert hat.
+ Die Erkennung funktioniert übrigens nur, solange sich \Macro{lastpenalty}
+ seit dem letzten Eintrag nicht geändert hat.
Initialisiert wird die Eigenschaft mit
\DescRef{\LabelBase.cmd.LastTOCLevelWasHigher} (siehe
\DescPageRef{\LabelBase.cmd.LastTOCLevelWasHigher}), was normalerweise
- dazu führt, dass ein Umbruch vor dem Eintrag begünstigt wird.%
+ dazu führt, dass ein Umbruch vor dem Eintrag begünstigt wird.%
}%
\entry{\OptionVName{onstartsamelevel}{Code}}{%
Der Stil \PValue{tocline} kann zu Beginn eines Eintrags eine Aktion in
- Abhängigkeit davon ausführen, ob der zuletzt gesetzte Eintrag einen
- höheren, denselben oder einen niedrigeren \PName{level}-Wert hatte. Im
+ Abhängigkeit davon ausführen, ob der zuletzt gesetzte Eintrag einen
+ höheren, denselben oder einen niedrigeren \PName{level}-Wert hatte. Im
Falle, dass der aktuelle Eintrag denselben \PName{level}-Wert besitzt, in
- der Hierarchie der Einträge also gleich gestellt ist, wird der über diese
- Eigenschaft angegebene \PName{Code} ausgeführt.
+ der Hierarchie der Einträge also gleich gestellt ist, wird der über diese
+ Eigenschaft angegebene \PName{Code} ausgeführt.
- Die Erkennung funktioniert übrigens nur, solange sich \Macro{lastpenalty}
- seit dem letzten Eintrag nicht geändert hat.
+ Die Erkennung funktioniert übrigens nur, solange sich \Macro{lastpenalty}
+ seit dem letzten Eintrag nicht geändert hat.
Initialisiert wird die Eigenschaft mit
\DescRef{\LabelBase.cmd.LastTOCLevelWasSame} (siehe
\DescPageRef{\LabelBase.cmd.LastTOCLevelWasSame}), was normalerweise dazu
- führt, dass ein Umbruch vor dem Eintrag begünstigt wird.%
+ führt, dass ein Umbruch vor dem Eintrag begünstigt wird.%
}%
\entry{\OptionVName{pagenumberbox}{Befehl}}{%
- Normalerweise wird die zu einem Eintrag gehörende Seitenzahl rechtsbündig
+ Normalerweise wird die zu einem Eintrag gehörende Seitenzahl rechtsbündig
in eine Box der Breite \Macro{@pnumwidth} gesetzt. Beim Stil
- \PValue{tocline} kann der Befehl, der dazu verwendet wird, über diese
+ \PValue{tocline} kann der Befehl, der dazu verwendet wird, über diese
Eigenschaft konfiguriert werden. Der dabei anzugebende \PName{Befehl} hat
genau ein Argument zu erwarten.
- Initialisiert wird die Eigenschaft mit der bereits erwähnten Box.%
+ Initialisiert wird die Eigenschaft mit der bereits erwähnten Box.%
}%
\entry{\OptionVName{pagenumberformat}{Befehl}}{%
- Über diese Eigenschaft kann die Formatierung der Seitenzahl des Eintrags
- verändert werden. Der dabei als Wert angegebene \PName{Befehl} hat genau
- ein Argument zu erwarten. Font-Änderungen über \Option{entryformat}
+ Ãœber diese Eigenschaft kann die Formatierung der Seitenzahl des Eintrags
+ verändert werden. Der dabei als Wert angegebene \PName{Befehl} hat genau
+ ein Argument zu erwarten. Font-Änderungen über \Option{entryformat}
erfolgen ausgehend von \Option{entryformat}, gefolgt von
\Macro{normalfont}\Macro{normalsize}.
- Initialisiert wird die Eigenschaft für die \PName{Eintragsebene}
- \PValue{part} mit der Ausgabe des übergebenen Arguments in
- \Macro{large}\Macro{bfseries}. Für alle anderen Ebenen erfolgt die Ausgabe
+ Initialisiert wird die Eigenschaft für die \PName{Eintragsebene}
+ \PValue{part} mit der Ausgabe des übergebenen Arguments in
+ \Macro{large}\Macro{bfseries}. Für alle anderen Ebenen erfolgt die Ausgabe
in \Macro{normalfont}\Macro{normalcolor}.%
}%
+ \entry{\OptionVName{pagenumberwidth}{Länge}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Mit dieser Eigenschaft kann die Breite der Standardbox für die Seitenzahl
+ eines Eintrags im Stil \PValue{tocline} von \Macro{@pnumwidth} in die
+ angegebene \PName{Länge} geändert werden. Es ist zu beachten, dass bei
+ Änderung des Befehls für die Box über die Eigenschaft
+ \Option{pagenumberbox} die angegebene \PName{Länge} nicht mehr automatisch
+ Anwendung findet.%
+ }%
+ \entry{\OptionVName{prepagenumber}{Code}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Im Stil \PValue{toctext} wird zwischen dem Eintragstext und der Seitenzahl
+ \PName{Code} ausgeführt. Dies dient in erster Linie dazu, Abstand oder
+ Trennzeichen zwischen Text und Seitenzahl einzufügen.%
+
+ Voreingestellt ist mit \Macro{nonbreakspace} ein nicht umbrechbares
+ Leerzeichen.%
+ }%
\entry{\OptionVName{raggedentrytext}{Schalter}}{%
\ChangedAt{v3.21}{\Package{tocbasic}}%
- \PName{Schalter} ist einer der Werte für einfache Schalter aus
+ \PName{Schalter} ist einer der Werte für einfache Schalter aus
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}.
Ist der Schalter beim Stil \PValue{tocline} aktiviert, so wird der Text
des Eintrags nicht im Blocksatz, sondern im Flattersatz gesetzt. Dabei
- werden nur noch Wörter getrennt, die länger als eine Zeile sind.
+ werden nur noch Wörter getrennt, die länger als eine Zeile sind.
In der Voreinstellung ist dieser Schalter nicht gesetzt.%
}%
\entry{\OptionVName{raggedpagenumber}{Schalter}}{%
- \PName{Schalter} ist einer der Werte für einfache Schalter aus
+ \PName{Schalter} ist einer der Werte für einfache Schalter aus
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}.
Ist der Schalter beim Stil \PValue{tocline} aktiviert, so wird die
- Seitenzahl nicht zwingend rechtsbündig gesetzt.
+ Seitenzahl nicht zwingend rechtsbündig gesetzt.
Je nach Wert der Eigenschaft \PValue{linefill} kann sich das
Setzen dieses Schalters nur im Erscheinen oder Verschwinden einer Warnung
- oder auch konkret in der Formatierung der Einträge auswirken. Es ist also
+ oder auch konkret in der Formatierung der Einträge auswirken. Es ist also
wichtig, diese beiden Eigenschaften zueinander passend zu setzen.
In der Voreinstellung ist dieser Schalter nicht gesetzt und passt damit
zur Initialisierung von \PValue{linefill} sowohl mit \Macro{hfill} als
auch mit \DescRef{\LabelBase.cmd.TOCLineLeaderFill}.%
}%
+ \entry{\OptionVName{raggedright}{Schalter}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ \PName{Schalter} ist einer der Werte für einfache Schalter aus
+ \autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}.
+ Ist der Schalter innerhalb eines Absatzes bei irgend einem Eintrag im Stil
+ \PValue{toctext} gesetzt, so wird der komplette Absatz in linksbündigem
+ Flattersatz gesetzt.%
+ }%
+ \entry{\OptionVName{rightindent}{Länge}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Mit dieser Eigenschaft kann der rechte Rand für den Text eines Eintrags im
+ Stil \PValue{tocline} von \Macro{@tocrmarg} in die angegebene
+ \PName{Länge} geändert werden. Beim Stil \PValue{toctext} wird
+ entsprechend der rechte Rand für den kompletten Absatz eingestellt.%
+ }%
\end{desclist}
-Während \Macro{DeclareTOCStyleEntry} nur genau eine \PName{Eintragsebene}
-definiert, kann über
+Während \Macro{DeclareTOCStyleEntry} nur genau eine \PName{Eintragsebene}
+definiert, kann über
\Macro{DeclareTOCStyeEntries}\ChangedAt{v3.26}{\Package{tocbasic}} auf einen
Schlag eine ganze \PName{Liste von Eintragsebenen} definiert werden. Die durch
Komma voneinander getrennt angegebenen Eintragsebenen der Liste werden dabei
-alle mit demselben \PName{Stil} und den über \PName{Optionenliste}
+alle mit demselben \PName{Stil} und den über \PName{Optionenliste}
angegebenen Einstellungen definiert.%
\EndIndexGroup
@@ -1629,76 +1762,76 @@ angegebenen Einstellungen definiert.%
\OParameter{Initialisierungscode}
\Parameter{Befehlscode}
\Macro{DefineTOCEntryOption}\Parameter{Option}
- \OParameter{Säumniswert}
+ \OParameter{Säumniswert}
\Parameter{Code}
\Macro{DefineTOCEntryBooleanOption}\Parameter{Option}
- \OParameter{Säumniswert}
- \Parameter{Präfix}
+ \OParameter{Säumniswert}
+ \Parameter{Präfix}
\Parameter{Postfix}
- \Parameter{Erklärung}
+ \Parameter{Erklärung}
%\OParameter{Initialisierungscode}
\Macro{DefineTOCEntryCommandOption}\Parameter{Option}
- \OParameter{Säumniswert}
- \Parameter{Präfix}
+ \OParameter{Säumniswert}
+ \Parameter{Präfix}
\Parameter{Postfix}
- \Parameter{Erklärung}
+ \Parameter{Erklärung}
%\OParameter{Initialisierungscode}
\Macro{DefineTOCEntryIfOption}\Parameter{Option}
- \OParameter{Säumniswert}
- \Parameter{Präfix}%
+ \OParameter{Säumniswert}
+ \Parameter{Präfix}%
\Parameter{Postfix}
- \Parameter{Erklärung}
+ \Parameter{Erklärung}
% \OParameter{Initialisierungscode}
\Macro{DefineTOCEntryLengthOption}\Parameter{Option}
- \OParameter{Säumniswert}
- \Parameter{Präfix}
+ \OParameter{Säumniswert}
+ \Parameter{Präfix}
\Parameter{Postfix}
- \Parameter{Erklärung}
+ \Parameter{Erklärung}
% \OParameter{Initialisierungscode}
\Macro{DefineTOCEntryNumberOption}\Parameter{Option}
- \OParameter{Säumniswert}
- \Parameter{Präfix}
+ \OParameter{Säumniswert}
+ \Parameter{Präfix}
\Parameter{Postfix}
- \Parameter{Erklärung}
+ \Parameter{Erklärung}
% \OParameter{Initialisierungscode}
\end{Declaration}
-\Macro{DeclareTOCEntryStyle}\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} ist
+\Macro{DeclareTOCEntryStyle}\ChangedAt{v3.20}{\Package{tocbasic}} ist
eine der komplexesten Anweisungen in \KOMAScript. Sie richtet sich daher
-ausdrücklich an \LaTeX-Entwickler und nicht an \LaTeX-Anwender. Mit ihrer
-Hilfe ist es möglich, einen neuen \PName{Stil} für Verzeichniseinträge zu
-definieren. Üblicherweise werden Verzeichniseinträge mit
+ausdrücklich an \LaTeX-Entwickler und nicht an \LaTeX-Anwender. Mit ihrer
+Hilfe ist es möglich, einen neuen \PName{Stil} für Verzeichniseinträge zu
+definieren. Üblicherweise werden Verzeichniseinträge mit
\Macro{addcontentsline}\IndexCmd{addcontentsline} oder bei Verwendung von
\Package{tocbasic} vorzugsweise mit
\DescRef{\LabelBase.cmd.addxcontentsline}\IndexCmd{addxcontentsline} (siehe
\autoref{sec:tocbasic.basics}, \DescPageRef{\LabelBase.cmd.addxcontentsline})
-erzeugt. Dabei schreibt \LaTeX{} eine zugehörige Anweisung
+erzeugt. Dabei schreibt \LaTeX{} eine zugehörige Anweisung
\Macro{contentsline}\IndexCmd{contentsline} in die jeweilige Hilfsdatei. Bei
-Einlesen dieser Hilfsdatei führt \LaTeX{} dann für jedes \Macro{contentsline}
+Einlesen dieser Hilfsdatei führt \LaTeX{} dann für jedes \Macro{contentsline}
eine Anweisung \Macro{l@\PName{Eintragsebene}} aus.
-Wird später einer \PName{Eintragsebene} über
+Wird später einer \PName{Eintragsebene} über
\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry} ein \PName{Stil} zugewiesen, so
-wird zunächst \PName{Initialisierungscode} ausgeführt falls angegeben und dann
-\PName{Befehlscode} für die Definition von \Macro{l@\PName{Eintragsebene}}
+wird zunächst \PName{Initialisierungscode} ausgeführt falls angegeben und dann
+\PName{Befehlscode} für die Definition von \Macro{l@\PName{Eintragsebene}}
verwendet. \PName{Befehlscode} ist also letztlich der Code, der bei
-\Macro{l@\PName{Eintragsebene}} ausgeführt wird. Dabei ist \texttt{\#1} der
-Name der Eintragsebene, während \texttt{\#\#1} und \texttt{\#\#2} Platzhalter
-für die beiden Argumente von \Macro{l@\PName{Eintragsebene}} sind.
+\Macro{l@\PName{Eintragsebene}} ausgeführt wird. Dabei ist \texttt{\#1} der
+Name der Eintragsebene, während \texttt{\#\#1} und \texttt{\#\#2} Platzhalter
+für die beiden Argumente von \Macro{l@\PName{Eintragsebene}} sind.
Der \PName{Initialisierungscode} dient einerseits dazu, die Einstellungen
eines Stils zu initialisieren. Entwickler\textnote{Empfehlung!} sollten darauf
achten, dass wirklich alle Einstellungen hier bereits einen Wert erhalten. Nur
dann funktioniert \DescRef{\LabelBase.cmd.DeclareTOCStyleEntry} auch ohne
-Angabe einer \PName{Optionenliste} fehlerfrei. Darüber hinaus hat der
+Angabe einer \PName{Optionenliste} fehlerfrei. Darüber hinaus hat der
\PName{Initialisierungscode} auch alle Optionen, die der jeweilige Stil
versteht, zu definieren. Zwingend vordefiniert wird lediglich
-\Option{level}. Der eingestellte Wert für \Option{level} kann in
+\Option{level}. Der eingestellte Wert für \Option{level} kann in
\PName{Befehlscode} mit \Macro{@nameuse}\PParameter{\#1tocdepth}%
\important{\Macro{\PName{Eintragsebene}tocdepth}} abgefragt werden, um ihn
-beispielsweise mit dem Wert des Zählers
+beispielsweise mit dem Wert des Zählers
\DescRef{\LabelBase.counter.tocdepth}\IndexCounter{tocdepth} zu vergleichen.
-Zur Definition neuer Optionen für die Eigenschaften einer
+Zur Definition neuer Optionen für die Eigenschaften einer
Eintragsebene existieren nur innerhalb von \PName{Initialisierungscode} die
Anweisungen \iffree{\Macro{DefineTOCEntryBooleanOption},
\Macro{DefineTOCEntryCommandOption}, \Macro{DefineTOCEntryIfOption},
@@ -1706,17 +1839,31 @@ Anweisungen \iffree{\Macro{DefineTOCEntryBooleanOption},
\Macro{DefineTOCEntryNumberOption}}{\Macro{DefineTOCEntry\dots Option}}.
Diese Anweisungen definieren jeweils eine \PName{Option}, die bei ihrem
Aufruf eine Anweisung
-\Macro{\PName{Präfix}\PName{Eintragsebene}\PName{Postfix}} mit dem übergebenen
-Wert oder bei Fehlen einer Wertzuweisung mit dem \PName{Säumniswert}
+\Macro{\PName{Präfix}\PName{Eintragsebene}\PName{Postfix}} mit dem übergebenen
+Wert oder bei Fehlen einer Wertzuweisung mit dem \PName{Säumniswert}
definieren. Eine Besonderheit stellt \Macro{DefineTOCEntryIfOption} dar. Diese
-definiert \Macro{\PName{Präfix}\PName{Eintragsebene}\PName{Postfix}} immer als
-Anweisung mit zwei Argumenten. Ist der an die Option übergebene Wert einer der
+definiert \Macro{\PName{Präfix}\PName{Eintragsebene}\PName{Postfix}} immer als
+Anweisung mit zwei Argumenten. Ist der an die Option übergebene Wert einer der
Aktivierungswerte aus \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}, so expandiert die Anweisung zum ersten
-Argument. Ist der an die Option übergebene Wert hingegen ein
+Argument. Ist der an die Option übergebene Wert hingegen ein
Deaktivierungswert, so expandiert die Anweisung zum zweiten Argument.
-Die \PName{Erklärung} sollte ein möglichst kurzer Text sein, der den Sinn der
+Neben\ChangedAt{v3.27}{\Package{tocbasic}} den normalen Optionen der Form
+\Option{\PName{Schlüssel}=\PName{Wert}} werden von allen fünf
+\Macro{DefineTOCEntry\dots Option}-Anweisungen automatisch Optionen der Form
+\Option{\PName{Schlüssel}:=\PName{Eintragsebene}} definiert. Diese dienen
+dazu, den Wert einer anderen \PName{Eintragsebene} zu kopieren, sofern der
+Wert in einem Makro mit gleichem \PName{Präfix} und \PName{Postfix}
+gespeichert ist. Bei den von \Package{tocbasic} vordefinierten Stilen ist das
+für gleichnamige Optionen über Stilgrenzen hinweg der Fall. Von
+\Macro{DefineTOCEntryLengthOption} und \Macro{DefineTOCEntryNumberOption}
+werden außerdem Optionen der Form \Option{\PName{Schlüssel}+=\PName{Wert}} mit
+definiert, die dazu dienen, zu dem in
+\Macro{\PName{Präfix}\PName{Eintragsebene}\PName{Postfix}} bereits
+gespeicherten Wert den neuen \PName{Wert} zu addieren.
+
+Die \PName{Erklärung} sollte ein möglichst kurzer Text sein, der den Sinn der
Option mit wenigen Schlagworten beschreibt. Er wird von \Package{tocbasic} bei
Fehlermeldungen, Warnungen und Informationen auf dem Terminal und in der
\File{log}-Datei ausgegeben.
@@ -1725,11 +1872,11 @@ Der einfachste Stil von \Package{tocbasic}, \PValue{gobble}, wurde mit
\begin{lstcode}
\DeclareTOCEntryStyle{gobble}{}%
\end{lstcode}
-definiert. Würde man nun mit
+definiert. Würde man nun mit
\begin{lstcode}
\DeclareTOCStyleEntry[level=1]{gobble}{dummy}
\end{lstcode}
-eine Eintragsebene \PValue{dummy} in diesem Stil definieren, so würde das
+eine Eintragsebene \PValue{dummy} in diesem Stil definieren, so würde das
unter anderem
\begin{lstcode}
\def\dummytocdepth{1}
@@ -1744,7 +1891,7 @@ Innerhalb von Stil \PValue{tocline} wird beispielsweise
{filling between text and page number}%
\end{lstcode}
verwendet, um Option \Option{linefill} zu definieren. Durch die Angabe von
-\DescRef{\LabelBase.cmd.TOCLineLeaderFill} als \PName{Säumniswert} würde ein
+\DescRef{\LabelBase.cmd.TOCLineLeaderFill} als \PName{Säumniswert} würde ein
Aufruf wie
\begin{lstcode}
\DeclareTOCStyleEntry[linefill]{tocline}{part}
@@ -1755,29 +1902,29 @@ unter anderem die Definition
\end{lstcode}
vornehmen.
-Wer\textnote{Tipp!} sich selbst einen Stil definieren möchte, dem sei
-empfohlen, zunächst die Definition des Stils \PValue{dottedtocline} zu
+Wer\textnote{Tipp!} sich selbst einen Stil definieren möchte, dem sei
+empfohlen, zunächst die Definition des Stils \PValue{dottedtocline} zu
studieren. Nachdem dessen Definition verstanden wurde, gibt dann die deutlich
komplexere Definition von Stil \PValue{tocline} viele Hinweise darauf, wie die
Anweisungen sinnvoll zu verwenden sind.
-In\textnote{Tipp!} vielen Fällen wird es jedoch auch ausreichen, einen der
+In\textnote{Tipp!} vielen Fällen wird es jedoch auch ausreichen, einen der
vorhandenen Stile mit \DescRef{\LabelBase.cmd.CloneTOCEntryStyle} zu klonen
und dann dessen Initialisierungscode mit Anweisung
\DescRef{\LabelBase.cmd.TOCEntryStyleInitCode} oder
-\DescRef{\LabelBase.cmd.TOCEntryStyleStartInitCode} abzuändern.
+\DescRef{\LabelBase.cmd.TOCEntryStyleStartInitCode} abzuändern.
-\Macro{DefineTOCEntryOption} dient eher der Definition der übrigen
+\Macro{DefineTOCEntryOption} dient eher der Definition der übrigen
Anweisungen und sollte in der Regel nicht direkt verwendet
-werden. Normalerweise besteht dafür auch keine Notwendigkeit. Sie sei hier
-nur der Vollständigkeit halber erwähnt.%
+werden. Normalerweise besteht dafür auch keine Notwendigkeit. Sie sei hier
+nur der Vollständigkeit halber erwähnt.%
\EndIndexGroup
\begin{Declaration}
\Macro{CloneTOCEntryStyle}\Parameter{Stil}\Parameter{neuer Stil}%
\end{Declaration}
-Mit\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} dieser Anweisung kann ein
+Mit\ChangedAt{v3.20}{\Package{tocbasic}} dieser Anweisung kann ein
existierender \PName{Stil} geklont werden. Dabei wird ein \PName{neuer Stil}
mit denselben Eigenschaften und Voreinstellungen wie der existierende
\PName{Stil} deklariert. Das Paket selbst verwendet
@@ -1786,7 +1933,7 @@ mit denselben Eigenschaften und Voreinstellungen wie der existierende
Anweisung um die Stile \PValue{part}, \PValue{section} und \PValue{chapter}
oder \PValue{subsection} als Klon von \PValue{tocline} zu deklarieren und dann
mit \DescRef{\LabelBase.cmd.TOCEntryStyleInitCode} und
-\DescRef{\LabelBase.cmd.TOCEntryStyleStartInitCode} abzuändern. Der Stil
+\DescRef{\LabelBase.cmd.TOCEntryStyleStartInitCode} abzuändern. Der Stil
\PValue{default} wird von \Class{scrbook} und \Class{scrreprt} neu als Klon
von \PValue{section} und von \Class{scrartcl} als Klon von \PValue{subsection}
deklariert.%
@@ -1799,26 +1946,26 @@ deklariert.%
\Macro{TOCEntryStyleStartInitCode}\Parameter{Stil}%
\Parameter{Initialisierungscode}
\end{Declaration}
-Jeder\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} Verzeichniseintragsstil
-verfügt über einen Initialisierungscode. Dieser wird immer dann aufgerufen,
+Jeder\ChangedAt{v3.20}{\Package{tocbasic}} Verzeichniseintragsstil
+verfügt über einen Initialisierungscode. Dieser wird immer dann aufgerufen,
wenn einer Verzeichnisebene der entsprechende \PName{Stil} mit
\DescRef{\LabelBase.cmd.DeclareTOCEntryStyle}\IndexCmd{DeclareTOCEntryStyle}
zugewiesen wird. Dieser\textnote{Achtung!} \PName{Initialisierungscode} sollte
-keine globalen Seiteneffekte aufweisen, da er auch für lokale
+keine globalen Seiteneffekte aufweisen, da er auch für lokale
Initialisierungen innerhalb anderer Anweisungen wie
\DescRef{\LabelBase.cmd.DeclareNewTOC}\IndexCmd{DeclareNewTOC} verwendet
wird. Der \PName{Initialisierungscode} dient einerseits dazu, Eigenschaften
-für den jeweiligen \PName{Stil} zu definieren. Er setzt aber auch die
-Standardeinstellungen für diese Eigenschaften.
+für den jeweiligen \PName{Stil} zu definieren. Er setzt aber auch die
+Standardeinstellungen für diese Eigenschaften.
Mit Hilfe der Anweisungen \Macro{TOCEntryStyleStartInitCode} und
-\Macro{TOCEntryStyleInitCode} kann der für einen \PName{Stil} bereits
+\Macro{TOCEntryStyleInitCode} kann der für einen \PName{Stil} bereits
definierte Initialisierungscode um weiteren \PName{Initialisierungscode}
-erweitert werden. Dabei fügt \Macro{TOCEntryStyleStartInitCode} den neuen
-\PName{Intialisierungscode} vorn an, während \Macro{TOCEntryStyleInitCode} den
-\PName{Initialisierungscode} hinten an den vorhandenen Code anfügt. Dies wird
-beispielsweise von den \KOMAScript-Klassen verwendet, um für den von
-\PValue{tocline} geklonten Stil \PValue{part} Füllung, Schrift und vertikalen
+erweitert werden. Dabei fügt \Macro{TOCEntryStyleStartInitCode} den neuen
+\PName{Intialisierungscode} vorn an, während \Macro{TOCEntryStyleInitCode} den
+\PName{Initialisierungscode} hinten an den vorhandenen Code anfügt. Dies wird
+beispielsweise von den \KOMAScript-Klassen verwendet, um für den von
+\PValue{tocline} geklonten Stil \PValue{part} Füllung, Schrift und vertikalen
Abstand passend zu initialisieren. Die Klassen \Class{scrbook} und
\Class{scrreprt} verwenden beispielsweise
\begin{lstcode}
@@ -1839,54 +1986,54 @@ definieren.%
\Macro{LastTOCLevelWasSame}
\Macro{LastTOCLevelWasLower}
\end{Declaration}
-Bei\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} Einträgen im Stil
-\PValue{tocline} wird am Anfang abhängig vom Wert von
+Bei\ChangedAt{v3.20}{\Package{tocbasic}} Einträgen im Stil
+\PValue{tocline} wird am Anfang abhängig vom Wert von
\Macro{lastpenalty}\IndexCmd{lastpenalty} eine dieser drei Anweisungen
-ausgeführt. Dabei fügen \Macro{LastTOCLevelWasHigher} und
+ausgeführt. Dabei fügen \Macro{LastTOCLevelWasHigher} und
\Macro{LastTOCLevelWasSame} im vertikalen Modus
-\Macro{addpenalty}\PParameter{\Macro{@lowpenalty}} ein und ermöglichen so
-einen Umbruch vor Einträgen gleicher oder übergeordneter
+\Macro{addpenalty}\PParameter{\Macro{@lowpenalty}} ein und ermöglichen so
+einen Umbruch vor Einträgen gleicher oder übergeordneter
Ebene. \Macro{LastTOCLevelWasLower} ist hingegen bisher leer definiert, so
dass zwischen einem Eintrag und seinem ersten Untereintrag normalerweise ein
Umbruch untersagt ist.
-Anwender sollten diese Anweisungen nicht umdefinieren. Stattdessen können und
-sollten Änderungen bei Zuweisung des Stils an eine Eintragsebene gezielt über
+Anwender sollten diese Anweisungen nicht umdefinieren. Stattdessen können und
+sollten Änderungen bei Zuweisung des Stils an eine Eintragsebene gezielt über
die Eigenschaften \PValue{onstartlowerlevel}, \PValue{onstartsamelevel} und
\PValue{onstarthigherlevel} vorgenommen werden.%
\EndIndexGroup
\begin{Declaration}
- \Macro{TOCLineLeaderFill}\OParameter{Füllzeichen}
+ \Macro{TOCLineLeaderFill}\OParameter{Füllzeichen}
\end{Declaration}
-Die\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} Anweisung ist dazu gedacht
-als Wert für die Eigenschaft \Option{linefill} des Verzeichniseintragsstils
+Die\ChangedAt{v3.20}{\Package{tocbasic}} Anweisung ist dazu gedacht
+als Wert für die Eigenschaft \Option{linefill} des Verzeichniseintragsstils
\PName{tocline} verwendet zu werden. Sie erzeugt dann eine Verbindung zwischen
-dem Ende des Textes eines Eintrags und der zugehörigen Seitenzahl. Das
-\PName{Füllzeichen}, das dazu in regelmäßigem Abstand wiederholt wird, kann
+dem Ende des Textes eines Eintrags und der zugehörigen Seitenzahl. Das
+\PName{Füllzeichen}, das dazu in regelmäßigem Abstand wiederholt wird, kann
als optionales Argument angegeben werden. Voreinstellung ist ein
Punkt.\textnote{Voreinstellung}
-Wie der Name schon vermuten lässt, werden die Füllzeichen mit Hilfe von
+Wie der Name schon vermuten lässt, werden die Füllzeichen mit Hilfe von
\Macro{leaders} gesetzt. Als Abstand wird wie bei der \LaTeX-Kern-Anweisung
-\Macro{@dottedtocline} vor und nach dem Füllzeichen
+\Macro{@dottedtocline} vor und nach dem Füllzeichen
\Macro{mkern}\Macro{@dotsep}\Unit{\texttt{mu}} verwendet.%
\EndIndexGroup
%
\EndIndexGroup
-\section{Interne Anweisungen für Klassen- und Paketautoren}
+\section{Interne Anweisungen für Klassen- und Paketautoren}
\seclabel{internals}
Das Paket \Package{tocbasic} bietet einige interne Anweisungen, deren
Benutzung durch Klassen- und Paketautoren freigegeben ist. Diese Anweisungen
beginnen alle mit \Macro{tocbasic@}. Aber\textnote{Achtung!} auch Klassen- und
Paketautoren sollten diese Anweisungen nur verwenden und nicht etwa
-umdefinieren! Ihre interne Funktion kann jederzeit geändert oder erweitert
+umdefinieren! Ihre interne Funktion kann jederzeit geändert oder erweitert
werden, so dass jede Umdefinierung der Anweisungen die Funktion von
-\Package{tocbasic} erheblich beschädigen könnte!
+\Package{tocbasic} erheblich beschädigen könnte!
\begin{Declaration}
@@ -1897,35 +2044,35 @@ bzw. ein \LaTeX-Kern, der um die Sprachverwaltung von \Package{babel}
erweitert wurde, schreibt bei jeder Sprachumschaltung am Anfang oder innerhalb
eines Dokuments in die Dateien mit den Dateierweiterungen \File{toc},
\File{lof} und \File{lot} Anweisungen, um diese Sprachumschaltung in diesen
-Dateien mit zu führen. \Package{tocbasic} erweitert diesen Mechanismus so,
+Dateien mit zu führen. \Package{tocbasic} erweitert diesen Mechanismus so,
dass mit Hilfe von \Macro{tocbasic@extend@babel} auch andere
\PName{Dateierweiterungen} davon profitieren. Das Argument
-\PName{Dateierweiterung} sollte dabei vollständig expandiert sein!
+\PName{Dateierweiterung} sollte dabei vollständig expandiert sein!
Anderenfalls besteht die Gefahr, dass etwa die Bedeutung eines Makros zum
-Zeitpunkt der tatsächlichen Auswertung bereits geändert wurde.
+Zeitpunkt der tatsächlichen Auswertung bereits geändert wurde.
-In der Voreinstellung wird diese Anweisung normalerweise für alle
+In der Voreinstellung wird diese Anweisung normalerweise für alle
\PName{Dateierweiterungen}, die mit \DescRef{\LabelBase.cmd.addtotoclist} zur
-Liste der bekannten Dateierweiterungen hinzugefügt werden, aufgerufen. Über
+Liste der bekannten Dateierweiterungen hinzugefügt werden, aufgerufen. Über
die Eigenschaft \PValue{nobabel}\important{\PValue{nobabel}} (siehe
\DescRef{\LabelBase.cmd.setuptoc}, \autoref{sec:tocbasic.toc},
-\DescPageRef{\LabelBase.cmd.setuptoc}) kann dies unterdrückt werden. Für die
-Dateinamenerweiterungen \File{toc}, \File{lof} und \File{lot} unterdrückt
+\DescPageRef{\LabelBase.cmd.setuptoc}) kann dies unterdrückt werden. Für die
+Dateinamenerweiterungen \File{toc}, \File{lof} und \File{lot} unterdrückt
\Package{tocbasic} dies bereits selbst, %
\iftrue% Umbruchvarianten
da \Package{babel} sie von sich aus vornimmt.%
\else%
-damit die Umschaltung nicht mehrfach in die zugehörigen Dateien
+damit die Umschaltung nicht mehrfach in die zugehörigen Dateien
eingetragen wird.%
\fi
Normalerweise gibt es keinen Grund, diese Anweisung selbst aufzurufen. Es sind
allerdings Verzeichnisse denkbar, die nicht unter der Kontrolle von
\Package{tocbasic} stehen, also nicht in der Liste der bekannten
-Dateierweiterungen geführt werden, aber trotzdem die Spracherweiterung für
-\Package{babel} nutzen sollen. Für derartige Verzeichnisse wäre die Anweisung
+Dateierweiterungen geführt werden, aber trotzdem die Spracherweiterung für
+\Package{babel} nutzen sollen. Für derartige Verzeichnisse wäre die Anweisung
explizit aufzurufen. Bitte\textnote{Achtung!} achten Sie jedoch darauf, dass
-dies für jede Dateierweiterung nur einmal geschieht!%
+dies für jede Dateierweiterung nur einmal geschieht!%
\EndIndexGroup
@@ -1943,21 +2090,21 @@ Anweisung baut selbst auf \Macro{@starttoc} auf, setzt allerdings zuvor
\Length{parskip}\IndexLength{parskip}\important[i]{\Length{parskip},
\Length{parindent}, \Length{parfillskip}} und
\Length{parindent}\IndexLength{parindent} auf 0 und
-\Length{parfillskip}\IndexLength{parfillskip} auf 0 bis unendlich. Außerdem
+\Length{parfillskip}\IndexLength{parfillskip} auf 0 bis unendlich. Außerdem
wird \Macro{@currext}\important{\Macro{@currext}}\IndexCmd{@currext} auf die
-aktuelle Dateierweiterung gesetzt, damit diese in den nachfolgend ausgeführten
-Haken\Index{Haken} ausgewertet werden kann. Die Erklärungen der Haken finden
+aktuelle Dateierweiterung gesetzt, damit diese in den nachfolgend ausgeführten
+Haken\Index{Haken} ausgewertet werden kann. Die Erklärungen der Haken finden
Sie im Anschluss.
Da\textnote{Achtung!} \LaTeX{} bei der Ausgabe eines Verzeichnisses auch
-gleich eine neue Verzeichnisdatei zum Schreiben öffnet, kann der Aufruf dieser
+gleich eine neue Verzeichnisdatei zum Schreiben öffnet, kann der Aufruf dieser
Anweisung zu einer Fehlermeldung der Art
\begin{lstoutput}
! No room for a new \write .
\ch@ck ...\else \errmessage {No room for a new #3}
\fi
\end{lstoutput}
-führen, wenn keine Schreibdateien mehr zur Verfügung stehen. Abhilfe kann in
+führen, wenn keine Schreibdateien mehr zur Verfügung stehen. Abhilfe kann in
diesem Fall das Laden des in \autoref{cha:scrwfile} beschriebenen Pakets
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}
oder die Verwendung von Lua\LaTeX{} bieten.%
@@ -1971,27 +2118,27 @@ oder die Verwendung von Lua\LaTeX{} bieten.%
Der Haken\Index{Haken} \Macro{tocbasic@@before@hook} wird unmittelbar vor dem
Einlesen der Verzeichnisdatei, noch vor den mit
\DescRef{\LabelBase.cmd.BeforeStartingTOC} definierten Anweisungen
-ausgeführt. Es ist erlaubt, diesen Haken mit Hilfe von
+ausgeführt. Es ist erlaubt, diesen Haken mit Hilfe von
\Macro{g@addto@macro}\IndexCmd{g@addto@macro} zu erweitern.
Ebenso wird \Macro{tocbasic@@after@hook} unmittelbar nach der
Verzeichnisdatei, aber noch vor den mit
\DescRef{\LabelBase.cmd.AfterStartingTOC} definierten Anweisungen
-ausgeführt. Es ist erlaubt, diesen Haken mit Hilfe von
+ausgeführt. Es ist erlaubt, diesen Haken mit Hilfe von
\Macro{g@addto@macro}\IndexCmd{g@addto@macro} zu erweitern.
\KOMAScript{} nutzt diese Haken, um Verzeichnisse mit dynamischer Anpassung an
-die Breite der Gliederungsnummern zu ermöglichen. Ihre Verwendung ist Klassen
+die Breite der Gliederungsnummern zu ermöglichen. Ihre Verwendung ist Klassen
und Paketen vorbehalten. Anwender\textnote{Achtung!} sollten sich auf
\DescRef{\LabelBase.cmd.BeforeStartingTOC} und
-\DescRef{\LabelBase.cmd.AfterStartingTOC} beschränken. Paketautoren sollten
+\DescRef{\LabelBase.cmd.AfterStartingTOC} beschränken. Paketautoren sollten
ebenfalls vorzugsweise diese beiden Anwenderanweisungen verwenden! Ausgaben
innerhalb der beiden Haken sind nicht gestattet!
Wird keine\textnote{Achtung!} der Anweisungen
\DescRef{\LabelBase.cmd.listofeachtoc}, \DescRef{\LabelBase.cmd.listoftoc} und
-\DescRef{\LabelBase.cmd.listoftoc*} für die Ausgabe der Verzeichnisse
-verwendet, sollten die Anweisungen für die Haken\Index{Haken} trotzdem
+\DescRef{\LabelBase.cmd.listoftoc*} für die Ausgabe der Verzeichnisse
+verwendet, sollten die Anweisungen für die Haken\Index{Haken} trotzdem
aufgerufen werden.%
\EndIndexGroup
@@ -2002,15 +2149,15 @@ aufgerufen werden.%
\end{Declaration}
Diese Anweisungen werden direkt nach
\DescRef{\LabelBase.cmd.tocbasic@@before@hook} bzw. vor
-\DescRef{\LabelBase.cmd.tocbasic@@after@hook} für das jeweilige Verzeichnis
+\DescRef{\LabelBase.cmd.tocbasic@@after@hook} für das jeweilige Verzeichnis
mit der entsprechenden \PName{Dateierweiterung}
-ausgeführt. Sie\textnote{Achtung!} dürfen keinesfalls von Klassen- und
-Paketautoren verändert werden. Werden für die Ausgabe der Verzeichnisse die
+ausgeführt. Sie\textnote{Achtung!} dürfen keinesfalls von Klassen- und
+Paketautoren verändert werden. Werden für die Ausgabe der Verzeichnisse die
Anweisungen \DescRef{\LabelBase.cmd.listoftoc},
\DescRef{\LabelBase.cmd.listoftoc*} und \DescRef{\LabelBase.cmd.listofeachtoc}
-nicht verwendet, sollten die beiden Anweisungen für die Haken\Index{Haken}
-trotzdem aufgerufen werden, soweit sie definiert sind. Die Anweisungen können
-auch undefiniert sein. Für einen entsprechenden Test siehe
+nicht verwendet, sollten die beiden Anweisungen für die Haken\Index{Haken}
+trotzdem aufgerufen werden, soweit sie definiert sind. Die Anweisungen können
+auch undefiniert sein. Für einen entsprechenden Test siehe
\DescRef{scrbase.cmd.scr@ifundefinedorrelax}\IndexCmd{scr@ifundefinedorrelax}
in \autoref{sec:scrbase.if},
\DescPageRef{scrbase.cmd.scr@ifundefinedorrelax}.%
@@ -2022,20 +2169,20 @@ in \autoref{sec:scrbase.if},
\end{Declaration}
Diese Anweisung wird von \DescRef{\LabelBase.cmd.listoftoc} und
\DescRef{\LabelBase.cmd.listofeachtoc} verwendet, um die Anweisung zum Setzen
-der Überschrift eines Verzeichnisses aufzurufen. Das kann entweder die
+der Ãœberschrift eines Verzeichnisses aufzurufen. Das kann entweder die
vordefinierte Anweisung des Pakets \Package{tocbasic} oder eine individuelle
-Anweisung sein. Wenn Sie Ihre eigene Anweisung für die Überschrift definieren,
-können Sie ebenfalls \Macro{tocbasic@listhead} verwenden. In diesem Fall
+Anweisung sein. Wenn Sie Ihre eigene Anweisung für die Überschrift definieren,
+können Sie ebenfalls \Macro{tocbasic@listhead} verwenden. In diesem Fall
sollte vor dem Aufruf von \Macro{tocbasic@listhead} die Anweisung
\Macro{@currext}\important{\Macro{@currext}}\IndexCmd{@currext} auf die
-Dateinamenerweiterung, die zu diesem Verzeichnis gehört, gesetzt werden.%
+Dateinamenerweiterung, die zu diesem Verzeichnis gehört, gesetzt werden.%
\EndIndexGroup
\begin{Declaration}
\Macro{tocbasic@listhead@\PName{Dateierweiterung}}\Parameter{Titel}
\end{Declaration}
-Ist diese individuelle Anweisung für das Setzen einer Verzeichnisüberschrift
+Ist diese individuelle Anweisung für das Setzen einer Verzeichnisüberschrift
definiert, so verwendet \DescRef{\LabelBase.cmd.tocbasic@listhead}
sie. Anderenfalls definiert \DescRef{\LabelBase.cmd.tocbasic@listhead} diese
vor der Verwendung.%
@@ -2051,10 +2198,10 @@ vor der Verwendung.%
\end{Declaration}
Anweisung\ChangedAt{v3.12}{\Package{tocbasic}}
\Macro{tocbasic@addxcontentsline} nimmt einen \PName{Eintrag} der angegebenen
-\PName{Ebene} in das über die \PName{Dateierweiterung} spezifizierte
+\PName{Ebene} in das über die \PName{Dateierweiterung} spezifizierte
Verzeichnis vor. Ob der Eintrag nummeriert wird\iffree{ oder
nicht}{}% Umbruchvarianten
-, hängt davon ab, ob das Argument \PName{Gliederungsnummer} leer ist oder
+, hängt davon ab, ob das Argument \PName{Gliederungsnummer} leer ist oder
nicht. Im Falle eines leeren Argument wird dem \PName{Eintrag} ein
\Macro{nonumberline} ohne Argument vorangestellt. Anderenfalls wird wie
gewohnt \DescRef{\LabelBase.cmd.numberline} mit \PName{Gliederungsnummer} als
@@ -2065,7 +2212,7 @@ Die Anweisung \Macro{nonumberline} wird innerhalb
\DescPageRef{\LabelBase.cmd.listoftoc}) entsprechend der Eigenschaft
\PValue{numberline} (siehe \autoref{sec:tocbasic.toc},
\DescPageRef{\LabelBase.cmd.setuptoc}) umdefiniert. Dadurch wirkt sich das
-Setzen oder Löschen dieser Eigenschaft \iffree{bereits beim nächsten
+Setzen oder Löschen dieser Eigenschaft \iffree{bereits beim nächsten
\LaTeX-Lauf}{unmittelbar} % Umbruchvarianten
aus.%
%
@@ -2076,34 +2223,34 @@ aus.%
\Macro{tocbasic@DependOnPenaltyAndTOCLevel}\Parameter{Eintragsebene}
\Macro{tocbasic@SetPenaltyByTOCLevel}\Parameter{Eintragsebene}
\end{Declaration}
-Der\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} Verzeichniseintragsstil
+Der\ChangedAt{v3.20}{\Package{tocbasic}} Verzeichniseintragsstil
\PValue{tocline} (siehe \autoref{sec:tocbasic.tocstyle}) setzt am Ende jedes
-Eintrags über \Macro{tocbasic@SetPenaltyByTOCLevel} \Macro{penalty} so, dass
+Eintrags über \Macro{tocbasic@SetPenaltyByTOCLevel} \Macro{penalty} so, dass
nach einem Eintrag kein Seitenumbruch erfolgen darf. Der genaue Wert wird
-dabei abhängig von der \PName{Eintragsebene} gewählt.
+dabei abhängig von der \PName{Eintragsebene} gewählt.
% \begin{sloppypar}
\begingroup
\emergencystretch=2em
-Über \Macro{tocbasic@DependOnPenaltyAndTOCLevel} wird am Anfang eines
-Eintrags, abhängig von \Macro{lastpenalty} und der \PName{Eintragsebene} die
-über die Eigenschaft \Option{onstartlowerlevel} im internen Makro
-\Macro{scr@tso@\PName{Eintragsebene}@LastTOCLevelWasHigher}, über die
+Ãœber \Macro{tocbasic@DependOnPenaltyAndTOCLevel} wird am Anfang eines
+Eintrags, abhängig von \Macro{lastpenalty} und der \PName{Eintragsebene} die
+über die Eigenschaft \Option{onstartlowerlevel} im internen Makro
+\Macro{scr@tso@\PName{Eintragsebene}@LastTOCLevelWasHigher}, über die
\iffree{Eigenschaft}{Ei\-genschaft}
-\Option{onstartsamelevel} im zugehörigen, internen
+\Option{onstartsamelevel} im zugehörigen, internen
Makro\iffree{
}{\linebreak}\Macro{scr@tso@\PName{Eintragsebene}@LastTOCLevelWasSame} oder
-über die Eigenschaft \Option{onstarthigherlevel} im zugehörigen, internen
+über die Eigenschaft \Option{onstarthigherlevel} im zugehörigen, internen
Makro \Macro{scr@tso@\PName{Eintragsebene}@LastTOCLevelWasLower} gespeicherte
-Aktion ausgeführt. In der Voreinstellung\textnote{Voreinstellung} erlauben die
-ersten beiden einen Umbruch, wenn sie im vertikalen Modus ausgeführt
+Aktion ausgeführt. In der Voreinstellung\textnote{Voreinstellung} erlauben die
+ersten beiden einen Umbruch, wenn sie im vertikalen Modus ausgeführt
werden.\par
\endgroup
%\end{sloppypar}
Entwicklern, die eigene Stile kompatibel mit \PValue{tocline} erstellen
-wollen, sei empfohlen, dieses Verhalten zu kopieren. Zu diesem Zweck dürfen
-sie auf diese eigentlich internen Makros zurückgreifen.%
+wollen, sei empfohlen, dieses Verhalten zu kopieren. Zu diesem Zweck dürfen
+sie auf diese eigentlich internen Makros zurückgreifen.%
\EndIndexGroup
@@ -2111,23 +2258,23 @@ sie auf diese eigentlich internen Makros zurückgreifen.%
\seclabel{example}
In diesem Abschnitt finden Sie ein komplettes Beispiel, wie eine eigene
-Gleitumgebung einschließlich Verzeichnis und \KOMAScript-Integration mit Hilfe
+Gleitumgebung einschließlich Verzeichnis und \KOMAScript-Integration mit Hilfe
von \Package{tocbasic} definiert werden kann. In diesem Beispiel werden
-interne Anweisungen, also solche mit »\texttt{@}« im Namen
+interne Anweisungen, also solche mit »\texttt{@}« im Namen
verwendet. Das\textnote{Achtung!} bedeutet, dass die Anweisungen entweder in
einem eigenen Paket, einer Klasse oder zwischen
\Macro{makeatletter}\important[i]{\Macro{makeatletter}\\\Macro{makeatother}}%
\IndexCmd{makeatletter} und \Macro{makeatother}\IndexCmd{makeatother}
-verwendet werden müssen.
+verwendet werden müssen.
-Als\textnote{Umgebung} erstes wird eine Umgebung benötigt, die diese neue
+Als\textnote{Umgebung} erstes wird eine Umgebung benötigt, die diese neue
Gleitumgebung bereitstellt. Das geht ganz einfach mit:
\begin{lstcode}
\newenvironment{remarkbox}%
{\@float{remarkbox}}%
{\end@float}
\end{lstcode}
-Die neue Umgebung heißt also \Environment{remarkbox}.
+Die neue Umgebung heißt also \Environment{remarkbox}.
Jede\textnote{Platzierung} Gleitumgebung hat eine Standardplatzierung. Diese
setzt sich aus einer oder mehreren der bekannten Platzierungsoptionen
@@ -2136,20 +2283,20 @@ setzt sich aus einer oder mehreren der bekannten Platzierungsoptionen
\newcommand*{\fps@remarkbox}{tbp}
\end{lstcode}
Die neue Gleitumgebung soll also in der Voreinstellung nur oben, unten oder
-auf einer eigenen Seite platziert werden dürfen.
+auf einer eigenen Seite platziert werden dürfen.
-Gleitumgebungen\textnote{Gleittyp} haben außerdem einen nummerischen Gleittyp
+Gleitumgebungen\textnote{Gleittyp} haben außerdem einen nummerischen Gleittyp
zwischen 1 und 31. Umgebungen, bei denen das gleiche Bit
-im Gleittyp gesetzt ist, dürfen sich nicht gegenseitig überholen. Abbildungen
-und Tabellen haben normalerweise den Typ~1 und 2. Abbildungen dürfen also
-Tabellen überholen und umgekehrt.
+im Gleittyp gesetzt ist, dürfen sich nicht gegenseitig überholen. Abbildungen
+und Tabellen haben normalerweise den Typ~1 und 2. Abbildungen dürfen also
+Tabellen überholen und umgekehrt.
\begin{lstcode}
\newcommand*{\ftype@remarkbox}{4}
\end{lstcode}
-Die neue Umgebung hat den Typ~4, darf also Tabellen und Abbildungen überholen
-und von diesen überholt werden.
+Die neue Umgebung hat den Typ~4, darf also Tabellen und Abbildungen überholen
+und von diesen überholt werden.
-Gleitumgebungen\textnote{Nummer} haben außerdem eine Nummer.
+Gleitumgebungen\textnote{Nummer} haben außerdem eine Nummer.
\begin{lstcode}
\newcounter{remarkbox}
\newcommand*{\remarkboxformat}{%
@@ -2157,11 +2304,11 @@ Gleitumgebungen\textnote{Nummer} haben außerdem eine Nummer.
}
\newcommand*{\fnum@remarkbox}{\remarkboxformat}
\end{lstcode}
-Hier wird zunächst ein neuer Zähler definiert, der unabhängig von Kapiteln
-oder sonstigen Gliederungszählern ist. Dabei definiert \LaTeX{} auch gleich
+Hier wird zunächst ein neuer Zähler definiert, der unabhängig von Kapiteln
+oder sonstigen Gliederungszählern ist. Dabei definiert \LaTeX{} auch gleich
\Macro{theremarkbox} mit der Standardausgabe als arabische Zahl. Diese wird
dann in der Definition der formatierten Ausgabe verwendet. Die formatierte
-Ausgabe wird wiederum als Gleitumgebungsnummer für die Verwendung in
+Ausgabe wird wiederum als Gleitumgebungsnummer für die Verwendung in
\DescRef{maincls.cmd.caption} definiert.
Gleitumgebungen\textnote{Dateierweiterung} haben Verzeichnisse und diese haben
@@ -2169,16 +2316,16 @@ eine Datei mit dem Namen \Macro{jobname} und einer Dateierweiterung.
\begin{lstcode}
\newcommand*{\ext@remarkbox}{lor}
\end{lstcode}
-Als Dateierweiterung verwenden wir also »\File{lor}«.
+Als Dateierweiterung verwenden wir also »\File{lor}«.
Die\important{\Package{tocbasic}} Umgebung selbst steht damit. Es fehlt
-allerdings das Verzeichnis. Damit wir dabei möglichst wenig selbst machen
-müssen, verwenden wir das Paket \Package{tocbasic}. Dieses wird in Dokumenten
+allerdings das Verzeichnis. Damit wir dabei möglichst wenig selbst machen
+müssen, verwenden wir das Paket \Package{tocbasic}. Dieses wird in Dokumenten
mit
\begin{lstcode}
\usepackage{tocbasic}
\end{lstcode}
-geladen. Ein Klassen- oder Paketautor würde hingegen
+geladen. Ein Klassen- oder Paketautor würde hingegen
\begin{lstcode}
\RequirePackage{tocbasic}
\end{lstcode}
@@ -2190,48 +2337,48 @@ Nun\textnote{Dateierweiterung} machen wir die neue Dateierweiterung dem Paket
\addtotoclist[float]{lor}
\end{lstcode}
Dabei verwenden wir als Besitzer \PValue{float}, damit sich alle
-anschließend aufgerufenen Optionen von \KOMAScript, die sich auf Verzeichnisse
+anschließend aufgerufenen Optionen von \KOMAScript, die sich auf Verzeichnisse
von Gleitumgebungen beziehen, auch auf das neue Verzeichnis beziehen.
-Jetzt\textnote{Verzeichnistitel} definieren wir noch einen Titel für dieses
+Jetzt\textnote{Verzeichnistitel} definieren wir noch einen Titel für dieses
Verzeichnis:
\begin{lstcode}
- \newcommand*{\listoflorname}{Verzeichnis der Merksätze}
+ \newcommand*{\listoflorname}{Verzeichnis der Merksätze}
\end{lstcode}
-Normalerweise würde man in einem Paket übrigens zunächst einen englischen
+Normalerweise würde man in einem Paket übrigens zunächst einen englischen
Titel definieren und dann beispielsweise mit Hilfe des Pakets
-\Package{scrbase} Titel für alle weiteren Sprachen, die man unterstützen
+\Package{scrbase} Titel für alle weiteren Sprachen, die man unterstützen
will. Siehe dazu \autoref{sec:scrbase.languageSupport}, ab
\autopageref{sec:scrbase.languageSupport}.
-Jetzt\textnote{Verzeichniseintrag}\index{Verzeichnis>Eintrag} müssen wir nur
+Jetzt\textnote{Verzeichniseintrag}\index{Verzeichnis>Eintrag} müssen wir nur
noch definieren, wie ein einzelner Eintrag in dem Verzeichnis aussehen soll:
\begin{lstcode}
\newcommand*{\l@remarkbox}{\l@figure}
\end{lstcode}
-Weil das die einfachste Lösung ist, wurde hier festgelegt, dass Einträge in
-das Verzeichnis der Merksätze genau wie Einträge in das Abbildungsverzeichnis
-aussehen sollen. Man hätte auch eine explizite Festlegung wie
+Weil das die einfachste Lösung ist, wurde hier festgelegt, dass Einträge in
+das Verzeichnis der Merksätze genau wie Einträge in das Abbildungsverzeichnis
+aussehen sollen. Man hätte auch eine explizite Festlegung wie
\begin{lstcode}
\DeclareTOCStyleEntry[level=1,indent=1em,numwidth=1.5em]%
{tocline}{remarkbox}
\end{lstcode}
-verwenden können.
+verwenden können.
-Außerdem\textnote{Kapiteleintrag} wollen Sie, dass sich Kapiteleinträge auf das
+Außerdem\textnote{Kapiteleintrag} wollen Sie, dass sich Kapiteleinträge auf das
Verzeichnis auswirken.
\begin{lstcode}
\setuptoc{lor}{chapteratlist}
\end{lstcode}
-Das Setzen dieser Eigenschaft ermöglicht dies bei Verwendung einer
+Das Setzen dieser Eigenschaft ermöglicht dies bei Verwendung einer
\KOMAScript-Klasse und jeder anderen Klasse, die diese Eigenschaft
-unterstützt. Leider gehören die Standardklassen nicht dazu.
+unterstützt. Leider gehören die Standardklassen nicht dazu.
-Das\textnote{Verzeichnis} genügt schon. Der Anwender kann nun bereits
+Das\textnote{Verzeichnis} genügt schon. Der Anwender kann nun bereits
wahlweise mit Hilfe der Optionen einer \KOMAScript-Klasse oder
-\DescRef{\LabelBase.cmd.setuptoc} verschiedene Formen der Überschrift (ohne
+\DescRef{\LabelBase.cmd.setuptoc} verschiedene Formen der Ãœberschrift (ohne
Inhaltsverzeichniseintrag, mit Inhaltsverzeichniseintrag, mit Nummerierung)
-wählen und das Verzeichnis mit
+wählen und das Verzeichnis mit
\DescRef{\LabelBase.cmd.listoftoc}\PParameter{lor} ausgeben. Mit einem
schlichten
\begin{lstcode}
@@ -2239,36 +2386,36 @@ schlichten
\end{lstcode}
kann man die Anwendung noch etwas vereinfachen.
-Wie Sie gesehen haben, beziehen sich gerade einmal fünf einzeilige
+Wie Sie gesehen haben, beziehen sich gerade einmal fünf einzeilige
Anweisungen, von denen nur drei bis vier wirklich notwendig sind, auf das
Verzeichnis selbst. Trotzdem bietet dieses Verzeichnis bereits die
-Möglichkeit, es zu nummerieren oder auch nicht nummeriert in das
+Möglichkeit, es zu nummerieren oder auch nicht nummeriert in das
Inhaltsverzeichnis aufzunehmen. Es kann sogar per Eigenschaft bereits eine
-tiefere Gliederungsebene gewählt werden. Kolumnentitel werden für \KOMAScript,
+tiefere Gliederungsebene gewählt werden. Kolumnentitel werden für \KOMAScript,
die Standardklassen und alle Klassen, die \Package{tocbasic} explizit
-unterstützen, angepasst gesetzt. Unterstützende Klassen beachten das neue
+unterstützen, angepasst gesetzt. Unterstützende Klassen beachten das neue
Verzeichnis sogar beim Wechsel zu einem neuen Kapitel. Sprachumschaltungen
-durch \Package{babel} werden in dem Verzeichnis ebenfalls berücksichtigt.
+durch \Package{babel} werden in dem Verzeichnis ebenfalls berücksichtigt.
-Natürlich\textnote{Verzeichniseigenschaften} kann ein Paketautor weiteres
-hinzufügen. So könnte er explizit Optionen anbieten, um die Verwendung von
+Natürlich\textnote{Verzeichniseigenschaften} kann ein Paketautor weiteres
+hinzufügen. So könnte er explizit Optionen anbieten, um die Verwendung von
\DescRef{\LabelBase.cmd.setuptoc} vor dem Anwender zu verbergen. Andererseits
kann er auch auf diese Anleitung zu \Package{tocbasic} verweisen, wenn es
-darum geht, die entsprechenden Möglichkeiten zu erklären. Vorteil ist dann,
-dass der Anwender automatisch von etwaigen zukünftigen Erweiterungen von
+darum geht, die entsprechenden Möglichkeiten zu erklären. Vorteil ist dann,
+dass der Anwender automatisch von etwaigen zukünftigen Erweiterungen von
\Package{tocbasic} profitiert. Soll der Anwender aber nicht mit der Tatsache
-belastet werden, dass für die Merksätze die Dateierweiterung \File{lor}
-verwendet wird, so genügt
+belastet werden, dass für die Merksätze die Dateierweiterung \File{lor}
+verwendet wird, so genügt
\begin{lstcode}
\newcommand*{\setupremarkboxes}{\setuptoc{lor}}
\end{lstcode}
\iffalse%
-um eine als Argument an \Macro{setupremarkboxes} übergebene Liste von
+um eine als Argument an \Macro{setupremarkboxes} übergebene Liste von
Eigenschaften direkt als Liste von %
\else%
-um über \Macro{setupremarkboxes}
+um über \Macro{setupremarkboxes}
\fi
-Eigenschaften für \File{lor} zu setzen.
+Eigenschaften für \File{lor} zu setzen.
\section{Alles mit einer Anweisung}
@@ -2284,82 +2431,86 @@ noch einfacher gehen kann.
\Parameter{Dateierweiterung}
\end{Declaration}%
Mit\ChangedAt{v3.06}{\Package{tocbasic}} dieser Anweisung wird in einem
-einzigen Schritt ein neues Verzeichnis, dessen Überschrift und die Bezeichnung
-für die Einträge unter Kontrolle von \Package{tocbasic} definiert. Optional
-können dabei gleichzeitig gleitende oder nicht gleitende Umgebungen definiert
+einzigen Schritt ein neues Verzeichnis, dessen Ãœberschrift und die Bezeichnung
+für die Einträge unter Kontrolle von \Package{tocbasic} definiert. Optional
+können dabei gleichzeitig gleitende oder nicht gleitende Umgebungen definiert
werden, innerhalb derer \DescRef{maincls.cmd.caption}%
-\important{\DescRef{maincls.cmd.caption}}\IndexCmd{caption} Einträge für
+\important{\DescRef{maincls.cmd.caption}}\IndexCmd{caption} Einträge für
dieses neue Verzeichnis erzeugt. Auch die Erweiterungen
\DescRef{maincls.cmd.captionabove}\important[i]{%
\DescRef{maincls.cmd.captionabove}\\
\DescRef{maincls.cmd.captionbelow}}, \DescRef{maincls.cmd.captionbelow} und
\DescRef{maincls.env.captionbeside} aus den \KOMAScript-Klassen (siehe
\autoref{sec:maincls.floats}, ab \DescPageRef{maincls.cmd.captionabove})
-können dann verwendet werden.
+können dann verwendet werden.
\PName{Dateierweiterung} definiert dabei die Dateiendung der Hilfsdatei, die
-das Verzeichnis repräsentiert, wie dies in \autoref{sec:tocbasic.basics}, ab
-\autopageref{sec:tocbasic.basics} bereits erläutert
+das Verzeichnis repräsentiert, wie dies in \autoref{sec:tocbasic.basics}, ab
+\autopageref{sec:tocbasic.basics} bereits erläutert
wurde. Dieser\textnote{Achtung!} Parameter muss angegeben werden und darf
nicht leer sein!
\PName{Optionenliste} ist eine durch Komma getrennte Liste, wie dies auch von
\DescRef{maincls.cmd.KOMAoptions} (siehe \autoref{sec:typearea.options},
\DescPageRef{typearea.cmd.KOMAoptions}) bekannt ist. Diese
-Optionen\textnote{Achtung!} können jedoch \emph{nicht} mit
+Optionen\textnote{Achtung!} können jedoch \emph{nicht} mit
\DescRef{maincls.cmd.KOMAoptions}\IndexCmd{KOMAoptions} gesetzt werden! Eine
-Übersicht über die möglichen Optionen bietet
+Übersicht über die möglichen Optionen bietet
\autoref{tab:tocbasic.DeclareNewTOC-options}\iffalse ab
\autopageref{tab:tocbasic.DeclareNewTOC-options}\fi.
-Wird\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}} Option
+Wird\ChangedAt{v3.20}{\Package{tocbasic}} Option
\Option{tocentrystyle} nicht gesetzt, so wird bei Bedarf der Stil
-\PValue{default} verwendet. Näheres zu diesem Stil ist
-\autoref{sec:tocbasic.tocstyle} zu entnehmen. Soll kein Befehl für
-Verzeichniseinträge definiert werden, so kann ein leeres Argument, also
+\PValue{default} verwendet. Näheres zu diesem Stil ist
+\autoref{sec:tocbasic.tocstyle} zu entnehmen. Soll kein Befehl für
+Verzeichniseinträge definiert werden, so kann ein leeres Argument, also
wahlweise \OptionValue{tocentrystyle}{}\iffree{}{\unskip} oder
\OptionValue{tocentrystyle}{\PParameter{}} verwendet werden.
-Abhängig\ChangedAt[2016/06]{v3.21}{\Package{tocbasic}} vom Stil der
-Verzeichniseinträge können auch alle für diesen Stil gültigen Eigenschaften
+Abhängig\ChangedAt{v3.21}{\Package{tocbasic}} vom Stil der
+Verzeichniseinträge können auch alle für diesen Stil gültigen Eigenschaften
gesetzt werden, indem die entsprechenden in
\autoref{tab:tocbasic.tocstyle.attributes} ab
-\autopageref{tab:tocbasic.tocstyle.attributes} aufgeführten Namen, mit dem
-Präfix \PValue{tocentry} versehen, in der \PName{Optionenliste} angegeben
-werden. Nachträgliche Änderungen am Stil sind mit
+\autopageref{tab:tocbasic.tocstyle.attributes} aufgeführten Namen, mit dem
+Präfix \PValue{tocentry} versehen, in der \PName{Optionenliste} angegeben
+werden. Nachträgliche Änderungen am Stil sind mit
\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry}%
\IndexCmd{DeclareTOCStyleEntry}%
\important{\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry}} jederzeit
-möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
+möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
\DescPageRef{\LabelBase.cmd.DeclareTOCStyleEntry}.
% Umbruchoptimierung: Tabelle verschoben.
\begin{desclist}
\renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
\desccaption[{%
- Optionen für die Anweisung \Macro{DeclareNewTOC}%
+ Optionen für die Anweisung \Macro{DeclareNewTOC}%
}]{%
- Optionen für die Anweisung
+ Optionen für die Anweisung
\Macro{DeclareNewTOC}\ChangedAt{v3.06}{\Package{tocbasic}}%
\label{tab:tocbasic.DeclareNewTOC-options}%
}{%
- Optionen für die Anweisung \Macro{DeclareNewTOC} (\emph{Fortsetzung})%
+ Optionen für die Anweisung \Macro{DeclareNewTOC} (\emph{Fortsetzung})%
}%
\entry{\OptionVName{atbegin}{Code}\ChangedAt{v3.09}{\Package{tocbasic}}}{%
Falls eine neue Gleitumgebung oder nicht gleitende Umgebung definiert
- wird, so wird \PName{Code} jeweils am Anfang dieser Umgebung ausgeführt.%
+ wird, so wird \PName{Code} jeweils am Anfang dieser Umgebung ausgeführt.%
}%
\entry{\OptionVName{atend}{Code}\ChangedAt{v3.09}{\Package{tocbasic}}}{%
Falls eine neue Gleitumgebung oder nicht gleitende Umgebung definiert
- wird, so wird \PName{Code} jeweils am Ende dieser Umgebung ausgeführt.%
+ wird, so wird \PName{Code} jeweils am Ende dieser Umgebung ausgeführt.%
}%
- \entry{\OptionVName{counterwithin}{\LaTeX-Zähler}}{%
+ \entry{\OptionVName{category}{Kategorie}}{%
+ \ChangedAt{v3.27}{\Package{tocbasic}}%
+ Diese Option kann als Synonym für \OptionVName{owner}{Besitzer} verwendet
+ werden.}%
+ \entry{\OptionVName{counterwithin}{\LaTeX-Zähler}}{%
Falls eine neue Gleitumgebung oder eine nicht gleitende Umgebung definiert
- wird, so wird für diese auch ein neuer Zähler
+ wird, so wird für diese auch ein neuer Zähler
\Counter{\PName{Eintragstyp}} (siehe Option \Option{type})
- angelegt. Dieser Zähler kann in gleicher Weise wie beispielsweise der
- Zähler \Counter{figure} bei \Class{book}-Klassen von Zähler
- \Counter{chapter} abhängt, von einem \LaTeX-Zähler ahängig gemacht
+ angelegt. Dieser Zähler kann in gleicher Weise wie beispielsweise der
+ Zähler \Counter{figure} bei \Class{book}-Klassen von Zähler
+ \Counter{chapter} abhängt, von einem \LaTeX-Zähler ahängig gemacht
werden.}%
\entry{\Option{float}}{%
Es wird nicht nur ein neuer Verzeichnistyp definiert, sondern auch
@@ -2368,132 +2519,132 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
(vgl. \Environment{figure} und \Environment{figure*}).}%
\entry{\OptionVName{floatpos}{Gleitverhalten}}{%
Jede Gleitumgebung hat ein voreingestelltes \PName{Gleitverhalten}, das
- über das optionale Argument der Gleitumgebung geändert werden kann. Mit
- dieser Option wird das \PName{Gleitverhalten} für die optional erstellbare
+ über das optionale Argument der Gleitumgebung geändert werden kann. Mit
+ dieser Option wird das \PName{Gleitverhalten} für die optional erstellbare
Gleitumgebung (siehe Option \Option{float}) festgelegt. Die Syntax und
- Semantik ist dabei mit der des optionalen Arguments für die Gleitumgebung
+ Semantik ist dabei mit der des optionalen Arguments für die Gleitumgebung
identisch. Wird die Option nicht verwendet, so ist das voreingestellte
Gleitverhalten \texttt{tbp}, also \emph{top}, \emph{bottom},
\emph{page}.}%
\entry{\OptionVName{floattype}{Gleittyp}}{%
Jede Gleitumgebung hat einen nummerischen Typ. Gleitumgebungen, bei denen
- in diesem \PName{Gleittyp} nur unterschiedliche Bits gesetzt sind, können
- sich gegenseitig überholen. Die Gleitumgebungen \Environment{figure} und
- \Environment{table} haben normalerweise die Typen 1 und 2, können sich
- also gegenseitig überholen. Es sind Typen von 1 bis 31 (alle Bits gesetzt,
- kann also keinen anderen Typ überholen und von keinem anderen Typen
- überholt werden) zulässig. Wird kein Typ angegeben, so wird mit 16 der
- höchst mögliche Ein-Bit-Typ verwendet.}%
+ in diesem \PName{Gleittyp} nur unterschiedliche Bits gesetzt sind, können
+ sich gegenseitig überholen. Die Gleitumgebungen \Environment{figure} und
+ \Environment{table} haben normalerweise die Typen 1 und 2, können sich
+ also gegenseitig überholen. Es sind Typen von 1 bis 31 (alle Bits gesetzt,
+ kann also keinen anderen Typ überholen und von keinem anderen Typen
+ überholt werden) zulässig. Wird kein Typ angegeben, so wird mit 16 der
+ höchst mögliche Ein-Bit-Typ verwendet.}%
\entry{\Option{forcenames}}{%
Siehe Option \Option{name} und \Option{listname}.}%
\entry{\OptionVName{hang}{Einzug}}{%
- \ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
- \ChangedAt[2015/12]{v3.21}{\Package{tocbasic}}%
- Diese Option gilt seit \KOMAScript~3.20 als überholt. Die Breite der
+ \ChangedAt{v3.20}{\Package{tocbasic}}%
+ \ChangedAt{v3.21}{\Package{tocbasic}}%
+ Diese Option gilt seit \KOMAScript~3.20 als überholt. Die Breite der
Nummer des Verzeichniseintrags\index{Verzeichnis>Eintrag} ist nun
- stattdessen als Eigenschaft in Abhängigkeit des Verzeichniseintragsstils
+ stattdessen als Eigenschaft in Abhängigkeit des Verzeichniseintragsstils
von Option \Option{tocentrystyle} anzugeben. Bei den Stilen von
- \KOMAScript{} wäre das beispielsweise die Eigenschaft \PValue{numwidth}
+ \KOMAScript{} wäre das beispielsweise die Eigenschaft \PValue{numwidth}
und damit Option \Option{tocentrynumwidth}. Besitzt ein Stil diese
Eigenschaft, so wird sie von \Macro{DeclareNewTOC} mit 1,5\Unit{em}
voreingestellt. Diese Voreinstellung kann durch explizite Angabe von
\OptionVName{tocentrynumwidth}{Wert} leicht mit einem anderen
- \PName{Wert} überschrieben werden. Für Abbildungen verwenden die
+ \PName{Wert} überschrieben werden. Für Abbildungen verwenden die
\KOMAScript-Klassen beispielsweise den \PName{Wert} \PValue{2.3em}.}%
\entry{\OptionVName{indent}{Einzug}}{%
- \ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
- \ChangedAt[2015/12]{v3.21}{\Package{tocbasic}}%
- Diese Option gilt seit \KOMAScript~3.20 als überholt. Der Einzug des
+ \ChangedAt{v3.20}{\Package{tocbasic}}%
+ \ChangedAt{v3.21}{\Package{tocbasic}}%
+ Diese Option gilt seit \KOMAScript~3.20 als überholt. Der Einzug des
Verzeichniseintrags\index{Verzeichnis>Eintrag} von links ist nun
- stattdessen als Eigenschaft in Abhängigkeit des Verzeichniseintragsstils
+ stattdessen als Eigenschaft in Abhängigkeit des Verzeichniseintragsstils
von Option \Option{tocentrystyle} anzugeben. Bei den Stilen von
- \KOMAScript{} wäre das beispielsweise die Eigenschaft \PValue{indent} und
+ \KOMAScript{} wäre das beispielsweise die Eigenschaft \PValue{indent} und
damit Option \Option{tocentryindent}. Besitzt ein Stil diese Eigenschaft,
so wird sie von \Macro{DeclareNewTOC} mit 1\Unit{em} voreingestellt. Diese
Voreinstellung kann durch explizite Angabe von
\OptionVName{tocentryindent}{Wert} leicht mit einem anderen \PName{Wert}
- überschrieben werden. Für Abbildungen verwenden die \KOMAScript-Klassen
+ überschrieben werden. Für Abbildungen verwenden die \KOMAScript-Klassen
beispielsweise den \PName{Wert} \PValue{1.5em}.}%
\entry{\OptionVName{level}{Gliederungsebene}}{%
- \ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
- \ChangedAt[2015/12]{v3.21}{\Package{tocbasic}}%
- Diese Option gilt seit \KOMAScript~3.20 als überholt. Der nummerische Wert
+ \ChangedAt{v3.20}{\Package{tocbasic}}%
+ \ChangedAt{v3.21}{\Package{tocbasic}}%
+ Diese Option gilt seit \KOMAScript~3.20 als überholt. Der nummerische Wert
der Ebene des Verzeichniseintrags\index{Verzeichnis>Eintrag} ist nun
- stattdessen als Eigenschaft in Abhängigkeit des Verzeichniseintragsstils
+ stattdessen als Eigenschaft in Abhängigkeit des Verzeichniseintragsstils
von Option \Option{tocentrystyle} anzugeben. Nichts desto trotz haben alle
Stile die Eigenschaft \PValue{level} und damit Option
\Option{tocentrylevel}. Die Eigenschaft wird von \Macro{DeclareNewTOC} mit
1 voreingestellt. Diese Voreinstellung kann durch explizite Angabe von
\OptionVName{tocentrylevel}{Wert} leicht mit einem anderen \PName{Wert}
- überschrieben werden.}%
+ überschrieben werden.}%
\entry{\OptionVName{listname}{Verzeichnistitel}}{%
- Jedes Verzeichnis hat eine Überschrift, die durch diese Option bestimmt
+ Jedes Verzeichnis hat eine Ãœberschrift, die durch diese Option bestimmt
werden kann. Ist die Option nicht angegeben, so wird als Verzeichnistitel
- »\texttt{List of \PName{Mehrzahl des Eintragstyps}}« (siehe Option
+ »\texttt{List of \PName{Mehrzahl des Eintragstyps}}« (siehe Option
\Option{types}) verwendet, wobei das erste Zeichen der \PName{Mehrzahl des
- Eintragstyps} in einen Großbuchstaben gewandelt wird. Es wird auch ein
+ Eintragstyps} in einen Großbuchstaben gewandelt wird. Es wird auch ein
Makro \Macro{list\PName{Eintragstyp}name} mit diesem Wert definiert, der
- jederzeit geändert werden kann. Dieses Makro wird jedoch nur definiert,
- wenn es nicht bereits definiert ist oder zusätzlich Option
+ jederzeit geändert werden kann. Dieses Makro wird jedoch nur definiert,
+ wenn es nicht bereits definiert ist oder zusätzlich Option
\Option{forcenames} gesetzt ist.}%
\entry{\OptionVName{name}{Eintragsname}}{%
- Sowohl als optionaler Präfix für die Einträge im Verzeichnis als auch für
+ Sowohl als optionaler Präfix für die Einträge im Verzeichnis als auch für
die Beschriftung in einer Gleitumgebung (siehe Option \Option{float}) oder
einer nicht gleitenden Umgebung (siehe Option \Option{nonfloat}) wird ein
- Name für einen Eintrag in das Verzeichnis benötigt. Ohne diese Option wird
+ Name für einen Eintrag in das Verzeichnis benötigt. Ohne diese Option wird
als \PName{Eintragsname} der \PName{Eintragstyp} (siehe Option
\Option{type}) verwendet, bei dem das erste Zeichen in einen
- Großbuchstaben gewandelt wird. Es wird auch ein Makro
+ Großbuchstaben gewandelt wird. Es wird auch ein Makro
\Macro{\PName{Eintragstyp}name} mit diesem Wert definiert, der jederzeit
- geändert werden kann. Dieses Makro wird jedoch nur definiert, wenn es
- nicht bereits definiert ist oder zusätzlich Option \Option{forcenames}
+ geändert werden kann. Dieses Makro wird jedoch nur definiert, wenn es
+ nicht bereits definiert ist oder zusätzlich Option \Option{forcenames}
gesetzt ist.}%
\entry{\Option{nonfloat}}{%
Es wird nicht nur ein neuer Verzeichnistyp definiert, sondern auch eine
nicht gleitende Umgebungen \Environment{\PName{Eintragstyp}-} (siehe
- Option \Option{type}), die ähnlich wie eine Gleitumgebung verwendet werden
+ Option \Option{type}), die ähnlich wie eine Gleitumgebung verwendet werden
kann, jedoch nicht gleitet und auch nicht die Grenzen der Umgebung, in der
sie verwendet wird, durchbricht.}%
\entry{\OptionVName{owner}{Besitzer}}{%
Jedes neue Verzeichnis hat bei \Package{tocbasic} einen Besitzer (siehe
\autoref{sec:tocbasic.basics}). Dieser kann hier angegeben werden. Ist
- kein Besitzer angegeben, so wird der Besitzer »\PValue{float}« verwendet,
- den auch die \KOMAScript-Klassen für das Abbildungs- und das
+ kein Besitzer angegeben, so wird der Besitzer »\PValue{float}« verwendet,
+ den auch die \KOMAScript-Klassen für das Abbildungs- und das
Tabellenverzeichnis verwenden.}%
\entry{\OptionVName{setup}{Liste von Eigenschaften}}{%
\ChangedAt{v3.25}{\Package{tocbasic}}%
Die \PName{Liste von Eigenschaften} wird via
\DescRef{\LabelBase.cmd.setuptoc} gesetzt. Es wird darauf hingewiesen,
- dass für die Angabe mehrerer durch Komma getrennter Eigenschaften die
+ dass für die Angabe mehrerer durch Komma getrennter Eigenschaften die
\PName{Liste von Eigenschaften} in geschweifte Klammern gesetzt werden
muss.%
}%
\entry{\OptionVName{tocentrystyle}{Eintragsstil}}{%
\ChangedAt{v3.20}{\Package{tocbasic}}%
- \PName{Eintragsstil} gibt den Stil an, den Einträge in das entsprechende
- Verzeichnis haben sollen. Der Name der Eintragsebene wird dabei über
- Option \Option{type} bestimmt. Zusätzlich zu den Optionen dieser Tabelle
- können auch alle Eigenschaften des Stils als Optionen angegeben werden,
- indem die Namen der Eigenschaften mit dem Präfix \PValue{toc} ergänzt
+ \PName{Eintragsstil} gibt den Stil an, den Einträge in das entsprechende
+ Verzeichnis haben sollen. Der Name der Eintragsebene wird dabei über
+ Option \Option{type} bestimmt. Zusätzlich zu den Optionen dieser Tabelle
+ können auch alle Eigenschaften des Stils als Optionen angegeben werden,
+ indem die Namen der Eigenschaften mit dem Präfix \PValue{toc} ergänzt
werden. So kann der nummerische Wert der Ebene beispielsweise als
- \Option{tocentrylevel} angegeben werden. Näheres zu den Stilen ist
+ \Option{tocentrylevel} angegeben werden. Näheres zu den Stilen ist
\autoref{sec:tocbasic.tocstyle} ab \autopageref{sec:tocbasic.tocstyle} zu
entnehmen.}%
\entry{\OptionVName{tocentry\PName{Stiloption}}{Wert}}{%
- \ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
- Weitere Optionen in Abhängigkeit vom via \Option{tocentrystyle} gewählten
+ \ChangedAt{v3.20}{\Package{tocbasic}}%
+ Weitere Optionen in Abhängigkeit vom via \Option{tocentrystyle} gewählten
\PName{Eintragsstil}. Siehe dazu \autoref{sec:tocbasic.tocstyle} ab
- \autopageref{sec:tocbasic.tocstyle}. Für die von \Package{tocbasic}
+ \autopageref{sec:tocbasic.tocstyle}. Für die von \Package{tocbasic}
vordefinierten Verzeichniseintragsstile finden sich die als
\PName{Stiloption} verwendbaren Attribute in
\autoref{tab:tocbasic.tocstyle.attributes}, ab
\autopageref{tab:tocbasic.tocstyle.attributes}.%
}%
\entry{\OptionVName{type}{Eintragstyp}}{%
- \PName{Eintragstyp} gibt den Typ der Einträge in das entsprechende
- Verzeichnis an. Der Typ wird auch als Basisname für verschiedene Makros
- und gegebenenfalls Umgebungen und Zähler verwendet. Er sollte daher nur
- aus Buchstaben bestehen. Wird diese Option nicht verwendet, so wird für
+ \PName{Eintragstyp} gibt den Typ der Einträge in das entsprechende
+ Verzeichnis an. Der Typ wird auch als Basisname für verschiedene Makros
+ und gegebenenfalls Umgebungen und Zähler verwendet. Er sollte daher nur
+ aus Buchstaben bestehen. Wird diese Option nicht verwendet, so wird für
\PName{Eintragstyp} die \PName{Dateierweiterung} aus dem obligatorischen
Argument verwendet.}%
\entry{\OptionVName{types}{Mehrzahl des Eintragstyps}}{%
@@ -2501,12 +2652,12 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
verwendet, beispielsweise um eine Anweisung \Macro{listof\PName{Mehrzahl
des Eintragstyps}} zu definieren. Wird diese Option nicht verwendet,
so wird als \PName{Mehrzahl des Eintragstyps} der Wert von
- \Option{type} mit angehängtem »s« verwendet.}%
+ \Option{type} mit angehängtem »s« verwendet.}%
\entry{\OptionVName{unset}{Liste von Eigenschaften}}{%
\ChangedAt{v3.25}{\Package{tocbasic}}%
Die \PName{Liste von Eigenschaften} wird via
\DescRef{\LabelBase.cmd.unsettoc} aufgehoben. Es wird darauf hingewiesen,
- dass für die Angabe mehrerer durch Komma getrennter Eigenschaften die
+ dass für die Angabe mehrerer durch Komma getrennter Eigenschaften die
\PName{Liste von Eigenschaften} in geschweifte Klammern gesetzt werden
muss.%
}%
@@ -2514,7 +2665,7 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
\begin{Example}
Das Beispiel aus \autoref{sec:tocbasic.example} kann mit Hilfe der neuen
- Anweisung deutlich verkürzt werden:
+ Anweisung deutlich verkürzt werden:
\begin{lstcode}
\DeclareNewTOC[%
type=remarkbox,%
@@ -2527,24 +2678,24 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
\setuptoc{lor}{chapteratlist}
\end{lstcode}
Neben den Umgebungen \Environment{remarkbox} und \Environment{remarkbox*}
- sind damit auch der Zähler \Counter{remarkbox}, die zur Ausgabe gehörenden
+ sind damit auch der Zähler \Counter{remarkbox}, die zur Ausgabe gehörenden
Anweisungen \Macro{theremarkbox}, \Macro{remarkboxname} und
- \Macro{remarkboxformat}, die für das Verzeichnis benötigten
+ \Macro{remarkboxformat}, die für das Verzeichnis benötigten
\Macro{listremarkboxname} und \Macro{listofremarkboxes} sowie einige intern
verwendete Anweisungen mit Bezug auf die Dateiendung \File{lor}
- definiert. Soll der Gleitumgebungstyp dem Paket überlassen werden, so kann
- Option \Option{floattype} im Beispiel entfallen. Wird zusätzlich
- die Option \Option{nonfloat} angegeben, wird außerdem eine nicht gleitende
+ definiert. Soll der Gleitumgebungstyp dem Paket überlassen werden, so kann
+ Option \Option{floattype} im Beispiel entfallen. Wird zusätzlich
+ die Option \Option{nonfloat} angegeben, wird außerdem eine nicht gleitende
Umgebung \Environment{remarkbox-} definiert, in der ebenfalls
\DescRef{maincls.cmd.caption}\IndexCmd{caption} verwendet werden kann.
- Zum besseren Verständnis zeigt \autoref{tab:tocbasic.comparison} eine
- Gegenüberstellung der Anweisungen und Umgebungen für die neu erstellte
+ Zum besseren Verständnis zeigt \autoref{tab:tocbasic.comparison} eine
+ Gegenüberstellung der Anweisungen und Umgebungen für die neu erstellte
Beispielumgebung \Environment{remarkbox} mit den entsprechenden Befehlen und
- Umgebungen für Abbildungen.%
+ Umgebungen für Abbildungen.%
\begin{table}
\centering
- \caption{Gegenüberstellung von Beispielumgebung \Environment{remarkbox}
+ \caption{Gegenüberstellung von Beispielumgebung \Environment{remarkbox}
und Umgebung \Environment{figure}}
\label{tab:tocbasic.comparison}
\begin{tabularx}{\textwidth}{l@{\hskip\tabcolsep}l@{\hskip\tabcolsep}>{\raggedright}p{7em}@{\hskip\tabcolsep}X}
@@ -2564,16 +2715,16 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
& Gleitumgebung des jeweiligen Typs.\\[1ex]
\Environment{remarkbox*} & \Environment{figure*}
& \Option{type}, \Option{float}
- & spaltenübergreifende Gleitumgebung des jeweiligen Typs \\[1ex]
+ & spaltenübergreifende Gleitumgebung des jeweiligen Typs \\[1ex]
\Counter{remarkbox} & \Counter{figure}
& \Option{type}, \Option{float}
- & Zähler, der von \DescRef{maincls.cmd.caption} verwendet wird \\[1ex]
+ & Zähler, der von \DescRef{maincls.cmd.caption} verwendet wird \\[1ex]
\Macro{theremarkbox} & \Macro{thefigure}
& \Option{type}, \Option{float}
- & Anweisung zur Ausgabe des jeweiligen Zählers \\[1ex]
+ & Anweisung zur Ausgabe des jeweiligen Zählers \\[1ex]
\Macro{remarkboxformat} & \DescRef{maincls.cmd.figureformat}
& \Option{type}, \Option{float}
- & Anweisung zur Formatierung des jeweiligen Zählers in der Ausgabe von
+ & Anweisung zur Formatierung des jeweiligen Zählers in der Ausgabe von
\DescRef{maincls.cmd.caption}\\[1ex]
\Macro{remarkboxname} & \Macro{figurename}
& \Option{type}, \Option{float}, \Option{name}
@@ -2584,19 +2735,19 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
& Anweisung zur Ausgabe des jeweiligen Verzeichnisses \\[1ex]
\Macro{listremarkboxname} & \Macro{listfigurename}
& \Option{type}, \Option{float}, \Option{listname}
- & Überschrift des jeweiligen Verzeichnisses \\[1ex]
+ & Ãœberschrift des jeweiligen Verzeichnisses \\[1ex]
\Macro{fps@remarkbox} & \Macro{fps@figure}
& \Option{type}, \Option{float}, \Option{floattype}
& nummerischer Gleitumge\-bungstyp zwecks
Reihen\-fol\-gen\-erhalts\\[1ex]
\File{lor} & \File{lof}
&
- & Dateiendung der Hilfsdatei für das jeweilige Verzeichnis \\
+ & Dateiendung der Hilfsdatei für das jeweilige Verzeichnis \\
\bottomrule
\end{tabularx}
\end{table}
- Und hier nun eine mögliche Verwendung der Umgebung:
+ Und hier nun eine mögliche Verwendung der Umgebung:
\begin{lstcode}
\begin{remarkbox}
\centering
@@ -2606,7 +2757,7 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
\label{rem:typo1}
\end{remarkbox}
\end{lstcode}
- Ein Ausschnitt aus einer Beispielseite mit dieser Umgebung könnte dann so
+ Ein Ausschnitt aus einer Beispielseite mit dieser Umgebung könnte dann so
aussehen:
\begin{center}\footnotesize
\begin{tabular}
@@ -2629,11 +2780,11 @@ möglich. Siehe dazu \autoref{sec:tocbasic.tocstyle},
Benutzer von
\Package{hyperref}\IndexPackage{hyperref}\important{\Package{hyperref}}
-sollten Option \Option{listname} übrigens immer angeben. Anderenfalls kommt es
+sollten Option \Option{listname} übrigens immer angeben. Anderenfalls kommt es
in der Regel zu einer Fehlermeldung, weil \Package{hyperref} nicht mit dem
\Macro{MakeUppercase}\IndexCmd{MakeUppercase} im Namen des Verzeichnisses
-zurecht kommt, das benötigt wird, um den ersten Buchstaben des Wertes von
-\Option{types} in Großbuchstaben zu wandeln.%
+zurecht kommt, das benötigt wird, um den ersten Buchstaben des Wertes von
+\Option{types} in Großbuchstaben zu wandeln.%
\EndIndexGroup
%
\EndIndexGroup
@@ -2643,21 +2794,21 @@ zurecht kommt, das benötigt wird, um den ersten Buchstaben des Wertes von
%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
-%%% coding: iso-latin-1
+%%% coding: utf-8
%%% ispell-local-dictionary: "de_DE"
%%% TeX-master: "../guide"
%%% End:
% LocalWords: Verzeichnisdatei Klonquelle Absatzabstandes Absatzabstand
-% LocalWords: Verzeichniseinträge Verzeichniseintrag Eintragsstile
-% LocalWords: Inhaltsverzeichniseinträge Standardklassen Nummernbreite
+% LocalWords: Verzeichniseinträge Verzeichniseintrag Eintragsstile
+% LocalWords: Inhaltsverzeichniseinträge Standardklassen Nummernbreite
% LocalWords: Standardeigenschaft Eintragsebene Optionenliste expandierbar
% LocalWords: Standardverzeichniseintragsstil Verzeichniseigenschaften
% LocalWords: Verzeichniseintragsstil Verzeichniseintragsstils Eintragsstil
-% LocalWords: Kapitelüberschrift Gliederungsebene expandierbares
+% LocalWords: Kapitelüberschrift Gliederungsebene expandierbares
% LocalWords: Eintragsnummer Initialisierungscode Aktivierungswerte
% LocalWords: Deaktivierungswert Verzeichnistitel Eintragstyp Eintragstyps
-% LocalWords: Verzeichniseintrags Säumniswert Überschriftenanweisung
+% LocalWords: Verzeichniseintrags Säumniswert Überschriftenanweisung
% LocalWords: Eintragstext Dateierweiterung Dateierweiterungen Paketautoren
% LocalWords: Verzeichnisbefehle Verzeichnisdaten Schrifteinstellungen
-% LocalWords: Eintragsebenen Platzierungsoptionen Kapiteleinträge
+% LocalWords: Eintragsebenen Platzierungsoptionen Kapiteleinträge