summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex2157
1 files changed, 1060 insertions, 1097 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
index f27ff563f2c..2e0af8b703d 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2-experts.tex
-% Copyright (c) Markus Kohm, 2002-2017
+% Copyright (c) Markus Kohm, 2002-2018
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlttr2-experts.tex
-% Copyright (c) Markus Kohm, 2002-2017
+% Copyright (c) Markus Kohm, 2002-2018
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,39 +46,43 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2-experts.tex}
- [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
+ [$Date: 2018-03-21 10:37:34 +0100 (Wed, 21 Mar 2018) $
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}
+ Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm\and
+ Karl Hagen}
-% Date of the translated German file: 2017-01-02
+% Date of the translated German file: 2018-01-02
-\chapter{Additional Information about the Letter Class
- \Class{scrlttr2} and the Letter Package \Package{scrletter}}
+\chapter{Additional Information about the \Class{scrlttr2} Class and the
+ \Package{scrletter} Package}
\labelbase{scrlttr2-experts}
+
\BeginIndexGroup
\BeginIndex{Class}{scrlttr2}
-\BeginIndex{Package}{scrletter}
-
-This chapter gives additional information about the \KOMAScript{} class
-\Class{scrlttr2}. \iffree{Some parts of the chapter are subject to the
- \KOMAScript{} book \cite{book:komascript} only. This should not be a
- problem, because the}{The} average user, who only want to use the package,
-does not need the information. Other information is addressed to users, who
-want additional information about details. For example the first section will
-describe pseudo-lengths in detail. These may be used to modify the note paper.
-Another part of the information describes features of the class that exist
-only because of compatibility to deprecated \Class{scrlettr} class. Last but
-not least it will be described in detail how to change a document from the old
-\Class{scrlettr} class to be used with the current \Class{scrlttr2} class.
-
-Since \KOMAScript~3.15\ChangedAt[2014/11]{v3.15}{\Package{scrletter}} the
-additional package \Package{scrletter} exists. It can
-be used with one of the \KOMAScript{} classes \Class{scrartcl},
-\Class{scrreprt}, or \Class{scrbook} and provides all the features of
-\Class{scrlttr2} for those classes. There are, however, small differences
-described later in this section.%
+This chapter provides additional information about the \KOMAScript{} class
+\Class{scrlttr2}. \iffree{Some parts of the chapter are found only in the
+ German \KOMAScript{} book \cite{book:komascript}. This should not be a
+ problem, because the}{The} average user, who only wants to use the class
+or package, will not normally need this information. Part of this information
+is addressed to users for whom the default options are insufficient. Thus,
+for example, the first section describes in detail the pseudo-lengths that
+specify the letterhead page and which can be used be used to modify the its
+layout.%
+\iffalse% Es wird Zeit das komplett rauszuwerfen!
+ In addition, this chapter also describes features that exist only to
+ provide compatibility with the deprecated \Class{scrlettr} class. It also
+ explains in detail how to convert a document from this obsolete class
+ to the current class.
+\fi
+
+\BeginIndex{Package}{scrletter}%
+Starting with \KOMAScript~3.15\ChangedAt[2014/11]{v3.15}{\Package{scrletter}},
+you can use the \Package{scrletter} package with one of the \KOMAScript{}
+classes \Class{scrartcl}, \Class{scrreprt}, or \Class{scrbook}. It provides
+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}
@@ -86,269 +90,285 @@ described later in this section.%
\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
-addressed with \Macro{newlength}, skip registers are used. Once all these
-registers are in use, you can not define any more additional lengths. The
-letter class \Class{scrlttr2} would normally use up more than 20 of such
-registers for the first page alone. {\LaTeX} itself already uses 40 of these
-registers. The \Package{typearea} package needs some of them too; thus,
-approximately a quarter of the precious registers would already be in
-use. That is the reason why lengths specific to letters in \Class{scrlttr2}
-are internally defined with macros instead of lengths. The drawback of this
-approach is that computations with macros is somewhat more complicated than
-with real lengths.
-
-Please note\textnote{Attention!}: 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 without backslash at the very
-beginning similar to the names of \LaTeX{} counters and in opposite to macros
-or \LaTeX{} lengths.
-
-It can be pointed out that the now recommended {\LaTeX} installation with
-{\eTeX} no longer suffers from the above-mentioned limitation. However, that
-improvement came too late for \Class{scrlttr2}.
-
-The pseudo-lengths defined and uses by \Class{scrlttr2} are listed in
-\autoref{tab:scrlttr2-experts.pseudoLength}. Cross references to the detailed
-descriptions of each pseudo-lengths in the following sub-sections are also
-given in the table.
-
-A schematic display of the most important distances of the note paper is shown
-in \autoref{fig:scrlttr2-experts.pseudoLength} at
-\autopageref{fig:scrlttr2-experts.pseudoLength}. Beside the
-pseudo-lengths for the modifiable distances, also some lengths, which may not
-be modified, are shown in light gray. Some rarely needed pseudo-length of the
-note paper have been omitted to get a more clear arrangement.
+\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 \Class{scrlttr2}%
+ Pseudo-lengths provided by \Class{scrlttr2} and \Package{scrletter}%
\label{tab:scrlttr2-experts.pseudoLength}%
}{%
- Pseudo-lengths provided by class \Class{scrlttr2} (\emph{continued})%
+ Pseudo-lengths provided by \Class{scrlttr2} and \Package{scrletter}
+ (\emph{continued})%
}%
\pentry{backaddrheight}{%
- height of the return address at the upper edge of the address field %
+ 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}{%
- length of the bottommost folding mark %
+ the length of the bottommost fold mark
(\autoref{sec:scrlttr2-experts.foldmarks},
\DescPageRef{scrlttr2-experts.plength.bfoldmarkvpos})%
}%
\pentry{bfoldmarkvpos}{%
- vertical distance of bottommost folding mark from top paper edge %
- (\autoref{sec:scrlttr2-experts.foldmarks},
+ 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}{%
- horizontal distance of the letter footer from the left paper edge; values
- greater than the width of the paper or smaller than the negative value of
- the width of the paper will activate special handling %
+ 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}{%
- vertical distance of letter footer from top paper edge %
- (\autoref{sec:scrlttr2-experts.firstFoot},
+ 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}{%
- width of letter footer %
+ the width of the letterhead page footer
(\autoref{sec:scrlttr2-experts.firstFoot},
\DescPageRef{scrlttr2-experts.plength.firstfootwidth})%
}%
\pentry{firstheadhpos}{%
- horizontal distance of the letterhead from the left paper edge; values
- greater than the width of the paper or smaller than the negative value of
- the width of the paper will activate special handling %
+ 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}{%
- vertical distance of letterhead from top paper edge %
+ 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}{%
- width of the letterhead %
- (\autoref{sec:scrlttr2-experts.firstHead},
+ the width of the letterhead (\autoref{sec:scrlttr2-experts.firstHead},
\DescPageRef{scrlttr2-experts.plength.firstheadwidth})%
}%
\pentry{foldmarkhpos}{%
- horizontal distance of the horizontal folding marks from left paper edge %
- (\autoref{sec:scrlttr2-experts.foldmarks},
+ 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}{%
- vertical distance of the vertical folding marks from the top paper edge %
- (\autoref{sec:scrlttr2-experts.foldmarks},
+ 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}{%
- thickness of an optional horizontal rule in the letterhead %
+ the thickness of an optional horizontal rule in the letterhead
(\autoref{sec:scrlttr2-experts.firstHead},
\DescPageRef{scrlttr2-experts.plength.fromrulethickness})%
}%
\pentry{fromrulewidth}{%
- length of an optional horizontal rule in letterhead %
+ the length of an optional horizontal rule in the letterhead
(\autoref{sec:scrlttr2-experts.firstHead},
\DescPageRef{scrlttr2-experts.plength.fromrulewidth})%
}%
\pentry{lfoldmarkhpos}{%
- horizontal distance of the vertical folding mark from the left paper edge %
- (\autoref{sec:scrlttr2-experts.foldmarks},
+ 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}{%
- length of the vertical folding mark %
+ the length of the vertical fold mark
(\autoref{sec:scrlttr2-experts.foldmarks},
\DescPageRef{scrlttr2-experts.plength.lfoldmarklength})%
}%
\pentry{locheight}{%
- height of the field with the extended sender's information, of the value
- is not zero; \PLength{toaddrheight} will be used instead of zero value %
+ 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}{%
- horizontal distance of the field with the extended sender's information
- from the right paper edge, if the value is positive; negative horizontal
- distance from the left paper edge, if the value is negative; negative
- value of \PLength{toaddrhpos} will be used instead of zero value %
+ 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}{%
- vertical distance of the field with the extended sender's information from
- the top paper edge, if the value is not zero; \PLength{toaddrvpos} will be
- used instead of zero value %
+ 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}{%
- width of the field with the extended sender's information; for zero value
- width is calculated automatically with respect to option \DescRef{scrlttr2.option.locfield}
- that is described in \autoref{sec:scrlttr2.firstpage},
- \DescPageRef{scrlttr2.option.locfield} %
+ 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}{%
- length of the middle horizontal folding mark %
+ the length of the middle horizontal fold mark
(\autoref{sec:scrlttr2-experts.foldmarks},
\DescPageRef{scrlttr2-experts.plength.mfoldmarklength})%
}%
\pentry{mfoldmarkvpos}{%
- vertical distance of the middle horizontal folding mark from the top paper
- edge %
- (\autoref{sec:scrlttr2-experts.foldmarks},
+ 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}{%
- length of the puncher hole mark %
+ 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 fields or business line %
+ vertical skip below reference-field line %
(\autoref{sec:scrlttr2-experts.refLine},
\DescPageRef{scrlttr2-experts.plength.refaftervskip})%
}%
\pentry{refhpos}{%
- horizontal distance of reference fields or business line from left paper
- edge; for zero value reference fields line is centered horizontally on
- letter paper %
+ 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}{%
- vertical distance of reference fields or business line from top paper
- edge %
- (\autoref{sec:scrlttr2-experts.refLine},
+ 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}{%
- width of reference fields line %
+ the width of the reference-field line
(\autoref{sec:scrlttr2-experts.refLine},
\DescPageRef{scrlttr2-experts.plength.refwidth})%
}%
\pentry{sigbeforevskip}{%
- vertical skip between closing and signature %
+ the vertical skip between the closing and the signature
(\autoref{sec:scrlttr2-experts.closing},
\DescPageRef{scrlttr2-experts.plength.sigbeforevskip})%
}%
\pentry{sigindent}{%
- indentation of signature with respect to text body %
+ the indentation of the signature with respect to the text body
(\autoref{sec:scrlttr2-experts.closing},
\DescPageRef{scrlttr2-experts.plength.sigindent})%
}%
\pentry{specialmailindent}{%
- left indentation of mode of dispatch within address field %
+ the left indentation of the delivery method within the address field
(\autoref{sec:scrlttr2-experts.addressee},
\DescPageRef{scrlttr2-experts.plength.specialmailindent})%
}%
\pentry{specialmailrightindent}{%
- right indentation of mode of dispatch within address field %
+ the right indentation of the delivery method within the address field
(\autoref{sec:scrlttr2-experts.addressee},
\DescPageRef{scrlttr2-experts.plength.specialmailrightindent})%
}%
\pentry{subjectaftervskip}{%
- vertical distance after the subject %
+ the vertical skip after the subject
(\autoref{sec:scrlttr2-experts.subject},
\DescPageRef{scrlttr2-experts.plength.subjectaftervskip})%
}%
\pentry{subjectbeforevskip}{%
- additional vertical distance before the subject %
+ additional vertical skip before the subject
(\autoref{sec:scrlttr2-experts.subject},
\DescPageRef{scrlttr2-experts.plength.subjectbeforevskip})%
}%
\pentry{subjectvpos}{%
- vertical distance of the subject from the top paper edge; zero value will
- set the subject depending on option \DescRef{scrlttr2.option.subject} %
+ 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}{%
- length of the topmost horizontal folding mark %
+ the length of the topmost horizontal fold mark
(\autoref{sec:scrlttr2-experts.foldmarks},
\DescPageRef{scrlttr2-experts.plength.tfoldmarklength})%
}%
\pentry{tfoldmarkvpos}{%
- vertical distance of the topmost horizontal folding mark from the top
- paper edge %
- (\autoref{sec:scrlttr2-experts.foldmarks},
+ 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}{%
- height of address field %
- (\autoref{sec:scrlttr2-experts.addressee},
+ the height of the address field (\autoref{sec:scrlttr2-experts.addressee},
\DescPageRef{scrlttr2-experts.plength.toaddrheight})%
}%
\pentry{toaddrhpos}{%
- horizontal distance of the address field from left paper edge, for
- positive values; negative horizontal distance of the address field from
- right paper edge, for negative values %
+ 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}{%
- left and right indentation of address within address field %
+ the left and right indentation of the address within the address field
(\autoref{sec:scrlttr2-experts.addressee},
\DescPageRef{scrlttr2-experts.plength.toaddrindent})%
}%
\pentry{toaddrvpos}{%
- vertical distance of the address field from the top paper edge %
- (\autoref{sec:scrlttr2-experts.addressee},
+ 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}{%
- width of address field %
+ the width of the address field %
(\autoref{sec:scrlttr2-experts.addressee},
\DescPageRef{scrlttr2-experts.plength.toaddrwidth})%
}%
@@ -365,22 +385,26 @@ note paper have been omitted to get a more clear arrangement.
\begin{Declaration}
\Macro{@newplength}\Parameter{name}
\end{Declaration}
-This command defines an new pseudo-length. This new pseudo-length is
-uniquely identified by its \PName{name}. If with this command a
-redefinition of an already existing pseudo-length is attempted, the
+This 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.
-Since the user in general does not define own pseudo-lengths, this command is
-not intended as a user command. Thus, it can not be used within a document,
-but it can, for example, be used within an
-\File{lco}-file\Index{lco-file=\File{lco}-file}.\iffree{}{ Nevertheless, if
- someone likes to define a pseudo-length inside the document, i.\,e. the
- document preamble, then one may avoid that constriction using
+Since the ordinary user does not normally need to define pseudo-lengths, this
+command is not a user instruction. It cannot be used within a document, but it
+can, for example, be used within an \File{lco}
+file\Index{lco file=\File{lco} file}.
+%
+\iftrue % Umbruchoptimierung!!!
+\iffree{}{ If you want to
+ define a pseudo-length inside the document anyway, you can override the
+ restriction with the help of
\Macro{makeatletter}\important[i]{\Macro{makeatletter}\\
\Macro{makeatother}}\IndexCmd{makeatletter} and
\Macro{makeatother}\IndexCmd{makeatother} (see
- \cite{UK:FAQ}). But\textnote{Attention!} inside an \File{lco}-file these two
- commands should never be used!}%
+ \cite{UK:FAQ}). But\textnote{Attention!} you should never use these two
+ commands inside an \File{lco} file!}%
+\fi
%
\EndIndexGroup
@@ -391,90 +415,91 @@ but it can, for example, be used within an
\Macro{@addtoplength}%
\OParameter{factor}\Parameter{pseudo-length}\Parameter{value}
\end{Declaration}
-Using the command \Macro{@setplength} you can assign the multiple of a
+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}).
-The command \Macro{@addtoplength} adds the \PName{value} to a
-\PName{pseudo-length}. Again a \PName{factor} may be given as an optional
+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, the command \Macro{useplength} (siehe
-\autoref{sec:scrlttr2.pseudoLength},
-\DescPageRef{scrlttr2.cmd.useplength}) is used within \PName{value}. To
-subtract the value of one pseudo-length from another \PName{pseudo-length} a
-minus sign, or \PValue{-1}, is used as the \PName{factor}.
-
-Since the user in general does not define own pseudo-lengths, this command is
-not intended as a user command. Thus, it can not be used within a document,
-but can, for example, be used within an \File{lco}-file.\iffree{}{
- Nevertheless, if someone likes to change the value of a pseudo-length inside
- the document, i.\,e. the document preamble, then one may avoid that
- constriction using
+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}.
+
+Since the ordinary user does not normally need to define pseudo-lengths, this
+command is not a user instruction. It cannot be used within a document, but it
+can, for example, be used within an \File{lco}
+file\Index{lco file=\File{lco} file}.\iffree{}{ If you want to
+ define a pseudo-length inside the document anyway, you can override the
+ restriction with the help of
\Macro{makeatletter}\important[i]{\Macro{makeatletter}\\
\Macro{makeatother}}\IndexCmd{makeatletter} and
\Macro{makeatother}\IndexCmd{makeatother} (see
- \cite{UK:FAQ}). But\textnote{Attention!} inside an \File{lco}-file these two
- commands should never be used!}%
+ \cite{UK:FAQ}). But\textnote{Attention!} you should never use these two
+ commands inside an \File{lco} file!}%
%
\EndIndexGroup
-\subsection{Folding Marks}
+\subsection{Fold Marks}
\seclabel{foldmarks}
\BeginIndexGroup
-\index{marks>folding|see{folding marks}}
-\BeginIndex{}{folding marks}%
+\BeginIndex{}{fold marks}%
+\index{marks>folding|see{fold marks}}
-Folding mark are short horizontal lines at the left edge, and short vertical
-lines at the upper edge of the paper. \KOMAScript{} at present supports three
-configurable horizontal and one configurable vertical foldmarks. In addition,
-there is support for a puncher hole mark or center mark which cannot be
-shifted in the vertical direction.
+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}
-The letter class \Class{scrlttr2} knows a total of three vertically placed
-configurable foldmarks. The position of the topmost foldmark, taken from the
-upper edge of the paper, is governed by the pseudo-length
-\PLength{tfoldmarkvpos}; the position of the middle foldmark by pseudo-length
-\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}; the position of
-the bottommost foldmark by pseudo-length \PLength{bfoldmarkvpos}. With the
-addition of the puncher hole\Index{puncher hole mark} or center\Index{center
- mark|see{punch hole mark}} mark, there is still a fourth horizontal
-mark. This one is however always placed at the vertical center of the paper.
-\iffalse% Umbruchkorrekturtext
-There's no pseudo-length for this last mark, because it vertical position is
-not configurable. \fi
-
-The\textnote{Attention!} topmost and bottommost foldmarks do not serve to
-divide the paper into exactly equal thirds. Instead, with their help, the
-paper should be folded such that the address field appears correctly in the
-space available in the chosen window envelope format, which is determined by
-choice of \File{lco}-file. Several such files are available offering
-predefined formats. An anomaly is present with \Option{DINmtext}: for this
-format, an envelope format of C6/5 (also known as ``C6 long'') is
-assumed. Letters written with this option are not suited to envelopes of
-formats C5 or C4.
-
-The middle foldmark is not normally required for Western letters. In Japan,
-however, a larger number of envelope formats exists, requiring one more
-foldmark (see the Japanese \File{lco}-files). At this point attention is drawn
-to the fact that reference to ``topmost'', ``middle'', and ``bottommost''
-foldmarks is simply a convenience. In fact, it is not defined that
-\PLength{tfoldmarkvpos} must be smaller than \PLength{mfoldmarkvpos}, which in
-turn must be smaller than \PLength{bfoldmarkvpos}. If on the other hand one of
-the pseudo-lengths is set to null, then the corresponding foldmark will not be
-set even if the option
-\DescRef{scrlttr2.option.foldmarks}\IndexOption{foldmarks~=\PName{Einstellung}}%
-\important{\DescRef{scrlttr2.option.foldmarks}} (see \autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.foldmarks}) is explicity activated.
+\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
@@ -486,26 +511,26 @@ set even if the option
\PLength{pfoldmarklength}
\end{Declaration}
These\ChangedAt{v2.97e}{\Class{scrlttr2}} four pseudo-lengths determine the
-lengths of the four horizontal foldmarks. One\textnote{Attention!}
-exceptional behaviour exists. If the length is given as null, then the three
-vertically-configurable pseudo-lengths \PLength{tfoldmarklength},
-\PLength{mfoldmarklength} and \PLength{bfoldmarklength} are set to 2\Unit{mm}
-in length. The length of the punchmark, \PLength{pfoldmarklength}, is instead
-set to 4\Unit{mm}.%
+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 foldmarks from the
-left edge of the paper. Normally, this is 3.5\Unit{mm}. This\textnote{Hint!}
-value can be changed in the user's own \File{lco}-file, in case the user's
-printer has a wider unprintable left margin. Whether the foldmarks are typeset
-at all depends on the option \DescRef{scrlttr2.option.foldmarks}\important{\DescRef{scrlttr2.option.foldmarks}}%
-\IndexOption{foldmarks~=\PName{Einstellung}} (see
-\autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.foldmarks}).
+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
@@ -513,39 +538,38 @@ at all depends on the option \DescRef{scrlttr2.option.foldmarks}\important{\Desc
\begin{Declaration}
\PLength{lfoldmarkhpos}
\end{Declaration}
-Apart from\ChangedAt{v2.97e}{\Class{scrlttr2}} the horizontal foldmarks there
-is also a vertical foldmark, whose position from the left margin is set via
-the pseudo-length \PLength{lfoldmarkhpos}. This foldmark is used, for example,
-in Japanese Chou- or You-format envelopes, when one wishes to use A4 size
-sheets with them. This can also be useful for envelopes in C6 format.%
+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}} length of the vertical foldmark is set
-via the pseudo-length \PLength{lfoldmarklength}. Here too there is an
-exceptional behaviour. When the length is set to null, a length of 4\Unit{mm}
-is actually used.%
+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 gives the distance of
-all vertical foldmarks from the upper edge of the paper. Normally this is
-3.5\Unit{mm}, but\textnote{Hint!} the value can be changed in the user's
-personal \File{lco}-file in case the user's printer has a wider unprintable
-top margin. Whether the foldmarks are typeset at all depends on the option
+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{Einstellung}} (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.foldmarks}). At
-present there is only one vertical foldmark, which is designated the left
-vertical foldmark.
-%
+\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
@@ -553,9 +577,9 @@ vertical foldmark.
\PLength{foldmarkthickness}
\end{Declaration}
This\ChangedAt{v2.97c}{\Class{scrlttr2}} pseudo-length determines the
-thickness of all foldmarks. Default value is 0.2\Unit{pt}, in other words a
-very thin hairline. In particular, if the color of the foldmarks is
-changed, this can be too thin!%
+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
@@ -564,68 +588,67 @@ changed, this can be too thin!%
\subsection{Letterhead}
\seclabel{firstHead}
\BeginIndexGroup
-\BeginIndex{}{letterhead}
-
-The term letterhead here refers to all of the data pertaining to the sender
-and which is set above the addressee's address. It is usually expected that
-this information is set via the page style settings. In fact, this was the
-case in the earlier incarnation of the letter class,
-\Class{scrlettr}. But\textnote{Attention!} with \Class{scrlttr2}, the
-letterhead is made independent of the page style setting, and is set by the
-command \DescRef{scrlttr2.cmd.opening}\IndexCmd{opening}.
+\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 position of the letterhead is absolute and 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 \PValue{empty}.%
+ 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 pseudo-length \PLength{firstheadvpos} gives the distance between the top
-edge of the paper and 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
+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 pseudo-length
-\PLength{firstheadhpos}\ChangedAt{v3.05}{\Class{scrlttr2}} gives the distance
-between the left edge of the paper and the start of the
-letterhead. If\textnote{Attention!} is actually greater than or equal to the
-paper width,
+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},
-then the letterhead will be centered to the note paper width. A negative value
-gives the distance between the distance between the right paper edge and the
-end of the letterhead. If the value is even less or equal to the negative
-value of the width of the paper, then the letterhead will be left aligned to
-the left edge of the typing area.
-
-Typical default\textnote{Attention!} is a value of
-\Length{maxdimen}\IndexLength{maxdimen}, though the greatest allowed value of
-a length. This will result in horizontal centering.%
-%
+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 pseudo-length \PLength{firstheadwidth} 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 adressee address field, it was the type
-area width in \Option{KOMAold} and has a definite value of 170\Unit{mm} in
+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
@@ -633,20 +656,19 @@ area width in \Option{KOMAold} and has a definite value of 170\Unit{mm} in
\PLength{fromrulethickness}%
\PLength{fromrulewidth}
\end{Declaration}
-Depending on the class option \Option{fromrule} (see
-\autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.fromrule}), a horizontal rule can be drawn
-the predefined letterheads under or within the sender
-address. If\textnote{Attention!} the pseudo-length \PLength{fromrulewidth} has
-a value of 0\Unit{pt}, which is the default in the predefined \File{lco}
-files, the rule length is calculated automatically taking into account,
-e.\,g., letterhead width or an optional logo. Users can adjust rule length
-manually in their own \File{lco}-files by setting this pseudo-length to
-positive values using \Macro{\@setplength} (see
-\DescPageRef{scrlttr2-experts.cmd.@setplength}). The default thickness of
-the line\ChangedAt{v2.97c}{\Class{scrlttr2}}, \PLength{fromrulethickness}, is
-0.4\Unit{pt}.%
-%
+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
@@ -656,63 +678,62 @@ the line\ChangedAt{v2.97c}{\Class{scrlttr2}}, \PLength{fromrulethickness}, is
\seclabel{addressee}%
\BeginIndexGroup
\BeginIndex{}{addressee}
-\index{address|seealso{addressee}}
+\index{recipient|seealso{addressee}}
-The term addressee here refers to the addressee's name and address which
-are output in an address field. Additional information can be output
-within this address field, such as dispatch type or a return address;
-the latter is especially useful when using window envelopes. The
-address directly follows the letterhead.
+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 vertical and horizontal position of the address
-field relative to 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. A special feature of
-\PLength{toaddrhpos} is that with negative values the offset is that of the
-right edge of the address field relative to the right edge of the paper. This
-can be found, for instance, in the case of \Option{SN} or \Option{NF}. The
-smallest value of \PLength{toaddrvpos} is found with \Option{DINmtext}. Care
-must be taken to avoid overlap of letterhead and address field. Whether the
-address field is output or not can be controlled by class option
-\Option{addrfield} (see \autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.addrfield}).%
-%
+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}
-The pseudo-length \PLength{toaddrheight} defines the height of the
-address field, including the dispatch type. If no dispatch type is
-specified, then the address is vertically centered in the field. If a
-dispatch type is specified, then the address is set below the dispatch
-type, and vertically centered in the remaining field height.
-%
+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. Values are set
-differently in the various predefined
-\File{lco}-files\textnote{\File{lco}-files}\Index{lco-file=\File{lco}-files},
-according to standard envelope window measures. Typical values are between
-70\Unit{mm} and 100\Unit{mm}.
+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}
- Assume that your printer has a very wide left or right margin of
- 15\Unit{mm}. In this case, when using the option \Option{SN}, the
- letterhead, sender's extensions and the address can not be completely
- printed. Thus, you create a new \File{lco}-file with the following content:
+ 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 own lco]
+ [2002/06/04 v0.1 my lco]
\LoadLetterOption{SN}
\@addtoplength{toaddrwidth}{%
-\useplength{toaddrhpos}}
@@ -722,8 +743,8 @@ according to standard envelope window measures. Typical values are between
\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}
+ simply use the option \Option{SNmmarg} instead of \Option{SN}.%
+\end{Example}%
%
\EndIndexGroup
@@ -731,53 +752,48 @@ according to standard envelope window measures. Typical values are between
\begin{Declaration}
\PLength{toaddrindent}
\end{Declaration}
-Additional indentation of the address within address field can be controlled
-by the pseudo-length \PLength{toaddrindent}. Its value applies to both left
-and right margin. Default value is 0\Unit{pt}.
+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}.
-With\textnote{Attention!} each of the
-settings\ChangedAt{v3.03}{\Class{scrlttr2}}
-\OptionValueRef{scrlttr2}{addrfield}{PP}\important[i]{%
+For\textnote{Attention!} the\ChangedAt{v3.03}{\Class{scrlttr2}}
+\OptionValueRef{scrlttr2}{addrfield}{PP}\important{%
\OptionValueRef{scrlttr2}{addrfield}{PP}\\
\OptionValueRef{scrlttr2}{addrfield}{image}\\
- \begin{tabular}{@{}l@{}}
- \KOption{addrfield}\\
- \quad\PValue{backgroundimage}
- \end{tabular}}\IndexOption{addrfield~=\PValue{PP}},
-\OptionValueRef{scrlttr2}{addrfield}{image}\IndexOption{addrfield~=\PValue{image}}, and
+ \OptionValueRef{scrlttr2}{addrfield}{backgroundimage}
+}\IndexOption{addrfield~=\textKValue{PP}},
+\OptionValueRef{scrlttr2}{addrfield}{image}%
+\IndexOption{addrfield~=\textKValue{image}}, and
\OptionValueRef{scrlttr2}{addrfield}{backgroundimage}%
-\IndexOption{addrfield~=\PValue{backgroundimage}} (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 really no indent should be used in this
-case, then 1\Unit{sp} may be used to set a negligible small
-indent. Additionally \PLength{toaddrindent} will be used also for the distance
-to the right edge of the address window with the mentioned \Option{addrfield}
-settings.%
-%
+\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 with small font at one line
-above the addressee. This kind of sender's information is known as return
+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
-at the address window and will be used by the post officers to return the
-letter (back) to the sender. In this return address only that information
-should be that is needed for this purpose.
-
-The height, that is reserved for the return address at the top of the address
-field, is given by pseudo-length \PLength{backaddrheight}. A typical value for
-this is 5\Unit{mm} in the predefined
-\File{lco}-files\textnote{\File{lco}-file}\Index{}{lco-file=\File{lco}-file}.
-Whether or not to print the return address depend on option \Option{addrfield}
-(see \autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.addrfield}) and
-\DescRef{scrlttr2.option.backaddress} (see \autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.backaddress}).%
-%
+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
@@ -785,17 +801,16 @@ Whether or not to print the return address depend on option \Option{addrfield}
\PLength{specialmailindent}%
\PLength{specialmailrightindent}
\end{Declaration}
-An optional dispatch type can be output within the address field between the
-return address and the addressee address, by setting the variable
-\DescRef{scrlttr2.variable.specialmail}. Left and right alignment are determined by
-pseudo-lengths \PLength{specialmailindent} and
-\PLength{specialmailrightindent}, respectively. In the predefined
-\File{lco}-files\textnote{\File{lco}-file}\Index{lco-file=\File{lco}-file}
-provided by \KOMAScript, \PLength{specialmailindent} is set to rubber length
-\Macro{fill}, while \PLength{specialmailrightindent} is set to
-1\Unit{em}. Thus the dispatch type is set 1\Unit{em} from the address field's
-right margin.
-%
+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
@@ -803,27 +818,26 @@ right margin.
\PLength{PPheadheight}%
\PLength{PPheadwidth}
\end{Declaration}
-The pseudo-length \PLength{PPheadheight}\ChangedAt{v3.03}{\Class{scrlttr2}} is
-the height, that will be reserved for the Port-Pay\'e head using the options
-\OptionValueRef{scrlttr2}{addrfield}{PP}\important[i]{%
+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}\\
- \begin{tabular}{@{}l@{}}
- \KOption{addrfield}\\
- \quad\PValue{backgroundimage}
- \end{tabular}}\IndexOption{addrfield~=\PValue{PP}} and
+ \OptionValueRef{scrlttr2}{addrfield}{backgroundimage}}%
+\IndexOption{addrfield~=\textKValue{PP}} and
\OptionValueRef{scrlttr2}{addrfield}{backgroundimage}%
-\IndexOption{addrfield~=\PValue{backgroundimage}}. Pseudo-length
-\PLength{PPheadwidth} will be used only with \OptionValueRef{scrlttr2}{addrfield}{PP} (see
-\autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.addrfield}) and gives the width of the left
-field in the Port-Pay\'e head that contains P.\,P. logo, zip-code and
-place. The width of the right field with the sender's code and the priority is
-the remaining width.
-
-Class\textnote{Attention!} \Class{scrlttr2} automatically changes
-pseudo-length \PLength{PPheadheight}'s\textnote{Attention} usual default value
-from 0\Unit{mm} into 20,74\Unit{pt} and \PLength{PPheadwidth}'s default from
-0\Unit{mm} into 42\Unit{mm}.%
+\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
@@ -831,32 +845,31 @@ from 0\Unit{mm} into 20,74\Unit{pt} and \PLength{PPheadwidth}'s default from
\begin{Declaration}
\PLength{PPdatamatrixvskip}
\end{Declaration}
-This\ChangedAt{v3.03}{\Class{scrlttr2}} pseudo-length gives the vertical
-distance between the Port-Pay\'e head and the data array or data matrix of
-option \OptionValueRef{scrlttr2}{addrfield}{PP}%
+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}). Class\textnote{Attention!}
-\Class{scrlttr2} automatically changes the default value 0\Unit{mm} into
-9\Unit{mm}. The data matrix will be set right aligned with the Port-Pay\'e
-head.%
-%
+\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{Sender's Extensions}
+\subsection{Extra Sender Information}
\seclabel{locationField}
\BeginIndexGroup
-\BeginIndex{}{sender's extension}
-\index{sender>extension|see{sender's extension}}
+\BeginIndex{}{extra sender information}
+\index{sender>extra information|see{extra sender information}}
-Often, especially with business letters, the space for the letterhead or page
-footer seems to be too tight to include all you want. To give more details
-about the sender, often the space right beside the addressee's field is
-used. In this manual this field is called the \emph{sender's extension}. In
-former manuals is has been called \emph{location field}.
+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}%
@@ -864,60 +877,52 @@ former manuals is has been called \emph{location field}.
\PLength{locvpos}%
\PLength{locwidth}
\end{Declaration}
-The pseudo-lengths \PLength{locwidth} and
-\PLength{locheight}\ChangedAt{v2.97d}{\Class{scrlttr2}} set the width and
-height of the sender's extension field. The pseudo-lengths \PLength{lochpos}
-and \PLength{locvpos} determine the distances from the right and upper paper
-edges. These value is typically set to 0\Unit{pt} in the predefined \File{lco}
-files. This\textnote{Attention!} does not mean that the sender's extension has
-no width; instead, it means that the actual width is set within
-\DescRef{scrlttr2.cmd.opening} when the paper width, address window width, and
-the distance between the left and upper edges of the paper and the address
-window are known. The option \DescRef{scrlttr2.option.locfield} (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.locfield}) is
-also taken into account. As is the case for \PLength{toaddrhpos}, negative
-values of \PLength{lochpos} take on a special meaning. In that case, instead
-of referring to a distance from the right edge of the paper, \PLength{lochpos}
-now means a distance from the left edge of the paper. The meaning is thus the
-opposite to that of \PLength{toaddrhpos} (see
-\autoref{sec:scrlttr2-experts.addressee},
+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{Business Line}
+\subsection{Reference Line}
\seclabel{refLine}%
\BeginIndexGroup
-\BeginIndex{}{business line}
-\index{reference>field line|see{business line}}
-\index{reference>line|see{business line}}
-
-Especially with business letters, a line can be found that gives initials,
-dial code, customer number, invoice number, or a reference to a previous
-letter. This line is sometimes called \emph{reference fields line} or
-\emph{reference line}, sometimes \emph{business line}. The business line can
-consist of more than just one line and is set only if one of those variables
-mentioned above is given. Only those fields will be set that are
-given. To\textnote{Hint!} set a seemingly empty field, one needs to give as
-value at least a forced white space or \Macro{null}. If you want to have your
-letter without a business line, then instead of it the label and contents of
-the variable \DescRef{scrlttr2.variable.date} will be set. Information about adding variables
-to the business line or clean up the business line may be found in
-\autoref{sec:scrlttr2-experts.variables},
+\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 gives the distance between the upper edge of the paper and
-the reference fields 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}.
-%
+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
@@ -925,52 +930,49 @@ Typical values are between 80.5\Unit{mm} and 98.5\Unit{mm}.
\PLength{refwidth}%
\PLength{refhpos}
\end{Declaration}
-This pseudo-length gives the width that is available for the reference fields
-line. The value is set typically 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
-determine that there is no available width for the business line; instead,
-this value means that the width will be calculated within the command
-\DescRef{scrlttr2.cmd.opening}\IndexCmd{opening}. Thus the calculated width depends on the
-determination of the options \DescRef{scrlttr2.option.refline}\important{\DescRef{scrlttr2.option.refline}}%
-\IndexOption{refline~=\PName{Einstellung}} (see
-\autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.refline}). At the same time,
-\PLength{refhpos} will be set according to this option. With
-\OptionValueRef{scrlttr2}{refline}{wide}\IndexOption{refline~=\PValue{wide}}, the reference
-fields line is centered, while with
-\OptionValueRef{scrlttr2}{refline}{narrow}\IndexOption{refline~=\PValue{narrow}} it is
-aligned on the left inside the typing area.
-
-If \PLength{refwidth} is not null, i.\,e., the width of the reference fields
-line is therefore not determined by the option \DescRef{scrlttr2.option.refline}, then
-\PLength{refhpos} gives the distance of the reference fields line from the
-left edge of the paper. If\textnote{Attention!} this distance is null, then
-the reference fields line is set so that the ratio between its distances from
-the left and right edges of the paper equal the ratio of distance of the type
+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 centered on the paper, the reference fields line too will be
-centered.
-
-As a rule, these special cases are likely to be of little interest to the
-normal user. The\textnote{Attention!} simplest rule is as follows: either
-\PLength{refhpos} is left at null and so the width and alignment of the
-reference fields line are left to the option
-\DescRef{scrlttr2.option.refline}, or \PLength{refwidth} as well as
-\PLength{refhpos} are set by the user.%
-%
+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 gives the vertical space that has to be inserted beneath
-the reference fields 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 text height of the first page. A typical value lies
+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
@@ -981,26 +983,26 @@ between one and two lines.%
\BeginIndexGroup
\BeginIndex{}{subject}
-In different countries the letter's subject will be set different. Some like
-to have the subject before the opening phrase, some prefer the subject below
-the opening phrase. Some professional guilds at least want the subject before
-the business line.
+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
-position of the subject is given by option
\DescRef{scrlttr2.option.subject}\important{\DescRef{scrlttr2.option.subject}}%
-\IndexOption{subject~=\PName{Einstellung}} (see
-\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.subject}).
-Every other value defines the distance between the top edge of the paper and
-the subject. It\textnote{Hint!} is recommended to take care of the available
-space to surely avoid interferences with other elements.
+\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}
- Some professional guilds prefer to have the subject at least before the
- business line. To achieve this, the position may be defined like this:
+ 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]
@@ -1008,9 +1010,8 @@ space to surely avoid interferences with other elements.
\@addtoplength{refvpos}{3\baselineskip}
\endinput
\end{lstcode}
- which also changes the position of the business line itself. If at least one
- empty line between subject and business line should stay empty, this
- provides a maximum of two subject lines.
+ 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
@@ -1020,13 +1021,12 @@ space to surely avoid interferences with other elements.
\PLength{subjectaftervskip}
\end{Declaration}
\ChangedAt{v3.01}{\Class{scrlttr2}}%
-If the subject is not positioned absolutely, but before or after the opening
-phrase, additional vertical spaces may be inserted before and after the
-subject. Thereby, the space before the subject may interfere with other
-distances like the automatic distance of one line after the title. Because of
-this the default is to use no additional space here. In contrast, the class's
-default for the space after the subject is two lines.%
-%
+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
@@ -1037,87 +1037,92 @@ default for the space after the subject is two lines.%
\BeginIndexGroup
\BeginIndex{}{closing}
-The closing consists of three parts: besides the closing phrase there
-are a hand-written inscription and the signature, which acts as an
-explanation for the inscription.
+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}
-Closing phrase\Index{closing>phrase}\Index{signature} and signature will be
-typeset in a box. The width of the box is determined by the length of the
-longest line of the closing phrase or signature.
-
-The box will be typeset with indentation of the length set in pseudo-length
-\PLength{sigindent}. 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 closing phrase and signature a vertical space is inserted, the height
-of which is defined in the pseudo-length \PLength{sigbeforevskip}. In the
-predefined
-\File{lco}-files\textnote{\File{lco}-file}\Index{lco-file=\File{lco}-file}
-this is set to two lines. In this space you can then write your inscription.%
+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{Letter Footer}
+\subsection{Letterhead Page Footer}
\seclabel{firstFoot}%
\BeginIndexGroup
-\BeginIndex{}{letter>footer}%
-\index{note paper>footer|see{letter footer}}%|
+\BeginIndex{}{letterhead page>footer}%
-
-As the first page of a letter, the note paper, holds a letterhead of its own,
-it also holds a footer\Index{footer>of note paper}\Index{footer>of letter} of
-its own. And, as with the letterhead, it will not be set by the page style
-settings, but directly with the use of
-\DescRef{scrlttr2.cmd.opening}\IndexCmd{opening}\important{\DescRef{scrlttr2.cmd.opening}}.
+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 between the letter footer and the upper
-edge of the paper. It also takes care of preventing text from jutting into the
-footer area. For this the text height on the first page will be decreased
-using \Macro{enlargethispage}\IndexCmd{enlargethispage}%
-\important{\Macro{enlargethispage}} if needed. Likewise, and if it is wanted,
-the text height can conversely be extended with the help of the option
-\DescRef{scrlttr2.option.enlargefirstpage}\important{\DescRef{scrlttr2.option.enlargefirstpage}} (see
+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}). This way, the distance
-between text area and the first letter footer can be reduced to the value
-\Length{footskip}\IndexLength{footskip}\important{\Length{footskip}}.
+\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}} up to version
+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}. The option \DescRef{scrlttr2.option.enlargefirstpage}%
-\important{\DescRef{scrlttr2.option.enlargefirstpage}} also loses its
-effect. From version 2.9u\IndexOption{version~=\PValue{2.9u}} onwards the
-footer is set in a position at the bottom edge of the paper. In this
-situation, the height of the type area also becomes dependent on
-\DescRef{scrlttr2.option.enlargefirstpage}.
-
-If the letter footer be switched off using option
+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}}
-(see \autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.firstfoot}), then the setting of
+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. Thus, there remains
-a mimimum bottom margin of length \Length{footskip}\IndexLength{footskip}.%
-%
+\Length{paperheight}\IndexLength{paperheight} is applied. There remains then a
+minimum bottom margin of length \Length{footskip}\IndexLength{footskip}.%
\EndIndexGroup
@@ -1125,28 +1130,28 @@ a mimimum bottom margin of length \Length{footskip}\IndexLength{footskip}.%
\PLength{firstfoothpos}
\end{Declaration}
\ChangedAt{v3.05}{\Class{scrlttr2}}%
-A\textnote{Attention!} positive value of pseudo-length \PLength{firstfoothpos}
-gives the distance between the letter footer and the left edge of the
-paper. If the value is even greater than or equal to the paper width,
-\Length{paperwidth}\IndexLength{paperwidth}, then the footer will be centered
-horizontally to the note paper. But if the value is less than or equal to the
-negative width of the paper, then the footer will be aligned left to the
-typing area.
-
-Typical default for this value is \Length{maxdimen}\IndexLength{maxdimen},
-that is the maximum allowed value of a length. This results in horizontal
-centering.%
+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 gives the width of the letter's first page footer. The
-value is set equal to that of the pseudo-length
+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} in the predefined
-\File{lco}-files\textnote{\File{lco}-file}\Index{lco-file=\File{lco}-file}.%
+\IndexPLength{firstheadwidth}.%
%
\EndIndexGroup
%
@@ -1160,9 +1165,9 @@ value is set equal to that of the pseudo-length
\BeginIndexGroup
\BeginIndex{}{variables}
-\KOMAScript{} provides beside the feature of using predefined variable also
-commands to define new variable or to manipulate the automatic usage of
-variables in the business line\Index{business line}.
+\KOMAScript{} provides commands not only to use predefined variables but also
+to define new variables or to change their automatic use within the reference
+line\Index{reference line}.
\begin{Declaration}
\Macro{newkomavar}\OParameter{description}\Parameter{name}%
@@ -1171,56 +1176,56 @@ variables in the business line\Index{business line}.
\Macro{defaultreffields}%
\Macro{addtoreffields}\Parameter{name}
\end{Declaration}
-With \Macro{newkomavar} a new variable is defined. This variable is
-addressed via \PName{name}. As an option you can define a
-\PName{description} for the variable \PName{name}. In opposite to \PName{name}
-the \PName{description} is not used to reference a variable. In fact the
-\PName{description} defines an addition to the content of a variable, that may
-be output similar to the variable content.
-
-Using the command \Macro{addtoreffields} you can add the variable \PName{name}
-to the reference fields line\Index{business line} (see
-\autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.refline}). The \PName{description} and the
-content of the variable are added at the end of the reference fields line. The
-starred version \Macro{newkomavar*} is similar to the unstarred version, with
-a subsequent call of the command \Macro{addtoreffields}. Thus, the starred
-version automatically adds the variable to the reference fields line.
+\Macro{newkomavar} defines a new variable. This variable is referenced as
+\PName{name}. Optionally, you can define a \PName{description} for the
+\PName{name} variable. Unlike the \PName{name}, the \PName{description} is not
+used to reference a variable. Instead, the \PName{description} acts as a
+supplement to the content of a variable that can be printed as a label along
+with its content.
+
+You can use the \Macro{addtoreffields} command to add the \PName{name}
+variable to the reference line\Index{reference line} (see
+\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.refline}). The
+\PName{description} and the content of the variable are added to the end of
+the reference line. The starred version \Macro{newkomavar*} is similar to the
+unstarred version but also calls the \Macro{addtoreffields} command. Thus, the
+starred version automatically adds the variable to the reference line.
\begin{Example}
- Suppose you need an additional field for direct dialling. You can
- define this field either with
+ Suppose you need an additional field for a telephone extension in the
+ reference line. You can define this field with
\begin{lstcode}
- \newkomavar[Direct dialling]{myphone}
+ \newkomavar[Extension]{myphone}
\addtoreffields{myphone}
\end{lstcode}
or more concisely with
\begin{lstcode}
- \newkomavar*[direct dialling]{myphone}
+ \newkomavar*[Extension]{myphone}
\end{lstcode}
\end{Example}
-When\textnote{Attention!} you define a variable for the reference fields line
-you should always give it a description.
-
-With the command \Macro{removereffields} all variables in the reference field
-line can be removed. This also includes the predefined variables of the
-class. The reference fields line is then empty. This can be useful, for
-example, if you wish to change the order of the variables in the reference
-fields line.
-
-The command \Macro{defaultreffields} acts to reset the reference
-fields line to its predefined format. In doing so, all custom-defined
-variables are removed from the reference fields line.
-
-The\textnote{Attention!} date should not be added to the reference fields line
-using \Macro{addtoreffields}. Instead option \Option{date}%
-\important[i]{\OptionValueRef{scrlttr2}{refline}{dateleft}\\
- \OptionValueRef{scrlttr2}{refline}{dateright}\\
- \OptionValueRef{scrlttr2}{refline}{nodate}}%
-\IndexOption{refline~=\PValue{dateleft}}%
-\IndexOption{refline~=\PValue{dateright}}%
-\IndexOption{refline~=\PValue{nodate}} should be used to select the date left,
-right or not at the business line. This option also will change the position
-of the date if no reference fields will be output.%
+When\textnote{Attention!} you define a variable for the reference line, you
+should always give it a description.
+
+You can use the \Macro{removereffields} command to remove all variables from
+the reference field. This includes the predefined variables of the class. The
+reference line is then empty. This can be useful, for example, if you wish to
+change the order of the variables in the reference fields line.
+
+The \Macro{defaultreffields} command resets the reference fields line to its
+predefined format. In doing so, all custom-defined variables are removed from
+the reference fields line.
+
+You\textnote{Attention!} should not add the date to the reference line with
+the \Macro{addtoreffields} command. Instead you should use the
+\DescRef{scrlttr2.option.refline}%
+\important{\OptionValueRef{scrlttr2}{refline}{dateleft}\\
+\OptionValueRef{scrlttr2}{refline}{dateright}\\
+\OptionValueRef{scrlttr2}{refline}{nodate}}%
+\IndexOption{refline~=\textKValue{dateleft}}%
+\IndexOption{refline~=\textKValue{dateright}}%
+\IndexOption{refline~=\textKValue{nodate}} option to select whether the date
+should appear on the left or right side of the reference line, or not at all.
+These settings also affect the position of the date when no reference line is
+used.%
%
\EndIndexGroup
@@ -1229,22 +1234,22 @@ of the date if no reference fields will be output.%
\Macro{usekomavar}\OParameter{command}\Parameter{name}%
\Macro{usekomavar*}\OParameter{command}\Parameter{name}
\end{Declaration}
-The commands \DescRef{scrlttr2.cmd.usekomavar} and
-\DescRef{scrlttr2.cmd.usekomavar*} are, similarly to all commands where a
-starred version exists or which can take an optional argument, not fully
-expandable. Nevertheless, if used within
-\DescRef{scrlttr2.cmd.markboth}\IndexCmd{markboth},
+The \DescRef{scrlttr2.cmd.usekomavar} and \DescRef{scrlttr2.cmd.usekomavar*}
+commands are, like all commands where a starred version exists or which can
+take an optional argument, not fully expandable. Nevertheless, if you use them
+within \DescRef{scrlttr2.cmd.markboth}\IndexCmd{markboth},
\DescRef{scrlttr2.cmd.markright}\IndexCmd{markright} or similar commands, you
-need not insert a \Macro{protect}\IndexCmd{protect} before using them. Of
-course this is also true for
-\DescRef{scrlayer-scrpage.cmd.markleft}\IndexCmd{markleft} if using package
-\Package{scrlayer-scrpage}. However\textnote{Attention!}, these kinds of
-commands can not be used within commands like
-\Macro{MakeUppercase}\important{\Macro{MakeUppercase}}\IndexCmd{MakeUppercase}
-which directly influence their argument. To avoid this problem you may use
-commands like \Macro{MakeUppercase} as an optional argument to
-\Macro{usekomavar} or \Macro{usekomavar*}. Then you will get the uppercase
-content of a variable using:
+need not insert \Macro{protect}\IndexCmd{protect} beforehand. Of course
+this is also true for
+\DescRef{scrlayer-scrpage.cmd.markleft}\IndexCmd{markleft} if you use the
+\hyperref[cha:scrlayer-scrpage]{\Package{scrlayer-scrpage}}%
+\IndexPackage{scrlayer-scrpage} package. These\textnote{Attention!} commands
+cannot be used within commands that directly affect their argument, such as
+\Macro{MakeUppercase}\important{\Macro{MakeUppercase}}%
+\IndexCmd{MakeUppercase}. To avoid this problem you can use commands like
+\Macro{MakeUppercase} as an optional argument to \Macro{usekomavar} or
+\Macro{usekomavar*}. Then you will get the upper-case content of a variable
+with
\begin{lstcode}[escapeinside=`']
\usekomavar[\MakeUppercase]{`\PName{Name}'}
\end{lstcode}
@@ -1256,194 +1261,110 @@ content of a variable using:
\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 or description of the variable will
-be expanded as far as this is possible with \Macro{edef}. If this results in
-spaces or unexpandable macros like \Macro{relax}, the result will be not empty
-even where the use of the variable would not result in any visible output.
-
-Both\textnote{Attention!} variants of the command also must not be used as the
-argument of \Macro{MakeUppercase}\IndexCmd{MakeUppercase} or other commands
-which have similar effects to their arguments However, they are robust enough
-to be used as the argument of, e.\,g., \DescRef{scrlttr2.cmd.markboth} or
-\Macro{footnote}.%
+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
+unexpandable macros like \Macro{relax}, the result will be not empty even
+where the use of the variable would not result in any visible output.
+
+Once\textnote{Attention!} again, this command cannot be used as the argument
+of \Macro{MakeUppercase}\IndexCmd{MakeUppercase} or similar commands However,
+it is robust enough to be used as the argument of
+\DescRef{scrlttr2.cmd.markboth} or \DescRef{scrlttr2.cmd.footnote}, for
+example.%
%
\EndIndexGroup
%
\EndIndexGroup
-\section{Differences in the Page Styles of \Package{scrletter}}
+\section{Additional Information about Page Styles}
\seclabel{pagestyleatscrletter}
\BeginIndexGroup
\BeginIndex{}{page>style}
-As described in \autoref{sec:scrlttr2.pagestyle}, the page style
-\PageStyle{headings} shows the content of variables \DescRef{scrlttr2.variable.nexthead} and
-\DescRef{scrlttr2.variable.nextfoot}. Page style \PageStyle{headings} has already another
-meaning in the \KOMAScript{} classes \Class{scrbook}, \Class{scrreprt}, and
-\Class{scrartcl}. Therefore \Package{scrletter} defines a new pair of page
-styles (see \autoref{sec:scrlayer-scrpage-experts.pagestyle.pairs},
-\autopageref{sec:scrlayer-scrpage-experts.pagestyle.pairs}). The definition
-is done using package
-\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}.
-
-Hence, you cannot use \Package{scrletter} with the outdated packages
-\Package{scrpage2}\IndexPackage{scrpage2} and
-\Package{scrpage}\IndexPackage{scrpage}. Same applies to
-\Package{fancyhdr}\IndexPackage{fancyhdr} that is in general not recommended
-for use with \KOMAScript. Additionally, internally loading package
-\Package{scrlayer-scrpage} automatically activates page style
-\PageStyle{scrheadings}\IndexPagestyle{scrheadings}. This activation
-changes page styles \PageStyle{headings} and \PageStyle{plain} into aliases of
-\PageStyle{scrheadings} and \PageStyle{plain.scrheadings}. So these page
-styles are also controlled by \Package{scrlayer-scrpage}.
-
-\begin{Declaration}
- \PageStyle{letter}
- \PageStyle{plain.letter}
- \DescRef{scrlttr2.variable.nexthead}
- \DescRef{scrlttr2.variable.nextfoot}
-\end{Declaration}
-Package \Package{scrletter} defines the pair of page style \PageStyle{letter}
-using \Package{scrlayer-scrpage} to become independent from the page styles of
-the document class. Variables \DescRef{scrlttr2.variable.nexthead} and
-\DescRef{scrlttr2.variable.nextfoot} are used by \Package{scrletter}'s
-\PageStyle{letter} in the same way as for \Class{scrlttr2}'s
-\PageStyle{headings}. The corresponding \PageStyle{plain} page style is also
-similar to \Class{scrlttr2}'s page style \PageStyle{plain}. Notably the
-position of the page number depends on option
-\DescRef{scrlttr2.option.pagenumber}\IndexOption{pagenumber} (see
-\DescPageRef{scrlttr2.option.pagenumber}).%
-\EndIndexGroup
-
-
-\begin{Declaration}
- \Option{headsepline}%
- \Option{footsepline}
-\end{Declaration}
-Because of the different internal approach of \Package{scrletter}, the options
-\Option{headsepline}\important[i]{\Option{headsepline}\\%
- \Option{footsepline}} and \Option{footsepline} differ slightly from
-class \Class{scrlttr2}, because they are controlled by package
-\Package{scrlayer-scrpage}. Especially the horizontal lines in page head and
-foot of the \PageStyle{plain} page style depend on the options of
-\Package{scrlayer-scrpage}. See
-\autoref{sec:scrlayer-scrpage.pagestyle.content},
-\DescPageRef{scrlayer-scrpage.option.headsepline} and
-\DescPageRef{scrlayer-scrpage.option.plainheadsepline} for information
-about those options.%
-\EndIndexGroup
-
-
-\begin{Declaration}
- \Macro{pagemark}%
- \Macro{letterpagemark}
-\end{Declaration}
-The \KOMAScript{} classes already define and use \Macro{pagemark}. So when
-\Package{scrletter} is loaded, it cannot simply redefine \Macro{pagemark} to
-add the prefix ``Page'' using \Macro{pagename}, because this would not only
-influence the pagination of the letter pages but the pagination of the whole
-document. Therefore\ChangedAt{v3.17}{\Package{scrletter}} \Package{scrletter}
-defines a new command \Macro{letterpagemark} with the prefix and lets
-\Macro{pagemark} become \Macro{letterpagemark} in
-\Macro{begin}\PParameter{letter} until the end of the letter only. If you want
-to redefine \Macro{pagemark} for the whole document including the letter
-pages, you have to add
-\begin{lstcode}
- \let\letterpagemark\pagemark
-\end{lstcode}
-just after the normal redefinition of \Macro{pagemark}. This add-on also will
-not violate anything if you later decide to switch from package
-\Package{scrletter} to class \Class{scrlttr2}. Note that the class
-\Class{scrlttr2} does not provide or use \Macro{letterpagemark}.%
-\EndIndexGroup
-%
+\LoadNonFree{scrlttr2-experts}{0}%
\EndIndexGroup
-
-\section{Differences in the Handling of \File{lco}-Files in
- \Package{scrletter}}
+\iffalse% Wurde bereits in Kapitel 4.21 behandelt
+\section{Differences in How \Package{scrletter} Handles \File{lco} Files}
\seclabel{lcoatscrletter}
\BeginIndexGroup
\BeginIndex{File}{lco}
-\BeginIndex{}{letter>class option}%
-\BeginIndex{}{letter class option}%
-\BeginIndex{}{lco-file=\File{lco}-file}
+\BeginIndex{}{lco file=\File{lco} file}
-As\ChangedAt{v3.15}{\Package{scrletter}} shown in
-\autoref{sec:scrlttr2.lcoFile}, \Class{scrlttr2} can load \File{lco}-files via
-the optional argument of \Macro{documentclass}. Package \Package{scrletter}
+As\ChangedAt{v3.15}{\Package{scrletter}} explained in
+\autoref{sec:scrlttr2.lcoFile}, \Class{scrlttr2} can load \File{lco} files via
+the optional argument of \Macro{documentclass}. The \Package{scrletter} package
does not support this.
\begin{Declaration}
\Macro{LoadLetterOption}\Parameter{name}%
\Macro{LoadLetterOptions}\Parameter{list of names}
\end{Declaration}
-For \Class{scrlttr2} it is only recommended to load \File{lco}-files using
+For \Class{scrlttr2}, load \File{lco} files with
\DescRef{scrlttr2.cmd.LoadLetterOption} or
-\DescRef{scrlttr2.cmd.LoadLetterOptions}. With \Package{scrletter} you must
-use these commands to load \File{lco}-files. Of course, you can use these
-commands at the earliest after loading \Package{scrletter}.%
+\DescRef{scrlttr2.cmd.LoadLetterOptions} is only a recommendation. For
+\Package{scrletter}, it is mandatory. Of course, you can only load the
+\File{lco} files after you load \Package{scrletter}.
+%
\EndIndexGroup
%
\EndIndexGroup
+\fi
-\section{\File{lco}-Files for Experienced Users}
+\section{\File{lco} Files for Experienced Users}
\seclabel{lcoFile}
\BeginIndexGroup
-\BeginIndex{File}{lco}%
-\BeginIndex{}{lco-file=\File{lco}-file}%
-
-\BeginIndex{}{paper>size>limitation}%
-Even though each paper size, that may be set up using package
-\Package{typearea}, may be also used with \Class{scrlttr2}, the result of the
-first page may be unwanted with some of those page sizes. The conception of
-the class is not the reason for this, but the fact, that there are mainly
-parameter sets for ISO~A4 paper. Unfortunately their are not any universal
-rules, to calculate, e.\,g., the position of the address field or similar for
-every available paper sizes. But it is possible to make parameter sets for any
-paper size that is needed.%
-%
-\EndIndex{}{paper>size>limitation}%
-
-
-\subsection{Survey of Paper Size}
-\seclabel{papersize}
-
-At present there exist only parameter sets and \File{lco}-files for A4-sized
-or letter-sized paper. Nevertheless, class \Class{scrlttr2} supports many more
-paper sizes. Because of this it's necessary to survey setting up the correct
-paper size.
+\BeginIndex{File}{lco}
+\BeginIndex{}{lco file=\File{lco} file}
+
+\BeginIndexGroup%
+\BeginIndex{}{paper>format}%
+Although you can use any paper size that the
+\hyperref[cha:typearea]{\Package{typearea}}%
+\IndexPackage{typearea} package can configure, the output of the letterhead
+page may produce undesirable results with some formats. Unfortunately, there
+are no general rules to calculate the position of the address fields and the
+like for every available paper size. Instead, different parameter sets are
+needed for different paper sizes.%
+
+%\subsection{Verifying the Paper Size}
+%\seclabel{papersize}
+
+At present parameter sets and \File{lco} files exist only for A4-sized and
+letter-sized paper. Theoretically, however, the \Class{scrlttr2} class can
+support many more paper sizes. Therefore, it's necessary to verify that the
+correct paper size is used. This is even more true if you use
+\Package{scrletter}, since the paper size depends on the class you use.
\begin{Declaration}
\Macro{LetterOptionNeedsPapersize}%
\Parameter{option name}\Parameter{paper size}
\end{Declaration}
-In order that you will at least be warned when using another \PName{paper
- size}, you will find a \Macro{LetterOptionNeedsPapersize} command in every
-\File{lco}-file distributed with {\KOMAScript}. The first argument is the name
-of the \File{lco}-file without the ``\File{.lco}'' suffix. The second argument
-is the paper size for which the \File{lco}-file is designed.
+To provide at least a warning when another \PName{paper size} is used, you can
+find a \Macro{LetterOptionNeedsPapersize} command in every \File{lco} file
+distributed with {\KOMAScript}. The first argument is the name of the
+\File{lco} file without the ``\File{.lco}'' suffix. The second argument is the
+paper size for which the \File{lco} file is designed.
If several \File{lco} files are loaded in succession, a
\Macro{LetterOptionNeedsPapersize} command can be contained in each of them,
-but the \DescRef{scrlttr2.cmd.opening} command will only check the last given \PName{paper
- size}. As shown in the following example, an experienced user can thus
-easily write \File{lco}-files with parameter sets for other paper sizes.
+but the \DescRef{scrlttr2.cmd.opening} command will only check the last given
+\PName{paper size}. As the following example shows, an experienced user can
+thus easily write \File{lco} files with parameter sets for other paper sizes.
\iffalse% Umbruchoptimierung
-If you do not plan to set up such \File{lco}-files yourself, you may just
+If you do not plan to set up such \File{lco} files yourself, you can just
forget about this option and skip the example.%
\fi
\begin{Example}
- Suppose you use A5-sized paper in normal, i.\,e., upright or portrait,
- orientation for your letters. We further assume that you want to put them
- into standard C6 window envelopes. In that case, the position of the address
- field would be the same as for a DIN standard letter on A4-sized paper. The
- main difference is that A5 paper needs only one fold. So you want to disable
- the topmost and bottommost folding marks. If their would not be options for
- this, the easiest way to achieve this would be to place the marks outside of
- the paper area.
+ Suppose you use A5-sized paper in normal, that is upright or portrait,
+ orientation for your letters. Let's assume that you want to put them into
+ standard C6 window envelopes. In that case, the position of the address
+ field would be the same as for a standard letter on A4-sized paper. The main
+ difference is that A5 paper needs only one fold. So you want to disable the
+ top and bottom fold marks. You can do this, for example, by placing the
+ marks outside the paper area.
\begin{lstcode}
\ProvidesFile{a5.lco}
[2002/05/02 letter class option]
@@ -1451,66 +1372,66 @@ forget about this option and skip the example.%
\@setplength{tfoldmarkvpos}{\paperheight}
\@setplength{bfoldmarkvpos}{\paperheight}
\end{lstcode}
- Besides this, the placement of the foot, that is, the pseudo-length
- \PLength{firstfootvpos}, must be adjusted. It is left to the reader to find
- an appropriate value. When using such an \File{lco} file, you must only take
- care that other \File{lco} file options, like \File{SN}, are declared before
- loading ``\File{a5.lco}''.
-\iffalse% Umbruchoptimierung
- Does this seem too complicated? Only before you have used it the first
- time. Anyway, how often do you write letters not using your standard formats
- for A4-size or letter-size paper?
-\fi%
+ Of course, it would be more elegant to deactivate the marks with the
+ \DescRef{scrlttr2.option.foldmarks} option. In addition, you must adjust the
+ position of the footer, that is, the \PLength{firstfootvpos} pseudo-length.
+ I leave it to the reader to find an appropriate value. When using such an
+ \File{lco} file, you must declare other \File{lco} file options like
+ \File{SN} before you load ``\File{a5.lco}''.
\end{Example}
%
-\EndIndexGroup
+\EndIndexGroup%
+\EndIndexGroup%
+\vskip-\ht\strutbox% Wegen Beispiel am Ende der Erklaerung
-\subsection{Visualization of Positions}
-\seclabel{visualize}
-\BeginIndexGroup
-\BeginIndex{Option}{visualize}
-
-If someone develops a new \File{lco}-file, e.\,g., to adapt the positions of
-the several fields of the note paper because of own wishes or because it's
-simply necessary, then it often will be useful to make at least some elements
-directly visual. This is the sense of \File{lco}-file
-\File{visualize.lco}\ChangedAt{v3.04}{\Class{scrlttr2}}. This file may be
-loaded like each other \File{lco}-file. But in difference to other
-\File{lco}-files it has to be done in the document preamble and it's not
-possible to switch off the effects of that \File{lco}-file. This
-\File{lco}-file uses packages \Package{eso-pic}\IndexPackage{eso-pic}%
-\important[i]{\Package{eso-pic}\\\Package{graphicx}}
-and \Package{graphicx}\IndexPackage{graphicx}, that are not part of
+%\subsection{Visualizing Positions}
+%\seclabel{visualize}
+%\BeginIndexGroup
+\begin{Declaration}
+ \File{visualize.lco}
+\end{Declaration}
+\BeginIndex{Option}{visualize}%
+If you develop your own \File{lco} file, for example to modify the positions
+of various fields on the letterhead page because your own desires or
+requirements, it is helpful if you can make at least some elements directly
+visible. The \File{lco} file
+\File{visualize.lco}\ChangedAt{v3.04}{\Class{scrlttr2}} exists for this
+purpose. You can load this file as you would any other \File{lco} file. But
+this \emph{letter class options} file must be loaded in the document preamble,
+and its effects cannot be deactivated. The \File{lco} file uses the
+\Package{eso-pic}\IndexPackage{eso-pic}%
+\important[i]{\Package{eso-pic}\\\Package{graphicx}} and
+\Package{graphicx}\IndexPackage{graphicx} packages, which are not part of
\KOMAScript.
\begin{Declaration}
\Macro{showfields}\Parameter{field list}
\end{Declaration}
-This command activates the visualization of note paper fields. Argument
-\PName{field list} is a comma separated list of fields that should be
-visualized. Following are the supported fields:
+This command makes the space occupied by the fields on the letterhead page
+visible. The \PName{field list} argument is a comma-separated list of fields
+to be shown. The following fields are supported:
\begin{labeling}[~--]{\PValue{location}}
-\item[\PValue{test}] is a test field of size 10\Unit{cm} by 15\Unit{cmd} with
- position 1\Unit{cm} down and right from the topmost and leftmost edges of
- the paper. This field exists for debugging purpose. It may be used as an
- measure comparison in the case, that the measures will be adulterated while
- printing.
-\item[\PValue{head}] is the header area of the note paper. This area has an
- open bottom.
-\item[\PValue{foot}] is the footer area of the note paper. This area has an
- open top.
+\item[\PValue{test}] is a 10\Unit{cm} by 15\Unit{cm} test field, 1\Unit{cm}
+ from the top and left edges of the paper. This field exists for debugging.
+ You can use it as a benchmark to check whether the measurements have been
+ distorted during the creation of the document.
+\item[\PValue{head}] is the header area of the letterhead page. This field
+ is open at the bottom.
+\item[\PValue{foot}] is the footer area of the letterhead page. This field is
+ open at the top.
\item[\PValue{address}] is the address window area used by window envelopes.
-\item[\PValue{location}] is the field of the sender's extension.
-\item[\PValue{refline}] is the business line. This are has an open bottom.
+\item[\PValue{location}] is the field for the extra sender information.
+\item[\PValue{refline}] is the reference line. This field is open at the
+ bottom.
\end{labeling}%
\BeginIndex{FontElement}{field}\LabelFontElement{field}%
-The color of the visualization may be changed using
-commands\DescRef{scrlttr2.cmd.setkomafont} und
-\DescRef{scrlttr2.cmd.addtokomafont} (see \autoref{sec:scrlttr2.textmarkup},
-\DescPageRef{scrlttr2.cmd.setkomafont}) with the element
-\FontElement{field}\important{\FontElement{field}}. Default is
+You can change the colour of the visualisation with
+the\DescRef{scrlttr2.cmd.setkomafont} and \DescRef{scrlttr2.cmd.addtokomafont}
+(see \autoref{sec:scrlttr2.textmarkup},
+\DescPageRef{scrlttr2.cmd.setkomafont}) commands using the
+\FontElement{field}\important{\FontElement{field}} element. The default is
\Macro{normalcolor}.%
\EndIndex{FontElement}{field}%
%
@@ -1518,20 +1439,21 @@ commands\DescRef{scrlttr2.cmd.setkomafont} und
\begin{Declaration}
- \Macro{setshowstyle}\Parameter{visualization style}%
+ \Macro{setshowstyle}\Parameter{style}%
\Macro{edgesize}
\end{Declaration}
-The default for the visualization of single areas are
-frames\important{\PValue{frame}} around the areas. Areas with open top or
-bottom are not framed completely but have an open edge with arrows at the end
-of the ending lines. Alternatively\important{\PValue{rule}} the
-\PName{visualization style} \PValue{rule} may be used. In this case a
-background color will be used to visualize the areas. This does not differ open
-and closed areas. Instead a minimal height will be used for open areas. The
-third\important{\PValue{edges}} available \PName{visualization style} is
-\PValue{edges}. This will mark the corners of the areas. The corner marks at
-the open edge of open areas will be omitted. The size of two edges of the
-corner marks are given by the macro \Macro{edgesize} with default 1\Unit{ex}.%
+By default, \File{visualize.lco} indicates the individual areas with
+frames\important{\PValue{frame}}, which corresponds to the \PName{style}
+\PValue{frame}. Areas open at top or bottom are not completely framed but have
+an open edge with with small arrows pointing up or down.
+Alternatively\important{\PValue{rule}}, you can use the \PName{style}
+\PValue{rule}. In this case, the area is highlighted by a background colour.
+It isnot possible to distinguish open and closed areas. Instead a minimal
+height will be used for open areas. The third\important{\PValue{edges}}
+available \PName{style} is \PValue{edges}, which shows the corners of the
+areas. The corner marks at the open edge of open areas will be omitted. The
+size of two edges of the corner marks are given by the \Macro{edgesize} macro
+with a default of 1\Unit{ex}.%
\EndIndexGroup
@@ -1544,60 +1466,55 @@ corner marks are given by the macro \Macro{edgesize} with default 1\Unit{ex}.%
\Macro{showUScheck}\OParameter{instructions}%
\Macro{unitfactor}
\end{Declaration}
-These commands may be used to output a graphics of an envelope. The envelope
-of the graphic will be rotated by 90\textdegree{} and printed in measure~1:1
-to one document page. The addressee window will be generated automatically
-using the current data of the address position of the note paper:
-\PLength{toaddrvpos}, \PLength{toaddrheight}, \PLength{toaddrwidth}, and
-\PLength{toaddrhpos}. For this the differences \PName{h-offset} and
-\PName{v-offset} of size of the folded letter sheet to the size of the
-envelope, \PName{width} and \PName{height}, will be needed. If both values,
-\PName{h-offset} and \PName{v-offset}, will be omitted using
-\Macro{showenvelope}, then these will be calculated from the folding marks and
-the paper size.
-
-Commands \Macro{showISOenvelope}, \Macro{showUScommercia}, and
-\Macro{showUScheck} base on \Macro{showenvelope}. With \Macro{showISOenvelope}
-ISO-envelopes with \PName{format} C4, C5, C5/6, DL (also known as C5/6) or C6
-may be generated. With \Macro{showUScommercial} an US-commercial envelope of
-\PName{format} 9 or 10 may be generated. \Macro{showUScheck} may be used for
-envelopes in format US-check.
-
-The \PName{instructions} may be used to print additional elements inside the
-envelope.
+If you have loaded \File{visualize.lco}, you can use these commands to output
+a page with a drawing of an envelope. The envelope drawing is always rotated
+by 90\textdegree{} on a separate page and printed in 1:1~scale. The addressee
+window is generated automatically from the current data for the address
+position of the letterhead page: \PLength{toaddrvpos}, \PLength{toaddrheight},
+\PLength{toaddrwidth}, and \PLength{toaddrhpos}. To do so requires knowing how
+much smaller the folded letter pages are than the width and height of the
+envelope. If you do not specify these two values, \PName{h-offset} and
+\PName{v-offset}, when calling \Macro{showenvelope}, they are calculated from
+the fold marks and the paper size itself.
+
+The \Macro{showISOenvelope}, \Macro{showUScommercial}, and \Macro{showUScheck}
+commands are based on \Macro{showenvelope}. With \Macro{showISOenvelope}, you
+can create ISO-envelopes in C4, C5, C5/6, DL (also known as C5/6) or C6
+\PName{format}. With \Macro{showUScommercial}, you can create a US commercial
+envelope in the 9 or 10 \PName{format}. You can use \Macro{showUScheck} for
+envelopes in US check format.
\BeginIndex{FontElement}{letter}\LabelFontElement{letter}%
-The position of the letter sheet will be signed with dash lines inside the
-envelope. The color of this dash lines may be changed using commands
-\DescRef{scrlttr2.cmd.setkomafont} und \DescRef{scrlttr2.cmd.addtokomafont}
+The position of the letterhead page inside the envelope is indicated with
+dashed lines. You can change the colour of these lines with the
+\DescRef{scrlttr2.cmd.setkomafont} and \DescRef{scrlttr2.cmd.addtokomafont}
(see \autoref{sec:scrlttr2.textmarkup},
-\DescPageRef{scrlttr2.cmd.setkomafont}) with element
-\FontElement{letter}\important{\FontElement{letter}}. Default is
+\DescPageRef{scrlttr2.cmd.setkomafont}) using the
+\FontElement{letter}\important{\FontElement{letter}} element. The default is
\Macro{normalcolor}.%
-%
\EndIndex{FontElement}{letter}%
\BeginIndex{FontElement}{measure}\LabelFontElement{measure}%
-The envelope will be dimensioned automatically. The color of the dimensioning
-may be changed using commands \DescRef{scrlttr2.cmd.setkomafont} und
-\DescRef{scrlttr2.cmd.addtokomafont} (see \autoref{sec:scrlttr2.textmarkup},
-\DescPageRef{scrlttr2.cmd.setkomafont}) with element
-\FontElement{measure}\important{\FontElement{measure}}. Default is
-\Macro{normalcolor} The dimensioning will be done in multiply of
-\Length{unitlength} with accuracy of $1/\Macro{unitfactor}$. Nevertheless
-accuracy of the \TeX{} arithmetic also limits the accuracy of
-dimensioning. Default is 1. The \Macro{unitfactor} may be changed using
-\Macro{renewcommand}.%
+The envelope drawing will be provided with dimensions automatically. You can
+change the colour of these dimension labels with the commands
+\DescRef{scrlttr2.cmd.setkomafont} and \DescRef{scrlttr2.cmd.addtokomafont}
+(see \autoref{sec:scrlttr2.textmarkup},
+\DescPageRef{scrlttr2.cmd.setkomafont}) using the
+\FontElement{measure}\important{\FontElement{measure}} element. The default is
+\Macro{normalcolor}. The dimensions are given in multiples of
+\Length{unitlength}, with an accuracy of $1/\Macro{unitfactor}$, where the
+accuracy of \TeX{} arithmetic is the actual limits. The default is 1. You can
+redefine \Macro{unitfactor} using \Macro{renewcommand}.%
\EndIndex{FontElement}{measure}%
\begin{Example}
- An example letter in format ISO-A4 will be produced. The supported fields
- should be visualized with yellow frame lines. Additionally the position of
- the window of an envelope with size DL should be checked with a
- graphics. The measure lines of the dimensioning should be red and the
- measure numbers should use a small font. The accuracy of the dimensioning
- should be 1\Unit{mm}. The dashed note paper sheet in the envelope should be
- colored green.
+ You are generating a sample letter using the ISO-A4 format. The supported
+ fields should be marked with yellow borders to check their position.
+ Furthermore, the position of the window for a DL-size envelope should be
+ checked with drawing. The dimension lines in this drawing should be red, and
+ the numbers should use a smaller font, with the dimensions printed in cm
+ with an accuracy of 1\Unit{mm}. The dashed letterhead page in the envelope
+ should be coloured green.
\begin{lstcode}
\documentclass[visualize]{scrlttr2}
\usepackage{xcolor}
@@ -1605,16 +1522,17 @@ dimensioning. Default is 1. The \Macro{unitfactor} may be changed using
\setkomafont{measure}{\color{red}\small}
\setkomafont{letter}{\color{green}}
\showfields{head,address,location,refline,foot}
- \usepackage[ngerman]{babel}
+ \usepackage[british]{babel}
\usepackage{lipsum}
\begin{document}
- \setkomavar{fromname}{Peter Musterfrau}
- \setkomavar{fromaddress}{Hinter dem Tal 2\\
- 54321 Musterheim}
+ \setkomavar{fromname}{Joe Public}
+ \setkomavar{fromaddress}{2 Valley\\
+ SAMPLEBY\\
+ ZY32 1XW}
\begin{letter}{%
- Joana Public\\
- Hillside 1\\
- 12345 Public City%
+ 1 Hillside\\
+ SAMPLESTEAD\\
+ WX12 3YZ%
}
\opening{Hello,}
\lipsum[1]
@@ -1625,14 +1543,14 @@ dimensioning. Default is 1. The \Macro{unitfactor} may be changed using
\showISOenvelope{DL}
\end{document}
\end{lstcode}
- This will show the note paper on the first and the envelope graphic on the
- second document page.
+ This will show the letterhead page as the first page and the drawing of the
+ envelope on the second page.
\end{Example}
-Please note, that inauspicious combinations of \Length{unitlength} and
-\Macro{unitfactor} may provoke \TeX{} errors like \emph{arithmetic overflow}
-very soon. Also shown measure numbers may differ a little bit from the real
-value. Both are not mistakes of \Option{visualize} but simple implementation
+Note that poorly chosen combinations of \Length{unitlength} and
+\Macro{unitfactor} can quickly lead to a \TeX{} \emph{arithmetic overflow}
+error. The dimension numbers shown may also differ slightly from the actual
+values. Neither are errors in \Option{visualize} but merely implementation
limitations of \TeX.
%
\EndIndexGroup
@@ -1645,161 +1563,87 @@ limitations of \TeX.
\section{Language Support}
\seclabel{languages}%
\BeginIndexGroup
-\BeginIndex{}{language}%
-
-The document class \Class{scrlttr2} supports many languages. These include
-German\Index{language>German} (\PValue{german} for old German orthography,
-\PValue{ngerman} for the new orthography, \PValue{austrian} for Austrian with
-old German orthography, and
-\PValue{naustrian}\ChangedAt{v3.09}{\Class{scrlttr2}} for Austrian with new
-orthography), English\Index{language>English} (\PValue{english} without
-specification as to whether American or British should be used,
-\PValue{american} and \PValue{USenglish} for American, and \PValue{british}
-and \PValue{UKenglish} for British), French\Index{language>French},
-Italian\Index{language>Italian}, Spanish\Index{language>Spanish},
-Dutch\Index{language>Dutch}, Croatian\Index{language>Croatian},
-Finnish\Index{language>Finnish},
-Norsk\Index{language>Norsk}\ChangedAt{v3.02}{\Class{scrlttr2}}, and
-Swedish\Index{language>Swedish}\ChangedAt{v3.08}{\Class{scrlttr2}}.
-
-If the package \Package{babel}\IndexPackage{babel} (see
-\cite{package:babel}) is used, one can switch between languages with
-the command \Macro{selectlanguage}\Parameter{language}. Other
-packages like \Package{german}\IndexPackage{german} (see
-\cite{package:german}) and \Package{ngerman}\IndexPackage{ngerman}
-(see \cite{package:ngerman}) also define this command. As a rule
-though, the language selection takes place already as a direct
-consequence of loading such a package.
+\BeginIndex{}{languages}%
+
+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;
+\PValue{austrian} for Austrian with the old German orthography,
+\PValue{naustrian}\ChangedAt{v3.09}{\Class{scrlttr2}} for Austrian with the
+new orthography; and \PValue{nswissgerman}\ChangedAt{v3.13}{\Class{scrlttr2}}
+for Swiss German with the new orthogrphy, \PValue{swissgerman} for Swiss
+German with the old orthography), English\Index{language>English} (among
+others, \PValue{english} without specification as to whether American or
+British should be used, \PValue{american} and \PValue{USenglish} for American
+English, and \PValue{british} and \PValue{UKenglish} for British English),
+French\Index{language>French}, Italian\Index{language>Italian},
+Spanish\Index{language>Spanish}, Dutch\Index{language>Dutch},
+Croatian\Index{language>Croatian}, Finnish\Index{language>Finnish},
+Norwegian\Index{language>Norwegian}\ChangedAt{v3.02}{\Class{scrlttr2}},
+Swedish\Index{language>Swedish}\ChangedAt{v3.08}{\Class{scrlttr2}},
+Polish\ChangedAt{v3.13}{\Class{scrlttr2}},
+Czech\ChangedAt{v3.13}{\Class{scrlttr2}}, and Slovak.
+
+You can switch languages using the \Package{babel}\IndexPackage{babel} package
+(see \cite{package:babel}) with the \Macro{selectlanguage}\Parameter{language}
+command. Other packages like \Package{german}\IndexPackage{german} (see
+\cite{package:german}) and \Package{ngerman}\IndexPackage{ngerman} (see
+\cite{package:ngerman}) also define this command. As a rule though, the
+language selection occurs immediately as a direct consequence of loading such
+a package.
\iffalse% Umbruchkorrekturtext
-Further information can be obtained in the documentation of the relevant
-packages.
+For details, please refer to the documentation of the relevant packages.
\fi
-There\textnote{Attention!} is one thing more to mention about language
-packages. The package
-\Package{french}\IndexPackage{french}\important{\Package{french}} (see
-\cite{package:french}) redefines not only the terms of
-\autoref{tab:scrlttr2-experts.languageTerms}, but also other, for instance
-some versions of that package even redefine the command
-\DescRef{scrlttr2.cmd.opening}, since the package assumes that the definition
-of the standard \Class{letter} is used. With \Class{scrlttr2} this is not the
-case, therefore the package \Package{french} destroys the definition in
-\Class{scrlttr2} and does not work correctly with \KOMAScript. The author
-views this is a fault in the \Package{french} package.
-
-If one utilizes the \Package{babel}\IndexPackage{babel} package in order to
-switch to language \PValue{french} while the package
-\Package{french}\IndexPackage{french} is simultaneously installed, then the
-same problems may likely occur, since \Package{babel} employs definitions
-from the \Package{french} package.
-%
-\iffalse% Umbruchergaenzungstext
-If the package \Package{french} is not
-installed then there are no problems. Aimilarly, there is no problem if for
-\Package{babel} instead of \PValue{french} other languages like
-\PValue{acadian}, \PValue{canadien}, \PValue{francais} or \PValue{frenchb} are
-chosen.
+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
+\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
+\Package{french} package thus overwrites the definition and does not work
+correctly with \KOMAScript. I regard this as a fault in the \Package{french}
+package which, although reported decades ago, was unfortunately never
+eliminated.
+
+If you use the \Package{babel}\IndexPackage{babel} package to switch to
+\PValue{french}, problems can occasionally occur. With \Package{babel},
+however, you can usually deactivate changes to a language in a targeted
+manner.%
+\iffalse% This is actually outdated!
+\ If the package \Package{french} is not installed, the problem with
+ \Package{babel} does not arise. Similarly, the problem usually does not
+ exist when you use \Package{babel} with other varieties of French such as
+ \PValue{acadian}, \PValue{canadien}, \PValue{francais} or \PValue{frenchb}
+ instead of \PValue{french}.
\fi
-From \Package{babel} version 3.7j this problem only occurs when it is
-indicated explicitly by means of an option that \Package{babel} should use the
-\Package{french} package. If it cannot be ascertained that a new version of
-\Package{babel} is being used, it is recommended to use
+\iffalse% This is also outdated!
+ However, with \Package{babel} version 3.7j and above, this problem only occurs
+ if the option explicitly indicates that \Package{babel} should use the
+ \Package{french} package.
+%
+\iftrue
+ If you cannot be sure you are not using an old version of \Package{babel}, I
+ recommend you use
\begin{lstcode}
\usepackage[...,frenchb,...]{babel}
\end{lstcode}
-in order to select french.
-
-Other languages can possibly cause similar problems. Currently there
-are no known problems with the \Package{babel} package for the
-german language and the various english language selections.
-
-\begin{Declaration}
- \Macro{captionsenglish}%
- \Macro{captionsUSenglish}%
- \Macro{captionsamerican}%
- \Macro{captionsbritish}%
- \Macro{captionsUKenglish}%
- \Macro{captionsgerman}%
- \Macro{captionsngerman}%
- \Macro{captionsaustrian}%
- \Macro{captionsnaustrian}%
- \Macro{captionsfrench}%
- \Macro{captionsitalian}%
- \Macro{captionsspanish}%
- \Macro{captionsdutch}%
- \Macro{captionscroatian}%
- \Macro{captionsfinnish}%
- \Macro{captionsnorsk}%
- \Macro{captionsswedish}
-\end{Declaration}
-If one switches the language of a letter then
-using these commands the language-dependent terms from
-\autoref{tab:scrlttr2-experts.languageTerms},
-\autopageref{tab:scrlttr2-experts.languageTerms} are redefined. If the used
-language selection scheme does not support this then the commands
-above can be used directly.
-%
-\EndIndexGroup
-
-
-\begin{Declaration}
- \Macro{dateenglish}%
- \Macro{dateUSenglish}%
- \Macro{dateamerican}%
- \Macro{datebritish}%
- \Macro{dateUKenglish}%
- \Macro{dategerman}%
- \Macro{datengerman}%
- \Macro{dateaustrian}%
- \Macro{datenaustrian}%
- \Macro{datefrench}%
- \Macro{dateitalian}%
- \Macro{datespanish}%
- \Macro{datedutch}%
- \Macro{datecroatian}%
- \Macro{datefinnish}%
- \Macro{datenorsk}%
- \Macro{dateswedish}
-\end{Declaration}
-The numerical representation of the date\Index{date} (see option
-\DescRef{scrlttr2.option.numericaldate} in \autoref{sec:scrlttr2.firstpage},
-\DescPageRef{scrlttr2.option.numericaldate}) will be written depending on the
-selected language. Some examples can be found in \autoref{tab:date}.%
-%
-\begin{table}
-% \centering
- \KOMAoptions{captions=topbeside}%
- \setcapindent{0pt}%
-% \caption
- \begin{captionbeside}{Language-dependent forms of the date}[l]
- \begin{tabular}[t]{ll}
- \toprule
- Command & Date example \\
- \midrule
- \Macro{dateenglish} & 24/12/1993\\
- \Macro{dateUSenglish} & 12/24/1993\\
- \Macro{dateamerican} & 12/24/1993\\
- \Macro{datebritish} & 24/12/1993\\
- \Macro{dateUKenglish} & 24/12/1993\\
- \Macro{dategerman} & 24.\,12.\,1993\\
- \Macro{datengerman} & 24.\,12.\,1993\\
- \Macro{dateaustrian} & 24.\,12.\,1993\\
- \Macro{datefrench} & 24.\,12.\,1993\\
- \Macro{dateitalian} & 24.\,12.\,1993\\
- \Macro{datespanish} & 24.\,12.\,1993\\
- \Macro{datedutch} & 24.\,12.\,1993\\
- \Macro{datecroatian} & 24.\,12.\,1993.\\
- \Macro{datefinnish } & 24.12.1993.\\
- \Macro{datenorsk} & 24.12.1993\\
- \Macro{dateswedish} & 24/12 1993\\
- \bottomrule
- \end{tabular}
- \end{captionbeside}
- \label{tab:date}
-\end{table}
-%
-\EndIndexGroup
+ to select French.
+ \iffalse %
+ If necessary, you can still switch to French with
+ \Macro{selectlanguage}\PParameter{french}.%
+ \fi%
+\fi
+\fi
+
+\iftrue
+ 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.
+\fi
\begin{Declaration}
@@ -1822,30 +1666,67 @@ selected language. Some examples can be found in \autoref{tab:date}.%
\Macro{wwwname}%
\Macro{bankname}
\end{Declaration}
-The commands contain the language-dependent terms. These definitions can be
-modified in order to support a new language or for private customization.
-How\important[i]{%
+These commands contain the language-dependent terms. These\important[i]{%
\DescRef{scrbase.cmd.newcaptionname}\\
\DescRef{scrbase.cmd.renewcaptionname}\\
- \DescRef{scrbase.cmd.providecaptionname}} this can be done is described in
-\autoref{sec:scrbase.languageSupport}. The definitions become active only at
-\Macro{begin}\PParameter{document}. Therefore they are not available in the
-{\LaTeX} preamble and cannot be redefined there. In
-\autoref{tab:scrlttr2-experts.languageTerms} the default settings for
-\Option{english} and \Option{ngerman} can be found.%
+ \DescRef{scrbase.cmd.providecaptionname}} definitions can be
+modified to support a new language or for your private customization, as
+described in
+\autoref{sec:scrbase.languageSupport}. \KOMAScript{} sets these terms only 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}.%
+\EndIndexGroup
+%\iffree{}{\clearpage}% Siehe Kommentar zur Tabelle
+
+\begin{Declaration}
+ \Macro{captionsacadian}
+ \Macro{captionsamerican}
+ \Macro{captionsaustralien}
+ \Macro{captionsaustrian}
+ \Macro{captionsbritish}
+ \Macro{captionscanadian}
+ \Macro{captionscanadien}
+ \Macro{captionscroatian}
+ \Macro{captionsczech}
+ \Macro{captionsdutch}
+ \Macro{captionsenglish}
+ \Macro{captionsfinnish}
+ \Macro{captionsfrancais}
+ \Macro{captionsfrench}
+ \Macro{captionsgerman}
+ \Macro{captionsitalian}
+ \Macro{captionsnaustrian}
+ \Macro{captionsnewzealand}
+ \Macro{captionsngerman}
+ \Macro{captionsnorsk}
+ \Macro{captionsnswissgerman}
+ \Macro{captionspolish}
+ \Macro{captionsslovak}
+ \Macro{captionsspanish}
+ \Macro{captionsswedish}
+ \Macro{captionsswissgerman}
+ \Macro{captionsUKenglish}
+ \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
+commands. If your language-switching package does not support this, you can
+also use the above commands directly.
%
\begin{table}
\begin{minipage}{\textwidth}
-% \centering
- \KOMAoptions{captions=topbeside}%
- \setcapindent{0pt}%
- %\caption
- \begin{captionbeside}[{%
- Default settings for language-dependent terms
+ \centering
+% \KOMAoptions{captions=topbeside}%
+% \setcapindent{0pt}%
+ \caption[{%
+ Defaults for language-dependent terms
}]{%
- Default settings for language-dependent terms using languages
- \Option{english} and \Option{ngerman}, as long as language selection
- packages have not been used%
+ 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}%
}[l]
\begin{tabular}[t]{lll}
@@ -1874,45 +1755,127 @@ How\important[i]{%
\end{tabular}
\deffootnote{1em}{1em}{1\ }% brutal aber effektiv
\footnotetext[1000]{Normally these terms are defined by language
- packages like \Package{babel}. In this case they are not redefined by
- \Class{scrlttr2} and may differ from the table above.}
- \end{captionbeside}
+ packages like \Package{babel}. In this case, \KOMAScript{} does not
+ redefine them. The actual wording may therefore differ and can
+ be found in the documentation for the language package used.}
+% \end{captionbeside}
\end{minipage}
\end{table}
%
\EndIndexGroup
+\iffree{}{\clearpage}% Umbruchkorrektur
+
+\begin{Declaration}
+ \Macro{dateacadian}
+ \Macro{dateamerican}
+ \Macro{dateaustralien}
+ \Macro{dateaustrian}
+ \Macro{datebritish}
+ \Macro{datecanadian}
+ \Macro{datecanadien}
+ \Macro{datecroatian}
+ \Macro{dateczech}
+ \Macro{datedutch}
+ \Macro{dateenglish}
+ \Macro{datefinnish}
+ \Macro{datefrancais}
+ \Macro{datefrench}
+ \Macro{dategerman}
+ \Macro{dateitalian}
+ \Macro{datenaustrian}
+ \Macro{datenewzealand}
+ \Macro{datengerman}
+ \Macro{datenorsk}
+ \Macro{datenswissgerman}
+ \Macro{datepolish}
+ \Macro{dateslovak}
+ \Macro{datespanish}
+ \Macro{dateswedish}
+ \Macro{dateswissgerman}
+ \Macro{dateUKenglish}
+ \Macro{dateUSenglish}
+\end{Declaration}
+Depending on the language used, the numerical representation of the date\Index{date} (see option
+\DescRef{scrlttr2.option.numericaldate} in \autoref{sec:scrlttr2.firstpage},
+\DescPageRef{scrlttr2.option.numericaldate}) is formatted in various ways.
+The exact format can be found in \autoref{tab:date}.%
+\EndIndexGroup
%
\EndIndexGroup
+\iffree{}{\clearpage}% Umbruchkorrektur zwecks Ausgabe der Tabellen
+\begin{table}[!tp]% Umbruchoptimierung
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}{Language-dependent Forms of the Date}[l]
+ \begin{tabular}[t]{ll}
+ \toprule
+ Command & Date Example \\
+ \midrule
+ \Macro{dateacadian} & 24.\,12.\,1993\\
+ \Macro{dateamerican} & 12/24/1993\\
+ \Macro{dateaustralien}& 24/12/1993\\
+ \Macro{dateaustrian} & 24.\,12.\,1993\\
+ \Macro{datebritish} & 24/12/1993\\
+ \Macro{datecanadian} & 1993/12/24\\
+ \Macro{datecanadien} & 1993/12/24\\
+ \Macro{datecroatian} & 24.\,12.\,1993.\\
+ \Macro{dateczech} & 24.\,12.\,1993\\
+ \Macro{datedutch} & 24.\,12.\,1993\\
+ \Macro{dateenglish} & 24/12/1993\\
+ \Macro{datefinnish } & 24.12.1993.\\
+ \Macro{datefrancais} & 24.\,12.\,1993\\
+ \Macro{datefrench} & 24.\,12.\,1993\\
+ \Macro{dategerman} & 24.\,12.\,1993\\
+ \Macro{dateitalian} & 24.\,12.\,1993\\
+ \Macro{datenaustrian} & 24.\,12.\,1993\\
+ \Macro{datenewzealand}& 24/12/1993\\
+ \Macro{datengerman} & 24.\,12.\,1993\\
+ \Macro{datenorsk} & 24.12.1993\\
+ \Macro{datenswissgerman} & 24.\,12.\,1993\\
+ \Macro{datepolish} & 24.\,12.\,1993\\
+ \Macro{dateslovak} & 24.\,12.\,1993\\
+ \Macro{datespanish} & 24.\,12.\,1993\\
+ \Macro{dateswedish} & 24/12 1993\\
+ \Macro{dateswissgerman} & 24.\,12.\,1993\\
+ \Macro{dateUKenglish} & 24/12/1993\\
+ \Macro{dateUSenglish} & 12/24/1993\\
+ \bottomrule
+ \end{tabular}
+ \end{captionbeside}
+ \label{tab:date}
+\end{table}
+%
+\section{Obsolete Commands in \Class{scrlttr2}}
+\seclabel{obsolete}
+\BeginIndexGroup
+
+\LoadNonFree{scrlttr2-experts}{1}
+\EndIndexGroup
+%
+\iffalse% Es wird Zeit das komplett rauszuwerfen!
\section{From Obsolete \Class{scrlettr} to Current \Class{scrlttr2}}
\seclabel{fromscrlettr}
-With\textnote{Attention!} the June 2002 release of \Class{scrlttr2} (see
-\autoref{cha:scrlttr2}) the old letter class \Class{scrlettr} became
-obsolete. It is recommended not to use that class for new applications. There
-is no more active development of the old letter class, and support is very
-restricted. However, if you really need the documentation of the old letter
-class, you can still find it in the file \File{scrlettr.dtx}, but only in
-German. You should run it through {\LaTeX} several times, like this:
-\begin{lstoutput}[morekeywords={latex,mkindex}]
- latex scrlettr.dtx
- mkindex scrlettr
- latex scrlettr.dtx
- mkindex scrlettr
- latex scrlettr.dtx
-\end{lstoutput}
-Then you obtain the file \File{scrlettr.dvi} containing the old German
-manual. If you want \File{scrlettr.pdf} instead of \File{scrlettr.dvi} you
-should use \File{pdflatex} instead of \File{latex}.
+With\textnote{Attention!} the 2002 release of \Class{scrlttr2} (see
+\autoref{cha:scrlttr2}), the old letter class, \Class{scrlettr}, became
+obsolete, and it is no longer part of \KOMAScript. If you still need the class
+or information about it, you will find it in
+\cite{package:koma-script-obsolete}.
To facilitate the transition to the new class, there is the compatibility
-option \Option{KOMAold}. In general, the complete older functionality still
-remains in the new class. Without \Option{KOMAold}, the user
-interface and the defaults will be different. More details on
+option \Option{KOMAold}. Basically, all the older functionality still
+exists in the new class. Without \Option{KOMAold}, however, the user
+interface and the defaults are different. More details on
this option are provided in \autoref{sec:scrlttr2.lcoFile},
\autoref{tab:lcoFiles}.
-\LoadNonFree{scrlttr2-experts}{0}
+\LoadNonFree{scrlttr2-experts}{2}
+%
+\EndIndexGroup
+\fi
%
\EndIndexGroup