summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex1671
1 files changed, 729 insertions, 942 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
index c2b92f9e897..ef26c720cab 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-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.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,18 +46,20 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2.tex}%
- [$Date: 2015-12-17 11:57:09 +0100 (Thu, 17 Dec 2015) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (chapter: scrlttr2)]
\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe
Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm}
-% Date of translated german file: 2015-12-17
+% Date of the translated German file: 2017-01-02
\chapter{The New Letter Class \Class{scrlttr2}}
\labelbase{scrlttr2}
+\BeginIndexGroup%
+\BeginIndex{Class}{scrlttr2}%
+\BeginIndex{}{letters}%
-\BeginIndex{Class}{scrlttr2}\BeginIndex{}{letters}%
\iffalse
Since the June 2002 release {\KOMAScript} provides a completely
rewritten letter class\ChangedAt{v2.8q}{\Class{scrlttr2}}. Although
@@ -78,13 +80,14 @@ users will benefit from its advantages.
\section{Variables}
\seclabel{variables}%
+\BeginIndexGroup
\BeginIndex{}{variables}
Apart from options, commands, environments, counters and lengths,
additional elements have already been introduced in \KOMAScript. A
typical property of an element is the font style and the option to
-change it (see \autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}). At this point we now
+change it (see \autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). At this point we now
introduce variables. Variables have a name by which they are called,
and they have a content. The content of a variable can be set
independently from time and location of the actual usage in the same
@@ -98,202 +101,200 @@ This section specifically only gives an introduction to the concept of
variables. The following examples have no special meaning. More
detailed examples can be found in the explanation of predefined
variables of the letter class in the following sections. An overview
-of all variables is given in \autoref{tab:scrlttr2.variables}.
+of all variables is given in \autoref{tab:\LabelBase.variables}.
%
\begin{desclist}
% Umbruchkorrektur
\renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
\desccaption{%
Alphabetical list of all supported variables in
- \Class{scrlttr2}\label{tab:scrlttr2.variables}%
+ \Class{scrlttr2}\label{tab:\LabelBase.variables}%
}{%
Alphabetical list of all supported variables in \Class{scrlttr2}
(\emph{continuation})%
}%
\ventry{addresseeimage}{%
instuctions, that will be used to print the Port-Pay\'e head of option
- \OptionValue{addrfield}{backgroundimage} or the Port-Pay\'e addressee of
- option \OptionValue{addrfield}{image} %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.addresseeimage})}%
+ \OptionValueRef{\LabelBase}{addrfield}{backgroundimage} or the Port-Pay\'e
+ addressee of option \OptionValueRef{\LabelBase}{addrfield}{image} %
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.addresseeimage})}%
\ventry{backaddress}{%
return address for window envelopes %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.backaddress})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.backaddress})}%
\ventry{%
backaddressseparator}{separator within the return address %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.backaddressseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.backaddressseparator})}%
\ventry{ccseparator}{%
separator between title of additional addressees, and additional
addressees %
- (\autoref{sec:scrlttr2.document},
- \autopageref{desc:scrlttr2.variable.ccseparator})}%
+ (\autoref{sec:\LabelBase.document},
+ \DescPageRef{\LabelBase.variable.ccseparator})}%
\ventry{customer}{%
customer number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.customer})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.customer})}%
\ventry{date}{%
date %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.date})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.date})}%
\ventry{emailseparator}{%
separator between e-mail name and e-mail address %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.emailseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.emailseparator})}%
\ventry{enclseparator}{%
separator between title of enclosure, and enclosures %
- (\autoref{sec:scrlttr2.document},
- \autopageref{desc:scrlttr2.variable.enclseparator})}%
+ (\autoref{sec:\LabelBase.document},
+ \DescPageRef{\LabelBase.variable.enclseparator})}%
\ventry{faxseparator}{%
separator between title of fax, and fax number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.faxseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.faxseparator})}%
\ventry{firstfoot}{%
page\ChangedAt{v3.08}{\Class{scrlttr2}} foot of the note paper %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.firstfoot})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.firstfoot})}%
\ventry{firsthead}{%
page\ChangedAt{v3.08}{\Class{scrlttr2}} head of the note paper %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.firsthead})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.firsthead})}%
\ventry{fromaddress}{%
sender's address without sender name %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromaddress})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromaddress})}%
\ventry{frombank}{%
sender's bank account %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.frombank})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.frombank})}%
\ventry{fromemail}{%
sender's e-mail %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromemail})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromemail})}%
\ventry{fromfax}{%
sender's fax number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromfax})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromfax})}%
\ventry{fromlogo}{%
commands for inserting the sender's logo %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromlogo})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromlogo})}%
\ventry{frommobilephone}{%
\ChangedAt{v3.12}{\Class{scrlttr2}}%
sender's mobile telephone number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.frommobilephone})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.frommobilephone})}%
\ventry{fromname}{%
complete name of sender %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromname})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromname})}%
\ventry{fromphone}{%
sender's telephone number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromphone})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromphone})}%
\ventry{fromurl}{%
a URL of the sender, e.\,g., the URL of his homepage %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromurl})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromurl})}%
\ventry{fromzipcode}{%
zip code or postcode of the sender used at the Port-Pay\'e head of option
- \OptionValue{addrfield}{PP} %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromzipcode})}%
+ \OptionValueRef{\LabelBase}{addrfield}{PP} %
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromzipcode})}%
\ventry{invoice}{%
invoice number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.invoice})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.invoice})}%
\ventry{location}{%
more details of the sender %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.location})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.location})}%
\ventry{myref}{%
sender's reference %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.myref})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.myref})}%
\ventry{nextfoot}{%
page\ChangedAt{v3.08}{\Class{scrlttr2}} foot using page style
- \Pagestyle{headings}\IndexPagestyle{headings} or
- \Pagestyle{myheadings}\IndexPagestyle{myheadings} %
- (\autoref{sec:scrlttr2.pagestyle},
- \autopageref{desc:scrlttr2.variable.nextfoot})}%
+ \PageStyle{headings}\IndexPagestyle{headings} or
+ \PageStyle{myheadings}\IndexPagestyle{myheadings} %
+ (\autoref{sec:\LabelBase.pagestyle},
+ \DescPageRef{\LabelBase.variable.nextfoot})}%
\ventry{nexthead}{%
page\ChangedAt{v3.08}{\Class{scrlttr2}} head using page style
- \Pagestyle{headings}\IndexPagestyle{headings} or
- \Pagestyle{myheadings}\IndexPagestyle{myheadings} %
- (\autoref{sec:scrlttr2.pagestyle},
- \autopageref{desc:scrlttr2.variable.nexthead})}%
+ \PageStyle{headings}\IndexPagestyle{headings} or
+ \PageStyle{myheadings}\IndexPagestyle{myheadings} %
+ (\autoref{sec:\LabelBase.pagestyle},
+ \DescPageRef{\LabelBase.variable.nexthead})}%
\ventry{phoneseparator}{%
separator between title of telephone and telephone number %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.phoneseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.phoneseparator})}%
\ventry{place}{%
sender's place used near date %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.place})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.place})}%
\ventry{placeseparator}{%
separator between place and date %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.placeseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.placeseparator})}%
\ventry{PPdatamatrix}{%
instruction, that print the data array of option
- \OptionValue{addrfield}{PP} %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.PPdatamatrix})}%
+ \OptionValueRef{\LabelBase}{addrfield}{PP} %
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.PPdatamatrix})}%
\ventry{PPcode}{%
instructions for the sender's identification code of option
- \OptionValue{addrfield}{PP} %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.PPcode})}%
+ \OptionValueRef{\LabelBase}{addrfield}{PP} %
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.PPcode})}%
\ventry{signature}{%
signature beneath the ending of the letter %
- (\autoref{sec:scrlttr2.closing},
- \autopageref{desc:scrlttr2.variable.signature})}%
+ (\autoref{sec:\LabelBase.closing},
+ \DescPageRef{\LabelBase.variable.signature})}%
\ventry{specialmail}{%
mode of dispatch %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.specialmail})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.specialmail})}%
\ventry{subject}{%
letter's subject %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.subject})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.subject})}%
\ventry{subjectseparator}{%
separator between title of subject and subject %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.subjectseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.subjectseparator})}%
\ventry{title}{%
letter title %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.title})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.title})}%
\ventry{toaddress}{%
address of addressee without addressee name %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.toaddress})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.toaddress})}%
\ventry{toname}{%
complete name of addressee %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.toname})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.toname})}%
\ventry{yourmail}{%
date of addressee's referenced mail %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.yourmail})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.yourmail})}%
\ventry{yourref}{%
addressee's reference %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.yourref})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.yourref})}%
\ventry{zipcodeseparator}{%
separator between the zip code's or postcode's title and the code itself %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.zipcodeseparator})}%
+ (\autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.zipcodeseparator})}%
\end{desclist}
\begin{Declaration}
\Macro{setkomavar}%
- \Parameter{name}\OParameter{description}\Parameter{content}\\
+ \Parameter{name}\OParameter{description}\Parameter{content}%
\Macro{setkomavar*}\Parameter{name}\Parameter{description}
\end{Declaration}
-\BeginIndex{Cmd}{setkomavar}%
-\BeginIndex{Cmd}{setkomavar*}%
With the command \Macro{setkomavar} you determine the
\PName{content} of the variable \PName{name}. Using an optional
argument you can at the same time change the \PName{description}
@@ -334,15 +335,13 @@ empty \PName{description} argument.
one command.
\end{Example}
%
-\EndIndex{Cmd}{setkomavar}%
-\EndIndex{Cmd}{setkomavar*}%
+\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*}%
In\ChangedAt{v2.9i}{\Class{scrlttr2}} some cases it is necessary for the user
to access the content or the description of a variable, and not to leave this
only up to the class. This is specially important when you have defined a
@@ -350,16 +349,14 @@ variable which is not added to the reference fields line. Using the command
\Macro{usekomavar} you have access to the content of the variable
\PName{name}, whereas the starred version \Macro{usekomavar*} allows you to
access the description or title. In \autoref{sec:scrlttr2-experts.variables},
-\autopageref{desc:scrlttr2-experts.cmd.newkomavar} you may find more
+\DescPageRef{scrlttr2-experts.cmd.newkomavar} you may find more
information about defining variable on your own.%
-\EndIndex{Cmd}{usekomavar}%
-\EndIndex{Cmd}{usekomavar*}%
+\EndIndexGroup
\begin{Declaration}
\Macro{ifkomavar}\Parameter{name}\Parameter{true-code}\Parameter{false-code}
\end{Declaration}
-\BeginIndex{Cmd}{ifkomavar}%
This\ChangedAt{v3.03}{\Class{scrlttr2}} command may be used to test, whether
or not a variable has already been defined. The \PName{true-code} will be
executed only, if the variable already exists. The contents of the variable
@@ -367,35 +364,33 @@ will not be examined, so it may be empty. The \PName{false-code} will be
executed if the variable does not yet exist. Such tests make sense if a
variable will be defined at one
\File{lco}-file\Index{lco-file=\File{lco}-file} (see
-\autoref{sec:scrlttr2.lcoFile} from \autopageref{sec:scrlttr2.lcoFile}
+\autoref{sec:\LabelBase.lcoFile} from \autopageref{sec:\LabelBase.lcoFile}
onward), but used in another \File{lco}-file if it exists only.%
%
-\EndIndex{Cmd}{ifkomavar}%
+\EndIndexGroup
\begin{Declaration}
\Macro{ifkomavarempty}\Parameter{name}\Parameter{true-code}%
- \Parameter{false-code}\\
+ \Parameter{false-code}%
\Macro{ifkomavarempty*}\Parameter{name}\Parameter{true-code}%
\Parameter{false-code}
\end{Declaration}
-\BeginIndex{Cmd}{ifkomavarempty}%
-\BeginIndex{Cmd}{ifkomavarempty*}%
With\ChangedAt{v2.9i}{\Class{scrlttr2}} these commands you may check
whether or not the expanded content or description of a variable is
empty. The \PName{true-code} will be executed if the content or
description is empty. Otherwise the \PName{false-code} will be
executed. The starred variant handles the description of a variable,
the unstarred variant handles the contents.%
-\EndIndex{Cmd}{ifkomavarempty*}%
-\EndIndex{Cmd}{ifkomavarempty}%
+\EndIndexGroup
%
-\EndIndex{}{variables}%
+\EndIndexGroup
\section{Pseudo-Lengths}
\seclabel{pseudoLength}
+\BeginIndexGroup
\BeginIndex{}{pseudo-lengths}
\LaTeX{} processes length with commands \Macro{newlength}, \Macro{setlength},
\Macro{addtolength}, and \Macro{the\PName{length}}. Many packages also use
@@ -417,9 +412,9 @@ sections of this chapter.
Normally users would not need to define a pseudo-length on their own. Because
of this, definition of pseudo-lengths will be described in the expert part at
\autoref{sec:scrlttr2-experts.pseudoLengths},
-\autopageref{desc:scrlttr2-experts.cmd.@newplength}. Setting pseudo-lengths to
+\DescPageRef{scrlttr2-experts.cmd.@newplength}. Setting pseudo-lengths to
new values is also a work for advanced users. So this will be described in the
-expert part too at \autopageref{desc:scrlttr2-experts.cmd.@setplength}.
+expert part too at \DescPageRef{scrlttr2-experts.cmd.@setplength}.
Please note\textnote{Attention!}: Even though these pseudo-lengths are
internally implemented as macros, the commands for pseudo-length management
@@ -431,24 +426,21 @@ or \LaTeX{} lengths.
\begin{Declaration}
\Macro{useplength}\Parameter{name}
\end{Declaration}
-\BeginIndex{Cmd}{useplength}%
Using this command you can access the value of the pseudo-length with
the given \PName{name}. This is one of the few user commands in
connection with pseudo-lengths. Of course this command can also be
used with an \File{lco}-file\Index{lco-file=\File{lco}-file} (see
-\autoref{sec:scrlttr2.lcoFile} ab \autopageref{sec:scrlttr2.lcoFile}).%
+\autoref{sec:\LabelBase.lcoFile} ab \autopageref{sec:\LabelBase.lcoFile}).%
%
-\EndIndex{Cmd}{useplength}%
+\EndIndexGroup
\begin{Declaration}
\Macro{setlengthtoplength}%
- \OParameter{factor}\Parameter{length}\Parameter{pseudo-length}\\
+ \OParameter{factor}\Parameter{length}\Parameter{pseudo-length}%
\Macro{addtolengthplength}%
\OParameter{factor}\Parameter{length}\Parameter{pseudo-length}
\end{Declaration}
-\BeginIndex{Cmd}{setlengthtoplength}%
-\BeginIndex{Cmd}{addtolengthplength}%
\begin{Explain}%
While you can simply prepend a factor to a length, this is not
possible with pseudo-lengths. Suppose you have a length \Macro{test}
@@ -468,20 +460,19 @@ to a \PName{length}. In this case you can either use a minus sign or
\Macro{addtolengthplength} works very similarly; it adds the multiple
of a \PName{pseudo-length} to the \PName{length}.
%
-\EndIndex{Cmd}{setlengthtoplength}%
-\EndIndex{Cmd}{addtolengthplength}%
+\EndIndexGroup
%
-\EndIndex{}{pseudo-lengths}
+\EndIndexGroup
-\LoadCommon[scrlttr]{0} % \section{Early or Late Selection of Options}
+\LoadCommonFile{options} % \section{Early or Late Selection of Options}
-\LoadCommon[scrlttr]{1} % \section{Compatibility with Earlier Versions of
+\LoadCommonFile{compatibility} % \section{Compatibility with Earlier Versions of
% \KOMAScript{}}
-\LoadCommon[scrlttr]{2} % \section{Draft-Mode}
+\LoadCommonFile{draftmode} % \section{Draft-Mode}
-\LoadCommon[scrlttr]{3} % \section{Page Layout}
+\LoadCommonFile{typearea} % \section{Page Layout}
Normally it makes no sense to distinguish letters with single-side layout and
letters with double-side layout. Mostly letters are not bound like
@@ -489,19 +480,20 @@ books. Therefor each page will be viewed on its own. This is also true if both
sides of the paper sheet will be used for printing. Vertical adjustment is
unusual at letters too. Nevertheless, if you need or want it, you may read the
description of \Macro{raggedbottom} and \Macro{flushbottom} in
-\autoref{sec:maincls.typearea} at \autopageref{desc:maincls.cmd.flushbottom}.%
+\autoref{sec:maincls.typearea} at \DescPageRef{maincls.cmd.flushbottom}.%
%
-\EndIndex{}{page>layout}
+\EndIndexGroup
\section{General Structure of Letter Documents}
\seclabel{document}
+\BeginIndexGroup
\BeginIndex{}{letter>structure}
The general structure of a letter document differs somewhat from the
structure of a normal document. Whereas a book document in general
contains only one book, a letter document can contain several
-letters. As illustrated in \autoref{fig:scrlttr2.document}, a letter
+letters. As illustrated in \autoref{fig:\LabelBase.document}, a letter
document consists of a preamble, the individual letters, and the
closing.
@@ -513,8 +505,8 @@ closing.
}]{%
General structure of a letter document with several individual letters
(the structure of a single letter is shown in
- \autoref{fig:scrlttr2.letter})%
- \label{fig:scrlttr2.document}%
+ \autoref{fig:\LabelBase.letter})%
+ \label{fig:\LabelBase.document}%
}[l]
\begin{minipage}[b]{.667\linewidth}
\centering\small\setlength{\fboxsep}{1.5ex}%
@@ -547,9 +539,9 @@ closing.
The preamble comprises all settings that in general concern all letters. Most
of them can also be overwritten in the settings of the individual letters. The
only setting which can not be changed within a single letter is compatibility
-to prior versions of \Class{scrlttr2} (see option \Option{version} in
-\autoref{sec:scrlttr2.compatibilityOptions},
-\autopageref{desc:scrlttr2.option.version}).
+to prior versions of \Class{scrlttr2} (see option \DescRef{\LabelBase.option.version} in
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}).
It is recommended that only general settings such as the loading of packages
and the setting of options be placed before
@@ -570,8 +562,8 @@ additional comments at this point.
General structure of a single letter within a letter document%
}]{%
General structure of a single letter within a letter document (see also
- \autoref{fig:scrlttr2.document})%
- \label{fig:scrlttr2.letter}}[l]
+ \autoref{fig:\LabelBase.document})%
+ \label{fig:\LabelBase.letter}}[l]
\begin{minipage}[b]{.667\linewidth}%
\centering\small\setlength{\fboxsep}{1.5ex}%
\addtolength{\linewidth}{-\dimexpr2\fboxrule+2\fboxsep\relax}%
@@ -581,7 +573,7 @@ additional comments at this point.
\dots\\[\dp\strutbox]
{\centering\emph{settings for this letter}\\}
\dots\\
- \Macro{opening}\Parameter{opening}\\
+ \DescRef{\LabelBase.cmd.opening}\Parameter{opening}\\
}}\\[1pt]
\fbox{\parbox{\linewidth}{\raggedright%
\dots\\[\dp\strutbox]
@@ -589,25 +581,25 @@ additional comments at this point.
\dots\\
}}\\[1pt]
\fbox{\parbox{\linewidth}{\raggedright%
- \Macro{closing}\Parameter{closing}\\
- \Macro{ps}\\
+ \DescRef{\LabelBase.cmd.closing}\Parameter{closing}\\
+ \DescRef{\LabelBase.cmd.ps}\\
\dots\\[\dp\strutbox]
{\centering\emph{postscript}\\}
\dots\\
- \Macro{encl}\Parameter{enclosures}\\
- \Macro{cc}\Parameter{additional addressees}\\
+ \DescRef{\LabelBase.cmd.encl}\Parameter{enclosures}\\
+ \DescRef{\LabelBase.cmd.cc}\Parameter{additional addressees}\\
\Macro{end}\PParameter{letter}\\
}}\\[\dimexpr\fboxsep+\fboxrule\relax]
\end{minipage}
\end{captionbeside}
\end{figure}
-As shown in \autoref{fig:scrlttr2.letter}, every single letter itself consists
+As shown in \autoref{fig:\LabelBase.letter}, every single letter itself consists
of an introduction, the letter body, and the closing. In the introduction, all
settings pertaining only to the current letter are defined. It is important
that this introduction always ends with
-\Macro{opening}\IndexCmd{opening}. Similarly, the closing always starts with
-\Macro{closing}\IndexCmd{closing}. The two arguments \PName{opening} and
+\DescRef{\LabelBase.cmd.opening}\IndexCmd{opening}. Similarly, the closing always starts with
+\DescRef{\LabelBase.cmd.closing}\IndexCmd{closing}. The two arguments \PName{opening} and
\PName{closing} can be left empty, but both commands must be used and must
have an argument.
@@ -618,18 +610,15 @@ recommended to use further general settings with limited scope between the
letters.
\begin{Declaration}
- \XMacro{begin}\PParameter{\Environment{letter}}%
- \OParameter{options}\Parameter{addressee}\\
- \quad\dots\\
- \XMacro{end}\PParameter{letter}
+ \begin{Environment}{letter}\OParameter{options}\Parameter{addressee}
+ \end{Environment}
\end{Declaration}
-\BeginIndex{Env}{letter}%
\BeginIndex{}{addressee}%
The \Environment{letter} environment is one of the key environments of the
letter class. A special\textnote{\KOMAScript{} vs. standard classes}
\Class{scrlttr2} feature are optional arguments to the \Environment{letter}
environment. These \PName{options} are executed internally via the
-\Macro{KOMAoptions} command.
+\DescRef{\LabelBase.cmd.KOMAoptions} command.
The \PName{addressee} is a mandatory argument passed to the
\Environment{letter} environment. Parts\textnote{Attention!} of the addressee
@@ -641,7 +630,7 @@ could lead to unexpected results and error messages, as is the case also for
the standard letter class.
\begin{Example}
- \phantomsection\label{desc:scrlttr2.env.letter.example}%
+ \phantomsection\label{desc:\LabelBase.env.letter.example}%
Assumed, someone wants to send a letter to Joana Public. A minimalistic
letter document for this may be:
\begin{lstcode}
@@ -656,19 +645,17 @@ the standard letter class.
\end{lstcode}
However, this would not result in any printable output. At least there
would not be an addressee at the note paper sheet. The reason for this will
- be explained at the description of command \Macro{opening} at
- \autopageref{desc:scrlttr2.cmd.opening}.
+ be explained at the description of command \DescRef{\LabelBase.cmd.opening} at
+ \DescPageRef{\LabelBase.cmd.opening}.
\end{Example}
%
-\EndIndex{}{addressee}%
-\EndIndex{Env}{letter}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{AtBeginLetter}\Parameter{instruction code}\\
+ \Macro{AtBeginLetter}\Parameter{instruction code}%
\Macro{AtEndLetter}\Parameter{instruction code}
\end{Declaration}
-\BeginIndex{Cmd}{AtBeginLetter}%
-\BeginIndex{Cmd}{AtEndLetter}%
{\LaTeX} enables the user to declare \PName{instruction code} whose execution
is delayed until a determined point. Such points are called
\emph{hooks}\Index{hook}. Known macros for using hooks are
@@ -706,27 +693,23 @@ following example may illustrate.
\Package{tabularx}\IndexPackage{tabularx} (see \cite{package:tabularx}).
\end{Example}
%
-\EndIndex{Cmd}{AtEndLetter}%
-\EndIndex{Cmd}{AtBeginLetter}%
+\EndIndexGroup
\begin{Declaration}
- \Counter{letter}\\
- \Macro{thisletter}\\
+ \Counter{letter}%
+ \Macro{thisletter}%
\Macro{letterlastpage}
\end{Declaration}
-\BeginIndex{Counter}{letter}%
-\BeginIndex{Cmd}{thisletter}%
-\BeginIndex{Cmd}{letterlastpage}%
If\ChangedAt{v3.19}{\Class{scrlttr2}\and \Package{scrletter}} you have more
than one letter in one document, it is useful to have a letter number. Since
version~3.19 \KOMAScript{} provides counter \Counter{letter} and increases it
at every \Macro{begin}\PParameter{letter}.
\begin{Example}
- Have one more look into the \Macro{AtBeginLetter} example. Instead of
- resetting the counter explicitly at \Macro{begin}\PParameter{letter}, we can
- do it implicitly by defining counter \Counter{Question} depending on counter
- \Counter{letter}:
+ Have one more look into the \DescRef{\LabelBase.cmd.AtBeginLetter}
+ example. Instead of resetting the counter explicitly at
+ \Macro{begin}\PParameter{letter}, we can do it implicitly by defining
+ counter \Counter{Question} depending on counter \Counter{letter}:
\begin{lstlisting}
\newcounter{Question}[letter]
\newcommand{\Question}[1]{%
@@ -756,15 +739,12 @@ page number of the current letter. Please note, the value of
\Macro{label} and \Macro{pageref}. So you need at least two or three \LaTeX{}
runs, if you use \Macro{letterlastpage}. Please have a look at \emph{Rerun}
terminal or \File{log}-file messages about labels that have been changed.%
-\EndIndex{Cmd}{letterlastpage}%
-\EndIndex{Cmd}{thisletter}%
-\EndIndex{Counter}{letter}%
+\EndIndexGroup
\begin{Declaration}
\Macro{opening}\Parameter{opening}
\end{Declaration}
-\BeginIndex{Cmd}{opening}%
This is one of the most important commands in \Class{scrlttr2}. For the user
it may seem that only the \PName{opening}\Index{letter>opening}, e.\,g.,
``Dear Mrs~\dots'', is typeset, but\textnote{Attention!} the command also
@@ -777,10 +757,10 @@ use an \Macro{opening} command with an empty argument.
\begin{Example}
Let's extend the example from
- \autopageref{desc:scrlttr2.env.letter.example} by an opening:
+ \DescPageRef{\LabelBase.env.letter.example} by an opening:
\lstinputcode[xleftmargin=1em]{letter-0.tex}
This will result in a note paper sheet shown in
- \autoref{fig:scrlttr2.letter-0}.
+ \autoref{fig:\LabelBase.letter-0}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with addressee and opening}]{%
@@ -788,7 +768,7 @@ use an \Macro{opening} command with an empty argument.
(date and folding marks are defaults of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-0}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-0}
+ \label{fig:\LabelBase.letter-0}
\end{figure}
\end{Example}
\iffalse% Umbruchkorrekturtext
@@ -799,26 +779,25 @@ capabilities have been enhanced. Thus personal openings are very common, even
in mass-production advertising letters.%
\fi
%
-\EndIndex{Cmd}{opening}%
+\EndIndexGroup
\begin{Declaration}
\Macro{closing}\Parameter{closing phrase}
\end{Declaration}
-\BeginIndex{Cmd}{closing}%
The main purpose of the command \Macro{closing} is to typeset the
\PName{closing phrase}\Index{closing}. This may even consists of multiple
lines. The lines should be separated by double backslash. Paragraph breaks
inside the \PName{closing phrase} are not allowed.
Beyond that the command also typesets the content of the variable
-\Variable{signature}. More information about the signature and the
-configuration of the signature may be found at \autoref{sec:scrlttr2.closing}
-ab \autopageref{desc:scrlttr2.variable.signature}.
+\DescRef{\LabelBase.variable.signature}. More information about the signature and the
+configuration of the signature may be found at \autoref{sec:\LabelBase.closing}
+ab \DescPageRef{\LabelBase.variable.signature}.
\begin{Example}
Let's extend the our example by some lines of text and a closing phrase:
\lstinputcode[xleftmargin=1em]{letter-1.tex}
- This will result in a the letter shown in \autoref{fig:scrlttr2.letter-1}.
+ This will result in a the letter shown in \autoref{fig:\LabelBase.letter-1}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with addressee, opening, text, and
@@ -827,16 +806,15 @@ ab \autopageref{desc:scrlttr2.variable.signature}.
(date and folding marks are defaults of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-1}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-1}
+ \label{fig:\LabelBase.letter-1}
\end{figure}
\end{Example}
%
-\EndIndex{Cmd}{closing}%
+\EndIndexGroup
\begin{Declaration}
\Macro{ps}
\end{Declaration}%
-\BeginIndex{Cmd}{ps}%
This instruction merely switches to the postscript. Hence, a new
paragraph begins, and a vertical distance\,---\,usually below the
signature\,---\,is inserted. The command \Macro{ps} is followed by
@@ -848,7 +826,7 @@ automatically nor optionally by the class \Class{scrlttr2}.
\begin{Example}
The example letter extended by a postscript
\lstinputcode[xleftmargin=1em]{letter-2.tex}
- results in \autoref{fig:scrlttr2.letter-2}.
+ results in \autoref{fig:\LabelBase.letter-2}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with addressee, opening, text,
@@ -858,7 +836,7 @@ automatically nor optionally by the class \Class{scrlttr2}.
(date and folding marks are defaults of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-2}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-2}
+ \label{fig:\LabelBase.letter-2}
\end{figure}
\end{Example}
@@ -872,15 +850,13 @@ automatically nor optionally by the class \Class{scrlttr2}.
of the particular letter.
\end{Explain}
%
-\EndIndex{Cmd}{ps}
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{cc}\Parameter{distribution list}\\
- \Macro{setkomavar}\PParameter{\Variable{ccseparator}}%
- \OParameter{description}\Parameter{content}
+ \Macro{cc}\Parameter{distribution list}%
+ \Variable{ccseparator}%
\end{Declaration}
-\BeginIndex{Cmd}{cc}%
-\BeginIndex{Variable}{ccseparator}%
With the command \Macro{cc}%
\Index{addressee>additional}\Index{distribution list}\Index{carbon copy} it is
possible to typeset a \PName{distribution list}. The command takes the
@@ -895,7 +871,7 @@ separate the individual entries with a double backslash.
This time, the example letter should be send not only to the chairman, but
also to all club members:
\lstinputcode[xleftmargin=1em]{letter-3.tex}%
- The result is shown in \autoref{fig:scrlttr2.letter-3}.
+ The result is shown in \autoref{fig:\LabelBase.letter-3}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with addressee, opening, text,
@@ -905,22 +881,18 @@ separate the individual entries with a double backslash.
(date and folding marks are defaults of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-3}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-3}
+ \label{fig:\LabelBase.letter-3}
\end{figure}
\end{Example}
In front of the distribution list a vertical gap is inserted automatically.%
%
-\EndIndex{Variable}{ccseparator}%
-\EndIndex{Cmd}{cc}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{encl}\Parameter{enclosures}\\
- \Macro{setkomavar}\PParameter{\Variable{enclseparator}}%
- \OParameter{description}\Parameter{content}
+ \Macro{encl}\Parameter{enclosures}%
+ \Variable{enclseparator}%
\end{Declaration}
-\BeginIndex{Cmd}{encl}%
-\BeginIndex{Variable}{enclseparator}%
The \PName{enclosures} have the same structure as the distribution list.
The only difference is that here the enclosures starts with the name
and content of the variable
@@ -931,7 +903,7 @@ and content of the variable
will be changed also, because there is only one enclosure and the default
may be prepared for several enclosures:
\lstinputcode[xleftmargin=1em]{letter-4.tex}
- This will result in \autoref{fig:scrlttr2.letter-4}.
+ This will result in \autoref{fig:\LabelBase.letter-4}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with addressee, opening, text,
@@ -941,55 +913,22 @@ and content of the variable
(date and folding marks are defaults of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-4}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-4}
+ \label{fig:\LabelBase.letter-4}
\end{figure}
\end{Example}
%
-\EndIndex{Cmd}{encl}%
-\EndIndex{Variable}{enclseparator}%
+\EndIndexGroup
%
-\EndIndex{}{letter>structure}
+\EndIndexGroup
-\section{Selection of Document or Letter Font Size}
-\LoadCommon[scrlttr]{4} % \section{Selection of Document Font Size}
-
-\begin{Example}
- Assumed, the example is a letter to \emph{``The friends of insane font
- sizes''} and therefor it should be printed with 14\Unit{pt} instead of
- 12\Unit{pt}. Only a simple change of the first line is needed:%
- \lstinputcode[xleftmargin=1em]{letter-6}%
- Alternatively the option may be set at the optional argument of the
- \Environment{letter} environment:%
- \lstinputcode[xleftmargin=1em]{letter-5}%
- In the case of this late change of the font size no recalculation of the
- type area will happen. Because of this, the two results of
- \autoref{fig:scrlttr2.letter-5-6} differ.
- \begin{figure}
- \centering
- \frame{\includegraphics[width=.4\textwidth]{letter-5}}\quad
- \frame{\includegraphics[width=.4\textwidth]{letter-6}}
- \caption[{Example: letter with addressee, opening, text,
- closing, postscript, distribution list, enclosure, and insane large
- font size}]{%
- result of a small letter with addressee, opening, text, closing,
- postscript, distribution list, enclosure, and insane large font size
- (date and folding marks are defaults of DIN-letters): at left one the
- font size has been defined by the optional argument of
- \Environment{letter}, at the right one the optional argument of
- \Macro{documentclass} has been used}
- \label{fig:scrlttr2.letter-5-6}
- \end{figure}
-\end{Example}
-%
-\EndIndex{Option}{fontsize~=\PName{size}}%
-%
-\EndIndex{}{font>size}
+\LoadCommonFile{fontsize} % \section{Selection of Document Font Size}
-\LoadCommon[scrlttr]{5} % \section{Text Markup}
+\LoadCommonFile{textmarkup} % \section{Text Markup}
\section{Note Paper}
\seclabel{firstpage}
+\BeginIndexGroup
\BeginIndex{}{note paper}%
\BeginIndex{}{letter>first page}
@@ -999,10 +938,10 @@ contains elements like the letter head with the sender's information and
logo. \KOMAScript{} provides to position these elements independent. With this
it is not only possible to replicate the note paper directly, but also to
complete the destined fields instantaneously. The independent position is
-provided by pseudo-lengths (see \autoref{sec:scrlttr2.pseudoLength} from
-\autopageref{sec:scrlttr2.pseudoLength} onward). A schematic display of the
+provided by pseudo-lengths (see \autoref{sec:\LabelBase.pseudoLength} from
+\autopageref{sec:\LabelBase.pseudoLength} onward). A schematic display of the
note page and the used variable is shown by
-\autoref{fig:scrlttr2.variables}. Thereby the names of the variables are
+\autoref{fig:\LabelBase.variables}. Thereby the names of the variables are
printed boldly for better distinction from the commands and their arguments.
Following pages\Index{page>following}\Index{following page} are different from
@@ -1014,13 +953,12 @@ pages but the first one.
\includegraphics[scale=0.99]{varDIN}
\caption{schematic display of the note paper with the most important
commands and variables for the drafted elements}
- \label{fig:scrlttr2.variables}
+ \label{fig:\LabelBase.variables}
\end{figure}
\begin{Declaration}
- \KOption{foldmarks}\PName{selection}
+ \OptionVName{foldmarks}{selection}
\end{Declaration}
-\BeginIndex{Option}{foldmarks~=\PName{selection}}%
Foldmarks\Index{foldmark} or folding marks\Index{folding mark} are tiny
horizontal rules at the left margin or tiny vertical rules at the top
margin. \KOMAScript{} currently provides three configurable horizontal folding
@@ -1033,19 +971,19 @@ two-, three- or four-panel folding, and a single horizontal folding, of the
letter, whereby the folding need not result in equal-sized parts. The position
of the four horizontal and the single vertical marks are configurable via
pseudo-lengths (see \autoref{sec:scrlttr2-experts.foldmarks} from
-\autopageref{desc:scrlttr2-experts.plength.foldmarkvpos} onwards).
+\DescPageRef{scrlttr2-experts.plength.foldmarkvpos} onwards).
The user has a choice: Either one may use the standard values for simple
switches, as described in \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}, to activate or deactivate at once all
configured folding marks on the left and upper edges of the paper;
or\ChangedAt{v2.97e}{\Class{scrlttr2}} one may specify by one or more letters,
-as listed in \autoref{tab:scrlttr2.foldmark}, the use of the individual
+as listed in \autoref{tab:\LabelBase.foldmark}, the use of the individual
folding marks independently. Also in the latter case the folding marks will only be
shown if they have not been switched off generally with one of \PValue{false},
\PValue{off}, or \PValue{no}. The exact positioning of the folding marks is
specified in the user settings, that is, the \File{lco} files (see
-\autoref{sec:scrlttr2.lcoFile} from \autopageref{sec:scrlttr2.lcoFile} onward)
+\autoref{sec:\LabelBase.lcoFile} from \autopageref{sec:\LabelBase.lcoFile} onward)
chosen for a letter. Default values are \PValue{true} and \PValue{TBMPL}.
%
\begin{table}
@@ -1076,7 +1014,7 @@ chosen for a letter. Default values are \PValue{true} and \PValue{TBMPL}.
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:scrlttr2.foldmark}
+ \label{tab:\LabelBase.foldmark}
\end{table}
%
\begin{Example}
@@ -1089,7 +1027,7 @@ chosen for a letter. Default values are \PValue{true} and \PValue{TBMPL}.
might have been made before, a safer method should be used. This changes our
example a little bit:
\lstinputcode[xleftmargin=1em]{letter-7}%
- The result is shown in \autoref{fig:scrlttr2.letter-7}.
+ The result is shown in \autoref{fig:\LabelBase.letter-7}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with addressee, opening, text,
@@ -1100,24 +1038,24 @@ chosen for a letter. Default values are \PValue{true} and \PValue{TBMPL}.
(the date is a default of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-7}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-7}
+ \label{fig:\LabelBase.letter-7}
\end{figure}
\end{Example}
-\BeginIndex{FontElement}{foldmark}%
+\BeginIndex{FontElement}{foldmark}\LabelFontElement{foldmark}%
The color of the folding mark may be changed
using\ChangedAt{v2.97c}{\Class{scrlttr2}} using the commands
-\Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}) with element
-\FontElement{foldmark}. Default is not change.%
+\DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup}, \DescPageRef{\LabelBase.cmd.setkomafont})
+with element \FontElement{foldmark}. Default is not change.%
\EndIndex{FontElement}{foldmark}%
%
-\EndIndex{Option}{foldmarks~=\PName{selection}}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{enlargefirstpage}\PName{simple switch}
+ \OptionVName{enlargefirstpage}{simple switch}
\end{Declaration}
-\BeginIndex{Option}{enlargefirstpage~=\PName{simple switch}}%
The first page of a letter always uses a different page layout. The
\Class{scrlttr2} class provides a mechanism to calculate height and vertical
alignment of header and footer of the first page independently of the
@@ -1128,31 +1066,33 @@ the text area should become larger, supposing that the footer on the first
page allows that, you can use this option. At best, a little more text will
then fit on the first page. See also the description of the pseudo-length
\PLength{firstfootvpos} on
-\autopageref{desc:scrlttr2-experts.plength.firstfootvpos}. This option can
+\DescPageRef{scrlttr2-experts.plength.firstfootvpos}. This option can
take the standard values for simple switches, as listed in
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. Default is
\PValue{false}.
%
-\EndIndex{Option}{enlargefirstpage~=\PName{simple switch}}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{firsthead}\PName{simple switch}
+ \OptionVName{firsthead}{simple switch}
\end{Declaration}
-\BeginIndex{Option}{firsthead~=\PName{simple switch}}%
+\BeginIndex{}{letterhead}%
+\BeginIndex{}{letter>head}%
The\ChangedAt{v2.97e}{\Class{scrlttr2}} letterhead is usually the topmost
element of the note paper. This option determines whether the letterhead will
be typeset at all. The option accepts the standard values for simple keys,
given in \autoref{tab:truefalseswitch} at
\autopageref{tab:truefalseswitch}. Default is for the letterhead to be set.%
%
-\EndIndex{Option}{firsthead~=\PName{simple switch}}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{fromalign}\PName{method}
+ \OptionVName{fromalign}{method}
\end{Declaration}
\BeginIndex{}{letterhead}%
\BeginIndex{}{letter>head}%
-\BeginIndex{Option}{fromalign~=\PName{method}}%
Option\important{\Option{fromalign}} \Option{fromalign} defines the placement
of the return address in the letterhead of the first page. Apart from the
various options for positioning the return address in the letterhead, there is
@@ -1162,58 +1102,54 @@ address to the sender's extension\Index{sender's
activate or deactivate the letterhead extensions. If these extensions are
deactivated, some other options will have no effect. This will be noted in the
explanations of the respective options. Possible values for \Option{fromalign}
-are shown in \autoref{tab:scrlttr2.fromalign}. Default is \PValue{left}.%
+are shown in \autoref{tab:\LabelBase.fromalign}. Default is \PValue{left}.%
%
\begin{table}
\caption[{Available values for option \Option{fromalign} with
\Class{scrlttr2}}]{Available values for option \Option{fromalign} to
define the position of the from address in the letterhead with
\Class{scrlttr2}}
- \label{tab:scrlttr2.fromalign}
+ \label{tab:\LabelBase.fromalign}
\begin{desctabular}
\entry{\PValue{center}, \PValue{centered}, \PValue{middle}}{%
- return address centered; an optional logo will be above the
- extended return address; letterhead extensions will be
- activated}%
+ return address centered; an optional logo will be above the extended
+ return address; letterhead extensions will be activated}%
\entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
- standard design will be used for the return address; the
- letterhead extensions are deactivated}%
+ standard design will be used for the return address; the letterhead
+ extensions are deactivated}%
\entry{\PValue{left}}{%
- left-justified return address; an optional logo will be right
- justified; letterhead extensions will be activated}%
+ left-justified return address; an optional logo will be right justified;
+ letterhead extensions will be activated}%
\entry{\PValue{locationleft}, \PValue{leftlocation}}{%
- return address is set left-justified in the sender's extension;
- a logo, if applicable, will be placed above it; the letterhead
- is automatically deactivated but can be reactivated using option
- \Option{firsthead}.}%
+ return address is set left-justified in the sender's extension; a logo,
+ if applicable, will be placed above it; the letterhead is automatically
+ deactivated but can be reactivated using option
+ \DescRef{\LabelBase.option.firsthead}.}%
\entry{\PValue{locationright}, \PValue{rightlocation},
\PValue{location}}{%
- return address is set right-justified in the sender's extension;
- a logo, if applicable, will be placed above it; the letterhead
- is automatically deactivated but can be reactivated using option
- \Option{firsthead}.}%
+ return address is set right-justified in the sender's extension; a logo,
+ if applicable, will be placed above it; the letterhead is automatically
+ deactivated but can be reactivated using option
+ \DescRef{\LabelBase.option.firsthead}.}%
\entry{\PValue{right}}{%
- right-justified return address; an optional logo will be left
- justified; letterhead extensions will be activated}%
+ right-justified return address; an optional logo will be left justified;
+ letterhead extensions will be activated}%
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{fromalign~=\PName{method}}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{fromrule}\PName{position}\\
- \Macro{setkomavar}\PParameter{\Variable{fromname}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{fromaddress}}%
- \OParameter{description}\Parameter{contents}
+ \OptionVName{fromrule}{position}%
+ \Variable{fromname}%
+ \Variable{fromaddress}%
\end{Declaration}
-\BeginIndex{Option}{fromrule~=\PName{position}}%
-\BeginIndex{Variable}{fromaddress}%
-\BeginIndex{Variable}{fromname}%
+\BeginIndex{}{letterhead}%
+\BeginIndex{}{letter>head}%
The\important{\Variable{fromname}} sender's name will be determined by
variable \Variable{fromname}. Thereby the \PName{description} (see also
-\autoref{tab:scrlttr2.fromTerm}, \autopageref{tab:scrlttr2.fromTerm}) will not
+\autoref{tab:\LabelBase.fromTerm}, \autopageref{tab:\LabelBase.fromTerm}) will not
be used by the predefined letterheads.
At\important{\OptionValue{fromrule}{aftername}} the extended letterhead an
@@ -1223,7 +1159,7 @@ Alternatively\important[i]{\begin{tabular}{@{}l@{}}
\KOption{fromrule}\\\quad\PValue{afteraddress}\end{tabular}} this rule may
be placed below the while sender using \OptionValue{fromrule}{afteraddress}. A
summary of all available rule position settings shows
-\autoref{tab:scrlttr2.fromrule}. The length of this rule is determined by
+\autoref{tab:\LabelBase.fromrule}. The length of this rule is determined by
pseudo-length \PLength{fromrulewidth}\IndexPLength[indexmain]{fromrulewidth}.
\begin{table}
@@ -1231,7 +1167,7 @@ pseudo-length \PLength{fromrulewidth}\IndexPLength[indexmain]{fromrulewidth}.
\Class{scrlttr2}}]{Possible values of option \Option{fromrule} for the
position of the rule in the from address with
\Class{scrlttr2}}
- \label{tab:scrlttr2.fromrule}
+ \label{tab:\LabelBase.fromrule}
\begin{desctabular}
\entry{\PValue{afteraddress}, \PValue{below}, \PValue{on}, \PValue{true},
\PValue{yes}}{%
@@ -1248,12 +1184,13 @@ standard letterhead the rule will always be placed below the sender's name.
The\important{\Variable{fromaddress}} sender's address follows below the
name. The \PName{content} of variable \Variable{fromaddress} determines this
-address. The \PName{description} (see also \autoref{tab:scrlttr2.fromTerm})
+address. The \PName{description} (see also \autoref{tab:\LabelBase.fromTerm})
will not be used at the predefined letterheads
-\BeginIndex{FontElement}{fromaddress}%
-\BeginIndex{FontElement}{fromname}%
-\BeginIndex{FontElement}{fromrule}%
+\BeginIndexGroup
+\BeginIndex{FontElement}{fromaddress}\LabelFontElement{fromaddress}%
+\BeginIndex{FontElement}{fromname}\LabelFontElement{fromname}%
+\BeginIndex{FontElement}{fromrule}\LabelFontElement{fromrule}%
The font of the whole address is determined by the element
\FontElement{fromaddress}\IndexFontElement{fromaddress}%
\important{\FontElement{fromaddress}}. Modifications to this may be defined
@@ -1266,9 +1203,7 @@ would make sense. But you may use the elements also to change the color,
e.\,g. color the rule gray instead of black. See \cite{package:xcolor} for
information about colors.%
%
-\EndIndex{FontElement}{fromrule}%
-\EndIndex{FontElement}{fromname}%
-\EndIndex{FontElement}{fromaddress}%
+\EndIndexGroup
\begin{Example}
Let's now define the name of the sender at our letter example:
@@ -1282,27 +1217,27 @@ information about colors.%
{result of a small letter with sender, addressee, opening, text, closing,
postscript, distribution list, and enclosure (date and folding marks are
defaults of DIN-letters): at left one the standard letterhead using
- \OptionValue{fromalign}{false}, at right one the
- extended letterhead using \OptionValue{fromalign}{center}}
- \label{fig:scrlttr2.letter-8-9}
+ \OptionValueRef{\LabelBase}{fromalign}{false}, at right one the
+ extended letterhead using \OptionValueRef{\LabelBase}{fromalign}{center}}
+ \label{fig:\LabelBase.letter-8-9}
\end{figure}
First of all not the extended but the standard letterhead has been used. The
- result is shown at the left side of \autoref{fig:scrlttr2.letter-8-9}. The
+ result is shown at the left side of \autoref{fig:\LabelBase.letter-8-9}. The
right side shows almost the same letter but with
- \OptionValue{fromalign}{center} and therefore with the extended
+ \OptionValueRef{\LabelBase}{fromalign}{center} and therefore with the extended
letterhead. You may see, that this variation is without any rule.
- For the first time \autoref{fig:scrlttr2.letter-8-9} also shows a signature
+ For the first time \autoref{fig:\LabelBase.letter-8-9} also shows a signature
below the closing phrase. This has been generated automatically from the
sender's name. More information about configuration of the signature may be
- found in \autoref{sec:scrlttr2.closing} from
- \autopageref{sec:scrlttr2.closing} onward.
+ found in \autoref{sec:\LabelBase.closing} from
+ \autopageref{sec:\LabelBase.closing} onward.
Now, the letter with extended letterhead should use option \Option{fromrule}
to print a rule below the sender's name:%
\lstinputcode[xleftmargin=1em]{letter-11.tex}%
The result may be found at the right side of
- \autoref{fig:scrlttr2.letter-10-11}.
+ \autoref{fig:\LabelBase.letter-10-11}.
\begin{figure}
\centering
\frame{\includegraphics[width=.4\textwidth]{letter-10}}\quad
@@ -1314,9 +1249,9 @@ information about colors.%
opening, text, closing, signature, postscript, distribution list,
enclosure and puncher hole mark (the date is a default of DIN-letters):
at left one the standard letterhead using
- \OptionValue{fromalign}{false}, at right one the extended letterhead
- using \OptionValue{fromalign}{center}}
- \label{fig:scrlttr2.letter-10-11}
+ \OptionValueRef{\LabelBase}{fromalign}{false}, at right one the extended letterhead
+ using \OptionValueRef{\LabelBase}{fromalign}{center}}
+ \label{fig:\LabelBase.letter-10-11}
\end{figure}
In difference to this, the left letter has been set once again with the
standard letter head, that does not react on the additional option.
@@ -1331,59 +1266,33 @@ are usually not allowed within the sender's address declaration. One has to
have very good knowledge of \Class{scrlttr2} to use things like those
mentioned above, intelligently. Another point to note is the one should most
certainly set the variables for return address (see variable
-\Variable{backaddress}, \autopageref{desc:scrlttr2.variable.backaddress}) and
-signature (see variable \Variable{signature},
-\autopageref{desc:scrlttr2.variable.signature}) oneself.%
+\DescRef{\LabelBase.variable.backaddress}, \DescPageRef{\LabelBase.variable.backaddress}) and
+signature (see variable \DescRef{\LabelBase.variable.signature},
+\DescPageRef{\LabelBase.variable.signature}) oneself.%
%
-\EndIndex{Variable}{fromname}%
-\EndIndex{Variable}{fromaddress}%
-\EndIndex{Option}{fromrule~=\PName{position}}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{symbolicnames}\PName{simple switch}\\
- \KOption{fromphone}\PName{simple switch}\\
- \KOption{frommobilephone}\PName{simple switch}\\
- \KOption{fromfax}\PName{simple switch}\\
- \KOption{fromemail}\PName{simple switch}\\
- \KOption{fromurl}\PName{simple switch}\\
- \Macro{setkomavar}\PParameter{\Variable{fromphone}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{frommobilephone}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{fromfax}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{fromemail}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{fromurl}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{phoneseparator}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{mobilephoneseparator}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{faxseparator}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{emailseparator}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{urlseparator}}%
- \OParameter{description}\Parameter{content}%
+ \OptionVName{symbolicnames}{simple switch}%
+ \OptionVName{fromphone}{simple switch}%
+ \OptionVName{frommobilephone}{simple switch}%
+ \OptionVName{fromfax}{simple switch}%
+ \OptionVName{fromemail}{simple switch}%
+ \OptionVName{fromurl}{simple switch}%
+ \Variable{fromphone}%
+ \Variable{frommobilephone}%
+ \Variable{fromfax}%
+ \Variable{fromemail}%
+ \Variable{fromurl}%
+ \Variable{phoneseparator}%
+ \Variable{mobilephoneseparator}%
+ \Variable{faxseparator}%
+ \Variable{emailseparator}%
+ \Variable{urlseparator}%
\end{Declaration}%
-\BeginIndex{Option}{symbolicnames~=\PName{simple switch}}%
-\BeginIndex{Option}{fromphone~=\PName{simple switch}}%
-\BeginIndex{Option}{frommobilephone~=\PName{simple switch}}%
-\BeginIndex{Option}{fromfax~=\PName{simple switch}}%
-\BeginIndex{Option}{fromemail~=\PName{simple switch}}%
-\BeginIndex{Option}{fromurl~=\PName{simple switch}}%
-\BeginIndex{Variable}{fromphone}%
-\BeginIndex{Variable}{frommobilephone}%
-\BeginIndex{Variable}{fromfax}%
-\BeginIndex{Variable}{fromemail}%
-\BeginIndex{Variable}{fromurl}%
-\BeginIndex{Variable}{emailseparator}%
-\BeginIndex{Variable}{faxseparator}%
-\BeginIndex{Variable}{phoneseparator}%
-\BeginIndex{Variable}{mobilephoneseparator}%
-\BeginIndex{Variable}{urlseparator}%
+\BeginIndex{}{letterhead}%
+\BeginIndex{}{letter>head}%
Whether or not a telephone number\Index{telephone}\Index{phone}, a
mobile\ChangedAt{v3.12}{\Class{scrlttr2}} telephone number\Index{mobile
phone}\Index{cell phone}\Index{cellphone}, a fax number\Index{fax}, an
@@ -1394,17 +1303,17 @@ for simple switches from \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch} may be assigned to these options. Default is
\PValue{false} for all of them. The \PName{contents} depends on the
corresponding variable. The default of the \PName{description} or title of
-each variable may be found in \autoref{tab:scrlttr2.fromTerm}. The separators,
+each variable may be found in \autoref{tab:\LabelBase.fromTerm}. The separators,
that will be inserted between \PName{description} and \PName{content}, may be
-found in \autoref{tab:scrlttr2.fromSeparator}.
+found in \autoref{tab:\LabelBase.fromSeparator}.
You may\ChangedAt{v3.12}{\Class{scrlttr2}}\important{\Option{symbolicnames}}
change the defaults for the description of the separator variables at once
using option \Option{symbolicnames}. The option understands the values for
simple switches from \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}. Switching on the option replaces the
-descriptions from the language depending terms \Macro{emailname},
-\Macro{faxname}, \Macro{mobilephonename}, and \Macro{phonename} into symbols
+descriptions from the language depending terms \DescRef{scrlttr2-experts.cmd.emailname},
+\DescRef{scrlttr2-experts.cmd.faxname}, \DescRef{scrlttr2-experts.cmd.mobilephonename}, and \DescRef{scrlttr2-experts.cmd.phonename} into symbols
of the package \Package{marvosym}\IndexPackage{marvosym}. Also the colon will
be removed from the content of the separator variables. And in this case the
description and the content of the URL separator will be
@@ -1417,23 +1326,23 @@ first time after \Macro{begin}\PParameter{document}.
\caption[{Predefined descriptions of the variables of the
letterhead}]{Predefined descriptions of the variables of the letterhead
(the description and contents of the separator variables may be found at
- \autoref{tab:scrlttr2.fromSeparator}}
+ \autoref{tab:\LabelBase.fromSeparator}}
\begin{desctabular}[1.8em]
- \ventry{fromemail}{\Macro{usekomavar*}\PParameter{emailseparator}%
- \Macro{usekomavar}\PParameter{emailseparator}}%
- \ventry{fromfax}{\Macro{usekomavar*}\PParameter{faxseparator}%
- \Macro{usekomavar}\PParameter{faxseparator}}%
+ \ventry{fromemail}{\DescRef{\LabelBase.cmd.usekomavar*}\PParameter{emailseparator}%
+ \DescRef{\LabelBase.cmd.usekomavar}\PParameter{emailseparator}}%
+ \ventry{fromfax}{\DescRef{\LabelBase.cmd.usekomavar*}\PParameter{faxseparator}%
+ \DescRef{\LabelBase.cmd.usekomavar}\PParameter{faxseparator}}%
\ventry{frommobilephone}{%
\ChangedAt{v3.12}{\Class{scrlttr2}}%
- \Macro{usekomavar*}\PParameter{mobilephoneseparator}%
- \Macro{usekomavar}\PParameter{mobilephoneseparator}}%
- \ventry{fromname}{\Macro{headfromname}}%
- \ventry{fromphone}{\Macro{usekomavar*}\PParameter{phoneseparator}%
- \Macro{usekomavar}\PParameter{phoneseparator}}%
- \ventry{fromurl}{\Macro{usekomavar*}\PParameter{urlseparator}%
- \Macro{usekomavar}\PParameter{urlseparator}}%
+ \DescRef{\LabelBase.cmd.usekomavar*}\PParameter{mobilephoneseparator}%
+ \DescRef{\LabelBase.cmd.usekomavar}\PParameter{mobilephoneseparator}}%
+ \ventry{fromname}{\DescRef{scrlttr2-experts.cmd.headfromname}}%
+ \ventry{fromphone}{\DescRef{\LabelBase.cmd.usekomavar*}\PParameter{phoneseparator}%
+ \DescRef{\LabelBase.cmd.usekomavar}\PParameter{phoneseparator}}%
+ \ventry{fromurl}{\DescRef{\LabelBase.cmd.usekomavar*}\PParameter{urlseparator}%
+ \DescRef{\LabelBase.cmd.usekomavar}\PParameter{urlseparator}}%
\end{desctabular}
- \label{tab:scrlttr2.fromTerm}
+ \label{tab:\LabelBase.fromTerm}
\end{table}
\begin{table}[tp]
@@ -1448,15 +1357,15 @@ first time after \Macro{begin}\PParameter{document}.
\toprule
variable name & description & content \\
\midrule
- \Variable{emailseparator} & \Macro{emailname} & \texttt{:\~} \\
- \Variable{faxseparator} & \Macro{faxname} & \texttt{:\~} \\
- \Variable{mobilephoneseparator} & \Macro{mobilephonename} & \Macro{usekomavaer}\PParameter{phoneseparator} \\
- \Variable{phoneseparator} & \Macro{phonename} & \texttt{:\~} \\
- \Variable{urlseparator} & \Macro{wwwname} & \texttt{:\~} \\
+ \Variable{emailseparator} & \DescRef{scrlttr2-experts.cmd.emailname} & \texttt{:\~} \\
+ \Variable{faxseparator} & \DescRef{scrlttr2-experts.cmd.faxname} & \texttt{:\~} \\
+ \Variable{mobilephoneseparator} & \DescRef{scrlttr2-experts.cmd.mobilephonename} & \Macro{usekomavaer}\PParameter{phoneseparator} \\
+ \Variable{phoneseparator} & \DescRef{scrlttr2-experts.cmd.phonename} & \texttt{:\~} \\
+ \Variable{urlseparator} & \DescRef{scrlttr2-experts.cmd.wwwname} & \texttt{:\~} \\
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:scrlttr2.fromSeparator}
+ \label{tab:\LabelBase.fromSeparator}
\end{table}
\begin{Example}
@@ -1466,11 +1375,11 @@ first time after \Macro{begin}\PParameter{document}.
defines the content of the needed variables:%
\lstinputcode[xleftmargin=1em]{letter-12.tex}%
Nevertheless the result at the left side of
- \autoref{fig:scrlttr2.letter-12-13} is not disillusioning: the options are
+ \autoref{fig:\LabelBase.letter-12-13} is not disillusioning: the options are
ignored. That's the case because the additional variables and options will
- be used at the extended letterhead only. So option \Option{fromalign} has to
+ be used at the extended letterhead only. So option \DescRef{\LabelBase.option.fromalign} has to
be used, like done at the right letter of
- \autoref{fig:scrlttr2.letter-12-13}.
+ \autoref{fig:\LabelBase.letter-12-13}.
\begin{figure}
\centering
\frame{\includegraphics[width=.4\textwidth]{letter-12}}\quad
@@ -1482,16 +1391,16 @@ first time after \Macro{begin}\PParameter{document}.
opening, text, closing, signature, postscript, distribution list,
enclosure and puncher hole mark (the date is a default of DIN-letters):
at left one the standard letterhead using
- \OptionValue{fromalign}{false}, at right one the extended letterhead
- using \OptionValue{fromalign}{center}}
- \label{fig:scrlttr2.letter-12-13}
+ \OptionValueRef{\LabelBase}{fromalign}{false}, at right one the extended letterhead
+ using \OptionValueRef{\LabelBase}{fromalign}{center}}
+ \label{fig:\LabelBase.letter-12-13}
\end{figure}
\lstinputcode[xleftmargin=1em]{letter-13.tex}
An arrangement of alternatives with left aligned using
- \OptionValue{fromalign}{left} and right aligned sender
- using \OptionValue{fromalign}{right} may be found in
- \autoref{fig:scrlttr2.letter-14-15}.
+ \OptionValueRef{\LabelBase}{fromalign}{left} and right aligned sender
+ using \OptionValueRef{\LabelBase}{fromalign}{right} may be found in
+ \autoref{fig:\LabelBase.letter-14-15}.
\begin{figure}
\centering
\frame{\includegraphics[width=.4\textwidth]{letter-14}}\quad
@@ -1503,36 +1412,21 @@ first time after \Macro{begin}\PParameter{document}.
opening, text, closing, signature, postscript, distribution list,
enclosure and puncher hole mark (the date is a default of DIN-letters):
at left one left aligned letterhead using
- \OptionValue{fromalign}{left}, at right one right aligned letterhead
- using \OptionValue{fromalign}{right}}
- \label{fig:scrlttr2.letter-14-15}
+ \OptionValueRef{\LabelBase}{fromalign}{left}, at right one right aligned letterhead
+ using \OptionValueRef{\LabelBase}{fromalign}{right}}
+ \label{fig:\LabelBase.letter-14-15}
\end{figure}
\end{Example}
%
-\EndIndex{Variable}{urlseparator}%
-\EndIndex{Variable}{mobilephoneseparator}%
-\EndIndex{Variable}{phoneseparator}%
-\EndIndex{Variable}{faxseparator}%
-\EndIndex{Variable}{emailseparator}%
-\EndIndex{Variable}{fromurl}
-\EndIndex{Variable}{fromemail}
-\EndIndex{Variable}{fromfax}
-\EndIndex{Variable}{frommobilephone}%
-\EndIndex{Variable}{fromphone}%
-\EndIndex{Option}{fromurl~=\PName{simple switch}}%
-\EndIndex{Option}{fromemail~=\PName{simple switch}}%
-\EndIndex{Option}{fromfax~=\PName{simple switch}}%
-\EndIndex{Option}{frommobilephone~=\PName{simple switch}}%
-\EndIndex{Option}{fromphone~=\PName{simple switch}}%
-\EndIndex{Option}{symbolicnames~=\PName{simple switch}}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{fromlogo}\PName{simple switch}\\
- \Macro{setkomavar}\PParameter{\Variable{fromlogo}}%
- \OParameter{description}\Parameter{content}
+ \OptionVName{fromlogo}{simple switch}%
+ \Variable{fromlogo}%
\end{Declaration}
-\BeginIndex{Option}{fromlogo~=\PName{simple switch}}%
-\BeginIndex{Variable}{fromlogo}%
+\BeginIndex{}{letterhead}%
+\BeginIndex{}{letter>head}%
With option \Option{fromlogo} you may configure whether or not to use a
logo\Index{Logo} at the letterhead. The option value may be any \PName{simple
switch} from \autoref{tab:truefalseswitch},
@@ -1540,7 +1434,7 @@ logo\Index{Logo} at the letterhead. The option value may be any \PName{simple
logo. The logo itself is defined by the \PName{content} of variable
\Variable{fromlogo}. The \PName{description} of the logo is empty by default
and \KOMAScript{} does not use it anywhere at the predefined note papers (see
-also \autoref{tab:scrlttr2.fromTerm}).%
+also \autoref{tab:\LabelBase.fromTerm}).%
\begin{Example}
Mr Public likes to use a letterhead with logo. He generated a graphics file
with the logo and would like to include this using
@@ -1548,7 +1442,7 @@ also \autoref{tab:scrlttr2.fromTerm}).%
\Package{graphics}\IndexPackage{graphics} (see \cite{package:graphics}).%
\lstinputcode[xleftmargin=1em]{letter-16}%
The result may be seen at the left top position of
- \autoref{fig:scrlttr2.letter-16-18}. The additional letter prints at this
+ \autoref{fig:\LabelBase.letter-16-18}. The additional letter prints at this
figure shows the result with right aligned or centered sender.
\begin{figure}
\setcapindent{0pt}%
@@ -1567,18 +1461,18 @@ also \autoref{tab:scrlttr2.fromTerm}).%
sender}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-18}}\quad
\end{captionbeside}
- \label{fig:scrlttr2.letter-16-18}
+ \label{fig:\LabelBase.letter-16-18}
\end{figure}
\end{Example}%
%
-\EndIndex{Variable}{fromlogo}%
-\EndIndex{Option}{fromlogo~=\PName{smart value}}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{firsthead}}%
- \OParameter{description}\Parameter{content}
+ \Variable{firsthead}%
\end{Declaration}
-\BeginIndex{Variable}{firsthead}%
+\BeginIndex{}{letterhead}%
+\BeginIndex{}{letter>head}%
For many cases, \Class{scrlttr2} with its options and variables offers
enough possibilities to create a letterhead. In very rare situations
one may wish to have more freedom in terms of layout. In those
@@ -1591,7 +1485,7 @@ construction as content of variable \Variable{firsthead}. Within
or one underneath the other. An advanced user will thus be able to
create a letterhead on his own. Of course the construct may
and should use other variables with the help of
-\Macro{usekomavar}. \KOMAScript{} does not use the
+\DescRef{\LabelBase.cmd.usekomavar}. \KOMAScript{} does not use the
\PName{description} of variable \Variable{firsthead}.
\iffree{}{A detailed example for the definition of a letterhead will be shown
in \autoref{cha:modernletters}.}
@@ -1601,72 +1495,46 @@ The\textnote{Attention!} command
compatibility to former \Class{scrlttr2} versions. However it is deprecated
and you should not use it anymore.%
%
-\EndIndex{Variable}{firsthead}%
-%
-\EndIndex{}{letter>head}%
-\EndIndex{}{letterhead}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{addrfield}\PName{mode}\\
- \KOption{backaddress}\PName{value}\\
- \KOption{priority}\PName{priority}\\
- \Macro{setkomavar}\PParameter{\Variable{toname}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{toaddress}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{backaddress}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{backaddressseparator}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{specialmail}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{fromzipcode}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{zipcodeseparator}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{place}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{PPcode}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{PPdatamatrix}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{addresseeimage}}%
- \OParameter{description}\Parameter{content}
+ \OptionVName{addrfield}{mode}%
+ \OptionVName{backaddress}{value}%
+ \OptionVName{priority}{priority}%
+ \Variable{toname}%
+ \Variable{toaddress}%
+ \Variable{backaddress}%
+ \Variable{backaddressseparator}%
+ \Variable{specialmail}%
+ \Variable{fromzipcode}%
+ \Variable{zipcodeseparator}%
+ \Variable{place}%
+ \Variable{PPcode}%
+ \Variable{PPdatamatrix}%
+ \Variable{addresseeimage}%
\end{Declaration}%
-\BeginIndex{}{Anschrift}%
-\BeginIndex{Option}{addrfield~=\PName{mode}}%
-\BeginIndex{Variable}{toname}%
-\BeginIndex{Variable}{toaddress}%
-\BeginIndex{Option}{backaddress~=\PName{value}}%
-\BeginIndex{Variable}{backaddress}%
-\BeginIndex{Variable}{backaddressseparator}%
-\BeginIndex{Option}{priority~=\PName{priority}}%
-\BeginIndex{Variable}{specialmail}%
-\BeginIndex{Variable}{fromzipcode}%
-\BeginIndex{Variable}{zipcodeseparator}%
-\BeginIndex{Variable}{place}%
-\BeginIndex{Variable}{PPcode}%
-\BeginIndex{Variable}{PPdatamatrix}%
-\BeginIndex{Variable}{addresseeimage}%
-\BeginIndex{FontElement}{addressee}%
-\BeginIndex{FontElement}{toname}%
-\BeginIndex{FontElement}{toaddress}%
+\BeginIndex{}{addressee}%
+\BeginIndexGroup
+\BeginIndex{FontElement}{addressee}\LabelFontElement{addressee}%
+\BeginIndex{FontElement}{toname}\LabelFontElement{toname}%
+\BeginIndex{FontElement}{toaddress}\LabelFontElement{toaddress}%
Option \Option{addrfield} defines whether or not to set an address
field. Default is to use an address field. This option can take the mode
values from
-\autoref{tab:scrlttr2.addrfield}\ChangedAt{v3.03}{\Class{scrlttr2}}. Default
+\autoref{tab:\LabelBase.addrfield}\ChangedAt{v3.03}{\Class{scrlttr2}}. Default
is \PValue{true}. With values \PValue{true},
\PValue{topaligned}\ChangedAt{v3.17}{\Class{scrlttr2}\and
\Package{scrletter}}, \PValue{PP}, and
\PValue{backgroundimage} name and address of the addressee will be defined by
-the mandatory argument of the \Environment{letter} environment (see
-\autoref{sec:scrlttr2.document},
-\autopageref{desc:scrlttr2.env.letter}). These elements will additionally be
+the mandatory argument of the \DescRef{\LabelBase.env.letter} environment (see
+\autoref{sec:\LabelBase.document},
+\DescPageRef{\LabelBase.env.letter}). These elements will additionally be
copied into the variables \Variable{toname} and \Variable{toaddress}. The
predefined font styles may be changed\ChangedAt{v2.97c}{\Class{scrlttr2}} by
-execution of command \Macro{setkomafont} or \Macro{addtokomafont} (siehe
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}). Thereby three elements
+execution of command \DescRef{\LabelBase.cmd.setkomafont} or \DescRef{\LabelBase.cmd.addtokomafont} (siehe
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). Thereby three elements
exist. First of all element
\FontElement{addressee}\important{\FontElement{addressee}}, that is
responsible for the addressee overall. The additional elements
@@ -1674,15 +1542,13 @@ responsible for the addressee overall. The additional elements
\FontElement{toaddress}\important{\FontElement{toaddress}} are responsible
only either for the name or the address of the addressee. They may be used to
define modifications from the \FontElement{addressee} configuration.%
-\EndIndex{FontElement}{toaddress}%
-\EndIndex{FontElement}{toname}%
-\EndIndex{FontElement}{addressee}%
+\EndIndexGroup
\begin{table}
\caption[{available values for option \Option{addrfield} using
\Class{scrlttr2}}]{available values for option \Option{addrfield} to
change the addressee mode of \Class{scrlttr2}}%
- \label{tab:scrlttr2.addrfield}%
+ \label{tab:\LabelBase.addrfield}%
\begin{desctabular}
\entry{\PValue{backgroundimage}, \PValue{PPbackgroundimage},
\PValue{PPBackgroundImage}, \PValue{PPBackGroundImage},
@@ -1730,7 +1596,7 @@ this value \PValue{plain}\important{\OptionValue{backaddress}{plain}} selects
a style without underline. Default is \PValue{underlined} and therefore
printing an underlined return address.
-\BeginIndex{FontElement}{backaddress}%
+\BeginIndex{FontElement}{backaddress}\LabelFontElement{backaddress}%
The return address itself is defined by the \PName{content} of variable
\Variable{backaddress}. Default is a combination of variable \Variable{toname}
and \Variable{toaddress} with redefinition of the double backslash to set the
@@ -1741,7 +1607,7 @@ by \KOMAScript. The font style of the return address is configurable via
element
\FontElement{backaddress}\important{\FontElement{backaddress}}. Default for
this is \Macro{sffamily} (see
-\autoref{tab:scrlttr2.AddresseeElements}). Before execution of the element's
+\autoref{tab:\LabelBase.AddresseeElements}). Before execution of the element's
font style \KOMAScript{} switches to \Macro{scriptsize}.%
\EndIndex{FontElement}{backaddress}%
@@ -1752,11 +1618,6 @@ opposite to this, \OptionValue{addrfield}{topaligned}%
\important{\OptionValue{addrfield}{topaligned}} will not centre the address
but follow it aligned top at the available space. This is the only difference
to \OptionValue{addrfield}{true}.%
-\EndIndex{Variable}{backaddressseparator}%
-\EndIndex{Variable}{backaddress}%
-\EndIndex{Option}{backaddress~=\PName{value}}%
-\EndIndex{Variable}{toaddress}%
-\EndIndex{Variable}{toname}%
\begin{table}
% \centering
@@ -1771,38 +1632,38 @@ to \OptionValue{addrfield}{true}.%
\toprule
element & font style \\
\midrule
- \FontElement{addressee}\IndexFontElement{addressee} &
+ \DescRef{\LabelBase.fontelement.addressee}\IndexFontElement{addressee} &
\\
- \FontElement{backaddress}\IndexFontElement{backaddress} &
+ \DescRef{\LabelBase.fontelement.backaddress}\IndexFontElement{backaddress} &
\Macro{sffamily}%
\\
- \FontElement{PPdata}\IndexFontElement{PPdata} &
+ \DescRef{\LabelBase.fontelement.PPdata}\IndexFontElement{PPdata} &
\Macro{sffamily}%
\\
- \FontElement{PPlogo}\IndexFontElement{PPlogo} &
+ \DescRef{\LabelBase.fontelement.PPlogo}\IndexFontElement{PPlogo} &
\Macro{sffamily}\Macro{bfseries}%
\\
- \FontElement{priority}\IndexFontElement{priority} &
+ \DescRef{\LabelBase.fontelement.priority}\IndexFontElement{priority} &
\Macro{fontsize}\PParameter{10pt}\PParameter{10pt}%
\Macro{sffamily}\Macro{bfseries}%
\\
- \FontElement{prioritykey}\IndexFontElement{prioritykey} &
+ \DescRef{\LabelBase.fontelement.prioritykey}\IndexFontElement{prioritykey} &
\Macro{fontsize}\PParameter{24.88pt}\PParameter{24.88pt}%
\Macro{selectfont}%
\\
- \FontElement{specialmail}\IndexFontElement{specialmail} &
+ \DescRef{\LabelBase.fontelement.specialmail}\IndexFontElement{specialmail} &
\\
- \FontElement{toaddress}\IndexFontElement{toaddress} &
+ \DescRef{\LabelBase.fontelement.toaddress}\IndexFontElement{toaddress} &
\\
- \FontElement{toname}\IndexFontElement{toname} &
+ \DescRef{\LabelBase.fontelement.toname}\IndexFontElement{toname} &
\\
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:scrlttr2.AddresseeElements}%
+ \label{tab:\LabelBase.AddresseeElements}%
\end{table}
-\BeginIndex{FontElement}{specialmail}%
+\BeginIndex{FontElement}{specialmail}\LabelFontElement{specialmail}%
At the default \OptionValue{addrfield}{true} an optional dispatch
type\Index{mode of dispatch}\Index{dispatch type} can be output within the
address field between the return address and the addressee address, This will
@@ -1812,40 +1673,43 @@ selected, which is also the default. Class \Class{scrlttr2} itself does not use
the \PName{description} of variable \Variable{specialmail}. The alignment is
defined by the pseudo-lengths PLength{specialmailindent} and
\PLength{specialmailrightindent} (siehe
-\autopageref{desc:scrlttr2-experts.plength.specialmailindent}). The predefined
+\DescPageRef{scrlttr2-experts.plength.specialmailindent}). The predefined
font style of element\ChangedAt{v2.97c}{\Class{scrlttr2}}
\FontElement{specialmail}\important{\FontElement{specialmail}}, that has been
-listed in \autoref{tab:scrlttr2.AddresseeElements}, may be changed using
-commands \Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}).%
+listed in \autoref{tab:\LabelBase.AddresseeElements}, may be changed using
+commands \DescRef{\LabelBase.cmd.setkomafont} and \DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}).%
\EndIndex{FontElement}{specialmail}%
-\BeginIndex{FontElement}{priority}%
-\BeginIndex{FontElement}{prioritykey}%
+\BeginIndexGroup
+\BeginIndex{FontElement}{priority}\LabelFontElement{priority}%
+\BeginIndex{FontElement}{prioritykey}\LabelFontElement{prioritykey}%
+\BeginIndex{FontElement}{PPlogo}\LabelFontElement{PPlogo}%
On\ChangedAt{v3.03}{\Class{scrlttr2}}\important[i]{\OptionValue{priority}{A}\\
\OptionValue{priority}{B}} the other hand, using an international priority
-with \OptionValue{priority}{A} or
-\OptionValue{priority}{B} (see \autoref{tab:scrlttr2.priority}) together with
-\OptionValue{addrfield}{true} will print the priority as mode of
-dispatch. Using it together with
+with \OptionValue{priority}{A} or \OptionValue{priority}{B} (see
+\autoref{tab:\LabelBase.priority}) together with \OptionValue{addrfield}{true}
+will print the priority as mode of dispatch. Using it together with
\OptionValue{addrfield}{PP}\important{\OptionValue{addrfield}{PP}} will print
the priority at the corresponding position in the Port-Pay\'e head. Thereby
the element \FontElement{priority} defines the basic font style and
\FontElement{prioritykey} the modification of the basic font style for the
-priority key, ``A'' or ``B''. The default font styles are listed in
-\autoref{tab:scrlttr2.AddresseeElements} and may be changed using commands \Macro{setkomafont} und \Macro{addtokomafont} (siehe
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}).%
-\EndIndex{FontElement}{prioritykey}%
-\EndIndex{FontElement}{priority}%
-\EndIndex{Variable}{specialmail}%
+priority key, ``A'' or ``B''. The Port-Pay\'e logo ``P.~P.'' uses the font
+style of element \FontElement{PPlogo}. The default font styles are listed in
+\autoref{tab:\LabelBase.AddresseeElements} and may be changed using commands
+\DescRef{\LabelBase.cmd.setkomafont} und
+\DescRef{\LabelBase.cmd.addtokomafont} (siehe
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}).%
+\EndIndexGroup
+
\begin{table}
\caption[{available values for option \Option{priority} in
\Class{scrlttr2}}]{available values for option \Option{priority} to select
the international priority at the address field of\Class{scrlttr2}}
- \label{tab:scrlttr2.priority}
+ \label{tab:\LabelBase.priority}
\begin{desctabular}
\entry{\PValue{false}, \PValue{off}, \PValue{no}, \PValue{manual}}{%
Priority will not be printed.}%
@@ -1871,8 +1735,8 @@ variable \Variable{fromzipcode} and the place from \PName{content} of variable
\PName{content} of variable \Variable{fromzipcode} will be preceded by the
\PName{description} of variable \Variable{fromzipcode} and the \PName{content}
of variable \Variable{zipcodeseparator}. The predefined \PName{description}
-depends on the used \File{lco}-file (see \autoref{sec:scrlttr2.lcoFile} from
-\autopageref{sec:scrlttr2.lcoFile} onward). On the other hand the default of
+depends on the used \File{lco}-file (see \autoref{sec:\LabelBase.lcoFile} from
+\autopageref{sec:\LabelBase.lcoFile} onward). On the other hand the default of
the \PName{content} of variable \Variable{zipcodeseparator} is a small
distance followed by an endash followed by one more small distance
(\Macro{,}\texttt{-{}-}\Macro{,}).
@@ -1884,20 +1748,15 @@ sender's identification code will be used at the Port-Pay\'e head. This is the
addressee an additional data array may be printed. The \PName{content} of
variable \Variable{PPdatamatrix} will be used for this.
-\BeginIndex{FontElement}{PPdata}%
+\BeginIndex{FontElement}{PPdata}\LabelFontElement{PPdata}%
Zip-code\ChangedAt{v3.03}{\Class{scrlttr2}}, place and code will be printed
with default font size 8\Unit{pt}. Thereby the font style of element
\FontElement{PPdata}\important{\FontElement{PPdata}} will be used. The default
-of the element is listed in \autoref{tab:scrlttr2.AddresseeElements} and may
-be changed using commands \Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}).%
+of the element is listed in \autoref{tab:\LabelBase.AddresseeElements} and may
+be changed using commands \DescRef{\LabelBase.cmd.setkomafont} and \DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}).%
\EndIndex{FontElement}{PPdata}%
-%
-\EndIndex{Variable}{PPcode}%
-\EndIndex{Variable}{place}%
-\EndIndex{Variable}{zipcodeseparator}%
-\EndIndex{Variable}{fromzipcode}%
With\important[i]{\begin{tabular}[t]{@{}l@{}}
\KOption{addrfield}\\\quad\PValue{backgroundimage}\end{tabular}\strut\\
@@ -1909,16 +1768,16 @@ for this. \KOMAScript{} does not use the \PName{description} of that
variable. Nothing else but the picture will be printed with option
\OptionValue{addrfield}{image}. But with option
\OptionValue{addrfield}{backgroundimage} the addressee's name and address from
-the mandatory argument of the \Environment{letter} environment will be
-output.
+the mandatory argument of the \DescRef{\LabelBase.env.letter} environment will
+be output.
The alignment of the Port-Pay\'e head as long as the alignment of the
Port-Pay\'e address is defined by pseudo-length \PLength{toaddrindent} (see
-\autopageref{desc:scrlttr2-experts.plength.toaddrindent}) as well as
+\DescPageRef{scrlttr2-experts.plength.toaddrindent}) as well as
\PLength{PPheadwidth} and \PLength{PPheadheight} (siehe
-\autopageref{desc:scrlttr2-experts.plength.PPheadheight}). The alignment of
+\DescPageRef{scrlttr2-experts.plength.PPheadheight}). The alignment of
the data array is defined by pseudo-length \PLength{PPdatamatrixvskip}
-(see \autopageref{desc:scrlttr2-experts.plength.PPdatamatrixvskip}).
+(see \DescPageRef{scrlttr2-experts.plength.PPdatamatrixvskip}).
Please note\textnote{Attention!} that \KOMAScript{} itself cannot set any
external graphics or pictures. So, if you want to put external picture files
@@ -1928,36 +1787,29 @@ have to use an additional graphics package like
\Package{graphicx}\IndexPackage{graphicx} to use, i.\,e., the command
\Macro{includegraphics} at the \PName{content} of the variables.%
%
-\EndIndex{Variable}{addresseeimage}%
-\EndIndex{Variable}{PPdatamatrix}%
-%
-\EndIndex{Option}{addrfield~=\PName{mode}}%
-\EndIndex{Option}{priority~=\PName{priority}}%
-%
-\EndIndex{}{Anschrift}
+\EndIndexGroup
\begin{Declaration}
- \KOption{locfield}\PName{selection}
+ \OptionVName{locfield}{selection}
\end{Declaration}
\BeginIndex{}{sender>additional information}%
-\BeginIndex{Option}{locfield~=\PName{selection}}%
\Class{scrlttr2} places a field with additional sender attributes next to the
address field. This can be used, for example, for bank account
or similar additional information.
-Depending\important[i]{\OptionValue{fromalign}{center}\\
+Depending\important[i]{\OptionValueRef{\LabelBase}{fromalign}{center}\\
\begin{tabular}[t]{@{}l@{}}
\KOption{fromalign}\\\quad\PValue{locationleft}\end{tabular}\\
\begin{tabular}[t]{@{}l@{}}
\KOption{fromalign}\\\quad\PValue{locationright}\end{tabular}} on the
-\Option{fromalign} option, it will also be used for the sender
-logo. The width of this field may be defined within an \File{lco} file
-(see \autoref{sec:scrlttr2.lcoFile}). If the width is set to 0 in that file,
+\DescRef{\LabelBase.option.fromalign} option, it will also be used for the
+sender logo. The width of this field may be defined within an \File{lco} file
+(see \autoref{sec:\LabelBase.lcoFile}). If the width is set to 0 in that file,
then the \Option{locfield} option can toggle between two presets for
-the field width. See the explanation on the \Variable{locwidth} pseudo
+the field width. See the explanation on the \PLength{locwidth} pseudo
length in \autoref{sec:scrlttr2-experts.locationField},
-\autopageref{desc:scrlttr2-experts.plength.locwidth}. Possible values for this
-option are shown in \autoref{tab:scrlttr2.locfield}. Default is
+\DescPageRef{scrlttr2-experts.plength.locwidth}. Possible values for this
+option are shown in \autoref{tab:\LabelBase.locfield}. Default is
\PValue{narrow}.%
%
\begin{table}
@@ -1970,7 +1822,7 @@ option are shown in \autoref{tab:scrlttr2.locfield}. Default is
\Class{scrlttr2}}]{Possible values of option \Option{locfield} for
setting the width of the field with additional sender attributes with
\Class{scrlttr2}%
- \label{tab:scrlttr2.locfield}}%
+ \label{tab:\LabelBase.locfield}}%
[l]
\begin{minipage}[t]{.45\linewidth}
\begin{desctabular}[t]
@@ -1982,10 +1834,9 @@ option are shown in \autoref{tab:scrlttr2.locfield}. Default is
\end{table}
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{location}}%
- \OParameter{description}\Parameter{content}
+ \Variable{location}%
\end{Declaration}
-\BeginIndex{Variable}{location}%
+\BeginIndex{}{sender>additional information}%
The contents of the sender's extension field is determined by the
variable \Variable{location}. To set this variable's \PName{content}, it is
permitted to use formatting commands like \Macro{raggedright}. \KOMAScript{}
@@ -1996,7 +1847,7 @@ does not use the \PName{description} of the variable.
membership. Therefor he uses the \Variable{location} variable:%
\lstinputcode[xleftmargin=1em]{letter-19.tex}%
This will define the field beside the addressee's address like shown in
- \autoref{fig:scrlttr2.letter-19}.
+ \autoref{fig:\LabelBase.letter-19}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with extended sender, logo,
@@ -2009,59 +1860,54 @@ does not use the \PName{description} of the variable.
mark (the date is a default of DIN-letters)}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-19}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-19}
+ \label{fig:\LabelBase.letter-19}
\end{figure}
\end{Example}
%
-\EndIndex{Variable}{location}%
+\EndIndexGroup
%
-\EndIndex{Option}{locfield~=\PName{selection}}%
-%
-\EndIndex{}{sender>additional information}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{numericaldate}\PName{simple switch}
+ \OptionVName{numericaldate}{simple switch}
\end{Declaration}
-\BeginIndex{Option}{numericaldate~=\PName{simple switch}}%
This option toggles between the standard, language-dependent
date\Index{date}\Index{reference line} presentation, and a short, numerical
one. {\KOMAScript} does not provide the standard presentation. It should be
defined by packages such as \Package{ngerman}\IndexPackage{ngerman},
\Package{babel}\IndexPackage{babel}, or
-\Package{isodate}\IndexPackage{isodate}. The\important{\OptionValue{numericaldate}{true}}
-short, numerical presentation, on the other hand, is produced by
-\Class{scrlttr2} itself. This option can take the standard values for simple
-switches, as listed in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is \PValue{false}, which results in
-standard date presentation.
+\Package{isodate}\IndexPackage{isodate}.
+The\important{\OptionValue{numericaldate}{true}} short, numerical
+presentation, on the other hand, is produced by \Class{scrlttr2} itself. This
+option can take the standard values for simple switches, as listed in
+\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. Default is
+\PValue{false}, which results in standard date presentation.
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{date}}%
- \OParameter{description}\Parameter{content}
+ \Variable{date}%
\end{Declaration}
-\BeginIndex{Variable}{date}%
The date in the selected presentation will become the \PName{content} of
-variable \Variable{date}. The selection of option \Option{numericaldate}
-does not influence the date any longer, if the \PName{content} of this variable
-will be changed by the user. Normally the date will be part of the reference
-line. If all other elements of the reference line will be empty and therefore
-unused a date line instead of a reference line will be printed. See the
-description of variable \Variable{place} on
-\autopageref{desc:scrlttr2.variable.placeseparator} for more information about
+variable \Variable{date}. The selection of option
+\DescRef{\LabelBase.option.numericaldate} does not influence the date any
+longer, if the \PName{content} of this variable will be changed by the
+user. Normally the date will be part of the reference line. If all other
+elements of the reference line will be empty and therefore unused a date line
+instead of a reference line will be printed. See the description of variable
+\DescRef{\LabelBase.variable.place} on
+\DescPageRef{\LabelBase.variable.placeseparator} for more information about
the date line. You should note, that you can change the automatic printing of
-the date using option \Option{refline}, that will be described next.
+the date using option \DescRef{\LabelBase.option.refline}, that will be described next.
%
-\EndIndex{Variable}{date}%
-\EndIndex{Option}{numericaldate~=\PName{switch}}%
+\EndIndexGroup
+\EndIndexGroup
\begin{Declaration}
- \KOption{refline}\PName{selection}
+ \OptionVName{refline}{selection}
\end{Declaration}
\BeginIndex{}{reference line}%
\index{business line|see{reference line}}% |
-\BeginIndex{Option}{refline~=\PName{selection}}%
Especially in business letters a line with information like identification
code\Index{identification>code}, direct dial, customer's number, invoice's
number, or references to previous letters may be found usually. This line will
@@ -2072,7 +1918,7 @@ attributes may extend beyond the normal type area to the left and to the
right. Option \OptionValue{refline}{wide} defines that this should also apply to
the reference fields line. Normally, the reference fields line contains at
least the date, but it can hold additional data. Possible values for this
-option are shown in \autoref{tab:scrlttr2.refline}. Default is \PValue{narrow}
+option are shown in \autoref{tab:\LabelBase.refline}. Default is \PValue{narrow}
and \PValue{dateright}\ChangedAt{v3.09}{\Class{scrlttr2}}.%
%
\begin{table}
@@ -2080,7 +1926,7 @@ and \PValue{dateright}\ChangedAt{v3.09}{\Class{scrlttr2}}.%
\Class{scrlttr2}}]{Possible value of option \Option{refline} for setting
the width of the reference fields line with
\Class{scrlttr2}}
- \label{tab:scrlttr2.refline}
+ \label{tab:\LabelBase.refline}
\begin{desctabular}
\pventry{dateleft}{\ChangedAt{v3.09}{\Class{scrlttr2}}%
The date will be placed leftmost at the reference line.}%
@@ -2096,29 +1942,19 @@ and \PValue{dateright}\ChangedAt{v3.09}{\Class{scrlttr2}}.%
\end{table}
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{yourref}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{yourmail}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{myref}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{customer}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{invoice}}%
- \OParameter{description}\Parameter{content}%
+ \Variable{yourref}%
+ \Variable{yourmail}%
+ \Variable{myref}%
+ \Variable{customer}%
+ \Variable{invoice}%
\end{Declaration}
-\BeginIndex{Variable}{yourref}%
-\BeginIndex{Variable}{yourmail}%
-\BeginIndex{Variable}{myref}%
-\BeginIndex{Variable}{customer}%
-\BeginIndex{Variable}{invoice}%
These five variables represent typical fields of the reference line. Their
-meanings are given in \autoref{tab:scrlttr2.variables} on
-\autopageref{tab:scrlttr2.variables}. Each variable has also a predefined
-\PName{description}, shown in \autoref{tab:scrlttr2.reflineTerm}. Additional
+meanings are given in \autoref{tab:\LabelBase.variables} on
+\autopageref{tab:\LabelBase.variables}. Each variable has also a predefined
+\PName{description}, shown in \autoref{tab:\LabelBase.reflineTerm}. Additional
information about adding other variables to the reference line may be found
in \autoref{sec:scrlttr2-experts.variables} from
-\autopageref{desc:scrlttr2-experts.cmd.newkomavar} onward.%
+\DescPageRef{scrlttr2-experts.cmd.newkomavar} onward.%
%
\begin{table}
% \centering
@@ -2133,29 +1969,29 @@ in \autoref{sec:scrlttr2-experts.variables} from
\toprule
variable name & description & e.\,g., in english \\
\midrule
- \Variable{yourref} & \Macro{yourrefname} & Your reference \\
- \Variable{yourmail} & \Macro{yourmailname} & Your letter from \\
- \Variable{myref} & \Macro{myrefname} & Our reference \\
- \Variable{customer} & \Macro{customername} & Customer No.: \\
- \Variable{invoice} & \Macro{invoicename} & Invoice No.: \\
- \Variable{date} & \Macro{datename} & date \\
+ \Variable{yourref} & \DescRef{scrlttr2-experts.cmd.yourrefname} & Your reference \\
+ \Variable{yourmail} & \DescRef{scrlttr2-experts.cmd.yourmailname} & Your letter from \\
+ \Variable{myref} & \DescRef{scrlttr2-experts.cmd.myrefname} & Our reference \\
+ \Variable{customer} & \DescRef{scrlttr2-experts.cmd.customername} & Customer No.: \\
+ \Variable{invoice} & \DescRef{scrlttr2-experts.cmd.invoicename} & Invoice No.: \\
+ \DescRef{\LabelBase.variable.date} & \DescRef{scrlttr2-experts.cmd.datename} & date \\
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:scrlttr2.reflineTerm}
+ \label{tab:\LabelBase.reflineTerm}
\end{table}
-\BeginIndex{FontElement}{refname}%
-\BeginIndex{FontElement}{refvalue}%
+\BeginIndex{FontElement}{refname}\LabelFontElement{refname}%
+\BeginIndex{FontElement}{refvalue}\LabelFontElement{refvalue}%
Font style and color\ChangedAt{v2.97c}{\Class{scrlttr2}} of the
\PName{description} and \PName{content} of the fields of the reference line
may be changed with elements \FontElement{refname}%
\important[i]{\FontElement{refname}\\\FontElement{refvalue}} and
-\FontElement{refvalue}. Therefor the commands \Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}) should be used. The default
+\FontElement{refvalue}. Therefor the commands \DescRef{\LabelBase.cmd.setkomafont} and \DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}) should be used. The default
configuration of both elements is listed in
-\autoref{tab:scrlttr2.refnamerefvalue}.%
+\autoref{tab:\LabelBase.refnamerefvalue}.%
\begin{table}[tp]
% \centering
\KOMAoptions{captions=topbeside}%
@@ -2164,14 +2000,14 @@ configuration of both elements is listed in
\begin{captionbeside}
[{font style default of elements of the reference line}]{default font
style configuration of the elements of the reference line%
- \label{tab:scrlttr2.refnamerefvalue}}
+ \label{tab:\LabelBase.refnamerefvalue}}
[l]
\begin{tabular}[t]{ll}
\toprule
element & default configuration \\
\midrule
- \FontElement{refname} & \Macro{sffamily}\Macro{scriptsize} \\
- \FontElement{refvalue} & \\
+ \DescRef{\LabelBase.fontelement.refname} & \Macro{sffamily}\Macro{scriptsize} \\
+ \DescRef{\LabelBase.fontelement.refvalue} & \\
\bottomrule
\end{tabular}
\end{captionbeside}
@@ -2179,45 +2015,43 @@ configuration of both elements is listed in
%
\EndIndex{FontElement}{refvalue}%
\EndIndex{FontElement}{refname}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{place}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{placeseparator}}%
- \OParameter{description}\Parameter{content}
+ \Variable{placeseparator}%
\end{Declaration}%
\BeginIndex{Variable}{place}%
-\BeginIndex{Variable}{placeseparator}%
If all variables of the reference line are empty, the line will be omitted.
-In this case, the \PName{content} of \Variable{place} and
+In this case, the \PName{content} of \DescRef{\LabelBase.variable.place} and
\Variable{placeseparator} will be set, followed by the \PName{content} of
-\Variable{date}. The predefined \PName{content} of the
+\DescRef{\LabelBase.variable.date}. The predefined \PName{content} of the
\Variable{placeseparator} is a comma followed by a non-breaking space. If the
-variable \Variable{place} has no \PName{content} value then the hyphen remains
-unset also. The predefined \PName{content} of \Variable{date} is
-\Macro{today}\IndexCmd{today} and depends on the setting of the option
-\Option{numericaldate} (see \autopageref{desc:scrlttr2.option.numericaldate}).
+variable \DescRef{\LabelBase.variable.place} has no \PName{content} value then
+the hyphen remains unset also. The predefined \PName{content} of
+\DescRef{\LabelBase.variable.date} is \Macro{today}\IndexCmd{today} and
+depends on the setting of the option \DescRef{\LabelBase.option.numericaldate}
+(see \DescPageRef{\LabelBase.option.numericaldate}).
Since version~3.09\ChangedAt{v3.09}{\Class{scrlttr2}} place and date the
-alignment of place and date is given by option \Option{refline}. The available
-alignment values for this option are listed in \autoref{tab:scrlttr2.refline}.
+alignment of place and date is given by option \DescRef{\LabelBase.option.refline}. The available
+alignment values for this option are listed in \autoref{tab:\LabelBase.refline}.
-\BeginIndex{FontElement}{placeanddate}%
+\BeginIndex{FontElement}{placeanddate}\LabelFontElement{placeanddate}%
The\ChangedAt{v3.12}{\Class{scrlttr2}} font setting of place and date in the
date line are given by font
element\FontElement{placeanddate}\important[i]{\FontElement{placeanddate}}
-instead of element \FontElement{refvalue}, which would be used for general
+instead of element \DescRef{\LabelBase.fontelement.refvalue}, which would be used for general
reference lines. You can change the empty default of the font element using
-commands \Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}).%
+commands \DescRef{\LabelBase.cmd.setkomafont} and \DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}).%
\EndIndex{FontElement}{placeanddate}%
\begin{Example}
Now Mr Public also sets the place:%
\lstinputcode[xleftmargin=1em]{letter-20.tex}%
- In this case \autoref{fig:scrlttr2.letter-20} shows the place and the
+ In this case \autoref{fig:\LabelBase.letter-20} shows the place and the
automatic separator in front of the date. The date has been defined
explicitly to make the printed date independent from the date of the
\LaTeX{} run.
@@ -2233,37 +2067,28 @@ commands \Macro{setkomafont} and \Macro{addtokomafont} (see
mark}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-20}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-20}
+ \label{fig:\LabelBase.letter-20}
\end{figure}
\end{Example}
%
-\EndIndex{Variable}{place}%
-\EndIndex{Variable}{placeseparator}%
- %
-\EndIndex{Variable}{invoice}%
-\EndIndex{Variable}{customer}%
-\EndIndex{Variable}{myref}%
-\EndIndex{Variable}{yourmail}%
-\EndIndex{Variable}{yourref}%
+\EndIndexGroup
%
-\EndIndex{Option}{refline~=\PName{selection}}%
-\EndIndex{}{reference line}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{title}}%
- \OParameter{description}\Parameter{content}
+ \Variable{title}%
\end{Declaration}
\BeginIndex{}{title}%
-\BeginIndex{Variable}{title}%
-\BeginIndex{FontElement}{lettertitle}%
-\BeginIndex{FontElement}{title}%
+\BeginIndex{FontElement}{lettertitle}\LabelFontElement{lettertitle}%
+\BeginIndex{FontElement}{title}\LabelFontElement{title}%
With \Class{scrlttr2} a letter can carry an additional title. The title is
centered and set with font size \Macro{LARGE} directly after and beneath the
reference fields line. The predefined font setup for the element
\FontElement{lettertitle}\important{\FontElement{lettertitle}} can be changed
-with commands \Macro{setkomafont} und \Macro{addtokomafont} (see
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}). Font size declarations are
+with commands \DescRef{\LabelBase.cmd.setkomafont} und \DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). Font size declarations are
allowed. Font size \Macro{LARGE} is not part of the predefined default
\Macro{normalcolor}\Macro{sffamily}\Macro{bfseries} but nevertheless will be
used before the font style of the element. With \Class{scrlttr2} you can also
@@ -2283,26 +2108,20 @@ a \KOMAScript{} class, because these classes already define an element
Like shown in the example, the \PName{content} of the variable defines the
title. \KOMAScript{} will not use the \PName{description}.%
%
-\EndIndex{Variable}{title}%
-\EndIndex{}{title}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{subject}\PName{selection}\\
- \Macro{setkomavar}\PParameter{\Variable{subject}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{subjectseparator}}%
- \OParameter{description}\Parameter{content}
+ \OptionVName{subject}{selection}%
+ \Variable{subject}%
+ \Variable{subjectseparator}%
\end{Declaration}
\BeginIndex{}{subject}%
-\BeginIndex{Option}{subject~=\PName{selection}}%
-\BeginIndex{Variable}{subject}%
-\BeginIndex{Variable}{subjectseparator}%
In case a subject should be set, the \PName{content} of the variable
\Variable{subject} need to be defined. First of all with option
\OptionValue{subject}{true}\important{\OptionValue{subject}{titled}} the usage
of the \PName{description} before the output of the subject may be
-configured. See \autoref{tab:scrlttr2.subjectTerm} for the predefined
+configured. See \autoref{tab:\LabelBase.subjectTerm} for the predefined
\PName{description}. In case of using the \PName{description} the
\PName{content} of variable \Variable{subjectseparator}\Index{separator} will
be set between the \PName{description} and \PName{content} of the
@@ -2320,15 +2139,15 @@ is a colon followed by a white space.
\toprule
variable name & description \\
\midrule
- \Variable{subject} & \Macro{usekomavar*}\PParameter{subjectseparator}%
+ \Variable{subject} & \DescRef{\LabelBase.cmd.usekomavar*}\PParameter{subjectseparator}%
\texttt{\%} \\
& \texttt{\quad}%
- \Macro{usekomavar}\PParameter{subjectseparator} \\
- \Variable{subjectseparator} & \Macro{subjectname} \\
+ \DescRef{\LabelBase.cmd.usekomavar}\PParameter{subjectseparator} \\
+ \Variable{subjectseparator} & \DescRef{scrlttr2-experts.cmd.subjectname} \\
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:scrlttr2.subjectTerm}
+ \label{tab:\LabelBase.subjectTerm}
\end{table}
On the other hand, \OptionValue{subject}{afteropening}%
@@ -2339,7 +2158,7 @@ formatting\important[i]{\OptionValue{subject}{underlined}\\
\OptionValue{subject}{right}} of the subject may be changed using either
\OptionValue{subject}{underlined}, \OptionValue{subject}{centered}, or
\OptionValue{subject}{right}\ChangedAt{v2.97c}{\Class{scrlttr2}}. All
-available values are listed in \autoref{tab:scrlttr2.subject}. Please
+available values are listed in \autoref{tab:\LabelBase.subject}. Please
note\textnote{Attention!}, that with option \OptionValue{subject}{underlined}
the while subject must fit at one line! Defaults are
\OptionValue{subject}{left}, \OptionValue{subject}{beforeopening}, and
@@ -2354,7 +2173,7 @@ the while subject must fit at one line! Defaults are
[{available values of option \Option{subject} with \Class{scrlttr2}}]
{available values of option \Option{subject} for the position and
formatting of the subject with
- \Class{scrlttr2}\label{tab:scrlttr2.subject}}%
+ \Class{scrlttr2}\label{tab:\LabelBase.subject}}%
[l]
\begin{minipage}[t]{.6\linewidth}
\begin{desctabular}[t]
@@ -2371,12 +2190,13 @@ the while subject must fit at one line! Defaults are
\end{captionbeside}
\end{table}
-\BeginIndex{FontElement}{lettersubject}%
-\BeginIndex{FontElement}{subject}%
+\BeginIndex{FontElement}{lettersubject}\LabelFontElement{lettersubject}%
+\BeginIndex{FontElement}{subject}\LabelFontElement{subject}%
The subject line is set in a separate font\Index{font>style}. To change this
-use the commands \Macro{setkomafont} and \Macro{addtokomafont} (siehe
-\autoref{sec:scrlttr2.textmarkup},
-\autopageref{desc:scrlttr2.cmd.setkomafont}). For element
+use the commands \DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} (siehe
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). For element
\FontElement{lettersubject}\important{\FontElement{lettersubject}} the
predetermined font is \Macro{normalcolor}\Macro{bfseries}. With
\Class{scrlttr2} you can also use
@@ -2391,7 +2211,7 @@ with a \KOMAScript{} class, because these classes already define an element
to have a kind of heading to the subject and therefor sets the corresponding
option:%
\lstinputcode[xleftmargin=1em]{letter-21.tex}%
- The result is shown by \autoref{fig:scrlttr2.letter-21}.
+ The result is shown by \autoref{fig:\LabelBase.letter-21}.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with extended sender, logo,
@@ -2404,42 +2224,39 @@ with a \KOMAScript{} class, because these classes already define an element
puncher hole mark}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-21}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-21}
+ \label{fig:\LabelBase.letter-21}
\end{figure}
\end{Example}
%
-\EndIndex{Variable}{subjectseparator}%
-\EndIndex{Variable}{subject}%
-\EndIndex{Option}{subject~=\PName{selection}}%
-\EndIndex{}{subject}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{firstfoot}\PName{simple switch}
+ \OptionVName{firstfoot}{simple switch}
\end{Declaration}
\BeginIndex{}{letter>foot}%
\BeginIndex{}{letterfoot}%
-\BeginIndex{Option}{firstfoot~=\PName{simple switch}}%
This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the
letterfoot is set or not. Switching off the letterfoot, e.\,g., using
\OptionValue{firstfoot}{false}\important{\OptionValue{firstfoot}{false}}, has
-an effect when the option \Option{enlargefirstpage} (see
-\autopageref{desc:scrlttr2.option.enlargefirstpage}) is used concurrently. In
+an effect when the option \DescRef{\LabelBase.option.enlargefirstpage} (see
+\DescPageRef{\LabelBase.option.enlargefirstpage}) is used concurrently. In
this case the text area of the page will be enlarged down to the bottom. Then
the normal distance between typing area and the letter foot will become the
-only distance remaining between the end of the typing area and the end of
-the page.
+only distance remaining between the end of the typing area and the end of the
+page.
The option understands the standard values for simple switches, as given in
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. Default is
the setting of the letter foot.
-\EndIndex{Option}{firstfoot~=\PName{simple switch}}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{firstfoot}}%
- \OParameter{description}\Parameter{content}
+ \Variable{firstfoot}%
\end{Declaration}%
-\BeginIndex{Variable}{firstfoot}%
+\BeginIndex{}{letter>foot}%
+\BeginIndex{}{letterfoot}%
The first page's footer is preset to
empty. However\ChangedAt{v3.08}{\Class{scrlttr2}}, a new construction may be
made at the \PName{content} of variable \Variable{firstfoot}. \KOMAScript{}
@@ -2450,15 +2267,13 @@ deprecated command \Macro{firstfoot}\IndexCmd[indexmain]{firstfoot} of
be used any longer.
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{frombank}}%
- \OParameter{description}\Parameter{content}
+ \Variable{frombank}%
\end{Declaration}%
-\BeginIndex{Variable}{frombank}%
This variable at the moment takes on a special meaning: it is not used
internally at this point, and the user can make use of it to set, for example,
his bank account\Index{bank account} within the sender's additional
-information (see variable \Variable{location},
-\autopageref{desc:scrlttr2.variable.location}) or the footer.%
+information (see variable \DescRef{\LabelBase.variable.location},
+\DescPageRef{\LabelBase.variable.location}) or the footer.%
%
\begin{Example}
In the first page's footer, you may want to set the \PName{content} of the
@@ -2515,29 +2330,27 @@ information (see variable \Variable{location},
% described above in this section.
\end{Example}
In the previous example a multi-line footer was set. With a compatibility
-setting to version 2.9u (see \Option{version} in
-\autoref{sec:scrlttr2.compatibilityOptions},
-\autopageref{desc:scrlttr2.option.version}) the space will in general not
+setting to version 2.9u (see \DescRef{\LabelBase.option.version} in
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}) the space will in general not
suffice. In that case, you may need to reduce \PLength{firstfootvpos} (see
-\autopageref{desc:scrlttr2-experts.plength.firstfootvpos}) appropriately.%
+\DescPageRef{scrlttr2-experts.plength.firstfootvpos}) appropriately.%
%
-\EndIndex{Variable}{frombank}%
-\EndIndex{Variable}{firstfoot}%
+\EndIndexGroup
%
-\EndIndex{}{letter>foot}%
-\EndIndex{}{letterfoot}%
+\EndIndexGroup
%
-\EndIndex{}{letter>first page}%
-\EndIndex{}{note paper}%
+\EndIndexGroup
-\LoadCommon[scrlttr]{6} % \section{Paragraph Markup}
+\LoadCommonFile{parmarkup} % \section{Paragraph Markup}
-\LoadCommon[scrlttr]{7} % \section{Detection of Odd and Even Pages}
+\LoadCommonFile{oddorevenpage} % \section{Detection of Odd and Even Pages}
\section{Head and Foot Using Predefined Page Style}
\seclabel{pagestyle}
+\BeginIndexGroup
\BeginIndex{}{page>style}%
\BeginIndex{}{page>head}%
\BeginIndex{}{page>foot}%
@@ -2545,7 +2358,7 @@ suffice. In that case, you may need to reduce \PLength{firstfootvpos} (see
One of the general properties of a document is the page style. In {\LaTeX}
this means mostly the contents of headers and
footers. Like\textnote{Attention!} already mentioned in
-\autoref{sec:scrlttr2.firstpage}, the head and foot of the note paper are
+\autoref{sec:\LabelBase.firstpage}, the head and foot of the note paper are
treated as elements of the note paper. Therefore they do not depend on the
settings of the page style. So this section describes the page styles of the
consecutive pages of letter after the note paper. At single-side letters this is
@@ -2556,7 +2369,6 @@ also the page style of all backsides.
\begin{Declaration}
\Macro{letterpagestyle}
\end{Declaration}
-\BeginIndex{Cmd}{letterpagestyle}%
The\ChangedAt{v3.19}{\Class{scrlttr2}\and \Package{scrletter}} default page
style used for letters is specified by the contents of command
\Macro{letterpagestyle}. With \Class{scrlttr2} an empty value has been
@@ -2564,15 +2376,15 @@ predefined that does not change the
page style of the letter from the page style of the document. This has been
done, because \Class{scrlttr2} has been made for letter-only-documents. So it
is much easier to define the page style of all letters with the page style of
-the document using \Macro{pagestyle} inside the preamble or before starting
+the document using \DescRef{\LabelBase.cmd.pagestyle} inside the preamble or before starting
the first letter.
-The \Pagestyle{plain} page style of letters differs from the \Pagestyle{plain}
+The \PageStyle{plain} page style of letters differs from the \PageStyle{plain}
page style of most classes. Therefore package \Package{scrletter} defines
\Macro{letterpagestyle} with the contents
-\Pagestyle{plain.letter}\IndexPagestyle{plain.letter}. So all letters will use
-the \Pagestyle{plain} style of page style pair
-\Pagestyle{letter}\IndexPagestyle{letter} by default and independent from the
+\PageStyle{plain.letter}\IndexPagestyle{plain.letter}. So all letters will use
+the \PageStyle{plain} style of page style pair
+\PageStyle{letter}\IndexPagestyle{letter} by default and independent from the
page style of the rest of the document. See
\autoref{sec:scrlttr2-experts.pagestyleatscrletter} for more information about
the characteristics of the page style of package \Package{scrletter}.
@@ -2585,19 +2397,17 @@ the characteristics of the page style of package \Package{scrletter}.
in your document preamble. Take care about the star of
\Macro{renewcommand*}!
\end{Example}
-Nevertheless, if you use \Macro{pagestyle} or \Macro{thispagestyle} inside a
+Nevertheless, if you use \DescRef{\LabelBase.cmd.pagestyle} or \DescRef{\LabelBase.cmd.thispagestyle} inside a
letter, this will overwrite the setting of \Macro{letterpagestyle} that is
only the default for the initialisation inside
\Macro{begin}\PParameter{document}.%
-\EndIndex{Cmd}{letterpagestyle}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{headsepline}\PName{simple switch}\\
- \KOption{footsepline}\PName{simple switch}
+ \OptionVName{headsepline}{simple switch}%
+ \OptionVName{footsepline}{simple switch}
\end{Declaration}
-\BeginIndex{Option}{headsepline~=\PName{simple switch}}%
-\BeginIndex{Option}{footsepline~=\PName{simple switch}}%
These two options select whether or not to insert a separator
line\Index{line>separator}\Index{rule>separator} below the header or above the
footer, respectively, on consecutive pages. This option can take the standard
@@ -2610,54 +2420,52 @@ head. Activation\important{\OptionValue{footsepline}{true}} of option
the options switches of the corresponding rules.
Obviously option \Option{headsepline} does not influence page style
-\PValue{empty}\important[i]{\Pagestyle{empty}} (see afterwards at this
+\PValue{empty}\important[i]{\PageStyle{empty}} (see afterwards at this
section). This page style explicitly does not use any page head.
-Typographically\important[i]{\Pagestyle{headings}\\
- \Pagestyle{myheadings}\\\Pagestyle{plain}} such a rule make a hard optical
+Typographically\important[i]{\PageStyle{headings}\\
+ \PageStyle{myheadings}\\\PageStyle{plain}} such a rule make a hard optical
connection of head or foot and the text area. This would not mean, that the
distance between head and text or text and foot should be increased. Instead
of this the head or foot should be seen as parts of the typing area, while
calculation of margins and typing area. To achieve this \KOMAScript{} will
-pass option
-\Option{headinclude}\important[i]{\Opton{headinclude}\\
- \Option{footinclude}} or \Option{footinclude}, respectively, to the
-\Package{typearea} package, if option \Option{headsepline} or
-\Option{footsepline}, respectively, are used as a class
-option. In\important{\Pagestyle{plain}} opposite to \Option{headsepline}
-option \Option{footsepline} does influence page style \PValue{plain} also,
-because \PValue{plain} uses a page number at the foot. Package
-\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}%
+pass option \DescRef{typearea.option.headinclude}%
+\important[i]{\DescRef{typearea.option.headinclude}\\
+ \DescRef{typearea.option.footinclude}} or
+\DescRef{typearea.option.footinclude}, respectively, to the \Package{typearea}
+package, if option \Option{headsepline} or \Option{footsepline}, respectively,
+are used as a class option. In\important{\PageStyle{plain}} opposite to
+\Option{headsepline} option \Option{footsepline} does influence page style
+\PValue{plain} also, because \PValue{plain} uses a page number at the
+foot. Package \Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}%
\important{\Package{scrlayer-scrpage}} (see \autoref{cha:scrlayer-scrpage})
provides additional features for rules at head and foot and may be combined
with \Class{scrlttr2}.%
%
-\EndIndex{Option}{headsepline~=\PName{simple switch}}%
-\EndIndex{Option}{footsepline~=\PName{simple switch}}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{pagenumber}\PName{position}
+ \OptionVName{pagenumber}{position}
\end{Declaration}
-\BeginIndex{Option}{pagenumber~=\PName{position}}%
This option defines if and where a page number will be placed on consecutive
pages. This option affects the page
-styles\important[i]{\Pagestyle{headings}\\
- \Pagestyle{myheadings}\\
- \Pagestyle{plain}} \Pagestyle{headings}, \Pagestyle{myheadings}, and
-\Pagestyle{plain}. It also affects the default page styles of the
+styles\important[i]{\PageStyle{headings}\\
+ \PageStyle{myheadings}\\
+ \PageStyle{plain}} \PageStyle{headings}, \PageStyle{myheadings}, and
+\PageStyle{plain}. It also affects the default page styles of the
\Package{scrlayer-scrpage}\important{\Package{scrlayer-scrpage}} package, if
set before loading the package (see \autoref{cha:scrlayer-scrpage}). It can
take values only influencing horizontal, only vertical, or both
positions. Available value are shown in
-\autoref{tab:scrlttr2.pagenumber}. Default is \PValue{botcenter}.
+\autoref{tab:\LabelBase.pagenumber}. Default is \PValue{botcenter}.
\begin{table}
\caption[{available values of option \Option{pagenumber} with
\Class{scrlttr2}}]{available values of option \Option{pagenumber} for the
- position of the page number in page styles \Pagestyle{headings},
- \Pagestyle{myheadings}, and \PValue{plain} with \Class{scrlttr2}}
- \label{tab:scrlttr2.pagenumber}
+ position of the page number in page styles \PageStyle{headings},
+ \PageStyle{myheadings}, and \PValue{plain} with \Class{scrlttr2}}
+ \label{tab:\LabelBase.pagenumber}
\begin{desctabular}
\entry{\PValue{bot}, \PValue{foot}}{%
page number in footer, horizontal position not changed}%
@@ -2688,69 +2496,74 @@ positions. Available value are shown in
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{pagenumber~=\PName{position}}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{pagestyle}\Parameter{page style}\\
+ \Macro{pagestyle}\Parameter{page style}%
\Macro{thispagestyle}\Parameter{local page style}
\end{Declaration}%
-\BeginIndex{Cmd}{pagestyle}%
-\BeginIndex{Cmd}{thispagestyle}%
-\BeginIndex{Pagestyle}{empty}%
-\BeginIndex{Pagestyle}{plain}%
-\BeginIndex{Pagestyle}{headings}%
-\BeginIndex{Pagestyle}{myheadings}%
In letters written with \Class{scrlttr2} there are four different
page styles.
\begin{description}
-\item[\Pagestyle{empty}] is the page style, in which the header and footer of
- consecutive pages are completely
- empty. This page style is also used for the first page, because
- header and footer of this page are set by other means using the
- macro \Macro{opening}\IndexCmd{opening} (see
- \autoref{sec:scrlttr2.firstpage}, \autopageref{desc:scrlttr2.cmd.opening}).
-\item[\Pagestyle{headings}] is the page style for running (automatic) headings
- on consecutive pages. The inserted marks are the sender's name from the
- variable \Variable{fromname}\IndexVariable{fromname} and the subject from
- the variable \Variable{subject}\IndexVariable{subject} (see
- \autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.fromname} and
- \autopageref{desc:scrlttr2.variable.subject}). At which position these
- marks and the page numbers are placed, depends on the previously described
- option \Option{pagenumber} and the \PName{content} of the variables
- \Variable{nexthead}\IndexVariable{nexthead} and
- \Variable{nextfoot}\IndexVariable{nextfoot}. The author can also change
- these marks manually after the \Macro{opening} command. To this end, the
- commands \Macro{markboth} and \Macro{markright} are available as usual, and
- with the use of package \Package{scrlayer-scrpage} also \Macro{markleft}
- (see \autoref{sec:scrlayer-scrpage.pagestyle.content},
- \autopageref{desc:scrlayer-scrpage.cmd.automark}) is available.
-\item[\Pagestyle{myheadings}] is the page style for manual page headings on
- consecutive pages. This is very similar to \PValue{headings}, but
- here the marks must be set by the author using the commands
- \Macro{markboth}\IndexCmd{markboth} and
- \Macro{markright}\Index{markright}. With the use of package
- \Package{scrlayer-scrpage} also \Macro{markleft} can be utilized.
-\item[\Pagestyle{plain}] is the page style with only page numbers in the
- header or footer on consecutive pages. The placement of these page numbers is
- influenced by the previously described option \Option{pagenumber}.
+\item[{\PageStyle{empty}%
+ \IndexPagestyle[indexmain]{empty}\LabelPageStyle{empty}}] is the page
+ style, in which the header and footer of consecutive pages are completely
+ empty. This page style is also used for the first page, because header and
+ footer of this page are set by other means using the macro
+ \DescRef{\LabelBase.cmd.opening}\IndexCmd{opening} (see
+ \autoref{sec:\LabelBase.firstpage}, \DescPageRef{\LabelBase.cmd.opening}).
+\item[{\PageStyle{headings}%
+ \IndexPagestyle[indexmain]{headings}\LabelPageStyle{heading}}] is the page
+ style for running (automatic) headings on consecutive pages. The inserted
+ marks are the sender's name from the variable
+ \DescRef{\LabelBase.variable.fromname}\IndexVariable{fromname} and the
+ subject from the variable \DescRef{\LabelBase.variable.subject}\IndexVariable{subject} (see
+ \autoref{sec:\LabelBase.firstpage},
+ \DescPageRef{\LabelBase.variable.fromname} and
+ \DescPageRef{\LabelBase.variable.subject}). At which position these marks
+ and the page numbers are placed, depends on the previously described option
+ \DescRef{\LabelBase.option.pagenumber} and the \PName{content} of the variables
+ \DescRef{\LabelBase.variable.nexthead}\IndexVariable{nexthead} and
+ \DescRef{\LabelBase.variable.nextfoot}\IndexVariable{nextfoot}. The author can also change
+ these marks manually after the \DescRef{\LabelBase.cmd.opening} command. To
+ this end, the commands \DescRef{\LabelBase.cmd.markboth} and
+ \DescRef{\LabelBase.cmd.markright} are available as usual, and with the use
+ of package \Package{scrlayer-scrpage} also
+ \DescRef{scrlayer-scrpage.cmd.markleft} (see
+ \autoref{sec:scrlayer-scrpage.pagestyle.content},
+ \DescPageRef{scrlayer-scrpage.cmd.automark}) is available.
+\item[{\PageStyle{myheadings}%
+ \IndexPagestyle[indexmain]{myheadings}\LabelPageStyle{myheadings}}] is the
+ page style for manual page headings on consecutive pages. This is very
+ similar to \PValue{headings}, but here the marks must be set by the author
+ using the commands \DescRef{\LabelBase.cmd.markboth}\IndexCmd{markboth} and
+ \DescRef{\LabelBase.cmd.markright}\Index{markright}. With the use of package
+ \Package{scrlayer-scrpage} also \DescRef{scrlayer-scrpage.cmd.markleft} can be utilized.
+\item[{\PageStyle{plain}%
+ \IndexPagestyle[indexmain]{plain}\LabelPageStyle{plain}}] is the page
+ style with only page numbers in the header or footer on consecutive
+ pages. The placement of these page numbers is influenced by the previously
+ described option \DescRef{\LabelBase.option.pagenumber}.
\end{description}
Page styles are also influenced by the previously described
-options\important[i]{\Option{headsepline}\\\Option{footsepline}}
-\Option{headsepline}\IndexOption{headsepline} and
-\Option{footsepline}\IndexOption{footsepline}. The page style beginning with
-the current page is switched using \Macro{pagestyle}. In contrast,
-\Macro{thispagestyle} changes only the page style of the current
+options\important[i]{\DescRef{\LabelBase.option.headsepline}\\
+ \DescRef{\LabelBase.option.footsepline}}
+\DescRef{\LabelBase.option.headsepline}\IndexOption{headsepline} and
+\DescRef{\LabelBase.option.footsepline}\IndexOption{footsepline}. The page
+style beginning with the current page is switched using \Macro{pagestyle}. In
+contrast, \Macro{thispagestyle} changes only the page style of the current
page. The\textnote{Attention!} letter class itself uses
\Macro{thispagestyle}\PParameter{empty} within
-\Macro{opening}\IndexCmd{opening} for the first page of the letter.
+\DescRef{\LabelBase.cmd.opening}\IndexCmd{opening} for the first page of the
+letter.
+\BeginIndexGroup
\BeginIndex[indexother]{}{font>style}%
-\BeginIndex{FontElement}{pageheadfoot}%
-\BeginIndex{FontElement}{pagefoot}%
-\BeginIndex{FontElement}{pagenumber}%
+\BeginIndex{FontElement}{pageheadfoot}\LabelFontElement{pageheadfoot}%
+\BeginIndex{FontElement}{pagefoot}\LabelFontElement{pagefoot}%
+\BeginIndex{FontElement}{pagenumber}\LabelFontElement{pagenumber}%
For changing the font style of headers or footers you should use the user
interface described in \autoref{sec:maincls.textmarkup}. For header and
footer the same element is used, which you can name either
@@ -2759,36 +2572,26 @@ footer the same element is used, which you can name either
additional element \FontElement{pagefoot}\important{\FontElement{pagefoot}}
for the page foot. This will be used after \FontElement{pageheadfoot} at page
foots, that has been defined either with variable
-\Variable{nextfoot}\IndexVariable{nextfoot} or Package
+\DescRef{\LabelBase.variable.nextfoot}\IndexVariable{nextfoot} or Package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage},
-\autopageref{desc:scrlayer-scrpage.fontelement.pagefoot}). The element for the
+\DescPageRef{scrlayer-scrpage.fontelement.pagefoot}). The element for the
page number within the header or footer is named
\FontElement{pagenumber}\important{\FontElement{pagenumber}}. Default settings
are listed in \autoref{tab:maincls.defaultFontsHeadFoot},
\autopageref{tab:maincls.defaultFontsHeadFoot}. Please have also a look at
the example in \autoref{sec:maincls.pagestyle},
-\autopageref{example:maincls.pagestyle}.
+\PageRefxmpl{maincls.cmd.pagestyle}.
%
-\EndIndex{FontElement}{pagenumber}%
-\EndIndex{FontElement}{pagefoot}%
-\EndIndex{FontElement}{pageheadfoot}%
-\EndIndex[indexother]{}{font>style}%
+\EndIndexGroup
%
-\EndIndex{Pagestyle}{myheadings}%
-\EndIndex{Pagestyle}{headings}%
-\EndIndex{Pagestyle}{plain}%
-\EndIndex{Pagestyle}{empty}%
-\EndIndex{Cmd}{thispagestyle}%
-\EndIndex{Cmd}{pagestyle}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{markboth}\Parameter{left mark}\Parameter{right mark}\\
+ \Macro{markboth}\Parameter{left mark}\Parameter{right mark}%
\Macro{markright}\Parameter{right mark}
\end{Declaration}
-\BeginIndex{Cmd}{markboth}%
-\BeginIndex{Cmd}{markright}%
The possibilities that are offered with variables and options in
\Class{scrlttr2} should be good enough in most cases to create letterheads and
footers for the consecutive pages that follow the first letter page. Even more
@@ -2796,30 +2599,28 @@ so since you can additionally change with \Macro{markboth} and
\Macro{markright} the sender's statements that \Class{scrlttr2} uses to create
the letterhead. The commands \Macro{markboth}\IndexCmd{markboth} and
\Macro{markright}\IndexCmd{markright} can in particular be used together with
-pagestyle \PValue{myheadings}\IndexPagestyle{myheadings}%
-\important{\Pagestyle{myheadings}}. If the package
+pagestyle \PageStyle{myheadings}\IndexPagestyle{myheadings}%
+\important{\PageStyle{myheadings}}. If the package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} is used then this,
of course, is valid also for pagestyle
\PValue{scrheadings}\IndexPagestyle{scrheadings}. There the command
-\Macro{markleft}\IndexCmd{markleft} is furthermore available.
+\DescRef{scrlayer-scrpage.cmd.markleft}\IndexCmd{markleft} is furthermore
+available.
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{nexthead}}%
- \OParameter{description}\Parameter{content}\\
- \Macro{setkomavar}\PParameter{\Variable{nextfoot}}%
- \OParameter{description}\Parameter{content}
+ \Variable{nexthead}%
+ \Variable{nextfoot}%
\end{Declaration}
-\BeginIndex{Variable}{nexthead}%
-\BeginIndex{Variable}{nextfoot}%
At times one wants to have more freedom with creating the letterhead or footer
of subsequent pages. Then one has to give up the previously described
possibilities of predefined letterheads or footers that could have been chosen
-via the option \Option{pagenumber}\IndexOption{pagenumber}. Instead one is
+via the option
+\DescRef{\LabelBase.option.pagenumber}\IndexOption{pagenumber}. Instead one is
free to create the letterhead and footer of consecutive pages just the way one
wants to have them set with page style
-\Pagestyle{headings}\IndexPagestyle{headings}\important{\Pagestyle{headings},
- \Pagestyle{myheadings}} or
-\Pagestyle{myheadings}\IndexPagestyle{myheadings}. For that, one creates the
+\PageStyle{headings}\IndexPagestyle{headings}\important{\PageStyle{headings},
+ \PageStyle{myheadings}} or
+\PageStyle{myheadings}\IndexPagestyle{myheadings}. For that, one creates the
desired letterhead or footer construction using the \PName{content} of
variable\ChangedAt{v3.08}{\Class{scrlttr2}} \Variable{nexthead} or
\Variable{nextfoot}, respectively. Within the \PName{content} of
@@ -2828,33 +2629,32 @@ boxes side by side or one beneath the other by use of the \Macro{parbox}
command (see \cite{latex:usrguide}). A more advanced user should have no
problems creating letterheads of footers of his own. Within \PName{content}
you can and should of course also make use of other variables by using
-\Macro{usekomavar}. \KOMAScript{} does not use the \PName{description} of both
-variables.
+\DescRef{\LabelBase.cmd.usekomavar}. \KOMAScript{} does not use the
+\PName{description} of both variables.
-Only\textnote{Attention!} for compatibility reason the deprecated commands \Macro{nexthead}\IndexCmd[indexmain]{nexthead} and
+Only\textnote{Attention!} for compatibility reason the deprecated commands
+\Macro{nexthead}\IndexCmd[indexmain]{nexthead} and
\Macro{nextfoot}\IndexCmd[indexmain]{nextfoot} of former \Class{scrlttr2}
releases before 3.08 are also implemented. Nevertheless, you should not use
those.%
%
-\EndIndex{Variable}{nextfoot}%
-\EndIndex{Variable}{nexthead}%
-\EndIndex{Cmd}{markright}%
-\EndIndex{Cmd}{markboth}%
+\EndIndexGroup
%
-\EndIndex{}{page>foot}%
-\EndIndex{}{page>head}%
-\EndIndex{}{page>style}%
+\EndIndexGroup
+%
+\EndIndexGroup
-\LoadCommon[scrlttr]{8} % \section{Interleaf Pages}
+\LoadCommonFile{interleafpage}% \section{Interleaf Pages}
-\LoadCommon[scrlttr]{9} % \section{Footnotes}
+\LoadCommonFile{footnotes}% \section{Footnotes}
-\LoadCommon[scrlttr]{12}% \section{Lists}
+\LoadCommonFile{lists}% \section{Lists}
\section{Math}
\seclabel{math}%
+\BeginIndexGroup
\BeginIndex{}{equations}%
\BeginIndex{}{formulas}%
\BeginIndex{}{mathematics}%
@@ -2864,9 +2664,10 @@ classes. Instead of this, the math features of the \LaTeX{} kernel have been
supported. Furthermore\textnote{Attention!} regular math with numbered
equations or formulas is very unusual at letters. Because of this
\Class{scrlttr2} does not actively support numbered equations. Therefore
-options \Option{leqno} and \Option{fleqn}, that has been described for
-\Class{scrbook}, \Class{scrreprt}, and \Class{scrartcl} at
-\autoref{sec:maincls.math} are not available from \Class{scrlttr2}.
+options \DescRef{maincls.option.leqno} and \DescRef{maincls.option.fleqn},
+that has been described for \Class{scrbook}, \Class{scrreprt}, and
+\Class{scrartcl} at \autoref{sec:maincls.math} are not available from
+\Class{scrlttr2}.
You will not find a description of the math environments of the \LaTeX{} kernel
here. If you want to use \Environment{displaymath}\IndexEnv{displaymath},
@@ -2876,9 +2677,8 @@ into \LaTeX{} like \cite{lshort}. But\textnote{Hint!} if you want more than
very simple mathematics, usage of package \Package{amsmath} would be
recommended (see \cite{package:amsmath}).%
%
-\EndIndex{}{mathematics}
-\EndIndex{}{formulas}
-\EndIndex{}{equations}
+\EndIndexGroup
+
\section{Floating Environments of Tables and Figures}
\seclabel{floats}
@@ -2893,39 +2693,39 @@ without floating environment may still be done with the letter class
\Class{scrlttr2}.
-\LoadCommon[scrlttr2]{13} % \section{Margin Notes}
+\LoadCommonFile{marginpar} % \section{Margin Notes}
\section{Closing}
\seclabel{closing}
+\BeginIndexGroup%
\BeginIndex{}{closing}%
\BeginIndex{}{letter>closing}%
\BeginIndex{}{signature}%
\BeginIndex{}{letter>signature}%
-That the letter closing will be set by \Macro{closing}\IndexCmd{closing} has
-been explained already in \autoref{sec:scrlttr2.document},
-\autopageref{desc:scrlttr2.cmd.closing}. A kind of annotation to the signature
-is often placed below the signature of the letter. The signing or hand-written
-inscription itself is placed between this signature annotation and the closing
-phrase.
+That the letter closing will be set by
+\DescRef{\LabelBase.cmd.closing}\IndexCmd{closing} has been explained already
+in \autoref{sec:\LabelBase.document}, \DescPageRef{\LabelBase.cmd.closing}. A kind
+of annotation to the signature is often placed below the signature of the
+letter. The signing or hand-written inscription itself is placed between this
+signature annotation and the closing phrase.
\begin{Declaration}
- \Macro{setkomavar}\PParameter{\Variable{signature}}%
- \OParameter{description}\Parameter{content}
+ \Variable{signature}%
\end{Declaration}
-\BeginIndex{Variable}{signature}%
The variable \Variable{signature} holds an explanation or annotation for the
inscription, the signing of the letter. The \PName{content} is predefined as
-\Macro{usekomavar}\PParameter{fromname}. The annotation may consist
-of multiple lines. The lines should then be separated by a double
+\DescRef{\LabelBase.cmd.usekomavar}\PParameter{fromname}. The annotation may
+consist of multiple lines. The lines should then be separated by a double
backslash. Paragraph\textnote{Attention!} breaks in the annotation are however
not permitted.%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{raggedsignature}
\end{Declaration}
-\BeginIndex{Cmd}{raggedsignature}%
Closing phrase 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's \PName{content}.
@@ -2934,23 +2734,23 @@ Where to place this box is determined by the pseudo-lengths
\PLength{sigindent}\IndexPLength{sigindent} and
\PLength{sigbeforevskip}\IndexPLength{sigbeforevskip} (see
\autoref{sec:scrlttr2-experts.closing},
-\autopageref{desc:scrlttr2-experts.plength.sigindent}). The command
+\DescPageRef{scrlttr2-experts.plength.sigindent}). The command
\Macro{raggedsignature} defines the alignment inside the box. In the
predefined \File{lco} files the command is either defined as \Macro{centering}
(all besides \Option{KOMAold}) or \Macro{raggedright} (\Option{KOMAold}). In
order to obtain flush-right or flush-left alignment inside the box, the
-command can be redefined in the same way as \Macro{raggedsection} (see
-\autoref{sec:maincls.structure},
-\autopageref{desc:maincls.cmd.raggedsection}).
+command can be redefined in the same way as
+\DescRef{maincls.cmd.raggedsection} (see \autoref{sec:maincls.structure},
+\DescPageRef{maincls.cmd.raggedsection}).
\begin{Example}
Now, Mr Public really wants to aggrandize himself. Therefor he uses the
signature to show again, that he himself was formerly chairman. Because of
this he changes \PName{contents} of variable
- \Variable{signature}. Additionally he wants the signature be flush-left
- aligned and so he also redefines \Macro{raggedsignature}:%
+ \DescRef{\LabelBase.variable.signature}. Additionally he wants the signature
+ be flush-left aligned and so he also redefines \Macro{raggedsignature}:%
\lstinputcode[xleftmargin=1em]{letter-22}%
- See \autoref{fig:scrlttr2.letter-22} for the result.
+ See \autoref{fig:\LabelBase.letter-22} for the result.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with extended sender, logo,
@@ -2963,22 +2763,18 @@ command can be redefined in the same way as \Macro{raggedsection} (see
and puncher hole mark}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-22}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-22}
+ \label{fig:\LabelBase.letter-22}
\end{figure}
\end{Example}
%
-\EndIndex{Cmd}{raggedsignature}%
-%
-\EndIndex{Variable}{signature}%
+\EndIndexGroup
%
-\EndIndex{}{letter>signature}%
-\EndIndex{}{signature}%
-\EndIndex{}{letter>closing}%
-\EndIndex{}{closing}%
+\EndIndexGroup
\section{Letter Class Option Files}
\seclabel{lcoFile}%
+\BeginIndexGroup
\BeginIndex{}{lco-file=\File{lco}-file}%
\BeginIndex{}{letter class option}%
\BeginIndex{}{letter>class option}%
@@ -2994,9 +2790,10 @@ offers the \File{lco}-files. The \File{lco} suffix is an abbreviation for
In an \File{lco} file you can use all commands available to the document at
the time the \File{lco} file is loaded. Additionally, it can contain internal
commands available to package writers. For \Class{scrlttr2}, these are in
-particular the commands \Macro{@newplength}\IndexCmd{@newplength},
-\Macro{@setplength}\IndexCmd{@setplength}, and
-\Macro{@addtoplength}\IndexCmd{@addtoplength} (see
+particular the commands
+\DescRef{scrlttr2-experts.cmd.@newplength}\IndexCmd{@newplength},
+\DescRef{scrlttr2-experts.cmd.@setplength}\IndexCmd{@setplength}, and
+\DescRef{scrlttr2-experts.cmd.@setplength}\IndexCmd{@addtoplength} (see
\autoref{sec:scrlttr2-experts.pseudoLengths}).
There are already some \File{lco} files included in the {\KOMAScript}
@@ -3022,11 +2819,9 @@ particular complex examples of \File{lco}-files are shown at \cite{homepage}
or in \cite{DANTE:TK0203:MJK}. Both locations are mainly in German.
\begin{Declaration}
- \Macro{LoadLetterOption}\Parameter{name}\\
+ \Macro{LoadLetterOption}\Parameter{name}%
\Macro{LoadLetterOptions}\Parameter{list of names}
\end{Declaration}
-\BeginIndex{Cmd}{LoadLetterOption}%
-\BeginIndex{Cmd}{LoadLetterOptions}%
With \Class{scrlttr2} \File{lco}-files can be loaded by the
\Macro{documentclass} command. You enter the name of the \File{lco}-file
without suffix as an option\Index{option}. In this case, the \File{lco}-file
@@ -3060,10 +2855,10 @@ the order given by the list.
\opening{Hello,}
\end{lstcode}
Since construction of the page does not start before the
- \Macro{opening}\IndexCmd{opening} command, it is sufficient to load the
- \File{lco}-file before this. In particular, the loading need not be done
- before \Macro{begin}\PParameter{letter}. Therefore the changes made by
- loading the \File{lco}-file are local to the corresponding letter.
+ \DescRef{\LabelBase.cmd.opening}\IndexCmd{opening} command, it is sufficient
+ to load the \File{lco}-file before this. In particular, the loading need not
+ be done before \Macro{begin}\PParameter{letter}. Therefore the changes made
+ by loading the \File{lco}-file are local to the corresponding letter.
\end{Example}
If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco}-file is loaded via
@@ -3076,7 +2871,7 @@ If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco}-file is loaded via
\lstinputcode[xleftmargin=1em]{ich.lco}%
With this the size of the previous letter decreases to:
\lstinputcode[xleftmargin=1em]{letter-23.tex}%
- Nevertheless, as shown in \autoref{fig:scrlttr2.letter-23}, the result
+ Nevertheless, as shown in \autoref{fig:\LabelBase.letter-23}, the result
does not change.
\begin{figure}
\setcapindent{0pt}%
@@ -3090,7 +2885,7 @@ If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco}-file is loaded via
and puncher hole mark using a \File{lco}-file}[l]
\frame{\includegraphics[width=.4\textwidth]{letter-23}}
\end{captionbeside}
- \label{fig:scrlttr2.letter-23}
+ \label{fig:\LabelBase.letter-23}
\end{figure}
\end{Example}
@@ -3107,13 +2902,13 @@ problems with the \Option{SN}\IndexOption{SN} option. Since the Swiss standard
SN~101\,130 defines the address field to be placed 8\Unit{mm} from the right
paper edge, the headline and the sender attributes too will be set with the
same small distance from the paper edge. This also applies to the reference
-line when using the \Option{refline}\PValue{=wide} option (see
-\autoref{sec:scrlttr2.firstpage},
-\autopageref{desc:scrlttr2.option.refline}). If\textnote{Hint!} you have this
+line when using the \DescRef{\LabelBase.option.refline}\PValue{=wide} option
+(see \autoref{sec:\LabelBase.firstpage},
+\DescPageRef{\LabelBase.option.refline}). If\textnote{Hint!} you have this
kind of problem, create your own \File{lco} file that loads \Option{SN} first
and then changes \PLength{toaddrhpos}\IndexPLength{toaddrhpos} (see
\autoref{sec:scrlttr2-experts.addressee},
-\autopageref{desc:scrlttr2-experts.plength.toaddrvpos}) to a smaller
+\DescPageRef{scrlttr2-experts.plength.toaddrvpos}) to a smaller
value. Additionally, also reduce \PLength{toaddrwidth} accordingly.%
By\textnote{Hint!} the way, the \File{DIN} \File{lco}-file will always be
@@ -3220,16 +3015,14 @@ and \Package{keyval} packages.%
size warning}%
\end{desclist}
%
-\EndIndex{Cmd}{LoadLetterOptions}%
-\EndIndex{Cmd}{LoadLetterOption}%
+\EndIndexGroup
%
-\EndIndex{}{lco-file=\File{lco}-file}%
-\EndIndex{}{letter class option}%
-\EndIndex{}{letter>class option}%
+\EndIndexGroup
\section{Address Files and Circular Letters}
\seclabel{addressFile}%
+\BeginIndexGroup
\BeginIndex{}{address>file}%
\BeginIndex{}{circular letters}%
\index{serial letters|see circular letters}%
@@ -3249,7 +3042,6 @@ of many different addresses. The class \Class{scrlttr2}%
\Parameter{address}\Parameter{phone}\Parameter{F1}\Parameter{F2}%
\Parameter{comment}\Parameter{key}
\end{Declaration}%
-\BeginIndex{Cmd}{adrentry}%
The class \Class{scrlttr2} supports the use of address files which
contain address entries, very useful for circular letters. The file
extension of the address file has to be \File{.adr}. Each entry is an
@@ -3291,22 +3083,21 @@ letters in order to not interfere with existing {\TeX} or {\LaTeX} commands.
file in a special directory.
\end{Example}
%
-\EndIndex{Cmd}{adrentry}
+\EndIndexGroup
\begin{Declaration}
\Macro{addrentry}\Parameter{last-name}\Parameter{first-name}%
\Parameter{address}\Parameter{phone}\Parameter{F1}\Parameter{F2}%
\Parameter{F3}\Parameter{F4}\Parameter{key}
\end{Declaration}%
-\BeginIndex{Cmd}{addrentry}%
-Over the years people have objected that the \Macro{adrentry} has only two
+Over the years people have objected that the \DescRef{\LabelBase.cmd.adrentry} has only two
free parameters. To cater to this demand, there now exists a new command
called \Macro{addrentry}\,---\,note the additional ``d''\,---\,which supports
four freely-definable parameters. Since {\TeX} supports maximally nine
parameters per command, the comment parameter has fallen away. Other than this
-difference, the use is the same as that of \Macro{adrentry}.
+difference, the use is the same as that of \DescRef{\LabelBase.cmd.adrentry}.
-Both \Macro{adrentry} and \Macro{addrentry} commands can be freely mixed in
+Both \DescRef{\LabelBase.cmd.adrentry} and \Macro{addrentry} commands can be freely mixed in
the \File{adr} files. However, it should be noted that there are some packages
which are not suited to the use of \Macro{addrentry}. For example, the
\Package{adrconv} by Axel Kielhorn can be used to create address lists from
@@ -3314,7 +3105,7 @@ which are not suited to the use of \Macro{addrentry}. For example, the
\Macro{addrentry}. In this case, the only choice is to extend the package
yourself.%
%
-\EndIndex{Cmd}{addrentry}
+\EndIndexGroup
Besides the simple access to addresses, the address files can be
easily used in order to write circular letters. Thus, there is no
@@ -3336,8 +3127,8 @@ requirement to access a complicated database system via {\TeX}.
\input{members.adr}
\end{document}
\end{lstcode}
- If the address file contains \Macro{addrentry} commands too, than an
- additional definition for \Macro{addrentry} is required before loading
+ If the address file contains \DescRef{\LabelBase.cmd.addrentry} commands too, than an
+ additional definition for \DescRef{\LabelBase.cmd.addrentry} is required before loading
the address file:
\begin{lstcode}
\renewcommand*{\addrentry}[9]{%
@@ -3345,16 +3136,16 @@ requirement to access a complicated database system via {\TeX}.
}
\end{lstcode}
In this simple example the extra freely-definable parameter is not
- used, and therefore \Macro{addrentry} is defined with the help of
- \Macro{adrentry}.
+ used, and therefore \DescRef{\LabelBase.cmd.addrentry} is defined with the help of
+ \DescRef{\LabelBase.cmd.adrentry}.
\end{Example}
With some additional programming one can let the content of the
letters depend on the address data. For this the free parameters of
-the \Macro{adrentry} and and \Macro{addrentry} commands can be used.
+the \DescRef{\LabelBase.cmd.adrentry} and and \DescRef{\LabelBase.cmd.addrentry} commands can be used.
\begin{Example}
- Suppose the 5\textsuperscript{th} parameter of the \Macro{adrentry}
+ Suppose the 5\textsuperscript{th} parameter of the \DescRef{\LabelBase.cmd.adrentry}
command contains the gender of a member (\PValue{m/f}), and the
6\textsuperscript{th} parameter contains what amount of subscription
has not yet been paid by the member. If you would like to write a
@@ -3382,16 +3173,14 @@ the \Macro{adrentry} and and \Macro{addrentry} commands can be used.
\end{Example}
As you can see, the letter text can be made more personal by depending on
attributes of the letter's addressee. The number of attributes is only
-restricted by number of two free parameters of the \Macro{adrentry} command,
-or four free parameters of the \Macro{addrentry} command.
+restricted by number of two free parameters of the \DescRef{\LabelBase.cmd.adrentry} command,
+or four free parameters of the \DescRef{\LabelBase.cmd.addrentry} command.
\begin{Declaration}
- \Macro{adrchar}\Parameter{initial letter}\\
+ \Macro{adrchar}\Parameter{initial letter}%
\Macro{addrchar}\Parameter{initial letter}
\end{Declaration}
-\BeginIndex{Cmd}{adrchar}%
-\BeginIndex{Cmd}{addrchar}%
\Index[indexmain]{address>list}\Index[indexmain]{telephone list}%
As already mentioned above, it is possible to create address and telephone
lists using \File{adr} files. For that, the additional package
@@ -3453,18 +3242,16 @@ ignored if the address files are utilized in \Class{scrlettr2}.
\end{Example}
More about the \Package{adrconv} package can be found in its
documentation. There you should also find information about whether the
-current version of \Package{adrconv} supports the \Macro{addrentry} and
-\Macro{addrchar} commands. Former versions only know the commands
-\Macro{adrentry} and \Macro{adrchar}.%
+current version of \Package{adrconv} supports the
+\DescRef{\LabelBase.cmd.addrentry} and \Macro{addrchar} commands. Former
+versions only know the commands \DescRef{\LabelBase.cmd.adrentry} and
+\Macro{adrchar}.%
%
-\EndIndex{Cmd}{adrchar}%
-\EndIndex{Cmd}{addrchar}%
+\EndIndexGroup
%
-\EndIndex{}{circular letters}%
-\EndIndex{}{address>file}%
+\EndIndexGroup
%
-\EndIndex{Class}{scrlttr2}%
-\EndIndex{}{letters}%
+\EndIndexGroup
%%% Local Variables:
@@ -3476,4 +3263,4 @@ current version of \Package{adrconv} supports the \Macro{addrentry} and
%%% End:
% LocalWords: scrlttr simpleSwitchValues afteropening beforeopening Combinable
-% LocalWords: locfield Hennig Kohm
+% LocalWords: locfield Hennig Kohm Foldmarks