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.tex52
1 files changed, 40 insertions, 12 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 7222a34c22..816c890859 100644
--- a/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex
+++ b/macros/latex/contrib/koma-script/source-doc/english/tocbasic.tex
@@ -1,6 +1,6 @@
% ======================================================================
% tocbasic.tex
-% Copyright (c) Markus Kohm, 2002-2019
+% Copyright (c) Markus Kohm, 2002-2020
%
% 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-2019
+% Copyright (c) Markus Kohm, 2002-2020
%
% 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: 2019-12-03 09:41:21 +0100 (Tue, 03 Dec 2019) $
+ [$Date: 2020-06-11 16:57:03 +0200 (Thu, 11 Jun 2020) $
KOMA-Script guide (package tocbasic)]
-% Date of the translated German file: 2019-12-03
+% Date of the translated German file: 2020-06-11
\translator{Markus Kohm\and Arndt Schubert\and Karl Hagen}
@@ -1027,10 +1027,11 @@ Currently, \Package{tocbasic} defines the following entry styles:
\PValue{section} and \PValue{subsection} using this style, but add extra
\PName{initial code} to the clones to change their defaults.
- The style supports 18\important{\PValue{level}, \PValue{beforeskip},
- \PValue{breakafternumber}, \PValue{dynnumwidth}, \PValue{entryformat},
- \PValue{entrynumberformat}, \PValue{indent}, \PValue{linefill},
- \PValue{numsep}, \PValue{numwidth}, \PValue{onstarthigherlevel},
+ The style supports 20\important{\PValue{level}, \PValue{beforeskip},
+ \PValue{breakafternumber}, \PValue{dynindent}, \PValue{dynnumwidth},
+ \PValue{entryformat}, \PValue{entrynumberformat}, \PValue{indent},
+ \PValue{indentfollows}, \PValue{linefill}, \PValue{numsep},
+ \PValue{numwidth}, \PValue{onstarthigherlevel},
\PValue{onstartlowerlevel}, \PValue{onstartsamelevel},
\PValue{pagenumberbox}, \PValue{pagenumberformat},
\PValue{pagenumberwidth}, \PValue{raggedentrytext},
@@ -1205,7 +1206,8 @@ Currently, \Package{tocbasic} defines the following entry styles:
\item[\PValue{toctext}]\ChangedAt{v3.27}{\Package{tocbasic}}%
is a special feature. While all other styles produce one paragraph per
entry, this one produces one paragraph for all successive entries of this
- style. With 13\important{\PValue{afterpar}, \PValue{entryformat},
+ style. With 14\important{\PValue{afterpar}, \PValue{beforeskip},
+ \PValue{entryformat},
\PValue{entrynumberformat}, \PValue{indent}, \PValue{numsep},
\PValue{onendentry}, \PValue{onendlastentry}, \PValue{onstartentry},
\PValue{onstartfirstentry}, \PValue{pagenumberformat},
@@ -1279,10 +1281,12 @@ the form \Option{\PName{key}:=\PName{entry level}} for all options of the
\PName{entry level} will be copied. For example, you can copy the current
indent of the \PValue{figure} level using \OptionValue{indent:}{figure}. For
options that expect a length or integer value, you can also use
-\Option{\PName{key}+=\PName{value}} to add\PName{value} to the current setting
+\Option{\PName{key}+=\PName{value}} to add \PName{value} to the current setting
of the \PName{key}. To subtract simply, you can use a negative \PName{value}.
For example, with \OptionValue{indent+}{1cm} you can increase the indent by
-1\Unit{cm}.
+1\Unit{cm}. For options that expect a list value, you can use
+\Option{\PName{key}+=\PName{value}} to append \PName{value} to the current
+setting of the \PName{key}.
If\ChangedAt{v3.21}{\Package{tocbasic}} you use these attributes as
options to \DescRef{\LabelBase.cmd.DeclareNewTOC} (see
@@ -1333,6 +1337,12 @@ Finally, using \Macro{DeclareTOCStyleEntry} will define the internal command
undefined, \PValue{section} is initialised with \texttt{1em plus 1pt}
instead. The initial value for all other levels is \texttt{0pt plus
.2pt}.%
+
+ In\ChangedAt{v3.31}{\Package{tocbasic}} the style \PValue{toctext} the
+ vertical space is inserted before the paragraph if it is the first entry
+ in the paragraph. It is ignored for all other entries in the paragraph. If
+ the initialization takes place via this style, \texttt{0pt} is used as
+ default.%
}%
\entry{\OptionVName{breakafternumber}{switch}}{%
\PName{switch} is one of the values for simple switches from
@@ -1344,7 +1354,7 @@ Finally, using \Macro{DeclareTOCStyleEntry} will define the internal command
false for the \PValue{tocline} style.
If\textnote{Attention!} the \Option{numberline} feature has been activated
- for a content list (see \DescRef{\LabelBase.cmd.setuptoc},
+ for a content list (see \DescRef{\LabelBase.cmd.setuptoc},
\autoref{sec:tocbasic.toc}, \DescPageRef{\LabelBase.cmd.setuptoc}), as is
the case with the \KOMAScript{} classes when the
\OptionValueRef{maincls}{toc}{numberline}%
@@ -1352,6 +1362,15 @@ Finally, using \Macro{DeclareTOCStyleEntry} will define the internal command
unnumbered entries will nevertheless have a (by default empty) number line
using the formatting of \Option{entrynumberformat}.%
}%
+ \entry{\OptionVName{dynindent}{switch}}{%
+ \ChangedAt{v3.31}{\Package{tocbasic}}%
+ \PName{switch} is one of the values for simple switches from
+ \autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. If the
+ switch is active with the \PValue{tocline} style, the \PValue{indent}
+ attribute only specifies a minimum value. The maximum value is determined
+ by the number width and the indentation of the levels specified via
+ \PValue{indentfollows}.%
+ }%
\entry{\OptionVName{dynnumwidth}{switch}}{%
\PName{switch} is one of the values for simple switches from
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. If the
@@ -1439,6 +1458,15 @@ Finally, using \Macro{DeclareTOCStyleEntry} will define the internal command
classes. For all other levels, the initialisation is done with the value
of \Macro{\PName{entry level}numdepth}, if this is defined.%
}%
+ \entry{\OptionVName{indentfollows}{list of levels}}{%
+ \ChangedAt{v3.31}{\Package{tocbasic}}%
+ If \Option{dynindent} is set with style \PValue{tocline}, the
+ comma-separated list of level names specified here is used to determine
+ the actual indentation. Levels whose names begin with ``\texttt{sub}''
+ will be initialized with the name without this prefix. The \KOMAScript{}
+ classes also automatically set appropriate values for the levels
+ \PValue{section} and \PValue{paragraph}.%
+ }%
\entry{\OptionVName{linefill}{code}}{%
With the \PValue{tocline} style, you can change what is used to fill the
space between the end of the entry text and the page number. The