diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex | 336 |
1 files changed, 119 insertions, 217 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex index 07ae5818839..f70e995ec42 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex @@ -1,6 +1,6 @@ % ====================================================================== % scrlttr2.tex -% Copyright (c) Markus Kohm, 2002-2007 +% Copyright (c) Markus Kohm, 2002-2008 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % scrlttr2.tex -% Copyright (c) Markus Kohm, 2002-2007 +% Copyright (c) Markus Kohm, 2002-2008 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3b, verteilt und/oder veraendert werden. @@ -45,7 +45,7 @@ % % ============================================================================ -\ProvidesFile{scrlttr2.tex}[2007/12/17 KOMA-Script guide (chapter: scrlttr2)] +\ProvidesFile{scrlttr2.tex}[2008/07/10 KOMA-Script guide (chapter: scrlttr2)] \translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm} @@ -116,7 +116,7 @@ you want to use \Class{scrlttr2}, you will have to install the perhaps also fewer optional arguments. You will see that when discussing the \Environment{letter} environment in \autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.environment.letter}. The class will + \autopageref{desc:scrlttr2.env.letter}. The class will automatically load the \Package{keyval} package. If you need to supply options to the \Package{keyval} package, you should use the \Macro{PassOptionsToPackage} command before \Macro{documentclass}. @@ -224,55 +224,6 @@ automatically, and the class then controls the package. The necessary options will be explained in this section. \begin{Declaration} - \Option{paper}=\PName{format} -\end{Declaration} -\BeginIndex{Option}{paper}% -\BeginIndex{}{paper format}% -This option defines the paper format. Theoretically, all paper formats -known by the \Package{typearea} are supported. However, you must leave -out the suffix \PValue{paper} when entering a value. So, for letter -format, you would use the value \PValue{letter}. The formats of the -ISO A, B, C, and D series must be entered in lowercase letters, e.\,g., -\PValue{a4} for ISO A4. See also \autoref{sec:typearea.paperTypes}. - -\begin{Explain} - Although every paper size supported by \Package{typearea} can be - used, several formats may result in unexpected results on the first - page of a letter. That is not a conceptual problem with the class, - but a reflection that there currently exist only parameter sets for - ISO A4. Unfortunately, there are no general rules to calculate the - placement of the address field and so on for arbitrary paper - sizes. However, it is possible to define additional parameter sets - for different paper sizes. See \autoref{sec:scrlttr2.lcoFile} for more - information. - -\end{Explain} -% -\EndIndex{Option}{paper}% -\EndIndex{}{paper format}% - -\begin{Declaration} - \Option{BCOR}=\PName{length}\\ - \Option{DIV}=\PName{value}\\ - \Option{headlines}=\PName{count} -\end{Declaration} -\BeginIndex{Option}{BCOR}% -\BeginIndex{Option}{DIV}% -\BeginIndex{Option}{header lines}% -The options for the divisor, the binding correction\Index{binding - correction}, and the number of headlines will be translated directly -into the corresponding options of the \Package{typearea} package and -passed to it. If the options are set using \Macro{KOMAoptions} and -not as class options, the \Macro{typearea} command from the -\Package{typearea} package will be used instead. See -\autoref{sec:typearea.options}, -\autopageref{desc:typearea.macro.typearea}. -% -\EndIndex{Option}{BCOR}% -\EndIndex{Option}{DIV}% -\EndIndex{Option}{header lines}% - -\begin{Declaration} \Option{enlargefirstpage} \end{Declaration} \BeginIndex{Option}{enlargefirstpage}% @@ -290,25 +241,12 @@ description of the pseudo-length \PLength{firstfootvpos} in \autoref{sec:scrlttr2.firstFoot}, \autopageref{desc:scrlttr2.plength.firstfootvpos}. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}. % \EndIndex{Option}{enlargefirstpage}% - -\begin{table} - \centering - \caption{Standard values for simple switches in \Class{scrlttr2}} - \begin{tabular}{ll} - Value & Description \\\hline\\[-1.75ex] - \PValue{true} & activates the option \\ - \PValue{on} & activates the option \\ - \PValue{false}& deactivates the option \\ - \PValue{off} & deactivates the option \\ - \end{tabular} - \label{tab:scrlttr2.simpleSwitchValues} -\end{table} - +% \EndIndex{}{page>layout}% \subsection{Other Layout Options} @@ -321,46 +259,9 @@ general. Strictly speaking, all page layout options vice versa for some of them. \begin{Declaration} - \Option{mpinclude}\\ - \Option{mpexclude} -\end{Declaration} -\BeginIndex{Option}{mpinclude}% -\BeginIndex{Option}{mpexclude}% -These two options of the \Package{typearea} package should not be used -with the \Class{scrlttr2} class, because the first page in particular -does not take this option into account. To anticipate any complaints, a -warning will be issued when this option is used. If you feel adventurous -you could try how these options, especially \Option{mpinclude}, interact -with other class options. -% -\EndIndex{Option}{mpinclude}% -\EndIndex{Option}{mpexclude}% - -\begin{Declaration} - \Option{twoside} -\end{Declaration}% -\BeginIndex{Option}{oneside}% -From the author's point of view, double-sided letters do not make much -sense. Therefore, the option \Option{twoside} only partially switches -to double-sided layout. You thus get the possibility to have different -margins on left and right pages, but this possibility is not used. So -this option really means \emph{activate the possibilities of a - double-sided document, but stay with the one-sided layout as far and - as long as possible.} This option can take the standard values for -simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is -\PValue{false}. -% -\EndIndex{Option}{twoside}% - -By the way, double-sided letters are not supported, because they seem -entirely unreasonable. - -\begin{Declaration} \Option{cleardoublepage}=\PName{style} \end{Declaration} -\BeginIndex{Option}{cleardoublepage}% +\BeginIndex{Option}{cleardoublepage~=\PName{style}}% If you want pages inserted by the \Macro{cleardoublepage} command to just contain a page number in the header and footer, or to be empty, this can be accomplished with this option. There are three different @@ -381,21 +282,21 @@ styles supported that are listed at \end{desctabular} \end{table} % -\EndIndex{Option}{cleardoublepage}% +\EndIndex{Option}{cleardoublepage~=\PName{style}}% \begin{Declaration} - \Option{headsepline}\\ - \Option{footsepline} + \KOption{headsepline}\PName{switch}\\ + \KOption{footsepline}\PName{switch} \end{Declaration} -\BeginIndex{Option}{headsepline}% -\BeginIndex{Option}{footsepline}% +\BeginIndex{Option}{headsepline~=\PName{switch}}% +\BeginIndex{Option}{footsepline~=\PName{switch}}% These two options insert a separator line below the header or above the footer, respectively, on consecutive pages. In the terminology of this manual, all pages of a letter except the first one are consecutive pages. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}. If one of the options is used without a value, like in the declaration above, this evaluates as \PValue{true}, so the separator line will be activated. When used as a \Macro{documentclass} @@ -404,8 +305,8 @@ respectively, will be passed on to the \Package{typearea} package (see \autoref{sec:typearea.options}, \autopageref{desc:typearea.option.headinclude}). % -\EndIndex{Option}{headsepline}% -\EndIndex{Option}{footsepline}% +\EndIndex{Option}{headsepline~=\PName{switch}}% +\EndIndex{Option}{footsepline~=\PName{switch}}% \begin{Declaration} \Option{pagenumber}=\PName{position} @@ -462,7 +363,7 @@ value are shown in \autoref{tab:scrlttr2.pagenumber}. Default is \begin{Declaration} \Option{parskip}=\PName{value} \end{Declaration}% -\BeginIndex{Option}{parskip}% +\BeginIndex{Option}{parskip~=\PName{value}}% \begin{Explain}% Especially in letters you often encounter paragraphs marked not with indentation of the first line, but with a vertical skip between @@ -516,7 +417,7 @@ in \autoref{tab:scrlttr2.parskip}. Default is \PValue{false}. \end{desctabular} \end{table} % -\EndIndex{Option}{parskip}% +\EndIndex{Option}{parskip~=\PName{value}}% \subsection{Font Options} \label{sec:scrlttr2.fontOptions} @@ -527,9 +428,9 @@ options affecting the font type would also count as font options. At present there is only one option for font size in \Class{scrlttr2}. \begin{Declaration} - \Option{fontsize}=\PName{size} + \KOption{fontsize}\PName{size} \end{Declaration} -\BeginIndex{Option}{fontsize}% +\BeginIndex{Option}{fontsize~=\PName{size}}% Whereas in the main classes you choose the font size\Index{font>size} for the document using the \Option{10pt}, \Option{12pt}, etc., options, in the \Class{scrlttr2} class the desired \PName{size} is set @@ -537,7 +438,7 @@ using the \Option{fontsize} option. The functionality is however the same. This option can only be used with \Macro{documentclass}, not with \Macro{KOMAoptions}. Default is \PValue{12pt}. % -\EndIndex{Option}{fontsize}% +\EndIndex{Option}{fontsize~=\PName{size}}% \subsection{Options for Letterhead and Address} \label{sec:scrlttr2.headoptions} @@ -550,21 +451,21 @@ these features could already be found in the now obsolete \Class{scrlettr} class. \begin{Declaration} - \Option{firsthead} + \KOption{firsthead}\PName{switch} \end{Declaration} -\BeginIndex{Option}{firsthead}% +\BeginIndex{Option}{firsthead~=\PName{switch}}% This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the letterhead will be typeset at all. The option undestands the standard values for simple keys, given -in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is for the +in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is for the letterhead to be set. -\EndIndex{Option}{firsthead}% +\EndIndex{Option}{firsthead~=\PName{switch}}% \begin{Declaration} - \Option{fromalign} + \KOption{fromalign}\PName{value} \end{Declaration} -\BeginIndex{Option}{fromalign}% +\BeginIndex{Option}{fromalign~=\PName{value}}% This option defines the placement of the return address in the letterhead of the first page. Apart from the various options for positioning the return address in the letterhead, there is also the @@ -612,12 +513,12 @@ explanations of the respective options. Possible values for \end{desctabular} \end{table} % -\EndIndex{Option}{fromalign}% +\EndIndex{Option}{fromalign~=\PName{value}}% \begin{Declaration} - \Option{fromrule} + \KOption{fromrule}\PName{value} \end{Declaration} -\BeginIndex{Option}{fromrule}% +\BeginIndex{Option}{fromrule~=\PName{value}}% This option is part of the letterhead extensions (see option \Option{fromalign} above). It allows you to place a horizontal line within the return address. The possible values are shown in @@ -643,108 +544,108 @@ line, see \autoref{sec:scrlttr2.other}, \end{desctabular} \end{table} % -\EndIndex{Option}{fromrule}% +\EndIndex{Option}{fromrule~=\PName{value}}% \begin{Declaration} - \Option{fromphone} + \KOption{fromphone}\PName{switch} \end{Declaration} -\BeginIndex{Option}{fromphone}% +\BeginIndex{Option}{fromphone~=\PName{switch}}% This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the phone number will be part of the return address. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}. % -\EndIndex{Option}{fromphone}% +\EndIndex{Option}{fromphone~=\PName{switch}}% \begin{Declaration} - \Option{fromfax} + \KOption{fromfax}\PName{switch} \end{Declaration} -\BeginIndex{Option}{fromfax}% +\BeginIndex{Option}{fromfax~=\PName{switch}}% This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the facsimile number will be part of the return address. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}. % -\EndIndex{Option}{fromfax}% +\EndIndex{Option}{fromfax~=\PName{switch}}% \begin{Declaration} - \Option{fromemail} + \KOption{fromemail}\PName{switch} \end{Declaration} -\BeginIndex{Option}{fromemail}% +\BeginIndex{Option}{fromemail~=\PName{switch}}% This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the email address will be part of the return address. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}. % -\EndIndex{Option}{fromemail}% +\EndIndex{Option}{fromemail~=\PName{switch}}% \begin{Declaration} - \Option{fromurl} + \KOption{fromurl}\PName{switch} \end{Declaration} -\BeginIndex{Option}{fromurl}% +\BeginIndex{Option}{fromurl~=\PName{switch}}% This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the URL will be part of the return address. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}. % -\EndIndex{Option}{fromurl}% +\EndIndex{Option}{fromurl~=\PName{switch}}% \begin{Declaration} - \Option{fromlogo} + \KOption{fromlogo}\PName{switch} \end{Declaration} -\BeginIndex{Option}{fromlogo}% +\BeginIndex{Option}{fromlogo~=\PName{switch}}% This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the logo will be part of the return address. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Regarding the placement +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Regarding the placement of the logo, see also the explanation of the option \Option{fromalign} above. Default is \PValue{false}. % -\EndIndex{Option}{fromlogo}% +\EndIndex{Option}{fromlogo~=\PName{switch}}% \begin{Declaration} - \Option{addrfield} + \KOption{addrfield}\PName{switch} \end{Declaration} -\BeginIndex{Option}{addrfield}% +\BeginIndex{Option}{addrfield~=\PName{switch}}% This option defines whether an address field will be set. Default is to use the address field. This option can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{true}. % -\EndIndex{Option}{addrfield}% +\EndIndex{Option}{addrfield~=\PName{switch}}% \begin{Declaration} - \Option{backaddress} + \KOption{backaddress}\PName{switch} \end{Declaration} -\BeginIndex{Option}{backaddress}% +\BeginIndex{Option}{backaddress~=\PName{switch}}% This option defines whether a return address for window envelopes will be set. Default is to use the return address. If the address field is suppressed (see option \Option{addrfield}), there will be no return address either. This option can take the standard values for simple -switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. +switches, as listed in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{true}. % -\EndIndex{Option}{backaddress}% +\EndIndex{Option}{backaddress~=\PName{switch}}% \begin{Declaration} - \Option{subject} + \KOption{subject}\PName{value} \end{Declaration} -\BeginIndex{Option}{subject}% +\BeginIndex{Option}{subject~=\PName{value}}% This option serves two purposes: first, you can choose if your subject\Index{subject} should have a title, given by the \PName{subject} variable (see \autoref{tab:scrlttr2.subjectTerm}, @@ -773,12 +674,12 @@ Defaults are \PValue{beforeopening} and \PValue{untitled}. \end{desctabular} \end{table} % -\EndIndex{Option}{subject}% +\EndIndex{Option}{subject~=\PName{value}}% \begin{Declaration} - \Option{locfield} + \KOption{locfield}\PName{value} \end{Declaration} -\BeginIndex{Option}{locfield}% +\BeginIndex{Option}{locfield~=\PName{value}}% \Class{scrlttr2} places a field with additional sender attributes next to the address field. This can be used, for example, for bank account or similar additional information. Depending on the @@ -804,12 +705,12 @@ option are shown in \autoref{tab:scrlttr2.locfield}. Default is \end{desctabular} \end{table} % -\EndIndex{Option}{locfield}% +\EndIndex{Option}{locfield~=\PName{value}}% \begin{Declaration} - \Option{foldmarks} + \KOption{foldmarks}\PName{value} \end{Declaration} -\BeginIndex{Option}{foldmarks}% +\BeginIndex{Option}{foldmarks~=\PName{value}}% This option activates or deactivates foldmarks\Index{foldmark} for vertical two-, three- or four-panel folding, and a single horizontal folding, of the letter, whereby the folding need not result in @@ -820,8 +721,8 @@ vertical marks are configurable via pseudo-lengths (see The user has a choice: Either one may use the standard values for simple switches, as described in -\autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}, to activate or +\autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}, to activate or deactivate at once all configured foldmarks on the left and upper edges of the paper; or\ChangedAt{v2.97e}{\Class{scrlttr2}} one may specify by one or more letters, as listed in @@ -837,8 +738,8 @@ The exact placement of the fold marks for three-panel letter folding depends on user settings, that is, the \File{lco} files (see \autoref{sec:scrlttr2.lcoFile}). The folding need not result in equal-sized parts. This option can take the standard values for simple -switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +switches, as listed in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{true}, which implies setting the fold marks. \begin{table} \centering @@ -874,12 +775,12 @@ switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \KOMAoption{foldmarks=true,foldmarks=blmtP} \end{lstlisting} \end{Example}% -\EndIndex{Option}{foldmarks}% +\EndIndex{Option}{foldmarks~=\PName{value}}% \begin{Declaration} - \Option{numericaldate} + \KOption{numericaldate}\PName{switch} \end{Declaration} -\BeginIndex{Option}{numericaldate}% +\BeginIndex{Option}{numericaldate~=\PName{switch}}% This option toggles between the standard, language-dependent date presentation, and a short, numerical one. {\KOMAScript} does not provide the standard presentation. It should be defined by packages @@ -888,18 +789,18 @@ such as \Package{german}\IndexPackage{german}, \Package{isodate}\IndexPackage{isodate}. The short, numerical presentation, on the other hand, is produced by \Class{scrlttr2} itself. This option can take the standard values for simple switches, -as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +as listed in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}, which results in standard date presentation. In the now obsolete \Class{scrlettr} class, the opposite effect was achieved using the \Option{orgdate} option. % -\EndIndex{Option}{numericaldate}% +\EndIndex{Option}{numericaldate~=\PName{switch}}% \begin{Declaration} - \Option{refline} + \Option{refline}\PName{value} \end{Declaration} -\BeginIndex{Option}{refline}% +\BeginIndex{Option}{refline~=\PName{value}}% With the \Class{scrlttr2} class, the header, footer, address, and sender attributes may extend beyond the normal type area to the left and to the right. This option defines whether that should also apply @@ -921,7 +822,7 @@ values for this option are shown in \end{desctabular} \end{table} % -\EndIndex{Option}{refline}% +\EndIndex{Option}{refline~=\PName{value}}% % \EndIndex{}{letter>head}\EndIndex{}{address}% @@ -941,9 +842,9 @@ pseudo-length \PLength{firstfootvpos}\IndexPLength{firstfootvpos} \autopageref{desc:scrlttr2.plength.firstfootvpos}). \begin{Declaration} - \Option{firstfoot} + \Option{firstfoot}\PName{switch} \end{Declaration} -\BeginIndex{Option}{firstfoot}% +\BeginIndex{Option}{firstfoot~=\PName{switch}}% This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the letterfoot is set or not. If the letterfoot is not set then the pseudo-length \PLength{firstfootvpos} is also ignored, and instead @@ -954,10 +855,10 @@ pseudo-length \PLength{firstfootvpos} is also ignored, and instead concurrently. The option understands the standard values for simple switches, as -given in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is the setting +given in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is the setting of the letterfoot. -\EndIndex{Option}{firstfoot}% +\EndIndex{Option}{firstfoot~=\PName{switch}}% \EndIndex{}{letter>footer} @@ -969,9 +870,9 @@ output and do not belong to another section. You might also call them the \emph{miscellaneous options}. \begin{Declaration} - \Option{draft} + \KOption{draft}\PName{switch} \end{Declaration} -\BeginIndex{Option}{draft}% +\BeginIndex{Option}{draft~=\PName{switch}}% This option toggles between the final\Index{final version} and the draft\Index{draft version} version of a document. In particular, enabling the \Option{draft} option activates little black boxes that @@ -979,13 +880,13 @@ will be drawn at the end of overfull lines. These boxes allow the unpracticed eye to more easily identify paragraphs that need manual intervention. When the \Option{draft} option is disabled, there will be no such boxes. This option can take the standard values for simple -switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +switches, as listed in \autoref{tab:truefalseswitch}, +\autopageref{tab:truefalseswitch}. Default is \PValue{false}, as usual. However, I strongly recommend enabling the \Option{draft} option when designing a letter, as for every other document. % -\EndIndex{Option}{draft}% +\EndIndex{Option}{draft~=\PName{switch}}% \subsection{The Letter Class Option Files} \label{sec:scrlttr2.lcoFile} @@ -1084,7 +985,7 @@ loading the \File{lco} file are local to the corresponding letter. The command \Macro{setkomavar} used above, and the principle of variables will be explained in detail in\autoref{sec:scrlttr2.variables}, -\autopageref{desc:scrlttr2.macro.setkomavar}. In the example given +\autopageref{desc:scrlttr2.cmd.setkomavar}. In the example given here, knowledge of the exact function of the command is not critical. It is only important to note what can be done with \File{lco} files, less so exactly how this might be @@ -1370,7 +1271,7 @@ page styles. macro \Macro{opening}\IndexCmd{opening} (see \autoref{sec:scrlttr2.firstHead}, \autoref{sec:scrlttr2.firstFoot}, as well as \autoref{sec:scrlttr2.opening}, - \autopageref{desc:scrlttr2.macro.opening}). + \autopageref{desc:scrlttr2.cmd.opening}). \item[plain] is the page style with only page numbers in the header or footer on subsequent pages. The placement of these page numbers is @@ -1393,7 +1294,7 @@ page styles. this end, the commands \Macro{markboth} and \Macro{markright} are available as usual, and with the use of package \Package{scrpage2} also \Macro{markleft} (see \autoref{sec:scrpage.basics.mark}, - \autopageref{desc:scrpage.macro.automark}) is available. + \autopageref{desc:scrpage.cmd.automark}) is available. \item[myheadings] is the page style for manual page headings on subsequent pages. This is very similar to \PValue{headings}, but @@ -1452,7 +1353,7 @@ look at the example in \autoref{sec:maincls.pageStyle}, \BeginIndex{Cmd}{cleardoubleplainpage}% \BeginIndex{Cmd}{cleardoubleemptypage}% Please refer to \autoref{sec:maincls.pageStyle}, -\autopageref{desc:maincls.macro.clearpage}. The function +\autopageref{desc:maincls.cmd.clearpage}. The function of \Macro{cleardoublepage} in \Class{scrlttr2} depends on the option \Option{cleardoublepage} which is described in more detail in \autoref{sec:scrlttr2.layout}, @@ -2005,19 +1906,20 @@ letters. As illustrated in \autoref{fig:scrlttr2.document}, a letter document consists of a preamble, the individual letters, and the closing. -The preamble comprises all settings that in general concern all -letters. Most of them can also be overwritten in the settings of the -individual letters. The only setting which can not be changed within a -single letter is the font size (see option \Option{fontsize} in -\autoref{sec:scrlttr2.fontOptions}, -\autopageref{desc:scrlttr2.option.fontsize}). It is recommended that -only general settings such as the loading of packages and the setting -of options be placed before \Macro{begin}\PParameter{document}. All -settings that comprise the setting of variables or other text features -should be done after \Macro{begin}\PParameter{document}. This is -particularly recommended when the \Package{babel} -package\IndexPackage{babel} (see \cite{package:babel}) is used, or -language-dependent variables of \Class{scrlttr2} are to be changed. +The preamble comprises all settings that in general concern all letters. Most +of them can also be overwritten in the settings of the individual letters. The +only setting which can not be changed within a single letter is compatibility +to prior versions of \Class{scrlttr2} (see option \Option{version} in +\autoref{sec:scrlttr2.compatibilityOptions}, +\autopageref{desc:scrlttr2.option.version}). + +It is recommended that only general settings such as the loading of packages +and the setting of options be placed before +\Macro{begin}\PParameter{document}. All settings that comprise the setting of +variables or other text features should be done after +\Macro{begin}\PParameter{document}. This is particularly recommended when the +\Package{babel} package\IndexPackage{babel} (see \cite{package:babel}) is +used, or language-dependent variables of \Class{scrlttr2} are to be changed. The closing usually consists only of \Macro{end}\PParameter{document}. Of course you can also insert @@ -2407,7 +2309,7 @@ e.\,g., letterhead width or an optional logo. Users can adjust rule length manually in their own \File{lco} files by setting this pseudo-length to positive values using \Macro{\@setplength} (see \autoref{sec:scrlttr2.pseudoLength}, -\autopageref{desc:scrlttr2.macro.@setplength}). The default +\autopageref{desc:scrlttr2.cmd.@setplength}). The default thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}}, \PLength{fromrulethickness}, is 0.4\Unit{pt}. % @@ -3373,7 +3275,7 @@ as \Macro{centering} (all besides \Option{KOMAold}) or flush-right or flush-left alignment inside the box, the command can be redefined in the same way as \Macro{raggedsection} (see \autoref{sec:maincls.structure}, -\autopageref{desc:maincls.macro.raggedsection}). +\autopageref{desc:maincls.cmd.raggedsection}). Between closing phrase and signature a vertical space is inserted, the height of which is defined in the pseudo-length |