% ======================================================================
% tocbasic.tex
% Copyright (c) Markus Kohm, 2002-2015
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX 
% version 2005/12/01 or later and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
%
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% tocbasic.tex
% Copyright (c) Markus Kohm, 2002-2015
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
% Die neuste Version dieser Lizenz ist
%   http://www.latex-project.org/lppl.txt
% und Version 1.3c ist Teil aller Verteilungen von LaTeX
% Version 2005/12/01 oder spaeter und dieses Werks.
%
% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
% (allein durch den Autor verwaltet).
%
% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
% 
% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
%
% Package tocbasic for Package and Class Authors
% Maintained by Markus Kohm
%
% ----------------------------------------------------------------------
%
% Paket tocbasic für Paket- und Klassenautoren
% Verwaltet von Markus Kohm
%
% ======================================================================

\KOMAProvidesFile{tocbasic.tex}
                 [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
                  KOMA-Script guide (package tocbasic)]

\chapter{Verzeichnisse verwalten mit Hilfe von \Package{tocbasic}}
\labelbase{tocbasic}

\BeginIndex{Package}{tocbasic}%
\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
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
der grundlegenden Anweisungen in \autoref{sec:tocbasic.toc} 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.


\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
Dateierweiterungen werden typischerweise mit
\Macro{addtocontents}\important{\Macro{addtocontents},
  \Macro{addxcontentsline}} oder \Macro{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 Dateiname der Klasse.

\begin{Declaration}
  \Macro{ifattoclist}\Parameter{Dateierweiterung}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}
\end{Declaration}
\BeginIndex{Cmd}{ifattoclist}%
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.
\begin{Example}
  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}
  \ifattoclist{foo}{%
    \PackageError{bar}{%
      extension `foo' already in use%
    }{%
      Each extension may be used only
      once.\MessageBreak
      The class or another package already
      uses extension `foo'.\MessageBreak
      This error is fatal!\MessageBreak
      You should not continue!}%
  }{%
    \PackageInfo{bar}{using extension `foo'}%
  }
\end{lstcode}
\end{Example}
\EndIndex{Cmd}{ifattoclist}%


\begin{Declaration}
  \Macro{addtotoclist}\OParameter{Besitzer}\Parameter{Dateierweiterung}
\end{Declaration}
\BeginIndex{Cmd}{addtotoclist}%
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
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
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}« 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
  Erweiterung nicht bereits in der Liste ist. Wenn die verwendete
  Klasse oder ein anderes Paket diese Dateierweiterung schon angemeldet hat,
  erhalten Sie den Fehler:
\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}
  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.
  This may be either an incompatibility of packages, an error at a package,
  or a mistake by the user.
\end{lstoutput}

  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}
  \newcommand*{\createnewlistofsomething}[1]{%
    \addtotoclist[bar.sty]{#1}%
    % Weitere Aktionen, um dieses Verzeichnis 
    % 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
  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
eindeutig sein! Wenn Sie beispielsweise der Autor des Pakets \Package{float}
wären, könnten Sie als \PName{Besitzer} auch »\PValue{float}« an Stelle von
»\PValue{float.sty}« angeben. In diesem Fall würden die \KOMAScript-Optionen
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 »\PName{float}« anmeldet und die Optionen
für diese Besitzer setzt.%
%
\EndIndex{Cmd}{addtotoclist}%


\begin{Declaration}
  \Macro{AtAddToTocList}\OParameter{Besitzer}\Parameter{Anweisungen}
\end{Declaration}
\BeginIndex{Cmd}{AtAddToTocList}%
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 Arguments 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}
  \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. 
\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}%


\begin{Declaration}
  \Macro{removefromtoclist}\OParameter{Besitzer}\Parameter{Dateierweiterung}
\end{Declaration}
\BeginIndex{Cmd}{removefromtoclist}%
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
angegebenen \PName{Besitzer} angemeldet wurde. Wie der Besitzer beim Weglassen
des optionalen Argument bestimmt wird, ist der Erklärung zu
\Macro{addtotoclist} zu entnehmen. Wird ein leerer \PName{Besitzer} angegeben,
findet kein Besitzertest statt, sondern die \PName{Dateierweiterung} wird
unabhängig vom Besitzer entfernt.%
\EndIndex{Cmd}{removefromtoclist}%


\begin{Declaration}
  \Macro{doforeachtocfile}\OParameter{Besitzer}\Parameter{Anweisungen}
\end{Declaration}
\BeginIndex{Cmd}{doforeachtocfile}%
Bisher haben Sie nur Anweisungen kennen gelernt, 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
\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}
  \doforeachtocfile{\typeout{\@currext}}
\end{lstcode}
  möglich. Wollen Sie hingegen nur die Dateierweiterungen des Besitzer
  »\PValue{foo}«, dann geht das einfach mit:
\begin{lstcode}
  \doforeachtocfile[foo]{\typeout{\@currext}}
\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
\PValue{chapteratlist} gesetzt ist, optional einen vertikalen Abstand oder die
Kapitelüberschrift in dieses Verzeichnis einzutragen. Wie Sie diese
Eigenschaft setzen können, ist in \autoref{sec:tocbasic.toc},
\autopageref{desc:tocbasic.cmd.setuptoc} zu finden.%
\EndIndex{Cmd}{doforeachtocfile}


\begin{Declaration}
  \Macro{tocbasicautomode}
\end{Declaration}
\BeginIndex{Cmd}{tocbasicautomode}%
Diese Anweisung definiert die Anweisung \Macro{@starttoc}, die der \LaTeX-Kern
bereit stellt, 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
\Macro{tocbasic@starttoc} an Stelle von \Macro{@starttoc} verwendet. Näheres
zu \Macro{tocbasic@starttoc} und \Macro{@starttoc} ist
\autoref{sec:tocbasic.internals},
\autopageref{desc:tocbasic.cmd.tocbasic@starttoc} zu entnehmen.

Mit Hilfe von \Macro{tocbasicautomode} wird also sozusagen jedes Verzeichnis,
das mit Hilfe von \Macro{@starttoc} erstellt wird, automatisch zumindest
teilweise unter die Kontrolle von \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 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 beschrieben werden.%
\EndIndex{Cmd}{tocbasicautomode}


\section{Erzeugen eines Verzeichnisses}
\seclabel{toc}

Im vorherigen Abschnitt haben Sie erfahren, wie eine Liste bekannter
Dateierweiterungen geführt werden kann und wie automatisch Anweisungen beim
Hinzufügen von Dateierweiterungen zu dieser Liste ausgeführt werden
können. Des Weiteren haben Sie eine Anweisung kennen gelernt, mit der man für
jede einzelne bekannte Dateierweiterung oder einen spezifischen Teil davon
Anweisungen ausführen kann. In diesem Abschnitt werden Sie Anweisungen kennen
lernen, die sich auf die Datei beziehen, die mit dieser Dateierweiterung
verbunden ist.


\begin{Declaration}
  \Macro{addtoeachtocfile}\OParameter{Besitzer}\Parameter{Inhalt}
\end{Declaration}
\BeginIndex{Cmd}{addtoeachtocfile}%
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}
  \addtoeachtocfile{%
    \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:
\begin{lstcode}
  \addtoeachtocfile[foo]{%
    \protect\addvspace{\protect\baselineskip}%
  }
\end{lstcode}
\end{Example}
Anweisungen, die nicht bereits beim Schreiben expandiert werden sollen, sind
wie bei \Macro{addtocontents} mit \Macro{protect} zu schützen.
\EndIndex{Cmd}{addtoeachtocfile}%


\begin{Declaration}
  \Macro{addxcontentsline}\Parameter{Dateierweiterung}\Parameter{Ebene}\\
  \hphantom{\XMacro{addxcontentsline}}%
                          \OParameter{Gliederungsnummer}\Parameter{Inhalt}
\end{Declaration}
\BeginIndex{Cmd}{addxcontentsline}%
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
\Macro{addcontentsline} im Argument \PName{Inhalt} mit angegeben wird. 

Die Anweisung wird verwendet, um nummerierte oder nicht nummerierte Einträge
in das über die \PName{Dateierweiterung} spezifierte 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
\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
\Macro{addparttocentry} (siehe \autoref{sec:maincls-experts.experts},
\autopageref{desc:maincls-experts.cmd.addparttocentry}). Ist die entsprechend
Anweisung nicht definiert, wird stattdessen die interne Anweisung
\Macro{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
\Macro{tocbasic@addxcontentsline} ist \autoref{sec:tocbasic.internals},
\autopageref{desc:tocbasic.cmd.tocbasic@addxcontentsline} zu entnehmen.

Ein Vorteil der Verwendung von \Macro{addxcontentsline} gegenüber
\Macro{addcontentsline} ist zum einen, dass die Eigenschaft
\PValue{numberline} (siehe \autopageref{desc:tocbasic.cmd.setuptoc}) beachtet
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.%
%
\EndIndex{Cmd}{addxcontentsline}%


\begin{Declaration}
  \Macro{addxcontentslinetoeachtocfile}%
  \OParameter{Besitzer}\Parameter{Ebene0}\\
  \hphantom{\XMacro{addxcontentslinetoeachtocfile}}%
  \OParameter{Gliederungsnummer}%
  \Parameter{Inhalt}\\
  \Macro{addcontentslinetoeachtocfile}%
  \OParameter{Besitzer}\Parameter{Ebene}\Parameter{Inhalt}%
\end{Declaration}
\BeginIndex{Cmd}{addcontentslinetoeachtocfile}%
Diese beiden Anweisungen stehen in direkter Beziehung zu dem oben erklärten
\Macro{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
eine einzelne Datei, sondern in alle Dateien eines angegebenen
\PName{Besitzers} und bei Verzicht auf das erste 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}
  \addxcontentslinetoeachtocfile{chapter}%
                                [\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.%

Die Anweisung\ChangedAt{v3.12}{\Package{tocbasic}}
\Macro{addxcontentslinetoeachtocfile} ist wann immer möglich gegenüber
\Macro{addcontentslinetoeachtocfile} vorzuziehen, da die Erweiterungen von
\Macro{addxcontentsline} nur damit Anwendung finden. Näheres zu diesen
Erweiterungen und Vorteilen ist in der vorausgehenden Erklärung von
\Macro{addxcontentsline} zu finden.%
%
\EndIndex{Cmd}{addcontentslinetoeachtocfile}%


\begin{Declaration}
  \Macro{listoftoc}\OParameter{Titel}\Parameter{Dateierweiterung}\\
  \Macro{listoftoc*}\Parameter{Dateierweiterung}\\
  \Macro{listofeachtoc}\OParameter{Besitzer}\\
  \Macro{listof\PName{Dateierweiterung}name}
\end{Declaration}
\BeginIndex{Cmd}{listoftoc}%
\BeginIndex{Cmd}{listoftoc*}%
\BeginIndex{Cmd}{listofeachtoc}%
\BeginIndex{Cmd}{listof\PName{Dateierweiterung}name}%
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 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
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
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}
  \listoftoc[Verzeichnis der Algorithmen]{loa}
\end{lstcode}
  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
  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 Laden des in \autoref{cha:scrwfile} beschriebenen Pakets
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile} bieten.
%
\EndIndex{Cmd}{listof\PName{Dateierweiterung}name}%
\EndIndex{Cmd}{listofeachtoc}%
\EndIndex{Cmd}{listoftoc*}%
\EndIndex{Cmd}{listoftoc}%


\begin{Declaration}
  \Macro{BeforeStartingTOC}\OParameter{Dateierweiterung}\Parameter{Anweisungen}\\
  \Macro{AfterStartingTOC}\OParameter{Dateierweiterung}\Parameter{Anweisungen}
\end{Declaration}
\BeginIndex{Cmd}{BeforeStartingTOC}%
\BeginIndex{Cmd}{AfterStartingTOC}%
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 genau solche \PName{Anweisungen}
wahlweise für eine einzelne \PName{Dateierweiterung} oder alle Dateien, die
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}\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}%


\begin{Declaration}
  \Macro{BeforeTOCHead}\OParameter{Dateierweiterung}\Parameter{Anweisungen}\\
  \Macro{AfterTOCHead}\OParameter{Dateierweiterung}\Parameter{Anweisungen}
\end{Declaration}
\BeginIndex{Cmd}{BeforeTOCHead}%
\BeginIndex{Cmd}{AfterTOCHead}%
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}\IndexCmd{@currext}\important{\Macro{@currext}} gilt, was
bereits bei \Macro{BeforeStartingTOC} und \Macro{AfterStartingTOC} oben
erklärt wurde.%
\EndIndex{Cmd}{AfterTOCHead}%
\EndIndex{Cmd}{BeforeTOCHead}%


\begin{Declaration}
  \Macro{MakeMarkcase}
\end{Declaration}
\BeginIndex{Cmd}{MakeMarkcase}%
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
\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
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}
  \let\MakeMarkcase\MakeLowercase
\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}%


\begin{Declaration}
  \Macro{deftocheading}\Parameter{Dateierweiterung}\Parameter{Definition}
\end{Declaration}
\BeginIndex{Cmd}{deftocheading}%
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 \Macro{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 \PName{\#1} enthalten. Beim Aufruf der Anweisung innerhalb von
\Macro{listoftoc} oder \Macro{listofeachtoc} wird als dieses Argument dann der
Titel für das Verzeichnis übergeben.
%
\EndIndex{Cmd}{deftocheading}%


\begin{Declaration}
  \Macro{setuptoc}\Parameter{Dateierweiterung}\Parameter{Liste von
    Eigenschaften}\\
  \Macro{unsettoc}\Parameter{Dateierweiterung}\Parameter{Liste von
    Eigenschaften}
\end{Declaration}
\BeginIndex{Cmd}{setuptoc}%
\BeginIndex{Cmd}{unsettoc}%
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 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{numberline}] \ChangedAt{v3.12}{\Package{tocbasic}}%
  bedeutet, dass auch all diejenigen Einträge, die mit Hilfe der Anweisung
  \Macro{addxcontentsline} oder der Anweisung
  \Macro{addxcontentslinetoceachtocfile} in das Verzeichnis geschrieben werden
  und bei denen das optionale Argument für die Nummer fehlt oder leer ist, mit
  einer (leeren) \Macro{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. Die \KOMAScript-Klassen setzen diese Eigenschaft bei Verwendung der
  Option \OptionValue{listof}{numberline}%
  \important{\OptionValue{listof}{numberline}}%
  \IndexOption{listof~=\PValue{numberline}} für die Dateierweiterungen des
  Besitzers \PValue{float} und bei Verwendung der Option
  \OptionValue{toc}{numberline}\important{\OptionValue{toc}{numberline}}%
  \IndexOption{toc~=\PValue{numberline}} für die Dateierweiterung
  \PValue{toc}. Entsprechend wird die Eigenschaft bei Verwendung von Option
  \OptionValue{listof}{nonumberline}%
  \important{\OptionValue{listof}{nonumberline}}%
  \IndexOption{listof~=\PValue{nonumberline}} oder
  \OptionValue{toc}{nonumberline}%
  \important{\OptionValue{toc}{nonumberline}}%
  \IndexOption{toc~=\PValue{nonumberline}} wieder zurückgesetzt.
\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 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.
\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
  Regel dazu, dass bei Dokumenten mit Absatzabstand der Abstand zwischen
  Überschrift und ersten Verzeichniseintrag 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
  \Package{microtype}\IndexPackage{microtype} oder ein anderes Paket, das die
  Anweisung \Macro{microtypesetup}\IndexCmd{microtypesetup} bereit stellt,
  geladen ist. Wenn also optischer Randausgleich in den Verzeichnissen
  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.
\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}\important{\OptionValue{listof}{numbered}}%
  \IndexOption{listof~=\PValue{numbered}} für
  alle Dateierweiterungen des Besitzers \Package{float}.
%% 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. 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
  Tabellenverzeichnis bei diesen beiden Klassen automatisch einspaltig
  gesetzt. Der Mehrspaltenmodus des
  \Package{multicol}-Pakets\IndexPackage{multicol} ist von der Eigenschaft
  ausdrücklich nicht betroffen.
%% 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\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}\IndexOption{listof}\important{\Option{listof}} in
  \autoref{sec:maincls.floats}, \autopageref{desc:maincls.option.listof} zu
  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
  Kapiteluntergliederung dieser Verzeichnisse zu verhindern:
\begin{lstcode}
  \unsettoc{lof}{chapteratlist}
  \unsettoc{lot}{chapteratlist}
\end{lstcode}

  Wollen Sie hingegen, dass das von Ihnen definierte Verzeichnis mit der
  Dateierweiterung »\PValue{loa}« ebenfalls von der Kapiteluntergliederung der
  \KOMAScript-Klassen betroffen ist, so verwenden Sie
\begin{lstcode}
  \setuptoc{loa}{chapteratlist}
\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 zusätzlich
\begin{lstcode}
  \ifundefinedorrelax{chapter}{}{%
    \setuptoc{loa}{onecolumn}%
  }
\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\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
realisierten Verzeichnisse, die sonst einigen Implementierungsaufwand
bedeuteten und deshalb in vielen Paketen leider fehlen.%
\EndIndex{Cmd}{unsettoc}%
\EndIndex{Cmd}{setuptoc}%


\begin{Declaration}
  \Macro{iftocfeature}\Parameter{Dateierweiterung}\Parameter{Eigenschaft}\Parameter{Dann-Teil}\\
  \hphantom{\Macro{iftocfeature}}\Parameter{Sonst-Teil}
\end{Declaration}
\BeginIndex{Cmd}{iftocfeature}%
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
beschriebenen Eigenschaften \PValue{totoc}, \PValue{numbered} oder
\PValue{leveldown} unterstützen wollen.
%
\EndIndex{Cmd}{iftocfeature}%


\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
werden, so dass Umdefinierung der Anweisungen die Funktion von
\Package{tocbasic} erheblich beschädigen könnte!


\begin{Declaration}
  \Macro{tocbasic@extend@babel}\Parameter{Dateierweiterung}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@extend@babel}%
Das Paket \Package{babel}\IndexPackage{babel} (siehe \cite{package:babel})
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,
dass mit Hilfe von \Macro{tocbasic@extend@babel} auch andere
\PName{Dateierweiterungen} davon profitieren. Das Argument
\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.

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.

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 diese ist die Anweisung explizit
aufzurufen. Bitte achten Sie jedoch darauf, dass dies für jede Dateierweiterung
nur einmal geschieht!
%
\EndIndex{Cmd}{tocbasic@extend@babel}%


\begin{Declaration}
  \Macro{tocbasic@starttoc}\Parameter{Dateierweiterung}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@starttoc}%
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}\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 wird
\Macro{@currext}\important{\Macro{@currext}}\IndexCmd{@currext} auf die
aktuelle Dateierweiterung gesetzt, damit diese in den nachfolgend ausgeführten
Haken ausgewertet werden kann.

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 Laden des in \autoref{cha:scrwfile} beschriebenen Pakets
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}
bieten.
%
\EndIndex{Cmd}{tocbasic@starttoc}%


\begin{Declaration}
  \Macro{tocbasic@@before@hook}\\
  \Macro{tocbasic@@after@hook}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@@before@hook}%
\BeginIndex{Cmd}{tocbasic@@after@hook}%
Der Haken \Macro{tocbasic@@before@hook} wird unmittelbar vor dem Einlesen der
Verzeichnisdatei, noch vor den mit \Macro{BeforeStartingTOC} definierten
Anweisungen 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 \Macro{AfterStartingTOC} definierten Anweisungen
ausgeführt. Es ist erlaubt, diesen Haken mit Hilfe von \Macro{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 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}%


\begin{Declaration}
  \Macro{tb@\PName{Dateierweiterung}@before@hook}\\
  \Macro{tb@\PName{Dateierweiterung}@after@hook}
\end{Declaration}
\BeginIndex{Cmd}{tb@\PName{Dateierweiterung}@before@hook}%
\BeginIndex{Cmd}{tb@\PName{Dateierweiterung}@after@hook}%
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, sollten die
beiden Anweisungen für die Haken trotzdem aufgerufen werden, soweit sie
definiert sind. Die Anweisungen können auch undefiniert sein. Für einen
entsprechenden Test siehe
\Macro{scr@ifundefinedorrelax}\IndexCmd{scr@ifundefinedorrelax} in
\autoref{sec:scrbase.if},
\autopageref{desc:scrbase.cmd.scr@ifundefinedorrelax}.
%
\EndIndex{Cmd}{tb@\PName{Dateierweiterung}@after@hook}%
\EndIndex{Cmd}{tb@\PName{Dateierweiterung}@before@hook}%


\begin{Declaration}
  \Macro{tocbasic@listhead}\Parameter{Titel}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@listhead}%
Diese Anweisung wird von \Macro{listoftoc} und \Macro{listofeachtoc}
verwendet, um die Anweisung zum Setzen 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 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.
%
\EndIndex{Cmd}{tocbasic@listhead}


\begin{Declaration}
  \Macro{tocbasic@listhead@\PName{Dateierweiterung}}\Parameter{Titel}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@listhead@\PName{Dateierweiterung}}%
Ist diese individuelle Anweisung für das Setzen einer Verzeichnisüberschrift
definiert, so verwendet \Macro{tocbasic@listhead} diese. Anderenfalls
definiert \Macro{tocbasic@listhead} diese und ruft sie dann auf.
%
\EndIndex{Cmd}{tocbasic@listhead@\PName{Dateierweiterung}}

\begin{Declaration}
  \Macro{tocbasic@addxcontentsline}%
  \Parameter{Dateierweiterung}\Parameter{Ebene}\\
  \hphantom{\XMacro{tocbasic@addxcontentsline}}%
  \Parameter{Gliederungsnummer}\Parameter{Eintrag}\\
  \Macro{nonumberline}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@addxcontentsline}%
\BeginIndex{Cmd}{nonumberline}%
Anweisung\ChangedAt{v3.12}{\Package{tocbasic}}
\Macro{tocbasic@addxcontentsline} nimmt einen \PName{Eintrag} der angegebenen
\PName{Ebene} in das über die \PName{Dateierweiterung} spezifizierte
Verzeichnis vor. Ob der Eintrag nummeriert wird oder nicht, 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 \Macro{numberline} mit
\PName{Gliederungsnummer} als Argument verwendet.

Die Anweisung \PName{nonumberline} wird innerhalb \Macro{listoftoc} (siehe
\autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.listoftoc})
entsprechend der Eigenschaft \PValue{numberline} (siehe
\autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.setuptoc})
umdefiniert. Dadurch wirkt sich das Setzen oder Löschen dieser Eigenschaft
bereits beim nächsten \LaTeX-Lauf aus.%
%
\EndIndex{Cmd}{nonumberline}%
\EndIndex{Cmd}{tocbasic@addxcontentsline}%


\section{Ein komplettes Beispiel}
\seclabel{example}

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\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 plus 1pt]
  \newenvironment{remarkbox}{%
    \@float{remarkbox}%
  }{%
    \end@float
  }
\end{lstcode}
Die neue Umgebung heißt also \Environment{remarkbox}. 

Jede\textnote{Platzierung} Gleitumgebung hat eine Standardplatzierung. Diese
setzt sich aus den bekannten Platzierungsoptionen zusammen:
% Umbruchkorrektur: listings korrigiert!
\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\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 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\textnote{Nummer} haben außerdem eine Nummer.
% Umbruchkorrektur: listings korrigiert!
\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
  \newcounter{remarkbox}
  \newcommand*{\remarkboxformat}{%
    Merksatz~\theremarkbox\csname autodot\endcsname}
  \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
\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
\Macro{caption} definiert.

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 plus 1pt]
  \newcommand*{\ext@remarkbox}{lor}
\end{lstcode}
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
mit
% Umbruchkorrektur: listings korrigiert!
\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 plus 1pt]
  \RequirePackage{tocbasic}
\end{lstcode}
verwenden.

Nun\textnote{Dateierweiterung} machen wir die neue Dateierweiterung dem Paket
\Package{tocbasic} bekannt.
% Umbruchkorrektur: listings korrigiert!
\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\textnote{Verzeichnistitel} definieren wir noch einen Titel für dieses
Verzeichnis:
% Umbruchkorrektur: listings korrigiert!
\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 alle weiteren Sprachen, die man unterstützen
will. Siehe dazu \autoref{sec:scrbase.languageSupport}, ab
\autopageref{sec:scrbase.languageSupport}.

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 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 plus 1pt]
  \newcommand*{\l@remarkbox}{\@dottedtocline{1}{1em}{1.5em}}
\end{lstcode}
verwenden können.

Außerdem\textnote{Kapiteleintrag} wollen Sie, das Kapiteleinträge sich auf das
Verzeichnis auswirken.
% Umbruchkorrektur: listings korrigiert!
\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\textnote{Verzeichnis} genügt schon. 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 plus 1pt]
  \newcommand*{\listofremarkboxes}{\listoftoc{lor}}
\end{lstcode}
kann man die Anwendung noch etwas vereinfachen.

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
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
Verzeichnis sogar beim Wechsel zu einem neuen Kapitel. Sprachumschaltungen
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 plus 1pt]
  \newcommand*{\setupremarkboxes}{\setuptoc{lor}}
\end{lstcode}
um eine als Argument an \Macro{setupremarkboxes} übergebene Liste von
Eigenschaften direkt als Liste von Eigenschaften für \File{lor} zu setzen.


\section{Alles mit einer Anweisung}
\seclabel{declarenewtoc}

Das Beispiel aus dem vorherigen Abschnitt hat gezeigt, dass es mit mit
\Package{tocbasic} recht einfach ist, eigene Gleitumgebungen mit eigenen
Verzeichnissen zu definieren. In diesem Beispiel wird gezeigt, dass es sogar
noch einfacher gehen kann.

\begin{Declaration}
  \Macro{DeclareNewTOC}\OParameter{Optionenliste}\Parameter{Dateierweiterung}%
\end{Declaration}%
\BeginIndex{Cmd}{DeclareNewTOC}%
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}\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}, ab
\autopageref{desc:maincls.cmd.captionabove}) 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 wurde. Dieser Parameter
muss angegeben werden und darf nicht leer sein!

\PName{Optionenliste} ist eine durch Komma getrennte Liste, wie dies auch von
\Macro{KOMAoptions} (siehe \autoref{sec:typearea.options},
\autopageref{desc:typearea.cmd.KOMAoptions}) 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} ab
\autopageref{tab:tocbasic.DeclareNewTOC-options}.
%
\begin{Example}
  Das Beispiel aus \autoref{sec:tocbasic.example} kann mit Hilfe der neuen
  Anweisung deutlich verkürzt werden:
\begin{lstcode}
  \DeclareNewTOC[%
    type=remarkbox,%
    types=remarkboxes,%
    float,% Gleitumgebungen sollen definiert werden.
    floattype=4,%
    name=Merksatz,%
    listname={Verzeichnis der Merks\"atze}%
  ]{lor}
  \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
  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 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.

  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.%
  \begin{table}
    \centering
    \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}
      \toprule
      \begin{tabular}[t]{@{}l@{}}
        Umgebung\\
        \Environment{remarkbox}
      \end{tabular}
      & \begin{tabular}[t]{@{}l@{}}
          Umgebung\\
          \Environment{figure}
        \end{tabular}
      & Optionen von \Macro{DeclareNewTOC} & Kurzbeschreibung \\[1ex]
      \midrule
      \Environment{remarkbox} & \Environment{figure} 
      & \Option{type}, \Option{float} 
      & Gleitumgebung des jeweiligen Typs.\\[1ex]
      \Environment{remarkbox*} & \Environment{figure*} 
      & \Option{type}, \Option{float} 
      & spaltenübergreifende Gleitumgebung des jeweiligen Typs \\[1ex]
      \Counter{remarkbox} & \Counter{figure} 
      & \Option{type}, \Option{float} 
      & Zähler, der von \Macro{caption} verwendet wird \\[1ex]
      \Macro{theremarkbox} & \Macro{thefigure} 
      & \Option{type}, \Option{float} 
      & Anweisung zur Ausgabe des jeweiligen Zählers \\[1ex]
      \Macro{remarkboxformat} & \Macro{figureformat}
      & \Option{type}, \Option{float}
      & Anweisung zur Formatierung des jeweiligen Zählers in der Ausgabe von
        \Macro{caption}\\[1ex]
      \Macro{remarkboxname} & \Macro{figurename}
      & \Option{type}, \Option{float}, \Option{name}
      & Name, der im Label von \Macro{caption} verwendet wird \\[1ex]
      \Macro{listofremarkboxes} & \Macro{listoffigures}
      & \Option{types}, \Option{float}
      & Anweisung zur Ausgabe des jeweiligen Verzeichnisses \\[1ex]
      \Macro{listremarkboxname} & \Macro{listfigurename}
      & \Option{type}, \Option{float}, \Option{listname}
      & Ü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 \\
      \bottomrule
    \end{tabularx}
  \end{table}

  Und hier nun eine mögliche Verwendung der Umgebung:
\begin{lstcode}
  \begin{remarkbox}
    \centering
    Gleiches sollte immer auf gleiche Weise und
    mit gleichem Aussehen gesetzt werden.
    \caption{Erster Hauptsatz der Typografie}
    \label{rem:typo1}
  \end{remarkbox}
\end{lstcode}
  Ein Ausschitt aus einer Beispielseite mit dieser Umgebung könnte dann so
  aussehen:
  \begin{center}\footnotesize
    \begin{tabular}
      {|!{\hspace{.1\linewidth}}p{.55\linewidth}!{\hspace{.1\linewidth}}|}
      \\
      \centering
      Gleiches sollte immer auf gleiche Weise und
      mit gleichem Aussehen gesetzt werden.\\[\abovecaptionskip]
      {%
        \usekomafont{caption}\footnotesize
        \begin{tabularx}{\hsize}[t]{@{}l@{ }X@{}}
          \usekomafont{captionlabel}{Merksatz 1:} &
          Erster Hauptsatz der Typografie \\
        \end{tabularx}
      }\\
    \end{tabular}%
  \end{center}%
\end{Example}%
% Umbruchoptimierung: Tabelle verschoben.
\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
    \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
    werden.}%
  \entry{\Option{float}}{%
    Es wird nicht nur ein neuer Verzeichnistyp definiert, sondern auch
    Gleitumgebungen \Environment{\PName{Eintragstyp}} (siehe Option
    \Option{type}) und \Environment{\PName{Eintragstyp}*}
    (vgl. \Environment{figure} und \Environment{figure*}).}%
  \entry{\KOption{floatpos}\PName{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
    Gleitumgebung (siehe Option \Option{float}) festgelegt. Die Syntax und
    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{\KOption{floattype}\PName{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.}%
  \entry{\Option{forcenames}}{%
    Siehe Option \Option{name} und \Option{listname}.}%
  \entry{\KOption{hang}\PName{Einzug}}{%
    Mehrzeilige Verzeichniseinträge in hierarchisch angeordneten
    Verzeichnissen besitzen ab der zweiten Zeile einen Einzug von
    links. Dieser Einzug wird auch für die Position des Textes in der ersten
    Zeile eines nummerierten Eintrags verwendet. Der Wert des Einzugs kann
    über diese Option bestimmt werden. Ohne diese Option wird als
    \PName{Einzug} 1,5\Unit{em} verwendet.}%
  \entry{\KOption{indent}\PName{Einzug}}{%
    In der hierarchischen Form besitzt jeder Verzeichniseintrag einen Einzug
    von links. Der Wert des Einzugs kann über diese Option bestimmt
    werden. Ohne diese Option wird als \PName{Einzug} 1\Unit{em} verwendet.}%
  \entry{\KOption{level}\PName{Gliederungsebene}}{%
    Jeder Eintrag in ein Verzeichnis hat eine nummerische
    \PName{Gliederungsebene}, die über diese Option gesetzt werden kann. Ist
    diese Option nicht angegeben, so wird der Standardwert 1 verwendet.}%
  \entry{\KOption{listname}\PName{Verzeichnistitel}}{%
    Jedes Verzeichnis hat eine Überschrift, die durch diese Option bestimmt
    werden kann. Ist die Option nicht angegeben, so wir als Verzeichnistitel
    »\texttt{List of \PName{Mehrzahl des Eintragstyps}}« (siehe Option
    \PName{types}) verwendet, wobei das erste Zeichen der \PName{Mehrzahl des
      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
    \Option{forcenames} gesetzt ist.}%
  \entry{\KOption{name}\PName{Eintragsname}}{%
    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
    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
    \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}
    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
    kann, jedoch nicht gleitet und auch nicht die Grenzen der aktuell gültigen
    Umgebung durchbricht.}%
  \entry{\KOption{owner}\PName{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
    Tabellenverzeichnis verwenden.}%
  \entry{\KOption{type}\PName{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} die \PName{Dateierweiterung} aus dem obligatorischen
    Argument verwendet.}%
  \entry{\KOption{types}\PName{Mehrzahl des Eintragstyps}}{%
    An verschiedenen Stellen wird auch die Mehrzahlform des Eintragstyps
    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} einfach
    »\PName{Eintragstyp}s« verwendet.}%
\end{desclist}
%
\EndIndex{Cmd}{DeclareNewTOC}%
%
\EndIndex{}{Verzeichnis}%
\EndIndex{}{Dateierweiterung}%
\EndIndex{Package}{tocbasic}%

\endinput

%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
%%% coding: iso-latin-1
%%% ispell-local-dictionary: "de_DE"
%%% TeX-master: "../guide"
%%% End:

%  LocalWords:  Verzeichnisdatei Klonquelle Absatzabstandes Absatzabstand
