diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/common-compatibility.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/common-compatibility.tex | 190 |
1 files changed, 103 insertions, 87 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-compatibility.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-compatibility.tex index f397b67f842..bed043d8d37 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-compatibility.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-compatibility.tex @@ -1,6 +1,6 @@ % ====================================================================== % common-compatibility.tex -% Copyright (c) Markus Kohm, 2001-2017 +% Copyright (c) Markus Kohm, 2001-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. % ---------------------------------------------------------------------- % common-compatibility.tex -% Copyright (c) Markus Kohm, 2001-2017 +% Copyright (c) Markus Kohm, 2001-2018 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -46,11 +46,11 @@ % ====================================================================== \KOMAProvidesFile{common-compatibility.tex} - [$Date: 2017-03-22 09:50:43 +0100 (Wed, 22 Mar 2017) $ + [$Date: 2018-02-28 13:23:23 +0100 (Wed, 28 Feb 2018) $ KOMA-Script guide (common paragraphs)] -\translator{Markus Kohm\and Krickette Murabayashi} +\translator{Markus Kohm\and Krickette Murabayashi\and Karl Hagen} -% Date of the translated German file: 2017-03-22 +% Date of the translated German file: 2018-01-30 \section{Compatibility with Earlier Versions of \KOMAScript} \seclabel{compatibilityOptions} @@ -58,122 +58,138 @@ \BeginIndex{}{Compatibility} \IfThisCommonFirstRun{}{% - It applies, mutatis mutandis, what is written in - \autoref{sec:\ThisCommonFirstLabelBase.compatibilityOptions}. - \IfThisCommonLabelBase{scrlttr2}{However, this feature exists at - \Class{scrlttr2} since version~2.9t. }% - So if you have alread read and understood - \autoref{sec:\ThisCommonFirstLabelBase.compatibilityOptions} you can - switch to \autopageref{sec:\ThisCommonLabelBase.compatibilityOptions.next}, + The information in + \autoref{sec:\ThisCommonFirstLabelBase.compatibilityOptions} applies equally + to this chapter. + \IfThisCommonLabelBase{scrlttr2}{However, this feature has existed in + \Class{scrlttr2} since version~2.9t, whereas \Package{scrletter} does not + offer it. }{}% + So if you have already read and understood + \autoref{sec:\ThisCommonFirstLabelBase.compatibilityOptions} you can skip + ahead to \autopageref{sec:\ThisCommonLabelBase.compatibilityOptions.next}, \autopageref{sec:\ThisCommonLabelBase.compatibilityOptions.next}.% } -\IfThisCommonLabelBase{typearea}{% - Those who achieve their documents in source code set utmost value to the - fact that future \LaTeX{} runs will yield exactly the same - result. Nevertheless, in some cases improvement and bug corrections of - packages will result in changes of the behaviour and make-up. But sometimes - this is not wanted.% +\IfThisCommonLabelBaseOneOf{typearea,maincls,scrlttr2,scrextend}{% + Those who produce their documents from source code typically attach the + utmost importance to the fact that future \LaTeX{} runs will yield exactly + the same result. In some cases, however, improvements and bug fixes to the + \IfThisCommonLabelBaseOneOf{maincls,scrlttr2}{class}{package} will + result in changes of behaviour, especially to the layout. This, however, + may be undesirable.% }{% - \IfThisCommonLabelBase{maincls}{% - Those who achieve their documents in source code set utmost value to the - fact that future \LaTeX{} runs will yield exactly the same - result. However, sometimes improvement and bug corrections of classes will - result in changes of the behaviour and make-up. But sometimes this is not - wanted. }{% - \IfThisCommonLabelBase{scrextend}{% - Those who achieve their documents in source code set utmost value to the - fact that future \LaTeX{} runs will yield exactly the same result. In - some cases improvement and bug corrections of packages will result in - changes of the behaviour and make-up. But sometimes this is not wanted.% - }{% - \IfThisCommonLabelBase{scrlttr2}{% - In some cases improvement and bug corrections of classes will result - in changes of the behaviour and make-up. But sometimes this is not - wanted.% - }{\InternalCommonFileBaseError}% - }% - }% -} + % \IfThisCommonLabelBase{scrextend}{% + % In some cases, improvements and bug fixes to the package will result + % in changes of behaviour, especially to the layout. This, however, + % may be undesirable. Those who produce their documents from source code + % typically attach the utmost importance to the fact that future + % \LaTeX{} runs will yield exactly the same result.% + % }{% + \ThisCommonLabelBaseFailure + % \IfThisCommonLabelBase{scrlttr2}{% + % In some cases, improvements and bug fixes to the package will result + % in changes of behaviour, especially to the layout. This, however, + % may be undesirable. + % }{}% + % }% +}% + \begin{Declaration} \OptionVName{version}{value}% \OptionValue{version}{first}% \OptionValue{version}{last} \end{Declaration} -\IfThisCommonLabelBase{scrextend}{At }{Since }% -\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% -\ChangedAt{v2.9t}{\Class{scrlttr2}}% -\ChangedAt{v3.01b}{\Package{typearea}}% -\IfThisCommonLabelBase{typearea}{% - version~3.01b of \Package{typearea} }{% - \IfThisCommonLabelBase{maincls}{% - version~2.96a of \KOMAScript{} }{% - \IfThisCommonLabelBase{scrlttr2}{% - version~2.9t of \Class{scrlttr2} }{% - \IfThisCommonLabelBase{scrextend}{% - \Package{scrextend} }{\InternalCommonFileUsageError}% +%\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}% +%\ChangedAt{v2.9t}{\Class{scrlttr2}}% +%\ChangedAt{v3.01b}{\Package{typearea}}% +\IfThisCommonLabelBase{scrextend}{With \Package{scrextend}, you can}{Since + \IfThisCommonLabelBase{typearea}{% + Version~3.01b, \Package{typearea}\ChangedAt{v3.01b}{\Package{typearea}}}{% + \IfThisCommonLabelBase{maincls}{% + Version~2.96a, \KOMAScript{}\ChangedAt{v2.96a}{\Class{scrbook}\and + \Class{scrreprt}\and \Class{scrartcl}}}{% + \IfThisCommonLabelBase{scrlttr2}{% + Version~2.9t, \Class{scrlttr2}\OnlyAt{\Class{scrlttr2}}% + \ChangedAt{v2.9t}{\Class{scrlttr2}}}{% + \InteralCommonFileUsageError}% }% }% -}% -it's your choice if your source code should result in the same make-up at -future \LaTeX{} runs or if you like to participate in all improvements of new -releases\IfThisCommonLabelBaseOneOf{maincls,scrlttr2}{ of the class}{}. You -may select the compatible version of \KOMAScript{} with option -\Option{version}. Compatibility to the lowest supported \KOMAScript{} release -may be achieved by +\ has been able to } +choose whether the source file should, as much as possible, +continue to produce exactly the same result within a \LaTeX{} run or should +be formatted according to the modifications of the latest version% +\IfThisCommonLabelBaseOneOf{maincls,scrlttr2}{ of the class}{}. You +can specify the version with which you want your file to be compatible by +using the \Option{version} option. Compatibility with the oldest supported +\KOMAScript{} version can be achieved with \OptionValue{version}{first}\important{\OptionValue{version}{first}} or \OptionValue{version}{2.9} or \OptionValue{version}{2.9t}. Setting \PName{value} to an unknown release number will result in a warning message and selects \OptionValue{version}{first} for safety. -With \OptionValue{version}{last} the most recent version will be selected at -every \LaTeX{} run. Be warned, though, that using \OptionValue{version}{last} -poses possibilities of compatibility issues for future \LaTeX{} runs. Option -\Option{version} without any \PName{value} means the -same. \ChangedAt{v3.01a}{\Class{scrbook}\and \Class{scrreprt}\and - \Class{scrartcl}\and \Class{scrlttr2}\and \Package{scrextend}}This is the -default behaviour as long as you do not use any deprecated options. +With \OptionValue{version}{last}\important{\OptionValue{version}{last}}% +\textnote{default}, you can select the latest version. In this case, you give +up backwards compatibility. If the option is used without a value, +\PValue{last} is assumed. This\ChangedAt{v3.01a}{\Class{scrbook}\and + \Class{scrreprt}\and \Class{scrartcl}\and \Class{scrlttr2}\and + \Package{scrextend}} also corresponds to the default setting, as long as you +do not use any deprecated options. -If\textnote{Attention!} you use a deprecated option of \KOMAScript~2, -\KOMAScript~3 will switch to \OptionValue{version}{first} automatically. This -will also result in a warning message that explains how to prevent this -switching. Alternatively you may select another adjustment using option -\Option{version} with the wanted compatibility after the deprecated option. +\IfThisCommonLabelBase{scrextend}{% scrextend doesn't recognize obsolete options +}{% + If\textnote{Attention!} you use a deprecated option of \KOMAScript~2, + \KOMAScript~3 will switch to \OptionValue{version}{first} automatically. + This will also result in a warning message that explains how to prevent + this switch. Alternatively, you can choose a different setting for + \Option{version} with the desired compatibility after the deprecated + option.% +} -Compatibility is primarily make-up compatibility. New features not related to -the mark-up will be available even if you switch compatibility to a version -before first implementation of the feature. Option \Option{version} does not -influence make-up changes that are motivated by bug fixes. If you need bug -compatibility you should physically save the used \KOMAScript{} version -together with your document. +Compatibility is primarily a question of line and page breaks (wrapping). If +you choose compatibility with an older version, new options that do not affect +wrapping are still available. The \Option{version} option does not affect any +wrapping changes that are the result of fixing unambiguous errors. +If\textnote{Hint!} you need unconditional wrapping compatibility even in the +case of bugs, you should physically save the old \KOMAScript{} version you +need together with your document. \IfThisCommonLabelBase{scrlttr2}{% \begin{Example} - The letter examples of this chapter should use and show all the features - of the recent \KOMAScript{} release. To achieve this, we set the - corresponding compatibility:% + The example letters in this chapter should use all the features of the + latest version of \KOMAScript{}. For this, the we set the compatibility + correspondingly when loading the class:% \lstinputcode[xleftmargin=1em,lastline=1]{letter-0.tex}% In this case the symbolic value \PValue{last} has been used to select the latest version.% - \end{Example}% -}{} + \iftrue% Umbruchkorrektur + Here, the latest version was simply chosen with the symbolic value + \PValue{last}.% + \else% + In order not to have to specify a new version number for each new version, + the symbolic value \PValue{last} was chosen here.% + \fi + \end{Example}}{} -Please note\textnote{Attention!} that you cannot change option -\Option{version} anymore after loading the % +Note\textnote{Attention!} that you cannot change the \Option{version} option +after loading the % \IfThisCommonLabelBaseOneOf{maincls,scrlttr2}{class}{% - package \IfThisCommonLabelBase{typearea}{\Package{typearea}}{% - \IfThisCommonLabelBase{scrextend}{\Package{scrextend}}{% + \IfThisCommonLabelBase{typearea}{\Package{typearea}}{% + \IfThisCommonLabelBase{scrextend}{\Package{scrextend}}{% \InternalCommonFileUsageError }% }% -}. Therefore, the usage of option \Option{version} within the argument of +\ package}. Setting this option with \DescRef{\ThisCommonLabelBase.cmd.KOMAoptions} or -\DescRef{\ThisCommonLabelBase.cmd.KOMAoption} is not recommended and will -cause an error.% +\DescRef{\ThisCommonLabelBase.cmd.KOMAoption} will +therefore cause an error.% \EndIndexGroup % \EndIndexGroup +\phantomsection +\label{sec:\ThisCommonLabelBase.compatibilityOptions.end} +\endinput + %%% Local Variables: %%% mode: latex %%% coding: us-ascii |