summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex843
1 files changed, 420 insertions, 423 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
index eb017eee545..224ca052f65 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
@@ -1,6 +1,6 @@
% ======================================================================
% tocbasic.tex
-% Copyright (c) Markus Kohm, 2002-2016
+% Copyright (c) Markus Kohm, 2002-2017
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% tocbasic.tex
-% Copyright (c) Markus Kohm, 2002-2016
+% Copyright (c) Markus Kohm, 2002-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,10 +46,10 @@
% ======================================================================
\KOMAProvidesFile{tocbasic.tex}
- [$Date: 2016-06-14 09:11:22 +0200 (Tue, 14 Jun 2016) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (package tocbasic)]
-% Date of translated German file: 2016/06/13
+% Date of the translated German file: 2017-01-02
\translator{Markus Kohm\and Arndt Schubert}
@@ -59,7 +59,7 @@
\Package{tocbasic}\protect\footnote{Translation of this chapter has been
made by the package author and needs editing!}}
\labelbase{tocbasic}
-
+\BeginIndexGroup%
\BeginIndex{Package}{tocbasic}%
\BeginIndex{}{table of contents}%
\BeginIndex{}{list>of contents}%
@@ -108,7 +108,6 @@ contents.
\Macro{ifattoclist}\Parameter{extension}\Parameter{true
part}\Parameter{false part}
\end{Declaration}
-\BeginIndex{Cmd}{ifattoclist}%
This command may be used to ask, whether or not a file name \PName{extension}
is already a known extension. If the \PName{extension} is already known the
\PName{true instructions} will be used, otherwise the \PName{false
@@ -132,12 +131,12 @@ is already a known extension. If the \PName{extension} is already known the
}
\end{lstcode}
\end{Example}
-\EndIndex{Cmd}{ifattoclist}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{addtotoclist}\OParameter{owner}\Parameter{extension}
\end{Declaration}
-\BeginIndex{Cmd}{addtotoclist}%
This command adds the \PName{extension} to the list of known extensions. But
if the \PName{extension} is a known one already, then an error will be
reported to avoid double usage of the same \PName{extension}.
@@ -206,19 +205,19 @@ registers file name extension ``\PValue{lof}'' for the list of figures and
file name extension ``\PValue{lot}'' for the list of tables with owner
``\PValue{float}'' and sets options for this owner. Package \Package{scrhack}
redefines some of package \Package{float}'s commands to do this.%
-\EndIndex{Cmd}{addtotoclist}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{AtAddToTocList}\OParameter{owner}\Parameter{instructions}
\end{Declaration}
-\BeginIndex{Cmd}{AtAddToTocList}%
This command adds the \PName{instructions} to an internal list of instructions
that will be processed whenever a file name extension with the given
\PName{owner} will be added to the list of known extensions using
-\Macro{addtotoclist}. The optional argument is handled in the same way as
-with the command \Macro{addtotoclist}. With an empty \PName{owner} you may
+\DescRef{\LabelBase.cmd.addtotoclist}. The optional argument is handled in the same way as
+with the command \DescRef{\LabelBase.cmd.addtotoclist}. With an empty \PName{owner} you may
add \Parameter{instructions}, that will be processed at every successful
-\Macro{addtotoclist}, after processing the instructions for the individual
+\DescRef{\LabelBase.cmd.addtotoclist}, after processing the instructions for the individual
owner. While processing the \PValue{instructions},
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} will be set to
the extension of the currently added extension.
@@ -235,27 +234,27 @@ the extension of the currently added extension.
\end{Example}
The two \Macro{expandafter} commands are needed, because the argument of
-\Macro{tocbasic@extend@babel} has to be expanded! See the description of
-\Macro{tocbasic@extend@babel} at \autoref{sec:tocbasic.internals}%
-, \autopageref{desc:tocbasic.cmd.tocbasic@extend@babel} for more information.%
-\EndIndex{Cmd}{AtAddToTocList}%
+\DescRef{\LabelBase.cmd.tocbasic@extend@babel} has to be expanded! See the description of
+\DescRef{\LabelBase.cmd.tocbasic@extend@babel} at \autoref{sec:tocbasic.internals}%
+, \DescPageRef{\LabelBase.cmd.tocbasic@extend@babel} for more information.%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{removefromtoclist}\OParameter{owner}\Parameter{extension}
\end{Declaration}
-\BeginIndex{Cmd}{removefromtoclist}%
This command removes the \PName{extension} from the list of known extensions.
If the optional argument, \OParameter{owner}, was given, the \PName{extension}
will only be removed if it was added by this \PName{owner}. See description of
-\Macro{addtotoclist} for information of omitting optional argument. Note that
+\DescRef{\LabelBase.cmd.addtotoclist} for information of omitting optional argument. Note that
an empty \PName{owner} is not the same like omitting the optional argument,
but removes the \PName{extension} without any owner test.%
-\EndIndex{Cmd}{removefromtoclist}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{doforeachtocfile}\OParameter{owner}\Parameter{instructions}
\end{Declaration}
-\BeginIndex{Cmd}{doforeachtocfile}%
Until now you've learned to know commands that result in more safety in
handling file name extensions, but also needs some additional effort. With
\Macro{doforeachtocfile} you will win for this. The command provides to
@@ -275,18 +274,18 @@ only file name extensions with an empty owner will be processed.
\doforeachtocfile[foo]{\typeout{\@currext}}
\end{lstcode}
\end{Example}
-\EndIndex{Cmd}{doforeachtocfile}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{tocbasicautomode}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasicautomode}%
This command redefines \LaTeX{} kernel macro \Macro{@starttoc} to add all not
yet added extensions to the list of known extensions and use
-\Macro{tocbasic@starttoc} instead of \Macro{@starttoc}. See
+\DescRef{\LabelBase.cmd.tocbasic@starttoc} instead of \Macro{@starttoc}. See
\autoref{sec:tocbasic.internals},
-\autopageref{desc:tocbasic.cmd.tocbasic@starttoc} for more information about
-\Macro{tocbasic@starttoc} and \Macro{@starttoc}.
+\DescPageRef{\LabelBase.cmd.tocbasic@starttoc} for more information about
+\DescRef{\LabelBase.cmd.tocbasic@starttoc} and \Macro{@starttoc}.
This means that after using \Macro{tocbasicautomode} every table of contents
or list of something, that will be generated using \Macro{@starttoc} will be
@@ -297,7 +296,8 @@ it would be better if the author of the corresponding class or package will
use \Package{tocbasic} explicitly. In that case additional advantages of
\Package{tocbasic} may be used that will be described at the following
sections.%
-\EndIndex{Cmd}{tocbasicautomode}%
+\EndIndexGroup
+
\section{Creating a Table or List of Contents}
\label{sec:tocbasic.toc}
@@ -312,7 +312,6 @@ known extensions.
\begin{Declaration}
\Macro{addtoeachtocfile}\OParameter{owner}\Parameter{content}
\end{Declaration}
-\BeginIndex{Cmd}{addtoeachtocfile}%
This command writes \PName{content} to the TOC-files\Index{TOC} of every known
file name extension of \PName{owner} using \LaTeX{} kernel command
\Macro{addtocontents}. If you omit the optional argument, \PName{content} is
@@ -339,14 +338,14 @@ extension of the currently handled file.
Commands, that shouldn't be expanded while writing, should be prefixed by
\Macro{protect} in the same way like they should be in the argument of
\Macro{addtocontents}.
-\EndIndex{Cmd}{addtoeachtocfile}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{addxcontentsline}%
\Parameter{extension}\Parameter{level}\OParameter{number}%
\Parameter{text}
\end{Declaration}
-\BeginIndex{Cmd}{addxcontentsline}%
The command \Macro{addxcontentsline} adds an entry of given \PName{level} to
TOC-file with file name \PName{extension}. If the \Parameter{number} is empty
or omitted the entry will not have number for the entry with the given
@@ -373,29 +372,28 @@ numbered entries of the same \PName{level}, depending on the
Note that \Macro{addxcontentsline} uses
\Macro{add\PName{level}\PName{extension}entry} if such a macro exists and
-\Macro{tocbasic@addxcontentsline} otherwise. Therefore you cannot define
+\DescRef{\LabelBase.cmd.tocbasic@addxcontentsline} otherwise. Therefore you cannot define
a macro \Macro{add\PName{level}\PName{extension}entry} using
-\Macro{addxcontentsline} but \Macro{tocbasic@addxcontentsline}.
+\Macro{addxcontentsline} but \DescRef{\LabelBase.cmd.tocbasic@addxcontentsline}.
It is recommended to use \Macro{addxcontentsline} instead of
\Macro{addcontentsline} whenever possible.%
-\EndIndex{Cmd}{addxcontentsline}
+\EndIndexGroup
+
\begin{Declaration}
\Macro{addcontentslinetoeachtocfile}\OParameter{owner}\Parameter{level}%
- \Parameter{contentsline}\\
+ \Parameter{contentsline}%
\Macro{addxcontentslinetoeachtocfile}\OParameter{owner}%
\Parameter{level}\OParameter{number}\Parameter{text}
\end{Declaration}
-\BeginIndex{Cmd}{addcontentslinetoeachtocfile}%
-\BeginIndex{Cmd}{addxcontentslinetoeachtocfile}%
The first command is something like \Macro{addcontentsline} from \LaTeX{}
kernel. In difference to that it writes the \PName{contentsline} not only into
one file, but into all files of all known file name extensions or of all known
file name extensions of a given owner.
The command \Macro{addxcontentslinetoeachtocfile} is similar but uses
-\Macro{addxcontentsline} instead of \Macro{addcontentsline} and
+\DescRef{\LabelBase.cmd.addxcontentsline} instead of \Macro{addcontentsline} and
therefore supports \Package{tocbasic} feature \PValue{numberline}.
\begin{Example}
You are a class author and want to write the chapter entry not only to the
@@ -414,19 +412,15 @@ written.
It is recommended to use \Macro{addxcontentslinetoeachtocfile} instead
of \Macro{addcontentslinetoeachtocfile} whenever possible.
-\EndIndex{Cmd}{addxcontentslinetoeachtocfile}%
-\EndIndex{Cmd}{addcontentslinetoeachtocfile}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{listoftoc}\OParameter{list of title}\Parameter{extension}\\
- \Macro{listoftoc*}\Parameter{extension}\\
- \Macro{listofeachtoc}\OParameter{owner}\\
+ \Macro{listoftoc}\OParameter{list of title}\Parameter{extension}%
+ \Macro{listoftoc*}\Parameter{extension}%
+ \Macro{listofeachtoc}\OParameter{owner}%
\Macro{listof\PName{extension}name}
\end{Declaration}
-\BeginIndex{Cmd}{listoftoc*}%
-\BeginIndex{Cmd}{listoftoc}%
-\BeginIndex{Cmd}{listofeachtoc}%
-\BeginIndex{Cmd}{listof\PName{extension}name}%
These commands may be used to print the TOC corresponding to file name
\PName{extension}. The\important{\Macro{listoftoc*}} star version
\Macro{listoftoc*} needs only one argument, the \PName{extension} of the
@@ -467,11 +461,11 @@ the user itself may use \Macro{listofeachtoc}.
\end{lstcode}
Note that in this case no entry at the table of contents will be created,
even if you'd used the setup command above.
- See command \Macro{setuptoc}
- at \autopageref{desc:tocbasic.cmd.setuptoc}
+ See command \DescRef{\LabelBase.cmd.setuptoc}
+ at \DescPageRef{\LabelBase.cmd.setuptoc}
for more information about the
attribute of generating entries into the table of contents using
- \Macro{setuptoc}.
+ \DescRef{\LabelBase.cmd.setuptoc}.
If you've defined
\begin{lstcode}
@@ -503,55 +497,49 @@ if there are no more write handles left. Loading package
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}
(see \autoref{cha:scrwfile})
may solve this problem.
-\EndIndex{Cmd}{listof\PName{extension}name}%
-\EndIndex{Cmd}{listofeachtoc}%
-\EndIndex{Cmd}{listoftoc*}%
-\EndIndex{Cmd}{listoftoc}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{BeforeStartingTOC}\OParameter{extension}\Parameter{instructions}\\
+ \Macro{BeforeStartingTOC}\OParameter{extension}\Parameter{instructions}%
\Macro{AfterStartingTOC}\OParameter{extension}\Parameter{instructions}
\end{Declaration}
-\BeginIndex{Cmd}{BeforeStartingTOC}%
-\BeginIndex{Cmd}{AfterStartingTOC}%
Sometimes it's useful, to process \PName{instructions} immediately before
reading the auxiliary file of a TOC. These commands may be used to process
\PName{instructions} before or after loading the file with given
-\PName{extension} using \Macro{listoftoc*}, \Macro{listoftoc}, or
-\Macro{listofeachtoc}. If you omit the optional argument (or set an empty
+\PName{extension} using \DescRef{\LabelBase.cmd.listoftoc*}, \DescRef{\LabelBase.cmd.listoftoc}, or
+\DescRef{\LabelBase.cmd.listofeachtoc}. If you omit the optional argument (or set an empty
one) the general hooks will be set. The general before hook will be called
before the individuel one and the general after hook will be called after the
individuel one. While calling the hooks
\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} is the
extension of the TOC-file and should not be changed.
-An example\textnote{Example} for usage of \Macro{AfterStartingTOC} may be
+An example\textnote{Example} for usage of \Macro{BeforeStartingTOC} may be
found in \autoref{sec:scrwfile.clonefilefeature} at
-\autopageref{example:scrwfile.AfterStartingTOC}.
-\EndIndex{Cmd}{AfterStartingTOC}%
-\EndIndex{Cmd}{BeforeStartingTOC}%
+\PageRefxmpl{scrwfile.cmd.BeforeStartingTOC}.
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{BeforeTOCHead}\OParameter{extension}\Parameter{instructions}\\
+ \Macro{BeforeTOCHead}\OParameter{extension}\Parameter{instructions}%
\Macro{AfterTOCHead}\OParameter{extension}\Parameter{instructions}
\end{Declaration}
-\BeginIndex{Cmd}{BeforeTOCHead}%
-\BeginIndex{Cmd}{AfterTOCHead}%
This commands may be used to process \PName{instructions} before or after
setting the title of a TOC corresponding to given file name \PName{extension}
-using \Macro{listoftoc*} or \Macro{listoftoc}. If you omit the optional
-argument (or set an empty one) the general hooks will be set. The general
-before hook will be called before the individuel one and the general after
-hook will be called after the individuel one. While calling the hooks
+using \DescRef{\LabelBase.cmd.listoftoc*} or
+\DescRef{\LabelBase.cmd.listoftoc}. If you omit the optional argument (or set
+an empty one) the general hooks will be set. The general before hook will be
+called before the individuel one and the general after hook will be called
+after the individuel one. While calling the hooks
\Macro{@currext}IndexCmd{@currext}\important{\Macro{@currext}} is the
extension of the corresponding file and should not be changed.
-\EndIndex{Cmd}{AfterTOCHead}%
-\EndIndex{Cmd}{BeforeTOCHead}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{MakeMarkcase}\Parameter{text}
\end{Declaration}
-\BeginIndex{Cmd}{MakeMarkcase}%
Whenever \Package{tocbasic} sets a mark for a running head, The text of the
mark will be an argument of \Macro{MakeMarkcase}. This command may be used, to
change the case of the letters at the running head if wanted. The default is,
@@ -588,41 +576,41 @@ cannot recognize and take into account the glyphs of the letters. Because of
this\textnote{Attention!} typesetting whole words and phrases is expert work
and almost ever must be hand made. So average users are recommended to not do
that or to use it only spare and not at exposed places like running heads.%
-\EndIndex{Cmd}{MakeMarkcase}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{deftocheading}\Parameter{extension}\Parameter{definition}
\end{Declaration}
-\BeginIndex{Cmd}{deftocheading}%
The package \Package{tocbasic} contains a standard definition for typesetting
headings of TOCs. This standard definition is configurable by several
-features, described at \Macro{setuptoc} next. But if all those features are
+features, described at \DescRef{\LabelBase.cmd.setuptoc} next. But if all those features are
not enough, an alternative heading command may be defined using
\Macro{deftocheading}. Thereby \PName{extension} is the file name extension of
the corresponding TOC-file. The \PName{definition} of the heading command may
use one single parameter \PValue{\#1}. While calling the newly defined command
-inside of \Macro{listoftoc} or \Macro{listofeachtoc} that \PValue{\#1} will be
+inside of \DescRef{\LabelBase.cmd.listoftoc} or \DescRef{\LabelBase.cmd.listofeachtoc} that \PValue{\#1} will be
replaced by the corresponding heading term.%
-\EndIndex{Cmd}{deftocheading}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{setuptoc}\Parameter{extension}\Parameter{feature list}\\
+ \Macro{setuptoc}\Parameter{extension}\Parameter{feature list}%
\Macro{unsettoc}\Parameter{extension}\Parameter{feature list}
\end{Declaration}
-\BeginIndex{Cmd}{setuptoc}%
-\BeginIndex{Cmd}{unsettoc}%
This commands set up and unset features bound to a file name
\PName{extension}. The \PName{feature list} is a comma separated list of
single features. \Package{tocbasic} does know following features:
\begin{description}
\item[\texttt{leveldown}] uses not the top level heading below
- \Macro{part}\,---\,\Macro{chapter} if available, \Macro{section}
- otherwise\,---\,but the first sub level. This feature will be evaluated by
- the internal heading command. On the other hand, if an user defined heading
- command has been made with \Macro{deftocheading}, that user is responsible
- for the evaluation of the feature. The \KOMAScript{} classes set this
- feature using option
- \OptionValue{listof}{leveldown}important{\OptionValue{listof}{leveldown}}%
+ \DescRef{maincls.cmd.part}\,---\,\DescRef{maincls.cmd.chapter} if available,
+ \DescRef{maincls.cmd.section} otherwise\,---\,but the first sub level. This
+ feature will be evaluated by the internal heading command. On the other
+ hand, if an user defined heading command has been made with
+ \DescRef{\LabelBase.cmd.deftocheading}, that user is responsible for the evaluation of the
+ feature. The \KOMAScript{} classes set this feature using option
+ \OptionValueRef{maincls}{listof}{leveldown}%
+ important{\OptionValueRef{maincls}{listof}{leveldown}}%
\IndexOption{listof~=\PValue{leveldown}} for all file name extensions of the
owner \PValue{float}.
\item[\texttt{nobabel}] prevents usage of the language switch of
@@ -653,18 +641,18 @@ single features. \Package{tocbasic} does know following features:
\item[\texttt{numbered}] uses a numbered heading for the TOC and because of
this also generates an entry to the table of contents. This feature will be
evaluated by the internal heading command. On the other hand, if an user
- defined heading command has been made with \Macro{deftocheading}, that user
+ defined heading command has been made with \DescRef{\LabelBase.cmd.deftocheading}, that user
is responsible for the evaluation of the feature. The \KOMAScript{} classes
- set this feature using option
- \OptionValue{listof}{numbered}\important{\OptionValue{listof}{numbered}}%
+ set this feature using option \OptionValueRef{maincls}{listof}{numbered}%
+ \important{\OptionValueRef{maincls}{listof}{numbered}}%
\IndexOption{listof~=\PValue{numbered}} for all file name extensions of the
owner \PValue{float}.
\item[\texttt{numberline}] \leavevmode\ChangedAt{v3.12}{\Package{tocbasic}}%
- redefines \Macro{nonumberline} to use \Macro{numberline}. With this the not
+ redefines \Macro{nonumberline} to use \DescRef{\LabelBase.cmd.numberline}. With this the not
numbered entries generated by \KOMAScript{} or using \Macro{nonumberline} at
the very beginning of the last argument of \Macro{addcontentline} will also
be indented like numbered entries of the same
- type. Using\ChangedAt{v3.20}{\Package{tocbasic}} \Macro{numberline} for
+ type. Using\ChangedAt{v3.20}{\Package{tocbasic}} \DescRef{\LabelBase.cmd.numberline} for
entries without number\ChangedAt{v3.20}{\Package{tocbasic}} can have
additional side effects if you use entry style \PValue{tocline}. See style
attribute \Option{breakafternumber} and \Option{entrynumberformat} in
@@ -672,17 +660,18 @@ single features. \Package{tocbasic} does know following features:
\autopageref{tab:tocbasic.tocstyle.attributes} downwards.
\KOMAScript{} classes set this feature for the file name extensions of the
- owner \PValue{float} if you use option \OptionValue{listof}{numberline}%
- \important{\OptionValue{listof}{numberline}}%
+ owner \PValue{float} if you use option
+ \OptionValueRef{maincls}{listof}{numberline}%
+ \important{\OptionValueRef{maincls}{listof}{numberline}}%
\IndexOption{listof~=\PValue{numberline}} and for file name extension
- \PValue{toc} if you use option
- \OptionValue{toc}{numberline}\important{\OptionValue{toc}{numberline}}%
+ \PValue{toc} if you use option \OptionValueRef{maincls}{toc}{numberline}%
+ \important{\OptionValueRef{maincls}{toc}{numberline}}%
\IndexOption{toc~=\PValue{numberline}}. Analogous they reset this feature if
- you use \OptionValue{listof}{nonumberline}%
- \important{\OptionValue{listof}{nonumberline}}%
+ you use \OptionValueRef{maincls}{listof}{nonumberline}%
+ \important{\OptionValueRef{maincls}{listof}{nonumberline}}%
\IndexOption{listof~=\PValue{nonumberline}} or
- \OptionValue{toc}{nonumberline}%
- \important{\OptionValue{toc}{nonumberline}}%
+ \OptionValueRef{maincls}{toc}{nonumberline}%
+ \important{\OptionValueRef{maincls}{toc}{nonumberline}}%
\IndexOption{toc~=\PValue{nonumberline}}.
\item[\texttt{onecolumn}] \leavevmode\ChangedAt{v3.01}{\Package{tocbasic}}%
typesets the corresponding TOC with internal one column mode of
@@ -690,19 +679,20 @@ single features. \Package{tocbasic} does know following features:
done only, if the corresponding table of contents or list of something does
not use feature \PValue{leveldown}\important{\PValue{leveldown}}. The
\KOMAScript{} classes \Class{scrbook} and \Class{scrreprt} activate this
- feature with \Macro{AtAddToTocList} (see \autoref{sec:tocbasic.basics},
- \autopageref{desc:tocbasic.cmd.AtAddToTocList}) for all TOCs with owner
- \PValue{float} or with themselves as owner. With this, e.\,g., the table of
- contents, the list of figures and the list of tables of both classes will be
- single columned automatically. The multiple-column-mode of package
- \Package{multicol}\IndexPackage{multicol} will not be recognised or changed
- by this option.
+ feature with \DescRef{\LabelBase.cmd.AtAddToTocList} (see
+ \autoref{sec:tocbasic.basics}, \DescPageRef{\LabelBase.cmd.AtAddToTocList})
+ for all TOCs with owner \PValue{float} or with themselves as owner. With
+ this, e.\,g., the table of contents, the list of figures and the list of
+ tables of both classes will be single columned automatically. The
+ multiple-column-mode of package \Package{multicol}\IndexPackage{multicol}
+ will not be recognised or changed by this option.
\item[\texttt{totoc}] writes the title of the corresponding TOC to the table
of contents. This feature will be evaluated by the internal heading
command. On the other hand, if an user defined heading command has been made
- with \Macro{deftocheading}, that user is responsible for the evaluation of
+ with \DescRef{\LabelBase.cmd.deftocheading}, that user is responsible for the evaluation of
the feature. The \KOMAScript{} classes set this feature using option
- \OptionValue{listof}{totoc}\important{\OptionValue{listof}{totoc}}%
+ \OptionValueRef{maincls}{listof}{totoc}%
+ \important{\OptionValueRef{maincls}{listof}{totoc}}%
\IndexOption{listof~=\PValue{totoc}} for all file name extensions of the
owner \PValue{float}.
\end{description}
@@ -711,10 +701,10 @@ know following additional features:
\begin{description}
\item[\texttt{chapteratlist}] activates special code to be put into the TOC at
start of a new chapter. This code may either be vertical space or the
- heading of the chapter. See
- \Option{listof}\IndexOption{listof}\important{\Option{listof}} in
- \autoref{sec:maincls.floats}, \autopageref{desc:maincls.option.listof} for
- more information about such features.
+ heading of the chapter. See \DescRef{maincls.option.listof}%
+ \IndexOption{listof}\important{\DescRef{maincls.option.listof}} in
+ \autoref{sec:maincls.floats}, \DescPageRef{maincls.option.listof} for more
+ information about such features.
\end{description}
\begin{Example}
Because \KOMAScript{} classes use \Package{tocbasic} for the list of figures
@@ -731,16 +721,16 @@ know following additional features:
\begin{lstcode}
\setuptoc{loa}{chapteratlist}
\end{lstcode}
- And if classes with \Macro{chapter} should also force single column mode for
- the list of algorithms you may use
+ And if classes with \DescRef{maincls.cmd.chapter} should also force single
+ column mode for the list of algorithms you may use
\begin{lstcode}
\ifundefinedorrelax{chapter}{}{%
\setuptoc{loa}{onecolumn}%
}
\end{lstcode}
- Usage of \Macro{ifundefinedorrelax} presumes package \Package{scrbase} (see
- \autoref{sec:scrbase.if},
- \autopageref{desc:scrbase.cmd.ifundefinedorrelax}).
+ Usage of \DescRef{scrbase.cmd.ifundefinedorrelax} presumes package
+ \Package{scrbase} (see \autoref{sec:scrbase.if},
+ \DescPageRef{scrbase.cmd.ifundefinedorrelax}).
It\textnote{Hint!} doesn't matter if you're package would be used with
another class. You should never the less set this feature. And if the other
@@ -751,27 +741,29 @@ As you may see, packages that use \Package{tocbasic}, already provide several
interesting features, without the need of a lot of implementation effort. Such
an effort would be needed only without \Package{tocbasic} and because of this,
most packages currently lack of such features.%
-\EndIndex{Cmd}{unsettoc}%
-\EndIndex{Cmd}{setuptoc}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{iftocfeature}\Parameter{extension}\Parameter{feature}%
\Parameter{true-instructions}\Parameter{false-instructions}
\end{Declaration}
-\BeginIndex{Cmd}{iftocfeature}%
This command may be used, to test, if a \PName{feature} was set for file name
\PName{extension}. If so the \PName{true-instructions} will be processed,
otherwise the \PName{false-instruction} will be. This may be useful, e.\,g.,
-if you define your own heading command using \Macro{deftocheading} but want to
-support the features \PValue{totoc}, \PValue{numbered} or \PValue{leveldown}.%
-\EndIndex{Cmd}{iftocfeature}%
+if you define your own heading command using
+\DescRef{\LabelBase.cmd.deftocheading} but want to support the features
+\PValue{totoc}, \PValue{numbered} or \PValue{leveldown}.%
+\EndIndexGroup
\section{Configuration of Entries to a Table or List of Contents}
\seclabel{tocstyle}%
+\BeginIndexGroup
\BeginIndex{}{table of contents>entry}%
\Index{list of contents|\see{table of contents}}
+
Since\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} version~3.20 package
\Package{tocbasic} can not only configure the tables or lists of contents and
their auxiliary files but also influence their entries. To do so, you can
@@ -781,12 +773,35 @@ package \Package{tocstyle} that never became an official part of the
\KOMAScript{} bundle. The \KOMAScript{} classes intensively use the TOC-entry
styles of \Package{tocbasic} since version~3.20.
+
\begin{Declaration}
- \Macro{numberline}\Parameter{entry number}\\
+ \Counter{tocdepth}
+\end{Declaration}
+Entries to tables or lists of contents are in hierarchical order. Therefore
+each entry level has a numerical value. Higher values correspond with deeper
+levels. Within the standard classes, e.\,g., parts have the numerical entry
+level -1 in the table of contents and chapter entries have value 0. Counter
+\Counter{tocdepth} defines the deepest level that should be shown in the
+tables and lists of any contents.
+
+Class \Class{book} sets \Counter{tocdepth} to 2, so entries of the levels
+\PValue{part}, \PValue{chapter}, \PValue{section}, and \PValue{subsection} are
+printed. Deeper levels like \PValue{subsubsection}, which has the numerical
+value 3, are not printed. Nevertheless the entries are part of the auxiliary
+file for the table of contents.
+
+Most entry styles of \Package{tocbasic} also cares about
+\Counter{tocdepth}. Only style \PValue{gobble} (see
+\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry}\iffree{}{, later in this
+ section}) ignores \Counter{tocdepth}.
+%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \Macro{numberline}\Parameter{entry number}%
\Macro{usetocbasicnumberline}\OParameter{code}
\end{Declaration}
-\BeginIndex{Cmd}{numberline}%
-\BeginIndex{Cmd}{usetocbasicnumberline}%
Though\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} the \LaTeX{} kernel
already defines command \Macro{numberline}, the kernel definition is not
sufficient for \Package{tocbasic}. Therefore \Package{tocbasic} has its own
@@ -807,24 +822,22 @@ you just do not want such a message, use an empty optional argument.
Please note\textnote{Attention!}, as a side effect
\Macro{usetocbasicnumberline} can globally change the internal switch
\Macro{@tempswa}!%
-\EndIndex{Cmd}{usetocbasicnumberline}%
-\EndIndex{Cmd}{numberline}%
+\EndIndexGroup
\begin{Declaration}
\Macro{DeclareTOCStyleEntry}\OParameter{option list}\Parameter{style}%
\Parameter{entry level}
\end{Declaration}
-\BeginIndex{Cmd}{DeclareTOCStyleEntry}%
This\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} command is used to define
or configure the TOC-entries of a given \PName{entry level}. Argument
\PName{entry level} is a symbolic name, e.\,g., \PValue{section} for the entry
to the table of contents of the section level with the same name or
-\PValue{figure} for an entry of a figure to the list of figures. A \PName{style}
-is assigned to each \PName{entry level}. The \PName{style} has to be defined
-before using it as an argument of \Macro{DeclareTOCStyleEntry}. The
-\PName{option list} is used to configure several \PName{style}-dependent
-attributes of the \PName{entry level}.
+\PValue{figure} for an entry of a figure to the list of figures. A
+\PName{style} is assigned to each \PName{entry level}. The \PName{style} has
+to be defined before using it as an argument of
+\Macro{DeclareTOCStyleEntry}. The \PName{option list} is used to configure
+several \PName{style}-dependent attributes of the \PName{entry level}.
Currently, \Package{tocbasic} defines the following entry styles:
\begin{description}
@@ -894,35 +907,35 @@ Currently, \Package{tocbasic} defines the following entry styles:
\label{fig:tocbasic.dottedtocline}
\end{figure}
\item[\PValue{gobble}] is the most ordinary style. Independently from the
- setting of
- \Counter{tocdepth}\IndexCounter{tocdepth}\important{\Counter{tocdepth}},
+ setting of \DescRef{\LabelBase.counter.tocdepth}%
+ \IndexCounter{tocdepth}\important{\DescRef{\LabelBase.counter.tocdepth}},
entries with this style will never be printed. The style simply gobbles the
entries. Nevertheless, it supports the standard attribute \PValue{level} but
does ignore it.
-\item[\PValue{largetocline}] is similar to the style used by the
- standard classes for the level \PValue{part}. It supports attributes
- \PValue{level} and \PValue{indent} only. The last one is already a variation
- of the standard classes that do not support an indent of the \PValue{part}
- entries.
+\item[\PValue{largetocline}] is similar to the style used by the standard
+ classes for the level \PValue{part}. It supports attributes \PValue{level}
+ and \PValue{indent} only. The last one is already a variation of the
+ standard classes that do not support an indent of the \PValue{part} entries.
Before an entry a page break will be made easier. The entries will be
indented by the value of \PValue{indent} from the left. They are printed
- using \Macro{large}\Macro{bfseries}. If \Macro{numberline} is used, the
- number width is 3\Unit{em}. \Macro{numberline} is not redefined. The
- standard classes do not use \Macro{numberline} for \PName{part} entries. The
- value of \PName{indent} even does not influence the indent from the second
- line of an entry.
+ using \Macro{large}\Macro{bfseries}. If \DescRef{\LabelBase.cmd.numberline}
+ is used, the number width is 3\Unit{em}. \DescRef{\LabelBase.cmd.numberline}
+ is not redefined. The standard classes do not use
+ \DescRef{\LabelBase.cmd.numberline} for \PName{part} entries. The value of
+ \PName{indent} even does not influence the indent from the second line of an
+ entry.
\hyperref[fig:tocbasic.largetocline]%
- {Figure~\ref*{fig:tocbasic.largetocline}} illustrates the attributes of
- this style. There you can also see that the style copies inconsistencies of
- the standard classes, e.\,g. the missing indent of the second and following
+ {Figure~\ref*{fig:tocbasic.largetocline}} illustrates the attributes of this
+ style. There you can also see that the style copies inconsistencies of the
+ standard classes, e.\,g. the missing indent of the second and following
lines of an entry or the different values of \Macro{@pnumwidth} that results
from the font size dependency. This can even result in a to small distance
between the entry text and the page number. Please note, the entry number
- width shown in the figure is only valid if \Macro{numberline} has been
- used. In contrast, the standard classes use a distance of 1\Unit{em} after
- the number.
+ width shown in the figure is only valid if
+ \DescRef{\LabelBase.cmd.numberline} has been used. In contrast, the standard
+ classes use a distance of 1\Unit{em} after the number.
\begin{figure}
\centering
\resizebox{.8\linewidth}{!}{%
@@ -976,7 +989,7 @@ Currently, \Package{tocbasic} defines the following entry styles:
on the name of the \PName{entry level}. They correspond to the results of
the standard classes. So after loading \Package{tocbasic}, you can change
the style of the standard classes entries to the table of contents into
- \PValue{tocline} using \Macro{DeclareTOCEntryStyle} without obvious visual
+ \PValue{tocline} using \DescRef{\LabelBase.cmd.DeclareTOCEntryStyle} without obvious visual
changes unless you change exactly these attributes that should induce such
changes. Same is valid for list of figures or list of tables of the standard
classes.
@@ -1145,10 +1158,11 @@ Currently, \Package{tocbasic} defines the following entry styles:
Before an entry, a page break will be made easier. The entries will be
indented by the value of \PValue{indent} from the left. They are printed
- using \Macro{bfseries}. \Macro{numberline} is used unchanged. The width of
- the entry number is given by the value of \PValue{numwidth}. For multiline
- entries the indent will be increased by the value of \PValue{numwidth} for
- the second and following lines. \hyperref[fig:tocbasic.undottedtocline]%
+ using \Macro{bfseries}. \DescRef{\LabelBase.cmd.numberline} is used
+ unchanged. The width of the entry number is given by the value of
+ \PValue{numwidth}. For multiline entries the indent will be increased by the
+ value of \PValue{numwidth} for the second and following
+ lines. \hyperref[fig:tocbasic.undottedtocline]%
{Figure~\ref*{fig:tocbasic.undottedtocline}} illustrates the attributes of
this style.
\begin{figure}
@@ -1194,13 +1208,13 @@ Currently, \Package{tocbasic} defines the following entry styles:
{Table~\ref*{tab:tocbasic.tocstyle.attributes}} describes all attributes of
all styles defined by
\Package{tocbasic}. If\ChangedAt[2016/06]{v3.21}{\Package{tocbasic}} you want
-to use these attributes as options to \Macro{DeclareNewTOC} (see
-\autopageref{desc:tocbasic.cmd.DeclareNewTOC}) you have to prefix the names of
-the attribute by \PValue{tocentry}, e\,g., attribute \PValue{level} becomes
+to use these attributes as options to \DescRef{\LabelBase.cmd.DeclareNewTOC}
+(see \DescPageRef{\LabelBase.cmd.DeclareNewTOC}) you have to prefix the names
+of the attribute by \PValue{tocentry}, e\,g., attribute \PValue{level} becomes
option \Option{tocentrylevel}.
-If\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}} you want to use
-these attributes as options to \Macro{DeclareSectionCommand} (see
-\autopageref{desc:maincls-experts.cmd.DeclareSectionCommand}) and similar
+If\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}} you want to use these
+attributes as options to \DescRef{maincls-experts.cmd.DeclareSectionCommand}
+(see \DescPageRef{maincls-experts.cmd.DeclareSectionCommand}) and similar
commands you have to prefix the names of the attributes by \PValue{toc},
e\,g., attribute \PValue{level} becomes option \Option{toclevel}.
@@ -1214,7 +1228,7 @@ command \Macro{l@\PName{entry level}}.
}{%
Attributes of the TOC-entry styles (\emph{continuation})%
}%
- \entry{\KOption{beforeskip}\PName{length}}{%
+ \entry{\OptionVName{beforeskip}{length}}{%
vertical distance, inserted before an entry of this level using style
\PValue{tocline} (see \autoref{fig:tocbasic.tocline}). The distance is
made using either \Macro{vskip} or \Macro{addvspace} depending on the
@@ -1227,31 +1241,33 @@ command \Macro{l@\PName{entry level}}.
\PValue{section} is initialised with \texttt{1em plus 1pt}. The initial
value for all other levels is \texttt{0pt plus .2pt}.%
}%
- \entry{\KOption{breakafternumber}\PName{switch}}{%
- \PName{switch} is one of the values for simple switches from
+ \entry{\OptionVName{breakafternumber}{switch}}{%
+ \PName{switch} is one of the values for simple switches from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. If the
switch is active with style \PValue{tocline}, there will be a line break
- after the entry number of \Macro{numberline}\IndexCmd{numberline}. The
- line after the entry number again starts left aligned with the number.
+ after the entry number of
+ \DescRef{\LabelBase.cmd.numberline}\IndexCmd{numberline}. The line after
+ the entry number again starts left aligned with the number.
This switch is not active by default at style \PValue{tocline}.
If\textnote{Attention!} the feature \Option{numberline} of a list of
- something has been activated (see \Macro{setuptoc},
- \autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.setuptoc}),
- i.\,e., if a \KOMAScript{} class with option
- \OptionValue{toc}{numberline}\IndexOption{toc~=\PValue{numberline}} is
- used, then the not numbered entries will nevertheless have a (by default
- empty) number line using the format code of \Option{entrynumberformat}.%
+ something has been activated (see \DescRef{\LabelBase.cmd.setuptoc},
+ \autoref{sec:tocbasic.toc}, \DescPageRef{\LabelBase.cmd.setuptoc}), i.\,e.,
+ if a \KOMAScript{} class with option
+ \OptionValueRef{maincls}{toc}{numberline}%
+ \IndexOption{toc~=\PValue{numberline}} is used, then the not numbered
+ entries will nevertheless have a (by default empty) number line using the
+ format code of \Option{entrynumberformat}.%
}%
- \entry{\KOption{dynnumwidth}\PName{switch}}{%
+ \entry{\OptionVName{dynnumwidth}{switch}}{%
\PName{switch} is one of the values for simple switches from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. If the
switch is active with style \PValue{tocline}, attribute \PValue{numwidth}
is ignored. Instead of that the maximum number width detected at the
previous \LaTeX{} run increased by the value of \PValue{numsep} is used.%
}%
- \entry{\KOption{entryformat}\PName{command}}{%
+ \entry{\OptionVName{entryformat}{command}}{%
This attributes makes the format of the entry. The value should be a
\PName{command} with exactly one argument. The \PName{command} should not
expect the argument to be fully expandable. Commands like
@@ -1267,24 +1283,25 @@ command \Macro{l@\PName{entry level}}.
no level \PValue{chapter} exists, \PValue{section} used
\Macro{bfseries}. All other levels print the argument unchanged.%
}%
- \entry{\KOption{entrynumberformat}\PName{command}}{%
+ \entry{\OptionVName{entrynumberformat}{command}}{%
This attribute makes the format of the entry number within
- \Macro{numberline}. The value should be a \PName{command} with exactly one
- argument. Font changes are relative to the one of attribute
- \Option{entryformat}.
+ \DescRef{\LabelBase.cmd.numberline}. The value should be a \PName{command}
+ with exactly one argument. Font changes are relative to the one of
+ attribute \Option{entryformat}.
The initial \PName{command} prints the argument unchanged. This means the
entry number will be printed as it is.
If\textnote{Attention!} the feature \Option{numberline} of a list of
- something has been activated (see \Macro{setuptoc},
- \autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.setuptoc}),
- i.\,e., if a \KOMAScript{} class with option
- \OptionValue{toc}{numberline}\IndexOption{toc~=\PValue{numberline}} is
- used, then the not numbered entries will nevertheless execute the
+ something has been activated (see \DescRef{\LabelBase.cmd.setuptoc},
+ \autoref{sec:tocbasic.toc}, \DescPageRef{\LabelBase.cmd.setuptoc}), i.\,e.,
+ if a \KOMAScript{} class with option
+ \OptionValueRef{maincls}{toc}{numberline}%
+ \IndexOption{toc~=\PValue{numberline}}
+ is used, then the not numbered entries will nevertheless execute the
\PName{command}.%
}%
- \entry{\KOption{indent}\PName{length}}{%
+ \entry{\OptionVName{indent}{length}}{%
Horizontal distance of the entry relative to the left margin (siehe
\autoref{fig:tocbasic.dottedtocline} and \autoref{fig:tocbasic.tocline}).
@@ -1295,41 +1312,43 @@ command \Macro{l@\PName{entry level}}.
\PValue{tocline} the initial values of levels \PValue{part} down to
\PValue{subparagraph} and the levels \PValue{figure} and \PValue{table}
are compatible with the standard classes. All other levels do not have an
- initial value. Therefore you have to set an explicit value for such
- levels when they are defined first time.%
+ initial value. Therefore you have to set an explicit value for such levels
+ when they are defined first time.%
}%
- \entry{\KOption{level}\PName{integer}}{%
+ \entry{\OptionVName{level}{integer}}{%
The numerical value of the \PName{entry level}. Only those entries are
- printed that have a numerical value less or equal to counter
- \Counter{tocdepth}\important{\Counter{tocdepth}}\IndexCounter{tocdepth}.
+ printed that have a numerical value less or equal to counter
+ \DescRef{\LabelBase.counter.tocdepth}%
+ \important{\DescRef{\LabelBase.counter.tocdepth}}\IndexCounter{tocdepth}.
This attribute is mandatory for all styles and will be defined
automatically at the declaration of the style.
At style \PValue{tocline} all entry levels with a name starting with
``\texttt{sub}'', the initial value is the level value of the entry level
- without this prefix increased by one. At the styles \PValue{dottedtocline},
- \PValue{largetocline}, \PValue{tocline}, and \PValue{undottedtocline}
- entry levels \PValue{part} down to \PValue{subparagraph}, \PValue{figure},
- and \PValue{table} are initialised compatible with the standard
- classes. For all other levels the initialisation is done with the value of
- \Macro{\PName{entry level}numdepth} if this is defined.%
+ without this prefix increased by one. At the styles
+ \PValue{dottedtocline}, \PValue{largetocline}, \PValue{tocline}, and
+ \PValue{undottedtocline} entry levels \PValue{part} down to
+ \PValue{subparagraph}, \PValue{figure}, and \PValue{table} are initialised
+ compatible with the standard classes. For all other levels the
+ initialisation is done with the value of \Macro{\PName{entry
+ level}numdepth} if this is defined.%
}%
- \entry{\KOption{linefill}\PName{code}}{%
+ \entry{\OptionVName{linefill}{code}}{%
At style \PValue{tocline} there can be a filler between the end of the
entry text and the page number. The value of attribute \PName{linefill} is
a \PName{code} that prints this filler. For \PName{entry level}
\PValue{part} and \PValue{chapter} the attribute is initialised with
\Macro{hfill}. If currently no \PName{entry level} \PValue{chapter} has
been defined, \PValue{section} also uses \Macro{hfill}. All other entry
- levels are initialised with \Macro{TOCLineLeaderFill} (see
- \autopageref{desc:tocbasic.cmd.TOCLineLeaderFill}).
+ levels are initialised with \DescRef{\LabelBase.cmd.TOCLineLeaderFill} (see
+ \DescPageRef{\LabelBase.cmd.TOCLineLeaderFill}).
If \PName{code} does not result in filling the distance, you should also
activate attribute \PValue{raggedpagenumber}, to avoid ``\texttt{underfull
\Macro{hbox}}'' messages.%
}%
- \entry{\KOption{numsep}\PName{length}}{%
+ \entry{\OptionVName{numsep}{length}}{%
Style \PValue{tocline} tries to ensure a minimum distance of
\PName{length} between the entry number and the entry text. If
\PValue{dynnumwidth} is active, it will correct the number width to achieve
@@ -1337,7 +1356,7 @@ command \Macro{l@\PName{entry level}}.
The initial \PName{length} is 0.4\Unit{em}.%
}%
- \entry{\KOption{numwidth}\PName{length}}{%
+ \entry{\OptionVName{numwidth}{length}}{%
The reserved width for the entry number (see
\autoref{fig:tocbasic.dottedtocline} until
\autoref{fig:tocbasic.undottedtocline}). At the styles
@@ -1355,7 +1374,7 @@ command \Macro{l@\PName{entry level}}.
have to explicitly set \PValue{numwidth} at the first definition of the
entry.%
}%
- \entry{\KOption{onstarthigherlevel}\PName{code}}{%
+ \entry{\OptionVName{onstarthigherlevel}{code}}{%
Style \PValue{tocline} can execute \PName{code} at the start of an entry,
if the numerical level is greater than the numerical level of the previous
entry. Remember: The numerical level of, e.\,g., \PValue{section} is
@@ -1365,10 +1384,10 @@ command \Macro{l@\PName{entry level}}.
Please note that the detection of the level of the previous entry depends
on a valid unchanged value of \Macro{lastpenalty}.
- The initial \PName{code} is \Macro{LastTOCLevelWasLower} (see
- \autopageref{desc:tocbasic.cmd.LastTOCLevelWasLower}).%
+ The initial \PName{code} is \DescRef{\LabelBase.cmd.LastTOCLevelWasLower} (see
+ \DescPageRef{\LabelBase.cmd.LastTOCLevelWasLower}).%
}%
- \entry{\KOption{onstartlowerlevel}\PName{code}}{%
+ \entry{\OptionVName{onstartlowerlevel}{code}}{%
Style \PValue{tocline} can execute \PName{code} at the start of an entry,
if the numerical level is lower than the numerical level of the previous
entry. Remember: The numerical level of, e.\,g., \PValue{part} is
@@ -1378,26 +1397,26 @@ command \Macro{l@\PName{entry level}}.
Please note that the detection of the level of the previous entry depends
on a valid unchanged value of \Macro{lastpenalty}.
- The initial \PName{code} is \Macro{LastTOCLevelWasHigher} (see
- \autopageref{desc:tocbasic.cmd.LastTOCLevelWasHigher}).%
+ The initial \PName{code} is \DescRef{\LabelBase.cmd.LastTOCLevelWasHigher} (see
+ \DescPageRef{\LabelBase.cmd.LastTOCLevelWasHigher}).%
}%
- \entry{\KOption{onstartsamelevel}\PName{code}}{%
+ \entry{\OptionVName{onstartsamelevel}{code}}{%
Style \PValue{tocline} can execute \PName{code} at the start of an entry,
if the level is same like the level of the previous entry.
Please note that the detection of the level of the previous entry depends
on a valid unchanged value of \Macro{lastpenalty}.
- The initial \PName{code} is \Macro{LastTOCLevelWasSame} (see
- \autopageref{desc:tocbasic.cmd.LastTOCLevelWasSame}).%
+ The initial \PName{code} is \DescRef{\LabelBase.cmd.LastTOCLevelWasSame} (see
+ \DescPageRef{\LabelBase.cmd.LastTOCLevelWasSame}).%
}%
- \entry{\KOption{pagenumberbox}\PName{command}}{%
+ \entry{\OptionVName{pagenumberbox}{command}}{%
By default the page number of an entry is printed right aligned in a box
of width \Macro{@pnumwidth}. At style \PValue{tocline} the \PName{command}
to print the number can be changed using this attribute. The
\PName{command} should have exactly one argument, the page number.%
}%
- \entry{\KOption{pagenumberformat}\PName{command}}{%
+ \entry{\OptionVName{pagenumberformat}{command}}{%
This attribute is the format of the page number of an entry. The
\PName{command} should have exactly one argument, the page number. Font
changes are relative to the font of \Option{entryformat} followed by
@@ -1408,7 +1427,7 @@ command \Macro{l@\PName{entry level}}.
all other levels prints the argument in
\Macro{normalfont}\Macro{normalcolor}.%
}%
- \entry{\KOption{raggedentrytext}\PName{switch}}{%
+ \entry{\OptionVName{raggedentrytext}{switch}}{%
\ChangedAt{v3.21}{\Package{tocbasic}}%
\PName{switch} is one of the values for simple switches from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. If the
@@ -1418,7 +1437,7 @@ command \Macro{l@\PName{entry level}}.
This switch is not active by default.%
}%
- \entry{\KOption{raggedpagenumber}\PName{switch}}{%
+ \entry{\OptionVName{raggedpagenumber}{switch}}{%
\PName{switch} is one of the values for simple switches from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. If the
switch is active, style \PValue{tocline} does not force the page number to
@@ -1429,43 +1448,44 @@ command \Macro{l@\PName{entry level}}.
unwanted warning messages. So both attributes should correspond.
By default the switch is not activated and therefore corresponds with an
- initial value \Macro{hfill} or \Macro{TOCLineLeaderFill} of attribute
+ initial value \Macro{hfill} or \DescRef{\LabelBase.cmd.TOCLineLeaderFill} of attribute
\PValue{linefill}.%
}%
\end{desclist}%
%
-\EndIndex{Cmd}{DeclareTOCStyleEntry}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{DeclareTOCEntryStyle}\Parameter{style}%
\OParameter{initial code}%
- \Parameter{command code}\\
+ \Parameter{command code}%
\Macro{DefineTOCEntryOption}\Parameter{option}\OParameter{default value}%
- \Parameter{code}\\
+ \Parameter{code}%
\Macro{DefineTOCEntryBooleanOption}\Parameter{option}%
\OParameter{default value}%
\Parameter{prefix}%
\Parameter{postfix}%
- \Parameter{description}\\%
- %\OParameter{initial code}\\
+ \Parameter{description}%%
+ %\OParameter{initial code}%
\Macro{DefineTOCEntryCommandOption}\Parameter{option}%
\OParameter{default value}%
\Parameter{prefix}%
\Parameter{postfix}%
- \Parameter{description}\\%
- %\OParameter{initial code}\\
+ \Parameter{description}%%
+ %\OParameter{initial code}%
\Macro{DefineTOCEntryIfOption}\Parameter{option}%
\OParameter{default value}%
\Parameter{prefix}%
\Parameter{postfix}%
- \Parameter{description}\\%
- %\OParameter{initial code}\\
+ \Parameter{description}%%
+ %\OParameter{initial code}%
\Macro{DefineTOCEntryLengthOption}\Parameter{option}%
\OParameter{default value}%
\Parameter{prefix}%
\Parameter{postfix}%
- \Parameter{description}\\%
- %\OParameter{initial code}\\
+ \Parameter{description}%%
+ %\OParameter{initial code}%
\Macro{DefineTOCEntryNumberOption}\Parameter{option}%
\OParameter{default value}%
\Parameter{prefix}%
@@ -1473,34 +1493,26 @@ command \Macro{l@\PName{entry level}}.
\Parameter{description}%
%\OParameter{initial code}%
\end{Declaration}
-\BeginIndex{Cmd}{DeclareTOCEntryStyle}%
-\BeginIndex{Cmd}{DefineTOCEntryOption}%
-\BeginIndex{Cmd}{DefineTOCEntryBooleanOption}%
-\BeginIndex{Cmd}{DefineTOCEntryCommandOption}%
-\BeginIndex{Cmd}{DefineTOCEntryIfOption}%
-\BeginIndex{Cmd}{DefineTOCEntryLengthOption}%
-\BeginIndex{Cmd}{DefineTOCEntryNumberOption}%
\Macro{DeclareTOCEntryStyle}\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} is
one of the most complex commands in \KOMAScript. It is addressed to \LaTeX{}
developers not the \LaTeX{} users. It provides the definition of a new
TOC-entry \PName{style}. Usually TOC-entries are made using
\Macro{addcontentsline}\IndexCmd{addcontentsline}, or, if you use
\Package{tocbasic}, with recommended
-\Macro{addxcontentsline}\IndexCmd{addxcontentsline} (see
+\DescRef{\LabelBase.cmd.addxcontentsline}\IndexCmd{addxcontentsline} (see
\autoref{sec:tocbasic.basics},
-\autopageref{desc:tocbasic.cmd.addxcontentsline}). In both cases \LaTeX{}
+\DescPageRef{\LabelBase.cmd.addxcontentsline}). In both cases \LaTeX{}
writes a corresponding \Macro{contentsline}\IndexCmd{contentsline} into the
given auxiliary file. Reading this auxiliary file each \Macro{contentsline}
results in execution of a command \Macro{l@\PName{entry level}}.
Whenever you assign a \PName{style} to a TOC-entry level using
-\Macro{DeclareTOCStyleEntry}, first of all the \PName{initial code} is
-executed and then \Macro{l@\PName{entry level}} is defined to be
+\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry}, first of all the \PName{initial
+ code} is executed and then \Macro{l@\PName{entry level}} is defined to be
\PName{command code}. So \PName{command code} is the code that will be
-expanded and executed by \Macro{l@\PName{entry level}}. Inside
-\PName{command code} \texttt{\#1} is the name of the TOC-entry level and
-\texttt{\#\#1} and \texttt{\#\#2} are the arguments of
-\Macro{l@\PName{entry level}}.
+expanded and executed by \Macro{l@\PName{entry level}}. Inside \PName{command
+ code} \texttt{\#1} is the name of the TOC-entry level and \texttt{\#\#1} and
+\texttt{\#\#2} are the arguments of \Macro{l@\PName{entry level}}.
The \PName{initial code} should initialise all attributes of the
\PName{style}. Developers are recommended to use \PName{initial code} to
@@ -1511,7 +1523,7 @@ the definition of options to setup the attributes of the \PName{style}. Option
can be got in \PName{command code} using
\Macro{@nameuse}\PParameter{\#1tocdepth}%
\important{\Macro{\PName{entry level}tocdepth}}, e.\,g., to compare it with
-the counter \Counter{tocdepth}\IndexCounter{tocdepth}.
+the counter \DescRef{\LabelBase.counter.tocdepth}\IndexCounter{tocdepth}.
Commands \Macro{DefineTOCEntryBooleanOption},
\Macro{DefineTOCEntryCommandOption}, \Macro{DefineTOCEntryIfOption},
@@ -1535,31 +1547,31 @@ in error messages, warnings or information output on the terminal and into the
The most simple style of \Package{tocbasic}, \PValue{gobble}, is defined
using:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\DeclareTOCEntryStyle{gobble}{}%
\end{lstcode}
If you would define a entry level \PValue{dummy} using:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\DeclareTOCStyleEntry[level=1]{gobble}{dummy}
\end{lstcode}
among others this would do something like:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\def\dummytocdepth{1}
\def\l@dummy#1#2{}
\end{lstcode}
Inside style \PValue{tocline} for example
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\DefineTOCEntryCommandOption{linefill}[\TOCLineLeaderFill]%
{scr@tso@}{@linefill}{filling between text and page number}%
\end{lstcode}
is used to define option \Option{linefill} with \PName{default value}
-\Macro{TOCLineLeaderFill}. A call like:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\DescRef{\LabelBase.cmd.TOCLineLeaderFill}. A call like:
+\begin{lstcode}
\RedeclareTOCStyleEntry[linefill]{tocline}{part}
\end{lstcode}
would therefore result in a definition like:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\def\scr@tso@part@linefill{\TOCLineLeaderFill}
\end{lstcode}
@@ -1569,25 +1581,20 @@ the much more complex definition of style \PValue{tocline} gives a lot of
hints of the correct usage of the described commands.
In many cases it will be enough to clone an existing style using
-\Macro{CloneTOCEntryStyle} and to change the initial code of the new style
-using \Macro{TOCEntryStyleInitCode} or \Macro{TOCEntryStyleStartInitCode}.
+\DescRef{\LabelBase.cmd.CloneTOCEntryStyle} and to change the initial code of
+the new style using \DescRef{\LabelBase.cmd.TOCEntryStyleInitCode} or
+\DescRef{\LabelBase.cmd.TOCEntryStyleStartInitCode}.
\Macro{DefineTOCEntryOption} is merely used to define the other
commands. It is not recommended to define options directly using
\Macro{DefineTOCEntryOption}. Normally this is even not needed. It is
alluded only for completeness.%
-\EndIndex{Cmd}{DefineTOCEntryNumberOption}%
-\EndIndex{Cmd}{DefineTOCEntryLengthOption}%
-\EndIndex{Cmd}{DefineTOCEntryIfOption}%
-\EndIndex{Cmd}{DefineTOCEntryCommandOption}%
-\EndIndex{Cmd}{DefineTOCEntryBooleanOption}%
-\EndIndex{Cmd}{DefineTOCEntryOption}%
-\EndIndex{Cmd}{DeclareTOCEntryStyle}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{CloneTOCEntryStyle}\Parameter{style}\Parameter{new style}%
\end{Declaration}
-\BeginIndex{Cmd}{CloneTOCEntryStyle}%
With\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} this command you can clone
an existing \PName{style}. This defines a \PName{new style} with the same
attributes and settings like the existing \PName{style}. The package itself
@@ -1596,23 +1603,23 @@ of \PValue{dottedtocline}. The \KOMAScript{} classes use the command to
declare the styles \PValue{part}, \PValue{section}, and \PValue{chapter} or
\PValue{subsection} as a clone of \PValue{tocline} and the style
\PValue{default} new as a clone of \PValue{section} or \PValue{subsection}.%
-\EndIndex{Cmd}{CloneTOCEntryStyle}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{TOCEntryStyleInitCode}\Parameter{style}%
- \Parameter{initial code}\\
+ \Parameter{initial code}%
\Macro{TOCEntryStyleStartInitCode}\Parameter{style}%
\Parameter{initial code}
\end{Declaration}
-\BeginIndex{Cmd}{TOCEntryStyleInitCode}%
-\BeginIndex{Cmd}{TOCEntryStyleStartInitCode}%
Every\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} TOC-entry style has an
initialisation code. This is used whenever a \PName{style} is assigned to an
-TOC-entry using \Macro{DeclareTOCEntryStyle}. This \PName{initial code} should
-never do anything global, because it is also used for local initialisation
-inside other commands like \Macro{DeclareNewTOC}\IndexCmd{DeclareNewTOC}. The
-\PName{initial code} not only defines all attributes of a \PName{style}. It
-also should set the defaults for those attributes.
+TOC-entry using \DescRef{\LabelBase.cmd.DeclareTOCEntryStyle}. This
+\PName{initial code} should never do anything global, because it is also used
+for local initialisation inside other commands like
+\DescRef{\LabelBase.cmd.DeclareNewTOC}\IndexCmd{DeclareNewTOC}. The \PName{initial code} not
+only defines all attributes of a \PName{style}. It also should set the
+defaults for those attributes.
You can use \Macro{TOCEntryStyleStartInitCode} and
\Macro{TOCEntryStyleInitCode} to extend the already existing initialisation
@@ -1623,7 +1630,7 @@ of the existing initialisation code. The \KOMAScript{} classes, e.\,g., are
using \Macro{TOCEntryStyleStartInitCode} to change the filling, font and
vertical distances of style \PValue{part} that is a clone of
\PValue{tocline}. Class \Class{scrbook} and \Class{scrreprt} use
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\CloneTOCEntryStyle{tocline}{section}
\TOCEntryStyleStartInitCode{section}{%
\expandafter\providecommand%
@@ -1632,17 +1639,14 @@ vertical distances of style \PValue{part} that is a clone of
}
\end{lstcode}
to declare \PValue{section} as a modified clone of \PValue{tocline}.%
-\EndIndex{Cmd}{TOCEntryStyleStartInitCode}%
-\EndIndex{Cmd}{TOCEntryStyleInitCode}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{LastTOCLevelWasHigher}\\
- \Macro{LastTOCLevelWasSame}\\
+ \Macro{LastTOCLevelWasHigher}%
+ \Macro{LastTOCLevelWasSame}%
\Macro{LastTOCLevelWasLower}
\end{Declaration}
-\BeginIndex{Cmd}{LastTOCLevelWasHigher}%
-\BeginIndex{Cmd}{LastTOCLevelWasSame}%
-\BeginIndex{Cmd}{LastTOCLevelWasLower}%
At\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} the very beginning entries
with style \PValue{tocline} \Package{tocbasic} executes one of these three
commands depending on \Macro{lastpenalty}. \Macro{LastTOCLevelWasHigher} and
@@ -1656,14 +1660,12 @@ Users should not redefine these commands. Instead of a redefinition you should
change the behaviour of single entry levels using attributes
\PValue{onstartlowerlevel}, \PValue{onstartsamelevel}, and
\PValue{onstarthigherlevel}.%
-\EndIndex{Cmd}{LastTOCLevelWasLower}%
-\EndIndex{Cmd}{LastTOCLevelWasSame}%
-\EndIndex{Cmd}{LastTOCLevelWasHigher}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{TOCLineLeaderFill}\OParameter{filling code}
\end{Declaration}
-\BeginIndex{Cmd}{TOCLineLeaderFill}%
Command\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} has been made to be used
as value of option \Option{linefill} of assigning style \PName{tocline} to a
TOC-entry. It is a line filler between the end of the entry text and the entry
@@ -1674,9 +1676,8 @@ As implied by the name of the command it uses \Macro{leaders} to put the
\PName{filling code}. The distance is defined analogous to the \LaTeX{} kernel
command \Macro{@dottedtocline} by
\Macro{mkern}\Macro{@dotsep}\Unit{\texttt{mu}}.%
-\EndIndex{Cmd}{TOCLineLeaderFill}%
-%
-\EndIndex{}{table of contents>entry}
+\EndIndexGroup
+\EndIndexGroup
\section{Internal Commands for Class and Package Authors}
@@ -1689,7 +1690,6 @@ should not change them!
\begin{Declaration}
\Macro{tocbasic@extend@babel}\Parameter{extension}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@extend@babel}%
The Package \Package{babel}\IndexPackage{babel} (see \cite{package:babel}),
or more specifically a \LaTeX{} kernel that has been extended by the language
management of \Package{babel} writes instructions to change the language
@@ -1702,10 +1702,10 @@ Otherwise the meaning of the argument may change until it will be used really.
Normally this command will be used by default for every file name
\PName{extension} that will be added to the list of known extensions using
-\Macro{addtotoclist}. This may be suppressed using feature
-\PValue{nobabel}\important{\PValue{nobabel}} (see \Macro{setuptoc},
-\autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.setuptoc}). For the
-file name extensions \File{toc}, \File{lof}, and \File{lot} this will be done
+\DescRef{\LabelBase.cmd.addtotoclist}. This may be suppressed using feature
+\PValue{nobabel}\important{\PValue{nobabel}} (see \DescRef{\LabelBase.cmd.setuptoc},
+\autoref{sec:tocbasic.toc}, \DescPageRef{\LabelBase.cmd.setuptoc}). For the file
+name extensions \File{toc}, \File{lof}, and \File{lot} this will be done
automatically by \Package{tocbasic} to avoid double language switching in the
corresponding files.
@@ -1715,19 +1715,19 @@ and so are not in \Package{tocbasic}'s list of known file name extensions, but
nevertheless should be handled by the language change mechanism of
\Package{babel}. The command may be used explicitly for those files. But please
note that this should be done only once per file name extension!%
-\EndIndex{Cmd}{tocbasic@extend@babel}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{tocbasic@starttoc}\Parameter{extension}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@starttoc}
This command is something like the \LaTeX{} kernel macro
\Macro{@starttoc}\IndexCmd{@starttoc}\important{\Macro{@starttoc}}. It is the
-command behind \Macro{listoftoc*} (see \autoref{sec:tocbasic.toc},
-\autopageref{desc:tocbasic.cmd.listoftoc*}). Authors of classes or packages
+command behind \DescRef{\LabelBase.cmd.listoftoc*} (see \autoref{sec:tocbasic.toc},
+\DescPageRef{\LabelBase.cmd.listoftoc*}). Authors of classes or packages
who want to participate from the advantages of \Package{tocbasic} should at
least use this command. Nevertheless it is recommended to use
-\Macro{listoftoc}. Command \Macro{tocbasic@starttoc} internally uses
+\DescRef{\LabelBase.cmd.listoftoc}. Command \Macro{tocbasic@starttoc} internally uses
\Macro{\@starttoc}, but sets
\Length{parskip}\IndexLength{parskip}\important{\Length{parskip}\\
\Length{parindent}\\
@@ -1750,108 +1750,103 @@ if there are no more unused write handles. This may be solved, e.\,g., using
package
\Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile}.
See \autoref{cha:scrwfile} for more information about that package.%
-\EndIndex{Cmd}{tocbasic@starttoc}
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{tocbasic@@before@hook}\\
+ \Macro{tocbasic@@before@hook}%
\Macro{tocbasic@@after@hook}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@@before@hook}%
-\BeginIndex{Cmd}{tocbasic@@after@hook}%
The hook \Macro{tocbasic@@before@hook} will be executed immediately before
reading a auxiliary file for a TOC even before execution of the instructions
-of a \Macro{BeforeStartingTOC} command. It is permitted to extend this hook
-using \Macro{g@addto@macro}\IndexCmd{g@addto@macro}.
+of a \DescRef{\LabelBase.cmd.BeforeStartingTOC} command. It is permitted to
+extend this hook using \Macro{g@addto@macro}\IndexCmd{g@addto@macro}.
Similarly \Macro{tocbasic@@after@hook} will be executed immediately after
reading such an auxiliary file and before execution of instructions of
-\Macro{AfterStartingTOC}. It is permitted to extend this hook using
-\Macro{g@addto@macro}\IndexCmd{g@addto@macro}.
+\DescRef{\LabelBase.cmd.AfterStartingTOC}. It is permitted to extend this hook
+using \Macro{g@addto@macro}\IndexCmd{g@addto@macro}.
\KOMAScript{} uses these hooks, to provide the automatic width calculation of
the place needed by heading numbers. Only classes and packages should use
these hooks. Users\textnote{Attention!} should really use
-\Macro{BeforeStartingTOC} and \Macro{AfterStartingTOC} instead. Authors of
-packages should also favour those commands! These hooks should not be used to
-generate any output!
+\DescRef{\LabelBase.cmd.BeforeStartingTOC} and
+\DescRef{\LabelBase.cmd.AfterStartingTOC} instead. Authors of packages should
+also favour those commands! These hooks should not be used to generate any
+output!
+
+If neither\textnote{Attention!} \DescRef{\LabelBase.cmd.listofeachtoc} nor
+\DescRef{\LabelBase.cmd.listoftoc} nor \DescRef{\LabelBase.cmd.listoftoc*} are
+used for the output of a TOC, the hooks should be executed explicitly.%
+\EndIndexGroup
-If neither\textnote{Attention!} \Macro{listofeachtoc} nor \Macro{listoftoc}
-nor \Macro{listoftoc*} are used for the output of a TOC, the hooks should be
-executed explicitly.%
-\EndIndex{Cmd}{tocbasic@@before@hook}%
-\EndIndex{Cmd}{tocbasic@@after@hook}%
\begin{Declaration}
- \Macro{tocbasic@\PName{extension}@before@hook}\\
+ \Macro{tocbasic@\PName{extension}@before@hook}%
\Macro{tocbasic@\PName{extension}@after@hook}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@\PName{extension}@before@hook}%
-\BeginIndex{Cmd}{tocbasic@\PName{extension}@after@hook}%
-These hooks are processed after \Macro{tocbasic@@before@hook}, respectively
-before \Macro{tocbasic@@after@hook} before and after loading the TOC-file with
+These hooks are processed after \DescRef{\LabelBase.cmd.tocbasic@@before@hook}, respectively
+before \DescRef{\LabelBase.cmd.tocbasic@@after@hook} before and after loading the TOC-file with
the corresponding file \PName{extension}. Authors\textnote{Attention!} of
classes and packages should never manipulate them! But if
-neither\textnote{Attention!} \Macro{listofeachtoc} nor \Macro{listoftoc} nor
-\Macro{listoftoc*} are used for the output of a TOC, the hooks should be
-executed explicitly, if they are defined. Please note that they even can be
-undefined.%
-\EndIndex{Cmd}{tocbasic@\PName{extension}@after@hook}%
-\EndIndex{Cmd}{tocbasic@\PName{extension}@before@hook}%
+neither\textnote{Attention!} \DescRef{\LabelBase.cmd.listofeachtoc} nor
+\DescRef{\LabelBase.cmd.listoftoc} nor \DescRef{\LabelBase.cmd.listoftoc*} are
+used for the output of a TOC, the hooks should be executed explicitly, if they
+are defined. Please note that they even can be undefined.%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{tocbasic@listhead}\Parameter{title}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@listhead}%
-This command is used by \Macro{listoftoc} to set the heading of the TOC,
+This command is used by \DescRef{\LabelBase.cmd.listoftoc} to set the heading of the TOC,
either the default heading or the individually defined heading. If you define
-your own TOC-command not using \Macro{listoftoc} you may use
+your own TOC-command not using \DescRef{\LabelBase.cmd.listoftoc} you may use
\Macro{tocbasic@listhead}. In this case you should define
\Macro{@currext}\important{\Macro{@currext}}\IndexCmd{@currext} to be the file
extension of the corresponding TOC-file before using
\Macro{tocbasic@listhead}.%
-\EndIndex{Cmd}{tocbasic@listhead}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{tocbasic@listhead@\PName{extension}}\Parameter{title}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@listhead@\PName{extension}}%
-This command is used in \Macro{tocbasic@listhead} to set the individual
+This command is used in \DescRef{\LabelBase.cmd.tocbasic@listhead} to set the individual
headings, optional table of contents entry, and running head, if it was
defined. If it was not defined it will be defined and used in
-\Macro{tocbasic@listhead} automatically.
-\EndIndex{Cmd}{tocbasic@listhead@\PName{extension}}%
+\DescRef{\LabelBase.cmd.tocbasic@listhead} automatically.
+\EndIndexGroup
+
\begin{Declaration}
\Macro{tocbasic@addxcontentsline}%
- \Parameter{extension}\Parameter{level}\Parameter{number}\Parameter{text}\\
+ \Parameter{extension}\Parameter{level}\Parameter{number}\Parameter{text}%
\Macro{nonumberline}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@addxcontentsline}%
-\BeginIndex{Cmd}{nonumberline}%
Command\ChangedAt{v3.12}{\Package{tocbasic}} \Macro{tocbasic@addxcontentsline}
uses \Macro{addcontentsline} to either create a numbered or not numbered text
entry to the TOC-file with the given \PName{extension}. Note, all parameters
of \Macro{tocbasic@addxcontentsline} are mandatory. But you may use an empty
\PName{number} argument, if you do not want a number. In this case the
\PName{text} will be prefixed by \Macro{nonumberline} without any argument. In
-the other case, if \PName{number} is not empty, \Macro{numberline} with
-argument \PName{number} will used as usual.
-
-Command \Macro{nonumberline} is redefined inside \Macro{listoftoc} (see
-\autoref{sec:tocbasic.toc}, \autopageref{desc:tocbasic.cmd.listoftoc})
-depending on feature \PValue{numberline} (see \autoref{sec:tocbasic.toc},
-\autopageref{desc:tocbasic.cmd.setuptoc}). This guarantees that changes of the
-feature results in changes of the corresponding TOC immediately at the next
-\LaTeX{} run.%
-\EndIndex{Cmd}{nonumberline}%
-\EndIndex{Cmd}{tocbasic@addxcontentsline}%
+the other case, if \PName{number} is not empty,
+\DescRef{\LabelBase.cmd.numberline} with argument \PName{number} will used as
+usual.
+
+Command \Macro{nonumberline} is redefined inside
+\DescRef{\LabelBase.cmd.listoftoc} (see \autoref{sec:tocbasic.toc},
+\DescPageRef{\LabelBase.cmd.listoftoc}) depending on feature \PValue{numberline}
+(see \autoref{sec:tocbasic.toc}, \DescPageRef{\LabelBase.cmd.setuptoc}). This
+guarantees that changes of the feature results in changes of the corresponding
+TOC immediately at the next \LaTeX{} run.%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{tocbasic@DependOnPenaltyAndTOCLevel}\Parameter{entry level}\\
+ \Macro{tocbasic@DependOnPenaltyAndTOCLevel}\Parameter{entry level}%
\Macro{tocbasic@SetPenaltyByTOCLevel}\Parameter{entry level}
\end{Declaration}
-\BeginIndex{Cmd}{tocbasic@DependOnPenaltyAndTOCLevel}%
-\BeginIndex{Cmd}{tocbasic@SetPenaltyByTOCLevel}%
At\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} the end of TOC-entry style
\PValue{tocline} (see \autoref{sec:tocbasic.tocstyle}) \Macro{penalty} is set
to prohibit page breaks. The used penalty value depends on the \PName{entry
@@ -1871,8 +1866,7 @@ macros \Macro{scr@tso@\PName{entry level}@LastTOCLevelWasHigher},
\Macro{scr@tso@\PName{entry level}@LastTOCLevelWasSame} and
\Macro{scr@tso@\PName{entry level}@LastTOCLevelWasLower} to store the current
values of the options.%
-\EndIndex{Cmd}{tocbasic@SetPenaltyByTOCLevel}%
-\EndIndex{Cmd}{tocbasic@DependOnPenaltyAndTOCLevel}%
+\EndIndexGroup
\section{A Complete Example}
@@ -1888,7 +1882,7 @@ has to be put into a package or class, or has to be placed between
First\textnote{environment} of all, a new floating environment will be
needed. This could simply be done using:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newenvironment{remarkbox}{%
\@float{remarkbox}%
}{%
@@ -1899,7 +1893,7 @@ To the new environment is named \Environment{remarkbox}.
Each\textnote{placement} floating environment has a default
placement. This is build by some of the well known placement options:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcommand*{\fps@remarkbox}{tbp}
\end{lstcode}
So, the new floating environment should be placed by default only either at
@@ -1910,14 +1904,14 @@ type. Environments with the same active bit at the floating type cannot change
their order. Figures and table normally use type~1 and 2. So a figure that
comes later at the source code than a table, may be output earlier than the
table and vica versa.
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcommand*{\ftype@remarkbox}{4}
\end{lstcode}
The new environment has floating type~4, so it may pass figures and floats and
may be passed by those.
The\textnote{number} captions of floating environment also have numbers.
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcounter{remarkbox}
\newcommand*{\remarkboxformat}{%
Remark~\theremarkbox\csname autodot\endcsname}
@@ -1928,12 +1922,12 @@ or the counters of other structural levels. \LaTeX{} itself also defines
\Macro{theremarkbox} with the default Arabic representation of the counter's
value. Afterwards this has been used defining the formatted output of the
counter. Last this formatted output has been used for the output of the
-environment number of the \Macro{caption} command.
+environment number of the \DescRef{maincls.cmd.caption} command.
Floating\textnote{file name extension} environments have lists of themselves
and those need a auxiliary file with name \Macro{jobname} and a file name
extension, the TOC-file\Index{TOC-file}:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcommand*{\ext@remarkbox}{lor}
\end{lstcode}
The file name extension of the TOC-file for the list of
@@ -1942,18 +1936,18 @@ The file name extension of the TOC-file for the list of
This was the definition of the floating environment. But the list of this new
environment's captions is still missing. To reduce the implementation effort
package \Package{tocbasic} will be used for this. This will be loaded using
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\usepackage{tocbasic}
\end{lstcode}
inside of document preambles. Authors of classes or packages would use
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\RequirePackage{tocbasic}
\end{lstcode}
instead.
Now\textnote{extension} we register the file name extension for package
\Package{tocbasic}:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\addtotoclist[float]{lor}
\end{lstcode}
Thereby the owner \PValue{float} has been used, to allude all further
@@ -1962,7 +1956,7 @@ one.
Next\textnote{title} we define a title or heading for the list of
\Environment{remarkbox}es:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcommand*{\listoflorname}{List of Remarks}
\end{lstcode}
You may use package \Package{scrbase} to additionally support titles in other
@@ -1970,20 +1964,20 @@ languages than English.
Also\textnote{entry} a command is needed to define the layout of the entries
to the list of remarks:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcommand*{\l@remarkbox}{\l@figure}
\end{lstcode}
Here simply the entries to the list of remarks get the same layout like the
entries to the list of figures. This would be the easiest solution. A more
explicit would be, e.\,g.,
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\DeclareTOCStyleEntry[level=1,indent=1em,numwidth=1.5em]%
{tocline}{remarkbox}
\end{lstcode}
Additionally\textnote{chapter entry} you may want structure the list of
remarks depending on chapters.
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\setuptoc{lor}{chapteratlist}
\end{lstcode}
The \KOMAScript{} classes provide that feature and maybe other classes do so
@@ -1991,9 +1985,10 @@ too. Unfortunately the standard classes do not.
This\textnote{list of remarks} would already be enough. Now, users may already
select different kinds of headings either using the corresponding options of
-the \KOMAScript{} classes, or \Macro{setuptoc}, e.\,g., with or without entry
-in the table of contents, with or without number. But a simple
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+the \KOMAScript{} classes, or \DescRef{\LabelBase.cmd.setuptoc}, e.\,g., with
+or without entry in the table of contents, with or without number. But a
+simple
+\begin{lstcode}
\newcommand*{\listofremarkboxes}{\listoftoc{lor}}
\end{lstcode}
may make the usage a little bit easier again.
@@ -2005,18 +2000,19 @@ table of contents. Optional even a lower document structure level may be used
for the heading. Running headers are provides with the \KOMAScript{} classes,
the standard classes, and all classes that explicitly support
\Package{tocbasic}. Supporting classes even pay attention to this new list of
-remarks at every new \Macro{chapter}. Even changes of the current language are
-handled inside the list of remarks like they will inside the list of figures
-or inside the list of tables.
+remarks at every new \DescRef{maincls.cmd.chapter}. Even changes of the
+current language are handled inside the list of remarks like they will inside
+the list of figures or inside the list of tables.
Moreover,\textnote{additional features} an author of a package may add more
-features. For example, options to hide \Macro{setuptoc} from the users may be
-added. On the other hand, the \Package{tocbasic} manual may be referenced to
-describe the corresponding features. The advantage of this would be that user
-would get information about new features provides by \Package{tocbasic}. But
-if the user should be able to set the features of the remarks even without
-knowledge about the file name extension \File{lor} a simple
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+features. For example, options to hide \DescRef{\LabelBase.cmd.setuptoc} from
+the users may be added. On the other hand, the \Package{tocbasic} manual may
+be referenced to describe the corresponding features. The advantage of this
+would be that user would get information about new features provides by
+\Package{tocbasic}. But if the user should be able to set the features of the
+remarks even without knowledge about the file name extension \File{lor} a
+simple
+\begin{lstcode}
\newcommand*{\setupremarkboxes}{\setuptoc{lor}}
\end{lstcode}
would be enough to use a list of features argument to
@@ -2033,27 +2029,28 @@ easier.
\begin{Declaration}
\Macro{DeclareNewTOC}\OParameter{options}\Parameter{extension}
\end{Declaration}
-\BeginIndex{Cmd}{DeclareNewTOC}%
This command declares\ChangedAt{v3.06}{\Package{tocbasic}} in one step only a
new TOC, the heading of that TOC, the term used for the TOC-entries, and to
manage the file name \PName{extension}. Additionally optional floating and
non-floating environments may be defined, and inside of both such environments
-\Macro{caption}\important{\Macro{caption}}\IndexCmd{caption} may be used. The
-additional features \Macro{captionabove}\important[i]{%
- \Macro{captionabove}\\
- \Macro{captionbelow}}, \Macro{captionbelow}, and \Environment{captionbeside}
-of the \KOMAScript{} classes (see \autoref{sec:maincls.floats}) may also be
-used inside of those environments.
+\DescRef{maincls.cmd.caption}%
+\important{\DescRef{maincls.cmd.caption}}\IndexCmd{caption} may be used. The
+additional features \DescRef{maincls.cmd.captionabove}\important[i]{%
+ \DescRef{maincls.cmd.captionabove}\\
+ \DescRef{maincls.cmd.captionbelow}}, \DescRef{maincls.cmd.captionbelow}, and
+\DescRef{maincls.env.captionbeside} of the \KOMAScript{} classes (see
+\autoref{sec:maincls.floats}) may also be used inside of those environments.
Argument \PName{extension} is the file name extension of the TOC-file, that
represents the list of something. See \autoref{sec:tocbasic.basics} for more
information about this. This argument is mandatory and must not be empty!
Argument \PName{options} is a comma separated list, like you know it from,
-e.\,g., \Macro{KOMAoptions} (see
+e.\,g., \DescRef{maincls.cmd.KOMAoptions} (see
\autoref{sec:typearea.options}). Nevertheless\textnote{Attention!}, those
-options cannot be set using \Macro{KOMAoptions}\IndexCmd{KOMAoptions}! An
-overview of all available options may be found in
+options cannot be set using
+\DescRef{maincls.cmd.KOMAoptions}\IndexCmd{KOMAoptions}! An overview of all
+available options may be found in
\autoref{tab:tocbasic.DeclareNewTOC-options}.
If\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}} option \Option{tocentrystyle}
@@ -2065,17 +2062,18 @@ i.\,e., \OptionValue{tocentrystyle}{} or
the risk to get a lot of errors while printing that list.
Depending\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
-\ChangedAt[2016/06]{v3.21}{\Package{tocbasic}} on the style of the
-entries to the list of something, you can setup all valid attributes of the
-selected style as part of the \PName{options}. To do so you have to prefix the
-names of the attributes given in \autoref{tab:tocbasic.tocstyle.attributes}
-from \autopageref{tab:tocbasic.tocstyle.attributes} by prefix
+\ChangedAt[2016/06]{v3.21}{\Package{tocbasic}} on the style of the entries to
+the list of something, you can setup all valid attributes of the selected
+style as part of the \PName{options}. To do so you have to prefix the names of
+the attributes given in \autoref{tab:tocbasic.tocstyle.attributes} from
+\autopageref{tab:tocbasic.tocstyle.attributes} by prefix
\PValue{tocentry}. Later changes of the style of the entries can be made using
-\Macro{DeclareTOCStyleEntry}%
-\IndexCmd{DeclareTOCStyleEntry}\important{\Macro{DeclareTOCStyleEntry}}. See
+\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry}%
+\IndexCmd{DeclareTOCStyleEntry}%
+\important{\DescRef{\LabelBase.cmd.DeclareTOCStyleEntry}}. See
\autoref{sec:tocbasic.tocstyle},
-\autopageref{desc:tocbasic.cmd.DeclareTOCStyleEntry} for more information
-about the styles.%
+\DescPageRef{\LabelBase.cmd.DeclareTOCStyleEntry} for more information about
+the styles.%
%
\begin{desclist}
\renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
@@ -2086,17 +2084,17 @@ about the styles.%
}{%
Options for command \Macro{DeclareNewTOC} (\emph{continuation})%
}%
- \entry{\KOption{atbegin}\PName{instructions}%
+ \entry{\OptionVName{atbegin}{instructions}%
\ChangedAt{v3.09}{\Package{tocbasic}}}{%
The \PName{instructions} will be executed at the begin of the floating or
non-floating environment.%
}%
- \entry{\KOption{atend}\PName{instructions}%
+ \entry{\OptionVName{atend}{instructions}%
\ChangedAt{v3.09}{\Package{tocbasic}}}{%
The \PName{instructions} will be executed at the end of the floating or
non-floating environment.%
}%
- \entry{\KOption{counterwithin}\PName{\LaTeX{} counter}}{%
+ \entry{\OptionVName{counterwithin}{\LaTeX{} counter}}{%
If you define a float or non-float, the captions will be numbered and a
counter \PName{type} (see option \Option{type}) will be defined. You may
declare another counter to be the parent \LaTeX{} counter. In this case,
@@ -2109,12 +2107,12 @@ about the styles.%
environments are the value of \PName{type} and for double column floats
the value of \PName{type} with addendum ``\PValue{*}''.%
}%
- \entry{\KOption{floatpos}\PName{float positions}}{%
+ \entry{\OptionVName{floatpos}{float positions}}{%
The default floating position of the float. If no float position was
given, ``tbp'' will be used like the standard classes do for figures and
tables.%
}%
- \entry{\KOption{floattype}\PName{number}}{%
+ \entry{\OptionVName{floattype}{number}}{%
The numerical float type of the defined floats. Float types with common
bits cannot be reordered. At the standard classes figures has float type 1
and tables has float type 2. If no float type was given, 16 will be used.%
@@ -2123,7 +2121,7 @@ about the styles.%
If set, the names will be even defined, if they where already defined
before.%
}%
- \entry{\KOption{hang}\PName{length}}{%
+ \entry{\OptionVName{hang}{length}}{%
\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
\ChangedAt[2015/12]{v3.21}{\Package{tocbasic}}%
This option is deprecated since \KOMAScript~3.20. Now, the amount of the
@@ -2132,11 +2130,11 @@ about the styles.%
\Option{tocentrystyle}. The styles of \KOMAScript{} provide an attribute
\PValue{numwidth}. If the used style has such an attribute,
\Macro{DeclareNewTOC} will initialise it with 1.5\Unit{em}. You can change
- the real \PName{value} using \KOption{tocentrynumwidth}\PName{value}. The
+ the real \PName{value} using \OptionVName{tocentrynumwidth}{value}. The
\KOMAScript{} classed for example use
\OptionValue{tocentrynumwidth}{2.3em}.%
}%
- \entry{\KOption{indent}\PName{length}}{%
+ \entry{\OptionVName{indent}{length}}{%
\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
\ChangedAt[2015/12]{v3.21}{\Package{tocbasic}}%
This option is deprecated since \KOMAScript~3.20. Now, the amount of
@@ -2145,11 +2143,11 @@ about the styles.%
\Option{tocentrystyle}. The styles of \KOMAScript{} provide an attribute
\PValue{indent}. If the used style has such an attribute,
\Macro{DeclareNewTOC} will initialise it with 1\Unit{em}. You can change
- the real \PName{value} using \KOption{tocentryindent}\PName{value}. The
+ the real \PName{value} using \OptionVName{tocentryindent}{value}. The
\KOMAScript{} classed for example use
\OptionValue{tocentrynumwidth}{1.5em}.%
}%
- \entry{\KOption{level}\PName{number}}{%
+ \entry{\OptionVName{level}{number}}{%
\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
\ChangedAt[2015/12]{v3.21}{\Package{tocbasic}}%
This option is deprecated since \KOMAScript~3.20. Now, the level of the
@@ -2157,14 +2155,14 @@ about the styles.%
of the TOC-entry style given by option
\Option{tocentrystyle}. Nevertheless all styles have an attribute
\PValue{level} and \Macro{DeclareNewTOC} initialises it with 1. You can
- change the real \PName{value} using \KOption{tocentrylevel}\PName{value}.%
+ change the real \PName{value} using \OptionVName{tocentrylevel}{value}.%
}%
- \entry{\KOption{listname}\PName{string}}{%
+ \entry{\OptionVName{listname}{string}}{%
The name of the TOC. If not given the value of \PValue{types} with upper
case first char using \Macro{MakeUppercase}\IndexCmd{MakeUppercase}
prefixed by ``List of '' will be used.%
}%
- \entry{\KOption{name}\PName{string}}{%
+ \entry{\OptionVName{name}{string}}{%
The name of an element. If no name is given, the value of \PValue{type}
with upper case first char will be used.%
}%
@@ -2172,11 +2170,11 @@ about the styles.%
If set, a non floating environment will be defined. The name of the
environment is the value of \PName{type} with attached ``\PValue{-}''.%
}%
- \entry{\KOption{owner}\PName{string}}{%
+ \entry{\OptionVName{owner}{string}}{%
The owner as described in the sections before. If no owner was given owner
\PValue{float} will be used.%
}%
- \entry{\KOption{tocentrystyle}\PName{TOC-entry style}}{%
+ \entry{\OptionVName{tocentrystyle}{TOC-entry style}}{%
\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
\PName{TOC-entry style} is the style that should be used for all entries
into the TOC corresponding to the \PName{extension}. The name of the entry
@@ -2188,7 +2186,7 @@ about the styles.%
the styles and their attributes see \autoref{sec:tocbasic.tocstyle} from
\autopageref{sec:tocbasic.tocstyle}.%
}%
- \entry{\KOption{tocentry\PName{style-option}}\PName{value}}{%
+ \entry{\OptionVName{tocentry\PName{style-option}}{value}}{%
\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}}%
Additional options depending on the \PName{TOC-entry style} given by
\Option{tocentrystyle}. See \autoref{sec:tocbasic.tocstyle},
@@ -2198,12 +2196,12 @@ about the styles.%
attributes of the predefined TOC-entry styles of package
\Package{tocbasic}, that can be used as \PName{style-option}.%
}%
- \entry{\KOption{type}\PName{string}}{%
+ \entry{\OptionVName{type}{string}}{%
sets the type of the new declared TOC. The type will be used e.\,g. to
defined a \Macro{listof}\PName{string}. If no type is set up the extension
from the mandatory argument will be used.%
}%
- \entry{\KOption{types}\PName{string}}{%
+ \entry{\OptionVName{types}{string}}{%
the plural of the type. If no plural was given the value of \PValue{type}
with attached ``s'' will be used.%
}%
@@ -2232,7 +2230,7 @@ about the styles.%
defined. If the package should use a default for the floating type, option
Option{floattype} may be omitted. If option \Option{nonfloat} will be used
additionally, then a non-floating environment \Environment{remarkbox-} will
- be also defined. You may use \Macro{caption}\IndexCmd{caption} inside of
+ be also defined. You may use \DescRef{maincls.cmd.caption}\IndexCmd{caption} inside of
that non-floating environment as usual for floating environments.
\hyperref[tab:tocbasic.comparison]{Figure~\ref*{tab:tocbasic.comparison}}
shows a comparison of the commands, counters and environments of the
@@ -2256,18 +2254,18 @@ about the styles.%
& columns spanning floating environments of the respective types\\[1ex]
\Counter{remarkbox} & \Counter{figure}
& \Option{type}, \Option{float}
- & counter used by \Macro{caption}\\[1ex]
+ & counter used by \DescRef{maincls.cmd.caption}\\[1ex]
\Macro{theremarkbox} & \Macro{thefigure}
& \Option{type}, \Option{float}
& output command to the respective counters\\[1ex]
- \Macro{remarkboxformat} & \Macro{figureformat}
+ \Macro{remarkboxformat} & \DescRef{maincls.cmd.figureformat}
& \Option{type}, \Option{float}
& formatting command to the respective counters used by
- \Macro{caption}\\[1ex]
+ \DescRef{maincls.cmd.caption}\\[1ex]
\Macro{remarkboxname} & \Macro{figurename}
& \Option{type}, \Option{float}, \Option{name}
- & names used in the label of \Macro{caption}\\[1ex]
- \Macro{listofremarkboxes} & \Macro{listoffigures}
+ & names used in the label of \DescRef{maincls.cmd.caption}\\[1ex]
+ \Macro{listofremarkboxes} & \DescRef{maincls.cmd.listoffigures}
& \Option{types}, \Option{float}
& command to show the list of the respective environments\\[1ex]
\Macro{listremarboxname} & \Macro{listfigurename}
@@ -2314,11 +2312,10 @@ Users of \Package{hyperref} should always use option
\Package{hyperref} usually has a problem with the
\Macro{MakeUppercase}\IndexCmd{MakeUppercase} command that is used to change
the case of the first letter of \Option{types} in the name of the list.%
-\EndIndex{Cmd}{DeclareNewTOC}%
-\EndIndex{Package}{tocbasic}%
-\EndIndex{}{table of contents}%
-\EndIndex{}{list>of contents}%
-\EndIndex{}{file>extension}%
+\EndIndexGroup
+%
+\EndIndexGroup
+%
\endinput
%%% Local Variables: