diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/tocbasic.dtx')
| -rw-r--r-- | Master/texmf-dist/source/latex/koma-script/tocbasic.dtx | 82 |
1 files changed, 43 insertions, 39 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/tocbasic.dtx b/Master/texmf-dist/source/latex/koma-script/tocbasic.dtx index d48a5a1481f..00d3a86df5b 100644 --- a/Master/texmf-dist/source/latex/koma-script/tocbasic.dtx +++ b/Master/texmf-dist/source/latex/koma-script/tocbasic.dtx @@ -1,8 +1,8 @@ -% \CheckSum{1335} +% \CheckSum{1340} % \iffalse meta-comment % ====================================================================== % tocbasic.dtx -% Copyright (c) Markus Kohm, 2008-2013 +% Copyright (c) Markus Kohm, 2008-2014 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -22,7 +22,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % tocbasic.dtx -% Copyright (c) Markus Kohm, 2008-2013 +% Copyright (c) Markus Kohm, 2008-2014 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -57,7 +57,7 @@ % Right brace \} Tilde \~} % % \iffalse -%%% From File: $Id: tocbasic.dtx 1533 2013-12-10 18:06:14Z mjk $ +%%% From File: $Id: tocbasic.dtx 1782 2014-08-18 10:48:22Z kohm $ %<*dtx> \ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi \ProvidesFile{tocbasic.dtx}[% @@ -202,13 +202,13 @@ The main purpose of package \Package{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 controll about these. For examples package +packages some types of control over these. For examples package \Package{tocbasic} delegates language control of all these tables and lists of contents to package \Package{babel}\IndexPackage{babel}%^^A %\iffalse^^A \ (see \cite{package:babel})%^^A %\fi^^A -. So automatic change of language will be provides inside +. So automatic change of language will be provided inside all these tables and lists of contents. Using \Package{tocbasic} will exculpate authors of classes and packages from implementation of such features. @@ -272,12 +272,12 @@ contents but also for the already mentioned lists of figures and tables. Basic commands are used to handle a list of all extensions\textnote{file extension, table or list of contents} known for files representing a table -of contents or list of something. Entries to such files are written using -\Macro{addtocontents}\important{\Macro{addtocontents}, - \Macro{addcontentsline}} or \Macro{addcontentsline} typically. There are -also commands to do something for all known extensions. And there are -commands to set or unset features of an extension or the file represented by -the extension. Typically an extension also has an owner\textnote{file owner}. +of contents or list of something. Entries to such files are typically written +using \Macro{addtocontents}\important{\Macro{addtocontents}, + \Macro{addcontentsline}} or \Macro{addcontentsline}. There are also +commands to do something for all known extensions. And there are commands to +set or unset features of an extension or the file represented by the +extension. Typically an extension also has an owner\textnote{file owner}. This owner may be a class or package or a term decided by the author of the class or package using \Package{tocbasic}, e.\,g., \KOMAScript{} uses the owner \texttt{float} for list of figures and list of tables, and the file name @@ -298,7 +298,7 @@ Command \Macro{ifattoclist}\Parameter{extension}\Parameter{true % \iffalse %</dtx> % \fi -may be used to ask, wether or not a \PName{extension} is already a known +may be used to ask, wether or not an \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 instructions} will be used. @@ -359,7 +359,7 @@ result in an empty owner. \addtotoclist{foo} \end{lstcode}% This will add the extension ``\PValue{foo}'' with owner ``\PValue{bar.sty}'' - to the list of known extensions, if it was not already at the list of known + to the list of known extensions, if it was not already on the list of known extensions. If the class or another package already added the extension you will get the error: \begin{lstoutput} @@ -377,7 +377,7 @@ result in an empty owner. or a mistake by the user. \end{lstoutput} - Maybe you package has a command, that creates list of files dynamically. In + Maybe your package has a command, that creates list of files dynamically. In this case you should use the optional argument of \Macro{addtotoclist} to set the owner. \begin{lstcode} @@ -397,12 +397,12 @@ result in an empty owner. You may use any owner you want. But it should be unique! So, if you would be, e.\,g., the author of package \Package{float} you could use for example owner ``\PValue{float}'' instead of owner ``\PValue{float.sty}'', so the -\KOMAScript{} options for list of figure and list of table will also handle -the lists of this package, that are already added to the known extensions, -when the option is used. This is because \KOMAScript{} already registers file -extension ``\PValue{lof}'' for the list of figures and file extension -``\PValue{lot}'' for the list of tables with owner ``\PValue{float}'' and sets -options for this owner. +\KOMAScript{} options for the list of figures and the list of tables will also +handle the lists of this package. Those are already added to the known +extensions when the option is used. This is because \KOMAScript{} already +registers file extension ``\PValue{lof}'' for the list of figures and file +extension ``\PValue{lot}'' for the list of tables with owner +``\PValue{float}'' and sets options for this owner. % \iffalse \EndIndex{Cmd}{addtotoclist}% % \fi @@ -420,10 +420,10 @@ Command \Macro{AtAddToTocList}\OParameter{owner}\Parameter{instructions} % \iffalse %</dtx> % \fi -adds the \PName{instructions} to a internal list of instructions, that will be -processed, whenever a file extension with the given \PName{owner} will be +adds the \PName{instructions} to a internal list of instructions that will be +processed whenever a file 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 kind as with command +optional argument is handled in the same way as with the command \Macro{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 @@ -467,8 +467,8 @@ Command \Macro{removefromtotoclist}\OParameter{owner}\Parameter{extension} %</dtx> % \fi 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 +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 an empty \PName{owner} is not the same like omitting the optional argument, but removes the \PName{extension} without any owner test.% @@ -487,17 +487,17 @@ but removes the \PName{extension} without any owner test.% % \iffalse %</dtx> % \fi -Until now you've learned to know commands, that result in more safety in +Until now you've learned to know commands that result in more safety in handling file extensions, but also needs some additional effort. With \Macro{doforeachtocfile}%^^A % \iffalse %<*dtx> % \fi -\OParameter{owner}\Parameter{instructions} +\OParameter{owner}\Parameter{instructions}%^^A % \iffalse %</dtx> % \fi -you'll win for this. The command provides to processes \PName{instructions} +\ you will win for this. The command provides to processes \PName{instructions} for every known file extension of the given \PName{owner}. While processing the \PName{instructions} \Macro{@currext} is the extension of the current file. If you omit the optional argument, \OParameter{owner}, every known file @@ -540,15 +540,15 @@ instead of \Macro{@starttoc}. See \autoref{sec:tocbasic.internals}%^^A % \fi for more information about \Macro{tocbasic@starttoc} and \Macro{@starttoc}. -This means, that after using \Macro{tocbasicautomode} every table of contents +This means that after using \Macro{tocbasicautomode} every table of contents or list of something, that will be generated using \Macro{@starttoc} will be -at least partial under control of \Package{tocbasic}. Whether or not this will +at least partially under control of \Package{tocbasic}. Whether or not this will make the wanted result, depends on the individual table of contents and lists of something. At least the \Package{babel} control extension for all those tables of contents and lists of something will work. Nevertheless, -it would be better, if the author of the corresponding class or package will +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 +\Package{tocbasic} may be used that will be described at the following sections.% % \iffalse \EndIndex{Cmd}{tocbasicautomode}% @@ -557,7 +557,7 @@ sections.% \section{Creating a Table of Contents or List of Something} \label{sec:tocbasic.toc} -At the previous section you've seen commands to handle a list of known +In the previous section you've seen commands to handle a list of known extensions and to trigger commands while adding a new extension to this list. You've also seen a command to do something for all known extensions or all known extensions of one owner. In this section you will see commands to @@ -579,8 +579,8 @@ Command \Macro{addtoeachtocfile}\OParameter{owner}\Parameter{content} % \fi writes \PName{content} to the files of every known file extension of \PName{owner} using \LaTeX{} kernel command \Macro{addtocontents}. If you omit -the optional argument, \PName{content} it written to the files of every known -file extension. Bay the way: The practical file name is build from +the optional argument, \PName{content} is written to the files of every known +file extension. Furthermore, the practical file name is built from \Macro{jobname} and the file extension. While writing the \PName{content}, \Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} is the extension of the currently handled file. @@ -944,7 +944,7 @@ head if wanted. The default is, to use without change of case. \Macro{MakeUppercase}\IndexCmd{MakeUppercase}\important{\Macro{MakeUppercase}} will be used for all other classes. If you are the class author you may define -\Macro{MakeMarkcase} on your own. If \Package{scrpage2} or another package, +\Macro{MakeMarkcase} on your own. If \Package{scrlayer} or another package, that defines \Macro{MakeMarkcase} will be used, \Package{tocbasic} will not overwrite that definition. \begin{Example} @@ -2993,7 +2993,9 @@ may be found in \autoref{tab:tocbasic.DeclareNewTOC-options}. % \end{macrocode} % The counter and hooks of float and nonfloat environments: % \changes{v3.10b}{2012/04/04}{\cs{noexpand} added to fix problems using -% \cs{autodot}} +% \cs{autodot}}%^^A +% \changes{v3.13}{2014/07/31}{add \cs{autodot} only to hierachical +% counters}%^^A % \begin{macrocode} \if@tempswa \@ifundefined{c@\tb@nt@type}{% @@ -3020,7 +3022,9 @@ may be found in \autoref{tab:tocbasic.DeclareNewTOC-options}. \expandafter\noexpand\csname \tb@nt@type name\endcsname \noexpand\nobreakspace \expandafter\noexpand\csname the\tb@nt@type\endcsname - \noexpand\csname autodot\endcsname + \ifx\tb@nt@counterwithin\@empty\else + \noexpand\csname autodot\endcsname + \fi }% \noexpand\newcommand*\expandafter\noexpand \csname fnum@\tb@nt@type\endcsname{% |