diff options
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.tex | 90 |
1 files changed, 62 insertions, 28 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 6020dd474dd..eb017eee545 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 @@ -46,10 +46,10 @@ % ====================================================================== \KOMAProvidesFile{tocbasic.tex} - [$Date: 2016-04-23 19:14:01 +0200 (Sat, 23 Apr 2016) $ + [$Date: 2016-06-14 09:11:22 +0200 (Tue, 14 Jun 2016) $ KOMA-Script guide (package tocbasic)] -% Date of translated German file: 2016/04/07 +% Date of translated German file: 2016/06/13 \translator{Markus Kohm\and Arndt Schubert} @@ -633,6 +633,10 @@ single features. \Package{tocbasic} does know following features: \Package{scrwfile}\important{\Package{scrwfile}}\IndexPackage{scrwfile} uses this feature also for clone destinations, because those will get the language change from the clone source already. + + Please note\textnote{Attention!}, the feature is executed while adding a + file extension to the list of known file extension. Changing the feature + afterwards would not have any effect. \item[\texttt{noparskipfake}] prevents\ChangedAt{v3.17}{\Package{tocbasic}} usage of an extra \Length{parskip} before switching \Length{parskip} off. In general, the consequence of this feature for documents using paragraph @@ -967,11 +971,11 @@ Currently, \Package{tocbasic} defines the following entry styles: \PValue{breakafternumber}, \PValue{indent}, \PValue{linefill}, \PValue{numsep}, \PValue{numwidth}, \PValue{onstarthigherlevel}, \PValue{onstartlowerlevel}, \PValue{onstartsamelevel}, - \PValue{pagenumberbox}, \PValue{pagenumberformat}, and - \PValue{raggedpagenumber}. The defaults of all these attributes depend 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{pagenumberbox}, \PValue{pagenumberformat}, \PValue{raggedentrytext}, + and \PValue{raggedpagenumber}. The defaults of all these attributes depend + 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 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 @@ -1188,13 +1192,17 @@ Currently, \Package{tocbasic} defines the following entry styles: \end{description} \hyperref[tab:tocbasic.tocstyle.attributes]% {Table~\ref*{tab:tocbasic.tocstyle.attributes}} describes all attributes of -all styles defined by \Package{tocbasic}. If you want to use these attributes -as options to \Macro{DeclareNewTOC} (see -\autopageref{desc:tocbasic.cmd.DeclareNewTOC}) or -\Macro{DeclareSectionCommand} (see +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 +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 -commands you have to prefix the names of the attributes by \PValue{toc}, e\,g., -attribute \PValue{level} becomes option \Option{toclevel}. +commands you have to prefix the names of the attributes by \PValue{toc}, +e\,g., attribute \PValue{level} becomes option \Option{toclevel}. Last but not least using \Macro{DeclareTOCStyleEntry} will define internal command \Macro{l@\PName{entry level}}. @@ -1400,7 +1408,17 @@ command \Macro{l@\PName{entry level}}. all other levels prints the argument in \Macro{normalfont}\Macro{normalcolor}.% }% - \entry{\KOption{raggedpagenumber}\PName{switch}}{% + \entry{\KOption{raggedentrytext}\PName{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 + switch is active, style \PValue{tocline} does print the text of an entry + left-aligned instead of justified and only word, that are longer than a + text line, are automatically hyphenated. + + This switch is not active by default.% + }% + \entry{\KOption{raggedpagenumber}\PName{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 @@ -2038,7 +2056,7 @@ options cannot be set using \Macro{KOMAoptions}\IndexCmd{KOMAoptions}! An overview of all available options may be found in \autoref{tab:tocbasic.DeclareNewTOC-options}. -If\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} option \Option{tocentrystyle} +If\ChangedAt[2015/12]{v3.20}{\Package{tocbasic}} option \Option{tocentrystyle} is not used, style \PValue{default} will be used. For information about this style see \autoref{sec:tocbasic.tocstyle}. If you do not want to define a command for entries to the list of something, you can use an empty argument, @@ -2046,12 +2064,13 @@ i.\,e., \OptionValue{tocentrystyle}{} or \OptionValue{tocentrystyle}{\PParameter{}}. Nevertheless, this would contain the risk to get a lot of errors while printing that list. -Depending\ChangedAt[2016/03]{v3.20}{\Package{tocbasic}} on the style of the +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 -\PValue{toc}. Later changes of the style of the entries can be made using +\PValue{tocentry}. Later changes of the style of the entries can be made using \Macro{DeclareTOCStyleEntry}% \IndexCmd{DeclareTOCStyleEntry}\important{\Macro{DeclareTOCStyleEntry}}. See \autoref{sec:tocbasic.tocstyle}, @@ -2105,35 +2124,40 @@ about the styles.% before.% }% \entry{\KOption{hang}\PName{length}}{% - \ChangedAt{v3.20}{\Package{tocbasic}}% + \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 hanging indent of the entries for that list\index{table of contents>entry} depend on attributes of the TOC-entry style given by option \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{tocnumwidth}\PName{value}. The - \KOMAScript{} classed for example use \OptionValue{tocnumwidth}{2.3em}.% + the real \PName{value} using \KOption{tocentrynumwidth}\PName{value}. The + \KOMAScript{} classed for example use + \OptionValue{tocentrynumwidth}{2.3em}.% }% \entry{\KOption{indent}\PName{length}}{% - \ChangedAt{v3.20}{\Package{tocbasic}}% + \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 indenting the entries of that list\index{table of contents>entry} depend on attributes of the TOC-entry style given by option \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{tocindent}\PName{value}. The - \KOMAScript{} classed for example use \OptionValue{tocnumwidth}{1.5em}.% + the real \PName{value} using \KOption{tocentryindent}\PName{value}. The + \KOMAScript{} classed for example use + \OptionValue{tocentrynumwidth}{1.5em}.% }% \entry{\KOption{level}\PName{number}}{% - \ChangedAt{v3.20}{\Package{tocbasic}}% + \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 entries of that list\index{table of contents>entry} depend on attributes 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{toclevel}\PName{value}.% + change the real \PName{value} using \KOption{tocentrylevel}\PName{value}.% }% \entry{\KOption{listname}\PName{string}}{% The name of the TOC. If not given the value of \PValue{types} with upper @@ -2153,17 +2177,27 @@ about the styles.% \PValue{float} will be used.% }% \entry{\KOption{tocentrystyle}\PName{TOC-entry style}}{% - \ChangedAt[2016/03]{v3.20}{\Package{tocbasic}}% + \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 level is given by option \Option{type}. Additional to the options of 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 by \PValue{toc}. For example, you can change the numerical level of the - entries using option \Option{toclevel}. For more information about the - styles and their attributes see \autoref{sec:tocbasic.tocstyle} from + entries using option \Option{tocentrylevel}. For more information about + the styles and their attributes see \autoref{sec:tocbasic.tocstyle} from \autopageref{sec:tocbasic.tocstyle}.% }% + \entry{\KOption{tocentry\PName{style-option}}\PName{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}, + \autopageref{sec:tocbasic.tocstyle} for additional information about + TOC-entry styles. See \autoref{tab:tocbasic.tocstyle.attributes}, + \autopageref{tab:tocbasic.tocstyle.attributes} for information about the + attributes of the predefined TOC-entry styles of package + \Package{tocbasic}, that can be used as \PName{style-option}.% + }% \entry{\KOption{type}\PName{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 |