summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex760
1 files changed, 446 insertions, 314 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex
index dc04f0604ce..e029743e1ca 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/tocbasic.tex
@@ -1,6 +1,6 @@
% ======================================================================
% tocbasic.tex
-% Copyright (c) Markus Kohm, 2002-2011
+% Copyright (c) Markus Kohm, 2002-2012
%
% 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-2011
+% Copyright (c) Markus Kohm, 2002-2012
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,19 +45,21 @@
%
% ======================================================================
-\ProvidesFile{tocbasic.tex}[2010/06/02 KOMA-Script package tocbasic]
+\ProvidesFile{tocbasic.tex}[2012/01/01 KOMA-Script package tocbasic]
\chapter{Verzeichnisse verwalten mit Hilfe von \Package{tocbasic}}
\labelbase{tocbasic}
\BeginIndex{Package}{tocbasic}%
-
-Das Paket \Package{tocbasic} ist neu in \KOMAScript~3.00. Sein Hauptzweck
-besteht darin, Paket- und 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 Verzeichnisse von \Package{babel}\IndexPackage{babel} (siehe
+\BeginIndex{}{Verzeichnis}%
+\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
+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
+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
genommen werden, selbst solche Anpassungen an andere Pakete oder an Klassen
@@ -71,16 +73,18 @@ als auch für die bereits erwähnten Verzeichnisse für Abbildungen und Tabellen.
\label{sec:tocbasic.basics}
Die grundlegenden Anweisungen dienen in erster Linie dazu, eine Liste aller
-bekannten Dateierweiterungen, die für Verzeichnisse stehen, zu
-verwalten. Einträge in Dateien mit solchen Dateierweiterungen werden
-typischerweise mit \Macro{addtocontents} oder \Macro{addcontentsline}
-vorgenommen. Darüber hinaus gibt es Anweisungen, mit denen eine Aktion 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. Dieser Besitzer kann eine Klasse oder ein Paket oder ein
-Bezeichner sein, den der Autor der Klasse oder des Pakets, das
-\Package{tocbasic} verwendet, selbst gewählt hat. \KOMAScript{} selbst
+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},
+ \Macro{addcontentsline}} oder \Macro{addcontentsline} vorgenommen. Darüber
+hinaus gibt es Anweisungen, mit denen eine Aktion 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, selbst 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{}
@@ -99,7 +103,7 @@ ausgeführt.
Angenommen, Sie wollen wissen, ob die Dateierweiterung »\File{foo}« bereits
verwendet wird, um in diesem Fall einen Fehlermeldung auszugeben, weil diese
damit nicht mehr verwendet werden kann:
- \begin{lstcode}
+\begin{lstcode}
\ifattoclist{foo}{%
\PackageError{bar}{%
extension `foo' already in use%
@@ -113,7 +117,7 @@ ausgeführt.
}{%
\PackageInfo{bar}{using extension `foo'}%
}
- \end{lstcode}
+\end{lstcode}
\end{Example}
%
\EndIndex{Package}{tocbasic}
@@ -124,61 +128,66 @@ ausgeführt.
\end{Declaration}
\BeginIndex{Cmd}{addtotoclist}%
Diese Anweisung fügt die \PName{Dateierweiterung} zu der Liste der bekannten
-Dateierweiterungen. Wenn das optionale Argument \OParameter{Besitzer}
-angegeben wurde, wird der angegebene \PName{Besitzer} für diese
-Dateierweiterung mit gespeichert. Wurde das optionale Argument weg gelassen,
-dann versucht \Package{tocbasic} den Dateinamen der aktuell abgearbeiteten
-Klasse oder des Pakets herauszufinden und als \PName{Besitzer} zu
-speichern. Dies funktioniert nur, wenn \Macro{addtotoclist} während des Ladens
-der Klasse oder des Pakets aufgerufen wird. Es funktioniert nicht, wenn
-\Macro{addtoclist} erst später Aufgrund der Verwendung einer Anweisung durch
-den Benutzer aufgerufen wird. In diesem Fall wird als \PName{Besitzer}
-»\PValue{.}« eingetragen. Beachten 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 leeren \PName{Besitzer} ergeben.
+Dateierweiterungen. 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
+das optionale Argument weg gelassen, 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{addtoclist} erst später
+Aufgrund der Verwendung einer Anweisung durch den Benutzer aufgerufen wird. In
+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
+leeren \PName{Besitzer} ergeben.
\begin{Example}
Angenommen, Sie wollen die Dateierweiterung »\File{foo}« zu der Liste der
bekannten Dateierweiterungen hinzufügen, während Ihr Paket mit dem
Dateinamen »\File{bar.sty}« geladen wird:
- \begin{lstcode}
+\begin{lstcode}
\addtotoclist{foo}
- \end{lstcode}
+\end{lstcode}
Dies fügt die Dateierweiterung »\PValue{foo}« mit dem Besitzer
»\PValue{bar.sty}« zur Liste der bekannten Dateierweiterung, wenn diese
Erweiterung nicht bereits in der Liste ist. Wenn bereits die verwendete
Klasse oder ein anderes Paket diese Dateierweiterung angemeldet hat,
erhalten Sie den Fehler:
- \begin{lstoutput}
- Package tocbasic Error: file extension `#2' cannot be used twice
+\begin{lstoutput}
+ Package tocbasic Error: file extension `foo' cannot be used twice
See the tocbasic package documentation for explanation.
Type H <return> for immediate help.
- \end{lstoutput}
+\end{lstoutput}
Wenn Sie dann tatsächlich die Taste »\texttt{H}« gefolgt von der
Return-Taste drücken, erhalten Sie als Hilfe:
- \begin{lstoutput}
+\begin{lstoutput}
File extension `foo' is already used by a toc-file, while bar.sty
tried to use it again for a toc-file.
This may be either an incompatibility of packages, an error at a package,
or a mistake by the user.
- \end{lstoutput}
+\end{lstoutput}
- Aber vielleicht stellt Ihr Paket auch eine Anweisung bereit, mit der ein
- Verzeichnis dynamisch erzeugt werden kann. In diesem Fall sollten Sie das
+ Vielleicht stellt Ihr Paket auch eine Anweisung bereit, die ein
+ Verzeichnis dynamisch erzeugt. In diesem Fall sollten Sie das
optionale Argument von \Macro{addtotoclist} verwenden, um den
\PName{Besitzer} anzugeben:
- \begin{lstcode}
+\begin{lstcode}
\newcommand*{\createnewlistofsomething}[1]{%
\addtotoclist[bar.sty]{#1}%
% Weitere Aktionen, um dieses Verzeichnis
% verfügbar zu machen
}
- \end{lstcode}
+\end{lstcode}
Wenn jetzt der Anwender diese Anweisung aufruft, beispielsweise mit
- \begin{lstcode}
+\begin{lstcode}
\createnewlistofsomething{foo}
- \end{lstcode}
+\end{lstcode}
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
@@ -205,29 +214,31 @@ Besitzer »\PName{float}« anmeldet und die Optionen für diese Besitzer setzt.%
Auf diese Weise können die \Parameter{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 Argument wird wie
-in der Erklärung von \Macro{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 \Macro{@currext} die Dateierweiterung, die
-gerade hinzugefügt wird.
+Dateierweiterungen hinzugefügt wird. Bezüglich des optionalen Argument wird
+wie in der Erklärung von \Macro{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
+\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
+Dateierweiterung, die gerade hinzugefügt wird.
\begin{Example}
\Package{tocbasic} selbst verwendet
% Umbruchkorrektur (schließende Klammer verschoben)
- \begin{lstcode}
+\begin{lstcode}
\AtAddToTocList[]{%
\expandafter\tocbasic@extend@babel
\expandafter{\@currext}}
- \end{lstcode}
+\end{lstcode}
um jede Dateierweiterung zu der in \Package{tocbasic} vorhandenen
- Erweiterung für das Paket \Package{babel} hinzuzufügen. Die zweimalige
- Verwendung von \Macro{expandafter} ist an dieser Stelle erforderlich, weil
- das Argument von \Macro{tocbasic@extend@babel} unbedingt expandiert sein
- muss. Siehe dazu die Erklärung zu \Macro{tocbasic@extend@babel} in
- \autoref{sec:tocbasic.internals},
- \autopageref{desc:tocbasic.cmd.tocbasic@extend@babel}.
+ 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 \Macro{tocbasic@extend@babel}
+zwingend bereits expandiert sein muss. Siehe dazu auch die Erklärung zu
+\Macro{tocbasic@extend@babel} in \autoref{sec:tocbasic.internals},
+\autopageref{desc:tocbasic.cmd.tocbasic@extend@babel}.
%
\EndIndex{Cmd}{AtAddToTocList}%
@@ -252,26 +263,26 @@ unabhängig vom Besitzer entfernt.%
\end{Declaration}
\BeginIndex{Cmd}{doforeachtocfile}%
Bisher haben Sie nur Anweisungen kennen gelernt, die für Klassen- und
-Paketautoren 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 \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 hingegen nur die Dateierweiterungen mit leerem Besitzer
-verarbeiten.
+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
+\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
+hingegen nur die Dateierweiterungen mit leerem Besitzer verarbeiten.
\begin{Example}
Wenn Sie die Liste aller bekannten Dateierweiterungen auf das Terminal und
in die \File{log}-Datei ausgeben wollen, ist dies einfach mit
- \begin{lstcode}
+\begin{lstcode}
\doforeachtocfile{\typeout{\@currext}}
- \end{lstcode}
+\end{lstcode}
möglich. Wollen Sie hingegen nur die Dateierweiterungen des Besitzer
»\PValue{foo}«, dann geht das einfach mit:
- \begin{lstcode}
+\begin{lstcode}
\doforeachtocfile[foo]{\typeout{\@currext}}
- \end{lstcode}
+\end{lstcode}
\end{Example}
Die \KOMAScript-Klassen \Class{scrbook} und \Class{scrreprt} verwenden diese
Anweisung übrigens, um für jedes Verzeichnis, für das die Eigenschaft
@@ -324,33 +335,33 @@ verbunden ist.
\Macro{addtoeachtocfile}\OParameter{Besitzer}\Parameter{Inhalt}
\end{Declaration}
\BeginIndex{Cmd}{addtoeachtocfile}%
-Die Anweisung \Macro{addtoeachtocfile} arbeitet ähnlich zu
-\Macro{addtotocfile} aus dem \LaTeX-Kern mit dem Unterschied, dass
-es \Parameter{Inhalt} in jede Datei schreibt, die für den angegebenen
-\PName{Besitzer} in der Liste der bekannten Dateierweiterungen zu finden
-ist. Wird das optionale Argument weggelassen, wird in jede Datei aus der Liste
-der bekannten Dateierweiterungen geschrieben. Der konkrete Dateiname setzt
-sich dabei übrigens aus \Macro{jobname} und der Dateierweiterung
-zusammen. Während des Schreibens von \PName{Inhalt} ist \Macro{@currext} die
+Die Anweisung \Macro{addtoeachtocfile} schreibt \PName{Inhalt} mit Hilfe von
+\Macro{addtocontents} aus dem \LaTeX-Kern in jede Datei, die für den
+angegebenen \PName{Besitzer} in der Liste der bekannten Dateierweiterungen zu
+finden ist. Wird das optionale Argument weggelassen, wird in jede Datei aus
+der Liste der bekannten Dateierweiterungen geschrieben. Der 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}
Sie wollen einen vertikalen Abstand von einer Zeile in alle Dateien aus der
Liste der bekannten Dateierweiterungen schreiben.
- \begin{lstcode}
+\begin{lstcode}
\addtoeachtocfile{%
\protect\addvspace{\protect\baselineskip}%
}%
- \end{lstcode}
+\end{lstcode}
Wenn Sie das hingegen nur für die Dateien mit dem definierten Besitzer
»\PValue{foo}« machen wollen, verwenden Sie:
- \begin{lstcode}
+\begin{lstcode}
\addtoeachtocfile[foo]{%
\protect\addvspace{\protect\baselineskip}%
}
- \end{lstcode}
+\end{lstcode}
\end{Example}
Anweisungen, die nicht bereits beim Schreiben expandiert werden sollen, sollte
-wie bei \Macro{addtotocfile} mit \Macro{protect} geschützt werden.
+wie bei \Macro{addtocontents} mit \Macro{protect} geschützt werden.
\EndIndex{Cmd}{addtoeachtocfile}%
@@ -358,26 +369,31 @@ wie bei \Macro{addtotocfile} mit \Macro{protect} geschützt werden.
\Macro{addcontentslinetoeachtocfile}\OParameter{Besitzer}\Parameter{Ebene}\Parameter{Inhalt}
\end{Declaration}
\BeginIndex{Cmd}{addcontentslinetoeachtocfile}%
-Diese Anweisung ist mit der \LaTeX-Kern-Anweisung \Macro{addcontentsline}
-vergleichbar. Der Unterschied besteht darin, dass auch diese Anweisung nicht
-nur in eine einzelne Datei, sondern in alle Dateien eines angegebenen
-Besitzers und bei Verzicht auf das optionale Argument in alle Dateien aus der
-Liste der bekannten Dateierweiterungen schreibt.
+Diese Anweisung ist mit \Macro{addcontentsline} aus dem \LaTeX-Kern
+vergleichbar. Der Unterschied besteht darin, dass diese Anweisung
+\PName{Inhalt} nicht nur in eine einzelne Datei, sondern in alle Dateien eines
+angegebenen \PName{Besitzers} und bei Verzicht auf das optionale Argument in
+alle 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 \PName{\#1} den Titel enthält, der geschrieben
werden soll.
- \begin{lstcode}
+\begin{lstcode}
\addcontentslinetoeachtocfile{chapter}{%
- \protect\numberline{\thechapter}#1}%
- \end{lstcode}
+ \protect\numberline{\thechapter}#1%
+ }%
+\end{lstcode}
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.
\end{Example}
+Während des Schreibens von \PName{Inhalt} ist auch hier wie schon bei
+\Macro{addtoeachtocfile}
+\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
+Dateierweiterung der Datei, in die aktuell geschrieben wird.
%
-\EndIndex{Cmd}{addcontentslineroeachtocfile}%
+\EndIndex{Cmd}{addcontentslinetoeachtocfile}%
\begin{Declaration}
@@ -390,50 +406,85 @@ Liste der bekannten Dateierweiterungen schreibt.
\BeginIndex{Cmd}{listoftoc*}%
\BeginIndex{Cmd}{listofeachtoc}%
\BeginIndex{Cmd}{listof\PName{Dateierweiterung}name}%
-Mit diesen Anweisungen werden die Verzeichnisse ausgegeben. Die 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 direkter Ersatz der \LaTeX-Kern-Anweisung
-\Macro{@starttoc} verstanden werden.
-
-Die 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 auch als optionaler Eintrag in
-Inhaltsverzeichnis und Kolumnentitel verwendet. Ist das Argument \PName{Titel}
-lediglich leer, so wird auch eine leere Angabe verwendet. Wird hingegen das
-komplette Argument einschließlich der eckigen Klammern weggelassen, so wird
-die Anweisung \Macro{listof\PName{Dateierweiterung}name} verwendet, wenn diese
+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
+direkter Ersatz der \LaTeX-Kern-Anweisung
+\Macro{@starttoc}\IndexCmd{@starttoc}\important{\Macro{@starttoc}} verstanden
+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
+auch als optionaler Eintrag in Inhaltsverzeichnis und 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
+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 Anweisung \Macro{listofeachtoc} gibt alle Verzeichnisse des angegebenen
-Besitzers oder alle Verzeichnisse aller bekannten Dateinamenerweiterungen
-aus. Dabei sollte \Macro{listof\PName{Dateierweiterung}name} definiert sein,
-damit der korrekte Titel ausgegeben werden kann. Da eventuell auch der
-Anwender selbst die Anweisungen \Macro{listoftoc*} und \Macro{listofeachtoc}
-verwenden könnte, wird empfohlen \Macro{listof\PName{Dateierweiterung}name}
-immer passend zu definieren.
+Die\important{\Macro{listofeachtoc}} Anweisung \Macro{listofeachtoc} gibt alle
+Verzeichnisse des angegebenen Besitzers 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
+passend zu definieren.
\begin{Example}
Angenommen, Sie haben ein neues »Verzeichnis der Algorithmen« mit der
Dateierweiterung »\PValue{loa}« und wollen dieses anzeigen lassen:
- \begin{lstcode}
+\begin{lstcode}
\listoftoc[Verzeichnis der Algorithmen]{loa}
- \end{lstcode}
+\end{lstcode}
erledigt das für Sie. Wollen Sie das Verzeichnis hingegen ohne Überschrift
ausgegeben haben, dann genügt:
- \begin{lstcode}
+\begin{lstcode}
\listoftoc*{loa}
- \end{lstcode}
- In diesem Fall würde natürlich auch ein optional aktivierter Eintrag in das
+\end{lstcode}
+ In 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 \Macro{setuptoc},
\autopageref{desc:tocbasic.cmd.setuptoc} zu finden.
+
+ Wenn Sie zuvor
+\begin{lstcode}
+ \newcommand*{\listofloaname}{%
+ Verzeichnis der Algorithmen%
+ }
+\end{lstcode}
+ 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
+\begin{lstcode}
+ \newcommand*{\listofalgorithms}{\listoftoc{loa}}
+\end{lstcode}
+ als einfache Verzeichnisanweisung definieren.
\end{Example}
+
+Da\textnote{Achtung!} \LaTeX{} bei der Ausgabe eines Verzeichnisses auch
+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
+diesem Fall das Lades des in \autoref{cha:scrwfile} beschriebenen Pakets
+\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile} bieten.
%
\EndIndex{Cmd}{listof\PName{Dateierweiterung}name}%
\EndIndex{Cmd}{listofeachtoc}%
@@ -455,8 +506,13 @@ mit Hilfe von \Macro{listoftoc*}, \Macro{listoftoc} oder \Macro{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
-\Macro{@currext} die Dateierweiterung der Datei, die eingelesen wird
-bzw. gerade eingelesen wurde.%
+\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} die
+Dateierweiterung der Datei, die eingelesen wird bzw. gerade eingelesen
+wurde.
+
+Ein Beispiel\textnote{Beispiel} zur Verwendung von \Macro{AfterStartingTOC}
+ist in \autoref{sec:scrwfile.clonefilefeature} auf
+\autopageref{example:scrwfile.AfterStartingTOC} zu finden.
\EndIndex{Cmd}{AfterStartingTOC}%
\EndIndex{Cmd}{BeforeStartingTOC}%
@@ -470,8 +526,10 @@ bzw. gerade eingelesen wurde.%
Es können auch \PName{Anweisungen} definiert werden, die unmittelbar vor oder
nach dem Setzen der Überschrift bei Verwendung von \Macro{listoftoc} oder
\Macro{listofeachtoc}, ausgeführt werden. Bezüglich des optionalen Arguments
-und der Bedeutung von \Macro{@currext} gilt, was bereits bei
-\Macro{BeforeStartingTOC} und \Macro{AfterStartingTOC} oben erklärt wurde.%
+und der Bedeutung von
+\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} gilt, was
+bereits bei \Macro{BeforeStartingTOC} und \Macro{AfterStartingTOC} oben
+erklärt wurde.%
\EndIndex{Cmd}{AfterTOCHead}%
\EndIndex{Cmd}{BeforeTOCHead}%
@@ -480,25 +538,47 @@ und der Bedeutung von \Macro{@currext} gilt, was bereits bei
\Macro{MakeMarkcase}
\end{Declaration}
\BeginIndex{Cmd}{MakeMarkcase}%
-Wenn das Paket \Package{tocbasic} eine Marke für einen Kolumnentitel setzt,
-dann setzt sie diese immer 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 \KOMAScript-Klasse \Macro{@firstofone}
-und bei Verwendung einer anderen Klasse \Macro{MakeUppercase}. Die Anweisung
-wird von \Package{tocbasic} jedoch nur definiert, wenn sie noch 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,
+Wann immer \Package{tocbasic} eine Marke für einen Kolumnentitel setzt, dann
+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
+\KOMAScript-Klasse
+\Macro{@firstofone}\IndexCmd{@firstofone}\important{\Macro{@firstofone}}, also
+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 noch
+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
Kolumnentitel gilt, die von \Package{tocbasic} gesetzt werden, definieren
Sie:
- \begin{lstcode}
+\begin{lstcode}
\let\MakeMarkcase\MakeLowercase
- \end{lstcode}
+\end{lstcode}
\end{Example}
+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. Darüber hinaus
+sind sich alle Typografen einig, dass beim Versalsatz, also beim Satz
+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
+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 die absoluten
+Experten ist und fast immer Handarbeit bedeutet, wird Laien empfohlen, darauf
+eher zu verzichten oder ihn nur vorsichtig und nicht an so exponierter Stelle
+wie im Kolumnentitel zu verwenden.
%
\EndIndex{Cmd}{MakeMarkcase}%
@@ -529,44 +609,53 @@ Titel für das Verzeichnis übergeben.
\end{Declaration}
\BeginIndex{Cmd}{setuptoc}%
\BeginIndex{Cmd}{unsettoc}%
-Mit diesen Anweisungen können \PName{Eigenschaften} für eine
+Mit diesen beiden Anweisungen können \PName{Eigenschaften} für eine
\PName{Dateierweiterung} bzw. das Verzeichnis, das dazu gehört, gesetzt
werden. Die \PName{Liste von Eigenschaften} ist dabei eine durch Komma
getrennte Aneinanderreihung von \PName{Eigenschaften}. Das Paket
\Package{tocbasic} wertet folgende Eigenschaften aus:
\begin{description}
\item[\PValue{leveldown}] bedeutet, dass das Verzeichnis nicht mit der
- obersten Gliederungsebene (wenn vorhanden \Macro{chapter}, sonst
- \Macro{section}) erstellt wird, sondern mit einer Überschrift der nächst
- tieferen Gliederungsebene. Diese Eigenschaft wird von der internen
- Überschriftenanweisung ausgewertet. Wird hingegen eine eigene
- Überschriftenanweisung mit \Macro{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 \OptionValue{listof}{leveldown} für alle Dateierweiterungen des
- Besitzers \Package{float}.
+ obersten Gliederungsebene unterhalb von \Macro{part} -- wenn vorhanden
+ \Macro{chapter}, sonst \Macro{section} -- 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 \Macro{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
+ \OptionValue{listof}{leveldown}\important{\OptionValue{listof}{leveldown}}%
+ \IndexOption{listof~=\PValue{leveldown}}
+ für alle Dateierweiterungen des Besitzers \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
+ werden, die nur in einer festen Sprache erstellt werden, in denen also
+ Sprachumschaltungen im Dokument nicht zu berücksichtigen sind. Sie wird
+ außerdem von Pakage
+ \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.
\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 \Macro{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 \OptionValue{listof}{numbered} für
+ Eigenschaft bei Verwendung der Option
+ \OptionValue{listof}{numbered}\important{\OptionValue{listof}{numbered}}%
+ \IndexOption{listof~=\PValue{numbered}} für
alle Dateierweiterungen des Besitzers \Package{float}.
-\item[\PValue{nobabel}] bedeutet, dass die normalerweise automatisch
- verwendete Erweiterung für die Sprachumschaltung mit \Package{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.
%% NEW FEATURE 3.01
\item[\PValue{onecolumn}] \leavevmode\ChangedAt{v3.01}{\Package{tocbasic}}%
bedeutet, dass für dieses Verzeichnis automatisch der \LaTeX-interne
- Einspaltenmodus mit \Macro{onecolumn}\IndexCmd{onecolumn} verwendet wird,
- falls dieses Verzeichnis nicht mit der Eigenschaft \PValue{leveldown} um
- eine Gliederungsebene nach unten verschoben wurde. Die \KOMAScript-Klassen
- \Class{scrbook} und \Class{scrreprt} setzen diese Eigenschaft per
- \Macro{AtAddToTocList} (siehe
+ Einspaltenmodus mit \Macro{onecolumn}\IndexCmd{onecolumn} verwendet
+ wird. Dies\textnote{Achtung!} gilt jedoch nur, falls dieses Verzeichnis
+ nicht mit der oben beschriebenen Eigenschaft
+ \PValue{leveldown}\important{\PValue{leveldown}} um eine Gliederungsebene
+ nach unten verschoben wurde. Die \KOMAScript-Klassen \Class{scrbook} und
+ \Class{scrreprt} setzen diese Eigenschaft per \Macro{AtAddToTocList} (siehe
\autopageref{desc:tocbasic.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
@@ -577,19 +666,23 @@ getrennte Aneinanderreihung von \PName{Eigenschaften}. Das Paket
%% END NEW FEATURE 3.01
\item[\PValue{totoc}] bedeutet, dass der Titel des Verzeichnisses in das
Inhaltsverzeichnis aufgenommen werden soll. Diese Eigenschaft wird von der
- internen Überschriftenanweisung ausgewertet. Wird hingegen eine eigene
- Überschriftenanweisung mit \Macro{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 \OptionValue{listof}{totoc} für alle Dateierweiterungen des
- Besitzers \Package{float}.
+ internen Überschriftenanweisung ausgewertet. Wird\textnote{Achtung!} mit
+ \Macro{deftocheading}\important{\Macro{deftocheading}}%
+ \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
+ \OptionValue{listof}{totoc}\important{\OptionValue{listof}{totoc}}%
+ \IndexOption{listof~=\PValue{totoc}} für alle
+ Dateierweiterungen des Besitzers \Package{float}.
\end{description}
Die \KOMAScript-Klassen kennen eine weitere Eigenschaft:
\begin{description}
\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 \Option{listof} in
+ Abstand. Näheres zu den Möglichkeiten ist Option
+ \Option{listof}\IndexOption{listof}\important{\Option{listof}} in
\autoref{sec:maincls.floats}, \autopageref{desc:maincls.option.listof} zu
entnehmen.
\end{description}
@@ -597,36 +690,36 @@ Die \KOMAScript-Klassen kennen eine weitere Eigenschaft:
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}
+\begin{lstcode}
\unsettoc{lof}{chapteratlist}
\unsettoc{lot}{chapteratlist}
- \end{lstcode}
+\end{lstcode}
Wollen Sie hingegen, dass das von Ihnen definierte Verzeichnis mit der
Dateierweiterung »\PName{loa}« ebenfalls von der Kapiteluntergliederung der
\KOMAScript-Klassen betroffen ist, so verwenden Sie
- \begin{lstcode}
+\begin{lstcode}
\setuptoc{loa}{chapteratlist}
- \end{lstcode}
+\end{lstcode}
%% NEW FEATURE 3.01
Wollen Sie außerdem, dass bei Klassen, die \Macro{chapter} als oberste
Gliederungsebene verwenden, das Verzeichnis automatisch einspaltig gesetzt
wird, so verwenden Sie außerdem
- \begin{lstcode}
+\begin{lstcode}
\ifundefinedorrelax{chapter}{}{%
\setuptoc{loa}{onecolumn}%
}
- \end{lstcode}
- Diese Lösung setzt aufgrund der Verwendung von \Macro{ifundefinedorrelax}
- zusäzlich das Paket \Package{scrbase} voraus (siehe
+\end{lstcode}
+ Die Verwendung von \Macro{ifundefinedorrelax}
+ setzt das Paket \Package{scrbase} voraus (siehe
\autoref{sec:scrbase.if},
\autopageref{desc:scrbase.cmd.ifundefinedorrelax}).
%% END NEW FEATURE 3.01
- Sollte 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
- dann eben automatisch die Möglichkeiten jener Klasse.
+ 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.
\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
@@ -637,16 +730,17 @@ bedeuteten und deshalb in vielen Paketen leider fehlen.%
\begin{Declaration}
- \Macro{iftocfeature}\Parameter{Dateierweiterung}\Parameter{Eigenschaft}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
+ \Macro{iftocfeature}\Parameter{Dateierweiterung}\Parameter{Eigenschaft}\Parameter{Dann-Teil}\\
+ \hphantom{\Macro{iftocfeature}}\Parameter{Sonst-Teil}
\end{Declaration}
\BeginIndex{Cmd}{iftocfeature}%
-Mit dieser Anweisung können Sie feststellen, ob eine bestimmte
-\PName{Eigenschaft} für eine \PName{Dateierweiterung} gesetzt ist. Ist sie
-gesetzt, so wird der \PName{Dann-Teil} ausgeführt, anderenfalls der
-\PName{Sonst-Teil}. Dies ist beispielsweise dann nützlich, wenn Sie eigene
+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 \Macro{deftocheading} definieren, aber die oben
-beschriebene Eigenschaft \PValue{totoc}, \PValue{numbered} oder
-\PValue{leveldown} ebenfalls unterstützen wollen.
+beschriebenen Eigenschaften \PValue{totoc}, \PValue{numbered} oder
+\PValue{leveldown} unterstützen wollen.
%
\EndIndex{Cmd}{iftocfeature}%
@@ -654,13 +748,13 @@ beschriebene Eigenschaft \PValue{totoc}, \PValue{numbered} oder
\section{Interne Anweisungen für Klassen- und Paketautoren}
\label{sec:tocbasic.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 auch Klassen- und Paketautoren
-sollten diese Anweisungen nur verwenden und nicht etwas umdefinieren! Ihre
-interne Funktion kann jederzeit geändert oder erweitert werden, so dass
-Umdefinierung der Anweisungen die Funktion von \Package{tocbasic} erheblich
-beschädigen könnte!
+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 etwas
+umdefinieren! Ihre interne Funktion kann jederzeit geändert oder erweitert
+werden, so dass Umdefinierung der Anweisungen die Funktion von
+\Package{tocbasic} erheblich beschädigen könnte!
\begin{Declaration}
@@ -679,15 +773,15 @@ dass mit Hilfe von \Macro{tocbasic@extend@babel} auch andere
Anderenfalls besteht die Gefahr, dass etwa die Bedeutung eines Makros zum
Zeitpunkt der tatsächlichen Auswertung bereits geändert wurde.
-Normalerweise wird diese Anweisung für alle \PName{Dateierweiterungen}, die mit
-\Macro{addtotoclist} zur Liste der bekannten Dateierweiterungen hinzugefügt
-werden, aufgerufen. Über die Eigenschaft \PValue{nobabel} (siehe
+In der Voreinstellung wird diese Anweisung normalerweise für alle
+\PName{Dateierweiterungen}, die mit \Macro{addtotoclist} zur Liste der
+bekannten Dateierweiterungen hinzugefügt werden, aufgerufen. Über die
+Eigenschaft \PValue{nobabel}\important{\PValue{nobabel}} (siehe
\Macro{setuptoc}, \autoref{sec:tocbasic.toc},
\autopageref{desc:tocbasic.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,
-damit die Umschaltung nicht mehrfach in die zugehörigen Dateien eingetragen
-wird.
+die Dateinamenerweiterungen \File{toc}, \File{lof} und \File{lot} unterdrückt
+\Package{tocbasic} dies bereits selbst, damit die Umschaltung nicht mehrfach
+in die zugehörigen Dateien eingetragen wird.
Normalerweise gibt es keinen Grund, diese Anweisung selbst aufzurufen. Es sind
allerdings Verzeichnisse denkbar, die nicht unter der Kontrolle von
@@ -704,15 +798,35 @@ nur einmal geschieht!
\Macro{tocbasic@starttoc}\Parameter{Dateierweiterung}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@starttoc}%
-Diese Anweisung ist der eigentlich Ersatz der Anweisung \Macro{@starttoc} aus
-dem \LaTeX-Kern. Es ist die Anweisung, die sich hinter \Macro{listoftoc*}
+Diese Anweisung ist der eigentlich Ersatz der Anweisung
+\Macro{@starttoc}\IndexCmd{@starttoc}\important{\Macro{@starttoc}} aus dem
+\LaTeX-Kern. Es ist die Anweisung, die sich hinter \Macro{listoftoc*} (siehe
+\autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.listoftoc*})
verbirgt. Klassen- oder Paketautoren, die Vorteile von \Package{tocbasic}
nutzen wollen, sollten zumindest diese Anweisung, besser jedoch
\Macro{listoftoc} verwenden. Die Anweisung baut selbst auf \Macro{@starttoc}
-auf, setzt allerdings zuvor \Length{parskip} und \Length{parindent} auf 0 und
-\Length{parfillskip} auf 0 bis unendlich. Außerdem wird \Macro{@currext} auf
-die aktuelle Dateierweiterung gesetzt, damit diese in den nachfolgend
-ausgeführten Haken ausgewertet werden können.
+auf, setzt allerdings zuvor
+\Length{parskip}\IndexLength{parskip}\important{\Length{parskip}\\
+ \Length{parindent}\\
+ \Length{parfillskip}} und \Length{parindent}\IndexLength{parindent} auf 0
+und \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 ausgewertet werden können.
+
+Da\textnote{Achtung!} \LaTeX{} bei der Ausgabe eines Verzeichnisses auch
+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
+diesem Fall das Lades des in \autoref{cha:scrwfile} beschriebenen Pakets
+\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}
+bieten.
%
\EndIndex{Cmd}{tocbasic@starttoc}%
@@ -724,9 +838,9 @@ ausgeführten Haken ausgewertet werden können.
\BeginIndex{Cmd}{tocbasic@@before@hook}%
\BeginIndex{Cmd}{tocbasic@@after@hook}%
Der Haken \Macro{tocbasic@@before@hook} wird unmittelbar vor dem Einlesen der
-Verzeichnisdatei, aber noch vor den mit \Macro{BeforeStartingTOC} definierten
+Verzeichnisdatei, noch vor den mit \Macro{BeforeStartingTOC} definierten
Anweisungen ausgeführt. Es ist erlaubt, diesen Haken mit Hilfe von
-\Macro{g@addto@macro} zu erweitern.
+\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 \Macro{AfterStartingTOC} definieren Anweisungen
@@ -735,14 +849,16 @@ zu erweitern.
\KOMAScript{} nutzt diese Haken, um die Verzeichnisse mit dynamischer
Anpassung an die Breite der Gliederungsnummern zu ermöglichen. Ihre Verwendung
-ist Klassen und Paketen vorbehalten. Anwender sollten sich auf
-\Macro{BeforeStartingTOC} und \Macro{AfterStartingTOC} beschränken. Paketautoren
-sollten ebenfalls vorzugsweise diese beiden Anwenderanweisungen verwenden!
-Ausgaben innerhalb der beiden Haken sind nicht gestattet!
-
-Werden für die Ausgabe der Verzeichnisse die Anweisungen \Macro{listoftoc},
-\Macro{listoftoc*} und \Macro{listofeachtoc} nicht verwendet, sollten die
-beiden Anweisungen für die Haken trotzdem aufgerufen werden.
+ist Klassen und Paketen vorbehalten. Anwender\textnote{Achtung!} sollten sich
+auf \Macro{BeforeStartingTOC} und \Macro{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 \Macro{listofeachtoc},
+\Macro{listoftoc} und \Macro{listoftoc*} für die Ausgabe der Verzeichnisse
+verwendet, sollten die beiden Anweisungen für die Haken trotzdem aufgerufen
+werden.
%
\EndIndex{Cmd}{tocbasic@@after@hook}%
\EndIndex{Cmd}{tocbasic@@before@hook}%
@@ -754,14 +870,14 @@ beiden Anweisungen für die Haken trotzdem aufgerufen werden.
\end{Declaration}
\BeginIndex{Cmd}{tb@\PName{Dateierweiterung}@before@hook}%
\BeginIndex{Cmd}{tb@\PName{Dateierweiterung}@after@hook}%
-Diese Anweisungen werden unmittelbar nach \Macro{tocbasic@@before@hook}
-bzw. vor \Macro{tocbasic@@after@hook} für die einzelnen
-\PName{Dateierweiterungen} ausgeführt. Sie dürfen keinesfalls von Klassen- und
-Paketautoren verändert werden. Werden für die Ausgabe der Verzeichnisse die
-Anweisungen \Macro{listoftoc}, \Macro{listoftoc*} und \Macro{listofeachtoc}
-nicht verwendet, sollte diese die beiden Anweisungen für die Haken trotzdem
-aufgerufen werden, soweit sie definiert sind. Die Anweisungen können auch
-undefiniert sein.
+Diese Anweisungen werden direkt nach \Macro{tocbasic@@before@hook} bzw. vor
+\Macro{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 Anweisungen \Macro{listoftoc},
+\Macro{listoftoc*} und \Macro{listofeachtoc} nicht verwendet, sollte diese die
+beiden Anweisungen für die Haken trotzdem aufgerufen werden, soweit sie
+definiert sind. Die Anweisungen können auch undefiniert sein.
%
\EndIndex{Cmd}{tb@\PName{Dateierweiterung}@after@hook}%
\EndIndex{Cmd}{tb@\PName{Dateierweiterung}@before@hook}%
@@ -777,7 +893,8 @@ 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 sollte vor dem Aufruf von
-\Macro{tocbasic@listhead} die Anweisung \Macro{@currext} auf die
+\Macro{tocbasic@listhead} die Anweisung
+\Macro{@currext}\important{\Macro{@currext}}\IndexCmd{@currext} auf die
Dateinamenerweiterung, die zu diesem Verzeichnis gehört, gesetzt werden.
%
\EndIndex{Cmd}{tocbasic@listhead}
@@ -800,15 +917,17 @@ definiert \Macro{tocbasic@listhead} diese und ruft sie dann auf.
In diesem Abschnitt finden Sie ein komplettes Beispiel, wie eine eigene
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 verwendet. Das
-bedeutet, dass die Anweisungen entweder in einem eigenen Paket, einer Klasse
-oder zwischen \Macro{makeatletter} und \Macro{makeatother} verwendet werden
-müssen.
-
-Als erstes wird eine Umgebung benötigt, die diese neue Gleitumgebung
-bereitstellt. Das geht ganz einfach mit:
+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.
+
+Als\textnote{Umgebung} erstes wird eine Umgebung benötigt, die diese neue
+Gleitumgebung bereitstellt. Das geht ganz einfach mit:
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newenvironment{remarkbox}{%
\@float{remarkbox}%
}{%
@@ -817,29 +936,29 @@ bereitstellt. Das geht ganz einfach mit:
\end{lstcode}
Die neue Umgebung heißt also \Environment{remarkbox}.
-Jede Gleitumgebung hat eine Standardplatzierung. Diese setzt sich aus
-bekannten Platzierungsoptionen zusammen:
+Jede\textnote{Platzierung} Gleitumgebung hat eine Standardplatzierung. Diese
+setzt sich aus bekannten Platzierungsoptionen zusammen:
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\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.
-Gleitumgebungen haben außerdem einen nummerischen Gleittyp. 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. Sie
-dürfen sich also gegenseitig überholen.
+Gleitumgebungen\textnote{Gleittyp} haben außerdem einen nummerischen
+Gleittyp. 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. Sie dürfen sich also gegenseitig überholen.
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\ftype@remarkbox}{4}
\end{lstcode}
Die neue Umgebung hat den Typ~4, darf also Tabellen und Abbildungen überholen
und von diesen überholt werden.
-Gleitumgebungen haben außerdem eine Nummer.
+Gleitumgebungen\textnote{Nummer} haben außerdem eine Nummer.
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcounter{remarkbox}
\newcommand*{\remarkboxformat}{%
Merksatz~\theremarkbox\csname autodot\endcsname}
@@ -852,78 +971,82 @@ dann in der Definition der formatierten Ausgabe verwendet. Die formatierte
Ausgabe wird wiederum als Gleitumgebungsnummer für die Verwendung in
\Macro{caption} definiert.
-Gleitumgebungen haben Verzeichnisse und diese haben eine Datei mit dem Namen
-\Macro{jobname} und einer Dateierweiterung.
+Gleitumgebungen\textnote{Dateierweiterung} haben Verzeichnisse und diese haben
+eine Datei mit dem Namen \Macro{jobname} und einer Dateierweiterung.
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\ext@remarkbox}{lor}
\end{lstcode}
Als Dateierweiterung verwenden wir also »\File{lor}«.
-Die 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 mit
+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
+mit
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\usepackage{tocbasic}
\end{lstcode}
geladen. Ein Klassen- oder Paketautor würde hingegen
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\RequirePackage{tocbasic}
\end{lstcode}
verwenden.
-Nun machen wir die neue Dateierweiterung dem Paket \Package{tocbasic}
-bekannt.
+Nun\textnote{Dateierweiterung} machen wir die neue Dateierweiterung dem Paket
+\Package{tocbasic} bekannt.
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\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
von Gleitumgebungen beziehen, auch auf das neue Verzeichnis beziehen.
-Jetzt definieren wir noch einen Titel für dieses Verzeichnis:
+Jetzt\textnote{Verzeichnistitel} definieren wir noch einen Titel für dieses
+Verzeichnis:
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\listoflorname}{Verzeichnis der Merksätze}
\end{lstcode}
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 andere Sprachen.
-Jetzt müssen wir nur noch definieren, wie ein einzelner Eintrag in dem
-Verzeichnis aussehen soll:
+Jetzt\textnote{Verzeichniseintrag} müssen wir nur noch definieren, wie ein
+einzelner Eintrag in dem Verzeichnis aussehen soll:
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\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
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\l@remarkbox}{\@dottedtocline{1}{1em}{1.5em}}
\end{lstcode}
verwenden können.
-Außerdem wollen Sie, das Kapiteleinträge sich auf das Verzeichnis auswirken.
+Außerdem\textnote{Kapiteleintrag} wollen Sie, das Kapiteleinträge sich auf das
+Verzeichnis auswirken.
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\setuptoc{lor}{chapteratlist}
\end{lstcode}
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.
-Das genügt bereits. Der Anwender kann nun bereits wahlweise mit Hilfe der
-Optionen einer \KOMAScript-Klasse oder \Macro{setuptoc} verschiedene Formen
-der Überschrift (ohne Inhaltsverzeichniseintrag, mit
-Inhaltsverzeichniseintrag, mit Nummerierung) wählen und das Verzeichnis mit
-\Macro{listoftoc}\PParameter{lor} ausgeben. Mit einem schlichten
+Das\textnote{Verzeichnis} genügt bereits. Der Anwender kann nun bereits
+wahlweise mit Hilfe der Optionen einer \KOMAScript-Klasse oder
+\Macro{setuptoc} verschiedene Formen der Überschrift (ohne
+Inhaltsverzeichniseintrag, mit Inhaltsverzeichniseintrag, mit Nummerierung)
+wählen und das Verzeichnis mit \Macro{listoftoc}\PParameter{lor} ausgeben. Mit
+einem schlichten
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\listofremarkboxes}{\listoftoc{lor}}
\end{lstcode}
kann man die Anwendung noch etwas vereinfachen.
@@ -935,20 +1058,20 @@ 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,
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 Babel werden in dem Verzeichnis ebenfalls berücksichtigt.
-
-Natürlich kann ein Paketautor weiteres hinzufügen. So könnte er explizit
-Optionen anbieten, um die Verwendung von \Macro{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 \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
+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 \Macro{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 \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
% Umbruchkorrektur: listings korrigiert!
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\setupremarkboxes}{\setuptoc{lor}}
\end{lstcode}
um eine als Argument an \Macro{setupremarkboxes} übergebene Liste von
@@ -971,29 +1094,37 @@ 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
-werden, innerhalb derer \Macro{caption} Einträge für dieses neue Verzeichnis
-erzeugt.
+werden, innerhalb derer
+\Macro{caption}\important{\Macro{caption}}\IndexCmd{caption} Einträge für
+dieses neue Verzeichnis erzeugt. Auch die Erweiterungen
+\Macro{captionabove}\important[i]{%
+ \Macro{captionabove}\\
+ \Macro{captionbelow}}, \Macro{captionbelow} und \Environment{captionbeside}
+aus den \KOMAScript-Klassen (siehe \autoref{sec:maincls.floats} können dann
+verwendet werden.
\PName{Dateierweiterung} definiert dabei die Dateiendung der Hilfsdatei, die
das Verzeichnis represäntiert, wie dies in \autoref{sec:tocbasic.basics}
bereits erläutert wurde. Dieser Parameter muss angegeben werden und darf nicht
leer sein!
-\PName{Optionenliste} ist eine durch Komma getrennte Liste von Optionen, wie
+\PName{Optionenliste} ist eine durch Komma getrennte Liste, wie
dies auch von \Macro{KOMAoptions} (siehe \autoref{sec:typearea.options})
-bekannt ist. Diese Optionen können jedoch \emph{nicht} mit
+bekannt ist. Diese Optionen\textnote{Achtung!} können jedoch \emph{nicht} mit
\Macro{KOMAoptions}\IndexCmd{KOMAoptions} gesetzt werden! Eine Übersicht über
die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
-
-\begin{desctable}
- \caption{Optionen für die Anweisung
- \Macro{DeclareNewTOC}\label{tab:tocbasic.DeclareNewTOC-options}}%
- \ChangedAt{v3.06}{\Package{tocbasic}}\\
- \Endfirsthead%
- \caption[]{Optionen für die Anweisung
- \Macro{DeclareNewTOC} (\emph{Fortsetzung})}\\
- \Endhead%
- \standardfoot%
+\iffree{}{\vskip-\ht\strutbox\enlargethispage{\dp\strutbox}}% Umbruchoptimierung!
+\begin{desclist}
+ \renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
+ \desccaption[{%
+ Optionen für die Anweisung \Macro{DeclareNewTOC}%
+ }]{%
+ 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})%
+ }%
\entry{\KOption{counterwithin}\PName{\LaTeX-Zähler}}{%
Falls eine neue Gleitumgebung oder eine nicht gleitende Umgebung definiert
wird, so wird für diese auch ein neuer Zähler
@@ -1017,7 +1148,7 @@ die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
Gleitverhalten \texttt{tbp}, also \emph{top}, \emph{bottom},
\emph{page}.}%
\entry{\KOption{floattype}\PName{Gleittyp}}{%
- Jede Gleitumgebung hat einen numerischen Typ. Gleitumgebungen, bei denen
+ 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
@@ -1089,7 +1220,7 @@ die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
des Eintragstyps}} zu definieren. Wird diese Option nicht verwendet,
so wird als \PName{Mehrzahl des Eintragstyps} einfach
»\PName{Eintragstyp}s« verwendet.}%
-\end{desctable}
+\end{desclist}
\begin{Example}
Das Beispiel aus \autoref{sec:tocbasic.example} kann mit Hilfe der neuen
@@ -1098,29 +1229,30 @@ die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
\DeclareNewTOC[%
type=remarkbox,%
types=remarkboxes,%
- float,% Es sollen Gleitumgebungen definiert werden.
+ float,% Gleitumgebungen sollen definiert werden.
floattype=4,%
name=Merksatz,%
listname={Verzeichnis der Merks\"atze}%
]{lor}
\setuptoc{lor}{chapteratlist}
\end{lstcode}
- Damit sind dann neben den Umgebungen \Environment{remarkbox} und
- \Environment{remarkbox*} auch der Zähler \Counter{remarkbox} und die
- Anweisungen \Macro{theremarkbox}, \Macro{remarkboxformat},
- \Macro{remarkboxname}, \Macro{listremarkboxname}, \Macro{listofremarkboxes}
- und 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 zusätzlich
- entfallen. Wird zusätzlich die Option \Option{nonfloat} angegeben, so wird
- zusätzlich ein Umgebung \Environment{remarkbox-} definiert, in der ebenfalls
- \Macro{caption}\IndexCmd{caption} verwendet werden kann, die jedoch nicht
- gleitet.%
+ Neben den Umgebungen \Environment{remarkbox} und \Environment{remarkbox*}
+ 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{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 zusätzlich entfallen. Wird zusätzlich
+ die Option \Option{nonfloat} angegeben, wird außerdem eine nicht gleitende
+ Umgebung \Environment{remarkbox-} definiert, in der ebenfalls
+ \Macro{caption}\IndexCmd{caption} verwendet werden kann.
\end{Example}%
%
\EndIndex{Cmd}{DeclareNewTOC}%
-
%
+\EndIndex{}{Verzeichnis}%
+\EndIndex{}{Dateierweiterung}%
\EndIndex{Package}{tocbasic}%
\endinput