diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex | 162 |
1 files changed, 86 insertions, 76 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex index 95d01f243d1..f168ad4ddd8 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex @@ -1,6 +1,6 @@ % ====================================================================== % scrextend.tex -% Copyright (c) Markus Kohm, 2002-2017 +% Copyright (c) Markus Kohm, 2002-2018 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % scrextend.tex -% Copyright (c) Markus Kohm, 2002-2017 +% Copyright (c) Markus Kohm, 2002-2018 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -46,57 +46,69 @@ % ====================================================================== \KOMAProvidesFile{scrextend.tex} - [$Date: 2017-05-11 15:48:59 +0200 (Thu, 11 May 2017) $ + [$Date: 2018-03-27 11:46:14 +0200 (Tue, 27 Mar 2018) $ KOMA-Script package scrextend] -\translator{Markus Kohm} +\translator{Markus Kohm\and Karl Hagen} -% Date of the translated German file: 2017-01-02 +% Date of the translated German file: 2018-01-24 -\chapter[{\KOMAScript{} Features for other Classes with Package - \Package{scrextend}}]{Making Basic Feature of the \KOMAScript{} Classes - Available with Package \Package{scrextend} while Using Other Classes} +\chapter[{\KOMAScript{} Features for Other Classes with \Package{scrextend}}] + {Using Basic Features of the \KOMAScript{} Classes in Other Classes with the + \Package{scrextend} Package} \labelbase{scrextend} \BeginIndexGroup% \BeginIndex{Package}{scrextend}% -There are several features, that are shared by all \KOMAScript{} classes. This -means not only the classes \Class{scrbook}, \Class{scrreprt}, and -\Class{scrartcl}, that has been made as a drop-in replacement for the standard -classes \Class{book}, \Class{report}, and \Class{article}, but also for -several features of the \KOMAScript{} class \Class{scrlttr2}, the successor of -\Class{scrlettr}, that may be used for letters. These basic features, that may -be found in the above-named classes, are also provided by package -\Package{scrextend} since \KOMAScript{} release~3.00. This package should not -be used together with a \KOMAScript{} class, but may be used together with -many other classes. Package \Package{scrextend} would recognize, if it would -be used with a \KOMAScript{} class, and would terminate with a warning message -in that case. - -There is no warranty for compatibility of \Package{scrextend} with every -class. The package has been designed primary to extend the standard classes -and derived classes. Anyway, before using \Package{scrextend} you should -make sure that the used class does not already provide the feature you need. - -Beside the features from this chapter, there are additional common features, -that are mainly provides for authors of classes and packages. These may be -found in \autoref{cha:scrbase} from \autopageref{cha:scrbase}. The package -\Package{scrbase}\important{\Package{scrbase}}, that has been described at -that chapter, was designed to be used mainly by authors of classes and -packages. Package \Package{scrextend} and all \KOMAScript{} classes also use -that package. - -\KOMAScript{} classes and package \Package{scrextend} also load package -\Package{scrlfile}\important{\Package{scrlfile}} described in -\autoref{cha:scrlfile} from \autopageref{cha:scrlfile}. Because of this the -features of that package are also available when using \Package{scrextend}. +There are some features that are common to all \KOMAScript{} classes. This +applies not only to the \Class{scrbook}, \Class{scrreprt}, and +\Class{scrartcl} classes, which are intended to replace the standard classes +\Class{book}, \Class{report}, and \Class{article}, but also to a large extend +the \KOMAScript{} class \Class{scrlttr2}, the successor to \Class{scrlettr}, +which is intended for letters. These basic features, which can be found in the +classes mentioned above, are also provided by package \Package{scrextend} from +\KOMAScript{} version~3.00 onward. This\textnote{Attention!} package should +not be used with \KOMAScript{} classes. It is intended for use with other +classes only. If you attempt to load the package with a \KOMAScript{} class, +\Package{scrextend} will detect this and reject loading it with a warning +message. + +The fact that \hyperref[cha:scrlttr2]{\Package{scrletter}}% +\IndexPackage{scrletter} can be used not only with \KOMAScript{} classes but +also with the standard classes is partly due to \Package{scrextend}. If +\hyperref[cha:scrlttr2]{\Package{scrletter}} detects that it is not being used +with a \KOMAScript class, it automatically loads \Package{scrextend}. Doing +so makes all required \KOMAScript{} classes available. + +Of course, there is no guarantee that \Package{scrextend} will work with all +classes. The package has been designed primarily to extend the standard +classes and those derived from them. In any case, before you use +\Package{scrextend}, you should first make sure that the class you are using +does not already provide the feature you need. + +In addition to the features described in this chapter, there are a few more +that are primarily intended for authors of classes and packages. These can be +found in \autoref{cha:scrbase}, starting on \autopageref{cha:scrbase}. The +\hyperref[cha:scrbase]{\Package{scrbase}}% +\important{\hyperref[cha:scrbase]{\Package{scrbase}}}\IndexPackage{scrbase} +package documented there is used by all \KOMAScript{} classes and the +\Package{scrextend} package. + +All \KOMAScript{} classes and the \Package{scrextend} package also load the +\hyperref[cha:scrlfile]{\Package{scrlfile}}% +\important{\hyperref[cha:scrlfile]{\Package{scrlfile}}}\IndexPackage{scrlfile} +package described in \autoref{cha:scrlfile} starting on +\autopageref{cha:scrlfile}. Therefore the features of this package are also +available when using \Package{scrextend}. \iftrue % Umbruchkorrekturtext -In difference to the above, only the \KOMAScript{} classes \Class{scrbook}, -\Class{scrreprt}, and \Class{scrartcl} load package \Package{tocbasic} (see -\autoref{cha:tocbasic} from \autopageref{cha:tocbasic}), that has been -designed to be used by authors of classes and packages too. Because of this -\Package{scrextend} does not provide the features of this package. Nevertheless -you may use \Package{tocbasic} together with \Package{scrextend}.% +In contrast, only the \KOMAScript{} classes \Class{scrbook}, \Class{scrreprt}, +and \Class{scrartcl} load the \hyperref[cha:tocbasic]{\Package{tocbasic}} +package (see \autoref{cha:tocbasic} starting on \autopageref{cha:tocbasic}), +which is designed for authors of classes and packages. For this reason, the +features defined there are found only in those classes and not in +\Package{scrextend}. Of course you can still use +\hyperref[cha:tocbasic]{\Package{tocbasic}} together with +\Package{scrextend}.% \fi \LoadCommonFile{options}% \section{Early or late Selection of Options} @@ -107,33 +119,32 @@ you may use \Package{tocbasic} together with \Package{scrextend}.% \section{Optional, Extended Features} \seclabel{optionalFeatures} -Package \Package{scrextend} provides some optional, extended features. Such -features are not available by default, but may be activated -additionally. These features are optional, i.\,e., because the conflict with -features of the standard classes of often used packages. +The \Package{scrextend} package provides some optional, extended features. +These features are not available by default but can be activated. These +features are optional because, for example, they may conflict with features of +the standard classes of other commonly used packages. \begin{Declaration} \OptionVName{extendedfeature}{feature} \end{Declaration} -With this option an extended \PName{feature} of \Package{scrextend} may be -activated. Option \Option{extendedfeature} is available only while loading the -package \Package{scrextend}. User have to set the option in the optional -argument of \DescRef{\LabelBase.cmd.usepackage}\OParameter{optional - argument}\PParameter{scrextend}. % +With this option, you can activate an extended \PName{feature} of +\Package{scrextend}. This option is available only while loading +\Package{scrextend}. You must therefore specify this option in the optional +argument of \DescRef{\LabelBase.cmd.usepackage}\PParameter{scrextend}. % \iffree{% - An overview of all available optional features is shown in + An overview of all available features is shown in \autoref{tab:scrextend.optionalFeatures}. \begin{table} - \caption[{optional available extended features of - \Package{scrextend}}]{overview of the optional available extended + \caption[{available extended features of + \Package{scrextend}}]{overview of the optional extended features of \Package{scrextend}} \label{tab:scrextend.optionalFeatures} \begin{desctabular} \entry{\PName{title}}{% - extends the title pages to the features of the \KOMAScript{} classes; - this means not only the commands for the title page but also option - \DescRef{\LabelBase.option.titlepage} (see + title pages have the additional features of the \KOMAScript{} classes; + this applies not only to the commands for the title page but also to + the \DescRef{\LabelBase.option.titlepage} option (see \autoref{sec:scrextend.titlepage}, from \autopageref{sec:scrextend.titlepage})% }% @@ -142,13 +153,11 @@ argument of \DescRef{\LabelBase.cmd.usepackage}\OParameter{optional }{% \par% Currently the only available extended \PName{feature} is - \PValue{title}\IndexOption[indexmain]{extendedfeature~=\PValue{title}}% - \important[i]{\begin{tabular}[t]{@{}r@{}} - \KOption{extendedfeature}\hspace*{1em}\\\PValue{title}\end{tabular}}. - This \PName{feature} provides the title pages of the \KOMAScript{} - classes. See \autoref{sec:scrextend.titlepage} from - \autopageref{sec:scrextend.titlepage} for description of these kind of title - pages.% + \PValue{title}\IndexOption[indexmain]{extendedfeature~=\textKValue{title}}% + \important{\OptionValue{extendedfeature}{title}}. + This \PName{feature} gives title pages the features of the \KOMAScript{} + classes, as described in \autoref{sec:scrextend.titlepage} starting on + \autopageref{sec:scrextend.titlepage}.% }% % \EndIndexGroup @@ -164,29 +173,30 @@ argument of \DescRef{\LabelBase.cmd.usepackage}\OParameter{optional \LoadCommonFile{oddorevenpage}% \section{Detection of Odd and Even Pages} -\section{Head and Foot Using Predefined Page Styles} +\section{Choosing a Predefined Page Style} \seclabel{pagestyle} One of the basic features of a document is the page -style\Index[indexmain]{page>style}. Page style in \LaTeX{} means mainly header -and footer of the page. Package \Package{scrextend} does not define any page -style, but it uses and expects the definition some page styles. +style\Index[indexmain]{page>style}. In \LaTeX{}, the page style primarily +determines the content of headers and footers. The \Package{scrextend} package +does not define any page styles itself. Instead it uses the page styles of the +\LaTeX{} kernel. \begin{Declaration} \Macro{titlepagestyle} \end{Declaration}% \Index{title>page style}% -Some pages have a different page style automatically selected using -\DescRef{maincls.cmd.thispagestyle}. With \Package{scrextend} this will be -used currently for the page with the in-page title if and only if option +On some pages \DescRef{maincls.cmd.thispagestyle}\IndexCmd{thispagestyle} +automatically selects a different page style. Currently, \Package{scrextend} +only does this for title pages, and only if \OptionValueRef{\LabelBase}{extendedfeature}{title} has been used (see \autoref{sec:scrextend.optionalFeatures}, \DescPageRef{scrextend.option.extendedfeature}). In this case the page style -stored at \DescRef{maincls.cmd.thispagestyle} will be used. Default for +specified in \DescRef{maincls.cmd.thispagestyle} will be used. The default for \DescRef{maincls.cmd.thispagestyle} is -\PageStyle{plain}\IndexPagestyle{plain}. This page style is predefined by the -\LaTeX{} kernel. So it should be available always.% +\PageStyle{plain}\IndexPagestyle{plain}. This page style is defined by the +\LaTeX{} kernel, so it should always be available.% \EndIndexGroup \LoadCommonFile{interleafpage}% \section{Interleaf Pages} |