summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source/tocbasic.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source/tocbasic.dtx')
-rw-r--r--macros/latex/contrib/koma-script/source/tocbasic.dtx701
1 files changed, 315 insertions, 386 deletions
diff --git a/macros/latex/contrib/koma-script/source/tocbasic.dtx b/macros/latex/contrib/koma-script/source/tocbasic.dtx
index 90a27fd670..70d19e7ec1 100644
--- a/macros/latex/contrib/koma-script/source/tocbasic.dtx
+++ b/macros/latex/contrib/koma-script/source/tocbasic.dtx
@@ -1,7 +1,7 @@
% \iffalse meta-comment
% ======================================================================
% tocbasic.dtx
-% Copyright (c) Markus Kohm, 2008-2020
+% Copyright (c) Markus Kohm, 2008-2022
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -17,44 +17,8 @@
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
-% ----------------------------------------------------------------------
-% tocbasic.dtx
-% Copyright (c) Markus Kohm, 2008-2020
-%
-% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
-% Version 1.3c, verteilt und/oder veraendert werden.
-% Die neuste Version dieser Lizenz ist
-% http://www.latex-project.org/lppl.txt
-% und Version 1.3c ist Teil aller Verteilungen von LaTeX
-% Version 2005/12/01 oder spaeter und dieses Werks.
-%
-% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
-% (allein durch den Autor verwaltet).
-%
-% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
-%
-% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
-% \fi
-%
-% \CharacterTable
-% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
-% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
-% Digits \0\1\2\3\4\5\6\7\8\9
-% Exclamation \! Double quote \" Hash (number) \#
-% Dollar \$ Percent \% Ampersand \&
-% Acute accent \' Left paren \( Right paren \)
-% Asterisk \* Plus \+ Comma \,
-% Minus \- Point \. Solidus \/
-% Colon \: Semicolon \; Less than \<
-% Equals \= Greater than \> Question mark \?
-% Commercial at \@ Left bracket \[ Backslash \\
-% Right bracket \] Circumflex \^ Underscore \_
-% Grave accent \` Left brace \{ Vertical bar \|
-% Right brace \} Tilde \~}
-%
-% \iffalse
-%%% From File: $Id: tocbasic.dtx 3617 2021-10-12 09:21:01Z kohm $
+%%% From File: $Id: tocbasic.dtx 3689 2022-02-10 09:53:38Z kohm $
%<identify>%%% (run: identify)
%<prepare>%%% (run: prepare)
%<option>%%% (run: option)
@@ -65,9 +29,9 @@
\ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
\begingroup
\def\filedate$#1: #2-#3-#4 #5${\gdef\filedate{#2/#3/#4}}
- \filedate$Date: 2021-10-12 11:21:01 +0200 (Tue, 12 Oct 2021) $
+ \filedate$Date: 2022-02-10 10:53:38 +0100 (Do, 10. Feb 2022) $
\def\filerevision$#1: #2 ${\gdef\filerevision{r#2}}
- \filerevision$Revision: 1962 $
+ \filerevision$Revision: 3689 $
\endgroup
\ProvidesFile{tocbasic.dtx}[\filedate\space\filerevision\space
%</dtx>
@@ -118,78 +82,75 @@
\let\endbatchfile\relax
\fi
\endbatchfile
-\documentclass[parskip=half-]{scrdoc}
-\usepackage[english]{babel}
-\usepackage{array}
-\usepackage{listings}
-\lstset{breaklines,prebreak=\mbox{$\hookleftarrow$},language=[LaTeX]TeX,
- basicstyle=\small}
-\lstnewenvironment{lstcode}[1][]{%
- \lstset{breaklines,prebreak=\mbox{$\hookleftarrow$},language=[LaTeX]TeX,
- basicstyle=\ttfamily\small,#1}%
-}{}
-\lstnewenvironment{lstoutput}[1][]{}{}
-\CodelineIndex
-\RecordChanges
-\GetFileInfo{tocbasic.dtx}
-\sloppy
+\documentclass[USenglish]{koma-script-source-doc}
+\usepackage{babel}
+\setcounter{StandardModuleDepth}{2}
\begin{document}
-\DocInput{\filename}
+\DocInput{tocbasic.dtx}
\end{document}
+%</dtx>
% \fi
%
-% \title{\KOMAScript{} \partname\ \texttt{\filename}%
-% \thanks{Diese Datei ist Version \fileversion\ von \texttt{\filename}.}}
-% \date{\filedate}
-% \author{Markus Kohm\thanks{mailto:komascript(at)gmx.info}}
+% \changes{v3.36}{2022/02/10}{switch over from \cls*{scrdoc} to
+% \cls*{koma-script-source-doc}}
+% \changes{v3.36}{2022/02/10}{require package \pkg*{scrlogo} instead of
+% defining \cs{KOMAScript}}
+%
+% \GetFileInfo{tocbasic.dtx}
+% \title{Handling of Tables and Lists of Contents with
+% \href{https://komascript.de}{\KOMAScript} Package \pkg*{tocbasic}}
+% \author{\href{mailto:komascript@gmx.info}{Markus Kohm}}
+% \date{Revision \fileversion{} of \filedate}
% \maketitle
% \begin{abstract}
-% The main purpose of package \textsf{tocbasic} is to provide features for
+% The main purpose of package \pkg*{tocbasic} is to provide features for
% authors of classes and packages to create own tables or lists of contents
% like the list of figures and the list of tables and thereby allow other
% classes or packages some types of control over these. For examples package
-% \textsf{tocbasic} delegates language control of all these tables and lists
-% of contents to package \textsf{babel}. So automatic change of language
+% \pkg*{tocbasic} delegates language control of all these tables and lists
+% of contents to package \pkg{babel}. So automatic change of language
% will be provided inside all these tables and lists of contents. Using
-% \textsf{tocbasic} will exculpate authors of classes and packages from
+% \pkg*{tocbasic} will exculpate authors of classes and packages from
% implementation of such features.
%
-% \KOMAScript{} itself uses \textsf{tocbasic} not only for the table of
+% \KOMAScript{} classes use \pkg*{tocbasic} not only for the table of
% contents but also for the already mentioned lists of figures and tables.
% \end{abstract}
-%
% \tableofcontents
%
-% \iffalse
-%</dtx>
-% \fi
+% \section{User Manual}
%
-% \StopEventually{\PrintIndex\PrintChanges}
+% You can find the user manuals of \pkg*{tocbasic} in the \KOMAScript{}
+% manual, either the German \file{scrguide} or the English \file{scrguien}.
+%
+% \MaybeStop{\PrintIndex}
%
%
% \section{Implementation}
% \label{sec:implementation}
%
-% All macros with prefix \texttt{tb@} or \texttt{@} are internal macros and
-% should not be used by package and class authors. Macros with prefix
-% \texttt{tocbasic@} are internal macros, that may be used by class and
-% packages authors. Macros without \texttt{@} are interface macros and may be
-% used by class and package authors and users.
+% \begin{macrocode}
+%<*package>
+% \end{macrocode}
+%
+% All macros with prefix \cs{tb@} or \cs{@} are internal macros and should not
+% be used by package and class authors. Macros with prefix \cs{tocbasic@} are
+% internal macros, that may be used by class and packages authors. Macros
+% without \texttt{@} are interface commands and may be used by class and
+% package authors and users.
%
-% Note: Parts of the implementation of package \textsf{tocbasic} are
-% out-sourced into file \texttt{scrkernel-tocbasic.dtx}.
+% Note: Parts of the implementation of package \pkg*{tocbasic} are
+% out-sourced into file \file{scrkernel-tocbasic.dtx}.
%
-% \iffalse
-%<*package>
-% \fi
%
% \subsection{Options}
% \label{sec:options}
%
% There are no options because the package should be used by class and package
% authors not by users. So the package will be loaded using
-% \cs{RequiresPackage}. Using different options by different packages would
-% result in an option clash.
+% \cs{RequirePackage}. Using different options by different packages would
+% result in an option clash. Nevertheless, the not existing options are
+% processed.
% \begin{macrocode}
%<*option>
\ProcessOptions\relax
@@ -197,10 +158,10 @@
% \end{macrocode}
%
%
-% \subsection{Required Packages}
+% \subsection{Required packages}
% \label{sec:packages}
%
-% Package \textsf{scrbase} is needed to process all macro options. As long as
+% Package \pkg*{scrbase} is needed to process all macro options. As long as
% no package options are provided, the \texttt{body}-run is early enough to
% load it.
% \begin{macrocode}
@@ -213,22 +174,22 @@
%
%
%
-% \subsection{Unwanted Packages}
+% \subsection{Unwanted packages}
% \label{sec:unpackages}
%
% There are packages, that are not recommended to be used together with
-% \textsf{tocbasic}:
+% \pkg*{tocbasic}:
% \begin{macrocode}
%<*body>
% \end{macrocode}
% \begin{description}
-% \item[\textsf{multitoc}:] This package implements multi-column ToCs using
-% \textsf{multicol}. Unfortunately there is a bug in that package, that
-% disables all extensions but \texttt{toc}, \texttt{lof} and \texttt{lot} and
+% \item[\pkg{multitoc}:] This package implements multi-column ToCs using
+% \pkg{multicol}. Unfortunately there is a bug in that package, that
+% disables all extensions but \file{toc}, \file{lof} and \file{lot} and
% even these if the corresponding option has not been set.
% \begin{macrocode}
\AfterPackage*{multitoc}{%
- \@ifpackagelater{multitoc}{2018/08/31}{}{%
+ \@ifpackagelater{multitoc}{2022/02/10}{}{%
\PackageWarningNoLine{tocbasic}{%
Usage of package `multitoc' is not recommended!\MessageBreak
Note, this package generally results in empty ToCs\MessageBreak
@@ -257,7 +218,7 @@
% \end{macrocode}
%
%
-% \subsection{Having a List of All Tocs}
+% \subsection{Having a list of all toc-files}
% \label{sec:listoftocs}
%
% If we have a list of all toc-files we may do commands for all
@@ -280,15 +241,12 @@
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{\ifattoclist}
-% \changes{v3.28}{2019/11/19}{renamed to \cs{Ifattoclist}}%^^A
-% \begin{macro}{\Ifattoclist}
-% \changes{v3.28}{2019/11/19}{renamed from \cs{ifattoclist}}%^^A
-% This command tests, if an extension is already at the list of
-% toc-files. The extension has to be the first argument. The second argument
-% will be done, if the extension is already at the list of toc-files. The
-% third argument will be done, if the extension is at the list of toc-files
-% not yet.
+% \begin{command}{\ifattoclist,\Ifattoclist}
+% \changes{v3.28}{2019/11/19}{\cs{ifattoclist} renamed to \cs{Ifattoclist}}
+% This command tests, if an extension is already at the list of toc-files. The
+% extension has to be the first argument. The second argument will be done, if
+% the extension is already at the list of toc-files. The third argument will
+% be done, if the extension is at the list of toc-files not yet.
% \begin{macrocode}
\providecommand*{\ifattoclist}{%
\PackageWarning{tocbasic}{Usage of deprecated command
@@ -310,26 +268,25 @@
\endgroup
}
% \end{macrocode}
-% \end{macro}%^^A \Ifattoclist
-% \end{macro}%^^A \ifattoclist
+% \end{command}^^A \ifattoclist,\Ifattoclist
%
-% \begin{macro}{\addtotoclist}
-% \changes{v1.0a}{2008/11/11}{internal \cs{@addtotoclist} renamed to
-% \cs{scr@addtotoclist} because of package \textsf{floatfram}}.^^A
-% \changes{v1.0a}{2008/11/11}{internal \cs{@@addtotoclist} renamed to
-% \cs{scr@@addtotoclist} because of package \textsf{floatfram}}.^^A
+% \begin{command}{\addtotoclist}
% \changes{v3.06a}{2010/09/14}{expand the arguments while adding them to the
-% internal list}%^^A
+% internal list}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\scr@addtotoclist}
-% \begin{macro}{\scr@@addtotoclist}
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@addtotoclist,\scr@addtotoclist}
+% \changes{v1.0a}{2008/11/11}{\cs{@addtotoclist} renamed to
+% \cs{scr@addtotoclist} because of package \pkg{flowfram}}
+% \begin{macro}{\@@addtotoclist,\scr@@addtotoclist}
+% \changes{v1.0a}{2008/11/11}{\cs{@@addtotoclist} renamed to
+% \cs{scr@@addtotoclist} because of package \pkg{flowfram}}
% \changes{v3.28}{2019/11/19}{\cs{ifattoclist} replaced by
-% \cs{Ifattoclist}}%^^A
+% \cs{Ifattoclist}}
% This command adds an extension to the list of toc-files. The first,
% optional argument is the class or package name with the corresponding
% extension of class or package files. If this argument was omitted
-% \textsf{tocbasic} tries to get it automatically. This should be
+% \pkg*{tocbasic} tries to get it automatically. This should be
% successfull while loading a class or package but not while processing any
% command of a class or package after loading the class or package. The
% second, mandatory argument is the extension of the toc-file. NOTE: An
@@ -384,11 +341,11 @@
% \end{macrocode}
% \end{macro}
% \end{macro}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\owneroftoc}
-% \changes{v3.22}{2016/08/09}{new}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{command}{\owneroftoc}
+% \changes{v3.22}{2016/08/09}{added}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% Returns the owner of a TOC or uses the owner of a TOC as argument of the
% optional argument, if it exists.
% \begin{macrocode}
@@ -400,22 +357,23 @@
\reserved@a
}
% \end{macrocode}
-% \end{macro}
-% \begin{macro}{\categoryoftoc}
-% \changes{v3.27}{2019/05/12}{new}%^^A
+% \end{command}
+% \begin{command}{\categoryoftoc}
+% \changes{v3.27}{2019/05/12}{added}
% Synonym for \cs{owneroftoc}.
% \begin{macrocode}
\newcommand*{\categoryoftoc}{\owneroftoc}
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\AtAddToTocList}
+% \begin{command}{\AtAddToTocList}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@AtAddToTocList,\@@AtAddToTocList}
% Action to be done, when adding a toc-file of a known owner. The first
% optional argument is the owner. The second, mandatory argument is the
% action. While doing the action \cs{@currext} will be the extension of the
-% added toc-file. If the first argument was omitted \textsf{tocbasic} tries
+% added toc-file. If the first argument was omitted \pkg*{tocbasic} tries
% to get it automatically. This should be successfull while loading a class
% or package but not while processing any command of a class or package
% after loading the class or package. The second, mandatory argument is the
@@ -444,10 +402,11 @@
}
% \end{macrocode}
% \end{macro}
+% \end{command}
%
% \begin{macro}{\tocbasic@extend@babel}
% \changes{v3.28}{2019/11/19}{\cs{iftocfeature} replaced by
-% \cs{Iftocfeature}}%^^A
+% \cs{Iftocfeature}}
% NOTE: To extend the original \cs{bbl@set@language} the argument of
% \cs{tocbasic@extend@babel} must not be a local macro (like \cs{@currext})
% \begin{macrocode}
@@ -462,7 +421,7 @@
for `#1'}%
}{%
% \end{macrocode}
-% \changes{v3.23}{2017/02/23}{using \cs{BabelContentsFiles} if available}%^^A
+% \changes{v3.23}{2017/02/23}{using \cs{BabelContentsFiles} if available}
% Since version 3.9a provides adding extensions to the language switch
% preparation. So it is used if it is available.
% \begin{macrocode}
@@ -490,21 +449,23 @@
}
% \end{macrocode}
% This feature should be used for all toc-files (unless feature
-% \texttt{nobabel} was set for the toc-file).
+% \opt{nobabel} was set for the toc-file).
% \begin{macrocode}
\AtAddToTocList[]{\expandafter\tocbasic@extend@babel\expandafter{\@currext}}
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{\removefromtoclist}
+% \begin{command}{\removefromtoclist}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\scr@removefromtoclist}
-% \changes{v3.22}{2016/09/06}{missing \cs{global} added}%^^A
-% \changes{v3.28}{2019/11/22}{renamed from \cs{@removefromtoclist}}%^^A
-% \begin{macro}{\scr@@removefromtoclist}
-% \changes{v3.22}{2016/09/06}{missing \cs{global} added}%^^A
-% \changes{v3.28}{2019/11/22}{renamed from \cs{@@removefromtoclist}}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\scr@removefromtoclist,\@removefromtoclist}
+% \changes{v3.22}{2016/09/06}{missing \cs{global} added}
+% \changes{v3.28}{2019/11/22}{\cs{@removefromtoclist} renamed to
+% \cs{scr@removefromtoclist}}
+% \begin{macro}{\scr@@removefromtoclist,\@@removefromtoclist}
+% \changes{v3.22}{2016/09/06}{missing \cs{global} added}
+% \changes{v3.28}{2019/11/22}{\cs{@@removefromtoclist} renamed to
+% \cs{scr@removefromtoclist}}
% This command will remove an extension from the list of toc-files. If the
% first, optional argument is given, the extension will only be removed, if
% it was added by the given owner. NOTE: An empty first argument is not the
@@ -553,13 +514,14 @@
% \end{macrocode}
% \end{macro}
% \end{macro}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\doforeachtocfile}
-% \changes{v3.09}{2011/03/01}{\cs{@currext} defined using \cs{edef} instead
-% of \cs{def}}%^^A
+% \begin{command}{\doforeachtocfile}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@doforeachtocfile,\@@doforeachtocfile}
+% \changes{v3.09}{2011/03/01}{\cs{@currext} defined using \cs{edef} instead
+% of \cs{def}}
% This command does the second, mandatory argument for each toc-file at the
% list of toc-files. If the first, optional argument was given this will be
% done only for the toc-files of that owner. NOTE: An empty first argument
@@ -600,13 +562,13 @@
}
% \end{macrocode}
% \end{macro}
-%
-% \begin{macro}{\addtoeachtocfile}
-% \begin{macro}{\@addtoeachtocfile}
-% \begin{macro}{\@@addtoeachtocfile}
-% \changes{v3.03b}{2009/06/08}{typo fix at usage of \cs{doforeachtocfile}}%^^A
+% \end{command}
+%
+% \begin{command}{\addtoeachtocfile}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@addtoeachtocfile,\@@addtoeachtocfile}
+% \changes{v3.03b}{2009/06/08}{typo fix at usage of \cs{doforeachtocfile}}
% This command calls \cs{addtocontents} with the section, mandatory
% argument for each toc-file at the list of toc-files. If the first,
% optional argument was given this will be done only for the toc-files of
@@ -627,17 +589,17 @@
%</body>
% \end{macrocode}
% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}
%
-% \subsection{Adding Entries into Toc-Files}
+% \subsection{Adding entries into toc-files}
%
% We have a new general command to add entries to several toc-files at
% once. And we have some special commands for the table of contents.
%
-% \begin{macro}{\addcontentslinetoeachtocfile}
+% \begin{command}{\addcontentslinetoeachtocfile}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@addcontentslinetoeachtocfile,\@@addcontentslinetoeachtocfile}
% Something like a combination of \cs{addtoeachtocfile} and
% \cs{addcontentsline}.
% \begin{macrocode}
@@ -654,18 +616,18 @@
}
% \end{macrocode}
% \end{macro}
-%
-% \begin{macro}{\addxcontentsline}
-% \changes{v3.12}{2013/09/24}{new}%^^A
-% \changes{v3.12}{2013/09/24}{Take care of new feature \texttt{numberline}}%^^A
+% \end{command}
+%
+% \begin{command}{\addxcontentsline}
+% \changes{v3.12}{2013/09/24}{added}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
% \begin{macro}{\@addxcontentsline}
-% \changes{v3.12}{2013/09/24}{new (internal)}%^^A
+% \changes{v3.12}{2013/09/24}{added}
% This will be used instead of \cs{addcontentsline} to generate numbered or
% not numbered entries to a toc-file. First argument is the toc-file, second
-% the entry type, e.g., \texttt{chapter}, the third is the entry number or
-% empty and the fourth and last is the entry text.
+% the entry type, e.g., |chapter|, the third is the entry number or empty and
+% the fourth and last is the entry text.
% \begin{macrocode}
\newcommand*{\addxcontentsline}[2]{%
\kernel@ifnextchar [%]
@@ -681,15 +643,15 @@
}%
}
% \end{macrocode}
-% \begin{macro}{\nonumberline}
-% \changes{v3.12}{2013/09/24}{new}%^^A
+% \begin{command}{\nonumberline}
+% \changes{v3.12}{2013/09/24}{added}
% Either \cs{relax} or \cs{numberline} depending on the feature
-% \texttt{numberline}.
+% \opt{numberline}.
% \begin{macrocode}
\newcommand*{\nonumberline}{}%
% \end{macrocode}
-% \end{macro}
-% \begin{macro}{\addxcontentsline}
+% \end{command}
+% \begin{command}{\addxcontentsline}
% This may be used to either use a heading type command or the general default
% one. You are not allowed to use it in the definition of a heading type
% command like \cs{addchaptertocentry}! You may use
@@ -703,26 +665,22 @@
\fi
}
% \end{macrocode}
+% \end{command}
% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\addxcontentslinetoeachtocfile}
-% \changes{v3.12}{2013/09/24}{new}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@addxcontentslinetoeachtocfile}
-% \changes{v3.12}{2013/09/24}{new (internal)}%^^A
+% \begin{command}{\addxcontentslinetoeachtocfile}
+% \changes{v3.12}{2013/09/24}{added}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@addxcontentslinetoeachtocfile}
-% \changes{v3.12}{2013/09/24}{new (internal)}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@addxcontentslinetoeachtocfile,
+% \@@addxcontentslinetoeachtocfile}
+% \changes{v3.12}{2013/09/24}{added}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@@addxcontentslinetoeachtocfile}
-% \changes{v3.12}{2013/09/24}{new (internal)}%^^A
-% \begin{macro}{\@@@@addxcontentslinetoeachtocfile}
-% \changes{v3.12}{2013/09/24}{new (internal)}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@@addxcontentslinetoeachtocfile,
+% \@@@@addxcontentslinetoeachtocfile}
+% \changes{v3.12}{2013/09/24}{added}
% Similar to \cs{addcontentslinetoeachtocfile} using
% \cs{addxcontentsline} instead of \cs{addcontentsline}.
% \begin{macrocode}
@@ -752,23 +710,21 @@
% \end{macrocode}
% \end{macro}
% \end{macro}
-% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}
%
%
-% \subsection{Show List of Toc-File}
+% \subsection{Show list of toc-file}
% \label{sec:showlistoftocfile}
%
% If you have a toc-file you want a list-of-command for this toc-file,
% too. Here are basics and high level commands for this.
%
% \begin{macro}{\tocbasic@starttoc}
-% \changes{v3.17}{2015/03/23}{usage of feature \texttt{noparskipfake}}
+% \changes{v3.17}{2015/03/23}{usage of feature \opt{noparskipfake}}
% \changes{v3.27}{2019/07/08}{hack to add \cs{par} at end of (main) file}
% \changes{v3.28}{2019/11/19}{\cs{iftocfeature} replaced by
% \cs{Iftocfeature}}
-% \changes{v3.32}{2020/08/25}{replace \cs{par} hack by \cs{par} solution}}
+% \changes{v3.32}{2020/08/25}{replace \cs{par} hack by \cs{par} solution}
% \changes{v3.32}{2020/08/25}{reentrant warning}
% Some basics are done like setting up \cs{parskip}, \cs{parindent} and
% \cs{parfillskip}, a general hook will be called, an individual hook will
@@ -815,37 +771,32 @@
\endgroup
}
% \end{macrocode}
-% \begin{macro]{tocbasic@end@toc@file}
-% \changes{v3.32}{2020/08/25}{new}
+% \begin{macro}{tocbasic@end@toc@file}
+% \changes{v3.32}{2020/08/25}{added}
% \begin{macrocode}
\newcommand*{\tocbasic@end@toc@file}{\par}
% \end{macrocode}
-% \end{macro}%^^A \tocbasic@end@toc@file
+% \end{macro}^^A \tocbasic@end@toc@file
% \begin{macro}{\tocbasic@reentrant@warning}
-% \changes{v3.32}{2020/08/25}{new}
+% \changes{v3.32}{2020/08/25}{added}
+% \begin{macrocode}
\newcommand*{\tocbasic@reentrant@warning}{}
-% \end{macro}
-% \begin{macro}{\tocbasic@@before@hook}
-% \begin{macro}{\tocbasic@@after@hook}
+% \end{macrocode}
+% \end{macro}^^A \tocbasic@reentrant@warning
+% \begin{macro}{\tocbasic@@before@hook,\tocbasic@@after@hook}
% These are the general hooks. They may be used by classes and packages for
% commands, that should be used for all lists of not only the own lists of,
-% e.\,g., \KOMAScript{} may use it to handle option \texttt{tocleft}.
+% e.\,g., \KOMAScript{} may use it to handle option \opt{tocleft}.
% \begin{macrocode}
\newcommand*{\tocbasic@@before@hook}{}
\newcommand*{\tocbasic@@after@hook}{}
% \end{macrocode}
-% \end{macro}
-% \end{macro}
-% \begin{macro}{\BeforeStartingTOC}
-% \changes{v3.04b}{2010/01/05}{fix: define the hook if not already defined}%^^A
+% \end{macro}^^A \tocbasic@@before@hook,\tocbasic@@after@hook
+% \begin{command}{\BeforeStartingTOC,\AfterStartingTOC}
+% \changes{v3.04b}{2010/01/05}{fix:define the hook if not already defined}
% \changes{v3.06}{2010/06/09}{fix: using \cs{@ifundefined} instead of
-% undefined \cs{scr@ifundefinedorrelax}}%^^A
-% \changes{v3.26}{2018/08/10}{message moved to \texttt{trace}}%^^A
-% \begin{macro}{\AfterStartingTOC}
-% \changes{v3.04b}{2010/01/05}{fix:define the hook if not already defined}%^^A
-% \changes{v3.06}{2010/06/09}{fix: using \cs{@ifundefined} instead of
-% undefined \cs{scr@ifundefinedorrelax}}%^^A
-% \changes{v3.26}{2018/08/10}{message moved to \texttt{trace}}%^^A
+% undefined \cs{scr@ifundefinedorrelax}}
+% \changes{v3.26}{2018/08/10}{message moved to \texttt{trace}}
% These are the commands to add code to the general or individual hooks. If
% the first, optional argument was given, the second, mandatory argument
% will be added to the individual hook, otherwise the general hook will be
@@ -876,22 +827,20 @@
\fi
}
% \end{macrocode}
-% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}^^A \BeforeStartingTOC,\AfterStartingTOC
+% \end{macro}^^A \tocbasic@starttoc
%
-% \begin{macro}{\listoftoc}
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
+% \begin{command}{\listoftoc}
+% \changes{v3.20}{2016/04/12}{\cs{@ifstar} replaced by \cs{kernel@ifstar}}
% \begin{macro}{\@listoftoc}
-% \changes{v1.0a}{2008/11/12}{\cs{twocolumn} fixed}%^^A
-% \changes{v1.01}{2008/11/13}{new feature \texttt{onecolumn}}%^^A
+% \changes{v1.0a}{2008/11/12}{\cs{twocolumn} fixed}
+% \changes{v1.01}{2008/11/13}{new feature \opt{onecolumn}}
% \changes{v3.09}{2011/03/01}{\cs{@currext} defined using \cs{edef} instead
-% of \cs{def}}%^^A
+% of \cs{def}}
% \changes{v3.28}{2019/11/19}{\cs{iftocfeature} replaced by
-% \cs{Iftocfeature}}%^^A
+% \cs{Iftocfeature}}
% \changes{v3.31}{2020/07/08}{use one time expansion of local
-% \cs{list@fname}}%^^A
+% \cs{list@fname}}
% Command to handle the hole list of something. There are additional hooks
% for this. The first optional argument is the title for this list. If the
% optional argument was omitted \cs{listof\#2name} will be used. The star
@@ -938,11 +887,11 @@
}
% \end{macrocode}
% \end{macro}
-% \end{macro}
+% \end{command}
%
-% \changes{v3.25}{2017/11/21}{\textsf{tocbibind} warning added}%^^A
-% Using \textsf{tocbibind} and \textsf{tocbasic} together can break features
-% either of \textsf{tocbibind} or \textsf{tocbasic}. Here we add at least a
+% \changes{v3.25}{2017/11/21}{\pkg{tocbibind} warning added}
+% Using \pkg{tocbibind} and \pkg*{tocbasic} together can break features
+% either of \pkg{tocbibind} or \pkg*{tocbasic}. Here we add at least a
% warning:
% \begin{macrocode}
\@ifpackageloaded{tocbibind}{}{%
@@ -973,20 +922,19 @@
}
% \end{macrocode}
%
-% \begin{macro}{\listofname}
-% While this is only an emergancy command, we don't support languages.
+% \begin{command}{\listofname}
+% While this is only an emergency command, we don't support languages.
% \begin{macrocode}
\newcommand*{\listofname}{List of}
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\listofeachtoc}
-% \begin{macro}{\@listofeachtoc}
-% \begin{macro}{\@@listofeachtoc}
-% \changes{v3.03b}{2009/06/08}{typo fix at usage of \cs{doforeachtocfile}}%^^A
+% \begin{command}{\listofeachtoc}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% Another example of using \cs{doforeachtocfile}.
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@listofeachtoc,\@@listofeachtoc}
+% \changes{v3.03b}{2009/06/08}{typo fix at usage of \cs{doforeachtocfile}}
+% Another example of using \cs{doforeachtocfile}.
% \begin{macrocode}
\newcommand*{\listofeachtoc}{%
\kernel@ifnextchar [%]
@@ -1000,12 +948,11 @@
}
% \end{macrocode}
% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}
%
% \begin{macro}{\ext@toc}
-% \changes{v3.23}{2017/02/23}{use indirect extension for toc}%^^A
-% We do not longer hard code extension \texttt{toc} for the table of
+% \changes{v3.23}{2017/02/23}{use indirect extension for toc}
+% We do not longer hard code extension \file{toc} for the table of
% contents. This allowes users to change it. Classes or other packages may
% also define it. So it seems to be better to \cs{providecommand} instead of
% \cs{newcommand} here.
@@ -1015,22 +962,21 @@
% \end{macro}
%
% \begin{macro}{\tocbasic@listhead}
-% \changes{v3.02a}{2009/01/20}{no explicite marks if ``numbered''}%
-% \changes{v3.09a}{2011/04/12}{again no explicite marks if ``numbered''}%
-% \changes{v3.12}{2013/09/24}{usage of new
-% \cs{tocbasic@addxcontentsline}}%
-% \changes{v3.15}{2014/12/10}{moved \cs{@mkboth} inside \cs{chapter*}}%^^A
-% \changes{v3.15}{2014/12/10}{usage of \cs{addsec} if available}%^^A
-% \changes{v3.15}{2014/12/10}{usage of \cs{@mkright} if available}%^^A
-% \changes{v3.17}{2015/03/08}{moved \cs{@mkboth} outside \cs{chapter*}}%^^A
-% \changes{v3.17}{2015/03/08}{usage of \cs{@mkdouble} if available}%^^A
+% \changes{v3.02a}{2009/01/20}{no explicite marks if ``numbered''}
+% \changes{v3.09a}{2011/04/12}{again no explicite marks if ``numbered''}
+% \changes{v3.12}{2013/09/24}{usage of new \cs{tocbasic@addxcontentsline}}
+% \changes{v3.15}{2014/12/10}{moved \cs{@mkboth} inside \cs{chapter*}}
+% \changes{v3.15}{2014/12/10}{usage of \cs{addsec} if available}
+% \changes{v3.15}{2014/12/10}{usage of \cs{@mkright} if available}
+% \changes{v3.17}{2015/03/08}{moved \cs{@mkboth} outside \cs{chapter*}}
+% \changes{v3.17}{2015/03/08}{usage of \cs{@mkdouble} if available}
% \changes{v3.17}{2015/03/25}{penalty and skip reconstruction after
-% \cs{@mkright}, \cs{@mkboth}, or \cs{@mkdouble}}%^^A
-% \changes{v3.26}{2018/06/22}{removed spurious group}%^^A
+% \cs{@mkright}, \cs{@mkboth}, or \cs{@mkdouble}}
+% \changes{v3.26}{2018/06/22}{removed spurious group}
% \changes{v3.26}{2018/09/03}{usage of \cs{addsecmark} or \cs{sectionmark}
-% instead of \cs{@mkright} or \cs{markright}}%^^A
+% instead of \cs{@mkright} or \cs{markright}}
% \changes{v3.28}{2019/11/19}{\cs{iftocfeature} replaced by
-% \cs{Iftocfeature}}%^^A
+% \cs{Iftocfeature}}
% Setting the headings of a list of something. The heading is the only
% argument.
% \begin{macrocode}
@@ -1142,16 +1088,11 @@
\csname tb@@afterhead@hook\endcsname
}
% \end{macrocode}
-% \begin{macro}{\BeforeTOCHead}
-% \changes{v3.04b}{2010/01/05}{fix: define the hook if not already defined}%^^A
+% \begin{command}{\BeforeTOCHead,\AfterTOCHead}
+% \changes{v3.04b}{2010/01/05}{fix: define the hook if not already defined}
% \changes{v3.06}{2010/06/09}{fix: using \cs{@ifundefined} instead of
-% undefined \cs{scr@ifundefinedorrelax}}%^^A
-% \changes{v3.26}{2018/08/10}{message moved to \texttt{trace}}%^^A
-% \begin{macro}{\AfterTOCHead}
-% \changes{v3.04b}{2010/01/05}{fix: define the hook if not already defined}%^^A
-% \changes{v3.06}{2010/06/09}{fix: using \cs{@ifundefined} instead of
-% undefined \cs{scr@ifundefinedorrelax}}%^^A
-% \changes{v3.26}{2018/08/10}{message moved to \texttt{trace}}%^^A
+% undefined \cs{scr@ifundefinedorrelax}}
+% \changes{v3.26}{2018/08/10}{message moved to \texttt{trace}}
% These are the commands to add code to the general or individual hooks. If
% the first, optional argument was given, the second, mandatory argument
% will be added to the individual hook, otherwise the general hook will be
@@ -1175,11 +1116,10 @@
}
%</body>
% \end{macrocode}
-% \end{macro}
-% \end{macro}
+% \end{command}
% \end{macro}
%
-% \begin{macro}{\MakeMarkcase}
+% \begin{command}{\MakeMarkcase}
% Use upper-case or not?
% \begin{macrocode}
%<*exit>
@@ -1194,37 +1134,34 @@
}
%</exit>
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\deftocheading}
+% \begin{command}{\deftocheading}
% Define a toc headings command with one argument (the title).
% \begin{macrocode}
%<*body>
\newcommand*{\deftocheading}[1]{%
\@namedef{tocbasic@listhead@#1}##1}
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\setuptoc}
-% \changes{v3.26}{2018/08/29}{Verwendung von \cs{scr@trim@spaces} statt
-% \cs{tb@@sp@def}}%^^A
-% \begin{macro}{\unsettoc}
-% \changes{v3.26}{2018/08/29}{Verwendung von \cs{scr@trim@spaces} statt
-% \cs{tb@@sp@def}}%^^A
+% \begin{command}{\setuptoc,\unsettoc}
+% \changes{v3.26}{2018/08/29}{using \cs{scr@trim@spaces} instead of
+% \cs{tb@@sp@def}}
% Known features are:
% \begin{description}
-% \item[\texttt{totoc}] writes the title of the list of to the table of
+% \item[\opt{totoc}] writes the title of the list of to the table of
% contents
-% \item[\texttt{numberline}] redefines \cs{nonumberline} to use
+% \item[\opt{numberline}] redefines \cs{nonumberline} to use
% \cs{numberline}
-% \item[\texttt{numbered}] uses a numbered headings for the list of
-% \item[\texttt{leveldown}] uses not the top level heading (e.\,g.,
+% \item[\opt{numbered}] uses a numbered headings for the list of
+% \item[\opt{leveldown}] uses not the top level heading (e.\,g.,
% \cs{chapter} with book) but the first sub level (e.\,g., \cs{section} with
% book).
-% \item[\texttt{nobabel}] prevents the extension to be added to the babel
+% \item[\opt{nobabel}] prevents the extension to be added to the babel
% handling of toc-files. To make this work, you have to set the feature
% before adding the extension to the list of known extension.
-% \item[[\texttt{noprotrusion}]] prevents disabling character protrusion at
+% \item[\opt{noprotrusion}] prevents disabling character protrusion at
% the toc.
% \end{description}
% Other features may be package dependent. You may test the feature using:
@@ -1254,10 +1191,8 @@
\setuptoc{lof}{nobabel}
\setuptoc{lot}{nobabel}
% \end{macrocode}
-% \begin{macro}{\iftocfeature}
-% \changes{v3.28}{2019/11/19}{renamed to \cs{Iftocfeature}}%^^A
-% \begin{macro}{\Iftocfeature}
-% \changes{v3.28}{2019/11/19}{renamed from \cs{iftocfeature}}%^^A
+% \begin{command}{\Iftocfeature,\iftocfeature}
+% \changes{v3.28}{2019/11/19}{\cs{iftocfeature} renamed to \cs{Iftocfeature}}
% We need a test for the features
% \begin{macrocode}
\providecommand*{\iftocfeature}{%
@@ -1278,24 +1213,22 @@
}
%</body>
% \end{macrocode}
-% \end{macro}
-% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}
+% \end{command}
%
-% \begin{macro}{\tocbasicautomode}
+% \begin{command}{\tocbasicautomode}
% \changes{v1.0a}{2008/11/11}{use of \cs{addtotoclist} instead of
-% internal}%^^A
+% internal}
% \changes{v3.07a}{2010/11/25}{fix: added missing
-% \cs{let}\cs{@starttoc}\cs{tocbasic@starttoc}}%^^A
+% \cs{let}\cs{@starttoc}\cs{tocbasic@starttoc}}
% \changes{v3.28}{2019/11/19}{\cs{ifattoclist} replaced by
-% \cs{Ifattoclist}}%^^A
-% \textsf{tocbasic} can overtake \cs{@starttoc} to automaticly add all
+% \cs{Ifattoclist}}
+% \pkg*{tocbasic} can overtake \cs{@starttoc} to automaticly add all
% used extensions to the list of known extensions and use
% \cs{tocbasic@starttoc} instead of \cs{@starttoc} from \LaTeX{}
% kernel. Please note, that we don't need a fix for the unfriendly
-% redefinition of \cs{@starttoc} by \textsf{hyperref}, because hyperref
-% does it only at the first \LaTeX{} run. So this action of \textsf{hyperref}
+% redefinition of \cs{@starttoc} by \pkg{hyperref}, because hyperref
+% does it only at the first \LaTeX{} run. So this action of \pkg{hyperref}
% may only result in the need of one more \LaTeX{} run, but not in a permanent
% mistake.
% \begin{macrocode}
@@ -1312,24 +1245,24 @@
}
%</body>
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
%
-% \subsection{High Level Interface for Generating New TOCs and Floats}
+% \subsection{High level interface for generating new ToCs and floats}
% \label{sec:newfloats}
%
-% \begin{macro}{\DeclareNewTOC}
-% \changes{v3.06}{2010/06/01}{new high level command}%^^A
+% \begin{command}{\DeclareNewTOC}
+% \changes{v3.06}{2010/06/01}{added}
% \changes{v3.18}{2015/06/20}{\cs{tb@nt@types} and \cs{tb@nt@listname} are
-% initialised \cs{relax}}%^^A
+% initialised \cs{relax}}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \changes{v3.26a}{2018/12/30}{fixed usage of \cs{kernel@ifnextchar}}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \cs{kernel@ifnextchar}}
+% \changes{v3.26a}{2018/12/30}{fixed usage of \cs{kernel@ifnextchar}}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% This command defines only a new TOC and a new caption command for this
% TOC. It does not define a new foat unless option float was set! It does
% not define a new nonfloat unless option nonfloat was set! The optional
-% argument is used to set up several settings using \textsf{keyval}. The
+% argument is used to set up several settings using \pkg{keyval}. The
% mandatory argument is the shortcut. The default type is the shortcut.
% The extension is the shortcut. The default owner is ``\texttt{float}''.
% \begin{macrocode}
@@ -1354,13 +1287,13 @@
\def\tb@nt@tocentrystyle{default}%
% \end{macrocode}
% \changes{v3.20}{2016/04/29}{need more initialization for empty optional
-% argument}%^^A
+% argument}
% \begin{macrocode}
\def\tb@nt@tocstyle@options{level=1}%
\IfArgIsEmpty{#1}{%
% \end{macrocode}
% Also need to call the style init code, to set the defaults for options
-% \texttt{numwidth} and \texttt{indent}.
+% \opt{numwidth} and \opt{indent}.
% \begin{macrocode}
\begingroup
\let\scr@dte@current\tb@nt@type
@@ -1373,7 +1306,9 @@
}%
}{%
\Ifstr{##1}{indent}{%
-%<trace>\typeout{TRACE \string\DeclareNewTOC[...]{#2}: set default indent 1em}%
+%<trace> \PackageInfo{tocbasic}{%
+%<trace> TRACE \string\DeclareNewTOC[...]{#2}:
+%<trace> set default indent 1em}%
\l@addto@macro\do@endgroup{%
\l@addto@macro{\tb@nt@tocstyle@options}{,indent=1em}%
}%
@@ -1392,7 +1327,7 @@
% After initialisation of the local values we need to know the style of the
% toc entry, to define style dependend options.
% \begin{macro}{\tb@nt@type}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
% The type of list is used for environment and counter names and as part of
% several internal and user macros. It is needed before defining the style
% dependend options. So we use a first run to set it up.
@@ -1403,7 +1338,7 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@tocentrystyle}
-% \changes{v3.20}{2015/12/16}{neu (intern)}
+% \changes{v3.20}{2015/12/16}{added}
% The style of the toc entry. It is needed before defining the style
% dependend options. So we use a first run to set it up.
% \begin{macrocode}
@@ -1423,8 +1358,8 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@ext}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
-% \changes{v3.25}{2017/11/20}{moved to pass 1}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
+% \changes{v3.25}{2017/11/20}{moved to pass 1}
% Don't tell the user, that the mandatory argument of the command may be
% overloaded by this option. This was only done to simplify the definition.
% \begin{macrocode}
@@ -1434,10 +1369,9 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@owner}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
-% \changes{v3.26}{2018/06/09}{moved to pass 1}%^^A
-% \changes{v3.27}{2019/05/12}{\texttt{category} is a synonym for
-% \texttt{owner}}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
+% \changes{v3.26}{2018/06/09}{moved to pass 1}
+% \changes{v3.27}{2019/05/12}{\opt{category} is a synonym for \opt{owner}}
% The owner of the new list extension.
% \begin{macrocode}
\DefineFamilyKey[.toc]{KOMAarg}{owner}{%
@@ -1448,14 +1382,14 @@
}%
% \end{macrocode}
% \end{macro}
-% After this we define pseudo option \texttt{@else@} to ignore all currently
+% After this we define pseudo option \opt{@else@} to ignore all currently
% not needed options. After this we do the first option execution run.
% \begin{macrocode}
\DefineFamilyKey[.toc]{KOMAarg}{@else@}{\FamilyKeyStateProcessed}%
\FamilyExecuteOptions[.toc]{KOMAarg}{#1}%
\RelaxFamilyKey[.toc]{KOMAarg}{@else@}%
% \end{macrocode}
-% \changes{v3.26}{2018/06/09}{add extension already after first pass}%^^A
+% \changes{v3.26}{2018/06/09}{add extension already after first pass}
% First of all, every TOC needs an extension, that should be added to the
% list of known extensions. This has to be done also, if no options has been
% given!
@@ -1474,10 +1408,10 @@
\DefineFamilyKey[.toc]{KOMAarg}{extension}{\FamilyKeyStateProcessed}%
\DefineFamilyKey[.toc]{KOMAarg}{category}{\FamilyKeyStateProcessed}%
% \end{macrocode}
-% \changes{v3.20}{2015/12/16}{defining toc style depending options}%^^A
-% \changes{v3.20}{2016/06/12}{using prefix \texttt{tocentry} instead of
-% \texttt{toc}}%^^A
-% \changes{v3.27}{2019/10/02}{additional \texttt{:}-options}%^^A
+% \changes{v3.20}{2015/12/16}{defining toc style depending options}
+% \changes{v3.20}{2016/06/12}{using prefix \opt{tocentry} instead of
+% \opt{toc}}
+% \changes{v3.27}{2019/10/02}{additional \opt{:}-options}
% If the toc style is empty we won't define any \cs{l@\dots}. Otherwise we
% need to define additional options.
% \begin{macrocode}
@@ -1541,25 +1475,25 @@
% After this, we need to define all the other options and do the real option
% execution.
% \begin{macro}{\tb@nt@atbegin}
-% \changes{v3.09}{2011/03/01}{new optional identifier \texttt{atbegin}}%^^A
-% \changes{v3.11c}{2013/02/01}{\texttt{atbegin} argument may be empty}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.09}{2011/03/01}{new optional identifier \opt{atbegin}}
+% \changes{v3.11c}{2013/02/01}{\opt{atbegin} argument may be empty}
+% \changes{v3.20}{2015/12/16}{locally valid only}
% Additional code executed at the begin of a new defined environment.
% \begin{macrocode}
\FamilyStringKey[.toc]{KOMAarg}{atbegin}{\tb@nt@atbegin}%
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@atend}
-% \changes{v3.09}{2011/03/01}{new optional identifier \texttt{atbend}}%^^A
-% \changes{v3.11c}{2013/02/01}{\texttt{atend} argument may be empty}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.09}{2011/03/01}{new optional identifier \opt{atbend}}
+% \changes{v3.11c}{2013/02/01}{\opt{atend} argument may be empty}
+% \changes{v3.20}{2015/12/16}{locally valid only}
% Additional code executed at the end of a new defined environment.
% \begin{macrocode}
\FamilyStringKey[.toc]{KOMAarg}{atend}{\tb@nt@atend}%
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@counterwithin}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
% If a counter will be defined, this counter may depend on another counter
% (like figure counter depends on chapter counter at book classes). If the
% value is empty, the counter does not depend on any other counter.
@@ -1570,15 +1504,15 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\iftb@nt@float}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
-% \changes{v3.06}{2010/06/01}{new internal}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
+% \changes{v3.06}{2010/06/01}{added}
% This boolean indicates, that float environments should also be defined.
% \begin{macrocode}
\FamilyBoolKey[.toc]{KOMAarg}{float}{tb@nt@float}%
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@floatpos}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
% Simply the value for the |\fps@...| macro.
% \begin{macrocode}
\DefineFamilyKey[.toc]{KOMAarg}{floatpos}{%
@@ -1587,7 +1521,7 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@floattype}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
% Simply the value for the |\ftype@...| macro. It has to be
% $1<=\textrm{value}<=31$.
% \begin{macrocode}
@@ -1605,8 +1539,8 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\iftb@nt@forcenames}
-% \changes{v3.06}{2010/06/01}{new internal}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.06}{2010/06/01}{added}
+% \changes{v3.20}{2015/12/16}{locally valid only}
% The |\...name| commands will only be defined, if they are not already
% defined. But some users may want to define their own names even if there
% are already definitions. So this boolean option may switch to force the
@@ -1615,9 +1549,9 @@
\FamilyBoolKey[.toc]{KOMAarg}{forcenames}{tb@nt@forcenames}%
% \end{macrocode}
% \end{macro}
-% \begin{macro}{\tb@nt@hang}
-% \changes{v3.20}{2015/12/16}{undefined}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \begin{macro}[noprint]{\tb@nt@hang}
+% \changes{v3.20}{2015/12/16}{removed}
+% \end{macro}
% Earch entry of a TOC/list of is idented on the left side. This is the
% amount of the indention of the text of the entry.
% \begin{macrocode}
@@ -1642,10 +1576,9 @@
\l@addto@macro\tb@nt@tocstyle@options{,numwidth=1.5em}%
}%
% \end{macrocode}
+% \begin{macro}[noprint]{\tb@nt@indent}
+% \changes{v3.20}{2015/12/16}{removed}
% \end{macro}
-% \begin{macro}{\tb@nt@indent}
-% \changes{v3.20}{2015/12/16}{undefined}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
% Earch entry of a TOC/list of is idented on the left side. This is the
% amount of the indention of the number part.
% \begin{macrocode}
@@ -1667,15 +1600,15 @@
\FamilyKeyStateProcessed
}%
\scr@ifundefinedorrelax{KV@KOMAarg.toc@tocindent}{}{%
-%<trace>\typeout{TRACE \string\DeclareNewTOC[...]{#2}: set default indent 1em}%
+%<trace> \PackageInfo{tocbasic}{%
+%<trace> TRACE \string\DeclareNewTOC[...]{#2}: set default indent 1em}%
\l@addto@macro\tb@nt@tocstyle@options{,indent=1em}%
}%
% \end{macrocode}
+% \begin{macro}[noprint]{\tb@nt@level}
+% \changes{v3.20}{2015/12/16}{removed}
% \end{macro}
-% \begin{macro}{\tb@nt@level}
-% \changes{v3.20}{2015/12/16}{undefined}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
-% \changes{v3.30}{2020/02/25}{spurious space in warning message removed}%^^A
+% \changes{v3.30}{2020/02/25}{spurious space in warning message removed}
% Each entry to a TOC/list of has a numeric level. You may set up your own
% level.
% \begin{macrocode}
@@ -1689,10 +1622,9 @@
\FamilyKeyStateProcessed
}%
% \end{macrocode}
-% \end{macro}
% \begin{macro}{\tb@nt@listname}
-% \changes{v3.18}{2015/06/20}{using \cs{def} instead of \cs{edef}}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.18}{2015/06/20}{using \cs{def} instead of \cs{edef}}
+% \changes{v3.20}{2015/12/16}{locally valid only}
% The list itself has a heading. A |\list<type>name| will also be defined.
% \begin{macrocode}
\DefineFamilyKey[.toc]{KOMAarg}{listname}{%
@@ -1701,7 +1633,7 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@name}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
% We need a name/term for the entries of the new list. This may e.\,g. be used
% for |caption| output. A |\<type>name| will also be defined.
% \begin{macrocode}
@@ -1711,8 +1643,8 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\iftb@nt@nonfloat}
-% \changes{v3.06}{2010/06/01}{new (internal)}%^^A
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.06}{2010/06/01}{added}
+% \changes{v3.20}{2015/12/16}{locally valid only}
% This boolean indicates, that non-float environment should also be
% defined. The environment has the postfix ``-''.
% \begin{macrocode}
@@ -1720,7 +1652,7 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@nt@types}
-% \changes{v3.20}{2015/12/16}{local valid only}%^^A
+% \changes{v3.20}{2015/12/16}{locally valid only}
% Sometimes the plural of the type is needed and may be defined by a
% seperate option.
% \begin{macrocode}
@@ -1729,8 +1661,8 @@
}%
% \end{macrocode}
% \end{macro}
-% \changes{v3.25}{2017/11/20}{new (internal)}%^^A
-% The new option \texttt{setup} allowes to setup ToC features provided by
+% \changes{v3.25}{2017/11/20}{option \opt{setup} added}
+% The new option \opt{setup} allowes to setup ToC features provided by
% \cs{setuptoc}. Note, currently there is no test whether or not a feature
% does exist!
% \begin{macrocode}
@@ -1738,8 +1670,8 @@
\setuptoc\tb@nt@ext{##1}%
}%
% \end{macrocode}
-% \changes{v3.25}{2017/11/20}{new (internal)}%^^A
-% The new option \texttt{unset} allowes to unset ToC features provided
+% \changes{v3.25}{2017/11/20}{option \opt{unset} added}
+% The new option \opt{unset} allowes to unset ToC features provided
% by \cs{unsettoc}. Note, currently there is no test whether or not a
% feature does exist!
% \begin{macrocode}
@@ -1749,9 +1681,9 @@
% \end{macrocode}
% Last but not least we have to execute the options and reset the option
% definitions.
-% \changes{v3.25}{2017/09/27}{\texttt{nonfloat} fixed}%^^A
-% \changes{v3.26}{2018/06/09}{added missing reset of \texttt{unset} and
-% \texttt{setup}}%^^A
+% \changes{v3.25}{2017/09/27}{\opt{nonfloat} fixed}
+% \changes{v3.26}{2018/06/09}{added missing reset of \opt{unset} and
+% \opt{setup}}
% \begin{macrocode}
\FamilyExecuteOptions[.toc]{KOMAarg}{#1}%
\RelaxFamilyKey[.toc]{KOMAarg}{unset}%
@@ -1784,7 +1716,7 @@
% \end{macrocode}
% Then we need the TOC itself with a name:
% \changes{v3.25}{2017/10/10}{use \cs{ext@\dots} instead of the extension
-% itself in definition of \cs{listof\dots}}%^^A
+% itself in definition of \cs{listof\dots}}
% \begin{macrocode}
\scr@ifundefinedorrelax{tb@nt@types}{%
\edef\tb@nt@types{\tb@nt@type s}%
@@ -1817,7 +1749,7 @@
}\@tempa
% \end{macrocode}
% The list entry:
-% \changes{v3.20}{2016/04/05}{warning if \cs{l@\dots} is undefined}%^^A
+% \changes{v3.20}{2016/04/05}{warning if \cs{l@\dots} is undefined}
% \begin{macrocode}
\Ifstr{\tb@nt@tocentrystyle}{}{%
\@ifundefined{l@\tb@nt@type}{%
@@ -1839,7 +1771,7 @@
}%
% \end{macrocode}
% \changes{v3.12}{2013/05/03}{fixed: definition of
-% \cs{listof\meta{type}entryname} added as explained in the manual}%^^A
+% \cs{listof\meta{type}entryname} added as explained in the manual}
% \begin{macrocode}
\@ifundefined{listof\tb@nt@ext entryname}{%
\expandafter\let\csname listof\tb@nt@ext entryname\endcsname\tb@nt@name
@@ -1855,8 +1787,8 @@
\@tempswafalse
% \end{macrocode}
% The float environments:
-% \changes{v3.09a}{2011/05/30}{fixed: floats may have an optional argument}%^^A
-% \changes{v3.12}{2013/12/10}{fixed: usage of default placement}%^^A
+% \changes{v3.09a}{2011/05/30}{fixed: floats may have an optional argument}
+% \changes{v3.12}{2013/12/10}{fixed: usage of default placement}
% \begin{macrocode}
\iftb@nt@float
\expandafter\newcommand\expandafter*\csname fps@\tb@nt@type\expandafter
@@ -1920,7 +1852,7 @@
% \cs{autodot}}
% \changes{v3.13}{2014/07/31}{add \cs{autodot} only to hierachical
% counters}
-% \changes{v3.35}{2021/10/12}{ignore \texttt{counterwithin} if it is
+% \changes{v3.35}{2021/10/12}{ignore \opt{counterwithin} if it is
% ``\texttt{chapter}'' resp. ``\texttt{section}'' and \cs{ifmainmatter} is
% not \cs{iffalse} and the counterwithin counter is < 1}
% \begin{macrocode}
@@ -1996,7 +1928,7 @@
}
% \end{macrocode}
% \begin{macro}{\tb@atbegin@after}
-% \changes{v3.09a}{2011/05/30}{new internal}%^^A
+% \changes{v3.09a}{2011/05/30}{added}
% Processes command \#1 with argument \#2 and optional argument \#3 and than
% \verb|\csname #2@atbegin\endcsname|. This is used to add
% \verb|csname #2@atbegin\endcsname| at begin part of a float (but after
@@ -2010,9 +1942,9 @@
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tb@ifvalueisnotempty}
-% \changes{v3.06}{2010/05/21}{new internal}%^^A
-% \changes{v3.20}{2015/12/16}{simpler definition}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \changes{v3.06}{2010/05/21}{added}
+% \changes{v3.20}{2015/12/16}{simpler definition}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% This is only a helper for defining some of the keys.
% \begin{macrocode}
\newcommand*{\tb@ifvalueisnotempty}[1]{%
@@ -2026,48 +1958,45 @@
}
% \end{macrocode}
% \end{macro}
-% \begin{macro}{\tb@boolkey}
-% \changes{v3.06}{2010/05/21}{new (internal)}%^^A
-% \changes{v3.20}{2015/12/16}{undefined}%^^A
-% \end{macro}
-% \begin{macro}{\tb@dimkey}
-% \changes{v3.06}{2010/05/21}{new (internal)}%^^A
-% \changes{v3.20}{2015/12/16}{undefined}%^^A
-% \end{macro}
-% \begin{macro}{\tb@numkey}
-% \changes{v3.06}{2010/05/21}{new internal}%
-% \changes{v3.20}{2015/12/16}{undefined}%^^A
+% \begin{macro}[noprint]{\tb@boolkey,\tb@dimkey,\tb@numkey}
+% \changes{v3.06}{2010/05/21}{added}
+% \changes{v3.20}{2015/12/16}{removed}
% \end{macro}
% \begin{macro}{\tb@nt@autofloattype}
-% \changes{v3.06}{2010/06/01}{new internal}%^^A
+% \changes{v3.06}{2010/06/01}{added}
% This macro saves the float type for auto generated float types.
% \begin{macrocode}
\newcommand*{\tb@nt@autofloattype}{16}
%</body>
% \end{macrocode}
% \end{macro}
-% \end{macro}
+% \end{command}
%
%
-% \iffalse
+% \begin{macrocode}
%</package>
-%<*load>
+% \end{macrocode}
+%
+% \subsection{Loading the package}
% Used at \KOMAScript{} packages and classes to load the package.
% \begin{macrocode}
+%<*load>
\RequirePackage{tocbasic}[%
%!KOMAScriptVersion
]
-% \end{macrocode}
%</load>
-% \fi
+% \end{macrocode}
+%
%
% \Finale
+% \PrintChanges
%
\endinput
-%
-% end of file `tocbasic.dtx'
-%%% Local Variables:
-%%% mode: doctex
-%%% coding: utf-8
-%%% TeX-master: t
-%%% End:
+% Local Variables:
+% mode: doctex
+% ispell-local-dictionary: "en_US"
+% eval: (flyspell-mode 1)
+% TeX-master: t
+% TeX-engine: luatex-dev
+% eval: (setcar (or (cl-member "Index" (setq-local TeX-command-list (copy-alist TeX-command-list)) :key #'car :test #'string-equal) (setq-local TeX-command-list (cons nil TeX-command-list))) '("Index" "mkindex %s" TeX-run-index nil t :help "makeindex for dtx"))
+% End: