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.tex422
1 files changed, 227 insertions, 195 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 d470aae319b..f13d44e885f 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-2013
+% Copyright (c) Markus Kohm, 2002-2014
%
% 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-2013
+% Copyright (c) Markus Kohm, 2002-2014
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{tocbasic.tex}[2013/10/02 KOMA-Script package tocbasic]
+\KOMAProvidesFile{tocbasic.tex}
+ [$Date: 2014-01-30 13:11:54 +0100 (Thu, 30 Jan 2014) $
+ KOMA-Script guide (package tocbasic)]
\chapter{Verzeichnisse verwalten mit Hilfe von \Package{tocbasic}}
\labelbase{tocbasic}
@@ -67,10 +69,10 @@ 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 ist nach den
-grundlegenden Anweisungen in \autoref{sec:tocbasic.toc}, verdeutlicht durch
-ein Beispiel in \autoref{sec:tocbasic.example} und kompakt in
-\autoref{sec:tocbasic.declarenewtoc} zu finden.
+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.
@@ -85,13 +87,13 @@ 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 eine Aktion für all diese
+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, selbst gewählt hat. \KOMAScript{} selbst
+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{}
@@ -102,7 +104,7 @@ als Besitzer den Dateiname der Klasse.
\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
+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.
@@ -133,19 +135,19 @@ ausgeführt.
\Macro{addtotoclist}\OParameter{Besitzer}\Parameter{Dateierweiterung}
\end{Declaration}
\BeginIndex{Cmd}{addtotoclist}%
-Diese Anweisung fügt die \PName{Dateierweiterung} zu der Liste der bekannten
-Dateierweiterungen. Ist die \PName{Dateierweiterung} bereits bekannt, so wird
-hingegen ein Fehler gemeldet, um die doppelte Verwendung derselben
-\PName{Dateierweiterung} zu verhindern.
+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 weg gelassen, dann versucht \Package{tocbasic} den
+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{addtoclist} erst später
-Aufgrund der Verwendung einer Anweisung durch den Benutzer aufgerufen wird. In
+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}
@@ -153,16 +155,16 @@ 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
+ 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}« 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,
+ »\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
@@ -204,11 +206,12 @@ 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 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.%
+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}%
@@ -220,7 +223,7 @@ 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
+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
@@ -366,13 +369,14 @@ Dateierweiterung der Datei, in die aktuell geschrieben wird.
}
\end{lstcode}
\end{Example}
-Anweisungen, die nicht bereits beim Schreiben expandiert werden sollen, sollte
-wie bei \Macro{addtocontents} mit \Macro{protect} geschützt werden.
+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}%
+ \Macro{addxcontentsline}\Parameter{Dateierweiterung}\Parameter{Ebene}\\
+ \hphantom{\XMacro{addxcontentsline}}%
\OParameter{Gliederungsnummer}\Parameter{Inhalt}
\end{Declaration}
\BeginIndex{Cmd}{addxcontentsline}%
@@ -381,23 +385,24 @@ 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
+\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.
-Die Anweisung selbst testet zunächst, ob eine Anweisung
-\Macro{add\PName{Ebene}\PName{Dateierweiterung}entry} definiert ist. Wenn dies
-der Fall ist, wird diese für den Eintrag verwendet, wobei
-\PName{Gliederungsnummer} als optionales Argument in \PName{Inhalt} als
+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
+\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 Argument
+\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},
@@ -415,15 +420,17 @@ spezifischer Anweisungen konfiguriert werden.%
\begin{Declaration}
\Macro{addxcontentslinetoeachtocfile}%
- \OParameter{Besitzer}\Parameter{Ebene}\OParameter{Gliederungsnummer}%
+ \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 Anweisungen sind mit der oben erklärten Anweisung
+Diese beiden Anweisungen stehen in direkter Beziehung zu dem oben erklärten
\Macro{addxcontentsline}\ChangedAt{v3.12}{\Package{tocbasic}}
-beziehungsweise \Macro{addcontentsline} aus dem \LaTeX-Kern vergleichbar. Der
+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
@@ -434,23 +441,24 @@ Dateien aus der Liste der bekannten Dateierweiterungen schreibt.
wir weiter an, dass aktuell \PName{\#1} den Titel enthält, der geschrieben
werden soll.
\begin{lstcode}
- \addxcontentslinetoeachtocfile{chapter}[\thechapter]{#1}
+ \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}
+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.%
-Anweisung\ChangedAt{v3.12}{\Package{tocbasic}}
+Die Anweisung\ChangedAt{v3.12}{\Package{tocbasic}}
\Macro{addxcontentslinetoeachtocfile} ist wann immer möglich gegenüber
-\Macro{addcontentslinetoeachtocfile} der Vorrang zu gewähren, da die
-Erweiterungen von \Macro{addxcontentsline} nur damit Anwendung finden. Näheres
-zu diesen Erweiterungen und Vorteilen ist in der vorausgehenden Erklärung der
-Anweisung \Macro{addxcontentsline} zu finden.%
+\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}%
@@ -481,7 +489,7 @@ 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
+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
@@ -521,7 +529,7 @@ passend zu definieren.
Verzeichnis der Algorithmen%
}
\end{lstcode}
- definiert haben, genügt auch
+ definiert haben, genügt auch:
\begin{lstcode}
\listoftoc{loa}
\end{lstcode}
@@ -542,7 +550,7 @@ dieser Anweisungen zu einer Fehlermeldung der Art
\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
+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}%
@@ -584,7 +592,7 @@ ist in \autoref{sec:scrwfile.clonefilefeature} auf
\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
+\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
@@ -597,7 +605,7 @@ erklärt wurde.%
\Macro{MakeMarkcase}
\end{Declaration}
\BeginIndex{Cmd}{MakeMarkcase}%
-Wann immer \Package{tocbasic} eine Marke für einen Kolumnentitel setzt, dann
+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
@@ -606,7 +614,7 @@ ist dazu gedacht, bei Bedarf die Groß-/Kleinschreibung des Kolumnentitels zu
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
+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.
@@ -619,6 +627,7 @@ sondern verwendet wie vorgefunden.
\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
@@ -687,14 +696,15 @@ getrennte Aneinanderreihung von \PName{Eigenschaften}. Das Paket
\IndexOption{listof~=\PValue{leveldown}}
für alle Dateierweiterungen des Besitzers \PValue{float}.
\item[\PValue{numberline}] \ChangedAt{v3.12}{\Package{tocbasic}}%
- bedeutet, dass auch diejenigen Einträge, die mit \Macro{addxcontentsline}
- oder \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 verstehen 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}%
+ 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
@@ -713,7 +723,7 @@ getrennte Aneinanderreihung von \PName{Eigenschaften}. Das Paket
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 Paket
+ 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.
@@ -794,7 +804,7 @@ Die \KOMAScript-Klassen kennen eine weitere Eigenschaft:
%% 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
+ wird, so verwenden Sie zusätzlich
\begin{lstcode}
\ifundefinedorrelax{chapter}{}{%
\setuptoc{loa}{onecolumn}%
@@ -841,7 +851,7 @@ beschriebenen Eigenschaften \PValue{totoc}, \PValue{numbered} oder
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
+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!
@@ -896,14 +906,14 @@ 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{\Length{parskip}\\
+\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 können.
+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
@@ -914,7 +924,7 @@ Anweisung zu einer Fehlermeldung der Art
\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
+diesem Fall das Laden des in \autoref{cha:scrwfile} beschriebenen Pakets
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}
bieten.
%
@@ -932,12 +942,12 @@ 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} definieren Anweisungen
+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 die Verzeichnisse mit dynamischer
+\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}
@@ -965,9 +975,13 @@ Diese Anweisungen werden direkt nach \Macro{tocbasic@@before@hook} bzw. vor
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
+\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.
+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}%
@@ -1002,13 +1016,14 @@ definiert \Macro{tocbasic@listhead} diese und ruft sie dann auf.
\begin{Declaration}
\Macro{tocbasic@addxcontentsline}%
- \Parameter{Dateierweiterung}\Parameter{Ebene}%
+ \Parameter{Dateierweiterung}\Parameter{Ebene}\\
+ \hphantom{\XMacro{tocbasic@addxcontentsline}}%
\Parameter{Gliederungsnummer}\Parameter{Eintrag}\\
\Macro{nonumberline}
\end{Declaration}
\BeginIndex{Cmd}{tocbasic@addxcontentsline}%
\BeginIndex{Cmd}{nonumberline}%
-Die\ChangedAt{v3.12}{\Package{tocbasic}} Anweisung
+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
@@ -1054,7 +1069,7 @@ Gleitumgebung bereitstellt. Das geht ganz einfach mit:
Die neue Umgebung heißt also \Environment{remarkbox}.
Jede\textnote{Platzierung} Gleitumgebung hat eine Standardplatzierung. Diese
-setzt sich aus bekannten Platzierungsoptionen zusammen:
+setzt sich aus den bekannten Platzierungsoptionen zusammen:
% Umbruchkorrektur: listings korrigiert!
\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
\newcommand*{\fps@remarkbox}{tbp}
@@ -1129,7 +1144,9 @@ Verzeichnis:
\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.
+\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:
@@ -1156,7 +1173,7 @@ 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 bereits. Der Anwender kann nun bereits
+Das\textnote{Verzeichnis} genügt schon. Der Anwender kann nun bereits
wahlweise mit Hilfe der Optionen einer \KOMAScript-Klasse oder
\Macro{setuptoc} verschiedene Formen der Überschrift (ohne
Inhaltsverzeichniseintrag, mit Inhaltsverzeichniseintrag, mit Nummerierung)
@@ -1217,20 +1234,134 @@ 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.
+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 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, wie
-dies auch von \Macro{KOMAoptions} (siehe \autoref{sec:typearea.options})
-bekannt ist. Diese Optionen\textnote{Achtung!} können jedoch \emph{nicht} mit
+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}.
-\iffree{}{\vskip-\ht\strutbox\enlargethispage{\dp\strutbox}}% Umbruchoptimierung!
+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[{%
@@ -1257,7 +1388,7 @@ die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
(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 überladen werden kann. Mit
+ ü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
@@ -1338,108 +1469,6 @@ die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
so wird als \PName{Mehrzahl des Eintragstyps} einfach
»\PName{Eintragstyp}s« verwendet.}%
\end{desclist}
-
-\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 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.
-
- 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}{ll>{\raggedright}p{7em}X}
- \toprule
- \Environment{remarkbox} & \Environment{figure}
- & 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{listremarboxname} & \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{\usekomafont{captionlabel}%
- Merksatz 1: }Erster Hauptsatz der Typografie
- }\\
- \end{tabular}%
- \end{center}%
-\end{Example}%
%
\EndIndex{Cmd}{DeclareNewTOC}%
%
@@ -1451,7 +1480,10 @@ die möglichen Optionen bietet \autoref{tab:tocbasic.DeclareNewTOC-options}.
%%% Local Variables:
%%% mode: latex
+%%% mode: flyspell
%%% coding: iso-latin-1
-%%% TeX-master: "guide.tex"
+%%% ispell-local-dictionary: "de_DE"
+%%% TeX-master: "../guide"
%%% End:
+% LocalWords: Verzeichnisdatei