summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex')
-rw-r--r--macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex1461
1 files changed, 1265 insertions, 196 deletions
diff --git a/macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex b/macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex
index 81923f666c..1c0a82a440 100644
--- a/macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex
+++ b/macros/latex/contrib/koma-script/source-doc/english/scrlttr2.tex
@@ -7,7 +7,7 @@
% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
-% http://www.latex-project.org/lppl.txt
+% https://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX
% version 2005/12/01 or later and of this work.
%
@@ -23,7 +23,7 @@
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
% Die neuste Version dieser Lizenz ist
-% http://www.latex-project.org/lppl.txt
+% https://www.latex-project.org/lppl.txt
% und Version 1.3c ist Teil aller Verteilungen von LaTeX
% Version 2005/12/01 oder spaeter und dieses Werks.
%
@@ -46,14 +46,14 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2.tex}%
- [$Date: 2019-10-10 10:25:29 +0200 (Thu, 10 Oct 2019) $
+ [$Date: 2019-12-03 09:41:21 +0100 (Tue, 03 Dec 2019) $
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\and
Karl Hagen}
-% Date of the translated German file: 2019-10-10
+% Date of the translated German file: 2019-12-03
\chapter{Letters with the \Class{scrlttr2} Class or the \Package{scrletter}
Package}
@@ -97,6 +97,27 @@ affect the page styles and are explicitly documented (see
explicitly mentioned, everything that is documented for \Class{scrlttr2}
applies without change.
+\LoadCommonFile{options} % \section{Early or Late Selection of Options}
+
+\LoadCommonFile{compatibility} % \section{Compatibility with Earlier Versions of
+ % \KOMAScript{}}
+
+\LoadCommonFile{draftmode} % \section{Draft-Mode}
+
+\LoadCommonFile{typearea} % \section{Page Layout}
+
+For letters, it is normally not useful to distinguish one-sided and two-sided
+printing. Since letters are not usually bound, each page of a letter will be
+viewed on its own. This is also true even if both the letter is printed on
+both sides of the paper. Vertical adjustment usually does not matter for
+letters either. If you nevertheless need it, or want to understand what it is,
+please refer to the commands
+\DescRef{maincls.cmd.raggedbottom}\IndexCmd{raggedbottom} and
+\DescRef{maincls.cmd.flushbottom}\IndexCmd{flushbottom} explained in
+\autoref{sec:maincls.typearea} on \DescPageRef{maincls.cmd.flushbottom}.%
+%
+\EndIndexGroup
+
\section{Variables}
\seclabel{variables}%
@@ -373,32 +394,34 @@ about defining your own variables.%
\begin{Declaration}
- \Macro{ifkomavar}\Parameter{name}\Parameter{then code}\Parameter{else code}
+ \Macro{Ifkomavar}\Parameter{name}\Parameter{then code}\Parameter{else code}
\end{Declaration}
-With\ChangedAt{v3.03}{\Class{scrlttr2}} this command, you can determine if a
-variable has already been defined. The \PName{then code} will be executed only
-if the variable already exists. The variable's contents will not be examined
-and so can be empty. The \PName{else code} will be executed if the variable
-does not exist. Such tests can be useful, for example, if your own variables
-are defined in one \File{lco} file\Index{lco file=\File{lco} file} (see
-\autoref{sec:\LabelBase.lcoFile} starting at
+With\ChangedAt{v3.03}{\Class{scrlttr2}}%
+\ChangedAt{v3.28}{\Class{scrlttr2}\and \Package{scrletter}} this command, you
+can determine if a variable has already been defined. The \PName{then code}
+will be executed only if the variable already exists. The variable's contents
+will not be examined and so can be empty. The \PName{else code} will be
+executed if the variable does not exist. Such tests can be useful, for
+example, if your own variables are defined in one \File{lco} file\Index{lco
+ file=\File{lco} file} (see \autoref{sec:\LabelBase.lcoFile} starting at
\autopageref{sec:\LabelBase.lcoFile}) but used in another \File{lco} file only
if they exist.%
\EndIndexGroup
\begin{Declaration}
- \Macro{ifkomavarempty}\Parameter{name}\Parameter{then code}%
+ \Macro{Ifkomavarempty}\Parameter{name}\Parameter{then code}%
\Parameter{else code}%
- \Macro{ifkomavarempty*}\Parameter{name}\Parameter{then code}%
+ \Macro{Ifkomavarempty*}\Parameter{name}\Parameter{then code}%
\Parameter{else code}
\end{Declaration}
-With\ChangedAt{v2.9i}{\Class{scrlttr2}} these commands, you can determine
-whether either the content or the description of a variable is empty. The
-\PName{then code} will be executed if the expanded content or the expanded
-description of the \PName{name} variable is empty. Otherwise, the \PName{else
-code} will be executed. The starred variant tests the variable's description,
-while the normal variant tests its contents.%
+With\ChangedAt{v2.9i}{\Class{scrlttr2}}%
+\ChangedAt{v3.28}{\Class{scrlttr2}\and \Package{scrletter}} these commands,
+you can determine whether either the content or the description of a variable
+is empty. The \PName{then code} will be executed if the expanded content or
+the expanded description of the \PName{name} variable is empty. Otherwise, the
+\PName{else code} will be executed. The starred variant tests the variable's
+description, while the normal variant tests its contents.%
\EndIndexGroup
%
\EndIndexGroup
@@ -417,26 +440,332 @@ the ability to process such lengths stored in macros with commands similar to
those used to handle real lengths. \KOMAScript{} calls lengths that are
actually stored in macros \emph{pseudo-lengths}.
-You can find a list of all pseudo-lengths defined by \Class{scrlttr2} in
-\autoref{tab:scrlttr2-experts.pseudoLength},
-\autopageref{tab:scrlttr2-experts.pseudoLength}. A graphical representation of
-the main pseudo-lengths for the letterhead page is given in
-\autoref{fig:scrlttr2-experts.pseudoLength}. The dimensions used in the figure
-correspond to the default settings of \Class{scrlttr2}. More detailed
-descriptions of the individual pseudo-lengths are found in the individual
-sections of this chapter.
+Note\textnote{Attention!} that even though these pseudo-lengths are internally
+implemented as macros, the commands for pseudo-length management expect only
+the names of the pseudo-lengths not the macros representing the
+pseudo-lengths. The names of pseudo-lengths are written without the initial
+backslash, like the names of \LaTeX{} counters and unlike macros or \LaTeX{}
+lengths.
+
+\begin{Explain}
+ Historical \TeX{} works with a fixed number of registers. There are
+ registers for tokens, for boxes, for counters, for skips, and for
+ dimensions. Overall there are 256 registers for each of these
+ categories. For \LaTeX{} lengths, which are defined with \Macro{newlength},
+ skip registers are used. Once all these registers are in use, you can not
+ define any more lengths. Both \Class{scrlttr2} and \Package{scrletter} would
+ normally use more than 20 of these registers for the first page
+ alone. \LaTeX{} itself already uses 40 of these registers. The
+ \hyperref[cha:typearea]{\Package{typearea}}%
+ \IndexPackage{typearea} package needs some of them too; thus, approximately
+ a quarter of these precious registers would already be in use. For this
+ reason, in 2002 \Class{scrlttr2} stores letter-specific lengths in macros
+ instead of lengths.
+
+ Anyone who wants to argue that the recommended \LaTeX{} installation with
+ \eTeX{}, which is required for \KOMAScript{} anyway, no longer suffers from
+ the above-mentioned limitation would be right. However, that improvement
+ came too late for \Class{scrlttr2}. With \Package{scrletter}, the concept of
+ psuedo-lengths was adopted for reasons of compatibility.
+\end{Explain}
+
+The pseudo-lengths defined and uses by \KOMAScript{} are listed in
+\autoref{tab:\LabelBase.pseudoLength}, which also provides cross
+references to the detailed descriptions of each pseudo-lengths in the
+following sub-sections.
+
+A schematic display of the most important distances of the letterhead page is
+shown in \autoref{fig:\LabelBase.pseudoLength} on
+\autopageref{fig:\LabelBase.pseudoLength}. In addition to the
+pseudo-lengths for the configurable distances, some non-configurable lengths
+are also shown in light gray. For the sake of clarity, however, some rarely
+required pseudo-lengths have been omitted.
+%
+\begin{desclist}
+ \renewcommand{\abovecaptionskipcorrection}{-\normalbaselineskip}%
+ \desccaption{%
+ Pseudo-lengths provided by \Class{scrlttr2} and \Package{scrletter}%
+ \label{tab:\LabelBase.pseudoLength}%
+ }{%
+ Pseudo-lengths provided by \Class{scrlttr2} and \Package{scrletter}
+ (\emph{continued})%
+ }%
+ \pentry{backaddrheight}{%
+ the height of the return address at the upper edge of the address field
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.backaddrheight})%
+ }%
+ \pentry{bfoldmarklength}{%
+ the length of the bottommost fold mark
+ (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.bfoldmarkvpos})%
+ }%
+ \pentry{bfoldmarkvpos}{%
+ the vertical distance of the bottommost fold mark from the top edge of the
+ paper (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.bfoldmarkvpos})%
+ }%
+ \pentry{firstfoothpos}{%
+ the horizontal distance of the letterhead page footer from the left edge
+ of the paper; values greater than the width of the paper or less than the
+ negative value of the width of the paper activate special handling %
+ (\autoref{sec:\LabelBase.firstFoot},
+ \DescPageRef{\LabelBase.plength.firstfoothpos})%
+ }%
+ \pentry{firstfootvpos}{%
+ the vertical distance of letterhead page footer from the top edge of the
+ paper (\autoref{sec:\LabelBase.firstFoot},
+ \DescPageRef{\LabelBase.plength.firstfootvpos})%
+ }%
+ \pentry{firstfootwidth}{%
+ the width of the letterhead page footer
+ (\autoref{sec:\LabelBase.firstFoot},
+ \DescPageRef{\LabelBase.plength.firstfootwidth})%
+ }%
+ \pentry{firstheadhpos}{%
+ the horizontal distance of the letterhead from the left edge of the paper;
+ values greater than the width of the paper or less than the negative value
+ of the width of the paper activate special handling
+ (\autoref{sec:\LabelBase.firstHead},
+ \DescPageRef{\LabelBase.plength.firstheadhpos})%
+ }%
+ \pentry{firstheadvpos}{%
+ the vertical distance of the letterhead from the top edge of the paper
+ (\autoref{sec:\LabelBase.firstHead},
+ \DescPageRef{\LabelBase.plength.firstheadvpos})%
+ }%
+ \pentry{firstheadwidth}{%
+ the width of the letterhead (\autoref{sec:\LabelBase.firstHead},
+ \DescPageRef{\LabelBase.plength.firstheadwidth})%
+ }%
+ \pentry{foldmarkhpos}{%
+ the horizontal distance of the horizontal fold marks from the left edge of
+ the paper (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.foldmarkhpos})%
+ }%
+ \pentry{foldmarkvpos}{%
+ the vertical distance of the vertical fold marks from the top edge of the
+ paper (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.foldmarkvpos})%
+ }%
+ \pentry{fromrulethickness}{%
+ the thickness of an optional horizontal rule in the letterhead
+ (\autoref{sec:\LabelBase.firstHead},
+ \DescPageRef{\LabelBase.plength.fromrulethickness})%
+ }%
+ \pentry{fromrulewidth}{%
+ the length of an optional horizontal rule in the letterhead
+ (\autoref{sec:\LabelBase.firstHead},
+ \DescPageRef{\LabelBase.plength.fromrulewidth})%
+ }%
+ \pentry{lfoldmarkhpos}{%
+ the horizontal distance of the vertical fold mark from the left edge of
+ the paper (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.lfoldmarkhpos})%
+ }%
+ \pentry{lfoldmarklength}{%
+ the length of the vertical fold mark
+ (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.lfoldmarklength})%
+ }%
+ \pentry{locheight}{%
+ the height of the field containing the additional sender information if
+ the value is not 0; if it is 0, \PLength{toaddrheight} is used instead
+ (\autoref{sec:\LabelBase.locationField},
+ \DescPageRef{\LabelBase.plength.locheight})%
+ }%
+ \pentry{lochpos}{%
+ the horizontal distance of the field containing the additional sender
+ information; if the value is positive, the distance is measured from the
+ right paper edge; if negative, from the left paper edge; if 0, the
+ negative value of \PLength{toaddrhpos} is used instead
+ (\autoref{sec:\LabelBase.locationField},
+ \DescPageRef{\LabelBase.plength.lochpos})%
+ }%
+ \pentry{locvpos}{%
+ the vertical distance of the field containing the additional sender
+ information from the top edge of the paper if the value is not 0; if it is
+ 0, \PLength{toaddrvpos} is used instead
+ (\autoref{sec:\LabelBase.locationField},
+ \DescPageRef{\LabelBase.plength.locvpos})%
+ }%
+ \pentry{locwidth}{%
+ the width of the field containing the additional sender information; if it
+ is 0, the width is calculated automatically based on the
+ \DescRef{\LabelBase.option.locfield} option described in
+ \autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.locfield} %
+ (\autoref{sec:\LabelBase.locationField},
+ \DescPageRef{\LabelBase.plength.locwidth})%
+ }%
+ \pentry{mfoldmarklength}{%
+ the length of the middle horizontal fold mark
+ (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.mfoldmarklength})%
+ }%
+ \pentry{mfoldmarkvpos}{%
+ the vertical distance of the middle horizontal fold mark from the top edge
+ of the paper (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.mfoldmarkvpos})%
+ }%
+ \pentry{pfoldmarklength}{%
+ the length of the hole-punch mark
+ (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.pfoldmarklength})%
+ }%
+ \pentry{PPdatamatrixvskip}{%
+ the vertical distance between the postpaid header and the data array with
+ \OptionValueRef{scrlttr2}{addrfield}{PP}
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.PPdatamatrixvskip})%
+ }%
+ \pentry{PPheadheight}{%
+ the height of the postpaid header
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.PPheadheight})%
+ }%
+ \pentry{PPheadwidth}{%
+ the width of the left postpaid field with
+ \OptionValueRef{scrlttr2}{addrfield}{PP}
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.PPheadwidth})%
+ }%
+ \pentry{refaftervskip}{%
+ vertical skip below reference-field line %
+ (\autoref{sec:\LabelBase.refLine},
+ \DescPageRef{\LabelBase.plength.refaftervskip})%
+ }%
+ \pentry{refhpos}{%
+ the horizontal distance of reference-field line from the left
+ edge of the paper; if the value is 0, the reference-field line is centred
+ horizontally on the letterhead page
+ (\autoref{sec:\LabelBase.refLine},
+ \DescPageRef{\LabelBase.plength.refhpos})%
+ }%
+ \pentry{refvpos}{%
+ the vertical distance of reference-field line from the top
+ edge of the paper (\autoref{sec:\LabelBase.refLine},
+ \DescPageRef{\LabelBase.plength.refvpos})%
+ }%
+ \pentry{refwidth}{%
+ the width of the reference-field line
+ (\autoref{sec:\LabelBase.refLine},
+ \DescPageRef{\LabelBase.plength.refwidth})%
+ }%
+ \pentry{sigbeforevskip}{%
+ the vertical skip between the closing and the signature
+ (\autoref{sec:\LabelBase.closing},
+ \DescPageRef{\LabelBase.plength.sigbeforevskip})%
+ }%
+ \pentry{sigindent}{%
+ the indentation of the signature with respect to the text body
+ (\autoref{sec:\LabelBase.closing},
+ \DescPageRef{\LabelBase.plength.sigindent})%
+ }%
+ \pentry{specialmailindent}{%
+ the left indentation of the delivery method within the address field
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.specialmailindent})%
+ }%
+ \pentry{specialmailrightindent}{%
+ the right indentation of the delivery method within the address field
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.specialmailrightindent})%
+ }%
+ \pentry{subjectaftervskip}{%
+ the vertical skip after the subject
+ (\autoref{sec:\LabelBase.subject},
+ \DescPageRef{\LabelBase.plength.subjectaftervskip})%
+ }%
+ \pentry{subjectbeforevskip}{%
+ additional vertical skip before the subject
+ (\autoref{sec:\LabelBase.subject},
+ \DescPageRef{\LabelBase.plength.subjectbeforevskip})%
+ }%
+ \pentry{subjectvpos}{%
+ the vertical distance of the subject from the top edge of the paper; if it
+ is 0, the position is calculated based on the
+ \DescRef{\LabelBase.option.subject} option
+ (\autoref{sec:\LabelBase.subject},
+ \DescPageRef{\LabelBase.plength.subjectaftervskip})%
+ }%
+ \pentry{tfoldmarklength}{%
+ the length of the topmost horizontal fold mark
+ (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.tfoldmarklength})%
+ }%
+ \pentry{tfoldmarkvpos}{%
+ the vertical distance of the topmost horizontal folding mark from the top
+ edge of the paper (\autoref{sec:\LabelBase.foldmarks},
+ \DescPageRef{\LabelBase.plength.tfoldmarkvpos})%
+ }%
+ \pentry{toaddrheight}{%
+ the height of the address field (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.toaddrheight})%
+ }%
+ \pentry{toaddrhpos}{%
+ the horizontal distance of the address field from left edge of the paper,
+ if the value is positive; if it is negative, the negative horizontal
+ distance of the address field from the right edge of the paper
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.toaddrhpos})%
+ }%
+ \pentry{toaddrindent}{%
+ the left and right indentation of the address within the address field
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.toaddrindent})%
+ }%
+ \pentry{toaddrvpos}{%
+ the vertical distance of the address field from the the top edge of the
+ paper (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.toaddrvpos})%
+ }%
+ \pentry{toaddrwidth}{%
+ the width of the address field %
+ (\autoref{sec:\LabelBase.addressee},
+ \DescPageRef{\LabelBase.plength.toaddrwidth})%
+ }%
+\end{desclist}
+
+\begin{figure}
+ \centering
+ \includegraphics{plenDIN}
+ \caption{Schematic of the pseudo-lengths for a letter}
+ \label{fig:\LabelBase.pseudoLength}
+\end{figure}
-Since users will usually not need to define their own pseudo-lengths, the
-method for defining them is described in the part for experts, in
-\autoref{sec:scrlttr2-experts.pseudoLengths},
-\DescPageRef{scrlttr2-experts.cmd.newplength}. Setting pseudo-lengths to new
-values should also be a matter for advanced users, so this is also described
-in the part for experts, on \DescPageRef{scrlttr2-experts.cmd.setplength}.
-Note\textnote{Attention!} that although these pseudo-lengths are internally
-implemented as macros, the commands to use pseudo-lengths expect only the the
-pseudo-length names. These are written without backslashes, like the names of
-\LaTeX{} counters and unlike macros or real lengths.
+\begin{Declaration}
+ \Macro{newplength}\Parameter{name}
+\end{Declaration}
+This\ChangedAt{v3.26}{\Class{scrlttr2}\and \Package{scrletter}} command
+defines a new pseudo-length. The new pseudo-length is uniquely identified by
+its \PName{name}. Each name can therefore be assigned only once. If you
+attempt to redefine an existing pseudo-length, the commands exits with an
+error message.
+
+\BeginIndex{Cmd}{@newplength}%
+Since the ordinary user does not normally need to define pseudo-lengths, this
+command was not a user instruction until \KOMAScript~3.26. Before then,
+\Macro{@newplength} existed with the same functionality. This instruction still
+exists for package authors.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \Macro{Ifplength}\Parameter{pseudo-length}%
+ \Parameter{then-code}\Parameter{else-code}
+\end{Declaration}
+This\ChangedAt{v3.27}{\Class{scrlttr2}\and \Class{scrletter}} command can be
+used to determine whether a \PName{pseudo-length} has been defined. The
+\PName{then-code} is executed if the \PName{pseudo-length} is defined and not
+\Macro{relax}. Otherwise the \PName{else-code} is executed.
+
+% Note: In the English manual this information is not \iffree{}{...}!
+\BeginIndex{Cmd}{if@plength}%
+For reasons of consistency only, the internal command \Macro{if@plength},
+with the identical meaning, exists for the use of package authors.%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{useplength}\Parameter{name}
@@ -451,6 +780,61 @@ used with an \File{lco} file\Index{lco file=\File{lco} file} (see
\begin{Declaration}
+ \Macro{setplength}%
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}%
+ \Macro{addtoplength}%
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}
+\end{Declaration}
+Using \Macro{setplength}, you can assign the multiple of a
+\PName{value} to a \PName{pseudo-length}. The \PName{factor} is given as an
+optional argument (see also \DescRef{\LabelBase.cmd.setlengthtoplength},
+\autoref{sec:\LabelBase.pseudoLength},
+\DescPageRef{\LabelBase.cmd.setlengthtoplength}).
+
+With \Macro{addtoplength} you can add the multiple of a \PName{value} to a
+\PName{pseudo-length}. Again, you can pass a \PName{factor} as an optional
+argument.
+
+To assign or to add the multiple of one \PName{pseudo-length} to another
+pseudo-length, use the \Macro{useplength} command (see
+\autoref{sec:\LabelBase.pseudoLength}, \DescPageRef{\LabelBase.cmd.useplength})
+within the \PName{value}. To subtract the value of one \PName{pseudo-length}
+from another \PName{pseudo-length}, you use should use at the same time a
+minus sign or \PValue{-1} as the \PName{factor}.
+
+\BeginIndex{Cmd}{@setplength}%
+\BeginIndex{Cmd}{@addtoplength}%
+Since the ordinary user does not normally need to define pseudo-lengths, these
+commands were not user instructions until \KOMAScript~3.26. Before then,
+\Macro{@setplength} and \Macro{@addtoplength} existed with the
+same functionality. These commands still exist for the use of package authors.%
+\EndIndexGroup
+
+\begin{Declaration}
+ \Macro{setplengthtowidth}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+ \Macro{setplengthtoheight}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+ \Macro{setplengthtodepth}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+ \Macro{setplengthtototalheight}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+\end{Declaration}
+The\ChangedAt{v3.26}{\Class{scrlttr2}\and \Package{scrletter}} first three
+commands essentially correspond with \Macro{settowidth},
+\Macro{settoheight}, and \Macro{settodepth} from the \LaTeX{} kernel, but set
+\PName{pseudo-length}s instead of lengths. Like
+\DescRef{\LabelBase.cmd.setplength}, these commands extend their \LaTeX{}
+kernel equivalents with an optional \PName{factor}. They set a
+\PName{pseudo-length} to the natural width, height or depth of the given
+\PName{content}, multiplied by the optional \PName{factor}. The additional
+command \Macro{setplengthtototalheight} sets the \PName{pseudo-length} to the
+sum of the height and depth of \PName{content} multiplied by the optional
+\PName{factor}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
\Macro{setlengthtoplength}%
\OParameter{factor}\Parameter{length}\Parameter{pseudo-length}%
\Macro{addtolengthplength}%
@@ -469,27 +853,6 @@ The \Macro{addtolengthplength} command works very similarly. It adds the
%
\EndIndexGroup
-\LoadCommonFile{options} % \section{Early or Late Selection of Options}
-
-\LoadCommonFile{compatibility} % \section{Compatibility with Earlier Versions of
- % \KOMAScript{}}
-
-\LoadCommonFile{draftmode} % \section{Draft-Mode}
-
-\LoadCommonFile{typearea} % \section{Page Layout}
-
-For letters, it is normally not useful to distinguish one-sided and two-sided
-printing. Since letters are not usually bound, each page of a letter will be
-viewed on its own. This is also true even if both the letter is printed on
-both sides of the paper. Vertical adjustment usually does not matter for
-letters either. If you nevertheless need it, or want to understand what it is,
-please refer to the commands
-\DescRef{maincls.cmd.raggedbottom}\IndexCmd{raggedbottom} and
-\DescRef{maincls.cmd.flushbottom}\IndexCmd{flushbottom} explained in
-\autoref{sec:maincls.typearea} on \DescPageRef{maincls.cmd.flushbottom}.%
-%
-\EndIndexGroup
-
\section{General Structure of Letter Documents}
\seclabel{document}
@@ -976,7 +1339,6 @@ Subsequent pages\Index{page>subsequent}\Index{subsequent pages} should be
distinguished from the letterhead page. For the purposes of this manual,
subsequent pages are all pages of a letter except the first one.
-
\begin{figure}
\centering
\includegraphics[scale=0.99]{varDIN}
@@ -986,22 +1348,27 @@ subsequent pages are all pages of a letter except the first one.
\end{figure}
+\subsection{Fold Marks}
+\seclabel{foldmarks}
+\BeginIndexGroup
+\BeginIndex{}{fold marks}%
+\index{marks>folding|see{fold marks}}
+
+Fold marks, or folding marks, are short horizontal lines at the left edge, and
+short vertical lines at the upper edge of the paper. \KOMAScript{} currently
+supports three configurable horizontal and one configurable vertical fold
+marks. In addition, there is support for a hole-punch mark, or centre mark,
+which cannot be shifted vertically.
+
\begin{Declaration}
\OptionVName{foldmarks}{setting}
\end{Declaration}
-Fold marks\Index{fold mark}, or folding marks, are small horizontal rules in
-the left margin and small vertical rules in the top margin. \KOMAScript{}
-currently provides three configurable horizontal fold marks and one
-configurable vertical fold mark. Additionally it provides a horizontal
-hole-punch or page-centre mark. This additional mark cannot be moved
-vertically.
-
The \Option{foldmarks} option activates or deactivates fold marks for two,
three, or four vertical divisions and one horizontal division. The individual
parts do not have to be of equal size. The positions of three of the four
horizontal marks and the single vertical mark are configurable via
-pseudo-lengths (see \autoref{sec:scrlttr2-experts.foldmarks} starting on
-\DescPageRef{scrlttr2-experts.plength.foldmarkvpos}).
+pseudo-lengths (see \autoref{sec:\LabelBase.pseudoLength},
+\autopageref{sec:\LabelBase.pseudoLength}).
With the \Option{foldmarks} option, you can either use the default values for
simple switches described in \autoref{tab:truefalseswitch},
@@ -1081,29 +1448,154 @@ with the \FontElement{foldmark} element. The default is no change.%
\begin{Declaration}
- \OptionVName{enlargefirstpage}{simple switch}
+ \PLength{tfoldmarkvpos}%
+ \PLength{mfoldmarkvpos}%
+ \PLength{bfoldmarkvpos}
\end{Declaration}
-\begin{Explain}
- The first page of a letter always uses a different page layout because of
- the many predefined elements such as the letterhead or the address. The
- \Class{scrlttr2} class provides a mechanism to calculate height and vertical
- alignment of header and footer of the first page independently of the
- subsequent pages. If, as a result, the footer of the first page would
- protrude into the text area, this text area of the first page is
- automatically reduced using
- \Macro{enlargethispage}\IndexCmd{enlargethispage}.
-\end{Explain}
-If the text area should become larger, assuming the footer on the first page
-permits this, you can use this option. At best, a little more text will then
-fit on the first page. See also the description of the \PLength{firstfootvpos}
-pseudo-length on \DescPageRef{scrlttr2-experts.plength.firstfootvpos}. This
-option takes the standard values for simple switches, as listed in
-\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. The default
-is \PValue{false}.\textnote{default}%
+\KOMAScript{} recognises a total of three fold marks whose vertical position
+can be configured. The distance of the top fold mark from the upper edge of
+the paper is determined by the \PLength{tfoldmarkvpos} pseudo-length; the
+distance of the middle fold mark, by the
+\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}} pseudo-length; the
+distance of the bottommost fold mark, by \PLength{bfoldmarkvpos}
+pseudo-length. With the addition of the hole-punch\Index{hole-punch mark} or
+centre\Index{centre mark|see{hole-punch mark}} mark, there is yet a fourth
+horizontal mark. This one is however always placed at the vertical centre of
+the paper.
+\iftrue% Umbruchkorrekturtext
+There is no pseudo-length for this last mark because its vertical position is
+not configurable.
+\fi
+
+The\textnote{Attention!} top and bottom fold marks do not serve to divide the
+paper exactly into equal thirds. Instead, the paper should be folded with
+their help such that the address field can be seen in a window envelope. The
+settings are therefore different depending on the \File{lco} file chosen.
+Several such files are available offering predefined formats. One format
+particularly worth noting is \Option{DINmtext}. This format assumes an
+envelope format of C6/5 (also known as ``C6 long''). Letters written with this
+option are typically not suited for C5 or C4 envelopes.
+
+The middle fold mark is not normally required for Western letters. In Japan,
+however, a larger number of envelope formats exists, requiring one more fold
+mark (see the Japanese \File{lco} files). Note that the terms ``top'',
+``middle'', and ``bottom'' fold marks only represent a naming convention. In
+fact, it is not required that \PLength{tfoldmarkvpos} must be smaller than
+\PLength{mfoldmarkvpos}, which in turn must be smaller than
+\PLength{bfoldmarkvpos}. If, though, one of the pseudo-lengths is zero, then
+the corresponding fold mark will not be set even if the
+\DescRef{\LabelBase.option.foldmarks}\IndexOption{foldmarks~=\PName{setting}}%
+\important{\DescRef{\LabelBase.option.foldmarks}} option (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.foldmarks}) is
+explicitly activated.
+%
\EndIndexGroup
\begin{Declaration}
+ \PLength{tfoldmarklength}%
+ \PLength{mfoldmarklength}%
+ \PLength{bfoldmarklength}%
+ \PLength{pfoldmarklength}
+\end{Declaration}
+These\ChangedAt{v2.97e}{\Class{scrlttr2}} four pseudo-lengths determine the
+lengths of the four horizontal fold marks. One\textnote{Attention!} feature is
+particularly worth noting. If the length is given as zero, then the three
+vertically configurable pseudo-lengths \PLength{tfoldmarklength},
+\PLength{mfoldmarklength} and \PLength{bfoldmarklength} are set to 2\Unit{mm}.
+The length of the hole-punch mark, \PLength{pfoldmarklength}, however, is set
+to 4\Unit{mm}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{foldmarkhpos}
+\end{Declaration}
+This pseudo-length gives the distance of all horizontal fold marks from the
+left edge of the paper. Normally, this is 3.5\Unit{mm}. You\textnote{Hint!}
+can change this value in your own \File{lco} file if you are using a printer
+that has a wider unprintable left margin. Whether the fold marks are typeset
+at all depends on the option \DescRef{\LabelBase.option.foldmarks}%
+\important{\DescRef{\LabelBase.option.foldmarks}}%
+\IndexOption{foldmarks~=\PName{setting}} (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.foldmarks}).
+%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{lfoldmarkhpos}
+\end{Declaration}
+In\ChangedAt{v2.97e}{\Class{scrlttr2}} addition to the horizontal fold marks,
+there is also a vertical fold mark. Its distance from the left margin is set
+via the \PLength{lfoldmarkhpos} pseudo-length. This fold mark is used, for
+example, in Japanese Chou- or You-format envelopes if you want to use them
+with A4 paper. It can also be useful for envelopes in C6 format.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{lfoldmarklength}
+\end{Declaration}
+The\ChangedAt{v2.97e}{\Class{scrlttr2}} \PLength{lfoldmarklength}
+pseudo-length determines the length of the vertical fold mark. Once again, a
+feature worth noting is that if the length is given as zero, a length of
+4\Unit{mm} is actually used.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{foldmarkvpos}
+\end{Declaration}
+This\ChangedAt{v2.97e}{\Class{scrlttr2}} pseudo-length determines the distance of
+all vertical fold marks from the upper edge of the paper. Normally this is
+3.5\Unit{mm}, but\textnote{Hint!} you can change the value in your own
+\File{lco} file in case your printer has a wider unprintable
+top margin. Whether or not the foldmarks are actually typeset depends on the
+\DescRef{\LabelBase.option.foldmarks}%
+\important{\DescRef{\LabelBase.option.foldmarks}}%
+\IndexOption{foldmarks~=\PName{setting}} option (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.foldmarks}).
+\iffree{At present there is only one vertical fold mark, called the left
+ vertical fold mark.}{}%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{foldmarkthickness}
+\end{Declaration}
+This\ChangedAt{v2.97c}{\Class{scrlttr2}} pseudo-length determines the
+thickness of all fold marks. The default is 0.2\Unit{pt}, in other words a
+very thin hairline. In\textnote{Hint!} particular, if the colour of the fold
+marks is changed, this may not be enough.%
+\EndIndexGroup
+%
+\EndIndexGroup
+
+
+\subsection{Letterhead}
+\seclabel{firstHead}
+\BeginIndexGroup
+\BeginIndex{}{letterhead}%
+
+The term letterhead refers here to all of the information concerning the
+sender that appears above the recipient's address. Normally you would expect
+that this information would be set through the page-style settings. In fact,
+this was the case with the old letter class, \Class{scrlettr}.
+But\textnote{Attention!} \Class{scrlttr2} and \Package{scrletter} output the
+letterhead independently of the page style by means of the
+\DescRef{\LabelBase.cmd.opening}\IndexCmd{opening} command.
+% Fuellmaterial
+\iftrue%
+ The letterhead is positioned absolutely, so that it is independent of the
+ type area. In fact, the first page of a letter, the page that holds the
+ letterhead, is set using the page style
+ \DescRef{\LabelBase.pagestyle.empty}\IndexPagestyle{empty}.%
+\fi
+% Ende des Fuellmaterials
+
+
+\begin{Declaration}
\OptionVName{firsthead}{simple switch}
\end{Declaration}
\BeginIndex{}{letterhead}%
@@ -1118,6 +1610,51 @@ standard values for simple switches given in \autoref{tab:truefalseswitch} on
\begin{Declaration}
+ \PLength{firstheadvpos}
+\end{Declaration}
+The \PLength{firstheadvpos} pseudo-length gives the distance between the top
+edge of the paper and the start of the letterhead. This value is set
+differently in the various predefined
+\File{lco} files\textnote{\File{lco} file}\Index{lco file=\File{lco} file}. A
+typical value is 8\Unit{mm}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{firstheadhpos}
+\end{Declaration}
+A positive value of the
+\PLength{firstheadhpos}\ChangedAt{v3.05}{\Class{scrlttr2}} pseudo-length gives
+the distance between the left edge of the paper and the start of the
+letterhead. If\textnote{Attention!} the value is actually greater than or
+equal to the paper width,
+\Length{paperwidth}\important{\Length{paperwidth}}\IndexLength{paperwidth},
+the letterhead will be centred horizontally on the letterhead paper. A
+negative value gives the distance between the right edge of the paper and the
+right edge of the letterhead. If the value actually less than or equal to the
+negative value of the width of the paper, the letterhead is placed flush with
+the left edge of the type area.
+
+The default\textnote{Attention!} value is typically
+\Length{maxdimen}\IndexLength{maxdimen}, which is the maximum allowed value of
+a length. This results in horizontal centring.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{firstheadwidth}
+\end{Declaration}
+The \PLength{firstheadwidth} pseudo-length gives the width of the letterhead.
+This value is set differently in the various predefined \File{lco}
+files\textnote{\File{lco} file}\Index{lco file=\File{lco} file}. While this
+value usually depends on the paper width and the distance between the left
+edge of the paper and the recipient's address field, it was the width of the
+type area in \Option{KOMAold} and has a fixed value of 170\Unit{mm} in
+\Option{NF}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
\OptionVName{fromalign}{method}
\end{Declaration}
\BeginIndex{}{letterhead}%
@@ -1305,6 +1842,27 @@ definitely set the variables for return address (see
%
\EndIndexGroup
+
+\begin{Declaration}
+ \PLength{fromrulethickness}%
+ \PLength{fromrulewidth}
+\end{Declaration}
+As mentioned in the explanation of the
+\DescRef{\LabelBase.option.fromrule}\IndexOption{fromrule} option in
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.fromrule}, you
+can put a horizontal rule within or below the sender's address in the
+predefined letterheads. If\textnote{Attention!} the \PLength{fromrulewidth}
+pseudo-length has a value of 0\Unit{pt}, which is the default in the
+predefined \File{lco} files, the length of this rule is calculated
+automatically taking into account, for example, letterhead width or an
+optional logo. You can adjust rule length manually in your own \File{lco}
+files by setting this pseudo-length to positive values using
+\Macro{setplength} (see \DescPageRef{\LabelBase.cmd.setplength}). The
+default thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}},
+\PLength{fromrulethickness}, is 0.4\Unit{pt}.%
+\EndIndexGroup
+
+
\begin{Declaration}
\OptionVName{symbolicnames}{value}%
\OptionVName{fromphone}{simple switch}%
@@ -1477,8 +2035,7 @@ logo\Index{Logo} in the letterhead. You can use any of the default values from
\PName{simple switch}. The default is \PValue{false}, which means no logo. The
logo itself is defined by the \PName{content} of the \Variable{fromlogo}
variable. The \PName{description} of the logo is empty by default and
-\KOMAScript{} does not use it in the default letterhead pages (see also
-\autoref{tab:\LabelBase.fromTerm}).%
+\KOMAScript{} does not use it in the default letterhead pages.%
\begin{Example}
Mr Public finds it particularly stylish when he provides his letterhead with
a logo. He has saved his logo as a graphics file, which he would like to
@@ -1532,7 +2089,23 @@ course you can and should use other variables with
a detailed example of a letterhead definition in
\autoref{cha:modernletters}.}%
\EndIndexGroup
+%
+\EndIndexGroup
+
+\subsection{Addressee}
+\seclabel{addressee}%
+\BeginIndexGroup
+\BeginIndex{}{addressee}
+\index{recipient|seealso{addressee}}
+
+The term \emph{addressee} normally refers only to the recipient's name and
+address, which are output in an address field. Additional information,
+however, can be placed within this address field, including the delivery
+method, for example registered mail or special delivery. For window envelopes,
+the return address also counts as part of the address field, as it will be
+displayed in the address window. The address field directly follows the
+letterhead.
\begin{Declaration}
\OptionVName{addrfield}{format}%
@@ -1712,7 +2285,7 @@ selected, which is the default. The \Class{scrlttr2} class itself does not use
the \PName{description} of the \Variable{specialmail} variable. The alignment
is defined by the \PLength{specialmailindent} and
\PLength{specialmailrightindent} pseudo-lengths (see
-\DescPageRef{scrlttr2-experts.plength.specialmailindent}). You can change the
+\DescPageRef{\LabelBase.plength.specialmailindent}). You can change the
default font style of the\ChangedAt{v2.97c}{\Class{scrlttr2}}
\FontElement{specialmail}\important{\FontElement{specialmail}} element, which
is listed in \autoref{tab:\LabelBase.AddresseeElements}, with the
@@ -1820,11 +2393,11 @@ be printed with the \OptionValue{addrfield}{backgroundimage} option.
The position of the postpaid postmark and that of the
postpaid address is defined by the \PLength{toaddrindent} pseudo-length (see
-\DescPageRef{scrlttr2-experts.plength.toaddrindent}) as well as
+\DescPageRef{\LabelBase.plength.toaddrindent}) as well as
\PLength{PPheadwidth} and \PLength{PPheadheight} (see
-\DescPageRef{scrlttr2-experts.plength.PPheadheight}). The position of
+\DescPageRef{\LabelBase.plength.PPheadheight}). The position of
the data array is defined by the \PLength{PPdatamatrixvskip} pseudo-length
-(see \DescPageRef{scrlttr2-experts.plength.PPdatamatrixvskip}).
+(see \DescPageRef{\LabelBase.plength.PPdatamatrixvskip}).
Note\textnote{Attention!} that \KOMAScript{} cannot print any external
graphics or pictures by itself. So if you want to put external picture files
@@ -1838,13 +2411,196 @@ must load an additional graphics package like
\begin{Declaration}
+ \PLength{toaddrvpos}%
+ \PLength{toaddrhpos}
+\end{Declaration}
+These pseudo-lengths define the vertical and horizontal distance of the
+address field from the top-left corner of the paper. Values are set
+differently in the various predefined \File{lco} files\textnote{\File{lco}
+file}\Index{lco file=\File{lco} file}, according to standard envelope window
+measures. For \PLength{toaddrhpos}, one property worth noting is that with
+negative values, the offset is the distance from the right edge of the address
+field to the right edge of the paper. You will find this, for instance, in
+\Option{SN} or \Option{NF}. The smallest value of \PLength{toaddrvpos} is
+found with \Option{DINmtext}. With this setting, the letterhead can easily
+protrude into the address window. Whether the address field is output or not
+depends on the \Option{addrfield} option (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.addrfield}).%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{toaddrheight}
+\end{Declaration}
+This pseudo-length defines the height of the address field, including the
+delivery method. Whether the name and address of the recipient are vertically
+centred in the address field, taking into account the presence or absence of
+the delivery method, depends on the \DescRef{\LabelBase.option.addrfield}
+option.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{toaddrwidth}
+\end{Declaration}
+This pseudo-length defines the width of the address field. The various
+predefined \File{lco} files\textnote{\File{lco} files}\Index{lco
+file=\File{lco} files} use different settings according to the different
+standards for window envelopes. Typical values are between 70\Unit{mm} and
+100\Unit{mm}.
+\begin{Example}
+ Suppose your printer has very wide, non-printable left and right margins of 15\Unit{mm}.
+ This means that the letterhead, the additional sender information, and the address field cannot
+ be completely printed if you use the \Option{SN} option. You therefore
+ create a new \File{lco} file with the following content:
+\begin{lstcode}
+ \ProvidesFile{SNmmarg.lco}
+ [2002/06/04 v0.1 my lco]
+ \LoadLetterOption{SN}
+ \addtoplength{toaddrwidth}{%
+ -\useplength{toaddrhpos}}
+ \setplength{toaddrhpos}{-15mm}
+ \addtoplength{toaddrwidth}{%
+ \useplength{toaddrhpos}}
+ \endinput
+\end{lstcode}
+ Then, until you can obtain a printer with smaller page margins, you
+ simply use the option \Option{SNmmarg} instead of \Option{SN}.%
+\end{Example}%
+%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{toaddrindent}
+\end{Declaration}
+Sometimes you do not want the address field to extend the full width of the
+address window but to be indented a bit. You can set the amount of this
+indentation with the \PLength{toaddrindent} pseudo-length. Typically, the
+default value is 0\Unit{pt}.
+
+For\textnote{Attention!} the\ChangedAt{v3.03}{\Class{scrlttr2}}
+\OptionValueRef{scrlttr2}{addrfield}{PP}\important{%
+ \OptionValueRef{scrlttr2}{addrfield}{PP}\\
+ \OptionValueRef{scrlttr2}{addrfield}{image}\\
+ \OptionValueRef{scrlttr2}{addrfield}{backgroundimage}
+}\IndexOption{addrfield~=\textKValue{PP}},
+\OptionValueRef{scrlttr2}{addrfield}{image}%
+\IndexOption{addrfield~=\textKValue{image}}, and
+\OptionValueRef{scrlttr2}{addrfield}{backgroundimage}%
+\IndexOption{addrfield~=\textKValue{backgroundimage}} settings (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.addrfield}) a
+value of 0\Unit{pt} will be replaced by a value of 8\Unit{mm}. If you really
+do not want any indentation, you can use a value of 1\Unit{sp} to set a
+negligibly small indentation. Furthermore, \PLength{toaddrindent} is also used
+for the distance to the right edge of the address window with the these
+\Option{addrfield} settings.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{backaddrheight}
+\end{Declaration}
+For window envelopes, the sender is often printed in a small font on one line
+above the addressee. This sender information is called the return
+address\textnote{return address}\Index{return address}, because it is visible
+in the address window and will be used by the post office to return an
+undeliverable letter to the sender. This return address, therefore, requires
+only the information necessary for that purpose.
+
+The height reserved for the return address within the address window is given
+by the \PLength{backaddrheight} pseudo-length. This value is typically
+5\Unit{mm} in the predefined \File{lco} files\textnote{\File{lco}
+file}\Index{}{lco file=\File{lco} file}. Whether to print the return address
+at all depends on the \Option{addrfield} (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.addrfield}) and
+\DescRef{\LabelBase.option.backaddress} options (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.backaddress}).%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{specialmailindent}%
+ \PLength{specialmailrightindent}
+\end{Declaration}
+You can print an optional delivery method between the return address and the
+recipient's address. This field is printed only if the
+\DescRef{\LabelBase.variable.specialmail} variable has non-empty contents. Its
+alignment is determined by the \PLength{specialmailindent} and
+\PLength{specialmailrightindent} pseudo-lengths, which specify the left and
+right indentation, respectively. In the predefined \File{lco}
+files\textnote{\File{lco} file}\Index{lco file=\File{lco} file},
+\PLength{specialmailindent} is set to rubber length \Macro{fill}, while
+\PLength{specialmailrightindent} is set to 1\Unit{em}. Thus the delivery
+method is set 1\Unit{em} from the address field's right margin.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{PPheadheight}%
+ \PLength{PPheadwidth}
+\end{Declaration}
+The \PLength{PPheadheight}\ChangedAt{v3.03}{\Class{scrlttr2}} pseudo-length
+specifies the height reserved for the postpaid header at the start of the
+address field for the two options
+\OptionValueRef{scrlttr2}{addrfield}{PP}\important{%
+ \OptionValueRef{scrlttr2}{addrfield}{PP}\\
+ \OptionValueRef{scrlttr2}{addrfield}{backgroundimage}}%
+\IndexOption{addrfield~=\textKValue{PP}} and
+\OptionValueRef{scrlttr2}{addrfield}{backgroundimage}%
+\IndexOption{addrfield~=\textKValue{backgroundimage}}. The
+\PLength{PPheadwidth} pseudo-length is used only with
+\OptionValueRef{scrlttr2}{addrfield}{PP} (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.addrfield}) and
+gives the width of the left-hand field within the postpaid header, which
+contains the postpaid logo, the postal code, and the location. The width of
+the right-hand field containing the sender's code and the priority is the
+remaining width.
+
+\KOMAScript{}\textnote{Attention!} automatically changes the default value of
+0\Unit{mm} for the \PLength{PPheadheight} pseudo-length to 20.74\Unit{pt}, and
+\PLength{PPheadwidth}'s default from 0\Unit{mm} to 42\Unit{mm}.%
+%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{PPdatamatrixvskip}
+\end{Declaration}
+This\ChangedAt{v3.03}{\Class{scrlttr2}} pseudo-length specifies the vertical
+distance between the postpaid header and the data array used with
+\OptionValueRef{scrlttr2}{addrfield}{PP}%
+\important{\OptionValueRef{scrlttr2}{addrfield}{PP}}%
+\IndexOption{addrfield~=\PValue{PP}} (see \autoref{sec:\LabelBase.firstpage},
+\DescPageRef{\LabelBase.option.addrfield}). \KOMAScript{}\textnote{Attention!}
+automatically changes the default value of 0\Unit{mm} to 9\Unit{mm}. The data
+matrix is flush right within the postpaid header.%
+\EndIndexGroup
+%
+\EndIndexGroup
+
+
+\subsection{Extra Sender Information}
+\seclabel{locationField}
+\BeginIndexGroup
+\BeginIndex{}{extra sender information}
+\index{sender>extra information|see{extra sender information}}
+
+Often, especially with business letters, there is not enough space in the
+letterhead and footer to accommodate all the information about the sender that
+you want to include. For such additional information, you can use the space
+next to the addressee. In this manual, this field is called the
+\emph{extra sender information}. In earlier versions of this manual, it
+was called the \emph{sender's extension} or the \emph{location field}.
+
+
+\begin{Declaration}
\OptionVName{locfield}{setting}
\end{Declaration}
\BeginIndex{}{extra sender information}%
-In addition to the address field, \Class{scrlttr2} can print a field with
-extra sender attributes next to the address field. Its content can be
-anything you want, for example a location, a bank-account number, or other
-information. Depending\important{%
+The content ot the field with extra sender attributes next to the address
+field can be anything you want, for example a location, a bank-account number,
+or other information. Depending\important{%
\OptionValueRef{\LabelBase}{fromalign}{locationleft}\\
\OptionValueRef{\LabelBase}{fromalign}{center}\\
\OptionValueRef{\LabelBase}{fromalign}{locationright}} on the
@@ -1854,8 +2610,8 @@ sender's logo. The width of this field can be specified in an \File{lco} file
\Option{locfield} option can toggle between two defaults for the field width.
This is the case for most of the \File{lco} files that come with
\KOMAScript{}. See also the explanation on the \PLength{locwidth}
-pseudo-length in \autoref{sec:scrlttr2-experts.locationField},
-\DescPageRef{scrlttr2-experts.plength.locwidth}. Available values for this
+pseudo-length in \autoref{sec:\LabelBase.locationField},
+\DescPageRef{\LabelBase.plength.locwidth}. Available values for this
option are shown in \autoref{tab:\LabelBase.locfield}. The default is
\PValue{narrow}.%
%
@@ -1915,6 +2671,51 @@ not use the \PName{description} of this variable.
\begin{Declaration}
+ \PLength{locheight}%
+ \PLength{lochpos}%
+ \PLength{locvpos}%
+ \PLength{locwidth}
+\end{Declaration}
+The \PLength{locwidth} and
+\PLength{locheight}\ChangedAt{v2.97d}{\Class{scrlttr2}} pseudo-lengths set the
+width and height of the extra-sender-information field. The \PLength{lochpos}
+and \PLength{locvpos} pseudo-lengths determine the distances from the
+top-right edge of the paper. These values are typically set to 0\Unit{pt} in
+the predefined \File{lco} files. These\textnote{Attention!} zero-length values
+have a special meaning. They result in the actual values being set within
+\DescRef{\LabelBase.cmd.opening} based on the paper width, the address-window
+width, the address window's distance from the top-left edge of the paper, and
+the \DescRef{\LabelBase.option.locfield} option (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.locfield}). As
+is the case for \PLength{toaddrhpos}, negative values of \PLength{lochpos}
+also take on a special meaning. Instead of referring to the distance from the
+right edge of the paper, \PLength{lochpos} then refers to the distance from
+the left edge of the paper. The meaning is thus the opposite of that of
+\PLength{toaddrhpos} (see \autoref{sec:\LabelBase.addressee},
+\DescPageRef{\LabelBase.plength.toaddrhpos}).%
+\EndIndexGroup
+%
+\EndIndexGroup
+
+
+\subsection{Reference Line}
+\seclabel{refLine}%
+\BeginIndexGroup
+\BeginIndex{}{reference line}
+\index{business line|see{reference line}}
+
+The reference line can actually be longer than just one line. It is printed
+only if at least one of variables for the reference line is not empty. Only
+non-empty fields will be printed. To\textnote{Hint!} set a seemingly empty
+field, you can provide content for the variable that appears empty, such as
+\Macro{mbox}\Parameter{}. If the reference line is omitted, the description
+and contents of the \DescRef{\LabelBase.variable.date} variable are printed in
+its place. You can find information about adding variables to or removing them
+from the reference line in \autoref{sec:scrlttr2-experts.variables},
+\DescPageRef{scrlttr2-experts.cmd.removereffields}.
+
+
+\begin{Declaration}
\OptionVName{numericaldate}{simple switch}
\end{Declaration}
This option toggles between the standard, language-dependent
@@ -2132,6 +2933,78 @@ usual with the \DescRef{\LabelBase.cmd.setkomafont} and
\begin{Declaration}
+ \PLength{refvpos}
+\end{Declaration}
+This pseudo-length specifies the distance from the upper edge of the paper to
+the reference line. Its value is set differently in the various predefined
+\File{lco} files\textnote{\File{lco} file}\Index{lco file=\File{lco} file}.
+Typical values are between 80.5\Unit{mm} and 98.5\Unit{mm}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{refwidth}%
+ \PLength{refhpos}
+\end{Declaration}
+The \PLength{refwidth} pseudo-length specifies the width available for the
+reference line. Its value is typically set to 0\Unit{pt} in the predefined
+\File{lco} files\textnote{\File{lco} file}\Index{lco file=\File{lco} file}.
+This\textnote{Attention!} value has a special meaning. In no way does it
+indicate that there is no available width for the reference line. Instead, it
+indicates that the width will be calculated within the
+\DescRef{\LabelBase.cmd.opening}\IndexCmd{opening} command. This calculated
+width then depends on the value of the \DescRef{\LabelBase.option.refline}%
+\important{\DescRef{\LabelBase.option.refline}}%
+\IndexOption{refline~=\PName{setting}} options (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.refline}). At
+the same time, \PLength{refhpos} will also be set according to this option.
+With \OptionValueRef{scrlttr2}{refline}{wide}%
+\IndexOption{refline~=\textKValue{wide}}, the reference fields line is
+centred, while with \OptionValueRef{scrlttr2}{refline}{narrow}%
+\IndexOption{refline~=\textKValue{narrow}} it is aligned flush left with the
+type area.
+
+If \PLength{refwidth} is not zero, the width of the reference line is not
+determined by the \DescRef{\LabelBase.option.refline} option, and so
+\PLength{refhpos} specifies the distance of the reference line from the left
+edge of the paper. If\textnote{Attention!} this distance is zero, the the
+reference line is placed so that the ratio between its distances from the left
+and right edges of the paper corresponds to the ratio of distance of the type
+area from the left and right edges of the paper. Thus, for a type area
+horizontally centred on the paper, the reference line will also be centred.
+
+As a rule, these special cases are likely of little interest to the normal
+user. The\textnote{Attention!} simplest rule is as follows: either
+\PLength{refhpos} remains zero, and so the width and alignment of the
+reference line are determined with the \DescRef{\LabelBase.option.refline}
+option, or the user sets both \PLength{refwidth} and \PLength{refhpos}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{refaftervskip}
+\end{Declaration}
+This pseudo-length specifies the vertical skip to be inserted beneath the
+reference line. The value is set in the predefined \File{lco}
+files\textnote{\File{lco} file}\Index{lco file=\File{lco} file}. It directly
+affects the height of the text area on the first page. A typical value is
+between one and two lines.%
+\EndIndexGroup
+%
+\EndIndexGroup
+
+
+\subsection{Subject}
+\seclabel{subject}%
+\BeginIndexGroup
+\BeginIndex{}{subject}
+
+Different countries have different conventions for placing the subject line of
+a letter. Some place it before the opening phrase; others place it after. Some
+professional groups even want it before the reference line.
+
+
+\begin{Declaration}
\Variable{title}%
\end{Declaration}
With \KOMAScript{}, you can also give a letter a title\Index{title}. The title
@@ -2292,6 +3165,198 @@ settings.%
\begin{Declaration}
+ \PLength{subjectvpos}
+\end{Declaration}
+\ChangedAt{v3.01}{\Class{scrlttr2}}%
+If\textnote{Attention!} the value of this pseudo-length is 0\Unit{pt}, the
+\DescRef{\LabelBase.option.subject}\important{\DescRef{\LabelBase.option.subject}}%
+\IndexOption{subject~=\PName{Einstellung}} option (see
+\autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.option.subject})
+determines the position of the subject. Any other value defines the distance
+between the top edge of the paper and the subject. In this
+case\textnote{Hint!}, you should ensure that there is enough space available
+that overlapping with other elements is unlikely.
+\begin{Example}
+ A few professionals prefer to have the subject above the reference line. For
+ this, you can specify the position as follows, which also changes the
+ position of the reference line itself:
+\begin{lstcode}
+ \ProvidesFile{lawsubj.lco}
+ [2008/11/03 lawyers lco file]
+ \setplength{subjectvpos}{\useplength{refvpos}}
+ \addtoplength{refvpos}{3\baselineskip}
+ \endinput
+\end{lstcode}
+ If you want to leave at least one empty line between the subject and the
+ reference, you have space for a maximum of two lines.
+\end{Example}
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{subjectbeforevskip}%
+ \PLength{subjectaftervskip}
+\end{Declaration}
+\ChangedAt{v3.01}{\Class{scrlttr2}}%
+If the subject is placed not absolutely but before or after the salutation,
+you can insert additional vertical space before and after the subject. The
+space before the subject may interfere with other distances, such as the
+automatic distance of one line after the title. Therefore the default is to
+use no additional space here. The default of the class and the package for the
+space after the subject is two lines.%
+\EndIndexGroup
+%
+\EndIndexGroup
+
+
+\subsection{Closing}
+\seclabel{closing}
+\BeginIndexGroup
+\BeginIndex{}{closing}
+
+\BeginIndex{}{letter>closing}%
+\BeginIndex{}{signature}%
+\BeginIndex{}{letter>signature}%
+
+It has already been mentioned in \autoref{sec:\LabelBase.document},
+\DescPageRef{\LabelBase.cmd.closing} that the letter's closing text is
+provided by \DescRef{\LabelBase.cmd.closing}\IndexCmd{closing}. Beneath the
+closing text, there is often a space for a handwritten signature, beneath
+which there can be a printed name, which serves as a kind of annotation to the
+actual signature.
+
+
+\begin{Declaration}
+ \Variable{signature}%
+\end{Declaration}
+The \Variable{signature} variable contains the printed name or annotation for
+the handwritten signature. Its default \PName{content} is the
+\DescRef{\LabelBase.cmd.usekomavar}\PParameter{fromname}. This annotation can
+consist of multiple lines. In that case, you should separate the individual
+lines with double backslashes. Paragraph\textnote{Attention!} breaks in the
+signature annotation, however, are not permitted.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \Macro{raggedsignature}
+\end{Declaration}
+The closing phrase and the signature will be typeset in a box. The width of
+the box is determined by the length of the longest line in the closing
+phrase or signature.
+
+The \PLength{sigindent}\IndexPLength{sigindent} and
+\PLength{sigbeforevskip}\IndexPLength{sigbeforevskip} pseudo-lengths determine
+exactly where this box is placed (see \autoref{sec:\LabelBase.closing},
+\DescPageRef{\LabelBase.plength.sigindent}). The \Macro{raggedsignature}
+command defines the alignment inside the box. In the default \File{lco} files,
+the command is either defined as \Macro{centering} (all besides
+\Option{KOMAold}) or \Macro{raggedright} (\Option{KOMAold}). In order to
+obtain flush-right or flush-left alignment inside the box, you can redefine
+the command in the same way as \DescRef{maincls.cmd.raggedsection} (see the
+example in \autoref{sec:maincls.structure},
+\DescPageRef{maincls.cmd.raggedsection}).
+
+\begin{Example}
+ Now Mr Public wants to make himself seem really important, and therefore he uses the
+ signature to show once again that he was formerly a chairman himself. So
+ he changes \PName{contents} of the
+ \DescRef{\LabelBase.variable.signature} variable. He also wants the signature
+ be aligned flush-left and so he also redefines \Macro{raggedsignature}:%
+ \lstinputcode[xleftmargin=1em]{letter-22}%
+ See \autoref{fig:\LabelBase.letter-22} for the result.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ recipient, extra sender information, place, date, subject,
+ opening, text, closing, modified signature, postscript, distribution
+ list, enclosure, and hole-punch mark}]
+ {result of a short letter with extended sender, logo, recipient,
+ extra sender information, place, date, subject opening, text,
+ closing, modified signature, postscript, distribution list, enclosure
+ and hole-punch mark}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-22}}
+ \end{captionbeside}
+ \label{fig:\LabelBase.letter-22}
+ \end{figure}
+\end{Example}
+\iftrue% Umbruchkorrekturtext
+ The preceding example shows the most important, although not all possible,
+ elements of a letter. It can, however, serve quite well as a general
+ template.%
+\else
+ \vskip -1\ht\strutbox plus .75\ht\strutbox% example at end of description
+\fi
+%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{sigindent}%
+ \PLength{sigbeforevskip}
+\end{Declaration}
+The closing phrase\Index{closing>phrase}\Index{signature} and signature
+explanation are typeset in a box whose width is determined by the length of
+the longest line of the closing phrase or explanation.
+
+The box will be indented by the distance specified in the \PLength{sigindent}
+pseudo-length. In the predefined \File{lco} files\textnote{\File{lco}
+file}\Index{lco file=\File{lco} file}, this length is set to 0\Unit{mm}.
+
+Between the closing phrase and the signature explanation, a vertical skip is
+inserted whose height is defined in the \PLength{sigbeforevskip}
+pseudo-length. In the predefined \File{lco} files\textnote{\File{lco}
+file}\Index{lco file=\File{lco} file} this value is set to two lines. In this
+space you can then write your signature.%
+\iffalse% Umbruchkorrekturtext
+\ If you decide to include a facsimile of your signature in the
+\DescRef{\LabelBase.variable.signature}\IndexVariable{signature}%
+\important{\DescRef{\LabelBase.variable.signature}} with the
+\Package{graphicx}\IndexPackage{graphicx} package, it would be useful
+to reduce the value of \PLength{sigbeforevskip} and thus the gap between
+the closing phrase and the signature.%
+\fi%
+\EndIndexGroup
+%
+\EndIndexGroup
+
+
+\subsection{Letterhead Page Footer}
+\seclabel{firstFoot}%
+\BeginIndexGroup
+\BeginIndex{}{letterhead page>footer}%
+
+The first page of a letter, the letterhead page, contains not just its own
+header, the letterhead, but also its own footer\Index{footer>letterhead
+page}\Index{footer}. Just like the letterhead, it will be set not by the page
+style but directly within \DescRef{\LabelBase.cmd.opening}\IndexCmd{opening}%
+\important{\DescRef{\LabelBase.cmd.opening}}.
+
+
+\begin{Declaration}
+ \OptionVName{enlargefirstpage}{simple switch}
+\end{Declaration}
+\begin{Explain}
+ The first page of a letter always uses a different page layout because of
+ the many predefined elements such as the letterhead or the address. The
+ \Class{scrlttr2} class provides a mechanism to calculate height and vertical
+ alignment of header and footer of the first page independently of the
+ subsequent pages. If, as a result, the footer of the first page would
+ protrude into the text area, this text area of the first page is
+ automatically reduced using
+ \Macro{enlargethispage}\IndexCmd{enlargethispage}.
+\end{Explain}
+If the text area should become larger, assuming the footer on the first page
+permits this, you can use this option. At best, a little more text will then
+fit on the first page. See also the description of the \PLength{firstfootvpos}
+pseudo-length on \DescPageRef{\LabelBase.plength.firstfootvpos}. This
+option takes the standard values for simple switches, as listed in
+\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. The default
+is \PValue{false}.\textnote{default}%
+\EndIndexGroup
+
+
+\begin{Declaration}
\OptionVName{firstfoot}{simple switch}
\end{Declaration}
\BeginIndex{}{letterhead page>footer}%
@@ -2351,7 +3416,7 @@ does not use the \PName{description} of the variable.
\multicolumn{1}{@{}l@{}}{Court Jurisdiction:}\\
Great Plains
\end{tabular}%
- \ifkomavarempty{frombank}{}{%
+ \Ifkomavarempty{frombank}{}{%
\hfill
\begin{tabular}[t]{l@{}}%
\multicolumn{1}{@{}l@{}}{\usekomavar*{frombank}:}\\
@@ -2381,7 +3446,7 @@ of version 2.9u (see \DescRef{\LabelBase.option.version} in
\autoref{sec:\LabelBase.compatibilityOptions},
\DescPageRef{\LabelBase.option.version}) the space is generally insufficient.
In this case, you should reduce \PLength{firstfootvpos} (see
-\DescPageRef{scrlttr2-experts.plength.firstfootvpos}) appropriately.%
+\DescPageRef{\LabelBase.plength.firstfootvpos}) appropriately.%
\EndIndexGroup
\begin{Declaration}
@@ -2396,6 +3461,82 @@ the variable \DescRef{\LabelBase.variable.location},
\DescPageRef{\LabelBase.variable.location}).%
%
\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{firstfootvpos}
+\end{Declaration}
+This pseudo-length gives the distance from the top of the paper to the footer
+of the letterhead page. It also ensures that the text area does not protrude
+into the footer. To do so, the height of the text area on the first page will
+be decreased, if necessary, using
+\Macro{enlargethispage}\IndexCmd{enlargethispage}%
+\important{\Macro{enlargethispage}}. The
+\DescRef{\LabelBase.option.enlargefirstpage}%
+\important{\DescRef{\LabelBase.option.enlargefirstpage}} option (see
+\autoref{sec:\LabelBase.firstpage},
+\DescPageRef{\LabelBase.option.enlargefirstpage}) can also ensure that the
+height of the text area is increased, if necessary. Thus, the distance between
+text area and the letterhead page footer can be reduced to the value of the
+\Length{footskip}\IndexLength{footskip}\important{\Length{footskip}} length.
+
+With\textnote{Attention!} the compatibility option
+set\ChangedAt{v2.9t}{\Class{scrlttr2}} to versions up to
+2.9t\IndexOption{version~=\PValue{2.9t}} (see
+\DescRef{\LabelBase.option.version} in
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}) the footer is set independently of the
+type area in all predefined \File{lco} files\textnote{\File{lco}
+file}\Index{lco file=\File{lco} file} (see \autoref{sec:\LabelBase.lcoFile})
+except for \Option{KOMAold} and \Option{NF}. Thus the
+\DescRef{\LabelBase.option.enlargefirstpage}%
+\important{\DescRef{\LabelBase.option.enlargefirstpage}} option has no effect.
+From version 2.9u on, the footer is placed at the bottom edge of the paper.
+Thus, the height of the letterhead page's type area may also depend on the
+\DescRef{\LabelBase.option.enlargefirstpage} option.
+
+If the letter footer is deactivated with the
+\OptionValueRef{scrlttr2}{firstfoot}{false}%
+\important{\OptionValueRef{scrlttr2}{firstfoot}{false}}%
+\IndexOption{firstfoot~=\PValue{false}}\ChangedAt{v2.97e}{\Class{scrlttr2}}
+option (see \autoref{sec:\LabelBase.firstpage},
+\DescPageRef{\LabelBase.option.firstfoot}), the setting of
+\PLength{firstfootvpos} is ignored, and instead
+\Length{paperheight}\IndexLength{paperheight} is applied. There remains then a
+minimum bottom margin of length \Length{footskip}\IndexLength{footskip}.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{firstfoothpos}
+\end{Declaration}
+\ChangedAt{v3.05}{\Class{scrlttr2}}%
+A\textnote{Attention!} positive value of the \PLength{firstfoothpos}
+pseudo-length specifies the distance from the left edge of the paper to the
+letterhead page footer. If the value is greater than or equal to the paper
+width, \Length{paperwidth}\IndexLength{paperwidth}, the footer is centred
+horizontally on the letterhead page. But if the value is less than or equal to
+the negative width of the paper, the footer is placed flush with the left edge
+of the typing area.
+
+The typical default for this value is \Length{maxdimen}\IndexLength{maxdimen},
+which is the maximum possible value for a length. This results in horizontal
+centring.%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \PLength{firstfootwidth}
+\end{Declaration}
+This pseudo-length specifies the width of the footer of the first page of the
+letter, that is the letterhead page. The value in the predefined \File{lco}
+files\textnote{\File{lco} file}\Index{lco file=\File{lco} file} matches
+\PLength{firstheadwidth}\important{\PLength{firstheadwidth}}%
+\IndexPLength{firstheadwidth}.%
+%
+\EndIndexGroup
+%
+\EndIndexGroup
%
\EndIndexGroup
@@ -2720,19 +3861,28 @@ uses \Macro{thispagestyle}\PParameter{empty} within
\DescRef{\LabelBase.cmd.opening}\IndexCmd{opening} for the first page of the
letter.
-\BeginIndexGroup
+\BeginIndexGroup%
\BeginIndex[indexother]{}{font>style}%
\BeginIndex{FontElement}{pageheadfoot}\LabelFontElement{pageheadfoot}%
+\BeginIndex{FontElement}{pagehead}\LabelFontElement{pagehead}%
\BeginIndex{FontElement}{pagefoot}\LabelFontElement{pagefoot}%
\BeginIndex{FontElement}{pagenumber}\LabelFontElement{pagenumber}%
To changing the font style of headers or footers, you should use the user
interface described in \autoref{sec:maincls.textmarkup}. The header and footer
-use the same element, which you can refer to by either
-\FontElement{pageheadfoot}\important{\FontElement{pagehead}} or
-\FontElement{pagehead}. The\ChangedAt{v3.00}{\Class{scrlttr2}}
-\FontElement{pagefoot}\important{\FontElement{pagefoot}} element
-additionally controls the formatting of the footer. This element is applied
-after \FontElement{pageheadfoot} in the
+use the same element
+\FontElement{pageheadfoot}\important{\FontElement{pageheadfoot}}.
+% TODO: Fix new translation
+With package \hyperref[cha:scrlayer-scrpage]{\Package{scrlayer-scrpage}}%
+\IndexPackage{scrlayer-scrpage} and therefore with \Package{scrletter} the
+\FontElement{pagehead}\important{\FontElement{pagehead}} element is
+additionally responsible for the header. In \Class{scrlttr2} and without
+package \Package{scrlayer-scrpage} the element is an alias of
+\FontElement{pageheadfoot} only.
+% :ODOT
+The\ChangedAt{v3.00}{\Class{scrlttr2}}
+\FontElement{pagefoot}\important{\FontElement{pagefoot}} element additionally
+controls the formatting of the footer. This element is applied after
+\FontElement{pageheadfoot} in the
\DescRef{\LabelBase.variable.nextfoot}\IndexVariable{nextfoot} variable or
when \Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} page styles are
used (see \autoref{cha:scrlayer-scrpage},
@@ -2856,87 +4006,6 @@ in letters. You could also define your own floating environments with help of
\LoadCommonFile{marginpar} % \section{Margin Notes}
-\section{Closing}
-\seclabel{closing}
-\BeginIndexGroup%
-\BeginIndex{}{closing}%
-\BeginIndex{}{letter>closing}%
-\BeginIndex{}{signature}%
-\BeginIndex{}{letter>signature}%
-
-It has already been mentioned in \autoref{sec:\LabelBase.document},
-\DescPageRef{\LabelBase.cmd.closing} that the letter's closing text is
-provided by \DescRef{\LabelBase.cmd.closing}\IndexCmd{closing}. Beneath the
-closing text, there is often a space for a handwritten signature, beneath
-which there can be a printed name, which serves as a kind of annotation to the
-actual signature.
-
-\begin{Declaration}
- \Variable{signature}%
-\end{Declaration}
-The \Variable{signature} variable contains the printed name or annotation for
-the handwritten signature. Its default \PName{content} is the
-\DescRef{\LabelBase.cmd.usekomavar}\PParameter{fromname}. This annotation can
-consist of multiple lines. In that case, you should separate the individual
-lines with double backslashes. Paragraph\textnote{Attention!} breaks in the
-signature annotation, however, are not permitted.%
-\EndIndexGroup
-
-
-\begin{Declaration}
- \Macro{raggedsignature}
-\end{Declaration}
-The closing phrase and the signature will be typeset in a box. The width of
-the box is determined by the length of the longest line in the closing
-phrase or signature.
-
-The \PLength{sigindent}\IndexPLength{sigindent} and
-\PLength{sigbeforevskip}\IndexPLength{sigbeforevskip} pseudo-lengths determine
-exactly where this box is placed (see \autoref{sec:scrlttr2-experts.closing},
-\DescPageRef{scrlttr2-experts.plength.sigindent}). The \Macro{raggedsignature}
-command defines the alignment inside the box. In the default \File{lco} files,
-the command is either defined as \Macro{centering} (all besides
-\Option{KOMAold}) or \Macro{raggedright} (\Option{KOMAold}). In order to
-obtain flush-right or flush-left alignment inside the box, you can redefine
-the command in the same way as \DescRef{maincls.cmd.raggedsection} (see the
-example in \autoref{sec:maincls.structure},
-\DescPageRef{maincls.cmd.raggedsection}).
-
-\begin{Example}
- Now Mr Public wants to make himself seem really important, and therefore he uses the
- signature to show once again that he was formerly a chairman himself. So
- he changes \PName{contents} of the
- \DescRef{\LabelBase.variable.signature} variable. He also wants the signature
- be aligned flush-left and so he also redefines \Macro{raggedsignature}:%
- \lstinputcode[xleftmargin=1em]{letter-22}%
- See \autoref{fig:\LabelBase.letter-22} for the result.
- \begin{figure}
- \setcapindent{0pt}%
- \begin{captionbeside}[{Example: letter with extended sender, logo,
- recipient, extra sender information, place, date, subject,
- opening, text, closing, modified signature, postscript, distribution
- list, enclosure, and hole-punch mark}]
- {result of a short letter with extended sender, logo, recipient,
- extra sender information, place, date, subject opening, text,
- closing, modified signature, postscript, distribution list, enclosure
- and hole-punch mark}[l]
- \frame{\includegraphics[width=.4\textwidth]{letter-22}}
- \end{captionbeside}
- \label{fig:\LabelBase.letter-22}
- \end{figure}
-\end{Example}
-
-\iftrue% Umbruchkorrekturtext
- The preceding example shows the most important, although not all possible,
- elements of a letter. It can, however, serve quite well as a general
- template.%
-\fi
-%
-\EndIndexGroup
-%
-\EndIndexGroup
-
-
\section{Letter Class Option Files}
\seclabel{lcoFile}%
\BeginIndexGroup
@@ -2955,10 +4024,10 @@ In an \File{lco} file, you can use all commands available to the document at
the time the \File{lco} file is loaded. You can also use internal commands
available to package writers. For \Class{scrlttr2} and \Package{scrletter},
these are, in particular, the commands
-\DescRef{scrlttr2-experts.cmd.newplength}\IndexCmd{newplength},
-\DescRef{scrlttr2-experts.cmd.setplength}\IndexCmd{setplength}, and
-\DescRef{scrlttr2-experts.cmd.addtoplength}\IndexCmd{addtoplength} (see
-\autoref{sec:scrlttr2-experts.pseudoLengths}).
+\DescRef{\LabelBase.cmd.newplength}\IndexCmd{newplength},
+\DescRef{\LabelBase.cmd.setplength}\IndexCmd{setplength}, and
+\DescRef{\LabelBase.cmd.addtoplength}\IndexCmd{addtoplength} (see
+\autoref{sec:\LabelBase.pseudoLength}).
\KOMAScript{} comes provided with some \File{lco} files. The \File{DIN.lco},
\File{DINmtext.lco}, \File{SNleft.lco}, \File{SN.lco}, \File{UScommercial9},
@@ -3084,8 +4153,8 @@ applies to the reference line when using the
If\textnote{Hint!} you have this kind of problem, create your own \File{lco}
file that loads \Option{SN} first and then changes
\PLength{toaddrhpos}\IndexPLength{toaddrhpos} (see
-\autoref{sec:scrlttr2-experts.addressee},
-\DescPageRef{scrlttr2-experts.plength.toaddrvpos}) to a smaller value. In
+\autoref{sec:\LabelBase.addressee},
+\DescPageRef{\LabelBase.plength.toaddrvpos}) to a smaller value. In
addition, you should also reduce \PLength{toaddrwidth} accordingly.%
By\textnote{Hint!} the way, the \File{DIN} \File{lco} file is always loaded
@@ -3470,7 +4539,7 @@ versions only recognised the \DescRef{\LabelBase.cmd.adrentry} and
%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
-%%% coding: us-ascii
+%%% coding: utf-8
%%% ispell-local-dictionary: "en_GB"
%%% TeX-master: "../guide"
%%% End: