summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex')
-rw-r--r--macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex1128
1 files changed, 16 insertions, 1112 deletions
diff --git a/macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex b/macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex
index 722183a7bd..23039e48b5 100644
--- a/macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex
+++ b/macros/latex/contrib/koma-script/source-doc/english/scrlttr2-experts.tex
@@ -46,14 +46,14 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2-experts.tex}
- [$Date: 2019-10-10 09:50:23 +0200 (Thu, 10 Oct 2019) $
+ [$Date: 2019-12-03 09:41:21 +0100 (Tue, 03 Dec 2019) $
KOMA-Script guide (chapter: scrlttr2 for experts)]
\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-09
+% Date of the translated German file: 2019-12-03
\chapter{Additional Information about the \Class{scrlttr2} Class and the
\Package{scrletter} Package}
@@ -85,1104 +85,6 @@ nearly all the features of \Class{scrlttr2} for those classes. There are,
however, a few differences described later in this chapter.%
-\section{Pseudo-Lengths for Experienced Users}
-\seclabel{pseudoLengths}
-\BeginIndexGroup
-\BeginIndex{}{pseudo-lengths}
-
-\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,
-\KOMAScript{} stores letter-specific lengths in macros instead of lengths. The
-drawback of this approach is that computations with macros are somewhat more
-complicated than with real lengths.
-
-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.
-
-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.
-
-The pseudo-lengths defined and uses by \KOMAScript{} are listed in
-\autoref{tab:scrlttr2-experts.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:scrlttr2-experts.pseudoLength} on
-\autopageref{fig:scrlttr2-experts.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:scrlttr2-experts.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:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.backaddrheight})%
- }%
- \pentry{bfoldmarklength}{%
- the length of the bottommost fold mark
- (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.bfoldmarkvpos})%
- }%
- \pentry{bfoldmarkvpos}{%
- the vertical distance of the bottommost fold mark from the top edge of the
- paper (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.firstFoot},
- \DescPageRef{scrlttr2-experts.plength.firstfoothpos})%
- }%
- \pentry{firstfootvpos}{%
- the vertical distance of letterhead page footer from the top edge of the
- paper (\autoref{sec:scrlttr2-experts.firstFoot},
- \DescPageRef{scrlttr2-experts.plength.firstfootvpos})%
- }%
- \pentry{firstfootwidth}{%
- the width of the letterhead page footer
- (\autoref{sec:scrlttr2-experts.firstFoot},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.firstHead},
- \DescPageRef{scrlttr2-experts.plength.firstheadhpos})%
- }%
- \pentry{firstheadvpos}{%
- the vertical distance of the letterhead from the top edge of the paper
- (\autoref{sec:scrlttr2-experts.firstHead},
- \DescPageRef{scrlttr2-experts.plength.firstheadvpos})%
- }%
- \pentry{firstheadwidth}{%
- the width of the letterhead (\autoref{sec:scrlttr2-experts.firstHead},
- \DescPageRef{scrlttr2-experts.plength.firstheadwidth})%
- }%
- \pentry{foldmarkhpos}{%
- the horizontal distance of the horizontal fold marks from the left edge of
- the paper (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.foldmarkhpos})%
- }%
- \pentry{foldmarkvpos}{%
- the vertical distance of the vertical fold marks from the top edge of the
- paper (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.foldmarkvpos})%
- }%
- \pentry{fromrulethickness}{%
- the thickness of an optional horizontal rule in the letterhead
- (\autoref{sec:scrlttr2-experts.firstHead},
- \DescPageRef{scrlttr2-experts.plength.fromrulethickness})%
- }%
- \pentry{fromrulewidth}{%
- the length of an optional horizontal rule in the letterhead
- (\autoref{sec:scrlttr2-experts.firstHead},
- \DescPageRef{scrlttr2-experts.plength.fromrulewidth})%
- }%
- \pentry{lfoldmarkhpos}{%
- the horizontal distance of the vertical fold mark from the left edge of
- the paper (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.lfoldmarkhpos})%
- }%
- \pentry{lfoldmarklength}{%
- the length of the vertical fold mark
- (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.locationField},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.locationField},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.locationField},
- \DescPageRef{scrlttr2-experts.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{scrlttr2.option.locfield} option described in
- \autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.locfield} %
- (\autoref{sec:scrlttr2-experts.locationField},
- \DescPageRef{scrlttr2-experts.plength.locwidth})%
- }%
- \pentry{mfoldmarklength}{%
- the length of the middle horizontal fold mark
- (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.mfoldmarklength})%
- }%
- \pentry{mfoldmarkvpos}{%
- the vertical distance of the middle horizontal fold mark from the top edge
- of the paper (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.mfoldmarkvpos})%
- }%
- \pentry{pfoldmarklength}{%
- the length of the hole-punch mark
- (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.pfoldmarklength})%
- }%
- \pentry{PPdatamatrixvskip}{%
- the vertical distance between the postpaid header and the data array with
- \OptionValueRef{scrlttr2}{addrfield}{PP}
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.PPdatamatrixvskip})%
- }%
- \pentry{PPheadheight}{%
- the height of the postpaid header
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.PPheadheight})%
- }%
- \pentry{PPheadwidth}{%
- the width of the left postpaid field with
- \OptionValueRef{scrlttr2}{addrfield}{PP}
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.PPheadwidth})%
- }%
- \pentry{refaftervskip}{%
- vertical skip below reference-field line %
- (\autoref{sec:scrlttr2-experts.refLine},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.refLine},
- \DescPageRef{scrlttr2-experts.plength.refhpos})%
- }%
- \pentry{refvpos}{%
- the vertical distance of reference-field line from the top
- edge of the paper (\autoref{sec:scrlttr2-experts.refLine},
- \DescPageRef{scrlttr2-experts.plength.refvpos})%
- }%
- \pentry{refwidth}{%
- the width of the reference-field line
- (\autoref{sec:scrlttr2-experts.refLine},
- \DescPageRef{scrlttr2-experts.plength.refwidth})%
- }%
- \pentry{sigbeforevskip}{%
- the vertical skip between the closing and the signature
- (\autoref{sec:scrlttr2-experts.closing},
- \DescPageRef{scrlttr2-experts.plength.sigbeforevskip})%
- }%
- \pentry{sigindent}{%
- the indentation of the signature with respect to the text body
- (\autoref{sec:scrlttr2-experts.closing},
- \DescPageRef{scrlttr2-experts.plength.sigindent})%
- }%
- \pentry{specialmailindent}{%
- the left indentation of the delivery method within the address field
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.specialmailindent})%
- }%
- \pentry{specialmailrightindent}{%
- the right indentation of the delivery method within the address field
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.specialmailrightindent})%
- }%
- \pentry{subjectaftervskip}{%
- the vertical skip after the subject
- (\autoref{sec:scrlttr2-experts.subject},
- \DescPageRef{scrlttr2-experts.plength.subjectaftervskip})%
- }%
- \pentry{subjectbeforevskip}{%
- additional vertical skip before the subject
- (\autoref{sec:scrlttr2-experts.subject},
- \DescPageRef{scrlttr2-experts.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{scrlttr2.option.subject} option
- (\autoref{sec:scrlttr2-experts.subject},
- \DescPageRef{scrlttr2-experts.plength.subjectaftervskip})%
- }%
- \pentry{tfoldmarklength}{%
- the length of the topmost horizontal fold mark
- (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.tfoldmarklength})%
- }%
- \pentry{tfoldmarkvpos}{%
- the vertical distance of the topmost horizontal folding mark from the top
- edge of the paper (\autoref{sec:scrlttr2-experts.foldmarks},
- \DescPageRef{scrlttr2-experts.plength.tfoldmarkvpos})%
- }%
- \pentry{toaddrheight}{%
- the height of the address field (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.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:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.toaddrhpos})%
- }%
- \pentry{toaddrindent}{%
- the left and right indentation of the address within the address field
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.toaddrindent})%
- }%
- \pentry{toaddrvpos}{%
- the vertical distance of the address field from the the top edge of the
- paper (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.toaddrvpos})%
- }%
- \pentry{toaddrwidth}{%
- the width of the address field %
- (\autoref{sec:scrlttr2-experts.addressee},
- \DescPageRef{scrlttr2-experts.plength.toaddrwidth})%
- }%
-\end{desclist}
-
-\begin{figure}
- \centering
- \includegraphics{plenDIN}
- \caption{Schematic of the pseudo-lengths for a letter}
- \label{fig:scrlttr2-experts.pseudoLength}
-\end{figure}
-
-
-\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{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{scrlttr2.cmd.setlengthtoplength},
-\autoref{sec:scrlttr2.pseudoLength},
-\DescPageRef{scrlttr2.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:scrlttr2.pseudoLength}, \DescPageRef{scrlttr2.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
-
-
-\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}
- \PLength{tfoldmarkvpos}%
- \PLength{mfoldmarkvpos}%
- \PLength{bfoldmarkvpos}
-\end{Declaration}
-\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{scrlttr2.option.foldmarks}\IndexOption{foldmarks~=\PName{setting}}%
-\important{\DescRef{scrlttr2.option.foldmarks}} option (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2.option.foldmarks}%
-\important{\DescRef{scrlttr2.option.foldmarks}}%
-\IndexOption{foldmarks~=\PName{setting}} (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2.option.foldmarks}%
-\important{\DescRef{scrlttr2.option.foldmarks}}%
-\IndexOption{foldmarks~=\PName{setting}} option (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2.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{scrlttr2.pagestyle.empty}\IndexPagestyle{empty}.%
-\fi
-% Ende des Fuellmaterials
-
-
-\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}
- \PLength{fromrulethickness}%
- \PLength{fromrulewidth}
-\end{Declaration}
-As mentioned in the explanation of the
-\DescRef{scrlttr2.option.fromrule}\IndexOption{fromrule} option in
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2-experts.cmd.setplength}). The
-default thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}},
-\PLength{fromrulethickness}, is 0.4\Unit{pt}.%
-\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}
- \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:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2.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:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.addrfield}) and
-\DescRef{scrlttr2.option.backaddress} options (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2.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:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.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}
- \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{scrlttr2.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{scrlttr2.option.locfield} option (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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:scrlttr2-experts.addressee},
-\DescPageRef{scrlttr2-experts.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{scrlttr2.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}
- \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{scrlttr2.cmd.opening}\IndexCmd{opening} command. This calculated
-width then depends on the value of the \DescRef{scrlttr2.option.refline}%
-\important{\DescRef{scrlttr2.option.refline}}%
-\IndexOption{refline~=\PName{setting}} options (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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{scrlttr2.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{scrlttr2.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}
- \PLength{subjectvpos}
-\end{Declaration}
-\ChangedAt{v3.01}{\Class{scrlttr2}}%
-If\textnote{Attention!} the value of this pseudo-length is 0\Unit{pt}, the
-\DescRef{scrlttr2.option.subject}\important{\DescRef{scrlttr2.option.subject}}%
-\IndexOption{subject~=\PName{Einstellung}} option (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.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}
-
-The closing of a letter consists of three parts: In addition to the closing
-phrase, there is a hand-written signature and a printed text such as a name,
-which acts as a kind of explanation of the hand-written signature.
-
-\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{scrlttr2.variable.signature}\IndexVariable{signature}%
-\important{\DescRef{scrlttr2.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{scrlttr2.cmd.opening}\IndexCmd{opening}%
-\important{\DescRef{scrlttr2.cmd.opening}}.
-
-\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{scrlttr2.option.enlargefirstpage}%
-\important{\DescRef{scrlttr2.option.enlargefirstpage}} option (see
-\autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.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{scrlttr2.option.version} in
-\autoref{sec:scrlttr2.compatibilityOptions},
-\DescPageRef{scrlttr2.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:scrlttr2.lcoFile})
-except for \Option{KOMAold} and \Option{NF}. Thus the
-\DescRef{scrlttr2.option.enlargefirstpage}%
-\important{\DescRef{scrlttr2.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{scrlttr2.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:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.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
-
-
\section{Variables for Experienced Users}
\seclabel{variables}
\BeginIndexGroup
@@ -1195,9 +97,9 @@ line\Index{reference line}.
\begin{Declaration}
\Macro{newkomavar}\OParameter{description}\Parameter{name}%
\Macro{newkomavar*}\OParameter{description}\Parameter{name}%
+ \Macro{addtoreffields}\Parameter{name}
\Macro{removereffields}%
\Macro{defaultreffields}%
- \Macro{addtoreffields}\Parameter{name}
\end{Declaration}
\Macro{newkomavar} defines a new variable. This variable is referenced as
\PName{name}. Optionally, you can define a \PName{description} for the
@@ -1281,8 +183,8 @@ with
\begin{Declaration}
- \Macro{ifkomavarempty}\Parameter{name}\Parameter{true}\Parameter{false}%
- \Macro{ifkomavarempty*}\Parameter{name}\Parameter{true}\Parameter{false}
+ \Macro{Ifkomavarempty}\Parameter{name}\Parameter{true}\Parameter{false}%
+ \Macro{Ifkomavarempty*}\Parameter{name}\Parameter{true}\Parameter{false}
\end{Declaration}
It is important to know that the content of the variable will be expanded as
far as this is possible with \Macro{edef}. If this results in spaces or
@@ -1312,12 +214,12 @@ variable is added as parameter to the \PName{command}.%
The \Macro{foreachnonemptykomavar} command does the same but only for those
variables that are not empty in sense of
-\DescRef{\LabelBase.cmd.ifkomavarempty}. Empty variables in the \PName{list of
+\DescRef{\LabelBase.cmd.Ifkomavarempty}. Empty variables in the \PName{list of
variables} are ignored.
By contrast, the \Macro{foreachemptykomavar} command executes the
\PName{command} only for variables that are empty in sense of
-\DescRef{\LabelBase.cmd.ifkomavarempty}. Accordingly, non-empty variables are
+\DescRef{\LabelBase.cmd.Ifkomavarempty}. Accordingly, non-empty variables are
ignored.
The \Macro{foreachkomavarifempty} command is a kind of combination of the two
@@ -1618,6 +520,8 @@ limitations of \TeX.
\BeginIndexGroup
\BeginIndex{}{languages}%
+% TODO: New translation of the shorter into in German manual should be used.
+% :ODOT
The \Class{scrlttr2} class and the \Package{scrletter} package support many
languages. These include German\Index{language>German} (\PValue{german} for
the old German orthography, \PValue{ngerman} for the new orthography;
@@ -1652,7 +556,7 @@ There\textnote{Attention!} is one more point to note about language-switching
packages. The
\Package{french}\IndexPackage{french}\important{\Package{french}} package (see
\cite{package:french}) makes changes well beyond redefining the terms in
-\autoref{tab:scrlttr2-experts.languageTerms}. For instance, it redefines the
+\autoref{tab:\LabelBase.languageTerms}. For instance, it redefines the
\DescRef{scrlttr2.cmd.opening} command, since the package simply assumes that
\DescRef{scrlttr2.cmd.opening} is always defined as it is in the standard
\Class{letter} class. This, however, is not the case with \KOMAScript{}. The
@@ -1692,7 +596,7 @@ manner.%
\fi
\fi
-\iftrue
+\iffalse
It cannot be ruled out that similar problems will not occur with other
languages or packages. For German and English, however, there are currently
no known problems with the \Package{babel} package.
@@ -1729,7 +633,7 @@ described in
\Macro{begin}\PParameter{document}. Therefore they are not available in the
preamble and cannot be redefined there. The default settings for
\Option{english} and \Option{ngerman} are listed in
-\autoref{tab:scrlttr2-experts.languageTerms}.%
+\autoref{tab:\LabelBase.languageTerms}.%
\EndIndexGroup
%\iffree{}{\clearpage}% Siehe Kommentar zur Tabelle
@@ -1764,8 +668,8 @@ preamble and cannot be redefined there. The default settings for
\Macro{captionsUSenglish}
\end{Declaration}
If you change the language of a letter, the language-dependent terms listed in
-\autoref{tab:scrlttr2-experts.languageTerms},
-\autopageref{tab:scrlttr2-experts.languageTerms} are redefined using these
+\autoref{tab:\LabelBase.languageTerms},
+\autopageref{tab:\LabelBase.languageTerms} are redefined using these
commands. If your language-switching package does not support this, you can
also use the above commands directly.
%
@@ -1780,7 +684,7 @@ also use the above commands directly.
Defaults for language-dependent terms for the languages
\Option{english} and \Option{ngerman}, if they are not already defined
by the packages used for language switching%
- \label{tab:scrlttr2-experts.languageTerms}%
+ \label{tab:\LabelBase.languageTerms}%
}[l]
\begin{tabular}[t]{lll}
\toprule
@@ -1901,7 +805,7 @@ The exact format can be found in \autoref{tab:date}.%
\label{tab:date}
\end{table}
%
-\section{Obsolete Commands in \Class{scrlttr2}}
+\section{Obsolete Commands}
\seclabel{obsolete}
\BeginIndexGroup