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.tex872
1 files changed, 364 insertions, 508 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 9b93f3776fc..f27ff563f2c 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-2015
+% Copyright (c) Markus Kohm, 2002-2017
%
% 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-2015
+% Copyright (c) Markus Kohm, 2002-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,17 +46,20 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2-experts.tex}
- [$Date: 2015-07-15 18:39:57 +0200 (Wed, 15 Jul 2015) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
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}
-% Date of the translated German file: 2015-03-31
+% Date of the translated German file: 2017-01-02
\chapter{Additional Information about the Letter Class
\Class{scrlttr2} and the Letter Package \Package{scrletter}}
\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
@@ -70,19 +73,17 @@ 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.
-\BeginIndex{Package}{scrletter}%
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.%
-%
-\EndIndex{Package}{scrletter}%
\section{Pseudo-Lengths for Experienced Users}
\seclabel{pseudoLengths}
+\BeginIndexGroup
\BeginIndex{}{pseudo-lengths}
{\TeX} works with a fixed number of registers. There are registers for tokens,
@@ -133,87 +134,87 @@ note paper have been omitted to get a more clear arrangement.
\pentry{backaddrheight}{%
height of the return address at the upper edge of the address field %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.backaddrheight})%
+ \DescPageRef{scrlttr2-experts.plength.backaddrheight})%
}%
\pentry{bfoldmarklength}{%
length of the bottommost folding mark %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.bfoldmarkvpos})%
+ \DescPageRef{scrlttr2-experts.plength.bfoldmarkvpos})%
}%
\pentry{bfoldmarkvpos}{%
vertical distance of bottommost folding mark from top paper edge %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.bfoldmarkvpos})%
+ \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 %
(\autoref{sec:scrlttr2-experts.firstFoot},
- \autopageref{desc:scrlttr2-experts.plength.firstfoothpos})%
+ \DescPageRef{scrlttr2-experts.plength.firstfoothpos})%
}%
\pentry{firstfootvpos}{%
vertical distance of letter footer from top paper edge %
(\autoref{sec:scrlttr2-experts.firstFoot},
- \autopageref{desc:scrlttr2-experts.plength.firstfootvpos})%
+ \DescPageRef{scrlttr2-experts.plength.firstfootvpos})%
}%
\pentry{firstfootwidth}{%
width of letter footer %
(\autoref{sec:scrlttr2-experts.firstFoot},
- \autopageref{desc:scrlttr2-experts.plength.firstfootwidth})%
+ \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 %
(\autoref{sec:scrlttr2-experts.firstHead},
- \autopageref{desc:scrlttr2-experts.plength.firstheadhpos})%
+ \DescPageRef{scrlttr2-experts.plength.firstheadhpos})%
}%
\pentry{firstheadvpos}{%
vertical distance of letterhead from top paper edge %
(\autoref{sec:scrlttr2-experts.firstHead},
- \autopageref{desc:scrlttr2-experts.plength.firstheadvpos})%
+ \DescPageRef{scrlttr2-experts.plength.firstheadvpos})%
}%
\pentry{firstheadwidth}{%
width of the letterhead %
(\autoref{sec:scrlttr2-experts.firstHead},
- \autopageref{desc:scrlttr2-experts.plength.firstheadwidth})%
+ \DescPageRef{scrlttr2-experts.plength.firstheadwidth})%
}%
\pentry{foldmarkhpos}{%
horizontal distance of the horizontal folding marks from left paper edge %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.foldmarkhpos})%
+ \DescPageRef{scrlttr2-experts.plength.foldmarkhpos})%
}%
\pentry{foldmarkvpos}{%
vertical distance of the vertical folding marks from the top paper edge %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.foldmarkvpos})%
+ \DescPageRef{scrlttr2-experts.plength.foldmarkvpos})%
}%
\pentry{fromrulethickness}{%
thickness of an optional horizontal rule in the letterhead %
(\autoref{sec:scrlttr2-experts.firstHead},
- \autopageref{desc:scrlttr2-experts.plength.fromrulethickness})%
+ \DescPageRef{scrlttr2-experts.plength.fromrulethickness})%
}%
\pentry{fromrulewidth}{%
length of an optional horizontal rule in letterhead %
(\autoref{sec:scrlttr2-experts.firstHead},
- \autopageref{desc:scrlttr2-experts.plength.fromrulewidth})%
+ \DescPageRef{scrlttr2-experts.plength.fromrulewidth})%
}%
\pentry{lfoldmarkhpos}{%
horizontal distance of the vertical folding mark from the left paper edge %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.lfoldmarkhpos})%
+ \DescPageRef{scrlttr2-experts.plength.lfoldmarkhpos})%
}%
\pentry{lfoldmarklength}{%
length of the vertical folding mark %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.lfoldmarklength})%
+ \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 %
(\autoref{sec:scrlttr2-experts.locationField},
- \autopageref{desc:scrlttr2-experts.plength.locheight})%
+ \DescPageRef{scrlttr2-experts.plength.locheight})%
}%
\pentry{lochpos}{%
horizontal distance of the field with the extended sender's information
@@ -221,135 +222,135 @@ note paper have been omitted to get a more clear arrangement.
distance from the left paper edge, if the value is negative; negative
value of \PLength{toaddrhpos} will be used instead of zero value %
(\autoref{sec:scrlttr2-experts.locationField},
- \autopageref{desc:scrlttr2-experts.plength.lochpos})%
+ \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 %
(\autoref{sec:scrlttr2-experts.locationField},
- \autopageref{desc:scrlttr2-experts.plength.locvpos})%
+ \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 \Option{locfield}
+ width is calculated automatically with respect to option \DescRef{scrlttr2.option.locfield}
that is described in \autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.option.locfield} %
+ \DescPageRef{scrlttr2.option.locfield} %
(\autoref{sec:scrlttr2-experts.locationField},
- \autopageref{desc:scrlttr2-experts.plength.locwidth})%
+ \DescPageRef{scrlttr2-experts.plength.locwidth})%
}%
\pentry{mfoldmarklength}{%
length of the middle horizontal folding mark %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.mfoldmarklength})%
+ \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},
- \autopageref{desc:scrlttr2-experts.plength.mfoldmarkvpos})%
+ \DescPageRef{scrlttr2-experts.plength.mfoldmarkvpos})%
}%
\pentry{pfoldmarklength}{%
length of the puncher hole mark %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.pfoldmarklength})%
+ \DescPageRef{scrlttr2-experts.plength.pfoldmarklength})%
}%
\pentry{refaftervskip}{%
vertical skip below reference fields or business line %
(\autoref{sec:scrlttr2-experts.refLine},
- \autopageref{desc:scrlttr2-experts.plength.refaftervskip})%
+ \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 %
(\autoref{sec:scrlttr2-experts.refLine},
- \autopageref{desc:scrlttr2-experts.plength.refhpos})%
+ \DescPageRef{scrlttr2-experts.plength.refhpos})%
}%
\pentry{refvpos}{%
vertical distance of reference fields or business line from top paper
edge %
(\autoref{sec:scrlttr2-experts.refLine},
- \autopageref{desc:scrlttr2-experts.plength.refvpos})%
+ \DescPageRef{scrlttr2-experts.plength.refvpos})%
}%
\pentry{refwidth}{%
width of reference fields line %
(\autoref{sec:scrlttr2-experts.refLine},
- \autopageref{desc:scrlttr2-experts.plength.refwidth})%
+ \DescPageRef{scrlttr2-experts.plength.refwidth})%
}%
\pentry{sigbeforevskip}{%
vertical skip between closing and signature %
(\autoref{sec:scrlttr2-experts.closing},
- \autopageref{desc:scrlttr2-experts.plength.sigbeforevskip})%
+ \DescPageRef{scrlttr2-experts.plength.sigbeforevskip})%
}%
\pentry{sigindent}{%
indentation of signature with respect to text body %
(\autoref{sec:scrlttr2-experts.closing},
- \autopageref{desc:scrlttr2-experts.plength.sigindent})%
+ \DescPageRef{scrlttr2-experts.plength.sigindent})%
}%
\pentry{specialmailindent}{%
left indentation of mode of dispatch within address field %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.specialmailindent})%
+ \DescPageRef{scrlttr2-experts.plength.specialmailindent})%
}%
\pentry{specialmailrightindent}{%
right indentation of mode of dispatch within address field %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.specialmailrightindent})%
+ \DescPageRef{scrlttr2-experts.plength.specialmailrightindent})%
}%
\pentry{subjectaftervskip}{%
vertical distance after the subject %
(\autoref{sec:scrlttr2-experts.subject},
- \autopageref{desc:scrlttr2-experts.plength.subjectaftervskip})%
+ \DescPageRef{scrlttr2-experts.plength.subjectaftervskip})%
}%
\pentry{subjectbeforevskip}{%
additional vertical distance before the subject %
(\autoref{sec:scrlttr2-experts.subject},
- \autopageref{desc:scrlttr2-experts.plength.subjectbeforevskip})%
+ \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 \Option{subject} %
+ set the subject depending on option \DescRef{scrlttr2.option.subject} %
(\autoref{sec:scrlttr2-experts.subject},
- \autopageref{desc:scrlttr2-experts.plength.subjectaftervskip})%
+ \DescPageRef{scrlttr2-experts.plength.subjectaftervskip})%
}%
\pentry{tfoldmarklength}{%
length of the topmost horizontal folding mark %
(\autoref{sec:scrlttr2-experts.foldmarks},
- \autopageref{desc:scrlttr2-experts.plength.tfoldmarklength})%
+ \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},
- \autopageref{desc:scrlttr2-experts.plength.tfoldmarkvpos})%
+ \DescPageRef{scrlttr2-experts.plength.tfoldmarkvpos})%
}%
\pentry{toaddrheight}{%
height of address field %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.toaddrheight})%
+ \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 %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.toaddrhpos})%
+ \DescPageRef{scrlttr2-experts.plength.toaddrhpos})%
}%
\pentry{toaddrindent}{%
left and right indentation of address within address field %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.toaddrindent})%
+ \DescPageRef{scrlttr2-experts.plength.toaddrindent})%
}%
\pentry{toaddrvpos}{%
vertical distance of the address field from the top paper edge %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.toaddrvpos})%
+ \DescPageRef{scrlttr2-experts.plength.toaddrvpos})%
}%
\pentry{toaddrwidth}{%
width of address field %
(\autoref{sec:scrlttr2-experts.addressee},
- \autopageref{desc:scrlttr2-experts.plength.toaddrwidth})%
+ \DescPageRef{scrlttr2-experts.plength.toaddrwidth})%
}%
\end{desclist}
@@ -360,10 +361,10 @@ note paper have been omitted to get a more clear arrangement.
\label{fig:scrlttr2-experts.pseudoLength}
\end{figure}
+
\begin{Declaration}
\Macro{@newplength}\Parameter{name}
\end{Declaration}
-\BeginIndex{Cmd}{@newplength}%
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
@@ -381,21 +382,20 @@ but it can, for example, be used within an
\cite{UK:FAQ}). But\textnote{Attention!} inside an \File{lco}-file these two
commands should never be used!}%
%
-\EndIndex{Cmd}{@newplength}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{@setplength}%
- \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}\\
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}%
\Macro{@addtoplength}%
\OParameter{factor}\Parameter{pseudo-length}\Parameter{value}
\end{Declaration}
-\BeginIndex{Cmd}{@setplength}%
-\BeginIndex{Cmd}{@addtoplength}%
Using the command \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 \Macro{setlengthtoplength},
+optional argument (see also \DescRef{scrlttr2.cmd.setlengthtoplength},
\autoref{sec:scrlttr2.pseudoLength},
-\autopageref{desc:scrlttr2.cmd.setlengthtoplength}).
+\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
@@ -404,7 +404,7 @@ 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},
-\autopageref{desc:scrlttr2.cmd.useplength}) is used within \PName{value}. To
+\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}.
@@ -420,12 +420,12 @@ but can, for example, be used within an \File{lco}-file.\iffree{}{
\cite{UK:FAQ}). But\textnote{Attention!} inside an \File{lco}-file these two
commands should never be used!}%
%
-\EndIndex{Cmd}{@setplength}%
-\EndIndex{Cmd}{@addtoplength}%
+\EndIndexGroup
\subsection{Folding Marks}
\seclabel{foldmarks}
+\BeginIndexGroup
\index{marks>folding|see{folding marks}}
\BeginIndex{}{folding marks}%
@@ -436,13 +436,10 @@ there is support for a puncher hole mark or center mark which cannot be
shifted in the vertical direction.
\begin{Declaration}
- \PLength{tfoldmarkvpos}\\
- \PLength{mfoldmarkvpos}\\
+ \PLength{tfoldmarkvpos}%
+ \PLength{mfoldmarkvpos}%
\PLength{bfoldmarkvpos}
\end{Declaration}
-\BeginIndex{PLength}{tfoldmarkvpos}%
-\BeginIndex{PLength}{bfoldmarkvpos}%
-\BeginIndex{PLength}{mfoldmarkvpos}%
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
@@ -475,25 +472,19 @@ foldmarks is simply a convenience. In fact, it is not defined that
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
-\Option{foldmarks}\IndexOption{foldmarks~=\PName{Einstellung}}%
-\important{\Option{foldmarks}} (see \autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.foldmarks}) is explicity activated.
+\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.
%
-\EndIndex{PLength}{tfoldmarkvpos}%
-\EndIndex{PLength}{mfoldmarkvpos}%
-\EndIndex{PLength}{bfoldmarkvpos}%
+\EndIndexGroup
\begin{Declaration}
- \PLength{tfoldmarklength}\\
- \PLength{mfoldmarklength}\\
- \PLength{bfoldmarklength}\\
+ \PLength{tfoldmarklength}%
+ \PLength{mfoldmarklength}%
+ \PLength{bfoldmarklength}%
\PLength{pfoldmarklength}
\end{Declaration}
-\BeginIndex{PLength}{tfoldmarklength}%
-\BeginIndex{PLength}{mfoldmarklength}%
-\BeginIndex{PLength}{bfoldmarklength}%
-\BeginIndex{PLength}{pfoldmarklength}%
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
@@ -501,84 +492,78 @@ 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}.%
-\EndIndex{PLength}{tfoldmarklength}%
-\EndIndex{PLength}{mfoldmarklength}%
-\EndIndex{PLength}{bfoldmarklength}%
-\EndIndex{PLength}{pfoldmarklength}%
+\EndIndexGroup
\begin{Declaration}
\PLength{foldmarkhpos}
\end{Declaration}
-\BeginIndex{PLength}{foldmarkhpos}%
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 \Option{foldmarks}\important{\Option{foldmarks}}%
+at all depends on the option \DescRef{scrlttr2.option.foldmarks}\important{\DescRef{scrlttr2.option.foldmarks}}%
\IndexOption{foldmarks~=\PName{Einstellung}} (see
\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.foldmarks}).
+\DescPageRef{scrlttr2.option.foldmarks}).
%
-\EndIndex{PLength}{foldmarkhpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{lfoldmarkhpos}
\end{Declaration}
-\BeginIndex{PLength}{lfoldmarkhpos}%
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.%
-\EndIndex{PLength}{lfoldmarkhpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{lfoldmarklength}
\end{Declaration}
-\BeginIndex{PLength}{lfoldmarklength}%
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.%
-\EndIndex{PLength}{lfoldmarklength}%
+\EndIndexGroup
\begin{Declaration}
\PLength{foldmarkvpos}
\end{Declaration}
-\BeginIndex{PLength}{foldmarkvpos}%
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
-\Option{foldmarks}\important{\Option{foldmarks}}%
+\DescRef{scrlttr2.option.foldmarks}%
+\important{\DescRef{scrlttr2.option.foldmarks}}%
\IndexOption{foldmarks~=\PName{Einstellung}} (see
-\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.foldmarks}). At present there is only one
-vertical foldmark, which is designated the left vertical foldmark.
+\autoref{sec:scrlttr2.firstpage}, \DescPageRef{scrlttr2.option.foldmarks}). At
+present there is only one vertical foldmark, which is designated the left
+vertical foldmark.
%
-\EndIndex{PLength}{foldmarkvpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{foldmarkthickness}
\end{Declaration}
-\BeginIndex{PLength}{foldmarkthickness}%
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!%
-\EndIndex{PLength}{foldmarkthickness}%
+\EndIndexGroup
%
-\EndIndex{}{folding marks}
+\EndIndexGroup
\subsection{Letterhead}
\seclabel{firstHead}
+\BeginIndexGroup
\BeginIndex{}{letterhead}
The term letterhead here refers to all of the data pertaining to the sender
@@ -587,7 +572,7 @@ 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 \Macro{opening}\IndexCmd{opening}.
+command \DescRef{scrlttr2.cmd.opening}\IndexCmd{opening}.
% Fuellmaterial
\iftrue%
The position of the letterhead is absolute and independent of the type
@@ -599,20 +584,18 @@ is set using the page style \PValue{empty}.%
\begin{Declaration}
\PLength{firstheadvpos}
\end{Declaration}
-\BeginIndex{PLength}{firstheadvpos}%
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
typical value is 8\Unit{mm}.%
%
-\EndIndex{PLength}{firstheadvpos}
+\EndIndexGroup
\begin{Declaration}
\PLength{firstheadhpos}
\end{Declaration}
-\BeginIndex{PLength}{firstheadhpos}%
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
@@ -629,13 +612,12 @@ 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.%
%
-\EndIndex{PLength}{firstheadhpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{firstheadwidth}
\end{Declaration}
-\BeginIndex{PLength}{firstheadwidth}%
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}.
@@ -644,18 +626,16 @@ 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
\Option{NF}.%
%
-\EndIndex{PLength}{firstheadwidth}%
+\EndIndexGroup
\begin{Declaration}
- \PLength{fromrulethickness}\\
+ \PLength{fromrulethickness}%
\PLength{fromrulewidth}
\end{Declaration}
-\BeginIndex{PLength}{fromrulethickness}%
-\BeginIndex{PLength}{fromrulewidth}%
Depending on the class option \Option{fromrule} (see
\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.fromrule}), a horizontal rule can be drawn
+\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}
@@ -663,18 +643,18 @@ 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
-\autopageref{desc:scrlttr2-experts.cmd.@setplength}). The default thickness of
+\DescPageRef{scrlttr2-experts.cmd.@setplength}). The default thickness of
the line\ChangedAt{v2.97c}{\Class{scrlttr2}}, \PLength{fromrulethickness}, is
0.4\Unit{pt}.%
%
-\EndIndex{PLength}{fromrulethickness}%
-\EndIndex{PLength}{fromrulewidth}%
+\EndIndexGroup
%
-\EndIndex{}{letterhead}%
+\EndIndexGroup
\subsection{Addressee}
\seclabel{addressee}%
+\BeginIndexGroup
\BeginIndex{}{addressee}
\index{address|seealso{addressee}}
@@ -685,11 +665,9 @@ the latter is especially useful when using window envelopes. The
address directly follows the letterhead.
\begin{Declaration}
- \PLength{toaddrvpos}\\
+ \PLength{toaddrvpos}%
\PLength{toaddrhpos}
\end{Declaration}
-\BeginIndex{PLength}{toaddrvpos}%
-\BeginIndex{PLength}{toaddrhpos}%
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
@@ -702,29 +680,26 @@ 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},
-\autopageref{desc:scrlttr2.option.addrfield}).%
+\DescPageRef{scrlttr2.option.addrfield}).%
%
-\EndIndex{PLength}{toaddrhpos}%
-\EndIndex{PLength}{toaddrvpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{toaddrheight}
\end{Declaration}
-\BeginIndex{PLength}{toaddrheight}%
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.
%
-\EndIndex{PLength}{toaddrheight}%
+\EndIndexGroup
\begin{Declaration}
\PLength{toaddrwidth}
\end{Declaration}
-\BeginIndex{PLength}{toaddrwidth}%
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},
@@ -750,44 +725,42 @@ according to standard envelope window measures. Typical values are between
simply use the option \Option{SNmmarg} instead of \Option{SN}.
\end{Example}
%
-\EndIndex{PLength}{toaddrwidth}%
+\EndIndexGroup
\begin{Declaration}
\PLength{toaddrindent}
\end{Declaration}
-\BeginIndex{PLength}{toaddrindent}%
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}.
With\textnote{Attention!} each of the
settings\ChangedAt{v3.03}{\Class{scrlttr2}}
-\OptionValue{addrfield}{PP}\important[i]{%
- \OptionValue{addrfield}{PP}\\
- \OptionValue{addrfield}{image}\\
+\OptionValueRef{scrlttr2}{addrfield}{PP}\important[i]{%
+ \OptionValueRef{scrlttr2}{addrfield}{PP}\\
+ \OptionValueRef{scrlttr2}{addrfield}{image}\\
\begin{tabular}{@{}l@{}}
\KOption{addrfield}\\
\quad\PValue{backgroundimage}
\end{tabular}}\IndexOption{addrfield~=\PValue{PP}},
-\OptionValue{addrfield}{image}\IndexOption{addrfield~=\PValue{image}}, and
-\OptionValue{addrfield}{backgroundimage}%
+\OptionValueRef{scrlttr2}{addrfield}{image}\IndexOption{addrfield~=\PValue{image}}, and
+\OptionValueRef{scrlttr2}{addrfield}{backgroundimage}%
\IndexOption{addrfield~=\PValue{backgroundimage}} (see
\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.addrfield}) a value of 0\Unit{pt} will be
+\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.%
%
-\EndIndex{PLength}{toaddrindent}%
+\EndIndexGroup
\begin{Declaration}
\PLength{backaddrheight}
\end{Declaration}
-\BeginIndex{PLength}{backaddrheight}%
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
address\textnote{return address}\Index{return address}, because it is visible
@@ -801,21 +774,20 @@ 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},
-\autopageref{desc:scrlttr2.option.addrfield}) and \Option{backaddress} (see
-\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.backaddress}).%
+\DescPageRef{scrlttr2.option.addrfield}) and
+\DescRef{scrlttr2.option.backaddress} (see \autoref{sec:scrlttr2.firstpage},
+\DescPageRef{scrlttr2.option.backaddress}).%
%
-\EndIndex{PLength}{backaddrheight}%
+\EndIndexGroup
+
\begin{Declaration}
- \PLength{specialmailindent}\\
+ \PLength{specialmailindent}%
\PLength{specialmailrightindent}
\end{Declaration}
-\BeginIndex{PLength}{specialmailindent}%
-\BeginIndex{PLength}{specialmailrightindent}%
An optional dispatch type can be output within the address field between the
return address and the addressee address, by setting the variable
-\Variable{specialmail}. Left and right alignment are determined by
+\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}
@@ -824,29 +796,26 @@ provided by \KOMAScript, \PLength{specialmailindent} is set to rubber length
1\Unit{em}. Thus the dispatch type is set 1\Unit{em} from the address field's
right margin.
%
-\EndIndex{PLength}{specialmailindent}%
-\EndIndex{PLength}{specialmailrightindent}%
+\EndIndexGroup
\begin{Declaration}
- \PLength{PPheadheight}\\
+ \PLength{PPheadheight}%
\PLength{PPheadwidth}
\end{Declaration}
-\BeginIndex{PLength}{PPheadheight}%
-\BeginIndex{PLength}{PPheadwidth}%
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
-\OptionValue{addrfield}{PP}\important[i]{%
- \OptionValue{addrfield}{PP}\\
+\OptionValueRef{scrlttr2}{addrfield}{PP}\important[i]{%
+ \OptionValueRef{scrlttr2}{addrfield}{PP}\\
\begin{tabular}{@{}l@{}}
\KOption{addrfield}\\
\quad\PValue{backgroundimage}
\end{tabular}}\IndexOption{addrfield~=\PValue{PP}} and
-\OptionValue{addrfield}{backgroundimage}%
+\OptionValueRef{scrlttr2}{addrfield}{backgroundimage}%
\IndexOption{addrfield~=\PValue{backgroundimage}}. Pseudo-length
-\PLength{PPheadwidth} will be used only with \OptionValue{addrfield}{PP} (see
+\PLength{PPheadwidth} will be used only with \OptionValueRef{scrlttr2}{addrfield}{PP} (see
\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.addrfield}) and gives the width of the left
+\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.
@@ -856,30 +825,30 @@ 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}.%
%
-\EndIndex{PLength}{PPheadwidth}%
-\EndIndex{PLength}{PPheadheight}%
+\EndIndexGroup
+
\begin{Declaration}
\PLength{PPdatamatrixvskip}
\end{Declaration}
-\BeginIndex{PLength}{PPdatamatrixvskip}%
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 \OptionValue{addrfield}{PP}\important{\OptionValue{addrfield}{PP}}%
-\IndexOption{addrfield~=\PValue{PP}}
-(see \autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.addrfield}). Class\textnote{Attention!}
+option \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.%
%
-\EndIndex{PLength}{PPdatamatrixvskip}%
+\EndIndexGroup
%
-\EndIndex{}{addressee}%
+\EndIndexGroup
\subsection{Sender's Extensions}
\seclabel{locationField}
+\BeginIndexGroup
\BeginIndex{}{sender's extension}
\index{sender>extension|see{sender's extension}}
@@ -890,43 +859,38 @@ used. In this manual this field is called the \emph{sender's extension}. In
former manuals is has been called \emph{location field}.
\begin{Declaration}
- \PLength{locheight}\\
- \PLength{lochpos}\\
- \PLength{locvpos}\\
+ \PLength{locheight}%
+ \PLength{lochpos}%
+ \PLength{locvpos}%
\PLength{locwidth}
\end{Declaration}
-\BeginIndex{PLength}{locwidth}%
-\BeginIndex{PLength}{locheight}%
-\BeginIndex{PLength}{lochpos}%
-\BeginIndex{PLength}{locvpos}%
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 \Macro{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
-\Option{locfield} (see \autoref{sec:scrlttr2.firstpage},
-\autopageref{desc: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},
-\autopageref{desc:scrlttr2-experts.plength.toaddrhpos}).%
-%
-\EndIndex{PLength}{locwidth}
-\EndIndex{PLength}{locheight}%
-\EndIndex{PLength}{lochpos}%
-\EndIndex{PLength}{locvpos}%
-%
-\EndIndex{}{sender's extension}
+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},
+\DescPageRef{scrlttr2-experts.plength.toaddrhpos}).%
+%
+\EndIndexGroup
+%
+\EndIndexGroup
\subsection{Business Line}
\seclabel{refLine}%
+\BeginIndexGroup
\BeginIndex{}{business line}
\index{reference>field line|see{business line}}
\index{reference>line|see{business line}}
@@ -940,49 +904,46 @@ 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 \Variable{date} will be set. Information about adding variables
+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},
-\autopageref{desc:scrlttr2-experts.cmd.removereffields}.
+\DescPageRef{scrlttr2-experts.cmd.removereffields}.
\begin{Declaration}
\PLength{refvpos}
\end{Declaration}
-\BeginIndex{PLength}{refvpos}%
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}.
%
-\EndIndex{PLength}{refvpos}%
+\EndIndexGroup
\begin{Declaration}
- \PLength{refwidth}\\
+ \PLength{refwidth}%
\PLength{refhpos}
\end{Declaration}
-\BeginIndex{PLength}{refwidth}%
-\BeginIndex{PLength}{refhpos}%
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
-\Macro{opening}\IndexCmd{opening}. Thus the calculated width depends on the
-determination of the options \Option{refline}\important{\Option{refline}}%
+\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},
-\autopageref{desc:scrlttr2.option.refline}). At the same time,
+\DescPageRef{scrlttr2.option.refline}). At the same time,
\PLength{refhpos} will be set according to this option. With
-\OptionValue{refline}{wide}\IndexOption{refline~=\PValue{wide}}, the reference
+\OptionValueRef{scrlttr2}{refline}{wide}\IndexOption{refline~=\PValue{wide}}, the reference
fields line is centered, while with
-\OptionValue{refline}{narrow}\IndexOption{refline~=\PValue{narrow}} it is
+\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 \Option{refline}, then
+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
@@ -994,29 +955,30 @@ 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 \Option{refline}, or
-\PLength{refwidth} as well as \PLength{refhpos} are set by the user.%
+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.%
%
-\EndIndex{PLength}{refwidth}%
-\EndIndex{PLength}{refhpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{refaftervskip}
\end{Declaration}
-\BeginIndex{PLength}{refaftervskip}%
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
between one and two lines.%
%
-\EndIndex{PLength}{refaftervskip}%
+\EndIndexGroup
%
-\EndIndex{}{business line}%
+\EndIndexGroup
+
\subsection{Subject}
\seclabel{subject}%
+\BeginIndexGroup
\BeginIndex{}{subject}
In different countries the letter's subject will be set different. Some like
@@ -1027,13 +989,12 @@ the business line.
\begin{Declaration}
\PLength{subjectvpos}
\end{Declaration}
-\BeginIndex{PLength}{subjectvpos}%
\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
-\Option{subject}\important{\Option{subject}}%
+\DescRef{scrlttr2.option.subject}\important{\DescRef{scrlttr2.option.subject}}%
\IndexOption{subject~=\PName{Einstellung}} (see
-\autoref{sec:scrlttr2.firstpage}, \autopageref{desc:scrlttr2.option.subject}).
+\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.
@@ -1051,15 +1012,13 @@ space to surely avoid interferences with other elements.
empty line between subject and business line should stay empty, this
provides a maximum of two subject lines.
\end{Example}
-\EndIndex{PLength}{subjectvpos}%
+\EndIndexGroup
\begin{Declaration}
- \PLength{subjectbeforevskip}\\
+ \PLength{subjectbeforevskip}%
\PLength{subjectaftervskip}
\end{Declaration}
-\BeginIndex{PLength}{subjectbeforevskip}%
-\BeginIndex{PLength}{subjectaftervskip}%
\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
@@ -1068,14 +1027,14 @@ 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.%
%
-\EndIndex{PLength}{subjectaftervskip}%
-\EndIndex{PLength}{subjectbeforevskip}%
+\EndIndexGroup
%
-\EndIndex{}{subject}%
+\EndIndexGroup
\subsection{Closing}
\seclabel{closing}
+\BeginIndexGroup
\BeginIndex{}{closing}
The closing consists of three parts: besides the closing phrase there
@@ -1083,11 +1042,9 @@ are a hand-written inscription and the signature, which acts as an
explanation for the inscription.
\begin{Declaration}
- \PLength{sigindent}\\
+ \PLength{sigindent}%
\PLength{sigbeforevskip}
\end{Declaration}
-\BeginIndex{PLength}{sigindent}%
-\BeginIndex{PLength}{sigbeforevskip}%
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.
@@ -1102,14 +1059,14 @@ 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.%
-\EndIndex{PLength}{sigindent}%
-\EndIndex{PLength}{sigbeforevskip}%
+\EndIndexGroup
%
-\EndIndex{}{closing}%
+\EndIndexGroup
\subsection{Letter Footer}
\seclabel{firstFoot}%
+\BeginIndexGroup
\BeginIndex{}{letter>footer}%
\index{note paper>footer|see{letter footer}}%|
@@ -1118,55 +1075,55 @@ 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
-\Macro{opening}\IndexCmd{opening}\important{\Macro{opening}}.
+\DescRef{scrlttr2.cmd.opening}\IndexCmd{opening}\important{\DescRef{scrlttr2.cmd.opening}}.
\begin{Declaration}
\PLength{firstfootvpos}
\end{Declaration}
-\BeginIndex{PLength}{firstfootvpos}%
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
-\Option{enlargefirstpage}\important{\Option{enlargefirstpage}} (see
+\DescRef{scrlttr2.option.enlargefirstpage}\important{\DescRef{scrlttr2.option.enlargefirstpage}} (see
\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.enlargefirstpage}). This way, the distance
+\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}}.
With\textnote{Attention!} the compatibility option
set\ChangedAt{v2.9t}{\Class{scrlttr2}} up to version
-2.9t\IndexOption{version~=\PValue{2.9t}} (see \Option{version} in
+2.9t\IndexOption{version~=\PValue{2.9t}} (see
+\DescRef{scrlttr2.option.version} in
\autoref{sec:scrlttr2.compatibilityOptions},
-\autopageref{desc:scrlttr2.option.version}) the footer is set independently of
-the type area in all predefined
+\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
-\Option{enlargefirstpage}\important{\Option{enlargefirstpage}} also loses its
+\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
-\Option{enlargefirstpage}.
+\DescRef{scrlttr2.option.enlargefirstpage}.
If the letter footer be switched off using option
-\OptionValue{firstfoot}{false}\important{\OptionValue{firstfoot}{false}}%
+\OptionValueRef{scrlttr2}{firstfoot}{false}%
+\important{\OptionValueRef{scrlttr2}{firstfoot}{false}}%
\IndexOption{firstfoot~=\PValue{false}}\ChangedAt{v2.97e}{\Class{scrlttr2}}
(see \autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.firstfoot}), then the setting of
+\DescPageRef{scrlttr2.option.firstfoot}), then 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}.%
%
-\EndIndex{PLength}{firstfootvpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{firstfoothpos}
\end{Declaration}
-\BeginIndex{PLength}{firstfoothpos}%
\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
@@ -1179,27 +1136,28 @@ 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.%
-\EndIndex{PLength}{firstfoothpos}%
+\EndIndexGroup
\begin{Declaration}
\PLength{firstfootwidth}
\end{Declaration}
-\BeginIndex{PLength}{firstfootwidth}%
This pseudo-length gives the width of the letter's first page footer. The
value is set equal to that of the pseudo-length
\PLength{firstheadwidth}\important{\PLength{firstheadwidth}}%
\IndexPLength{firstheadwidth} in the predefined
\File{lco}-files\textnote{\File{lco}-file}\Index{lco-file=\File{lco}-file}.%
%
-\EndIndex{PLength}{firstfootwidth}%
+\EndIndexGroup
%
-\EndIndex{}{letter>footer}%
+\EndIndexGroup
%
-\EndIndex{}{pseudo-lengths}%
+\EndIndexGroup
+
\section{Variables for Experienced Users}
\seclabel{variables}
+\BeginIndexGroup
\BeginIndex{}{variables}
\KOMAScript{} provides beside the feature of using predefined variable also
@@ -1207,17 +1165,12 @@ commands to define new variable or to manipulate the automatic usage of
variables in the business line\Index{business line}.
\begin{Declaration}
- \Macro{newkomavar}\OParameter{description}\Parameter{name}\\
- \Macro{newkomavar*}\OParameter{description}\Parameter{name}\\
- \Macro{removereffields}\\
- \Macro{defaultreffields}\\
+ \Macro{newkomavar}\OParameter{description}\Parameter{name}%
+ \Macro{newkomavar*}\OParameter{description}\Parameter{name}%
+ \Macro{removereffields}%
+ \Macro{defaultreffields}%
\Macro{addtoreffields}\Parameter{name}
\end{Declaration}
-\BeginIndex{Cmd}{newkomavar}%
-\BeginIndex{Cmd}{newkomavar*}%
-\BeginIndex{Cmd}{addtoreffields}%
-\BeginIndex{Cmd}{removereffields}%
-\BeginIndex{Cmd}{defaultreffields}%
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}
@@ -1228,7 +1181,7 @@ 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},
-\autopageref{desc:scrlttr2.option.refline}). The \PName{description} and the
+\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
@@ -1259,35 +1212,32 @@ 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]{\OptionValue{refline}{dateleft}\\
- \OptionValue{refline}{dateright}\\
- \OptionValue{refline}{nodate}}%
+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.%
%
-\EndIndex{Cmd}{defaultreffields}%
-\EndIndex{Cmd}{newkomavar}%
-\EndIndex{Cmd}{newkomavar*}%
-\EndIndex{Cmd}{addtoreffields}%
-\EndIndex{Cmd}{removereffields}%
-%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{usekomavar}\OParameter{command}\Parameter{name}\\
+ \Macro{usekomavar}\OParameter{command}\Parameter{name}%
\Macro{usekomavar*}\OParameter{command}\Parameter{name}
\end{Declaration}
-\BeginIndex{Cmd}{usekomavar}%
-\BeginIndex{Cmd}{usekomavar*}%
-The commands \Macro{usekomavar} and \Macro{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
-\Macro{markboth}\IndexCmd{markboth}, \Macro{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
-\Macro{markleft}\IndexCmd{markleft} if using package
+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},
+\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}
@@ -1299,15 +1249,13 @@ content of a variable using:
\usekomavar[\MakeUppercase]{`\PName{Name}'}
\end{lstcode}
%
-\EndIndex{Cmd}{usekomavar}%
-\EndIndex{Cmd}{usekomavar*}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{ifkomavarempty}\Parameter{name}\Parameter{true}\Parameter{false}\\
+ \Macro{ifkomavarempty}\Parameter{name}\Parameter{true}\Parameter{false}%
\Macro{ifkomavarempty*}\Parameter{name}\Parameter{true}\Parameter{false}
\end{Declaration}
-\BeginIndex{Cmd}{ifkomavarempty}%
-\BeginIndex{Cmd}{ifkomavarempty*}%
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
@@ -1316,22 +1264,22 @@ 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., \Macro{markboth} or \Macro{footnote}.%
+to be used as the argument of, e.\,g., \DescRef{scrlttr2.cmd.markboth} or
+\Macro{footnote}.%
%
-\EndIndex{Cmd}{ifkomavarempty*}%
-\EndIndex{Cmd}{ifkomavarempty}%
+\EndIndexGroup
%
-\EndIndex{}{variables}%
+\EndIndexGroup
\section{Differences in the Page Styles of \Package{scrletter}}
\seclabel{pagestyleatscrletter}
-\BeginIndex{Package}{scrletter}
+\BeginIndexGroup
\BeginIndex{}{page>style}
As described in \autoref{sec:scrlttr2.pagestyle}, the page style
-\Pagestyle{headings} shows the content of variables \Variable{nexthead} and
-\Variable{nextfoot}. Page style \Pagestyle{headings} has already another
+\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},
@@ -1345,63 +1293,52 @@ Hence, you cannot use \Package{scrletter} with the outdated packages
\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
+\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}
- \XMacro{pagestyle}\PParameter{\Pagestyle{letter}}\\
- \XMacro{pagestyle}\PParameter{\Pagestyle{plain.letter}}\\
- \XMacro{setkomavar}\PParameter{\Variable{nexthead}}%
- \OParameter{description}\Parameter{content}\\
- \XMacro{setkomavar}\PParameter{\Variable{nextfoot}}%
- \OParameter{description}\Parameter{content}
+ \PageStyle{letter}
+ \PageStyle{plain.letter}
+ \DescRef{scrlttr2.variable.nexthead}
+ \DescRef{scrlttr2.variable.nextfoot}
\end{Declaration}
-\BeginIndex{Pagestyle}{letter}%
-\BeginIndex{Pagestyle}{plain.letter}%
-\BeginIndex{Variable}{nexthead}%
-\BeginIndex{Variable}{nextfoot}%
-Package \Package{scrletter} defines the pair of page style \Pagestyle{letter}
+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 \Variable{nexthead} and \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
-\Option{pagenumber}\IndexOption{pagenumber} (see
-\autopageref{desc:scrlttr2.option.pagenumber}).%
-\EndIndex{Variable}{nextfoot}%
-\EndIndex{Variable}{nexthead}%
-\EndIndex{Pagestyle}{plain.letter}%
-\EndIndex{Pagestyle}{letter}%
+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{headsepline}%
\Option{footsepline}
\end{Declaration}
-\BeginIndex{Option}{headsepline}%
-\BeginIndex{Option}{footsepline}%
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
+foot of the \PageStyle{plain} page style depend on the options of
\Package{scrlayer-scrpage}. See
\autoref{sec:scrlayer-scrpage.pagestyle.content},
-\autopageref{desc:scrlayer-scrpage.option.headsepline} and
-\autopageref{desc:scrlayer-scrpage.option.plainheadsepline} for information
+\DescPageRef{scrlayer-scrpage.option.headsepline} and
+\DescPageRef{scrlayer-scrpage.option.plainheadsepline} for information
about those options.%
-\EndIndex{Option}{footsepline}%
-\EndIndex{Option}{headsepline}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{pagemark}\\
+ \Macro{pagemark}%
\Macro{letterpagemark}
\end{Declaration}
-\BeginIndex{Cmd}{pagemark}%
-\BeginIndex{Cmd}{letterpagemark}%
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
@@ -1412,23 +1349,22 @@ defines a new command \Macro{letterpagemark} with the prefix and lets
\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}[belowskip=\dp\strutbox]
+\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}.%
-\EndIndex{Cmd}{letterpagemark}%
-\EndIndex{Cmd}{pagemark}%
-%
+\EndIndexGroup
%
-\EndIndex{}{page>style}
+\EndIndexGroup
\section{Differences in the Handling of \File{lco}-Files in
\Package{scrletter}}
\seclabel{lcoatscrletter}
+\BeginIndexGroup
\BeginIndex{File}{lco}
\BeginIndex{}{letter>class option}%
\BeginIndex{}{letter class option}%
@@ -1440,27 +1376,22 @@ the optional argument of \Macro{documentclass}. Package \Package{scrletter}
does not support this.
\begin{Declaration}
- \Macro{LoadLetterOption}\Parameter{name}\\
+ \Macro{LoadLetterOption}\Parameter{name}%
\Macro{LoadLetterOptions}\Parameter{list of names}
\end{Declaration}
-\BeginIndex{Cmd}{LoadLetterOption}%
-\BeginIndex{Cmd}{LoadLetterOptions}%
For \Class{scrlttr2} it is only recommended to load \File{lco}-files using
-\Macro{LoadLetterOption} or \Macro{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}.%
-\EndIndex{Cmd}{LoadLetterOptions}%
-\EndIndex{Cmd}{LoadLetterOption}%
+\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}.%
+\EndIndexGroup
%
-\EndIndex{}{lco-file=\File{lco}-file}%
-\EndIndex{}{letter class option}%
-\EndIndex{}{letter>class option}%
-%
-\EndIndex{Package}{scrletter}%
+\EndIndexGroup
\section{\File{lco}-Files for Experienced Users}
\seclabel{lcoFile}
+\BeginIndexGroup
\BeginIndex{File}{lco}%
\BeginIndex{}{lco-file=\File{lco}-file}%
@@ -1489,7 +1420,6 @@ paper size.
\Macro{LetterOptionNeedsPapersize}%
\Parameter{option name}\Parameter{paper size}
\end{Declaration}
-\BeginIndex{Cmd}{LetterOptionNeedsPapersize}
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
@@ -1498,7 +1428,7 @@ 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 \Macro{opening} command will only check the last given \PName{paper
+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.
\iffalse% Umbruchoptimierung
@@ -1533,11 +1463,12 @@ forget about this option and skip the example.%
\fi%
\end{Example}
%
-\EndIndex{Cmd}{LetterOptionNeedsPapersize}
+\EndIndexGroup
\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
@@ -1557,7 +1488,6 @@ and \Package{graphicx}\IndexPackage{graphicx}, that are not part of
\begin{Declaration}
\Macro{showfields}\Parameter{field list}
\end{Declaration}
-\BeginIndex{Cmd}{showfields}%
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:
@@ -1575,23 +1505,22 @@ visualized. Following are the supported fields:
\item[\PValue{location}] is the field of the sender's extension.
\item[\PValue{refline}] is the business line. This are has an open bottom.
\end{labeling}%
-\BeginIndex{FontElement}{field}%
+\BeginIndex{FontElement}{field}\LabelFontElement{field}%
The color of the visualization may be changed using
-commands\Macro{setkomafont} und \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}) with the element
+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
\Macro{normalcolor}.%
\EndIndex{FontElement}{field}%
%
-\EndIndex{Cmd}{showfields}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{setshowstyle}\Parameter{visualization style}\\
+ \Macro{setshowstyle}\Parameter{visualization style}%
\Macro{edgesize}
\end{Declaration}
-\BeginIndex{Cmd}{setshowstyle}%
-\BeginIndex{Cmd}{edgesize}
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
@@ -1603,24 +1532,18 @@ 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}.%
-\EndIndex{Cmd}{edgesize}%
-\EndIndex{Cmd}{setshowstyle}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{showenvelope}(\PName{width},\PName{height})%
- (\PName{h-offset},\PName{v-offset})%
- \OParameter{instructions}\\
- \Macro{showISOenvelope}\Parameter{format}\OParameter{instructions}\\
- \Macro{showUScommercial}\Parameter{format}\OParameter{instructions}\\
- \Macro{showUScheck}\OParameter{instructions}\\
+ \Macro{showenvelope}\AParameter{width\textup{,}height}%
+ \AParameter{h-offset\textup{,}v-offset}%
+ \OParameter{instructions}%
+ \Macro{showISOenvelope}\Parameter{format}\OParameter{instructions}%
+ \Macro{showUScommercial}\Parameter{format}\OParameter{instructions}%
+ \Macro{showUScheck}\OParameter{instructions}%
\Macro{unitfactor}
\end{Declaration}
-\BeginIndex{Cmd}{showenvelope}%
-\BeginIndex{Cmd}{showISOenvelope}%
-\BeginIndex{Cmd}{showUScommercial}%
-\BeginIndex{Cmd}{showUScheck}%
-\BeginIndex{Cmd}{unitfactor}%
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
@@ -1643,22 +1566,22 @@ envelopes in format US-check.
The \PName{instructions} may be used to print additional elements inside the
envelope.
-\BeginIndex{FontElement}{letter}%
+\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
-\Macro{setkomafont} und \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}) with element
+\DescRef{scrlttr2.cmd.setkomafont} und \DescRef{scrlttr2.cmd.addtokomafont}
+(see \autoref{sec:scrlttr2.textmarkup},
+\DescPageRef{scrlttr2.cmd.setkomafont}) with element
\FontElement{letter}\important{\FontElement{letter}}. Default is
\Macro{normalcolor}.%
%
\EndIndex{FontElement}{letter}%
-\BeginIndex{FontElement}{measure}%
+\BeginIndex{FontElement}{measure}\LabelFontElement{measure}%
The envelope will be dimensioned automatically. The color of the dimensioning
-may be changed using commands \Macro{setkomafont} und \Macro{addtokomafont}
-(see \autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}) with element
+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
@@ -1712,20 +1635,16 @@ 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
limitations of \TeX.
%
-\EndIndex{Cmd}{unitfactor}%
-\EndIndex{Cmd}{showUScheck}%
-\EndIndex{Cmd}{showUScommercial}%
-\EndIndex{Cmd}{showISOenvelope}%
-\EndIndex{Cmd}{showenvelope}%
+\EndIndexGroup
%
-\EndIndex{Option}{visualize}%
+\EndIndexGroup
%
-\EndIndex{}{lco-file=\File{lco}-file}%
-\EndIndex{File}{lco}%
+\EndIndexGroup
\section{Language Support}
\seclabel{languages}%
+\BeginIndexGroup
\BeginIndex{}{language}%
The document class \Class{scrlttr2} supports many languages. These include
@@ -1761,12 +1680,12 @@ 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 \Macro{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.
+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
@@ -1796,37 +1715,24 @@ 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{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}
-\BeginIndex{Cmd}{captionsenglish}\BeginIndex{Cmd}{captionsUSenglish}%
-\BeginIndex{Cmd}{captionsamerican}\BeginIndex{Cmd}{captionsbritish}%
-\BeginIndex{Cmd}{captionsUKenglish}%
-\BeginIndex{Cmd}{captionsgerman}\BeginIndex{Cmd}{captionsngerman}%
-\BeginIndex{Cmd}{captionsaustrian}\BeginIndex{Cmd}{captionsnaustrian}%
-\BeginIndex{Cmd}{captionsfrench}%
-\BeginIndex{Cmd}{captionsitalian}%
-\BeginIndex{Cmd}{captionsspanish}%
-\BeginIndex{Cmd}{captionsdutch}%
-\BeginIndex{Cmd}{captionscroatian}%
-\BeginIndex{Cmd}{captionsfinnish}%
-\BeginIndex{Cmd}{captionsnorsk}%
-\BeginIndex{Cmd}{captionsswedish}%
If one switches the language of a letter then
using these commands the language-dependent terms from
\autoref{tab:scrlttr2-experts.languageTerms},
@@ -1834,54 +1740,32 @@ using these commands the language-dependent terms from
language selection scheme does not support this then the commands
above can be used directly.
%
-\EndIndex{Cmd}{captionsswedish}%
-\EndIndex{Cmd}{captionsnorsk}%
-\EndIndex{Cmd}{captionsenglish}\EndIndex{Cmd}{captionsUSenglish}%
-\EndIndex{Cmd}{captionsamerican}\EndIndex{Cmd}{captionsbritish}%
-\EndIndex{Cmd}{captionsUKenglish}\EndIndex{Cmd}{captionsgerman}%
-\EndIndex{Cmd}{captionsngerman}%
-\EndIndex{Cmd}{captionsaustrian}\EndIndex{Cmd}{captionsnaustrian}%
-\EndIndex{Cmd}{captionsfrench}%
-\EndIndex{Cmd}{captionsitalian}\EndIndex{Cmd}{captionsspanish}%
-\EndIndex{Cmd}{captionsdutch}\EndIndex{Cmd}{captionscroatian}%
-\EndIndex{Cmd}{captionsfinnish}%
+\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{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}
-\BeginIndex{Cmd}{dateenglish}\BeginIndex{Cmd}{dateUSenglish}%
-\BeginIndex{Cmd}{dateamerican}\BeginIndex{Cmd}{datebritish}%
-\BeginIndex{Cmd}{dateUKenglish}\BeginIndex{Cmd}{dategerman}%
-\BeginIndex{Cmd}{datengerman}%
-\BeginIndex{Cmd}{dateaustrian}\BeginIndex{Cmd}{datenaustrian}%
-\BeginIndex{Cmd}{datefrench}%
-\BeginIndex{Cmd}{dateitalian}\BeginIndex{Cmd}{datespanish}%
-\BeginIndex{Cmd}{datedutch}\BeginIndex{Cmd}{datecroatian}%
-\BeginIndex{Cmd}{datefinnish}%
-\BeginIndex{Cmd}{datenorsk}%
-\BeginIndex{Cmd}{dateswedish}%
The numerical representation of the date\Index{date} (see option
-\Option{numericaldate} in \autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.numericaldate}) will be
-written depending on the selected language. Some examples can be found
-in \autoref{tab:date}.%
+\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
@@ -1915,54 +1799,35 @@ in \autoref{tab:date}.%
\label{tab:date}
\end{table}
%
-\EndIndex{Cmd}{dateswedish}%
-\EndIndex{Cmd}{datenorsk}%
-\EndIndex{Cmd}{dateenglish}\EndIndex{Cmd}{dateUSenglish}%
-\EndIndex{Cmd}{dateamerican}\EndIndex{Cmd}{datebritish}%
-\EndIndex{Cmd}{dateUKenglish}\EndIndex{Cmd}{dategerman}%
-\EndIndex{Cmd}{datengerman}%
-\EndIndex{Cmd}{dateaustrian}\EndIndex{Cmd}{datenaustrian}%
-\EndIndex{Cmd}{datefrench}%
-\EndIndex{Cmd}{dateitalian}\EndIndex{Cmd}{datespanish}%
-\EndIndex{Cmd}{datedutch}\EndIndex{Cmd}{datecroatian}%
-\EndIndex{Cmd}{datefinnish}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{yourrefname}\\
- \Macro{yourmailname}\\
- \Macro{myrefname}\\
- \Macro{customername}\\
- \Macro{invoicename}\\
- \Macro{subjectname}\\
- \Macro{ccname}\\
- \Macro{enclname}\\
- \Macro{headtoname}\\
- \Macro{headfromname}\\
- \Macro{datename}\\
- \Macro{pagename}\\
- \Macro{phonename}\\
- \Macro{faxname}\\
- \Macro{emailname}\\
- \Macro{wwwname}\\
+ \Macro{yourrefname}%
+ \Macro{yourmailname}%
+ \Macro{myrefname}%
+ \Macro{customername}%
+ \Macro{invoicename}%
+ \Macro{subjectname}%
+ \Macro{ccname}%
+ \Macro{enclname}%
+ \Macro{headtoname}%
+ \Macro{headfromname}%
+ \Macro{datename}%
+ \Macro{pagename}%
+ \Macro{mobilephonename}%
+ \Macro{phonename}%
+ \Macro{faxname}%
+ \Macro{emailname}%
+ \Macro{wwwname}%
\Macro{bankname}
\end{Declaration}
-\BeginIndex{Cmd}{yourrefname}\BeginIndex{Cmd}{yourmailname}%
-\BeginIndex{Cmd}{myrefname}%
-\BeginIndex{Cmd}{customername}\BeginIndex{Cmd}{invoicename}%
-\BeginIndex{Cmd}{subjectname}%
-\BeginIndex{Cmd}{ccname}\BeginIndex{Cmd}{enclname}%
-\BeginIndex{Cmd}{headtoname}\BeginIndex{Cmd}{headfromname}%
-\BeginIndex{Cmd}{datename}\BeginIndex{Cmd}{pagename}%
-\BeginIndex{Cmd}{phonename}\BeginIndex{Cmd}{faxname}%
-\BeginIndex{Cmd}{emailname}\BeginIndex{Cmd}{wwwname}%
-\BeginIndex{Cmd}{bankname}%
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]{%
- \Macro{newcaptionname}\\
- \Macro{renewcaptionname}\\
- \Macro{providecaptionname}} this can be done is described in
+ \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
@@ -1999,6 +1864,7 @@ How\important[i]{%
\Macro{invoicename} & Invoice no. & Rechnungsnummer \\
\Macro{myrefname} & Our ref. & Unser Zeichen \\
\Macro{pagename}\footnotemark[1] & Page & Seite \\
+ \Macro{mobilephonename} & Mobile phone & Mobiltelefon \\
\Macro{phonename} & Phone & Telefon \\
\Macro{subjectname} & Subject & Betrifft \\
\Macro{wwwname} & Url & URL \\
@@ -2014,22 +1880,12 @@ How\important[i]{%
\end{minipage}
\end{table}
%
-\EndIndex{Cmd}{yourrefname}\EndIndex{Cmd}{yourmailname}%
-\EndIndex{Cmd}{myrefname}%
-\EndIndex{Cmd}{customername}\EndIndex{Cmd}{invoicename}%
-\EndIndex{Cmd}{subjectname}%
-\EndIndex{Cmd}{ccname}\EndIndex{Cmd}{enclname}%
-\EndIndex{Cmd}{headtoname}\EndIndex{Cmd}{headfromname}%
-\EndIndex{Cmd}{datename}\EndIndex{Cmd}{pagename}%
-\EndIndex{Cmd}{phonename}\EndIndex{Cmd}{faxname}%
-\EndIndex{Cmd}{emailname}\EndIndex{Cmd}{wwwname}%
-\EndIndex{Cmd}{bankname}%
+\EndIndexGroup
%
-\EndIndex{}{language}
+\EndIndexGroup
\section{From Obsolete \Class{scrlettr} to Current \Class{scrlttr2}}
\seclabel{fromscrlettr}
-\BeginIndex{Class}{scrlettr}
With\textnote{Attention!} the June 2002 release of \Class{scrlttr2} (see
\autoref{cha:scrlttr2}) the old letter class \Class{scrlettr} became
@@ -2038,7 +1894,7 @@ 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}[belowskip=\dp\strutbox,morekeywords={latex,mkindex}]
+\begin{lstoutput}[morekeywords={latex,mkindex}]
latex scrlettr.dtx
mkindex scrlettr
latex scrlettr.dtx
@@ -2057,8 +1913,8 @@ this option are provided in \autoref{sec:scrlttr2.lcoFile},
\autoref{tab:lcoFiles}.
\LoadNonFree{scrlttr2-experts}{0}
-
-\EndIndex{Class}{scrlettr}%
+%
+\EndIndexGroup
\endinput