summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex')
-rw-r--r--macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex96
1 files changed, 56 insertions, 40 deletions
diff --git a/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex b/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex
index bd34f48969..7222a34c22 100644
--- a/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex
+++ b/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex
@@ -46,10 +46,10 @@
% ======================================================================
\KOMAProvidesFile{tocbasic.tex}
- [$Date: 2019-10-10 09:50:23 +0200 (Thu, 10 Oct 2019) $
+ [$Date: 2019-12-03 09:41:21 +0100 (Tue, 03 Dec 2019) $
KOMA-Script guide (package tocbasic)]
-% Date of the translated German file: 2019-10-09
+% Date of the translated German file: 2019-12-03
\translator{Markus Kohm\and Arndt Schubert\and Karl Hagen}
@@ -105,18 +105,18 @@ figures and list of tables, respectively. For the table of contents,
\KOMAScript{} uses the file name of the class.
\begin{Declaration}
- \Macro{ifattoclist}\Parameter{extension}\Parameter{then code}%
+ \Macro{Ifattoclist}\Parameter{extension}\Parameter{then code}%
\Parameter{else code}
\end{Declaration}
-This command tests whether or not the \PName{extension} already exists in the
-list of known file extensions. If the \PName{extension} is already known, the
-\PName{then code} will be executed. Otherwise, the \PName{else code} will be
-executed.
+This\ChangedAt{v3.28}{\Package{tocbasic}} command tests whether or not the
+\PName{extension} already exists in the list of known file extensions. If the
+\PName{extension} is already known, the \PName{then code} will be
+executed. Otherwise, the \PName{else code} will be executed.
\begin{Example}
Suppose you want to know if the file name extension ``\File{foo}'' is
already in use in order to report an error because it cannot be used:
\begin{lstcode}
- \ifattoclist{foo}{%
+ \Ifattoclist{foo}{%
\PackageError{bar}{%
extension `foo' already in use%
}{%
@@ -147,12 +147,11 @@ argument, \Package{tocbasic} tries to determine the file name of the class or
package currently being processed and saves it as the owner.
This\textnote{Attention!} procedure only works if you call
\Macro{addtotoclist} while loading a class or package. It will fail if a user
-calls \Macro{addtotoclist} afterwards. In this case, the owner is set to
-``\PValue{.}''.
+calls \Macro{addtotoclist} afterwards. In this case, the owner is empty.
Note\textnote{Attention!} that passing an empty \PName{owner} argument is not
-the same as completely omitting the optional argument, including the square
-brackets. An empty argument would also result in an empty owner.
+always the same as completely omitting the optional argument, including the
+square brackets. An empty argument would always result in an empty owner.
\begin{Example}
Suppose you want to add the extension ``\File{foo}'' to the list of known
file extensions while loading your package with the file name
@@ -202,11 +201,10 @@ specify the category ``\PValue{float}'' instead of ``\PValue{float.sty}'' as
the \PName{owner}. In this case, the \KOMAScript{}
options\important{\DescRef{maincls.option.listof}}%
\IndexOption{listof~=\PName{setting}} for the list of figures and the list of
-tables would also affect your content lists because these lists are already
-added to the list of known file extensions at the time the option is set, and
-\KOMAScript{} associates the file extensions ``\PValue{lof}'' for the list of
-figures and ``\PValue{lot}'' for the list of tables with the owner
-``\PValue{float}'' and sets the options for this owner.
+tables would also affect your content lists because \KOMAScript{} associates
+the file extensions ``\PValue{lof}'' for the list of figures and
+``\PValue{lot}'' for the list of tables with the owner ``\PValue{float}'' and
+sets the options for this owner.
By the way, the \hyperref[cha:scrhack]{\Package{scrhack}}%
\IndexPackage{scrhack}\important{\hyperref[cha:scrhack]{\Package{scrhack}}}
@@ -258,11 +256,13 @@ See the description of \DescRef{\LabelBase.cmd.tocbasic@extend@babel} in
\end{Declaration}
This command removes the \PName{extension} from the list of known extensions.
If the optional argument, \OParameter{owner}, is given, the \PName{extension}
-will only be removed if it was added by this \PName{owner}. See
-\DescRef{\LabelBase.cmd.addtotoclist} for an explanation of how the list owner
-is determined if the optional argument is omitted. If you specify an empty
-\PName{owner}, the owner is not tested and the \PName{extension} is removed
+will only be removed if it was added by this \PName{owner}.
+% TODO: Fix new translation
+This also applies to the empty \PName{owner}. If, on the other hand, no
+\OParameter{owner} is specified at all and the square brackets are also
+omitted, the owner is not tested and the \PName{extension} is removed
regardless of the owner.%
+% :ODOT
\EndIndexGroup
@@ -777,13 +777,13 @@ The \KOMAScript{} classes recognize an additional feature:
top-level structure to use the one-column mode automatically, you can
use
\begin{lstcode}
- \ifundefinedorrelax{chapter}{}{%
+ \Ifundefinedorrelax{chapter}{}{%
\setuptoc{loa}{onecolumn}%
}
\end{lstcode}
- Using \DescRef{scrbase.cmd.ifundefinedorrelax} requires the
+ Using \DescRef{scrbase.cmd.Ifundefinedorrelax} requires the
\Package{scrbase} package (see \autoref{sec:scrbase.if},
- \DescPageRef{scrbase.cmd.ifundefinedorrelax}).
+ \DescPageRef{scrbase.cmd.Ifundefinedorrelax}).
Even\textnote{Hint!} if your package will be used with another class, it
does not hurt to set these features. To the contrary, if another class also
@@ -797,14 +797,14 @@ of effort to implement and which are therefore missing in many packages.%
\begin{Declaration}
- \Macro{iftocfeature}\Parameter{extension}\Parameter{feature}%
+ \Macro{Iftocfeature}\Parameter{extension}\Parameter{feature}%
\Parameter{then code}\Parameter{else code}
\end{Declaration}
-You can use this command to test if a \PName{feature} was set for the given
-file \PName{extension}. If so the \PName{then code} will be executed,
-otherwise the \PName{else code} will be. This can be useful, for example, if
-you define your own heading command using
-\DescRef{\LabelBase.cmd.deftocheading} but want to support the features
+You\ChangedAt{v3.28}{\Package{tocbasic}} can use this command to test if a
+\PName{feature} was set for the given file \PName{extension}. If so the
+\PName{then code} will be executed, otherwise the \PName{else code} will
+be. This can be useful, for example, 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
@@ -1576,8 +1576,10 @@ Finally, using \Macro{DeclareTOCStyleEntry} will define the internal command
followed by \Macro{normalfont}\Macro{normalsize}.
The initial \PName{command} of entry level \PValue{part} prints the
- argument in \Macro{large}\Macro{bfseries}. The initial \PName{command} of
- all other levels prints the argument in
+ argument in \Macro{large}\Macro{bfseries} and of entry level
+ \PValue{chapter} in \Macro{bfseries}. For classes without
+ \Macro{l@chapter} \PValue{section} also uses \Macro{bfseries}. The initial
+ \PName{command} of all other levels prints the argument in
\Macro{normalfont}\Macro{normalcolor}.%
}%
\entry{\OptionVName{pagenumberwidth}{length}}{%
@@ -2005,10 +2007,12 @@ authors should never change them under any circumstances! If
neither\textnote{Attention!} \DescRef{\LabelBase.cmd.listofeachtoc} nor
\DescRef{\LabelBase.cmd.listoftoc} nor \DescRef{\LabelBase.cmd.listoftoc*} are
used to output a content list, the hooks should nevertheless be called, if
-they are defined. These commands can be undefined. For an appropriate test,
-see \DescRef{scrbase.cmd.scr@ifundefinedorrelax}%
-\IndexCmd{scr@ifundefinedorrelax} in \autoref{sec:scrbase.if},
-\DescPageRef{scrbase.cmd.scr@ifundefinedorrelax}.%
+they are defined. These commands can be undefined.%
+\iffalse % With current LaTeX you can simply use \@ifundefined
+For an appropriate test, see \DescRef{scrbase.cmd.Ifundefinedorrelax}%
+\IndexCmd{Ifundefinedorrelax} in \autoref{sec:scrbase.if},
+\DescPageRef{scrbase.cmd.Ifundefinedorrelax}.%
+\fi%
\EndIndexGroup
@@ -2161,8 +2165,8 @@ Now\textnote{extension} we register the file name extension with the
\begin{lstcode}
\addtotoclist[float]{lor}
\end{lstcode}
-We use \PValue{float} as the owner so that all subsequent \KOMAScript{}
-options that relate to lists of floating environments also apply to the new
+We use \PValue{float} as the owner so that all options of \KOMAScript{}
+classes that relate to lists of floating environments also apply to the new
content list.
Next\textnote{title} we define a title or heading for this content list:
@@ -2424,7 +2428,7 @@ the styles.%
name of the entry level is given by the \Option{type} option. In addition
to the options in this table, all attributes of the \PName{TOC-entry
style} can be used as options. To do so, you have to prefix the name of
- such an attribute with \PValue{toc}. For example, you can change the
+ such an attribute with \PValue{tocentry}. For example, you can change the
numerical level of the entries using the \Option{tocentrylevel} option.
For more information about the styles and their attributes see
\autoref{sec:tocbasic.tocstyle}, starting on
@@ -2564,7 +2568,19 @@ Otherwise they may get an error message because \Package{hyperref} usually has
a problem with the \Macro{MakeUppercase}\IndexCmd{MakeUppercase} command that
is needed to convert the first letter of \Option{types} to upper case.%
\EndIndexGroup
-%
+
+
+\section{Obsolete Befehle}
+\seclabel{obsolete}
+
+% TODO: new translation
+Prior releases of \Package{tocbasic} provide some commands that has been
+renamed, because of a statement of The \LaTeX{} Project Team. Those deprecated
+commands should not be used any longer.
+% :ODOT
+
+\LoadNonFree{tocbasic}{0}%
+%
\EndIndexGroup
%
\endinput