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.tex6307
1 files changed, 2802 insertions, 3505 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 a3e3c96dd78..cabf94914ce 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
@@ -40,12 +40,13 @@
%
% ----------------------------------------------------------------------
%
-% Kapitel über scrlttr2 in der KOMA-Script-Anleitung
+% Kapitel ueber scrlttr2 in der KOMA-Script-Anleitung
% Verwaltet von Markus Kohm
%
% ============================================================================
-\ProvidesFile{scrlttr2.tex}[2011/01/20 KOMA-Script guide (chapter: scrlttr2)]
+\ProvidesFile{scrlttr2.tex}[2012/05/15 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}
@@ -55,1330 +56,33 @@
\labelbase{scrlttr2}
\BeginIndex{Class}{scrlttr2}\BeginIndex{}{letters}%
-\begin{Explain}
+\iffalse
Since the June 2002 release {\KOMAScript} provides a completely
rewritten letter class\ChangedAt{v2.8q}{\Class{scrlttr2}}. Although
part of the code is identical to that of the main classes described
- in \autoref{cha:maincls}, letters are quite different from articles,
- reports, books, and suchlike. That alone justifies a separate
- chapter about the letter class. But there is another reason for a
- chapter on \Class{scrlttr2}. This class has been redeveloped from
- scratch and provides a new user interface different from every other
- class the author knows of. This new user interface may be uncommon,
- but the author is convinced both experienced and new {\KOMAScript}
- users will benefit from its advantages.
-
-\section{Looking Back on the Old Letter Class}
-\label{sec:scrlttr2.scrlettr}
-
-With the June 2002 release the old letter class
-\Class{scrlettr}\IndexClass{scrlettr} became obsolete. It is
-recommended not to use that class for new applications. There is no
-more active development of the old letter class, and support is very
-restricted. However, if you really need the documentation of the old
-letter class, you can still find it in the file \File{scrlettr.dtx},
-but only in German. You should run it through {\LaTeX} several times,
-like this:
-\begin{lstlisting}
- latex scrlettr.dtx
- latex scrlettr.dtx
- latex scrlettr.dtx
-\end{lstlisting}
-Then you obtain the file \File{scrlettr.dvi} containing the old German
-manual.
-
-To facilitate the transition to the new class, there is a
-compatibility option. In general, the complete older functionality
-still remains in the new class. Without that compatibility option,
-the user interface and the defaults will be different. More details on
-%this option is provided in \autoref{sec:scrlttr2.options} and
-%\autoref{sec:scrlttr2.fromscrlettr}.
-this option are provided in \autoref{sec:scrlttr2.lcoFile},
-\autoref{tab:lcoFiles} and \autoref{sec:scrlttr2.fromscrlettr}.
-\end{Explain}
-
-\section{Options}
-\label{sec:scrlttr2.options}
-
-The letter class \Class{scrlttr2} uses the package
-\Package{keyval}\IndexPackage{keyval} to handle options. This is part
-of the \Package{graphics} package (see \cite{package:graphics}). Since
-\Package{graphics} is part of the \emph{required} section of {\LaTeX},
-it should be found in every {\LaTeX} distribution. Should your {\TeX}
-distribution contain {\LaTeX}, but not the packages \Package{graphics}
-and \Package{keyval}, please complain to your {\TeX} distributor. If
-you want to use \Class{scrlttr2}, you will have to install the
-\Package{graphics} package yourself in that case.
-
-\begin{Explain}
- The special feature of the \Package{keyval} package is that options
- can have values. Thus, you not only need a lot less options, but
- perhaps also fewer optional arguments. You will see that when
- discussing the \Environment{letter} environment in
- \autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.env.letter}. The class will
- automatically load the \Package{keyval} package. If you need to
- supply options to the \Package{keyval} package, you should use the
- \Macro{PassOptionsToPackage} command before \Macro{documentclass}.
-\end{Explain}
-
-\subsection{Defining Options Later}
-\label{sec:scrlttr2.options.late}
-\BeginIndex{}{options}
-
-This section anticipates a feature of the new letter class. The
-meaning of this feature will not become clear until the structure of a
-document with more than one letter inside and another feature of
-\Class{scrlttr2} is understood. However, to keep the number of forward
-references low, it is reasonable to describe the feature this early.
-
-\begin{Declaration}
- \Macro{KOMAoptions}\Parameter{option list}
-\end{Declaration}
-\BeginIndex{Cmd}{KOMAoptions}%
-A special feature of the \Class{scrlttr2} class is the possibility to
-change many options even after loading the class. The
-\Macro{KOMAoptions} command serves this purpose, taking options and
-their values as arguments. You can list multiple options, separated by
-commas, just like in the optional argument of
-\Macro{documentclass}. If an option is only available when loading the
-class, i.\,e., as an optional argument to \Macro{documentclass}, this
-will be explicitly mentioned in the option's description.
-
-\begin{Explain}
- If you set an option to an illegal value within the \PName{option
- list}, {\LaTeX} will stop and show an error message. By entering
- ``\texttt{h}'' you will get an explanation that will also list
- possible values for that particular option.
-\end{Explain}
-%
-\EndIndex{Cmd}{KOMAoptions}%
-\EndIndex{}{options}%
-
-\subsection{Options for Compatibility}
-\label{sec:scrlttr2.compatibilityOptions}
-\BeginIndex{}{compatibility}%
-
-People who archive their letters in source code format generally place
-the highest priority on obtaining exactly the same results in future
-{\LaTeX} runs. In some cases however, improvements and corrections to
-the class can lead to changes in behaviour, particularly as regards
-page breaking.
-
-\begin{Declaration}
- \Option{version}=\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{version}%
-With\ChangedAt{v2.9t}{\Class{scrlttr2}} \Class{scrlttr2} there is the
-choice, whether a source file should give, as far as is technically
-possible, the same in any future {\LaTeX} runs, or whether the
-document should be set according to the latest version of the
-class. To which version compatibility should be retained is determined
-by the option \Option{version}. The default is version 2.9t. The same effect can be obtained with
-\begin{lstlisting}
- version=first
-\end{lstlisting}
-or
-\begin{lstlisting}
- version=2.9
-\end{lstlisting}
-or
-\begin{lstlisting}
- version=2.9t
-\end{lstlisting}
-If an unknown version is entered for \PName{value}, a warning is
-output and for safety's sake \Option{version=}\PValue{first} is
-assumed. With
-\begin{lstlisting}
- version=last
-\end{lstlisting}
-the current newest version can be selected. In this case future
-compatibility is waived. If the option is used without any value, then
-\PValue{last} is assumed as well.
-
-The question of compatibility concerns first and foremost page
-breaking. New features which have no effect on page breaking will be
-available even when compatibility to an earlier version is chosen by
-this option. The option also has no effect on changes in page breaking
-which result from the removal of old errors in the new version
-class. If page breaking compatibility is required absolutely, to the
-point of incorporating previous class errors, then the document should
-rather be archived together with the relevant version of \KOMAScript.
-
-It should be noted that the option \Option{version} can no longer be
-changed after loading of the class.%
-%
-\EndIndex{Option}{version}%
-%
-\EndIndex{}{compatibility}%
-
-\subsection{Page Layout Options}
-\label{sec:scrlttr2.typeareaOptions}
-\BeginIndex{}{page>layout}%
-
-In contrast to the old \Class{scrlettr} class, but in agreement with
-the other {\KOMAScript} classes, the \Class{scrlttr2} class refers to
-the \Package{typearea} package for the construction of the page layout
-(see \autoref{cha:typearea}). The package will be loaded by the class
-automatically, and the class then controls the package. The necessary
-options will be explained in this section.
-
-\begin{Declaration}
- \Option{enlargefirstpage}
-\end{Declaration}
-\BeginIndex{Option}{enlargefirstpage}%
-As described later in this chapter, 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 following pages. If, as
-a result, the footer of the first page would reach into the text area,
-this text area is automatically made smaller using the
-\Macro{enlargethispage}\IndexCmd{enlargethispage} macro. On the other
-hand, if the text area should become larger, supposing that the footer
-on the first page allows that, you can also 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} in
-\autoref{sec:scrlttr2.firstFoot},
-\autopageref{desc:scrlttr2.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}%
-%
-\EndIndex{}{page>layout}%
-
-\subsection{Other Layout Options}
-\label{sec:scrlttr2.layout}
-
-In this subsection, you will find all options, except the specific
-page layout options, that have an influence on the layout in
-general. Strictly speaking, all page layout options
-(see~\ref{sec:scrlttr2.typeareaOptions}) are also layout options, and
-vice versa for some of them.
-
-\begin{Declaration}
- \Option{cleardoublepage}=\PName{style}
-\end{Declaration}
-\BeginIndex{Option}{cleardoublepage~=\PName{style}}%
-If you want pages inserted by the \Macro{cleardoublepage} command to
-just contain a page number in the header and footer, or to be empty,
-this can be accomplished with this option. There are three different
-styles supported that are listed at
-\autoref{tab:scrlttr2.cleardoublepage}. Default is \PValue{standard}.
-
-\begin{table}
- \caption[{Possible values of option \Option{cleardoublepage} with
- \Class{scrlttr2}}]{Possible values of option \Option{cleardoublepage} for
- selection of page style of empty left pages with \Class{scrlttr2}}
- \label{tab:scrlttr2.cleardoublepage}
- \begin{desctabular}
- \pventry{empty}{switches to page style\Index{page>style}
- \PValue{empty}\IndexPagestyle{empty} for inserted pages}%
- \pventry{plain}{switches to page style
- \PValue{plain}\IndexPagestyle{plain} for inserted pages}
- \pventry{standard}{keeps the current page style for inserted pages}
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{cleardoublepage~=\PName{style}}%
-
-\begin{Declaration}
- \KOption{headsepline}\PName{switch}\\
- \KOption{footsepline}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{headsepline~=\PName{switch}}%
-\BeginIndex{Option}{footsepline~=\PName{switch}}%
-These two options insert a separator line below the header or above
-the footer, respectively, on consecutive pages. In the terminology of
-this manual, all pages of a letter except the first one are
-consecutive pages. This option can take the standard values for
-simple switches, as listed in
-\autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is
-\PValue{false}. If one of the options is used without a value, like in
-the declaration above, this evaluates as \PValue{true}, so the
-separator line will be activated. When used as a \Macro{documentclass}
-option, the option \Option{headinclude} or \Option{footinclude},
-respectively, will be passed on to the \Package{typearea} package (see
-\autoref{sec:typearea.options},
-\autopageref{desc:typearea.option.headinclude}).
-%
-\EndIndex{Option}{headsepline~=\PName{switch}}%
-\EndIndex{Option}{footsepline~=\PName{switch}}%
-
-\begin{Declaration}
- \Option{pagenumber}=\PName{position}
-\end{Declaration}
-\BeginIndex{Option}{pagenumber}%
-This option defines if and where a page number will be placed on
-consecutive pages. All pages without a letterhead are consecutive
-pages. This option affects the page styles\Index{page>style}
-\PValue{headings} and \PValue{plain}. It also affects the default page
-styles of the \Package{scrpage2} package, if set before loading the
-package (see \autoref{cha:scrpage}). It can take values only
-influencing horizontal, only vertical, or both positions. Possible
-value are shown in \autoref{tab:scrlttr2.pagenumber}. Default is
-\PValue{botcenter}.
-
-\begin{table}
- \caption[{Possible values of option \Option{pagenumber} with
- \Class{scrlttr2}}]{Possible values of option \Option{pagenumber} for the
- position of the page number in page styles \PValue{headings} and
- \PValue{plain} with \Class{scrlttr2}}
- \label{tab:scrlttr2.pagenumber}
- \begin{desctabular}
- \entry{\PValue{bot}, \PValue{foot}}{%
- page number in footer, horizontal position not changed}%
- \entry{\PValue{botcenter}, \PValue{botcentered}, \PValue{botmittle},
- \PValue{footcenter}, \PValue{footcentered}, \PValue{footmiddle}}{%
- page number in footer, centered}%
- \entry{\PValue{botleft}, \PValue{footleft}}{%
- page number in footer, left justified}%
- \entry{\PValue{botright}, \PValue{footright}}{%
- page number in footer, right justified}%
- \entry{\PValue{center}, \PValue{centered}, \PValue{middle}}{%
- page number centered horizontally, vertical position not changed}%
- \entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
- no page number}%
- \entry{\PValue{head}, \PValue{top}}{%
- page number in header, horizontal position not changed}%
- \entry{\PValue{headcenter}, \PValue{headcentered}, \PValue{headmiddle},
- \PValue{topcenter}, \PValue{topcentered}, \PValue{topmiddle}}{%
- page number in header, centered}%
- \entry{\PValue{headleft}, \PValue{topleft}}{%
- page number in header, left justified}%
- \entry{\PValue{headright}, \PValue{topright}}{%
- page number in header, right justified}%
- \entry{\PValue{left}}{%
- page number left, vertical position not changed}%
- \entry{\PValue{right}}{%
- page number right, vertical position not changed}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{pagenumber}%
-
-\begin{Declaration}
- \Option{parskip}=\PName{value}
-\end{Declaration}%
-\BeginIndex{Option}{parskip~=\PName{value}}%
-\begin{Explain}%
- Especially in letters you often encounter paragraphs marked not with
- indentation of the first line, but with a vertical skip between
- them. This is a matter of tradition. Apparently, it was easier for a
- secretary to operate the carriage return lever twice than to set an
- indentation using a tab stop or the space bar. Correct justification
- is almost impossible using a typewriter, so letters are
- traditionally typeset unjustified.
-
- However, typographers like Jan Tschichold take the view that
- letters, written using means available to modern typesetting, should
- take advantage of their possibilities just like other documents
- do. Under these circumstances, letters should also be typeset using
- paragraph indentation and justification.
-\end{Explain}
-
-As a reaction to many serious requests, \Class{scrlttr2} offers the
-possibility to mark paragraphs not only by indentation of the first
-line, but alternatively by a vertical skip. You can choose between a
-full or half a line of vertical space. When using paragraph spacing,
-it is often useful to keep the last line of a paragraph shorter so
-that paragraph recognition will be eased. All these features are
-controlled by different values for the \Option{parskip} option, shown
-in \autoref{tab:scrlttr2.parskip}. Default is \PValue{false}.
-
-\begin{table}
- \caption[{Possible values of option \Option{parskip} with
- \Class{scrlttr2}}]{Possible values of option \Option{parskip} to select
- the paragraph mark with \Class{scrlttr2}}
- \label{tab:scrlttr2.parskip}
- \begin{desctabular}
- \entry{\PValue{false}, \PValue{off}}{%
- paragraph indentation instead of vertical space; the last line of a
- paragraph may be arbitrarily filled}%
- \entry{\PValue{full}, \PValue{on}, \PValue{true}}{%
- one line vertical space between paragraphs; there must be at least
- 1\Unit{em} free space in the last line of a paragraph}%
- \pventry{full*}{one line vertical space between paragraphs; there must be
- at least a quarter of a line free space at the end of a paragraph}%
- \pventry{full+}{one line vertical space between paragraphs; there must be
- at least a third of a line free space at the end of a paragraph}%
- \pventry{full-}{one line vertical space between paragraphs; the last line
- of a paragraph may be arbitrarily filled}%
- \pventry{half}{half a line vertical space between paragraphs; there must
- be at least 1\Unit{em} free space in the last line of a paragraph}%
- \pventry{half*}{half a line vertical space between paragraphs; there must
- be at least a quarter of a line free space at the end of a paragraph}%
- \pventry{half+}{half a line vertical space between paragraphs; there must
- be at least a third of a line free space at the end of a paragraph}%
- \pventry{half-}{one line vertical space between paragraphs}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{parskip~=\PName{value}}%
-
-\subsection{Font Options}
-\label{sec:scrlttr2.fontOptions}
-
-Fonts options are any options which influence the size of the base
-font or of fonts for particular parts of the letter. In theory,
-options affecting the font type would also count as font options. At
-present there is only one option for font size in \Class{scrlttr2}.
-
-\begin{Declaration}
- \KOption{fontsize}\PName{size}
-\end{Declaration}
-\BeginIndex{Option}{fontsize~=\PName{size}}%
-Whereas in the main classes you choose the font size\Index{font>size}
-for the document using the \Option{10pt}, \Option{12pt}, etc.,
-options, in the \Class{scrlttr2} class the desired \PName{size} is set
-using the \Option{fontsize} option. The functionality is however the
-same. This option can only be used with \Macro{documentclass}, not
-with \Macro{KOMAoptions}. Default is \PValue{12pt}.
-%
-\EndIndex{Option}{fontsize~=\PName{size}}%
-
-\subsection{Options for Letterhead and Address}
-\label{sec:scrlttr2.headoptions}
-\BeginIndex{}{letter>head}\BeginIndex{}{address}%
-
-The \Class{scrlttr2} class offers numerous extensions for the design
-of the letterhead. There are also options for address formatting,
-extending the possibilities of the standard letter class, although
-these features could already be found in the now obsolete
-\Class{scrlettr} class.
-
-\begin{Declaration}
- \KOption{firsthead}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{firsthead~=\PName{switch}}%
-This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the
-letterhead will be typeset at all. The option undestands the standard
-values for simple keys, given
-in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is for the
-letterhead to be set.
-\EndIndex{Option}{firsthead~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{fromalign}\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{fromalign~=\PName{value}}%
-This option 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 also the
-option\ChangedAt{v2.97e}{\Class{scrlttr2}} of adding the return
-address to the sender's
-extension\Index{sender's extension}. At the same
-time, this option serves as a switch to activate or deactivate the
-extended letterhead options. 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}.
-
-\begin{table}
- \caption[{Possible values of option \Option{fromalign} with
- \Class{scrlttr2}}]{Possible values of option \Option{fromalign} for
- setting the position of the from address in the letterhead with
- \Class{scrlttr2}}
- \label{tab:scrlttr2.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}%
- \entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
- 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}%
- \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}.}%
- \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}.}%
- \entry{\PValue{right}}{%
- right-justified return address; an optional logo will be left
- justified; letterhead extensions will be activated}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{fromalign~=\PName{value}}%
-
-\begin{Declaration}
- \KOption{fromrule}\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{fromrule~=\PName{value}}%
-This option is part of the letterhead extensions (see option
-\Option{fromalign} above). It allows you to place a horizontal line
-within the return address. The possible values are shown in
-\autoref{tab:scrlttr2.fromrule}. Default is \PValue{false}. You can
-not activate more than one line at a time. Regarding the length of the
-line, see \autoref{sec:scrlttr2.other},
-\autopageref{desc:scrlttr2.plength.fromrulewidth}.
+ in \autoref{cha:maincls}, letters
+\else
+ Letters
+\fi
+are quite different from articles,
+reports, books, and suchlike. That alone justifies a separate
+chapter about the letter class. But there is another reason for a
+chapter on \Class{scrlttr2}. This class has been redeveloped from
+scratch and provides a new user interface different from every other
+class the author knows of. This new user interface may be uncommon,
+but the author is convinced both experienced and new {\KOMAScript}
+users will benefit from its advantages.
+
+
+\section{Variables}
+\label{sec:scrlttr2.variables}%
+\BeginIndex{}{variables}
-\begin{table}
- \caption[{Possible values of option \Option{fromrule} with
- \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}
- \begin{desctabular}
- \entry{\PValue{afteraddress}, \PValue{below}, \PValue{on}, \PValue{true},
- \PValue{yes}}{%
- rule below the return address}%
- \entry{\PValue{aftername}}{%
- rule directly below the sender's name}%
- \entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
- no rule}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{fromrule~=\PName{value}}%
-
-\begin{Declaration}
- \KOption{fromphone}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{fromphone~=\PName{switch}}%
-This option is part of the letterhead extensions (see option
-\Option{fromalign} above). It defines whether the phone number will be
-part of the return address. 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}{fromphone~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{fromfax}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{fromfax~=\PName{switch}}%
-This option is part of the letterhead extensions (see option
-\Option{fromalign} above). It defines whether the facsimile number
-will be part of the return address. 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}{fromfax~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{fromemail}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{fromemail~=\PName{switch}}%
-This option is part of the letterhead extensions (see option
-\Option{fromalign} above). It defines whether the
-email address will be part of the return address. 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}{fromemail~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{fromurl}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{fromurl~=\PName{switch}}%
-This option is part of the letterhead extensions (see option
-\Option{fromalign} above). It defines whether the
-URL will be part of the return address. 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}{fromurl~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{fromlogo}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{fromlogo~=\PName{switch}}%
-This option is part of the letterhead extensions (see option
-\Option{fromalign} above). It defines whether the logo will be part of
-the return address. This option can take the standard values for
-simple switches, as listed in
-\autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Regarding the placement
-of the logo, see also the explanation of the option \Option{fromalign}
-above. Default is \PValue{false}.
-%
-\EndIndex{Option}{fromlogo~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{addrfield}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{addrfield~=\PName{switch}}%
-This option defines whether an address field will be set. Default is
-to use the address field. This option can take the standard values for
-simple switches, as listed in
-\autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is
-\PValue{true}.
-%
-\EndIndex{Option}{addrfield~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{backaddress}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{backaddress~=\PName{switch}}%
-This option defines whether a return address for window envelopes will
-be set. Default is to use the return address. If the address field is
-suppressed (see option \Option{addrfield}), there will be no return
-address either. This option can take the standard values for simple
-switches, as listed in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}.
-Default is \PValue{true}.
-%
-\EndIndex{Option}{backaddress~=\PName{switch}}%
-
-\begin{Declaration}
- \KOption{subject}\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{subject~=\PName{value}}%
-This option serves two purposes: first, you can choose if your
-subject\Index{subject} should have a title, given by the
-\PName{subject} variable (see \autoref{tab:scrlttr2.subjectTerm},
-\autopageref{tab:scrlttr2.subjectTerm}); second, you can choose if the
-subject should be set before or after the opening. Furthermore, the
-formatting\ChangedAt{v2.97c}{\Class{scrlttr2}} of the subject can be
-modified. Possible values for this option are shown in
-\autoref{tab:scrlttr2.subject}. It is expressly noted that when using
-the setting \PValue{underlined}, the subject must fit on one line!
-Defaults are \PValue{beforeopening} and \PValue{untitled}.
-\begin{table}
- \caption[{Possible values of option \Option{subject} with
- \Class{scrlttr2}}]{Possible values of option \Option{subject} for the
- position of the subject with
- \Class{scrlttr2}}
- \label{tab:scrlttr2.subject}
- \begin{desctabular}
- \pventry{afteropening}{set subject after opening}%
- \pventry{beforeopening}{set subject before opening}%
- \pventry{centered}{set subject centered}%
- \pventry{left}{set subject left-justified}%
- \pventry{right}{set subject right-justified}%
- \pventry{titled}{add title to subject}%
- \pventry{underlined}{set subject underlined (see note in text)}%
- \pventry{untitled}{do not add title to subject}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{subject~=\PName{value}}%
-
-\begin{Declaration}
- \KOption{locfield}\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{locfield~=\PName{value}}%
-\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 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,
-then the \Option{locfield} option can toggle between two presets for
-the field width. See the explanation on the \Variable{locwidth} pseudo
-length in \autoref{sec:scrlttr2.locationField},
-\autopageref{desc:scrlttr2.plength.locwidth}. Possible values for this
-option are shown in \autoref{tab:scrlttr2.locfield}. Default is
-\PValue{narrow}.
-
-\begin{table}
- \caption[{Possible values of option \Option{locfield} with
- \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}
- \begin{desctabular}
- \pventry{narrow}{narrow sender supplement field}%
- \pventry{wide}{wide sender supplement field}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{locfield~=\PName{value}}%
-
-\begin{Declaration}
- \KOption{foldmarks}\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{foldmarks~=\PName{value}}%
-This option activates or deactivates foldmarks\Index{foldmark} for
-vertical 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.foldmarks} from
-\autopageref{sec:scrlttr2.foldmarks} 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 foldmarks 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 foldmarks
-independently. Also in the latter case the foldmarks 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 foldmarks is specified in the user settings, that is, the
-\File{lco} files (see \autoref{sec:scrlttr2.lcoFile}) chosen for a
-letter. Default values are \PValue{true} and \PValue{TBMPL}.
-
-The exact placement of the fold marks for three-panel letter folding
-depends on user settings, that is, the \File{lco} files (see
-\autoref{sec:scrlttr2.lcoFile}). The folding need not result in
-equal-sized parts. This option can take the standard values for simple
-switches, as listed in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is
-\PValue{true}, which implies setting the fold marks.
-\begin{table}
- \centering
- \caption{Combined values for the configuration of foldmarks with the
- option \Option{foldmarks}}
- \label{tab:scrlttr2.foldmark}
- \begin{desctabular}
- \pventry{B}{activate upper horizontal foldmark on left paper edge}%
- \pventry{b}{deactivate upper horizontal foldmark on left paper edge}%
- \pventry{H}{activate all horizontal foldmarks on left paper edge}%
- \pventry{h}{deactivate all horizontal foldmarks on left paper edge}%
- \pventry{L}{activate left vertical foldmark on upper paper edge}%
- \pventry{l}{deactivate left vertical foldmark on upper paper edge}%
- \pventry{M}{activate middle horizontal foldmark on left paper edge}%
- \pventry{m}{deactivate middle horizontal foldmark on left paper edge}%
- \pventry{P}{activate punch or center mark on left paper edge}%
- \pventry{p}{deactivate punch or center mark on left paper edge}%
- \pventry{T}{activate lower horizontal foldmark on left paper edge}%
- \pventry{t}{deactivate lower horizontal foldmark on left paper edge}%
- \pventry{V}{activate all vertical foldmarks on upper paper edge}%
- \pventry{v}{deactivate all vertical foldmarks on upper paper edge}%
- \end{desctabular}
-\end{table}
-\begin{Example}
- Assume that you would like to deactivate all foldmarks exept the punching
- mark. This you can accomplish with, for example:
- \begin{lstlisting}
- \KOMAoption{foldmarks=blmt}
- \end{lstlisting}
- as long as the defaults have not been changed previously. If some changes
- might have been made before, then for added safety you may use:
- \begin{lstlisting}
- \KOMAoption{foldmarks=true,foldmarks=blmtP}
- \end{lstlisting}
-\end{Example}%
-\EndIndex{Option}{foldmarks~=\PName{value}}%
-
-\begin{Declaration}
- \KOption{numericaldate}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{numericaldate~=\PName{switch}}%
-This option toggles between the standard, language-dependent date
-presentation, and a short, numerical one. {\KOMAScript} does not
-provide the standard presentation. It should be defined by packages
-such as \Package{german}\IndexPackage{german},
-\Package{babel}\IndexPackage{babel}, or
-\Package{isodate}\IndexPackage{isodate}. The 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. In the
-now obsolete \Class{scrlettr} class, the opposite effect was achieved
-using the \Option{orgdate} option.
-%
-\EndIndex{Option}{numericaldate~=\PName{switch}}%
-
-\begin{Declaration}
- \Option{refline}\PName{value}
-\end{Declaration}
-\BeginIndex{Option}{refline~=\PName{value}}%
-With the \Class{scrlttr2} class, the header, footer, address, and
-sender attributes may extend beyond the normal type area to the left
-and to the right. This option defines whether that 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}.
-
-\begin{table}
- \caption[{Possible value of option \Option{refline} with
- \Class{scrlttr2}}]{Possible value of option \Option{refline} for setting
- the width of the reference fields line with
- \Class{scrlttr2}}
- \label{tab:scrlttr2.refline}
- \begin{desctabular}
- \pventry{narrow}{reference fields line restricted to type area}%
- \pventry{wide}{reference fields line corresponds to address and
- sender attributes}%
- \end{desctabular}
-\end{table}
-%
-\EndIndex{Option}{refline~=\PName{value}}%
-
-%
-\EndIndex{}{letter>head}\EndIndex{}{address}%
-
-\subsection{Options for the Letterfoot}
-\label{sec:scrlttr2.footoptions}
-\BeginIndex{}{letter>footer}
-
-The letterfoot is the footer of the first page of the letter. There
-exist some special rules for its placement, which are given in the
-description of the option
-\Option{enlargefirstpage}\IndexOption{enlargefirstpage} (see
-\autoref{sec:scrlttr2.typeareaOptions},
-\autopageref{desc:scrlttr2.option.enlargefirstpage}) and the
-pseudo-length \PLength{firstfootvpos}\IndexPLength{firstfootvpos}
-(siehe \autoref{sec:scrlttr2.firstFoot},
-\autopageref{desc:scrlttr2.plength.firstfootvpos}).
-
-\begin{Declaration}
- \Option{firstfoot}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{firstfoot~=\PName{switch}}%
-This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the
-letterfoot is set or not. If the letterfoot is not set then the
-pseudo-length \PLength{firstfootvpos} is also ignored, and instead
-\Class{scrlttr2} assumes that the value is equal to
-\Length{paperheight}. This has an effect when the option
-\Option{enlargefirstpage} (see \autoref{sec:scrlttr2.firstFoot},
-\autopageref{desc:scrlttr2.plength.firstfootvpos}) is used
-concurrently.
-
-The option understands the standard values for simple switches, as
-given in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is the setting
-of the letterfoot.
-\EndIndex{Option}{firstfoot~=\PName{switch}}%
-
-\EndIndex{}{letter>footer}
-
-\subsection{Formatting Options}
-\label{sec:scrlttr2.formatingOptions}
-
-Formatting options are those which influence form or formatting of the
-output and do not belong to another section. You might also call them
-the \emph{miscellaneous options}.
-
-\begin{Declaration}
- \KOption{draft}\PName{switch}
-\end{Declaration}
-\BeginIndex{Option}{draft~=\PName{switch}}%
-This option toggles between the final\Index{final version} and the
-draft\Index{draft version} version of a document. In particular,
-enabling the \Option{draft} option activates little black boxes that
-will be drawn at the end of overfull lines. These boxes allow the
-unpracticed eye to more easily identify paragraphs that need manual
-intervention. When the \Option{draft} option is disabled, there will
-be no such boxes. This option can take the standard values for simple
-switches, as listed in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. Default is
-\PValue{false}, as usual. However, I strongly recommend enabling the
-\Option{draft} option when designing a letter, as for every other
-document.
-%
-\EndIndex{Option}{draft~=\PName{switch}}%
-
-\subsection{The Letter Class Option Files}
-\label{sec:scrlttr2.lcoFile}
-
-\BeginIndex{}{lco=\File{lco}}\BeginIndex{}{letter>class option}%
-Normally, you would not redefine parameters like the distance between
-the address field and the top edge of the paper every time you write a
-letter. Instead, you would reuse a whole set of parameters for certain
-occasions. It will be much the same for the letterhead and footer used
-on the first page. Therefore, it is reasonable to save these settings
-in a separate file. For this purpose, the \Class{scrlttr2} class
-offers the \File{lco} files. The \File{lco} suffix is an abbreviation
-for \emph{\emph{l}etter \emph{c}lass \emph{o}ption}.
-
-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}, \Macro{@setplength}, and \Macro{@addtoplength}
-(see \autoref{sec:scrlttr2.pseudoLength}).
-
-There are already some \File{lco} files included in the {\KOMAScript}
-distribution. The \File{DIN.lco}, \File{DINmtext.lco}, \File{SNleft.lco},
-\File{SN.lco}, and \File{NF.lco}\ChangedAt{v3.04}{\Class{scrlttr2}} files
-serve to adjust {\KOMAScript} to different layout standards. They are well
-suited as templates for your own parameter sets. The \File{KOMAold.lco} file,
-on the other hand, serves to improve compatibility with the old letter class
-\Class{scrlettr}. Since it contains internal commands not open to package
-writers, you should not use this as a template for your own \File{lco}
-files. You can find a list of predefined \File{lco} files in
-\autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles}.
-
-\begin{Explain}
- If you have defined a parameter set for a letter standard not yet
- supported by \KOMAScript, you are explicitly invited to send this
- parameter set to the {\KOMAScript} support address. Please do not
- forget to include the permission for distribution under the
- {\KOMAScript} license (see the \File{lppl.txt} file). If you know
- the necessary metrics for an unsupported letter standard, but are
- not able to write a corresponding \File{lco} file yourself, you can
- also contact the {\KOMAScript} author, Markus Kohm, directly.
-\end{Explain}
-
-\begin{Declaration}
- \Macro{LoadLetterOption}\Parameter{name}
-\end{Declaration}
-\BeginIndex{Cmd}{LoadLetterOption}%
-Usually, the \File{lco} files will be loaded by the
-\Macro{documentclass} command. You enter the name of the \File{lco} file
-without suffix as an option. The \File{lco} file will be loaded right
-after the class file.
-
-However, it is also possible to load an \File{lco} file later, or even
-from within another \File{lco} file. This can be done with the
-\Macro{LoadLetterOption} command, which takes the \PName{name} of the
-\File{lco} file without suffix as a parameter.
-\begin{Example}
-You write a document containing several letters. Most of them should
-comply with the German DIN standard. So you start with:
-\begin{lstlisting}
- \documentclass{scrlttr2}
-\end{lstlisting}
-However, one letter should use the \File{DINmtext} variant, with the
-address field placed more toward the top, which results in more text
-fitting on the first page. The folding will be modified so that the
-address field still matches the address window in a DIN~C6/5 envelope.
-You can achieve this as follows:
-\begin{lstlisting}
- \begin{letter}{Markus Kohm\\
- Freiherr-von-Drais-Stra\ss e 66\\68535 Edingen-Neckarhausen}
- \LoadLetterOption{DINmtext}
- \opening{Hello,}
-\end{lstlisting}
-Since construction of the page does not start before the
-\Macro{opening} command, it is sufficient to load the \File{lco} file
-before this. In particular, the laoding 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}
-
-\begin{Explain}
- If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco} file is loaded
- via \Macro{documentclass}, then it may no longer have the same name
- as an option.
-\end{Explain}
-
-\begin{Example}
- You do not want to enter your sender address every time, so you
- create an \File{lco} file with the necessary data, like this:
-\begin{lstlisting}
- \ProvidesFile{mkohm.lco}[2002/02/25 letter class option]
- \setkomavar{fromname}{Markus Kohm}
- \setkomavar{fromaddress}{Freiherr-von-Drais-Stra\ss e 66\\
- 68535 Edingen-Neckarhausen}
-\end{lstlisting}
-The command \Macro{setkomavar} used above, and the principle of
-variables will be explained in detail
-in\autoref{sec:scrlttr2.variables},
-\autopageref{desc:scrlttr2.cmd.setkomavar}. In the example given
-here, knowledge of the exact function of the command is not
-critical. It is only important to note what can be done with
-\File{lco} files, less so exactly how this might be
-accomplished. Please note that the German sharp s, ``\ss'', was
-entered using the {\TeX} macro \Macro{ss}, because directly after
-\Macro{documentclass} no packages for input encoding, for example
-\Macro{usepackage}\PValue{[latin1]}\PParameter{inputenc} for Unix or
-\Macro{usepackage}\PValue{[ansinew]}\PParameter{inputenc} for Windows,
-and no language packages, like
-\Macro{usepackage}\PParameter{ngerman}\IndexPackage{ngerman} for the
-new German orthography, are loaded.
-
-However, if you would always use the same input encoding, you could
-also include it into your \File{lco} file. This would look as follows:
-\begin{lstlisting}
- \ProvidesFile{mkohm.lco}[2002/02/25 letter class option]
- \RequirePackage[latin1]{inputenc}
- \setkomavar{fromname}{Markus Kohm}
- \setkomavar{fromaddress}{Freiherr-von-Drais-Stra\ss e 66\\
- 68535 Edingen-Neckarhausen}
-\end{lstlisting}
-There is one distinct disadvantage with this usage: you can no longer
-load this \File{lco} file later in your document. If you want to have
-letters with different senders in one document, you should therefore
-refrain from loading packages in your \File{lco} file.
-
-Let us further assume that I always typeset letters using the preset
-parameters \File{KOMAold}. Then I could add the following line to my
-\File{mkohm.lco} file:
-\begin{lstlisting}
- \LoadLetterOption{KOMAold}
-\end{lstlisting}
-
- Anyway, now you can preset my sender address using
-\begin{lstlisting}
- \documentclass[mkohm]{scrlttr2}
-\end{lstlisting}
-\end{Example}
-
-In \autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles} you can find a
-list of all predefined \File{lco} files. If you use a printer that has
-large unprintable areas on the left or right side, you might have
-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 fields line when using the
-\Option{refline}\PValue{=wide} option (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.refline}). If 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.addressee},
-\autopageref{desc:scrlttr2.plength.toaddrvpos}) to a smaller
-value. Additionally, also reduce \PLength{toaddrwidth} accordingly.
-%
-\EndIndex{Cmd}{LoadLetterOption}%
-
-\begin{desctable}
- \caption{The predefined \File{lco} files\label{tab:lcoFiles}}\\
- \Endfirsthead%
- \caption[]{The predefined \File{lco} files (\emph{continuation})}\\
- \Endhead%
- \standardfoot%
- \oentry{DIN}{%
- parameter set for letters on A4-size paper, complying with German standard
- DIN~676; suitable for window envelopes in the sizes C4, C5, C6, and C6/5
- (C6 long).}%
- \oentry{DINmtext}{%
- parameter set for letters on A4-size paper, complying with DIN~676, but
- using an alternate layout with more text on the first page; only suitable
- for window envelopes in the sizes C6 and C6/5 (C6 long).}%
- \oentry{KOMAold}{%
- parameter set for letters on A4-size paper using a layout close to the now
- obsolete \Class{scrlettr} letter class; suitable for window envelopes in
- the sizes C4, C5, C6, and C6/5 (C6 long); some additional commands to
- improve compatibility with obsolete \Class{scrlettr} commands are defined;
- \Class{scrlttr2} may behave slightly different when used with this
- \File{lco} file than with the other \File{lco} files.}%
- \oentry{NF}{%
- parameter set for French letters, according to NF~Z~11-001; suitable for
- window envelopes of type DL (110\Unit{mm} to 220\Unit{mm}) with a window
- of about 20\Unit{mm} from right and bottom with width 45\Unit{mm} and
- height 100\Unit{mm}; this file was originally developed by Jean-Marie
- Pacquet, who provides an extended version and additional information on
- \cite{www:NF.lco}.}%
- \oentry{NipponEL}{%
- parameter set for Japanese letters in A4 format; suitable for Japanese
- window envelopes of types Chou or You 3 or 4, in which the windows is
- approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned
- 22\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
- \autoref{cha:japanlco}).}%
- \oentry{NipponEH}{%
- parameter set for Japanese letters in A4 format; suitable for Japanese
- window envelopes of types Chou or You 3 or 4, in which the windows is
- approximately 90\Unit{mm} wide, 55\Unit{mm} high, and positioned
- 22\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
- \autoref{cha:japanlco}).}%
- \oentry{NipponLL}{%
- parameter set for Japanese letters in A4 format; suitable for Japanese
- window envelopes of types Chou or You 3 or 4, in which the windows is
- approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned
- 25\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
- \autoref{cha:japanlco}).}%
- \oentry{NipponLH}{%
- parameter set for Japanese letters in A4 format; suitable for Japanese
- window envelopes of types Chou or You 3 or 4, in which the windows is
- approximately 90\Unit{mm} wide, 55\Unit{mm} high, and positioned
- 25\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
- \autoref{cha:japanlco}).}%
- \oentry{NipponRL}{%
- parameter set for Japanese letters in A4 format; suitable for Japanese
- window envelopes of types Chou or You 3 or 4, in which the windows is
- approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned
- 25\Unit{mm} from the left and 24\Unit{mm} from the top edge (see
- \autoref{cha:japanlco}).}%
- \oentry{KakuLL}{%
- parameter set for Japanese letters in A4 format; suitable for Japanese
- window envelopes of type Kaku A4, in which the windows is approximately
- 90\Unit{mm} wide, 45\Unit{mm} high, and positioned 25\Unit{mm} from the
- left and 24\Unit{mm} from the top edge (see \autoref{cha:japanlco}).}%
- \oentry{SN}{%
- parameter set for Swiss letters with address field on the right side,
- according to SN~010\,130; suitable for Swiss window envelopes in the sizes
- C4, C5, C6, and C6/5 (C6 long).}%
- \oentry{SNleft}{%
- parameter set for Swiss letters with address field on the left side;
- suitable for Swiss window envelopes with window on the left side in the
- sizes C4, C5, C6, and C6/5 (C6 long).}%
-\end{desctable}
-
-\begin{Explain}
-\begin{Declaration}
- \Macro{LetterOptionNeedsPapersize}%
- \Parameter{option name}\Parameter{paper size}
-\end{Declaration}
-\BeginIndex{Cmd}{LetterOptionNeedsPapersize}
-As mentioned in \autoref{sec:scrlttr2.typeareaOptions}, at present
-there exist only parameter sets and \File{lco} files for A4-sized
-paper. In order that you will at least be warned when using another
-\PName{paper size}, you will find a \Macro{LetterOptionNeedsPapersize}
-command in every \File{lco} file distributed with {\KOMAScript}. The
-first argument is the name of the \File{lco} file without the
-``\File{.lco}'' suffix. The second argument is the paper size for
-which the \File{lco} file is designed.
-
-If several \File{lco} files are loaded in succession, a
-\Macro{LetterOptionNeedsPapersize} command can be contained in each of
-them, but the \Macro{opening} command will only check the last given
-\PName{paper size}. As shown in the following example, an experienced
-user can thus easily write \File{lco} files with parameter sets for
-other paper sizes. If you do not plan to set up such \File{lco} files
-yourself, you may just forget about this option and skip the example.
-
-\begin{Example}
- Suppose you use A5-sized paper in normal, i.\,e., upright or
- portrait, orientation for your letters. We further assume that you
- want to put them into standard C6 window envelopes. In that case,
- the position of the address field would be the same as for a DIN
- standard letter on A4-sized paper. The main difference is that A5
- paper needs only one fold. So you want to disable the upper and
- lower fold marks. The easiest way to achieve this is to place the
- marks outside of the paper area.
-\begin{lstlisting}
- \ProvidesFile{paper=a5.lco}[2002/05/02 letter class option]
- \LetterOptionNeedsPapersize{paper=a5}{a5}
- \@setplength{tfoldmarkvpos}{\paperheight}
- \@setplength{bfoldmarkvpos}{\paperheight}
-\end{lstlisting}
-Besides this, the placement of the foot, that is, the pseudo-length
-\PLength{firstfootvpos}, must be adjusted. It is left to the reader to
-find an appropriate value. When using such an \File{lco} file, you
-must only take care that other \File{lco} file options, like
-\File{SN}, are declared before the paper size, i.\,e., before loading
-``\File{paper=a5.lco}''. Does this seem too complicated? Only before
-you have used it the first time. Anyway, how often do you write
-letters not using your standard formats for A4-size or letter-size
-paper?
-\end{Example}
-%
-\EndIndex{Cmd}{LetterOptionNeedsPapersize}
-\end{Explain}
-
-By the way, the \File{DIN} \File{lco} file will always be loaded as
-the first \File{lco} file. This ensures that all pseudo-lengths will
-have more or less reasonable default values.
-
-Please note that it is not possible to use \Macro{PassOptionsToPackage}
-to pass options to packages from within an \File{lco} file that have
-already been loaded by the class. Normally, this only applies to the
-\Package{typearea}, \Package{scrlfile}, and \Package{keyval} packages.
-%
-\EndIndex{}{lco=\File{lco}}\EndIndex{}{letter>class option}%
-
-\section{General Document Properties}
-\label{sec:scrlttr2.general}
-
-Some document properties are not assigned to any particular part of
-the document such as to the letterhead or the letter body. Several of
-these properties have already been mentioned or explained in
-\autoref{sec:scrlttr2.options}.
-
-
-\subsection{Font Selection}
-\label{sec:scrlttr2.font}
-
-\BeginIndex{}{font>style}\BeginIndex{}{font>size}%
-\begin{Explain}
- Commands for defining, extending and querying the font of a specific
- element can be found in \autoref{sec:maincls.font}. These commands
- work exactly the same in \Class{scrlttr2}. The elements which can be
- influenced in this way are listed in
- \autoref{tab:scrlttr2.elementsWithoutText}.
- %
- \begin{desctable}
- \caption{Alphabetical list of elements whose font can be changed in
- \Class{scrlttr2} using the commands \Macro{setkomafont} and
- \Macro{addtokomafont}\label{tab:scrlttr2.elementsWithoutText}}\\
- \Endfirsthead
- \caption[]{Elements whose font can be changed
- (\emph{continuation})}\\
- \Endhead%
- \standardfoot%
- \feentry{addressee}{name und address in address field}%
- \feentry{backaddress}{%
- return address for a window envelope}%
- \feentry{descriptionlabel}{%
- label, i.\,e., the optional argument of \Macro{item}, in a
- \Environment{description} environment}%
- \feentry{foldmark}{foldmark on the letter page; intended for color
- settings}%
- \feentry{fromaddress}{%
- sender's address in the letterhead}%
- \feentry{fromname}{%
- sender's address in the letterhead if different from
- \FontElement{fromaddress}}%
- \feentry{fromrule}{line in return address field in letterhead;
- intended for color settings}%
- \feentry{pagefoot}{%
- in most cases the footer, sometimes the header of a page}%
- \feentry{pagehead}{%
- in most cases the header, sometimes the footer of page}%
- \feentry{pagenumber}{%
- page number in the footer or header, inserted with
- \Macro{pagemark}}%
- \feentry{specialmail}{mode of dispatch in address field}%
- \feentry{subject}{%
- subject in the opening of the letter}%
- \feentry{title}{%
- title in the opening of the letter}%
- \feentry{toaddress}{variation of the element
- \FontElement{addressee} for setting the adressee address (less
- the name) in the adress field}%
- \feentry{toname}{variation of the element \FontElement{addressee}
- for the name (only) of the addressee in the address field}%
- \end{desctable}
-\end{Explain}
-%
-\EndIndex{}{font>style}\EndIndex{}{font>size}%
-
-
-\subsection{Page Style}
-\label{sec:scrlttr2.pageStyle} One of the general properties of a
-document is the page style. Please refer also to
-\autoref{sec:maincls.pageStyle} and \autoref{cha:scrpage}.
-
-\begin{Declaration}
-\Macro{pagestyle}\PParameter{empty}\\
-\XMacro{pagestyle}\PParameter{plain}\\
-\XMacro{pagestyle}\PParameter{headings}\\
-\XMacro{pagestyle}\PParameter{myheadings}\\
-\XMacro{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[empty] is the page style, in which the header and footer of
- subsequent pages (all pages apart from the first) are completely
- empty. This page style is also used for the first page, because
- header and footer of this page are set by otehr means using the
- macro \Macro{opening}\IndexCmd{opening} (see
- \autoref{sec:scrlttr2.firstHead}, \autoref{sec:scrlttr2.firstFoot},
- as well as \autoref{sec:scrlttr2.opening},
- \autopageref{desc:scrlttr2.cmd.opening}).
-
-\item[plain] is the page style with only page numbers in the header or
- footer on subsequent pages. The placement of these page numbers is
- determined by the option \Option{pagenumber} (see
- \autoref{sec:scrlttr2.layout},
- \autopageref{desc:scrlttr2.option.pagenumber}).
-
-\item[headings] is the page style for running (automatic) headings on
- subsequent 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.firstHead},
- \autopageref{desc:scrlttr2.variable.fromname} and
- \autoref{sec:scrlttr2.titleSubject},
- \autopageref{desc:scrlttr2.variable.subject}). At which position
- these marks and the page numbers are placed, depends on the option
- \Option{pagenumber} (see \autoref{sec:scrlttr2.layout},
- \autopageref{desc:scrlttr2.option.pagenumber}). 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{scrpage2}
- also \Macro{markleft} (see \autoref{sec:scrpage.basics.mark},
- \autopageref{desc:scrpage.cmd.automark}) is available.
-
-\item[myheadings] is the page style for manual page headings on
- subsequent 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{scrpage2} also \Macro{markleft} can be utilized.
-\end{description}
-
-In the terminology of this manual, subsequent pages are all pages of a
-letter except for the first one.
-
-Page styles are also influenced by the option
-\Option{headsepline}\IndexOption{headsepline} and
-\Option{footsepline}\IndexOption{footsepline} (see
-\autoref{sec:scrlttr2.layout},
-\autopageref{desc:scrlttr2.option.headsepline}). 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 letter class itself uses
-\Macro{thispagestyle}\PParameter{empty} within
-\Macro{opening}\IndexCmd{opening} for the first page of the letter.
-%
-\EndIndex{Cmd}{pagestyle}%
-\EndIndex{Cmd}{thispagestyle}%
-\EndIndex{Pagestyle}{empty}%
-\EndIndex{Pagestyle}{plain}%
-\EndIndex{Pagestyle}{headings}%
-\EndIndex{Pagestyle}{myheadings}%
-
-\BeginIndex[indexother]{}{font>style}%
-For changing the font style of headers or footers you should use the
-user interface described in \autoref{sec:maincls.font}. For header
-and footer the same element is used, which you can name either
-\FontElement{pagehead}\IndexFontElement{pagehead} or
-\FontElement{pagefoot}\IndexFontElement{pagefoot}. The element for the
-page number within the header or footer is named
-\FontElement{pagenumber}\IndexFontElement{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{sec:maincls.pageStyle.example}.
-%
-\EndIndex[indexother]{}{font>style}%
-
-\begin{Declaration}
- \Macro{clearpage}\\
- \Macro{cleardoublepage}\\
- \Macro{cleardoublestandardpage}\\
- \Macro{cleardoubleplainpage}\\
- \Macro{cleardoubleemptypage}
-\end{Declaration}%
-\BeginIndex{Cmd}{clearpage}%
-\BeginIndex{Cmd}{cleardoublepage}%
-\BeginIndex{Cmd}{cleardoublestandardpage}%
-\BeginIndex{Cmd}{cleardoubleplainpage}%
-\BeginIndex{Cmd}{cleardoubleemptypage}%
-Please refer to \autoref{sec:maincls.pageStyle},
-\autopageref{desc:maincls.cmd.clearpage}. The function
-of \Macro{cleardoublepage} in \Class{scrlttr2} depends on the
-option \Option{cleardoublepage} which is described in more detail
-in \autoref{sec:scrlttr2.layout},
-\autopageref{desc:scrlttr2.option.cleardoublepage}.
-%
-\EndIndex{Cmd}{clearpage}%
-\EndIndex{Cmd}{cleardoublepage}%
-\EndIndex{Cmd}{cleardoublestandardpage}%
-\EndIndex{Cmd}{cleardoubleplainpage}%
-\EndIndex{Cmd}{cleardoubleemptypage}%
-
-
-
-\subsection{Variables}
-\label{sec:scrlttr2.variables}
-
-\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:maincls.font}). At this point we now
+change it (see \autoref{sec:scrlttr2.textmarkup},
+\autopageref{desc:scrlttr2.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
@@ -1393,175 +97,203 @@ 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}.
-
-\begin{desctable}
- \caption{Alphabetical list of all supported variables in
- \Class{scrlttr2}\label{tab:scrlttr2.variables}}\\
- \Endfirsthead
- \caption[]{Alphabetical list of all supported variables in
- \Class{scrlttr2} (\emph{continued})}\\
- \Endhead%
- \standardfoot%
- \ventry{backaddress}{return address for window envelopes
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.variable.backaddress})}%
- \ventry{backaddressseparator}{separator within the return address
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.variable.backaddressseparator})}%
- \ventry{ccseparator}{separator between title of additional addressees, and
- additional addressees
- (\autoref{sec:scrlttr2.afterClosing},
- \autopageref{desc:scrlttr2.variable.ccseparator})}%
- \ventry{customer}{customer number
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.customer})}%
- \ventry{date}{date
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.date})}%
- \ventry{emailseparator}{separator between e-mail name and e-mail address
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.emailseparator})}%
- \ventry{enclseparator}{separator between title of enclosure, and enclosures
- (\autoref{sec:scrlttr2.afterClosing},
- \autopageref{desc:scrlttr2.variable.enclseparator})}%
- \ventry{faxseparator}{separator between title of fax, and fax number
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.faxseparator})}%
- \ventry{fromaddress}{sender's address without sender name
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromaddress})}%
- \ventry{frombank}{sender's bank account
- (\autoref{sec:scrlttr2.other},
- \autopageref{desc:scrlttr2.variable.frombank})}%
- \ventry{fromemail}{sender's e-mail
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromemail})}%
- \ventry{fromfax}{sender's fax number
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromfax})}%
- \ventry{fromlogo}{commands for inserting the sender's logo
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromlogo})}%
- \ventry{fromname}{complete name of sender
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromname})}%
- \ventry{fromphone}{sender's telephone number
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromphone})}%
- \ventry{fromurl}{a url of the sender
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.fromurl})}%
- \ventry{invoice}{invoice number
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.invoice})}%
- \ventry{location}{more details of the sender
- (\autoref{sec:scrlttr2.locationField},
- \autopageref{desc:scrlttr2.variable.location})}%
- \ventry{myref}{ sender's reference
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.myref})}%
- \ventry{place}{place
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.place})}%
- \ventry{placeseparator}{separator between place and date
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.placeseparator})}%
- \ventry{phoneseparator}{separator between title of telephone, and telephone
- number
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.variable.phoneseparator})}%
- \ventry{signature}{signature beneath the ending of the letter
- (\autoref{sec:scrlttr2.closing},
- \autopageref{desc:scrlttr2.variable.signature})}%
- \ventry{specialmail}{mode of dispatch
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.variable.specialmail})}%
- \ventry{subject}{subject
- (\autoref{sec:scrlttr2.titleSubject},
- \autopageref{desc:scrlttr2.variable.subject})}%
- \ventry{subjectseparator}{separator between title of subject, and subject
- (\autoref{sec:scrlttr2.titleSubject},
- \autopageref{desc:scrlttr2.variable.subjectseparator})}%
- \ventry{title}{letter title
- (\autoref{sec:scrlttr2.titleSubject},
- \autopageref{desc:scrlttr2.variable.title})}%
- \ventry{toname}{complete name of addressee
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.variable.toname})}%
- \ventry{toaddress}{address of addressee without addressee name
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.variable.toaddress})}%
- \ventry{yourmail}{date of addressee's mail
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.yourmail})}%
- \ventry{yourref}{addressee's reference
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.variable.yourref})}%
-\end{desctable}
-
-\begin{Declaration}
- \Macro{newkomavar}\OParameter{description}\Parameter{name}\\
- \Macro{newkomavar*}\OParameter{description}\Parameter{name}\\
- \Macro{removereffields}\\
- \Macro{defaultreffields}\\
- \Macro{addtoreffields}\Parameter{name}
-\end{Declaration}
-\BeginIndex{Cmd}{newkomavar}\BeginIndex{Cmd}{newkomavar*}%
-\BeginIndex{Cmd}{addtoreffields}\BeginIndex{Cmd}{removereffields}%
-\BeginIndex{Cmd}{defaultreffields}%
-With \Macro{newkomavar} a new variable is defined. This variable is
-addressed via \PName{name}. As an option you can define a
-\PName{description} for the variable \PName{name}. Using the command
-\Macro{addtoreffields} you can add the variable \PName{name} to the
-reference fields line (see \autoref{sec:scrlttr2.refLine}). The
-\PName{description} and the content of the variable are added at the
-end of the reference fields line. The starred version
-\Macro{newkomavar*} is similar to the unstarred version, with a
-subsequent call of the command \Macro{addtoreffields}. Thus, the
-starred version automatically adds the variable to the reference
-fields line.
-\begin{Example}
- Suppose you need an additional field for direct dialling. You can
- define this field either with
-\begin{lstlisting}
- \newkomavar[Direct dialling]{myphone}
- \addtoreffields{myphone}
-\end{lstlisting}
- or more concisely with
-\begin{lstlisting}
- \newkomavar*[direct dialling]{myphone}
-\end{lstlisting}
-
-\end{Example}
-When you define a variable for the reference fields line you should always
-give it a description.
-
-With the command \Macro{removereffields} all variables in the ference
-line can be removed. This also includes the predefined variables of
-the class. The reference fields line is then empty except for the date
-which is always appended to the end. This can be useful, for example,
-if you wish to change the order of the variables in the reference
-fields line.
-
-The command \Macro{defaultreffields} acts to reset the reference
-fields line to its predefined format. In doing so, all custom-defined
-variables are removed from the reference fields line.
%
-\EndIndex{Cmd}{defaultreffields}%
-\EndIndex{Cmd}{newkomavar}\EndIndex{Cmd}{newkomavar*}%
-\EndIndex{Cmd}{addtoreffields}\EndIndex{Cmd}{removereffields}%
+\begin{desclist}
+ % Umbruchkorrektur
+ \renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
+ \desccaption{%
+ Alphabetical list of all supported variables in
+ \Class{scrlttr2}\label{tab:scrlttr2.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})}%
+ \ventry{backaddress}{%
+ return address for window envelopes %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.backaddress})}%
+ \ventry{%
+ backaddressseparator}{separator within the return address %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.backaddressseparator})}%
+ \ventry{ccseparator}{%
+ separator between title of additional addressees, and additional
+ addressees %
+ (\autoref{sec:scrlttr2.document},
+ \autopageref{desc:scrlttr2.variable.ccseparator})}%
+ \ventry{customer}{%
+ customer number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.customer})}%
+ \ventry{date}{%
+ date %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.date})}%
+ \ventry{emailseparator}{%
+ separator between e-mail name and e-mail address %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.emailseparator})}%
+ \ventry{enclseparator}{%
+ separator between title of enclosure, and enclosures %
+ (\autoref{sec:scrlttr2.document},
+ \autopageref{desc:scrlttr2.variable.enclseparator})}%
+ \ventry{faxseparator}{%
+ separator between title of fax, and fax number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.faxseparator})}%
+ \ventry{firstfoot}{%
+ page\ChangedAt{v3.08}{\Class{scrlttr2}} foot of the note paper %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.firstfoot})}%
+ \ventry{firsthead}{%
+ page\ChangedAt{v3.08}{\Class{scrlttr2}} head of the note paper %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.firsthead})}%
+ \ventry{fromaddress}{%
+ sender's address without sender name %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.fromaddress})}%
+ \ventry{frombank}{%
+ sender's bank account %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.frombank})}%
+ \ventry{fromemail}{%
+ sender's e-mail %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.fromemail})}%
+ \ventry{fromfax}{%
+ sender's fax number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.fromfax})}%
+ \ventry{fromlogo}{%
+ commands for inserting the sender's logo %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.fromlogo})}%
+ \ventry{fromname}{%
+ complete name of sender %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.fromname})}%
+ \ventry{fromphone}{%
+ sender's telephone number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.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})}%
+ \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})}%
+ \ventry{invoice}{%
+ invoice number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.invoice})}%
+ \ventry{location}{%
+ more details of the sender %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.location})}%
+ \ventry{myref}{%
+ sender's reference %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.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})}%
+ \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})}%
+ \ventry{phoneseparator}{%
+ separator between title of telephone and telephone number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.phoneseparator})}%
+ \ventry{place}{%
+ sender's place used near date %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.place})}%
+ \ventry{placeseparator}{%
+ separator between place and date %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.placeseparator})}%
+ \ventry{PPdatamatrix}{%
+ instruction, that print the data array of option
+ \OptionValue{addrfield}{PP} %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.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})}%
+ \ventry{signature}{%
+ signature beneath the ending of the letter %
+ (\autoref{sec:scrlttr2.closing},
+ \autopageref{desc:scrlttr2.variable.signature})}%
+ \ventry{specialmail}{%
+ mode of dispatch %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.specialmail})}%
+ \ventry{subject}{%
+ letter's subject %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.subject})}%
+ \ventry{subjectseparator}{%
+ separator between title of subject and subject %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.subjectseparator})}%
+ \ventry{title}{%
+ letter title %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.title})}%
+ \ventry{toaddress}{%
+ address of addressee without addressee name %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.toaddress})}%
+ \ventry{toname}{%
+ complete name of addressee %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.toname})}%
+ \ventry{yourmail}{%
+ date of addressee's referenced mail %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.yourmail})}%
+ \ventry{yourref}{%
+ addressee's reference %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.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})}%
+\end{desclist}
\begin{Declaration}
\Macro{setkomavar}%
\Parameter{name}\OParameter{description}\Parameter{content}\\
\Macro{setkomavar*}\Parameter{name}\Parameter{description}
\end{Declaration}
-\BeginIndex{Cmd}{setkomavar}\BeginIndex{Cmd}{setkomavar*}%
+\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}
of the variable. In contrast, \Macro{setkomavar*} can only set the
\PName{description} of the variable \PName{name}.
+% Wir haben hier ein anderes Beispiel als in der deutschen Anleitung, aber das
+% passt hier sehr gut so!
\begin{Example}
Suppose you have defined a direct dialling as mentioned above
and you now want to set the content. You write:
@@ -1595,267 +327,93 @@ empty \PName{description} argument.
one command.
\end{Example}
%
-\EndIndex{Cmd}{setkomavar}\EndIndex{Cmd}{setkomavar*}%
-
+\EndIndex{Cmd}{setkomavar}%
+\EndIndex{Cmd}{setkomavar*}%
\begin{Declaration}
\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 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.
+\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
+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
+information about defining variable on your own.%
+\EndIndex{Cmd}{usekomavar}%
+\EndIndex{Cmd}{usekomavar*}%
-\begin{Explain}
- The commands \Macro{usekomavar} and \Macro{usekomavar*} are,
- similarly to all commands where a starred version exists or which
- can take an optional argument, not fully expandable. Nevertheless,
- if used within \Macro{markboth}\IndexCmd{markboth},
- \Macro{markright}\IndexCmd{markright} or similar commands, you need
- not insert a \Macro{protect}\IndexCmd{protect} before using them.
- Of course this is also true for \Macro{markleft}\IndexCmd{markleft}
- if using package \Package{scrpage2}. However, these kinds of
- commands can not be used within commands like
- \Macro{MakeUppercase}\IndexCmd{MakeUppercase} which directly
- influence their argument.
- \Macro{MakeUppercase}\PParameter{\Macro{usekomavar}\Parameter{name}}
- would result in \Macro{usekomavar}\Parameter{NAME}. To avoid this
- problem you may use commands like \Macro{MakeUppercase} as an
- optional argument to \Macro{usekomavar} or \Macro{usekomavar*}. Then
- you will get the uppercase content of a variable using
- \Macro{usekomavar}\PValue{[\Macro{MakeUppercase}]}\Parameter{name}.
-\end{Explain}
-%
-\EndIndex{Cmd}{usekomavar}\EndIndex{Cmd}{usekomavar*}%
+
+\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
+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}
+onward), but used in another \File{lco}-file if it exists only.%
%
-\EndIndex{}{variables}
+\EndIndex{Cmd}{ifkomavar}%
+
\begin{Declaration}
- \Macro{ifkomavarempty}\Parameter{name}\Parameter{true}\Parameter{false}\\
- \Macro{ifkomavarempty*}\Parameter{name}\Parameter{true}\Parameter{false}
+ \Macro{ifkomavarempty}\Parameter{name}\Parameter{true-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} argument will be executed if the content or
-description is empty. Otherwise the \PName{false} argument will be
+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.
-
-\begin{Explain}
- It is important to know that the content or description of the
- variable will be expanded as far as this is possible with
- \Macro{edef}. If this results in spaces or unexpandable macros like
- \Macro{relax}, the result will be not empty even where the use of
- the variable would not result in any visible output.
-
- Both variants of the command also must not be used as the argument
- of \Macro{MakeUppercase}\IndexCmd{MakeUppercase} or other commands
- which have similar effects to their arguments (see the description
- of \Macro{usekomavar} above for more information about using
- commands like \Macro{usekomavar} or \Macro{ifkomavarempty} at the
- argument of \Macro{MakeUppercase}). However, they are robust enough
- to be used as the argument of, e.\,g., \Macro{markboth} or
- \Macro{footnote}.
-\end{Explain}
+the unstarred variant handles the contents.%
+\EndIndex{Cmd}{ifkomavarempty*}%
+\EndIndex{Cmd}{ifkomavarempty}%
+%
+\EndIndex{}{variables}%
-\subsection{The Pseudo-Lengths}
+\section{Pseudo-Lengths}
\label{sec:scrlttr2.pseudoLength}
-\BeginIndex{}{pseudo-lengths}
-\begin{Explain}
- {\TeX} works with a fixed number of registers. There are registers
- for tokens, for boxes, for counters, for skips and for dimensions.
- Overall there are 256 registers for each of these categories. For
- {\LaTeX} lengths, which are addressed with \Macro{newlength}, skip
- registers are used. Once all these registers are in use, you can not
- define any more additional lengths. The letter class
- \Class{scrlttr2} would normally use up more than 20 of such
- registers for the first page alone. {\LaTeX} itself already uses 40
- of these registers. The \Package{typearea} package needs some of
- them too; thus, approximately a quarter of the precious registers
- would already be in use. That is the reason why lengths specific to
- letters in \Class{scrlttr2} are defined with macros instead of
- lengths. The drawback of this approach is that computations with
- macros is somewhat more complicated than with real lengths.
-
- It can be pointed out that the now recommended {\LaTeX} installation
- with {\eTeX} no longer suffers from the above-mentioned
- limitation. However, that improvement came too late for
- \Class{scrlttr2}.
-\end{Explain}
+\BeginIndex{}{pseudo-lengths}
+\LaTeX{} processes length with commands \Macro{newlength}, \Macro{setlength},
+\Macro{addtolength}, and \Macro{the\PName{length}}. Many packages also use
+macros, that are commands, to storage lengths. \KOMAScript{} extends the
+method of storing length at macros by some commands similar to the commands
+above, that are used to handle real lengths. \KOMAScript calls this kind of
+lengths, that are stored at macros instead of real \LaTeX{} lengths,
+pseudo-lengths.
A list of all pseudo-lengths in \Class{scrlttr2} is shown in
-\autoref{tab:scrlttr2.pseudoLength} starting at
-\autopageref{tab:scrlttr2.pseudoLength}. The meaning of the various
+\autoref{tab:scrlttr2-experts.pseudoLength} starting at
+\autopageref{tab:scrlttr2-experts.pseudoLength}. The meaning of the various
pseudo-lengths is shown graphically in
-\autoref{fig:scrlttr2.pseudoLength}. The dimensions used in the figure
+\autoref{fig:scrlttr2-experts.pseudoLength}. The dimensions used in the figure
correspond to the default settings of \Class{scrlttr2}. More detailed
-description of the individual pseudo-lengths is found in the
-individual sections of this chapter.
-
-\begin{figure}
- \centering
- \includegraphics{plenDIN}
- \caption{Schematic of the pseudo-lengths for a letter}
- \label{fig:scrlttr2.pseudoLength}
-\end{figure}
-
-\begin{desctable}
- \caption{Pseudo-lengths provided by class \Class{scrlttr2}%
- \label{tab:scrlttr2.pseudoLength}}\\
- \Endfirsthead %
- \caption[]{Pseudo-lengths provided by class \Class{scrlttr2}
- (\emph{continued})}\\%
- \Endhead%
- \standardfoot%
- \pentry{backaddrheight}{%
- height of the return address at the upper edge of the address
- field (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.backaddrheight})}%
- \pentry{bfoldmarkvpos}{%
- vertical distance of lower foldmark from top paper edge
- (\autoref{sec:scrlttr2.other},
- \autopageref{desc:scrlttr2.plength.bfoldmarkvpos})}%
- \pentry{firstfootvpos}{%
- vertical distance of letterfoot from top paper edge
- (\autoref{sec:scrlttr2.firstFoot},
- \autopageref{desc:scrlttr2.plength.firstfootvpos})}%
- \pentry{firstfootwidth}{%
- width of letterfoot; letterfoot is centered horizontally on letter
- paper (\autoref{sec:scrlttr2.firstFoot},
- \autopageref{desc:scrlttr2.plength.firstfootwidth})}%
- \pentry{firstheadvpos}{%
- vertical distance of letterhead from top paper edge
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.plength.firstheadvpos})}%
- \pentry{firstheadwidth}{%
- width of letter head; letterhead is centered horizontally on
- letter paper (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.plength.firstheadwidth})}%
- \pentry{foldmarkhpos}{%
- horizontal distance of all foldmarks from left paper edge
- (\autoref{sec:scrlttr2.other},
- \autopageref{desc:scrlttr2.plength.foldmarkhpos})}%
- \pentry{fromrulethickness}{%
- Thickness of an optional horizontal line in the letterhead
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.plength.fromrulethickness})}%
- \pentry{fromrulewidth}{%
- length of an optional horizontal rule in letterhead
- (\autoref{sec:scrlttr2.firstHead},
- \autopageref{desc:scrlttr2.plength.fromrulewidth})}%
- \pentry{locwidth}{%
- width of supplemental data field; for zero value width is
- calculated automatically with respect to option \Option{locfield}
- that is described in \autoref{sec:scrlttr2.headoptions}
- (\autoref{sec:scrlttr2.locationField},
- \autopageref{desc:scrlttr2.plength.locwidth})}%
- \pentry{refaftervskip}{%
- vertical skip below reference fields line
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.plength.refaftervskip})}%
- \pentry{refhpos}{%
- horizontal distance of reference fields line from left paper edge;
- for zero value reference fields line is centered horizontally on
- letter paper (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.plength.refhpos})}%
- \pentry{refvpos}{%
- vertical distance of reference fields line from top paper edge
- (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.plength.refvpos})}%
- \pentry{refwidth}{%
- width of reference fields line (\autoref{sec:scrlttr2.refLine},
- \autopageref{desc:scrlttr2.plength.refwidth})}%
- \pentry{sigbeforevskip}{%
- vertical skip between closing and signature
- (\autoref{sec:scrlttr2.closing},
- \autopageref{desc:scrlttr2.plength.sigbeforevskip})}%
- \pentry{sigindent}{%
- indentation of signature with respect to text body
- (\autoref{sec:scrlttr2.closing},
- \autopageref{desc:scrlttr2.plength.sigindent})}%
- \pentry{specialmailindent}{%
- left indentation of mode of dispatch within address field
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.specialmailindent})}%
- \pentry{specialmailrightindent}{%
- right indentation of mode of dispatch within address field
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.specialmailrightindent})}%
- \pentry{tfoldmarkvpos}{%
- vertical distance of upper foldmark from top paper edge
- (\autoref{sec:scrlttr2.other},
- \autopageref{desc:scrlttr2.plength.tfoldmarkvpos})}%
- \pentry{toaddrheight}{%
- height of address field (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.toaddrheight})}%
- \pentry{toaddrhpos}{%
- horizontal distance of address field from left paper edge, for
- positive values; or negative horizontal distance of address field
- from right paper edge, for negative values
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.toaddrhpos})}%
- \pentry{toaddrindent}{%
- left and right indentation of address within address field
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.toaddrindent})}%
- \pentry{toaddrvpos}{%
- vertical distance of address field from top paper edge
- (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.toaddrvpos})}%
- \pentry{toaddrwidth}{%
- width of address field (\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.plength.toaddrwidth})}%
-\end{desctable}
+description of the individual pseudo-lengths is found in the individual
+sections of this chapter.
-\begin{Declaration}
- \Macro{@newplength}\Parameter{name}
-\end{Declaration}
-\BeginIndex{Cmd}{@newplength}%
-This command defines an new pseudo-length. This new pseudo-length is
-uniquely identified by its \PName{name}. If with this command a
-redefinition of an already existing pseudo-length is attempted, the
-commands exits with an error message.
-
-Since the user in general does not define own pseudo-lengths, this
-command is not intended as a user command. Thus, it can not be used
-within a document, but it can, for example, be used within an
-\File{lco} file.
-%
-\EndIndex{Cmd}{@newplength}%
+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
+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}.
-\begin{Declaration}
- \Macro{@setplength}%
- \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}\\
- \Macro{@addtoplength}%
- \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}
-\end{Declaration}
-\BeginIndex{Cmd}{@setplength}%
-\BeginIndex{Cmd}{@addtoplength}%
-Using the command \Macro{@setplength} you can assign the multiple of a
-\PName{value} to a \PName{pseudo-length}. The \PName{factor} is given
-as an optional argument (see also \Macro{setlengthtoplength}). The
-command \Macro{@addtoplength} adds the \PName{value} to a
-\PName{pseudo-length}. To assign, or to add the multiple of, one
-\PName{pseudo-length} to another pseudo-length, the command
-\Macro{useplength} is used within \PName{value}. To subtract the
-value of one pseudo-length from another \PName{pseudo-length} a minus
-sign, or \PValue{-1}, is used as the \PName{factor}.
-
-Since the user in general does not define own pseudo-lengths, this
-command is not intended as a user command. Thus, it can not be used
-within a document, but can, for example, be used within an \File{lco}
-file.
-%
-\EndIndex{Cmd}{@setplength}%
-\EndIndex{Cmd}{@addtoplength}%
\begin{Declaration}
\Macro{useplength}\Parameter{name}
@@ -1864,10 +422,12 @@ file.
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.
+used with an \File{lco}-file\Index{lco-file=\File{lco}-file} (see
+\autoref{sec:scrlttr2.lcoFile} ab \autopageref{sec:scrlttr2.lcoFile}).%
%
\EndIndex{Cmd}{useplength}%
+
\begin{Declaration}
\Macro{setlengthtoplength}%
\OParameter{factor}\Parameter{length}\Parameter{pseudo-length}\\
@@ -1900,8 +460,30 @@ of a \PName{pseudo-length} to the \PName{length}.
%
\EndIndex{}{pseudo-lengths}
-\subsection{The General Structure of a Letter Document}
+
+\LoadCommon[scrlttr]{0} % \section{Early or Late Selection of Options}
+
+\LoadCommon[scrlttr]{1} % \section{Compatibility with Earlier Versions of
+ % \KOMAScript{}}
+
+\LoadCommon[scrlttr]{2} % \section{Draft-Mode}
+
+\LoadCommon[scrlttr]{3} % \section{Page Layout}
+
+Normally it makes no sense to distinguish letters with single-side layout and
+letters with double-side layout. Mostly letters won't be bound like
+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}.%
+%
+\EndIndex{}{page>layout}
+
+
+\section{General Structure of Letter Documents}
\label{sec:scrlttr2.document}
+\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
@@ -1910,6 +492,45 @@ letters. As illustrated in \autoref{fig:scrlttr2.document}, a letter
document consists of a preamble, the individual letters, and the
closing.
+\begin{figure}
+ \KOMAoptions{captions=bottombeside}%
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{%
+ General structure of a letter document with several individual letters%
+ }]{%
+ 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}%
+ }[l]
+ \begin{minipage}[b]{.667\linewidth}
+ \centering\small\setlength{\fboxsep}{1.5ex}%
+ \addtolength{\linewidth}{-\dimexpr2\fboxrule+2\fboxsep\relax}%
+ \fbox{\parbox{\linewidth}{\raggedright%
+ \Macro{documentclass}\OParameter{\dots}\PParameter{scrlttr2}\\
+ \dots\\
+ {\centering\emph{settings for all letters}\\}
+ \dots\\
+ \Macro{begin}\PParameter{document}\\
+ \dots\\
+ {\centering\emph{settings for all letters}\\}
+ \dots\\
+ }}\\
+ \fbox{\parbox{\linewidth}{\raggedright%
+ \Macro{begin}\PParameter{letter}\Parameter{addressee}\\
+ \dots\\
+ {\centering\emph{content of the individual letter}\\}
+ \dots\\
+ \Macro{end}\PParameter{letter}\\
+ }}\\[2pt]
+ \parbox{\linewidth}{\raggedright\vspace{-.5ex}\vdots\vspace{1ex}}\\
+ \fbox{\parbox{\linewidth}{\raggedright%
+ \Macro{end}\PParameter{document}\\
+ }}\\[\dimexpr\fboxsep+\fboxrule\relax]
+ \end{minipage}
+ \end{captionbeside}
+\end{figure}
+
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
@@ -1930,446 +551,926 @@ The closing usually consists only of
additional comments at this point.
\begin{figure}
-\centering\small\setlength{\fboxsep}{1.5ex}
-\fbox{\parbox{.667\linewidth}{\raggedright%
- \Macro{documentclass}\OParameter{\dots}\PParameter{scrlttr2}\\
- \dots\\
- {\centering\emph{settings for all letters}\\}
- \dots\\
- \Macro{begin}\PParameter{document}\\
- \dots\\
- {\centering\emph{settings for all letters}\\}
- \dots\\
- }}\\
-\fbox{\parbox{.667\linewidth}{\raggedright%
- \Macro{begin}\PParameter{letter}\Parameter{addressee}\\
- \dots\\
- {\centering\emph{content of the individual letter}\\}
- \dots\\
- \Macro{end}\PParameter{letter}\\
- }}\\
-\parbox{.667\linewidth}{\raggedright\vspace{-.5ex}\vdots\vspace{1ex}}\\
-\fbox{\parbox{.667\linewidth}{\raggedright%
- \Macro{end}\PParameter{document}\\
- }}\\
-\caption{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}
-\vspace{2\abovecaptionskip}
-\fbox{\parbox{.667\linewidth}{\raggedright%
- \Macro{begin}\PParameter{letter}%
- \OParameter{options}\Parameter{addressee}\\
- \dots\\
- {\centering\emph{settings for this letter}\\}
- \dots\\
- \Macro{opening}\Parameter{opening}\\
- }}\\
-\fbox{\parbox{.667\linewidth}{\raggedright%
- \dots\\
- {\centering\emph{letter text}\\}
- \dots\\
- }}\\
-\fbox{\parbox{.667\linewidth}{\raggedright%
- \Macro{closing}\Parameter{closing}\\
- \Macro{ps}\\
- \dots\\
- {\centering\emph{postscript}\\}
- \dots\\
- \Macro{encl}\Parameter{enclosures}\\
- \Macro{cc}\Parameter{additional addressees}\\
- \Macro{end}\PParameter{letter}\\
- }}\\
-\caption{General structure of a single letter within a letter
-document (see also \autoref{fig:scrlttr2.document})}
-\label{fig:scrlttr2.letter}
+ \KOMAoptions{captions=bottombeside}%
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{%
+ 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]
+ \begin{minipage}[b]{.667\linewidth}%
+ \centering\small\setlength{\fboxsep}{1.5ex}%
+ \addtolength{\linewidth}{-\dimexpr2\fboxrule+2\fboxsep\relax}%
+ \fbox{\parbox{\linewidth}{\raggedright%
+ \Macro{begin}\PParameter{letter}%
+ \OParameter{Optionen}\Parameter{addressee}\\
+ \dots\\[\dp\strutbox]
+ {\centering\emph{settings for this letter}\\}
+ \dots\\
+ \Macro{opening}\Parameter{opening}\\
+ }}\\[1pt]
+ \fbox{\parbox{\linewidth}{\raggedright%
+ \dots\\[\dp\strutbox]
+ {\centering\emph{letter text}\\}
+ \dots\\
+ }}\\[1pt]
+ \fbox{\parbox{\linewidth}{\raggedright%
+ \Macro{closing}\Parameter{closing}\\
+ \Macro{ps}\\
+ \dots\\[\dp\strutbox]
+ {\centering\emph{postscript}\\}
+ \dots\\
+ \Macro{encl}\Parameter{enclosures}\\
+ \Macro{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 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}. Similarly, the closing always starts with
-\Macro{closing}. The two arguments \PName{opening} and \PName{closing}
-can be left empty, but both commands must be used and must have an
-argument.
+As shown in \autoref{fig:scrlttr2.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
+\PName{closing} can be left empty, but both commands must be used and must
+have an argument.
-\begin{Explain}
- It should be noted that several settings can be changed between the
- individual letters. Such changes then have an effect on all
- subsequent letters. For reasons of maintainability of your letter
- documents, it is however not recommended to use further general
- settings with limited scope between the letters.
-\end{Explain}
-
-As already mentioned, all general settings used in the preamble of a
-letter document, with the exception of font size, can also be in the
-preamble of the individual letters. Therefore, you will not find more
-detailed explanations for the possible settings in this
-section. Please refer to \autoref{sec:scrlttr2.startLetter}.
-
-
-\section{The Letter Declaration}
-\label{sec:scrlttr2.startLetter}
-
-The letter declaration gives all settings for the letter itself, as
-well as for the first page of the body. The first page consists of
-more than just the preliminaries of the letter; in fact, it consists
-of several different parts.
+It should be noted that several settings can be changed between the individual
+letters. Such changes then have an effect on all subsequent letters. For
+reasons of maintainability of your letter documents, it is however not
+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}
+\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.
-\subsection{Foldmarks}
-\label{sec:scrlttr2.foldmarks}
-\BeginIndex{}{foldmark}%
+The \PName{addressee} is a mandatory argument passed to the
+\Environment{letter} environment. Parts\textnote{Attention!} of the addressee
+contents are separated by double backslashes. These parts are output on
+individual lines in the address field. Nevertheless, the double backslash
+should not be interpreted as a certain line break. Vertical material such as
+paragraphs or vertical space is not permitted within \PName{addressee}, and
+could lead to unexpected results and error messages, as is the case also for
+the standard letter class.
-Foldmarks\Index{foldmark} are short horizontal lines at the left edge,
-and short vertical lines at the upper edge of the paper. \KOMAScript{}
-at present supports three configurable horizontal and one configurable
-vertical foldmarks. In addition, there is support for a punchmark or
-center mark which cannot be shifted in the vertical direction.
+\begin{Example}
+ \phantomsection\label{desc:scrlttr2.env.letter.example}%
+ Assumed, someone wants to send a letter to Joana Public. A minimalistic
+ letter document for this may be:
+\begin{lstcode}
+ \documentclass[version=last]{scrlttr2}
+ \usepackage[english]{babel}
+ \begin{document}
+ \begin{letter}{Joana Public\\
+ Hillside 1\\
+ 12345 Public-City}
+ \end{letter}
+ \end{document}
+\end{lstcode}
+ However, this would not result in any printable output. At least there
+ wouldn't 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}.
+\end{Example}
+%
+\EndIndex{}{addressee}%
+\EndIndex{Env}{letter}%
\begin{Declaration}
- \PLength{tfoldmarkvpos}\\
- \PLength{mfoldmarkvpos}\\
- \PLength{bfoldmarkvpos}
+ \Macro{AtBeginLetter}\Parameter{instruction code}\\
+ \Macro{AtEndLetter}\Parameter{instruction code}
\end{Declaration}
-\BeginIndex{PLength}{tfoldmarkvpos}%
-\BeginIndex{PLength}{bfoldmarkvpos}%
-\BeginIndex{PLength}{mfoldmarkvpos}%
-The letter class \Class{scrlttr2} knows a total of three
-vertically-placed configurable foldmarks. The position of the upper
-foldmark, taken from the upper edge of the paper, is governed by the
-pseudo-length \PLength{tfoldmarkvpos}, that of the middle foldmark by
-pseudo-length
-\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}, and that
-of the lower foldmark by pseudo-length \PLength{bfoldmarkvpos}. With
-the addition of the punch\Index{punchmark} or
-center\Index{center mark|see{punchmark}}% not sure of this construction
-mark, there is still a fourth horizontal mark. This one is however
-always placed at the vertical center of the paper.
-
-The upper and lower foldmarks do not serve to divide the paper into
-exactly equal thirds. Instead, with their help, the paper should be
-folded such that the address field appears correctly in the space
-available in the chosen window envelope format, which is determined by
-choice of \File{lco} file. Several such files are available offering
-predefined formats. An anomaly is present with \Option{DINmtext}: for
-this format, an envelope format of C6/5 (also known as ``C6 long'') is
-assumed. Letters written with this option are not suited to envelopes
-of formats C5 or C4.
-
-The middle foldmark is not normally required for Western letters. In
-Japan, however, a larger number of envelope formats exists, requiring
-one more foldmark (see the Japanese \File{lco} files). At this point
-attention is drawn to the fact that reference to ``upper'',
-``middle'', and ``lower'' foldmarks is simply a convenience. In fact,
-it is not defined that \PLength{tfoldmarkvpos} must be smaller than
-\PLength{mfoldmarkvpos}, which in turn must be smaller than
-\PLength{bfoldmarkvpos}. If on the other hand one of the
-pseudo-lengths is set to null, then the corresponding foldmark will
-not be set even if the option \Option{foldmarks} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.foldmarks}) is explicity activated.
+\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
+\Macro{AtBeginDocument}\IndexCmd{AtBeginDocument} and
+\Macro{AtEndOfClass}\IndexCmd{AtEndOfClass} at the \LaTeX{} kernel. The class
+\Class{scrlttr2} provides two more hooks. The \PName{instruction code} for
+these may be declared using \Macro{AtBeginLetter} and
+\Macro{AtEndLetter}\ChangedAt{v2.95}{\Class{scrlttr2}}. Originally, hooks were
+provided for package and class authors, so they are documented in
+\cite{latex:clsguide} only, and not in \cite{latex:usrguide}. However, with
+letters there are useful applications of \Macro{AtBeginLetter} as the
+following example may illustrate.
%
-\EndIndex{PLength}{tfoldmarkvpos}%
-\EndIndex{PLength}{mfoldmarkvpos}%
-\EndIndex{PLength}{bfoldmarkvpos}%
+\begin{Example}
+ It is given that one has to set multiple letters with questionnaires
+ within one document. Questions are numbered automatically within
+ single letters using a counter. Since, in contrast to page
+ numbering, that counter is not known by \Class{scrlttr2}, it would
+ not be reset at the start of each new letter. Given that each
+ questionnaire contains ten questions, question~1 would get number~11
+ in the second letter. A solution is to reset this counter at the
+ beginning of each new letter:
+\begin{lstlisting}
+ \newcounter{Question}
+ \newcommand{\Question}[1]{%
+ \refstepcounter{Question}\par
+ \noindent\begin{tabularx}{\textwidth}{l@{}X}
+ \theQuestion:~ & #1\\
+ \end{tabularx}%
+ }%
+ \AtBeginLetter{\setcounter{Question}{0}}
+\end{lstlisting}
+ This way first question remains question~1, even in the 1001st letter. Of
+ course the definition at this example needs package
+ \Package{tabularx}\IndexPackage{tabularx} (see \cite{package:tabularx}).
+\end{Example}
+%
+\EndIndex{Cmd}{AtEndLetter}%
+\EndIndex{Cmd}{AtBeginLetter}%
\begin{Declaration}
- \PLength{tfoldmarklength}\\
- \PLength{mfoldmarklength}\\
- \PLength{bfoldmarklength}\\
- \PLength{pfoldmarklength}
+ \Macro{opening}\Parameter{opening}
\end{Declaration}
-\BeginIndex{PLength}{tfoldmarklength}%
-\BeginIndex{PLength}{mfoldmarklength}%
-\BeginIndex{PLength}{bfoldmarklength}%
-\BeginIndex{PLength}{pfoldmarklength}%
-These\ChangedAt{v2.97e}{\Class{scrlttr2}} four pseudo-lengths
-determine the lengths of the four horizontal foldmarks. One
-exceptional behaviour exists. If the length is given as null, then the
-three vertically-configurable pseudo-lengths
-\PLength{tfoldmarklength}, \PLength{mfoldmarklength} and
-\PLength{bfoldmarklength} are set to 2\Unit{mm} in length. The length of
-the punchmark, \PLength{pfoldmarklength}, is instead set to 4\Unit{mm}.
-\EndIndex{PLength}{tfoldmarklength}%
-\EndIndex{PLength}{mfoldmarklength}%
-\EndIndex{PLength}{bfoldmarklength}%
-\EndIndex{PLength}{pfoldmarklength}%
+\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
+typesets the folding marks\Index{folding marks},
+letterhead\Index{letter>head}, address field\Index{address field}, reference
+fields line\Index{reference line}, subject\Index{subject}, the page
+footer\Index{page>footer} and others. In short, without \Macro{opening} there
+is no letter. And if you want to print a letter without opening you have to
+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:
+ \lstinputcode[xleftmargin=1em]{letter-0.tex}
+ This will result in a note paper sheet shown in
+ \autoref{fig:scrlttr2.letter-0}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with addressee and opening}]{%
+ result of a minimalistic letter with addressee and opening only
+ (date and folding marks are defaults of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-0}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-0}
+ \end{figure}
+\end{Example}
+\iffalse% Umbruchkorrekturtext
-\begin{Declaration}
- \PLength{foldmarkhpos}
-\end{Declaration}
-\BeginIndex{PLength}{foldmarkhpos}%
-This pseudo-length gives the distance of all horizontal foldmarks from
-the left edge of the paper. Normally, this is 3.5\Unit{mm}. This value
-can be changed in the user's own \File{lco} file, in case the user's
-printer has a wider unprintable left margin. Whether the foldmarks are
-typeset at all depends on the option \Option{foldmarks} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.foldmarks}).
+In the early days of computer-generated letters, programs did not have many
+capabilities, therefore the letters seldom had an opening. Today the
+capabilities have been enhanced. Thus personal openings are very common, even
+in mass-production advertising letters.%
+\fi
%
-\EndIndex{PLength}{foldmarkhpos}%
-\EndIndex{}{Faltmarke}%
-
+\EndIndex{Cmd}{opening}%
\begin{Declaration}
- \PLength{lfoldmarkhpos}
+ \Macro{closing}\Parameter{closing phrase}
\end{Declaration}
-\BeginIndex{PLength}{lfoldmarkhpos}%
-Apart from\ChangedAt{v2.97e}{\Class{scrlttr2}} the horizontal
-foldmarks there is also a vertical foldmark, whose position from the
-left margin is set via the pseudo-length \PLength{lfoldmarkhpos}. This
-foldmark is used, for example, in Japanese Chou- or You-format
-envelopes, when one wishes to use A4 size sheets with them. This can
-also be useful for envelopes in C6 format.
-\EndIndex{PLength}{lfoldmarkhpos}%
+\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}.
+
+\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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with addressee, opening, text, and
+ closing}]{%
+ result of a small letter with addressee, opening, text, and closing
+ (date and folding marks are defaults of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-1}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-1}
+ \end{figure}
+\end{Example}
+%
+\EndIndex{Cmd}{closing}%
\begin{Declaration}
- \PLength{lfoldmarklength}
-\end{Declaration}
-\BeginIndex{PLength}{lfoldmarklength}%
-The\ChangedAt{v2.97e}{\Class{scrlttr2}} length of the vertical
-foldmark is set via the pseudo-length \PLength{lfoldmarklength}. Here
-too there is an exceptional behaviour. When the length is set to null,
-a length of 4\Unit{mm} is actually used.
-\EndIndex{PLength}{lfoldmarklength}%
+ \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
+normal text. If you want the postscript to be introduced with the
+acronym ``PS:'' , which by the way is written without a full stop, you
+have to type this yourself. The acronym is typeset neither
+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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with addressee, opening, text,
+ closing, and postscript}]{%
+ result of a small letter with addressee, opening, text, closing, and
+ postscript
+ (date and folding marks are defaults of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-2}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-2}
+ \end{figure}
+\end{Example}
+\begin{Explain}
+ In the time when letters were written by hand it was quite common to use a
+ postscript because this was the only way to add information which one had
+ forgotten to mention in the main part of the letter. Of course, in letters
+ written with {\LaTeX} you can insert additional lines easily. Nevertheless,
+ it is still popular to use the postscript. It gives one a good possibility
+ to underline again the most important or sometimes the less important things
+ of the particular letter.
+\end{Explain}
+%
+\EndIndex{Cmd}{ps}
\begin{Declaration}
- \PLength{foldmarkvpos}
+ \Macro{cc}\Parameter{distribution list}\\
+ \Macro{setkomavar}\PParameter{\Variable{ccseparator}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
-\BeginIndex{PLength}{foldmarkvpos}%
-This\ChangedAt{v2.97e}{\Class{scrlttr2}} pseudo-length gives the
-distance of all vertical foldmarks from teh upper edge of the
-paper. Normally this is 3.5\Unit{mm}, but the value can be changed in the
-user's personal \File{lco} file in case the user's printer has a wider
-unprintable top margin. Whether the foldmarks are typeset at all
-depends on the option \Option{foldmarks} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.foldmarks}). At present there is
-only one vertical foldmark, which is designated the left vertical
-foldmark.
+\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
+\PName{distribution list} as its argument. If the content of the variable
+\Variable{ccseparator}\Index{separator}\Index{delimiter} is not empty, then
+the name and the content of this variable is inserted before
+\PName{distribution list}. In this case the \PName{distribution list} will be
+indented appropriately. It is a good idea\textnote{Hint!} to set the
+\PName{distribution list} \Macro{raggedright}\IndexCmd{raggedright} and to
+separate the individual entries with a double backslash.
+\begin{Example}
+ 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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with addressee, opening, text,
+ closing, postscript, and distribution list}]{%
+ result of a small letter with addressee, opening, text, closing,
+ postscript, and distribution list
+ (date and folding marks are defaults of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-3}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-3}
+ \end{figure}
+\end{Example}
+In front of the distribution list a vertical gap is inserted automatically.%
%
-\EndIndex{PLength}{foldmarkvpos}%
-\EndIndex{}{Faltmarke}%
+\EndIndex{Variable}{ccseparator}%
+\EndIndex{Cmd}{cc}%
\begin{Declaration}
- \PLength{foldmarkthickness}
+ \Macro{encl}\Parameter{enclosures}\\
+ \Macro{setkomavar}\PParameter{\Variable{enclseparator}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
-\BeginIndex{PLength}{foldmarkthickness}%
-This\ChangedAt{v2.97c}{\Class{scrlttr2}} pseudo-length determines the
-thickness of all foldmarks. Default value is 0.2\Unit{pt}, in other words a
-very thin hairline. In particular, if the color of the foldmarks is
-changed, this can be too thin!
-\EndIndex{PLength}{foldmarkthickness}%
+\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
+\Variable{enclseparator}\Index{separator}\Index{delimiter}.
+\begin{Example}
+ Now, the example letter will be extended by some paragraphs from the
+ constitution. These will be added as an enclosure. The description title
+ 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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with addressee, opening, text,
+ closing, postscript, distribution list, and enclosure}]{%
+ result of a small letter with addressee, opening, text, closing,
+ postscript, distribution list, and enclosure
+ (date and folding marks are defaults of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-4}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-4}
+ \end{figure}
+\end{Example}
+%
+\EndIndex{Cmd}{encl}%
+\EndIndex{Variable}{enclseparator}%
+%
+\EndIndex{}{letter>structure}
+
+
+\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}
+
+
+\LoadCommon[scrlttr]{5} % \section{Text Markup}
+
+With command \Macro{usekomafont} the current font style may be changed into
+the font style of the selected \PName{element}.
+
+A general example for the usage of \Macro{setkomafont} and \Macro{usekomafont}
+may be found in \autoref{sec:maincls.textmarkup} at
+\autopageref{desc:maincls.setkomafont.example}.
+
+\begin{desclist}
+ \desccaption{%
+ Alphabetical list of elements whose font can be changed in
+ \Class{scrlttr2} using the commands \Macro{setkomafont} and
+ \Macro{addtokomafont}\label{tab:scrlttr2.elementsWithoutText}%
+ }{%
+ Elements whose font can be changed (\emph{continuation})%
+ }%
+ \feentry{addressee}{name und address in address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.option.addrfield})}%
+ \feentry{backaddress}{%
+ return address for a window envelope %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.option.backaddress})}%
+ \feentry{descriptionlabel}{%
+ label, i.\,e., the optional argument of \Macro{item}, in a
+ \Environment{description} environment %
+ (\autoref{sec:scrlttr2.lists},
+ \autopageref{desc:scrlttr2.env.description})}%
+ \feentry{foldmark}{%
+ foldmark on the letter page; intended for color settings %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.option.foldmarks})}%
+ \feentry{footnote}{%
+ footnote text and marker %
+ (see \autoref{sec:scrlttr2.footnotes},
+ \autopageref{desc:scrlttr2.cmd.footnote})}%
+ \feentry{footnotelabel}{%
+ mark of a footnote; used according to the element \FontElement{footnote} %
+ (see \autoref{sec:scrlttr2.footnotes},
+ \autopageref{desc:scrlttr2.cmd.footnote})}%
+ \feentry{footnotereference}{%
+ footnote reference in the text %
+ (see \autoref{sec:scrlttr2.footnotes},
+ \autopageref{desc:scrlttr2.cmd.footnote})}%
+ \feentry{footnoterule}{%
+ horizontal rule\ChangedAt{v3.07}{\Class{scrlttr2}} above the footnotes at
+ the end of the text area %
+ (see \autoref{sec:maincls.footnotes},
+ \autopageref{desc:maincls.cmd.setfootnoterule})}%
+ \feentry{labelinglabel}{%
+ labels, i.\,e., the optional argument of \Macro{item} in the
+ \Environment{labeling} environment %
+ (see \autoref{sec:scrlttr2.lists},
+ \autopageref{desc:scrlttr2.env.labeling})}%
+ \feentry{labelingseparator}{%
+ separator, i.\,e., the optional argument of the \Environment{labeling}
+ environment; used according to the element \FontElement{labelinglabel} %
+ (see \autoref{sec:scrlttr2.lists},
+ \autopageref{desc:scrlttr2.env.labeling})}%
+ \feentry{pagefoot}{%
+ used after element \FontElement{pageheadfoot} for the page foot, that has
+ been defined with variable \Variable{nextfoot}\IndexVariable{nextfoot}, or
+ for the page foot of package \Package{scrpage2} %
+ (\autoref{cha:scrpage}, \autopageref{desc:scrpage.fontelement.pagefoot})}%
+ \feentry{pagehead}{%
+ another name for \FontElement{pageheadfoot}}%
+ \feentry{pageheadfoot}{%
+ the head of a page, but also the foot of a page at all page style, that
+ has been defined using \KOMAScript{} %
+ (see \autoref{sec:scrlttr2.pagestyle},
+ \autopageref{desc:scrlttr2.fontelement.pageheadfoot})}%
+ \feentry{pagenumber}{%
+ page number in the header or footer %
+ (see \autoref{sec:scrlttr2.pagestyle},
+ \autopageref{desc:scrlttr2.fontelement.pagenumber})}%
+ \feentry{pagination}{%
+ another name for \FontElement{pagenumber}}%
+ \feentry{refname}{%
+ description or title of the fields in the reference line %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.yourref})}%
+ \feentry{refvalue}{%
+ content of the fields in the reference line %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.yourref})}%
+ \feentry{specialmail}{%
+ mode of dispatch in the address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.specialmail})}%
+ \feentry{subject}{%
+ subject in the opening of the letter %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.subject})}%
+ \feentry{title}{%
+ title in the opening of the letter %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.title})}%
+ \feentry{toaddress}{%
+ variation of the element \FontElement{addressee} for setting the addressee
+ address (less the name) in the address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.toaddress})}%
+ \feentry{toname}{%
+ variation of the element \FontElement{addressee} for the name (only) of
+ the addressee in the address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.toname})}%
+\end{desclist}
+%
+\EndIndex{Cmd}{setkomafont}%
+\EndIndex{Cmd}{addtokomafont}%
+\EndIndex{Cmd}{usekomafont}%
+%
+\EndIndex{}{font}%
+\EndIndex{}{text>markup}
+
+
+\section{Note Paper}
+\label{sec:scrlttr2.firstpage}
+\BeginIndex{}{note paper}%
+\BeginIndex{}{letter>first page}
+
+The note paper is the first page and therefore the signboard of each
+letter. In business scope often preprinted forms are used, that already
+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
+note page and the used variable is shown by
+\autoref{fig:scrlttr2.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
+the note paper. Following pages in the meaning of this manual are all letter
+pages but the first one.
+
+\begin{figure}
+ \centering
+ \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}
+\end{figure}
\begin{Declaration}
- \FontElement{foldmark}
-\end{Declaration}
+ \KOption{foldmarks}\PName{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
+marks and one configurable vertical folding mark. Additionally it provides a
+horizontal hole puncher mark, also known as page middle mark. This additional
+mark cannot be moved vertically.
+
+This option activates or deactivates folding marks for vertical
+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).
+
+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
+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)
+chosen for a letter. Default values are \PValue{true} and \PValue{TBMPL}.
+%
+\begin{table}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}{%
+ Combinable values for the configuration of folding marks with
+ option \Option{foldmarks}%
+ }[l]
+ \begin{tabular}[t]{ll}
+ \toprule
+ \PValue{B} & activate upper horizontal foldmark on left paper edge\\%
+ \PValue{b} & deactivate upper horizontal foldmark on left paper edge\\%
+ \PValue{H} & activate all horizontal folding marks on left paper edge\\%
+ \PValue{h} & deactivate all horizontal folding marks on left paper edge\\%
+ \PValue{L} & activate left vertical foldmark on upper paper edge\\%
+ \PValue{l} & deactivate left vertical foldmark on upper paper edge\\%
+ \PValue{M} & activate middle horizontal foldmark on left paper edge\\%
+ \PValue{m} & deactivate middle horizontal foldmark on left paper edge\\%
+ \PValue{P} & activate punch or center mark on left paper edge\\%
+ \PValue{p} & deactivate punch or center mark on left paper edge\\%
+ \PValue{T} & activate lower horizontal foldmark on left paper edge\\%
+ \PValue{t} & deactivate lower horizontal foldmark on left paper edge\\%
+ \PValue{V} & activate all vertical folding marks on upper paper edge\\%
+ \PValue{v} & deactivate all vertical folding marks on upper paper edge\\%
+ \bottomrule
+ \end{tabular}
+ \end{captionbeside}
+ \label{tab:scrlttr2.foldmark}
+\end{table}
+%
+\begin{Example}
+ Assume that you would like to deactivate all folding marks except the punching
+ mark. This you can accomplish with, for example:
+\begin{lstlisting}
+ \KOMAoption{foldmarks=blmt}
+\end{lstlisting}
+ as long as the defaults have not been changed previously. If some changes
+ 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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with addressee, opening, text,
+ closing, postscript, distribution list, enclosure, and hole puncher
+ mark}]{%
+ result of a small letter with addressee, opening, text, closing,
+ postscript, distribution list, enclosure, and hole puncher mark
+ (the date is a default of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-7}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-7}
+ \end{figure}
+\end{Example}
\BeginIndex{FontElement}{foldmark}%
-Via\ChangedAt{v2.97c}{\Class{scrlttr2}} this element the color of the
-foldmarks can be changed. To do so, the commands to change the font of
-the element are usd, as described in \autoref{sec:scrlttr2.font},
-\autopageref{sec:scrlttr2.font}. The default setting is no change.
+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.%
\EndIndex{FontElement}{foldmark}%
+%
+\EndIndex{Option}{foldmarks~=\PName{selection}}%
-\subsection{The Letterhead}
-\label{sec:scrlttr2.firstHead}
-\BeginIndex{}{letter>head}%
-
-The term letterhead here refers to all of the data pertaining to the
-sender and which is set above the addressee's address. It is usually
-expected that this information is set via the page style settings. In
-fact, this was the case in the earlier incarnation of the letter
-class, \Class{scrlettr}. But with \Class{scrlttr2}, the letterhead is
-made independent of the page style setting, and is set by the command
-\Macro{opening}.
-% Fuellmaterial
-\iftrue The position of the letterhead is absolute and independent of
-the type area. In fact, the first page of a letter, the page that
-holds the letterhead, is set using the page style \PValue{empty}. \fi
-% Ende des Fuellmaterials
+\begin{Declaration}
+ \KOption{enlargefirstpage}\PName{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
+following pages. If, as a result, the footer of the first page would reach
+into the text area, this text area is automatically made smaller using the
+\Macro{enlargethispage}\IndexCmd{enlargethispage} macro. On the other hand, if
+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
+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}}%
\begin{Declaration}
- \PLength{firstheadvpos}
+ \KOption{firsthead}\PName{simple switch}
\end{Declaration}
-\BeginIndex{PLength}{firstheadvpos}%
-The pseudo-length \PLength{firstheadvpos} gives the distance between
-the top edge of the paper and start of the letterhead. This value is
-set differently in the various predefined \File{lco} files. A typical
-value is 8\Unit{mm}.
+\BeginIndex{Option}{firsthead~=\PName{simple switch}}%
+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{PLength}{firstheadvpos}
+\EndIndex{Option}{firsthead~=\PName{simple switch}}%
\begin{Declaration}
- \PLength{firstheadwidth}
+ \KOption{fromalign}\PName{method}
\end{Declaration}
-\BeginIndex{PLength}{firstheadwidth}%
-The pseudo-length \PLength{firstheadwidth} gives the width of the
-letterhead. This value is set differently in the various predefined
-\File{lco} files. While this value usually depends on the paper width
-and the distance between the left edge of the paper and the adressee
-address field, it was the type area width in \Option{KOMAold}.
+\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
+also the option\ChangedAt{v2.97e}{\Class{scrlttr2}} of adding the return
+address to the sender's extension\Index{sender's
+ extension}. Further\textnote{Attention!}, this option serves as a switch to
+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}.%
+%
+\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}
+ \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}%
+ \entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
+ 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}%
+ \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}.}%
+ \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}.}%
+ \entry{\PValue{right}}{%
+ right-justified return address; an optional logo will be left
+ justified; letterhead extensions will be activated}%
+ \end{desctabular}
+\end{table}
%
-\EndIndex{PLength}{firstheadwidth}%
+\EndIndex{Option}{fromalign~=\PName{method}}%
+
\begin{Declaration}
- \Variable{fromname}\\
- \Variable{fromaddress}\\
- \Variable{fromphone}\\
- \Variable{fromfax}\\
- \Variable{fromemail}\\
- \Variable{fromurl}\\
- \Variable{fromlogo}
+ \KOption{fromrule}\PName{position}\\
+ \Macro{setkomavar}\PParameter{\Variable{fromname}}%
+ \OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{fromaddress}}%
+ \OParameter{description}\Parameter{contents}
\end{Declaration}
-\BeginIndex{Variable}{fromname}%
+\BeginIndex{Option}{fromrule~=\PName{position}}%
\BeginIndex{Variable}{fromaddress}%
+\BeginIndex{Variable}{fromname}%
+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
+be used by the predefined letterheads.
+
+At\important{\OptionValue{fromrule}{aftername}} the extended letterhead an
+optional horizontal rule below the name may be selected using
+\OptionValue{fromrule}{aftername}.
+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
+pseudo-length \PLength{fromrulewidth}\IndexPLength[indexmain]{fromrulewidth}.
+
+\begin{table}
+ \caption[{Possible values of option \Option{fromrule} with
+ \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}
+ \begin{desctabular}
+ \entry{\PValue{afteraddress}, \PValue{below}, \PValue{on}, \PValue{true},
+ \PValue{yes}}{%
+ rule below the return address}%
+ \entry{\PValue{aftername}}{%
+ rule directly below the sender's name}%
+ \entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
+ no rule}%
+ \end{desctabular}
+\end{table}
+
+Default for the rule at the extended letterhead is \PValue{false}. But at the
+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})
+will not be used at the predefined letterheads
+
+\BeginIndex{FontElement}{fromaddress}%
+\BeginIndex{FontElement}{fromname}%
+\BeginIndex{FontElement}{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
+with element \FontElement{fromname}\IndexFontElement{fromname}%
+\important{\FontElement{fromname}} for the sender's name and with element
+\FontElement{fromrule}\IndexFontElement{fromrule}%
+\important{\FontElement{fromrule}} for the rule, that may be activated using
+option \Option{fromrule}. Nevertheless changing the font style of the rule
+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}%
+
+\begin{Example}
+ Let's now define the name of the sender at our letter example:
+ \lstinputcode[xleftmargin=1em]{letter-8.tex}
+ \begin{figure}
+ \centering
+ \frame{\includegraphics[width=.4\textwidth]{letter-8}}\quad
+ \frame{\includegraphics[width=.4\textwidth]{letter-9}}
+ \caption[{Example: letter with sender, addressee, opening, text, closing,
+ postscript, distribution list, and enclosure}]
+ {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}
+ \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
+ right side shows almost the same letter but with
+ \OptionValue{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
+ 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.
+
+ 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}.
+ \begin{figure}
+ \centering
+ \frame{\includegraphics[width=.4\textwidth]{letter-10}}\quad
+ \frame{\includegraphics[width=.4\textwidth]{letter-11}}
+ \caption[{Example: letter with sender, separation rule, addressee,
+ opening, text, closing, signature, postscript, distribution list,
+ enclosure, and puncher hole mark}]
+ {result of a small letter with sender, separation rule, addressee,
+ 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}
+ \end{figure}
+ In difference to this, the left letter has been set once again with the
+ standard letter head, that doesn't react on the additional option.
+\end{Example}
+
+An\textnote{Attention!} important note concerns the sender's address: within
+the sender's address, parts such as street, P.O.~Box, state, country, etc.,
+are separated with a double backslash. Depending on how the sender's address
+is used, this double backslash will be interpreted differently and therefore
+is not strictly always a line break. Paragraphs, vertical spacing and the like
+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.%
+%
+\EndIndex{Variable}{fromname}%
+\EndIndex{Variable}{fromaddress}%
+\EndIndex{Option}{fromrule~=\PName{position}}%
+
+
+\begin{Declaration}
+ \KOption{fromphone}\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{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{faxseparator}}%
+ \OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{emailseparator}}%
+ \OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{urlseparator}}%
+ \OParameter{description}\Parameter{content}%
+\end{Declaration}%
+\BeginIndex{Option}{fromphone~=\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}{fromfax}%
\BeginIndex{Variable}{fromemail}%
\BeginIndex{Variable}{fromurl}%
-\BeginIndex{Variable}{fromlogo}%
-%
-These variables give all information concerning the sender necessary
-to create the letterhead. Which variables will actually be used to
-finally build the letterhead can be chosen by use of the letterhead
-extensions (see option \Option{fromalign} in
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.fromalign}) and the options given
-there. The variables \Variable{fromname}, \Variable{fromaddress} and
-\Variable{fromlogo} will be set in the letterhead without their
-labels; the variables \Variable{fromphone}, \Variable{fromfax},
-\Variable{fromemail} and \Variable{fromurl} will be set with their
-labels. The labels are shown in \autoref{tab:scrlttr2.fromTerm},
-\autopageref{tab:scrlttr2.fromTerm}.
-%
+\BeginIndex{Variable}{emailseparator}%
+\BeginIndex{Variable}{faxseparator}%
+\BeginIndex{Variable}{phoneseparator}%
+\BeginIndex{Variable}{urlseparator}%
+Whether or not a telephone number\Index{telephone}\Index{phone}, a fax
+number\Index{fax}, an e-mail address\Index{e-mail}, or a sender's URL should
+be set as part of the letterhead may be configured by the options
+\Option{fromphone}, \Option{fromfax}, \Option{fromemail}, and
+\Option{fromurl}. Any standard value 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, that will be inserted between
+\PName{description} and \PName{content}, may be found in
+\autoref{tab:scrlttr2.fromSeparator}.
+
\begin{table}
\centering
- \caption{The sender's predefined labels for the letterhead}
+ \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}}
\begin{desctabular}[1.8em]
\ventry{fromemail}{\Macro{usekomavar*}\PParameter{emailseparator}%
\Macro{usekomavar}\PParameter{emailseparator}}%
- \ventry{fromfax}{\Macro{usekomavar*}\PParameter{faxseparator}
+ \ventry{fromfax}{\Macro{usekomavar*}\PParameter{faxseparator}%
\Macro{usekomavar}\PParameter{faxseparator}}%
- \ventry{fromname}{\Macro{headfromname}}
+ \ventry{fromname}{\Macro{headfromname}}%
\ventry{fromphone}{\Macro{usekomavar*}\PParameter{phoneseparator}%
\Macro{usekomavar}\PParameter{phoneseparator}}%
\ventry{fromurl}{\Macro{usekomavar*}\PParameter{urlseparator}%
\Macro{usekomavar}\PParameter{urlseparator}}%
\end{desctabular}
-\label{tab:scrlttr2.fromTerm}
+ \label{tab:scrlttr2.fromTerm}
\end{table}
-An important hint concerns the sender's address: within the sender's
-address, parts such as street, P.O.~Box, state, country, etc., are
-separated with a double backslash. Depending on how the sender's
-address is used, this double backslash will be interpreted differently
-and therefore is not strictly always a line break. Paragraphs,
-vertical spacing and the like 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
-\autoref{sec:scrlttr2.addressee},
-\autopageref{desc:scrlttr2.variable.backaddress}) and signature (see
-\autoref{sec:scrlttr2.closing},
-\autopageref{desc:scrlttr2.variable.signature}) oneself.
-
-It is possible, by the way, to load an external picture to use as a
-logo. For this purpose one can put as content of \Variable{fromlogo}
-an \Macro{includegraphics} command. Naturally, the corresponding
-package, that is, either \Package{graphics} or \Package{graphicx} (see
-\cite{package:graphics}), has to be loaded in the preamble of the
-letter document (see \autoref{sec:scrlttr2.document}).
-%
-\EndIndex{Variable}{fromname}%
-\EndIndex{Variable}{fromaddress}%
-\EndIndex{Variable}{fromphone}%
-\EndIndex{Variable}{fromfax}%
-\EndIndex{Variable}{fromemail}%
-\EndIndex{Variable}{fromurl}%
-\EndIndex{Variable}{fromlogo}%
-
-\begin{Declaration}
- \PLength{fromrulethickness}\\
- \PLength{fromrulewidth}
-\end{Declaration}
-\BeginIndex{PLength}{fromrulethickness}%
-\BeginIndex{PLength}{fromrulewidth}%
-Depending on the class option \Option{fromrule} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.fromrule}), a horizontal rule can be
-drawn the predefined letterheads under or within the sender
-address. If the pseudo-length \PLength{fromrulewidth} has a value of
-0\Unit{pt}, which is the default in the predefined \File{lco} files,
-the rule length is calculated automatically taking into account,
-e.\,g., letterhead width or an optional logo. Users can adjust rule
-length manually in their own \File{lco} files by setting this
-pseudo-length to positive values using \Macro{\@setplength} (see
-\autoref{sec:scrlttr2.pseudoLength},
-\autopageref{desc:scrlttr2.cmd.@setplength}). The default
-thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}},
-\PLength{fromrulethickness}, is 0.4\Unit{pt}.
-%
-\EndIndex{PLength}{fromrulethickness}%
-\EndIndex{PLength}{fromrulewidth}%
-
-\begin{Declaration}
- \Variable{phoneseparator}\\
- \Variable{faxseparator}\\
- \Variable{emailseparator}\\
- \Variable{urlseparator}
-\end{Declaration}
-\BeginIndex{Variable}{phoneseparator}%
-\BeginIndex{Variable}{faxseparator}%
-\BeginIndex{Variable}{emailseparator}%
-\BeginIndex{Variable}{urlseparator}%
-With these variables, hyphens are defined. If applicable, they are
-used in the sender's data in the letterhead (see
-\autoref{tab:scrlttr2.fromTerm}). As a feature, they are labeled and
-the labels also used in the sender's details of the letterhead. To
-look up the predefined labels and their contents, see
-\autoref{tab:scrlttr2.fromSeparator}.
-%
-% table moved in following paragraph (JUM) >>>
-%
-\EndIndex{Variable}{phoneseparator}%
-\EndIndex{Variable}{faxseparator}%
-\EndIndex{Variable}{emailseparator}%
-\EndIndex{Variable}{urlseparator}%
-
-
-\begin{Declaration}
- \Macro{firsthead}\Parameter{construction}
-\end{Declaration}
-\BeginIndex{Cmd}{firsthead}%
-For most 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
-situations one will have to do without predefined letterheads, which
-could have been chosen via options. Instead, one needs to create one's
-own letterhead from scratch. To do so, one has to define the preferred
-\PName{construction} with the command \Macro{firsthead}. Within
-\Macro{firsthead}, and with the help of the \Macro{parbox} command
-(see \cite{latex:usrguide}), one can set several boxes side by side,
-or one underneath the other. An advanced user will thus be able to
-create a letterhead on his own. Of course the \PName{construct} may
-use variables with the help of \Macro{usekomavar}.
-%
-% <<< table of previous paragraph
-\begin{table}
- \centering
- \caption{predefined labels and contents of hyphens for sender's data in the
- letterhead}
- \begin{tabular}{lll}
+\begin{table}[tp]
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}{Predefined description and content of the separators
+ at the letterhead}
+ [l]
+ \begin{tabular}[t]{lll}
\toprule
- name & label & content \\
+ variable name & description & content \\
\midrule
\Variable{emailseparator} & \Macro{emailname} & \texttt{:\~} \\
\Variable{faxseparator} & \Macro{faxname} & \texttt{:\~} \\
@@ -2377,571 +1478,663 @@ use variables with the help of \Macro{usekomavar}.
\Variable{urlseparator} & \Macro{wwwname} & \texttt{:\~} \\
\bottomrule
\end{tabular}
+ \end{captionbeside}
\label{tab:scrlttr2.fromSeparator}
\end{table}
-%
-\EndIndex{Cmd}{firsthead}%
-%
-\EndIndex{}{letter>head}%
-
-\subsection{The Letterfoot}
-\label{sec:scrlttr2.firstFoot}
-\BeginIndex{}{letter>footer}%
-
-As the first page holds a letterhead of its own, it also holds a
-footer of its own. And, as with the letterhead, it will not be set by
-the page style settings, but directly with the use of \Macro{opening}.
-
-\begin{Declaration}
- \PLength{firstfootvpos}
-\end{Declaration}
-\BeginIndex{PLength}{firstfootvpos}%
-%
-This pseudo-length gives the distance between the letterfoot and the
-upper edge of the paper. This value is set differently in the various
-predefined \File{lco} files. It also takes care of preventing text
-from jutting into the footer area. If needed, it can help to shorten
-the text height on the first page using \Macro{enlargethispage}.
-Likewise, and if it is needed, the text height can conversely be
-extended with the help of the option \Option{enlargefirstpage}. This
-way, the distance between text area and the first letterfoot can be
-reduced to the value \Length{footskip}. See also
-\autoref{sec:scrlttr2.typeareaOptions},
-\autopageref{desc:scrlttr2.option.enlargefirstpage}.
-
-With the compatibility option set\ChangedAt{2.9t}{\Class{scrlttr2}} up
-to version 2.9t (see \Option{version} in
-\autoref{sec:scrlttr2.compatibilityOptions},
-\autopageref{desc:scrlttr2.option.version}) the footer is set
-independently of the type area in all predefined \File{lco} files (see
-\autoref{sec:scrlttr2.lcoFile}) except for \Option{KOMAold}. The
-option \Option{enlargefirstpage} also loses its effect. From version
-2.9u onwards the footer is set in a position at the bottom edge of the
-paper. In this situation, the height of the type area also becomes
-dependent on \Option{enlargefirstpage}.
-
-If the letterfoot be switched off using option
-\Option{firstfoot}\IndexOption{firstfoot}\ChangedAt{v2.97e}{\Class{scrlttr2}}
-(siehe \autoref{sec:scrlttr2.footoptions},
-\autopageref{desc:scrlttr2.option.firstfoot}), then the setting of
-\PLength{firstfootvpos} is ignored, and instead
-\Length{paperheight}\IndexLength{paperheight} is applied. Thus, there
-remains a mimimum bottom margin of length
-\Length{footskip}\IndexLength{footskip}.
-%
-\EndIndex{PLength}{firstfootvpos}%
-
-\begin{Declaration}
- \PLength{firstfootwidth}
-\end{Declaration}
-\BeginIndex{PLength}{firstfootwidth}%
-This pseudo-length gives the width of the letter's first page
-footer. The value is set equal to that of the pseudo-length
-\PLength{firstheadwidth} in the predefined \File{lco} files.
-%
-\EndIndex{PLength}{firstfootwidth}%
-
-
-\begin{Declaration}
- \Macro{firstfoot}\Parameter{construction}
-\end{Declaration}
-\BeginIndex{Cmd}{firstfoot}%
-The first page's footer is preset to empty. However, with the
-\Macro{firstfoot} command, it is possible to create a
-\PName{construction} the same way as when defining the letterhead with
-\Macro{firsthead}.
\begin{Example}
- In the first page's footer, you may want to set the content of the
- variable \Variable{frombank} (the bank account). The double
- backslash should be exchanged with a comma at the same time:
- \begin{lstlisting}
- \firstfoot{%
- \parbox[b]{\linewidth}{%
- \centering\def\\{, }\usekomavar{frombank}%
- }%
- }
- \end{lstlisting}
- For the hyphen you might define a variable of your own if you like.
- This is left as an exercise for the reader.
-
- Nowadays it has become very common to create a proper footer in
- order to obtain some balance with respect to the letterhead. This
- can be done as follows:
- \begin{lstlisting}
- \firstfoot{%
- \parbox[t]{\textwidth}{\footnotesize
- \begin{tabular}[t]{l@{}}%
- \multicolumn{1}{@{}l@{}}{Partners:}\\
- Jim Smith\\
- Russ Mayer
- \end{tabular}%
- \hfill
- \begin{tabular}[t]{l@{}}%
- \multicolumn{1}{@{}l@{}}{Manager:}\\
- Jane Fonda\\[1ex]
- \multicolumn{1}{@{}l@{}}{Court Of Jurisdiction:}\\
- Great Plains
- \end{tabular}%
- \ifkomavarempty{frombank}{}{%
- \hfill
- \begin{tabular}[t]{l@{}}%
- \multicolumn{1}{@{}l@{}}{\usekomavar*{frombank}:}\\
- \usekomavar{frombank}
- \end{tabular}%
- }%
- }%
- }
- \end{lstlisting}
- This example, by the way, came from Torsten Kr\"uger. With
- \begin{lstlisting}
- \setkomavar{frombank}{Account No. 12\,345\,678\\
- at Citibank\\
- bank code no: 876\,543\,21}
- \end{lstlisting}
- the bank account can be set accordingly. If the footer will have
- such a large height then it might happen that you have to shift its
- position. You can do this with the pseudo-length
- \PLength{firstfootvpos}\IndexPLength{firstfootvpos}, which is
- described above in this section.
+ Mr Public from the example letter has telephone and e-mail. He wants to show
+ this also in the letterhead. Furthermore the separation rule should be
+ placed below the letterhead. So he uses the corresponding options and
+ 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
+ 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, like done at the right letter of
+ \autoref{fig:scrlttr2.letter-12-13}.
+ \begin{figure}
+ \centering
+ \frame{\includegraphics[width=.4\textwidth]{letter-12}}\quad
+ \frame{\includegraphics[width=.4\textwidth]{letter-13}}
+ \caption[{Example: letter with extended sender, separation rule, addressee,
+ opening, text, closing, signature, postscript, distribution list,
+ enclosure, and puncher hole mark; standard vs. extended letterhead}]
+ {result of a small letter with sender, separation rule, addressee,
+ 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}
+ \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}.
+ \begin{figure}
+ \centering
+ \frame{\includegraphics[width=.4\textwidth]{letter-14}}\quad
+ \frame{\includegraphics[width=.4\textwidth]{letter-15}}
+ \caption[{Example: letter with extended sender, separation rule, addressee,
+ opening, text, closing, signature, postscript, distribution list,
+ enclosure, and puncher hole mark; left vs. right aligned letterhead}]
+ {result of a small letter with sender, separation rule, addressee,
+ 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}
+ \end{figure}
\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 suffice. In that case, you may need to reduce
-\PLength{firstfootvpos} (see
-\autopageref{desc:scrlttr2.plength.firstfootvpos}) appropriately.
-%
-\EndIndex{Cmd}{firstfoot}%
%
-\EndIndex{}{letter>footer}%
-
-\subsection{The Address}
-\label{sec:scrlttr2.addressee}
-\BeginIndex{}{address}%
-
-The term address here refers to the addressee's name and address which
-are output in an address field. Additional information can be output
-within this address field, such as dispatch type or a return address;
-the latter is especially useful when using window envelopes. The
-address directly follows the letterhead.
-
-\begin{Declaration}
- \PLength{toaddrvpos}\\
- \PLength{toaddrhpos}
-\end{Declaration}
-\BeginIndex{PLength}{toaddrvpos}%
-\BeginIndex{PLength}{toaddrhpos}%
-These pseudo-lengths define vertical and horizontal position of the
-address field relative to the top-left corner of the paper. Values are
-set differently in the various predefined \File{lco} files, according
-to standard envelope window measures. A special feature of
-\PLength{toaddrhpos} is that with negative values the offset is that
-of the right edge of the address field relative to the right edge of
-the paper. This can be found, for instance, in the case of
-\Option{SN}. The smallest value of \PLength{toaddrvpos} is found with
-\Option{DINmtext}. Care must be taken to avoid overlap of letterhead
-and address field. Whether the address field is output or not can be
-controlled by class option \Option{addrfield} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.addrfield}).
-%
-\EndIndex{PLength}{toaddrhpos}%
-\EndIndex{PLength}{toaddrvpos}%
+\EndIndex{Variable}{urlseparator}%
+\EndIndex{Variable}{phoneseparator}%
+\EndIndex{Variable}{faxseparator}%
+\EndIndex{Variable}{emailseparator}%
+\EndIndex{Variable}{fromurl}
+\EndIndex{Variable}{fromemail}
+\EndIndex{Variable}{fromfax}
+\EndIndex{Variable}{fromphone}%
+\EndIndex{Option}{fromurl~=\PName{simple switch}}%
+\EndIndex{Option}{fromemail~=\PName{simple switch}}%
+\EndIndex{Option}{fromfax~=\PName{simple switch}}%
+\EndIndex{Option}{fromphone~=\PName{simple switch}}%
\begin{Declaration}
- \PLength{toaddrheight}
-\end{Declaration}
-\BeginIndex{PLength}{toaddrheight}%
-The pseudo-length \PLength{toaddrheight} defines the height of the
-address field, including the dispatch type. If no dispatch type is
-specified, then the address is vertically centered in the field. If a
-dispatch type is specified, then the address is set below the dispatch
-type, and vertically centered in the remaining field height.
-%
-\EndIndex{PLength}{toaddrheight}%
-
-\begin{Declaration}
- \PLength{toaddrwidth}
+ \KOption{fromlogo}\PName{simple switch}\\
+ \Macro{setkomavar}\PParameter{\Variable{fromlogo}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
-\BeginIndex{PLength}{toaddrwidth}%
-The pseudo-length \PLength{toaddrwidth} defines the width of the
-address field. Values are set differently in the various predefined
-\File{lco} files, according to standard envelope window
-measures. Typical values are between 70\Unit{mm} and 100\Unit{mm}.
+\BeginIndex{Option}{fromlogo~=\PName{simple switch}}%
+\BeginIndex{Variable}{fromlogo}%
+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},
+\autopageref{tab:truefalseswitch}. Default is \PValue{false}, that means no
+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{} won't use it anywhere at the predefined note papers (see
+also \autoref{tab:scrlttr2.fromTerm}).%
\begin{Example}
- Assume that your printer has a very wide left or right margin of
- 15\Unit{mm}. In this case, when using the option \Option{SN}, the
- letterhead, sender's extensions and the address can not be
- completely printed. Thus, you create a new \File{lco} file with the
- following content:
- \begin{lstlisting}
- \ProvidesFile{SNmmarg.lco}
- [2002/06/04 v0.1 my own lco]
- \LoadLetterOption{SN}
- \@addtoplength{toaddrwidth}{%
- -\useplength{toaddrhpos}}
- \@setplength{toaddrhpos}{-15mm}
- \@addtoplength{toaddrwidth}{%
- \useplength{toaddrhpos}}
- \endinput
- \end{lstlisting}
- Then, until you can obtain a printer with smaller page margins, you
- simply use the option \Option{SNmmarg} instead of \Option{SN}.
-\end{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
+ \Macro{includegraphics}. Therefor he uses the additional package
+ \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
+ figure shows the result with right aligned or centered sender.
+ \begin{figure}
+ \setcapindent{0pt}%
+ {\hfill
+ \frame{\includegraphics[width=.4\textwidth]{letter-16}}\quad
+ \frame{\includegraphics[width=.4\textwidth]{letter-17}}\par\bigskip}
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ separation rule, addressee, opening, text, closing, signature,
+ postscript, distribution list, enclosure, and puncher hole mark; left
+ vs. right aligned vs. centered sender}]
+ {result of a small letter with extended sender, logo, separation rule,
+ addressee, opening, text, closing, signature, postscript, distribution
+ list, enclosure and puncher hole mark (the date is a default of
+ DIN-letters): at top left one left aligned sender using, at right
+ beneath one with centered sender, and at right one right aligned
+ sender}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-18}}\quad
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-16-18}
+ \end{figure}
+\end{Example}%
%
-\EndIndex{PLength}{toaddrwidth}%
-
+\EndIndex{Variable}{fromlogo}%
+\EndIndex{Option}{fromlogo~=\PName{smart value}}%
\begin{Declaration}
- \PLength{toaddrindent}
+ \Macro{setkomavar}\PParameter{\Variable{firsthead}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
-\BeginIndex{PLength}{toaddrindent}%
-Additional indentation of the address within address field can be
-controlled by the pseudo-length \PLength{toaddrindent}. Its value
-applies to both left and right margin. Default value is 0\Unit{pt}.
-%
-\EndIndex{PLength}{toaddrindent}%
-
+\BeginIndex{Variable}{firsthead}%
+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
+situations one will have to do without predefined letterheads, which
+could have been chosen via options. Instead, one needs to create one's
+own letterhead from scratch. To do so, one has to define the preferred
+construction as content of variable \Variable{firsthead}. Within
+\Macro{firsthead}, and with the help of the \Macro{parbox} command
+(see \cite{latex:usrguide}), one can set several boxes side by side,
+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{} doesn't 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}.}
-\begin{Declaration}
- \Variable{backaddress}\\
- \Variable{backaddressseparator}\\
- \PLength{backaddrheight}
-\end{Declaration}
-\BeginIndex{Variable}{backaddress}\BeginIndex{Variable}{backaddressseparator}%
-\BeginIndex{PLength}{backaddrheight}%
-When using window envelopes, the sender's return address is often
-included within the window, placed at the top above the addressee and
-dispatch type information, separated by a horizontal rule and set in a
-smaller font size. The contents of the return address, stored in the
-variable \Variable{backaddress}, are usually built automatically from
-the variables \Variable{fromname} and \Variable{fromaddress}. Within
-the return address, double backslashes are replaced by the content of
-the variable \Variable{backaddressseparator}, whose default value is a
-comma followed by a non-breaking space.
-
-The height reserved for the return address within the address field is
-defined by the pseudo-length \PLength{backaddrheight}. In the
-predefined \File{lco} files, this is typically set to
-5\Unit{mm}. Whether the return address is output or not is controlled
-by document class options \Option{addrfield} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.addrfield}) and \Option{backaddress
-} (see \autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.backaddress}).
+The\textnote{Attention!} command
+\Macro{firsthead}\IndexCmd[indexmain]{firsthead} exists only for reason of
+compatibility to former \Class{scrlttr2} versions. However it is deprecated
+and you should not use it anymore.%
%
-\EndIndex{PLength}{backaddrheight}%
-\EndIndex{Variable}{backaddress}\EndIndex{Variable}{backaddressseparator}%
-
-
-\begin{Declaration}
- \Variable{specialmail}\\
- \PLength{specialmailindent}\\
- \PLength{specialmailrightindent}
-\end{Declaration}
-\BeginIndex{Variable}{specialmail}%
-\BeginIndex{PLength}{specialmailindent}%
-\BeginIndex{PLength}{specialmailrightindent}%
-An optional dispatch type can be output within the address field
-between the return address and the addressee address, by setting the
-variable \Variable{specialmail}. Left and right alignment are
-determined by pseudo-lengths \PLength{specialmailindent} and
-\PLength{specialmailrightindent}, respectively. In the predefined
-\File{lco} files provided by \KOMAScript, \PLength{specialmailindent}
-is set to rubber length \Macro{fill}, while
-\PLength{specialmailrightindent} is set to 1\Unit{em}. Thus the
-dispatch type is set 1\Unit{em} from the address field's right margin.
+\EndIndex{Variable}{firsthead}%
%
-\EndIndex{PLength}{specialmailindent}%
-\EndIndex{PLength}{specialmailrightindent}%
-\EndIndex{Variable}{specialmail}%
-
-
-\begin{Declaration}
- \Variable{toname}\\
- \Variable{toaddress}
-\end{Declaration}
+\EndIndex{}{letter>head}%
+\EndIndex{}{letterhead}%
+
+\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}
+\end{Declaration}%
+\BeginIndex{}{Anschrift}%
+\BeginIndex{Option}{addrfield~=\PName{mode}}%
\BeginIndex{Variable}{toname}%
\BeginIndex{Variable}{toaddress}%
-These two variables contain the addressee's name and address as output
-in the address field. Usually you will not access these variables
-directly, but their values are taken from the argument to the
-\Environment{letter} environment\IndexEnv{letter}. Please see the
-important hint on address formatting given in
-\autoref{sec:scrlttr2.firstHead},
-\autopageref{desc:scrlttr2.variable.fromname}.
-%
-\EndIndex{Variable}{toname}%
-\EndIndex{Variable}{toaddress}%
-
-
-\begin{Declaration}
- \Environment{letter}\OParameter{options}\Parameter{addressee}
-\end{Declaration}
-\BeginIndex{Env}{letter}%
-The \Environment{letter} environment is only one of the key
-environments of the letter class. A special \Class{scrlttr2} feature
-are optional arguments to the \Environment{letter} environment. These
-\PName{options} are executed internally via the \Macro{KOMAoptions}
-command.
-
-The \PName{addressee} is a mandatory argument passed to the
-\Environment{letter} environment. Parts of the addressee contents are
-separated by double backslashes. The first part of \PName{addressee}
-is stored in variable \Variable{toname}, while the rest is stored in
-variable \Variable{toaddress} for further use. These parts are output
-on individual lines in the address field. Nevertheless, the double
-backslash should not be interpreted as a certain line break. Vertical
-material such as paragraphs or vertical space is not permitted within
-\PName{addressee}, and could lead to unexpected results and error
-messages, as is the case also for the standard letter class.
-
-The \Environment{letter} environment does not actually start the
-letter output. This is done by the \Macro{opening} command.
-%
-\EndIndex{Env}{letter}%
-
+\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}%
+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
+is \PValue{true}. With values \PValue{true}, \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
+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
+exist. First of all element
+\FontElement{addressee}\important{\FontElement{addressee}}, that is
+responsible for the addressee overall. The additional elements
+\FontElement{toname}\important{\FontElement{toname}} and
+\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}%
-\begin{Declaration}
- \Macro{AtBeginLetter}\Parameter{commands}
-\end{Declaration}
-\BeginIndex{Cmd}{AtBeginLetter}%
-{\LaTeX} enables the user to declare \PName{commands} whose execution
-is delayed until a determined point. Such points are called
-\emph{hooks}. Known macros for using hooks are \Macro{AtBeginDocument}
-and \Macro{AtEndOfClass}. The letter class \Class{scrlttr2} provides
-an additional hook that can be used via the macro
-\Macro{AtBeginLetter}. Originally, hooks were provided for package
-and class authors, so they are documented in \cite{latex:clsguide}
-only, and not in \cite{latex:usrguide}. However, with letters there
-are useful applications of \Macro{AtBeginLetter} as the following
-example may illustrate:
-%
-\begin{Example}
- It is given that one has to set multiple letters with questionnaires
- within one document. Questions are numbered automatically within
- single letters using a counter. Since, in contrast to page
- numbering, that counter is not known by \Class{scrlttr2}, it would
- not be reset at the start of each new letter. Given that each
- questionnaire contains ten questions, question~1 would get number~11
- in the second letter. A solution is to reset this counter at the
- beginning of each new letter:
-\begin{lstlisting}
- \newcounter{Question}
- \newcommand{\Question}[1]{%
- \refstepcounter{Question}\par
- \@hangfrom{\makebox[2em][r]{\theQuestion:~}}{#1}}
- \AtBeginLetter{\setcounter{Question}{0}}
-\end{lstlisting}
-This way question~1 remains question~1, even in the 1001st letter. Of
-course definitions like those mentioned above need to be stated either
-between macros \Macro{makeatletter} and \Macro{makeatother} (see
-\cite{DANTE:FAQ}) in letter declarations (see
-\autoref{sec:scrlttr2.document} and \autoref{fig:scrlttr2.document},
-\autopageref{fig:scrlttr2.document}), in a unique package, or in an
-\File{lco} file (see \autoref{sec:scrlttr2.lcoFile}).
-\end{Example}
-%
-\EndIndex{Cmd}{AtBeginLetter}%
-%
-\EndIndex{}{address}%
+\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}%
+ \begin{desctabular}
+ \entry{\PValue{true}, \PValue{on}, \PValue{yes}}{%
+ Prints an address field including a return address and a mode of dispatch
+ or priority.}%
+ \entry{\PValue{false}, \PValue{off}, \PValue{no}}{%
+ Omits the address field.}%
+ \entry{\PValue{PP}, \PValue{pp}, \PValue{PPexplicite},
+ \PValue{PPExplicite}, \PValue{ppexplicite}, \PValue{ppExplicite}}{%
+ Prints an address field with Port-Pay\'e head, defined by the variables
+ \Variable{fromzipcode}, \Variable{place}, and \Variable{PPcode} and when
+ indicated with priority and data array defined by
+ \Variable{PPdatamatrix} but without return address and mode of
+ dispatch.}%
+ \entry{\PValue{backgroundimage}, \PValue{PPbackgroundimage},
+ \PValue{PPBackgroundImage}, \PValue{PPBackGroundImage},
+ \PValue{ppbackgroundimage}, \PValue{ppBackgroundImage},
+ \PValue{ppBackGroundImage}}{%
+ Prints an address field with Port-Pay\'e head, in variable
+ \Variable{addresseimage} defined background graphics, but without return
+ address or mode of dispatch.}%
+ \entry{\PValue{image}, \PValue{Image}, \PValue{PPimage}, \PValue{PPImage},
+ \PValue{ppimage}, \PValue{ppImage}}{%
+ Prints variable \Variable{addresseeimage} as addressee with Port-Pay\'e,
+ but ignores addressee information and definitions for return address,
+ mode of dispatch or priority.}%
+ \end{desctabular}
+\end{table}%
+
+With the default \OptionValue{addrfield}{true} an additional return address
+will be printed. Option \Option{backaddress} defines whether a return address
+for window envelopes will be set. This
+option\important{\OptionValue{backaddress}{false}} can take the standard
+values for simple switches, as listed in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. These values don't change style of the
+return address. On the other hand,
+additionally\ChangedAt{v2.96}{\Class{scrlttr2}} to switching on the return
+address, the style of the return address may be selected. Option value
+\PValue{underlined} selects an underlined return address. In opposite to
+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}%
+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
+\PName{content} of variable \Variable{backaddressseparator}. The predefined
+separator \PName{content} is a comma followed by a non-breakable white
+space. The \PName{description} of variable \Variable{backaddress} isn't used
+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
+font style \KOMAScript{} switches to \Macro{scriptsize}.%
+\EndIndex{FontElement}{backaddress}%
+%
+\EndIndex{Variable}{backaddressseparator}%
+\EndIndex{Variable}{backaddress}%
+\EndIndex{Option}{backaddress~=\PName{value}}%
+\EndIndex{Variable}{toaddress}%
+\EndIndex{Variable}{toname}%
-\subsection{The Sender's Extensions}
-\label{sec:scrlttr2.locationField}
-\BeginIndex{}{sender's extension}
+\begin{table}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}{%
+ Predefined font style for the elements of the address field.%
+ }%
+ [l]
+ \begin{tabular}[t]{ll}
+ \toprule
+ element & font style \\
+ \midrule
+ \FontElement{addressee}\IndexFontElement{addressee} &
+ \\
+ \FontElement{backaddress}\IndexFontElement{backaddress} &
+ \Macro{sffamily}%
+ \\
+ \FontElement{PPdata}\IndexFontElement{PPdata} &
+ \Macro{sffamily}%
+ \\
+ \FontElement{PPlogo}\IndexFontElement{PPlogo} &
+ \Macro{sffamily}\Macro{bfseries}%
+ \\
+ \FontElement{priority}\IndexFontElement{priority} &
+ \Macro{fontsize}\PParameter{10pt}\PParameter{10pt}%
+ \Macro{sffamily}\Macro{bfseries}%
+ \\
+ \FontElement{prioritykey}\IndexFontElement{prioritykey} &
+ \Macro{fontsize}\PParameter{24.88pt}\PParameter{24.88pt}%
+ \Macro{selectfont}%
+ \\
+ \FontElement{specialmail}\IndexFontElement{specialmail} &
+ \\
+ \FontElement{toaddress}\IndexFontElement{toaddress} &
+ \\
+ \FontElement{toname}\IndexFontElement{toname} &
+ \\
+ \bottomrule
+ \end{tabular}
+ \end{captionbeside}
+ \label{tab:scrlttr2.AddresseeElements}%
+\end{table}
-Often, especially with business letters, the space for the letterhead
-or page footer seems to be too tight to include all you want. To give
-more details about the sender, often the space right beside the
-addressee's field is used. In this manual this field is called the
-\emph{sender's extension}
+\BeginIndex{FontElement}{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
+be done only if variable \Variable{specialmail} is not empty and
+\OptionValue{priority}{manual}\ChangedAt{v3.03}{\Class{scrlttr2}} has been
+selected, which is also the default. Class \Class{scrlttr2} itself doesn't 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
+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}).%
+\EndIndex{FontElement}{specialmail}%
+
+\BeginIndex{FontElement}{priority}%
+\BeginIndex{FontElement}{prioritykey}%
+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
+\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}%
+\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}
+ \begin{desctabular}
+ \entry{\PValue{false}, \PValue{off}, \PValue{no}, \PValue{manual}}{%
+ Priority will not be printed.}%
+ \entry{\PValue{B}, \PValue{b}, \PValue{economy}, \PValue{Economy},
+ \PValue{ECONOMY}, \PValue{B-ECONOMY}, \PValue{B-Economy},
+ \PValue{b-economy}}{%
+ Use international priority B-Economy. With
+ \OptionValue{addrfield}{true} this will be printed instead of the mode
+ of dispatch.}%
+ \entry{\PValue{A}, \PValue{a}, \PValue{priority}, \PValue{Priority},
+ \PValue{PRIORITY}, \PValue{A-PRIORITY}, \PValue{A-Priority},
+ \PValue{a-priority}}{%
+ Use international priority A-Priority. With
+ \OptionValue{addrfield}{true} this will be printed instead of the mode
+ of dispatch.}%
+ \end{desctabular}
+\end{table}
-\begin{Declaration}
- \PLength{locheight}\\
- \PLength{lochpos}\\
- \PLength{locvpos}\\
- \PLength{locwidth}
-\end{Declaration}
-\BeginIndex{PLength}{locwidth}%
-\BeginIndex{PLength}{locheight}%
-\BeginIndex{PLength}{lochpos}%
-\BeginIndex{PLength}{locvpos}%
-The pseudo-lengths \PLength{locwidth} and
-\PLength{locheight}\ChangedAt{v2.97d}{\Class{scrlttr2}} set the width
-and height of the sender's extension field. The pseudo-lengths
-\PLength{lochpos} and \PLength{locvpos} determine the distances from
-the right and upper paper edges. These value is typically set to
-0\Unit{pt} in the predefined \File{lco} files. This does not mean that
-the sender's extension has no width; instead, it means that the actual
-width is set with \Macro{opening} when the paper width, address window
-width, and the distance between the left and upper edges of the paper
-and the address window are known. The option \Option{locfield} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.locfield}) is also taken into
-account. As is the case for \PLength{toaddrhpos}, negative values of
-\PLength{lochpos} take on a special meaning. In that case, instead of
-referring to a distance from the right edge of the paper,
-\PLength{lochpos} now means a distance from the left edge of the
-paper. The meaning is thus the opposite to that of
-\PLength{toaddrhpos} (see \autoref{sec:scrlttr2.addressee},
-\autopageref{desc:scrlttr2.plength.toaddrhpos}).
+With\ChangedAt{v3.03}{\Class{scrlttr2}}\important{\OptionValue{addrfield}{PP}}
+\OptionValue{addrfield}{PP} also the zip-code of
+variable \Variable{fromzipcode} and the place from \PName{content} of variable
+\Variable{place} will be set in the Port-Pay\'e head. Thereby the
+\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
+the \PName{content} of variable \Variable{zipcodeseparator} is a small
+distance followed by an endash followed by one more small distance
+(\Macro{,}\texttt{-{}-}\Macro{,}).
+
+Beyond\ChangedAt{v3.03}{\Class{scrlttr2}} that, with
+\OptionValue{addrfield}{PP}\important{\OptionValue{addrfield}{PP}} and
+sender's identification code will be used at the Port-Pay\'e head. This is the
+\PName{content} of variable \Variable{PPcode}. Right beside the address of the
+addressee an additional data array may be printed. The \PName{content} of
+variable \Variable{PPdatamatrix} will be used for this.
+
+\BeginIndex{FontElement}{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}).%
+\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\\
+ \strut\OptionValue{addrfield}{image}} options
+\OptionValue{addrfield}{backgroundimage}\ChangedAt{v3.03}{\Class{scrlttr2}}
+or \OptionValue{addrfield}{image} a picture will be print inside the address
+field. The \PName{content} of variable \Variable{addresseeimage} will be used
+for this. \KOMAScript{} doesn't 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 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
+\PLength{PPheadwidth} and \PLength{PPheadheight} (siehe
+\autopageref{desc:scrlttr2-experts.plength.PPheadheight}). The alignment of
+the data array is defined by pseudo-length \PLength{PPdatamatrixvskip}
+(see \autopageref{desc: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
+into variables like \Variable{addresseeimage} or \Variable{PPdatamatrix}, you
+have to use an additional graphics package like
+\Package{graphics}\IndexPackage{graphics} or
+\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}
+
+
+\begin{Declaration}
+ \KOption{locfield}\PName{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}\\
+ \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,
+then the \Option{locfield} option can toggle between two presets for
+the field width. See the explanation on the \Variable{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
+\PValue{narrow}.%
%
-\EndIndex{PLength}{locwidth}
-\EndIndex{PLength}{locheight}%
-\EndIndex{PLength}{lochpos}%
-\EndIndex{PLength}{locvpos}%
-
+\begin{table}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}
+ [{Possible values of option \Option{locfield} with
+ \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}}%
+ [l]
+ \begin{minipage}[t]{.45\linewidth}
+ \begin{desctabular}[t]
+ \pventry{narrow}{narrow sender supplement field}%
+ \pventry{wide}{wide sender supplement field}%
+ \end{desctabular}
+ \end{minipage}
+ \end{captionbeside}
+\end{table}
\begin{Declaration}
- \Variable{location}
+ \Macro{setkomavar}\PParameter{\Variable{location}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
\BeginIndex{Variable}{location}%
The contents of the sender's extension field is determined by the
-variable \Variable{location}. To set this variable's content, it is
-permitted to use formatting commands like \Macro{raggedright}. One has
-to consider that depending on the use of the options
-\Option{fromalign} and \Option{fromlogo}, a part of the space for the
-sender's extension may already be reserved for a logo or return
-address (see \autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.fromalign} and
-\autopageref{desc:scrlttr2.option.fromlogo}).
-%
+variable \Variable{location}. To set this variable's \PName{content}, it is
+permitted to use formatting commands like \Macro{raggedright}. \KOMAScript{}
+doesn't use the \PName{description} of the variable.
+
\begin{Example}
- Assume that you would like to put the names of your partners,
- manager, or court of jurisdiction in the sender's extension
- field. You can do this as follows:
-\begin{lstlisting}
- \KOMAoptions{locfield=wide}
- \setkomavar{location}{\raggedright
- \textbf{Partners:}\\
- \quad Hugo Mayer\\
- \quad Bernd Miller\\[1ex]
- \textbf{Manager:}\\
- \quad Liselotte Mayer\\[1ex]
- \textbf{Court of jurisdiction:}\\
- \quad Washington, DC
- }
-\end{lstlisting}
-The option \Option{locfield=wide} is set to make the details fit
-horizontally. Sender details like those mentioned in the above example
-can be written, together with the common sender address details, into
-your own \File{lco} file.
+ Mr Public likes to show some additional information about his
+ 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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ addressee, additional sender information, opening,
+ text, closing, signature, postscript, distribution list, enclosure,
+ and puncher hole mark}]
+ {result of a small letter with extended sender, logo,
+ addressee, additional sender information, opening, text, closing,
+ signature, postscript, distribution list, enclosure and puncher hole
+ mark (the date is a default of DIN-letters)}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-19}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-19}
+ \end{figure}
\end{Example}
%
\EndIndex{Variable}{location}%
-\EndIndex{}{sender's extension}%
-
-
-\subsection{The Reference Fields Line}
-\label{sec:scrlttr2.refLine}
-\BeginIndex{}{reference fields line}%
-
-Especially with business letters, a line can be found that gives
-initials, dial code, customer number, invoice number, or a reference
-to a previous letter. In this manual this line is called the
-\emph{reference fields line}. The reference fields line can consist of
-more than just one line and is set only if one of those variables
-mentioned above is given. Only those fields will be set that are
-given. To set a seemingly empty field, one needs to give as value at
-least a white space or \Macro{null}. If you want to have your letter
-without a reference fields line, then instead of it the label and
-contents of the variable \Variable{date} will be set.
+%
+\EndIndex{Option}{locfield~=\PName{selection}}%
+%
+\EndIndex{}{sender>additional information}%
\begin{Declaration}
- \PLength{refvpos}
+ \KOption{numericaldate}\PName{simple switch}
\end{Declaration}
-\BeginIndex{PLength}{refvpos}%
-This pseudo-length gives the distance between the upper edge of the
-paper and the reference fields line. Its value is set differently in
-the various predefined \File{lco} files. Typical values are between
-80.5\Unit{mm} and 98.5\Unit{mm}.
-%
-\EndIndex{PLength}{refvpos}%
-
+\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.
\begin{Declaration}
- \PLength{refwidth}\\
- \PLength{refhpos}
+ \Macro{setkomavar}\PParameter{\Variable{date}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
-\BeginIndex{PLength}{refwidth}%
-This pseudo-length gives the width that is available for the reference
-fields line. The value is set typically to 0\Unit{pt} in the
-predefined \File{lco} files. This value has a special meaning: in no
-way does it determine that there is no available width for the
-business line; instead, this value means that the width will be
-calculated with the \Macro{opening}. Thus the calculated width depends
-on the determination of the options \Option{refline} (see
-\autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.refline}). At the same time,
-\PLength{refhpos} will be set according to this option. With
-\Option{refline=}\PValue{wide}, the reference fields line is centered,
-while with \Option{refline=}\PValue{narrow} it is aligned on the left.
-
-If \PLength{refwidth} non-null, i.\,e., the width of the reference
-fields line is therefore not determined by the option
-\Option{refline}, then \PLength{refhpos} gives the distance of the
-reference fields line from the left edge of the paper. If this
-distance is null, then the reference fields line is set so that the
-ratio between its distances from the left and right edges of the paper
-equal the ratio of distance of the type area from the left and right
-edges of the paper. Thus, for a type area horizontally centered on the
-paper, the reference fields line too will be centered.
-
-As a rule, these special cases are likely to be of little interest to
-the normal user. The simplest rule is as follows: either
-\PLength{refhpos} is left at null and so the width and alignment of
-the reference fields line are left to the option \Option{refline}, or
-\PLength{refwidth} as well as \PLength{refhpos} are set by the user.
+\BeginIndex{Variable}{date}%
+The date in the selected presentation will become the \PName{content} of
+variable \Variable{date}. The selection of option \Option{numericaldate}
+doesn't 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. This is the case even if all other elements of the reference line will
+be empty and therefore unused. For more information about the automatic
+printing of the date may be found in following description of option
+\Option{refline}.%
%
-\EndIndex{PLength}{refwidth}%
-\EndIndex{PLength}{refhpos}%
+\EndIndex{Variable}{date}%
+\EndIndex{Option}{numericaldate~=\PName{switch}}%
\begin{Declaration}
- \PLength{refaftervskip}
+ \KOption{refline}\PName{selection}
\end{Declaration}
-\BeginIndex{PLength}{refaftervskip}%
-This pseudo-length gives the vertical space that has to be inserted
-beneath the reference fields line. The value is set in the predefined
-\File{lco} files. It directly affects the text height of the first
-page. A typical value lies between one and two lines.
+\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
+be named \emph{reference line}\textnote{reference line} in this manual.
+
+With the \Class{scrlttr2} class, the header, footer, address, and sender
+attributes may extend beyond the normal type area to the left and to the
+right. Option \Option{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}
+and \PValue{dateright}\ChangedAt{v3.09}{\Class{scrlttr2}}.%
%
-\EndIndex{PLength}{refaftervskip}%
+\begin{table}
+ \caption[{Possible value of option \Option{refline} with
+ \Class{scrlttr2}}]{Possible value of option \Option{refline} for setting
+ the width of the reference fields line with
+ \Class{scrlttr2}}
+ \label{tab:scrlttr2.refline}
+ \begin{desctabular}
+ \pventry{dateleft}{\ChangedAt{v3.09}{\Class{scrlttr2}}%
+ The date will be placed leftmost at the reference line.}%
+ \pventry{dateright}{\ChangedAt{v3.09}{\Class{scrlttr2}}%
+ The date will be placed rightmost at the reference line.}%
+ \pventry{narrow}{The reference line will be restricted to type
+ area.}%
+ \pventry{nodate}{\ChangedAt{v3.09}{\Class{scrlttr2}}%
+ The date won't be placed automatically into the reference line.}%
+ \pventry{wide}{The with of the reference line corresponds to address and
+ sender's additional information.}%
+ \end{desctabular}
+\end{table}
\begin{Declaration}
- \Variable{yourref}\\
- \Variable{yourmail}\\
- \Variable{myref}\\
- \Variable{customer}\\
- \Variable{invoice} \\
- \Variable{date}
+ \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}%
\end{Declaration}
\BeginIndex{Variable}{yourref}%
\BeginIndex{Variable}{yourmail}%
\BeginIndex{Variable}{myref}%
\BeginIndex{Variable}{customer}%
\BeginIndex{Variable}{invoice}%
-\BeginIndex{Variable}{date}%
-These variables are typical reference fields. Their meanings are given
-in \autoref{tab:scrlttr2.variables} on
-\autopageref{tab:scrlttr2.variables}. Each variable has also a
-predefined label, shown in \autoref{tab:scrlttr2.reflineTerm}. The
-field width that belongs to each variable, adjusts itself
-automatically to its label and content.
+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
+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.%
%
\begin{table}
- \centering
- \caption{predefined labels of typical variables of the reference
- fields line. The
- content of the macros depend on language.}
- \begin{tabular}{lll}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}[{predefined descriptions of variables of the reference
+ line}]{predefined descriptions of typical variables of the reference
+ fields line using macros depending on the current language}%
+ [l]
+ \begin{tabular}[t]{lll}
\toprule
- name & label & in english \\
+ variable name & description & e.\,g., in english \\
\midrule
\Variable{yourref} & \Macro{yourrefname} & Your reference \\
\Variable{yourmail} & \Macro{yourmailname} & Your letter from \\
@@ -2951,62 +2144,116 @@ automatically to its label and content.
\Variable{date} & \Macro{datename} & date \\
\bottomrule
\end{tabular}
+ \end{captionbeside}
\label{tab:scrlttr2.reflineTerm}
\end{table}
-%
-\EndIndex{Variable}{yourref}%
-\EndIndex{Variable}{yourmail}%
-\EndIndex{Variable}{myref}%
-\EndIndex{Variable}{customer}%
-\EndIndex{Variable}{invoice}%
-\EndIndex{Variable}{date}%
-%
-\begin{Declaration}
- \Variable{place}\\
- \Variable{placeseparator}
-\end{Declaration}
+\BeginIndex{FontElement}{refname}%
+\BeginIndex{FontElement}{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
+configuration of both elements is listed in
+\autoref{tab:scrlttr2.refnamerefvalue}.%
+\begin{table}[tp]
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \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}}
+ [l]
+ \begin{tabular}[t]{ll}
+ \toprule
+ element & default configuration \\
+ \midrule
+ \FontElement{refname} & \Macro{sffamily}\Macro{scriptsize} \\
+ \FontElement{refvalue} & \\
+ \bottomrule
+ \end{tabular}
+ \end{captionbeside}
+\end{table}%
+%
+\EndIndex{FontElement}{refvalue}%
+\EndIndex{FontElement}{refname}%
+
+
+\begin{Declaration}
+ \Macro{setkomavar}\PParameter{\Variable{place}}%
+ \OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{placeseparator}}%
+ \OParameter{description}\Parameter{content}
+\end{Declaration}%
\BeginIndex{Variable}{place}%
\BeginIndex{Variable}{placeseparator}%
-As said before in the introduction of this subsection, the reference
-fields line can be omitted. This happens if all variables of the
-business line are empty with the exception of the variable for the
-date. In this case, the content of \Variable{place} and
-\Variable{placeseparator} will be set, followed by the content of
-\Variable{date}. The predefined content of the
-\Variable{placeseparator} is a comma followed by a non-breaking
-space. If the variable \Variable{place} has no value then the hyphen
-remains unset also. The predefined content of \Variable{date} is
-\Macro{today} and depends on the setting of the option
-\Option{numericaldate} (see \autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.numericaldate}).
+If all variables of the reference line are empty, the line will be omitted.
+In this case, the \PName{content} of \Variable{place} and
+\Variable{placeseparator} will be set, followed by the \PName{content} of
+\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}).
+
+\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
+ 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.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ addressee, additional sender information, place, date, opening,
+ text, closing, signature, postscript, distribution list, enclosure,
+ and puncher hole mark}]
+ {result of a small letter with extended sender, logo, addressee,
+ additional sender information, place, date, opening, text, closing,
+ signature, postscript, distribution list, enclosure and puncher hole
+ mark}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-20}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.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}%
%
-\EndIndex{}{reference fields line}%
-
-
-\subsection{The Title and the Subject Line}
-\label{sec:scrlttr2.titleSubject}
-Business letters very often carry a subject line. The subject line
-indicates briefly the respect of the letter. Usually the subject
-should be short and precise and not run across several lines. Apart
-fom the subject, such a letter may also carry a title. Titles find
-usage most often with irregular letters such as a warning, an invoice
-or a reminder.
-
+\EndIndex{Option}{refline~=\PName{selection}}%
+\EndIndex{}{reference line}%
\begin{Declaration}
- \Variable{title}
+ \Macro{setkomavar}\PParameter{\Variable{title}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
+\BeginIndex{}{title}%
\BeginIndex{Variable}{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
-this element (\Macro{normalcolor}\Macro{sffamily}\Macro{bfseries}) can
-be changed with help of the interface described in
-\autoref{sec:maincls.font}. Font size declarations are allowed.
+\BeginIndex{FontElement}{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{title}\important{\FontElement{title}} can be changed with
+commands \Macro{setkomafont} und \Macro{addtokomafont} (see
+\autoref{sec:scrlttr2.textmarkup},
+\autopageref{desc:scrlttr2.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.
\begin{Example}
Assume that you are to write a reminder. Thus you put as title:
\begin{lstlisting}
@@ -3014,786 +2261,928 @@ be changed with help of the interface described in
\end{lstlisting}
This way the addressee will recognize a reminder as such.
\end{Example}
+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{FontElement}{title}%
+\EndIndex{Variable}{title}%
+\EndIndex{}{title}%
\begin{Declaration}
- \Variable{subject}\\
- \Variable{subjectseparator}
+ \KOption{subject}\PName{selection}\\
+ \Macro{setkomavar}\PParameter{\Variable{subject}}%
+ \OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{subjectseparator}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
+\BeginIndex{}{subject}%
+\BeginIndex{Option}{subject~=\PName{selection}}%
\BeginIndex{Variable}{subject}%
\BeginIndex{Variable}{subjectseparator}%
-In case a subject should be set, the contents of the variable
-\Variable{subject} need to be defined. Depending on what the option
-\Option{subject} is set to, a label can be placed in front of the
-subject contents; also, the vertical position of the subject contents
-can be changed (see \autoref{sec:scrlttr2.headoptions},
-\autopageref{desc:scrlttr2.option.subject}). The predefined labels are
-shown in \autoref{tab:scrlttr2.subjectTerm}. The predefined value of
-\Variable{subjectseparator} is a colon followed by a non-breaking
-space.
-%
+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
+\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
+\Variable{subject}. The predefined \PName{content} of \PName{subjectseparator}
+is a colon followed by a white space.
+
\begin{table}
- \centering
- \caption{Predefined labels of subject-related variables.}
- \begin{tabular}{lll}
- \toprule
- name & label \\
- \midrule
- \Variable{subject} & \Macro{usekomavar*}\PParameter{subjectseparator}%
- \texttt{\%} \\
- & \texttt{\quad}%
- \Macro{usekomavar}\PParameter{subjectseparator} \\
- \Variable{subjectseparator} & \Macro{subjectname} \\
- \bottomrule
- \end{tabular}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}{predefined descriptions of subject-related variables}
+ [l]
+ \begin{tabular}[t]{lll}
+ \toprule
+ variable name & description \\
+ \midrule
+ \Variable{subject} & \Macro{usekomavar*}\PParameter{subjectseparator}%
+ \texttt{\%} \\
+ & \texttt{\quad}%
+ \Macro{usekomavar}\PParameter{subjectseparator} \\
+ \Variable{subjectseparator} & \Macro{subjectname} \\
+ \bottomrule
+ \end{tabular}
+ \end{captionbeside}
\label{tab:scrlttr2.subjectTerm}
\end{table}
-The subject line is set in a separate font. To change this use the
-user interface described in \autoref{sec:maincls.font}. For the
-element \FontElement{subject}\IndexFontElement{subject} the
-predetermined font in \Class{scrlttr2} is
-\Macro{normalfont}\Macro{normalcolor}\Macro{bfseries}.
+On the other hand, \OptionValue{subject}{afteropening}%
+\important{\OptionValue{subject}{afteropening}} may be used to place the
+subject below instead of before the letter opening. Furthermore, the
+formatting\important[i]{\OptionValue{subject}{underlined}\\
+ \OptionValue{subject}{centered}\\
+ \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
+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
+\OptionValue{subject}{untitled}.%
+%
+\begin{table}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}
+ [{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}}%
+ [l]
+ \begin{minipage}[t]{.6\linewidth}
+ \begin{desctabular}[t]
+ \pventry{afteropening}{subject after opening}%
+ \pventry{beforeopening}{subject before opening}%
+ \pventry{centered}{subject centered}%
+ \pventry{left}{subject left-justified}%
+ \pventry{right}{subject right-justified}%
+ \pventry{titled}{add title/description to subject}%
+ \pventry{underlined}{set subject underlined (see note in text please)}%
+ \pventry{untitled}{do not add title/description to subject}%
+ \end{desctabular}
+ \end{minipage}
+ \end{captionbeside}
+\end{table}
+
+\BeginIndex{FontElement}{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}). or the element
+\FontElement{subject}\important{\FontElement{subject}} the predetermined font
+in \Class{scrlttr2} is \Macro{normalcolor}\Macro{bfseries}.%
+\EndIndex{FontElement}{subject}%
+
\begin{Example}
- Assume you are a board member and want to write a letter to another
- member of that board about a few internals of the organization. You
- want to clarify with your subject line what this letter is all
- about, but without labeling it thus. You can do this as follows:
-\begin{lstlisting}
- \setkomavar{subject}[Subject ]{%
- organization's internals}
-\end{lstlisting}
- or easier:
-\begin{lstlisting}
- \setkomavar{subject}[]{%
- about organization's internals}
-\end{lstlisting}
-Furthermore, if you want to set the subject line not only in bold but
-also in sans serif:
-\begin{lstlisting}
- \addtokomafont{subject}{\sffamily}
-\end{lstlisting}
-As you can see, it is really easy to solve such problems.
+ Now, Mr Public sets a subject. He's a more traditional person, so he likes
+ 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}.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ addressee, additional sender information, place, date, subject,
+ opening, text, closing, signature, postscript, distribution list,
+ enclosure, and puncher hole mark}]
+ {result of a small letter with extended sender, logo, addressee,
+ additional sender information, place, date, subject opening, text,
+ closing, signature, postscript, distribution list, enclosure and
+ puncher hole mark}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-21}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-21}
+ \end{figure}
\end{Example}
%
-\EndIndex{Variable}{subject}%
\EndIndex{Variable}{subjectseparator}%
-
-
-\subsection{Further Settings}
-\label{sec:scrlttr2.other}
-In this paragraph variables and settings are listed which could not be
-assigned to any other part of the letter declaration but somehow
-belong to this section.
+\EndIndex{Variable}{subject}%
+\EndIndex{Option}{subject~=\PName{selection}}%
+\EndIndex{}{subject}%
\begin{Declaration}
- \Variable{frombank}
+ \KOption{firstfoot}\PName{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
+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.
+
+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}}%
+
+\begin{Declaration}
+ \Macro{setkomavar}\PParameter{\Variable{firstfoot}}%
+ \OParameter{description}\Parameter{content}
+\end{Declaration}%
+\BeginIndex{Variable}{firstfoot}%
+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{}
+doesn't use the \PName{description} of the variable. For more information see
+the example following the next description. Only for compatibility reason the
+deprecated command \Macro{firstfoot}\IndexCmd[indexmain]{firstfoot} of
+\Class{scrlttr2} before release~3.08 still exists. Nevertheless it shouldn't
+be used any longer.
+
+\begin{Declaration}
+ \Macro{setkomavar}\PParameter{\Variable{frombank}}%
+ \OParameter{description}\Parameter{content}
+\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 within the sender's extension field or the
-footer.
+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.%
%
-\EndIndex{Variable}{frombank}%
-
-
-\begin{Declaration}
- \Macro{nexthead}\Parameter{construction}\\
- \Macro{nextfoot}\Parameter{construction}
-\end{Declaration}
-\BeginIndex{Cmd}{nexthead}%
-\BeginIndex{Cmd}{nextfoot}%
-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 those pages that follow the first letter
-page. Even more 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 term ``subsequent
-pages'' in this manual refers to all pages following the first letter
-page. The commands \Macro{markboth}\IndexCmd{markboth} and
-\Macro{markright}\IndexCmd{markright} can in particular be used
-together with pagestyle\Index{page>style}
-\PValue{myheadings}\IndexPagestyle{myheadings}. If the package
-\Package{scrpage2}\IndexPackage{scrpage2} 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.
+\begin{Example}
+ In the first page's footer, you may want to set the \PName{content} of the
+ variable \Variable{frombank} (the bank account). The double
+ backslash should be exchanged with a comma at the same time:
+\begin{lstcode}
+ \setkomavar{firstfoot}{%
+ \parbox[b]{\linewidth}{%
+ \centering\def\\{, }\usekomavar{frombank}%
+ }%
+ }
+\end{lstcode}
+ For the hyphen you might define a variable of your own if you like.
+ This is left as an exercise for the reader.
-At times one wants to have more freedom with creating the letterhead
-or footer of subsequent pages. Then one has to give up the
-possibilities of predefined letterheads or footers that could have
-been chosen via the option \Option{pagenumber}\IndexOption{pagenumber}
-(see \autoref{sec:scrlttr2.layout},
-\autopageref{desc:scrlttr2.option.pagenumber}). Instead one is free to
-create the letterhead and footer of subsequent pages just the way one
-wants to have them set. For that, one creates the desired letterhead
-or footer \PName{construction} using the command \Macro{nexthead} or
-\Macro{nextfoot}, respectively. Within \Macro{nexthead} and
-\Macro{nextfoot} you can, for example, have several 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{construction} you can of course also make use of the variables
-by using \Macro{usekomavar}.
+ Nowadays it has become very common to create a proper footer in
+ order to obtain some balance with respect to the letterhead. This
+ can be done as follows:
+\begin{lstcode}
+ \setkomavar{firstfoot}{%
+ \parbox[t]{\textwidth}{\footnotesize
+ \begin{tabular}[t]{l@{}}%
+ \multicolumn{1}{@{}l@{}}{Partners:}\\
+ Jim Smith\\
+ Russ Mayer
+ \end{tabular}%
+ \hfill
+ \begin{tabular}[t]{l@{}}%
+ \multicolumn{1}{@{}l@{}}{Manager:}\\
+ Jane Fonda\\[1ex]
+ \multicolumn{1}{@{}l@{}}{Court Of Jurisdiction:}\\
+ Great Plains
+ \end{tabular}%
+ \ifkomavarempty{frombank}{}{%
+ \hfill
+ \begin{tabular}[t]{l@{}}%
+ \multicolumn{1}{@{}l@{}}{\usekomavar*{frombank}:}\\
+ \usekomavar{frombank}
+ \end{tabular}%
+ }%
+ }%
+ }
+\end{lstcode}
+ This example, by the way, came from Torsten Kr\"uger. With
+\begin{lstcode}
+ \setkomavar{frombank}{Account No. 12\,345\,678\\
+ at Citibank\\
+ bank code no: 876\,543\,21}
+\end{lstcode}
+ the bank account can be set accordingly.
+% If the footer will have such a large height then it might happen that you
+% have to shift its position. You can do this with the pseudo-length
+% \PLength{firstfootvpos}\IndexPLength{firstfootvpos}, which is
+% 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
+suffice. In that case, you may need to reduce \PLength{firstfootvpos} (see
+\autopageref{desc:scrlttr2-experts.plength.firstfootvpos}) appropriately.%
%
-\EndIndex{Cmd}{nexthead}%
-\EndIndex{Cmd}{nextfoot}%
+\EndIndex{Variable}{frombank}%
+\EndIndex{Variable}{firstfoot}%
+%
+\EndIndex{}{letter>foot}%
+\EndIndex{}{letterfoot}%
+%
+\EndIndex{}{letter>first page}%
+\EndIndex{}{note paper}%
-\section{The Text}
-\label{sec:scrlttr2.text}
+\LoadCommon[scrlttr]{6} % \section{Paragraph Markup}
-In contrast to an article, a report or a book, a letter normally has
-no chapter or section structure. Even float environments with tables
-and figure are unusual. Therefore, a letter has no table of contents,
-lists of figures and tables, index, bibliography, glossary or similar
-things. The letter text mainly consists of an opening and the main
-text. Thereupon follow the signature, a postscript and various
-listings.
+\LoadCommon[scrlttr]{7} % \section{Detection of Odd and Even Pages}
-\subsection{The Opening}
-\label{sec:scrlttr2.opening}
+\section{Head and Foot Using Predefined Page Style}
+\label{sec:scrlttr2.pagestyle}
+\BeginIndex{}{page>style}%
+\BeginIndex{}{page>head}%
+\BeginIndex{}{page>foot}%
-\begin{Explain}
- In the early days of computer-generated letters, programs did not
- have many capabilities, therefore the letters seldom had an opening.
- Today the capabilities have been enhanced. Thus personal openings
- are very common, even in mass-production advertising letters.
-\end{Explain}
+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
+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
+the page style of the secondary letter sheet. At double-side letters this is
+also the page style of all backsides.
\begin{Declaration}
- \Macro{opening}\Parameter{opening}
+ \KOption{headsepline}\PName{simple switch}\\
+ \KOption{footsepline}\PName{simple switch}
\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 opening is typeset, but the command
-also typesets the folding marks, letterhead, address field, reference
-fields line, subject, the page footer and others. In short, without
-\Macro{opening} there is no letter.
-%
-\EndIndex{Cmd}{opening}%
-
-\subsection{Footnotes}
-\label{sec:scrlttr2.footnotes}
-
-In letters footnotes should be used more sparingly than in normal
-documents. However, \Class{scrlttr2} is equipped with all mechanisms
-mentioned in \autoref{sec:maincls.footnotes} for the main document
-classes. Therefore they will not be discussed here again.
-
-\subsection{Lists}
-\label{sec:scrlttr2.lists}
-
-Lists have the same validity in letters as in normal documents. Thus
-\Class{scrlttr2} provides the same possibilities as mentioned in
-\autoref{sec:maincls.lists} for the main document classes. Therefore
-they will not be discussed here again.
+\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
+values for simple switches, as listed in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}.
+Activation\important{\OptionValue{headsepline}{true}} of option
+\Option{headsepline} switches on a rule below the page
+head. Activation\important{\OptionValue{footsepline}{true}} of option
+\Option{footsepline} switches on a rule above the page foot. Deactivation of
+the options switches of the corresponding rules.
+
+Obviously option \Option{headsepline} doesn't influence page styles
+\PValue{empty}\important[i]{\Pagestyle{empty}\\
+ \Pagestyle{plain}} and \PValue{plain} (see afterwards at this
+section). These page styles explicitly don't use any page head.
+
+Typographically\important[i]{\Pagestyle{headings}\\
+ \Pagestyle{myheadings}} such a rule make a hard optical connection of head
+or foot and the text area. This wouldn't 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{scrpage2}\IndexPackage{scrpage2}\important{\Package{scrpage2}} (see
+\autoref{cha: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}}%
+
+
+\begin{Declaration}
+ \KOption{pagenumber}\PName{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
+\Package{scrpage2}\important{\Package{scrpage2}} package, if set before
+loading the package (see \autoref{cha: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}.
-\subsection{Margin Notes}
-\label{sec:scrlttr2.marginNotes}
+\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}
+ \begin{desctabular}
+ \entry{\PValue{bot}, \PValue{foot}}{%
+ page number in footer, horizontal position not changed}%
+ \entry{\PValue{botcenter}, \PValue{botcentered}, \PValue{botmittle},
+ \PValue{footcenter}, \PValue{footcentered}, \PValue{footmiddle}}{%
+ page number in footer, centered}%
+ \entry{\PValue{botleft}, \PValue{footleft}}{%
+ page number in footer, left justified}%
+ \entry{\PValue{botright}, \PValue{footright}}{%
+ page number in footer, right justified}%
+ \entry{\PValue{center}, \PValue{centered}, \PValue{middle}}{%
+ page number centered horizontally, vertical position not changed}%
+ \entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
+ no page number}%
+ \entry{\PValue{head}, \PValue{top}}{%
+ page number in header, horizontal position not changed}%
+ \entry{\PValue{headcenter}, \PValue{headcentered}, \PValue{headmiddle},
+ \PValue{topcenter}, \PValue{topcentered}, \PValue{topmiddle}}{%
+ page number in header, centered}%
+ \entry{\PValue{headleft}, \PValue{topleft}}{%
+ page number in header, left justified}%
+ \entry{\PValue{headright}, \PValue{topright}}{%
+ page number in header, right justified}%
+ \entry{\PValue{left}}{%
+ page number left, vertical position not changed}%
+ \entry{\PValue{right}}{%
+ page number right, vertical position not changed}%
+ \end{desctabular}
+\end{table}
+%
+\EndIndex{Option}{pagenumber~=\PName{position}}%
-Margin notes are quite uncommon in letters. Therefore the option
-\Option{mpinclude} is not actively supported by \Class{scrlttr2}.
-However, \Class{scrlttr2} is equipped with all mechanisms mentioned in
-\autoref{sec:maincls.marginNotes} for the main document
-classes. Therefore they will not be discussed here again.
-\subsection{Text Emphasis}
-\label{sec:scrlttr2.emphasis}
+\begin{Declaration}
+ \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{scrpage2} also \Macro{markleft} (see
+ \autoref{sec:scrpage.basics.mark}, \autopageref{desc: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{scrpage2} 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}.
+\end{description}
-The distinction of text has the same importance in letters as in other
-documents. Thus the same rules apply, meaning: emphasize text
-sparingly. Even letters should be readable and a letter where each
-word is typeset in another font is quite unreadable.
+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
+page. The\textnote{Attention!} letter class itself uses
+\Macro{thispagestyle}\PParameter{empty} within
+\Macro{opening}\IndexCmd{opening} for the first page of the letter.
-The class \Class{scrlttr2} is equipped with all
-mechanisms mentioned in \autoref{sec:maincls.emphasis} for
-the main document classes. Therefore it will not be discussed
-here again.
+\BeginIndex[indexother]{}{font>style}%
+\BeginIndex{FontElement}{pageheadfoot}%
+\BeginIndex{FontElement}{pagefoot}%
+\BeginIndex{FontElement}{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
+\FontElement{pageheadfoot}\important{\FontElement{pagehead}} or
+\FontElement{pagehead}. There\ChangedAt{v3.00}{\Class{scrlttr2}} is an
+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
+\Package{scrpage2}\IndexPackage{scrpage2} (see \autoref{cha:scrpage},
+\autopageref{desc: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{sec:maincls.pagestyle.example}.
+%
+\EndIndex{FontElement}{pagenumber}%
+\EndIndex{FontElement}{pagefoot}%
+\EndIndex{FontElement}{pageheadfoot}%
+\EndIndex[indexother]{}{font>style}%
+%
+\EndIndex{Pagestyle}{myheadings}%
+\EndIndex{Pagestyle}{headings}%
+\EndIndex{Pagestyle}{plain}%
+\EndIndex{Pagestyle}{empty}%
+\EndIndex{Cmd}{thispagestyle}%
+\EndIndex{Cmd}{pagestyle}%
-\section{The Closing Part}
-\label{sec:scrlttr2.backend}
-A letter always ends with a closing phrase. Even computer-generated
-letters without signature have such a phrase. Sometimes this is a
-sentence such as, ``This letter has been generated automatically and
-is valid without a signature.''. Sometimes a sentence like this will
-even be used as a signature. Thereupon can follow a postscript and
-various listings.
+\begin{Declaration}
+ \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
+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
+\Package{scrpage2}\IndexPackage{scrpage2} 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.
-\subsection{Closing}
+\begin{Declaration}
+ \Macro{setkomavar}\PParameter{\Variable{nexthead}}%
+ \OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{nextfoot}}%
+ \OParameter{description}\Parameter{content}
+\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
+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
+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
+\Variable{nexthead} and \Variable{nextfoot} you can, for example, have several
+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{} doesn't use the \PName{description} of both
+variables.
+
+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 shouldn't use
+those.%
+%
+\EndIndex{Variable}{nextfoot}%
+\EndIndex{Variable}{nexthead}%
+\EndIndex{Cmd}{markright}%
+\EndIndex{Cmd}{markboth}%
+%
+\EndIndex{}{page>foot}%
+\EndIndex{}{page>head}%
+\EndIndex{}{page>style}%
+
+
+\LoadCommon[scrlttr]{8} % \section{Interleaf Pages}
+
+\LoadCommon[scrlttr]{9} % \section{Footnotes}
+\LoadCommon[scrlttr]{11}% -"-
+\LoadCommon[scrlttr]{10}% -"-
+
+\LoadCommon[scrlttr]{12}% \section{Lists}
+
+
+\section{Math}
+\label{sec:scrlttr2.math}%
+\BeginIndex{}{equations}%
+\BeginIndex{}{formulas}%
+\BeginIndex{}{mathematics}%
+
+There are not math environments implemented at the \KOMAScript{}
+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} doesn't 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}.
+
+You won't find a description of the math environments of the \LaTeX{} kernel
+here. If you want to use \Environment{displaymath}\IndexEnv{displaymath},
+\Environment{equation}\IndexEnv{equation} and
+\Environment{eqnarray}\IndexEnv{eqnarray} you should read a short introduction
+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}
+
+\section{Floating Environments of Tables and Figures}
+\label{sec:scrlttr2.floats}
+
+Floating environments for tables or figures are very unusual in
+letters. Therefore\textnote{Attention!} \Class{scrlttr2} doesn't provide
+them. If someone nevertheless needs floating environments, then this is often
+points out a malpractice of the letter class. In such cases you may try to
+define the floating environments with help of packages like \Package{tocbasic}\important{\Package{tocbasic}} (siehe
+\autoref{cha:tocbasic}). Nevertheless, tabulars and pictures or graphics
+without floating environment may still be done with the letter class
+\Class{scrlttr2}.
+
+
+\LoadCommon[scrlttr2]{13} % \section{Margin Notes}
+
+
+\section{Closing}
\label{sec:scrlttr2.closing}
+\BeginIndex{}{closing}%
+\BeginIndex{}{letter>closing}%
+\BeginIndex{}{signature}%
+\BeginIndex{}{letter>signature}%
-The closing consists of three parts: besides the closing phrase there
-are a hand-written inscription and the signature, which acts as an
-explanation for the inscription.
+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.
\begin{Declaration}
- \Variable{signature}
+ \Macro{setkomavar}\PParameter{\Variable{signature}}%
+ \OParameter{description}\Parameter{content}
\end{Declaration}
\BeginIndex{Variable}{signature}%
-The variable \Variable{signature} holds an explanation for the
-inscription. The content is predefined as
-\Macro{usekomavar}\PParameter{fromname}. The explanation may consist
+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
-backslash. Paragraphs in the explanation are however not permitted.
-%
-\EndIndex{Variable}{signature}%
+backslash. Paragraph\textnote{Attention!} breaks in the annotation are however
+not permitted.%
\begin{Declaration}
- \Macro{closing}\Parameter{closing phrase}
-\end{Declaration}
-\BeginIndex{Cmd}{closing}%
-The command \Macro{closing} not only typesets the closing phrase, but
-also the content of the variable \Variable{signature}. The closing
-phrase may consists of multiple lines, but paragraphs are not
-permitted.
-%
-\EndIndex{Cmd}{closing}%
-
-\begin{Declaration}
- \PLength{sigindent}\\
- \PLength{sigbeforevskip}\\
\Macro{raggedsignature}
\end{Declaration}
-\BeginIndex{PLength}{sigindent}%
-\BeginIndex{PLength}{sigbeforevskip}%
\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.
-
-The box will be typeset with indentation of the length set in
-pseudo-length \PLength{sigindent}. In the predefined \File{lco} files
-this length is set to 0\Unit{mm}.
-
-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
+phrase or signature's \PName{content}.
+
+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
+\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}).
-Between closing phrase and signature a vertical space is inserted, the
-height of which is defined in the pseudo-length
-\PLength{sigbeforevskip}. In the predefined \File{lco} files this is
-set to 2 lines. In this space you can then write your inscription.
\begin{Example}
- You are writing as the directorate of a society a letter to all
- members. Moreover, you want on the one hand to elucidate that you
- are writing in the name of the board of directors, and on the other
- hand you want indicate your position on the board of directors.
-\begin{lstlisting}
- \setkomavar{signature}{John McEnvy\\
- {\small (Vice-President ``The Other Society'')}}
- \closing{Regards\\
- (for the board of directors)}
-\end{lstlisting}
-You can of coure set the variable \Variable{signature} in your private
-\File{lco} files. Otherwise it is advisable to define the variable in
-the letter preamble (see \autoref{sec:scrlttr2.startLetter}).
+ 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}:%
+ \lstinputcode[xleftmargin=1em]{letter-22}%
+ See \autoref{fig:scrlttr2.letter-22} for the result.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ addressee, additional sender information, place, date, subject,
+ opening, text, closing, modified signature, postscript, distribution
+ list, enclosure, and puncher hole mark}]
+ {result of a small letter with extended sender, logo, addressee,
+ additional sender information, place, date, subject opening, text,
+ closing, modified signature, postscript, distribution list, enclosure
+ and puncher hole mark}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-22}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-22}
+ \end{figure}
\end{Example}
%
-\EndIndex{PLength}{sigindent}%
-\EndIndex{PLength}{sigbeforevskip}%
\EndIndex{Cmd}{raggedsignature}%
-
-\subsection{Postscript, Carbon Copy and Enclosures}
-\label{sec:scrlttr2.afterClosing}
-
-After the closing can follow some other statements. Besides the
-postscript, there are the distribution list of carbon copies, and the
-reference to enclosures.
-
-\begin{Explain}%
-\begin{Declaration}
- \Macro{ps}
-\end{Declaration}%
-\BeginIndex{Cmd}{ps}%
-In the time when letters were written by hand it was quite common to
-use a postscript because this was the only way to add information
-which one had forgotten to mention in the main part of the letter. Of
-course, in letters written with {\LaTeX} you can insert additional
-lines easily. Nevertheless, it is still popular to use the
-postscript. It gives one a good possibility to underline again the
-most important or sometimes the less important things of the
-particular letter.
%
-\end{Explain}
-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
-normal text. If you want the postscript to be introduced with the
-acronym ``PS:'' , which by the way is written without a full stop, you
-have to type this yourself. The acronym is typeset neither
-automatically nor optionally by the class \Class{scrlttr2}.
+\EndIndex{Variable}{signature}%
%
-\EndIndex{Cmd}{ps}
+\EndIndex{}{letter>signature}%
+\EndIndex{}{signature}%
+\EndIndex{}{letter>closing}%
+\EndIndex{}{closing}%
+
+
+\section{Letter Class Option Files}
+\label{sec:scrlttr2.lcoFile}%
+\BeginIndex{}{lco-file=\File{lco}-file}%
+\BeginIndex{}{letter class option}%
+\BeginIndex{}{letter>class option}%
+
+Normally, you would not redefine selections like the sender's information
+every time you write a letter. Instead, you would reuse a whole set of
+parameters for certain occasions. It will be much the same for the letterhead
+and footer used on the first page. Therefore, it is reasonable to save these
+settings in a separate file. For this purpose, the \Class{scrlttr2} class
+offers the \File{lco}-files. The \File{lco} suffix is an abbreviation for
+\emph{\emph{l}etter \emph{c}lass \emph{o}ption}.
+
+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
+\autoref{sec:scrlttr2-experts.pseudoLengths}).
+There are already some \File{lco} files included in the {\KOMAScript}
+distribution. The \File{DIN.lco}, \File{DINmtext.lco}, \File{SNleft.lco},
+\File{SN.lco}, \File{UScommercial9}, \File{UScommercial9DW},
+\File{NF.lco}\ChangedAt{v3.04}{\Class{scrlttr2}} files serve to adjust
+{\KOMAScript} to different layout standards. They are well suited as templates
+for your own parameter sets, while you become a \KOMAScript{} expert. The
+\File{KOMAold.lco} file, on the other hand, serves to improve compatibility
+with the old letter class \Class{scrlettr}. Since it contains internal
+commands not open to package writers, you should not use this as a template
+for your own \File{lco} files. You can find a list of predefined \File{lco}
+files in \autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles}.
+
+If you have defined a parameter set for a letter standard not yet supported by
+\KOMAScript, you are explicitly invited to send this parameter set to the
+{\KOMAScript} support address. Please do not forget to include the permission
+for distribution under the {\KOMAScript} license (see the \File{lppl.txt}
+file). If you know the necessary metrics for an unsupported letter standard,
+but are not able to write a corresponding \File{lco} file yourself, you can
+also contact the {\KOMAScript} author, Markus Kohm, directly. More
+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{cc}\Parameter{distribution list}\\
- \Variable{ccseparator}
+ \Macro{LoadLetterOption}\Parameter{name}
\end{Declaration}
-\BeginIndex{Cmd}{cc}%
-\BeginIndex{Variable}{ccseparator}%
-With the command \Macro{cc} it is possible to typeset a
-\PName{distribution list}. The command takes the \PName{distribution
- list} as its argument. If the content of the variable
-\Variable{ccseparator} is not empty, then the name and the content of
-this variable is inserted before \PName{distribution list}. In this
-case the \PName{distribution list} will be indented appropriately. It
-is a good idea to set the \PName{distribution list}
-\Macro{raggedright} and to separate the individual entries with a
-double backslash.
+\BeginIndex{Cmd}{LoadLetterOption}%
+Usually, the \File{lco}-files will be loaded by the \Macro{documentclass}
+command. You enter the name of the \File{lco}-file without suffix as an
+option\Index{option}. The \File{lco}-file will be loaded right after the class
+file.
+
+However, it is also possible to load an \File{lco}-file later, or even from
+within another \File{lco}-file. This may be done with the
+\Macro{LoadLetterOption} command, which takes the \PName{name} of the
+\File{lco}-file without suffix as a parameter.
\begin{Example}
- You want to indicate that your letter is sent to all members of a
- society and to the board of directors:
-\begin{lstlisting}
- \cc{%
- the board of directors\\
- all society members}
-\end{lstlisting}
-This instruction should be written below the \Macro{closing}
-instruction from the previous example, or below a possible postscript.
+ Mr Public also writes a document containing several letters. Most of them
+ should comply with the German DIN standard. So he starts with:
+\begin{lstcode}
+ \documentclass{scrlttr2}
+\end{lstcode}
+ However, one letter should use the \File{DINmtext} variant, with the
+ address field placed more toward the top, which results in more text
+ fitting on the first page. The folding will be modified so that the
+ address field still matches the address window in a DIN~C6/5 envelope.
+ You can achieve this as follows:
+\begin{lstcode}
+ \begin{letter}{%
+ Joana Public\\
+ Hillside 1\\
+ 12345 Public-City}
+ \LoadLetterOption{DINmtext}
+ \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.
\end{Example}
-A vertical space is inserted automatically before the distribution
-list.
-%
-\EndIndex{Cmd}{cc}%
-\EndIndex{Variable}{ccseparator}%
-
-
-\begin{Declaration}
- \Macro{encl}\Parameter{enclosures}\\
- \Variable{enclseparator}
-\end{Declaration}
-\BeginIndex{Cmd}{encl}%
-\BeginIndex{Variable}{enclseparator}%
-\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 \Variable{enclseparator}.
-%
-\EndIndex{Cmd}{encl}%
-\EndIndex{Variable}{enclseparator}%
-
-
-\section{Language Support}
-\label{sec:scrlttr2.languages}
-\BeginIndex{}{language}%
-
-The document class \Class{scrlttr2} supports many languages. These
-include German (\PValue{german} for old German orthography,
-\PValue{ngerman} for the new orthography, and \PValue{austrian} for
-Austrian), English (\PValue{english} without specification as to
-whether American or British should be used, \PValue{american} and
-\PValue{USenglish} for American, and \PValue{british} and
-\PValue{UKenglish} for British), French, Italian, Spanish, Dutch,
-Croatian, Finnish, Norsk\ChangedAt{v3.02}{\Class{scrlttr2}}, and
-Swedish\ChangedAt{v3.08}{\Class{scrlttr2}}.
-
-\subsection{Language Selection}
-\label{sec:scrlttr2.switchLanguage}
-\Index[indexmain]{language>selection}
-
-If the package \Package{babel}\IndexPackage{babel} (see
-\cite{package:babel}) is used, one can switch between languages with
-the command \Macro{selectlanguage}\Parameter{language}. Other
-packages like \Package{german}\IndexPackage{german} (see
-\cite{package:german}) and \Package{ngerman}\IndexPackage{ngerman}
-(see \cite{package:ngerman}) also define this command. As a rule
-though, the language selection takes place already as a direct
-consequence of loading such a package. Further information can be
-obtained in the documentation of the relevant packages.
-
-\begin{Explain}
- There is one thing more to mention about language packages. The
- package \Package{french}\IndexPackage{french} (see
- \cite{package:french}) redefines not only the terms of
- \autoref{sec:scrlttr2.languageTerms}, but also other, for instance
- it even redefines the command \Macro{opening}, since it assumes that
- the definition of the standard \Class{letter} is used. With
- \Class{scrlttr2} this is not the case, therefore the package
- \Package{french} destroys the definition in \Class{scrlttr2} and
- does not work correctly with \KOMAScript. The author views this is a
- fault in the \Package{french} package.
-
- If one utilizes the \Package{babel}\IndexPackage{babel} package in
- order to switch to language \PValue{french} while the package
- \Package{french}\IndexPackage{french} is simultaneously installed,
- then the same problems will likely occur, since \Package{babel}
- employs definitions from the \Package{french} package. If the
- package \Package{french} is not installed then there are no
- problems. Aimilarly, there is no problem if for \Package{babel}
- instead of \PValue{french} other languages like \PValue{acadian},
- \PValue{canadien}, \PValue{francais} or \PValue{frenchb} are chosen.
-
- From \Package{babel} version 3.7j this problem only occurs when it
- is indicated explicitly by means of an option that \Package{babel}
- should use the \Package{french} package.
-
- If it cannot be ascertained that a new version of \Package{babel} is
- being used, it is recommended to use
-
- %\Macro{usepackage}\PValue{[...,frenchb,...]}\PParameter{babel}
-
- \begin{lstlisting}
- \usepackage[...,frenchb,...]{babel}
- \end{lstlisting}
-
- in order to select french.
-
- Other languages can possibly cause similar problems. Currently there
- are no known problems with the \Package{babel} package for the
- german language and the various english language selections.
-
-% \iftrue
-% % You may use this paragraphs to improve page break:
-% Most \Package{babel} features in \Package{babel} or original
-% language definition files of \Package{babel} (e.\,g.,
-% \File{frenchb.ldf}), which may cause problems with other packages or
-% classes, can be switched off. This is a great advantage of babel. So
-% if you have a problem, try to switch of such features or ask the
-% authors of \Package{babel}.
-
-% There are no known problems with using the
-% \Package{german}\IndexPackage{german} or
-% \Package{ngerman}\IndexPackage{ngerman} package for german selection
-% with old or new orthography, nor for the various english selections.
-% \fi
-\end{Explain}
-
-\begin{Declaration}
- \Macro{captionsenglish}\\
- \Macro{captionsUSenglish}\\
- \Macro{captionsamerican}\\
- \Macro{captionsbritish}\\
- \Macro{captionsUKenglish}\\
- \Macro{captionsgerman}\\
- \Macro{captionsngerman}\\
- \Macro{captionsaustrian}\\
- \Macro{captionsfrench}\\
- \Macro{captionsitalian}\\
- \Macro{captionsspanish}\\
- \Macro{captionsdutch}\\
- \Macro{captionscroatian} \\
- \Macro{captionsfinnish}\\
- \Macro{captionsnorsk}\\
- \Macro{captionsswedish}
-\end{Declaration}
-\BeginIndex{Cmd}{captionsenglish}\BeginIndex{Cmd}{captionsUSenglish}%
-\BeginIndex{Cmd}{captionsamerican}\BeginIndex{Cmd}{captionsbritish}%
-\BeginIndex{Cmd}{captionsUKenglish}\BeginIndex{Cmd}{captionsgerman}%
-\BeginIndex{Cmd}{captionsngerman}%
-\BeginIndex{Cmd}{captionsaustrian}\BeginIndex{Cmd}{captionsfrench}%
-\BeginIndex{Cmd}{captionsitalian}\BeginIndex{Cmd}{captionsspanish}%
-\BeginIndex{Cmd}{captionsdutch}\BeginIndex{Cmd}{captionscroatian}%
-\BeginIndex{Cmd}{captionsfinnish}%
-\BeginIndex{Cmd}{captionsnorsk}%
-\BeginIndex{Cmd}{captionsswedish}%
-If one switches the language then
-using these commands the language-dependent terms from
-\autoref{sec:scrlttr2.languageTerms} are redefined. If the used
-language selection scheme does not support this then the commands
-above can be used directly.
-%
-\EndIndex{Cmd}{captionsswedish}%
-\EndIndex{Cmd}{captionsnorsk}%
-\EndIndex{Cmd}{captionsenglish}\EndIndex{Cmd}{captionsUSenglish}%
-\EndIndex{Cmd}{captionsamerican}\EndIndex{Cmd}{captionsbritish}%
-\EndIndex{Cmd}{captionsUKenglish}\EndIndex{Cmd}{captionsgerman}%
-\EndIndex{Cmd}{captionsngerman}%
-\EndIndex{Cmd}{captionsaustrian}\EndIndex{Cmd}{captionsfrench}%
-\EndIndex{Cmd}{captionsitalian}\EndIndex{Cmd}{captionsspanish}%
-\EndIndex{Cmd}{captionsdutch}\EndIndex{Cmd}{captionscroatian}%
-\EndIndex{Cmd}{captionsfinnish}%
-\begin{Declaration}
- \Macro{dateenglish}\\
- \Macro{dateUSenglish}\\
- \Macro{dateamerican}\\
- \Macro{datebritish}\\
- \Macro{dateUKenglish}\\
- \Macro{dategerman}\\
- \Macro{datengerman}\\
- \Macro{dateaustrian}\\
- \Macro{datefrench}\\
- \Macro{dateitalian}\\
- \Macro{datespanish}\\
- \Macro{datedutch}\\
- \Macro{datecroatian}\\
- \Macro{datefinnish}\\
- \Macro{datenorsk}\\
- \Macro{dateswedish}
-\end{Declaration}
-\BeginIndex{Cmd}{dateenglish}\BeginIndex{Cmd}{dateUSenglish}%
-\BeginIndex{Cmd}{dateamerican}\BeginIndex{Cmd}{datebritish}%
-\BeginIndex{Cmd}{dateUKenglish}\BeginIndex{Cmd}{dategerman}%
-\BeginIndex{Cmd}{datengerman}%
-\BeginIndex{Cmd}{dateaustrian}\BeginIndex{Cmd}{datefrench}%
-\BeginIndex{Cmd}{dateitalian}\BeginIndex{Cmd}{datespanish}%
-\BeginIndex{Cmd}{datedutch}\BeginIndex{Cmd}{datecroatian}%
-\BeginIndex{Cmd}{datefinnish}%
-\BeginIndex{Cmd}{datenorsk}%
-\BeginIndex{Cmd}{dateswedish}%
-The numerical representation of the date\Index{date} (see option
-\Option{numericaldate} in \autoref{sec:scrlttr2.headoptions}) will be
-written depending on the selected language. Some examples can be found
-in \autoref{tab:date}.
-%
-\begin{table}[t]
- \centering
- \caption{Language-dependent forms of the date}
- \begin{tabular}{ll}
- \toprule
- Command & Date example \\
- \midrule
- \Macro{dateenglish} & 24/12/1993\\
- \Macro{dateUSenglish} & 12/24/1993\\
- \Macro{dateamerican} & 12/24/1993\\
- \Macro{datebritish} & 24/12/1993\\
- \Macro{dateUKenglish} & 24/12/1993\\
- \Macro{dategerman} & 24.\,12.\,1993\\
- \Macro{datengerman} & 24.\,12.\,1993\\
- \Macro{dateaustrian} & 24.\,12.\,1993\\
- \Macro{datefrench} & 24.\,12.\,1993\\
- \Macro{dateitalian} & 24.\,12.\,1993\\
- \Macro{datespanish} & 24.\,12.\,1993\\
- \Macro{datedutch} & 24.\,12.\,1993\\
- \Macro{datecroatian} & 24.\,12.\,1993.\\
- \Macro{datefinnish } & 24.12.1993.\\
- \Macro{datenorsk} & 24.12.1993\\
- \Macro{dateswedish} & 24/12 1993\\
- \bottomrule
- \end{tabular}
- \label{tab:date}
-\end{table}
-%
-\EndIndex{Cmd}{datenorsk}%
-\EndIndex{Cmd}{dateenglish}\EndIndex{Cmd}{dateUSenglish}%
-\EndIndex{Cmd}{dateamerican}\EndIndex{Cmd}{datebritish}%
-\EndIndex{Cmd}{dateUKenglish}\EndIndex{Cmd}{dategerman}%
-\EndIndex{Cmd}{datengerman}%
-\EndIndex{Cmd}{dateaustrian}\EndIndex{Cmd}{datefrench}%
-\EndIndex{Cmd}{dateitalian}\EndIndex{Cmd}{datespanish}%
-\EndIndex{Cmd}{datedutch}\EndIndex{Cmd}{datecroatian}%
-\EndIndex{Cmd}{datefinnish}%
-\EndIndex{Cmd}{dateswedish}%
-
-
-\subsection{Language-Dependent Terms}%
-\label{sec:scrlttr2.languageTerms}%
-\BeginIndex{}{language>-dependent terms}%
-\BeginIndex{}{terms>language-dependent}
-
-As is usual in {\LaTeX}, the language-dependent terms are defined by
-commands which are then redefined when one switches the language.
+If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco}-file is loaded via
+\Macro{documentclass}, then it may no longer have the same name as an option.
-\begin{Declaration}
- \Macro{yourrefname}\\
- \Macro{yourmailname}\\
- \Macro{myrefname}\\
- \Macro{customername}\\
- \Macro{invoicename}\\
- \Macro{subjectname}\\
- \Macro{ccname}\\
- \Macro{enclname}\\
- \Macro{headtoname}\\
- \Macro{headfromname}\\
- \Macro{datename}\\
- \Macro{pagename}\\
- \Macro{phonename}\\
- \Macro{faxname}\\
- \Macro{emailname}\\
- \Macro{wwwname}\\
- \Macro{bankname}
-\end{Declaration}
-\BeginIndex{Cmd}{yourrefname}\BeginIndex{Cmd}{yourmailname}
-\BeginIndex{Cmd}{myrefname}
-\BeginIndex{Cmd}{customername}\BeginIndex{Cmd}{invoicename}
-\BeginIndex{Cmd}{subjectname}
-\BeginIndex{Cmd}{ccname}\BeginIndex{Cmd}{enclname}
-\BeginIndex{Cmd}{headtoname}\BeginIndex{Cmd}{headfromname}
-\BeginIndex{Cmd}{datename}\BeginIndex{Cmd}{pagename}
-\BeginIndex{Cmd}{phonename}\BeginIndex{Cmd}{faxname}
-\BeginIndex{Cmd}{emailname}\BeginIndex{Cmd}{wwwname}
-\BeginIndex{Cmd}{bankname} The commands above contain the
-language-dependent terms. These definitions can be modified in order
-to support a new language or for private customization. How this can
-be done is described in \autoref{sec:scrlttr2.defLanguageTerms}. The
-definitions become active only at \Macro{begin}\PParameter{document}.
-Therefore they are not available in the {\LaTeX} preamble and cannot
-be redefined there. In \autoref{tab:scrlttr2.languageTerms} the
-default settings for \Option{english} and \Option{ngerman} can be
-found.
-%
-\EndIndex{Cmd}{yourrefname}\EndIndex{Cmd}{yourmailname}
-\EndIndex{Cmd}{myrefname}
-\EndIndex{Cmd}{customername}\EndIndex{Cmd}{invoicename}
-\EndIndex{Cmd}{subjectname}
-\EndIndex{Cmd}{ccname}\EndIndex{Cmd}{enclname}
-\EndIndex{Cmd}{headtoname}\EndIndex{Cmd}{headfromname}
-\EndIndex{Cmd}{datename}\EndIndex{Cmd}{pagename}
-\EndIndex{Cmd}{phonename}\EndIndex{Cmd}{faxname}
-\EndIndex{Cmd}{emailname}\EndIndex{Cmd}{wwwname}
-\EndIndex{Cmd}{bankname}
-
-\begin{table}[!t]
- \begin{minipage}{\textwidth}
- \centering
- \caption{Default settings for languages \Option{english}
- and \Option{ngerman}}
- \begin{tabular}{lll}
- \toprule
- Command & \Option{english} & \Option{ngerman} \\
- \midrule
- \Macro{bankname} & Bank account & Bankverbindung \\
- \Macro{ccname}\footnotemark[1] & cc & Kopien an \\
- \Macro{customername} & Customer no. & Kundennummer \\
- \Macro{datename} & Date & Datum \\
- \Macro{emailname} & Email & E-Mail \\
- \Macro{enclname}\footnotemark[1] & encl & Anlagen \\
- \Macro{faxname} & Fax & Fax \\
- \Macro{headfromname} & From & Von \\
- \Macro{headtoname}\footnotemark[1] & To & An \\
- \Macro{invoicename} & Invoice no. & Rechnungsnummer \\
- \Macro{myrefname} & Our ref. & Unser Zeichen \\
- \Macro{pagename}\footnotemark[1] & Page & Seite \\
- \Macro{phonename} & Phone & Telefon \\
- \Macro{subjectname} & Subject & Betrifft \\
- \Macro{wwwname} & Url & URL \\
- \Macro{yourmailname} & Your letter of & Ihr Schreiben vom\\
- \Macro{yourrefname} & Your ref. & Ihr Zeichen \\
- \bottomrule
- \end{tabular}
- \label{tab:scrlttr2.languageTerms}
- \deffootnote{1em}{1em}{\textsuperscript{1}}%
- \footnotetext[1000]{Normally these terms are defined by language
- packages like \Package{babel}. In this case they are not redefined
- by \Class{scrlttr2} and may differ from the table above.}
- \end{minipage}
-\end{table}
-%
-
-\subsection{Defining and Changing Language-dependent Terms}
-\label{sec:scrlttr2.defLanguageTerms}
-\Index[indexmain]{language>definition}
-\begin{Explain}
- Normally one has to change or define the language-dependent terms of
- \autoref{sec:scrlttr2.switchLanguage} in such a way that in addition
- to the available terms the new or redefined terms are defined. This
- is made more difficult by the fact that some packages like
- \Package{german}\IndexPackage{german} or
- \Package{ngerman}\IndexPackage{ngerman} redefine those settings when
- the packages are loaded. This definitions unfortunately occurs in
- such a manner as to destroy all previous private settings. That is
- also the reason why \Class{scrlttr2} delays its own changes, with
- \Macro{AtBeginDocument} until \Macro{begin}\PParameter{document},
- that is, after package loading is completed. The user can also use
- \Macro{AtBeginDocument}, or redefine the language-dependent terms
- after \Macro{begin}\PParameter{document}, that is, not put them in
- the preamble at all. The class \Class{scrlttr2} even provides some
- additional commands for defining language-dependent terms.
-\end{Explain}
-
-\begin{Declaration}
- \Macro{providecaptionname}%
- \Parameter{language}\Parameter{term}\Parameter{definition}\\
- \Macro{newcaptionname}%
- \Parameter{language}\Parameter{term}\Parameter{definition}\\
- \Macro{renewcaptionname}%
- \Parameter{language}\Parameter{term}\Parameter{definition}
-\end{Declaration}
-\BeginIndex{Cmd}{providecaptionname}%
-\BeginIndex{Cmd}{newcaptionname}%
-\BeginIndex{Cmd}{renewcaptionname}%
-Using one of the commands above, the user can assign a
-\PName{definition} for a particular \PName{language} to a
-\PName{term}. The \PName{term} is always a macro. The commands differ
-dependent on whether a given \PName{language} or a \PName{term} within
-a given \PName{language} are already defined or not at the time the
-command is called.
-
-If \PName{language} is not defined, then \Macro{providecaptionname}
-does nothing other than writes a message in the log file. This happens
-only once for each language. If \PName{language} is defined but
-\PName{term} is not yet defined for it, then it will be defined using
-\PName{definition}. The \PName{term} will not be redefined if the
-\PName{language} already has such a definition; instead, an
-appropriate message is written to the log file.
-
-The command \Macro{newcaptionname} has a slightly different behaviour.
-If the \PName{language} is not yet defined, then a new language
-command (see \autoref{sec:scrlttr2.switchLanguage}) will be created
-and a message written to the log file. If \PName{term} is not yet
-defined in \PName{language}, then it will be defined using
-\PName{definition}. If \PName{term} already exists in
-\PName{language}, then this results in an error message.
-
-The command \Macro{renewcaptionname} again behaves differently. It
-requires an existing definition of \PName{term} in \PName{language}.
-If neither \PName{language} nor \PName{term} exist or \PName{term} is
-unknown in a defined language then a error message will be
-given. Otherwise, the \PName{term} for \PName{language} will be
-redefined according to \PName{definition}.
-
-The class \Class{scrlttr2} itself employs \Macro{providecaptionname}
-in order to define the commands in
-\autoref{sec:scrlttr2.languageTerms}.
\begin{Example}
- If you prefer ``Your message of'' instead of ``Your letter of'', you
- have to redefine the definition of \Macro{yourmailname}.
-\begin{lstlisting}
- \renewcaptionname{english}{\yourmailname}{%
- Your message of}
-\end{lstlisting}
-
-Since only existing terms in available languages can be redefined, you
-have to put the command after \Macro{begin}\PParameter{document} or
-delay the command by using \Macro{AtBeginDocument}. Furthermore, you
-will get an error message if there is no package used that switches
-language selection to \PName{english}.
+ Since Mr~Public often writes letters with the same options and parameters,
+ he doesn't like to copy all these to each new letter. To simplify the effort
+ of writing a new letter, he therefore makes a \File{lco}-file:%
+ \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
+ doesn't change.
+ \begin{figure}
+ \setcapindent{0pt}%
+ \begin{captionbeside}[{Example: letter with extended sender, logo,
+ addressee, additional sender information, place, date, subject,
+ opening, text, closing, modified signature, postscript, distribution
+ list, enclosure, and puncher hole mark using a \File{lco}-file}]
+ {result of a small letter with extended sender, logo, addressee,
+ additional sender information, place, date, subject opening, text,
+ closing, modified signature, postscript, distribution list, enclosure
+ and puncher hole mark using a \File{lco}-file}[l]
+ \frame{\includegraphics[width=.4\textwidth]{letter-23}}
+ \end{captionbeside}
+ \label{fig:scrlttr2.letter-23}
+ \end{figure}
\end{Example}
+
+Please note\textnote{Attention!} that immediately after loading the
+document class normally neither a package for the input encoding nor a
+language package has been loaded. Because of this, you should use \TeX's 7-bit
+encoding for all characters, e.\,g., use ``\Macro{ss}'' to produce a German
+``\ss''.
+
+In \autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles} you can find a list of
+all predefined \File{lco} files. If\textnote{Attention!} you use a printer
+that has large unprintable areas on the left or right side, you might have
+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
+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
+value. Additionally, also reduce \PLength{toaddrwidth} accordingly.%
+
+By\textnote{Hint!} the way, the \File{DIN} \File{lco}-file will always be
+loaded as the first \File{lco} file. This ensures that all pseudo-lengths will
+have more or less reasonable default values. Because of this, it is not
+necessary to load this default file on your own.
+
+Please\textnote{Attention!} note that it is not possible to use
+\Macro{PassOptionsToPackage} to pass options to packages from within an
+\File{lco}-file that have already been loaded by the class. Normally, this
+only applies to the \Package{typearea}, \Package{scrlfile}, \Package{scrbase},
+and \Package{keyval} packages.%
+
+\begin{desclist}
+ \renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}%
+ \desccaption{%
+ predefined \File{lco}-files\label{tab:lcoFiles}%
+ }{%
+ predefined \File{lco}-files (\emph{continuation})%
+ }%
+ \oentry{DIN}{%
+ parameter set for letters on A4-size paper, complying with German standard
+ DIN~676; suitable for window envelopes in the sizes C4, C5, C6, and C6/5
+ (C6 long).}%
+ \oentry{DINmtext}{%
+ parameter set for letters on A4-size paper, complying with DIN~676, but
+ using an alternate layout with more text on the first page; only suitable
+ for window envelopes in the sizes C6 and C6/5 (C6 long).}%
+ \oentry{KakuLL}{%
+ parameter set for Japanese letters in A4 format; suitable for Japanese
+ window envelopes of type Kaku A4, in which the windows is approximately
+ 90\Unit{mm} wide, 45\Unit{mm} high, and positioned 25\Unit{mm} from the
+ left and 24\Unit{mm} from the top edge (see \autoref{cha:japanlco}).}%
+ \oentry{KOMAold}{%
+ parameter set for letters on A4-size paper using a layout close to the now
+ obsolete \Class{scrlettr} letter class; suitable for window envelopes in
+ the sizes C4, C5, C6, and C6/5 (C6 long); some additional commands to
+ improve compatibility with obsolete \Class{scrlettr} commands are defined;
+ \Class{scrlttr2} may behave slightly different when used with this
+ \File{lco}-file than with the other \File{lco}-files.}%
+ \oentry{NF}{%
+ parameter set for French letters, according to NF~Z~11-001; suitable for
+ window envelopes of type DL (110\Unit{mm} to 220\Unit{mm}) with a window
+ of about 20\Unit{mm} from right and bottom with width 45\Unit{mm} and
+ height 100\Unit{mm}; this file was originally developed by Jean-Marie
+ Pacquet, who provides an extended version and additional information on
+ \cite{www:NF.lco}.}%
+ \oentry{NipponEH}{%
+ parameter set for Japanese letters in A4 format; suitable for Japanese
+ window envelopes of types Chou or You 3 or 4, in which the windows is
+ approximately 90\Unit{mm} wide, 55\Unit{mm} high, and positioned
+ 22\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
+ \autoref{cha:japanlco}).}%
+ \oentry{NipponEL}{%
+ parameter set for Japanese letters in A4 format; suitable for Japanese
+ window envelopes of types Chou or You 3 or 4, in which the windows is
+ approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned
+ 22\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
+ \autoref{cha:japanlco}).}%
+ \oentry{NipponLH}{%
+ parameter set for Japanese letters in A4 format; suitable for Japanese
+ window envelopes of types Chou or You 3 or 4, in which the windows is
+ approximately 90\Unit{mm} wide, 55\Unit{mm} high, and positioned
+ 25\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
+ \autoref{cha:japanlco}).}%
+ \oentry{NipponLL}{%
+ parameter set for Japanese letters in A4 format; suitable for Japanese
+ window envelopes of types Chou or You 3 or 4, in which the windows is
+ approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned
+ 25\Unit{mm} from the left and 12\Unit{mm} from the top edge (see
+ \autoref{cha:japanlco}).}%
+ \oentry{NipponRL}{%
+ parameter set for Japanese letters in A4 format; suitable for Japanese
+ window envelopes of types Chou or You 3 or 4, in which the windows is
+ approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned
+ 25\Unit{mm} from the left and 24\Unit{mm} from the top edge (see
+ \autoref{cha:japanlco}).}%
+ \oentry{SN}{%
+ parameter set for Swiss letters with address field on the right side,
+ according to SN~010\,130; suitable for Swiss window envelopes in the sizes
+ C4, C5, C6, and C6/5 (C6 long).}%
+ \oentry{SNleft}{%
+ parameter set for Swiss letters with address field on the left side;
+ suitable for Swiss window envelopes with window on the left side in the
+ sizes C4, C5, C6, and C6/5 (C6 long).}%
+ \oentry{UScommercial9}{%
+ parameter set for US-American letters with paper size letter; suitable for
+ US-American window envelopes of size \emph{commercial~No.\,9} with window
+ width of 4\,1/2\Unit{in}, height of 1\,1/8\Unit{in}, and position of
+ 7/8\Unit{in} from the left and 1/2\Unit{in} from the bottom, without
+ sender's return address inside of the window; with folding it first at the
+ puncher mark then at the top folder mark also legal paper may be used but
+ would result in a page size warning}%
+ \oentry{UScommercial9DW}{%
+ parameter set for US-American letters with paper size letter; suitable for
+ US-American window envelopes of size \emph{commercial~No.\,9} with
+ addressee's window width of 3\,5/8\Unit{in}, height of 1\,1/8\Unit{in},
+ and position of 3/4\Unit{in} from the left and 1/2\Unit{in} from the
+ bottom, and with a sender's window width of 3\,1/2\Unit{in}, height of
+ 7/8\Unit{in}, and position of 5/16\Unit{in} from the left and
+ 2\,1/2\Unit{in} from the bottom, but without a sender's return address at
+ any of the windows; with folding it first at the puncher mark then at the
+ top folder mark also legal paper may be used but would result in a page
+ size warning}%
+\end{desclist}
%
-\EndIndex{Cmd}{providecaptionname}%
-\EndIndex{Cmd}{newcaptionname}%
-\EndIndex{Cmd}{renewcaptionname}%
+\EndIndex{Cmd}{LoadLetterOption}%
%
-\EndIndex{}{language}%
-\EndIndex{}{language>-dependent terms}%
-\EndIndex{}{terms>language-dependent}
-
-\section{Address Files and Circular Letters}
-\label{sec:scrlttr2.addressFile}
-\BeginIndex{}{address>file}\BeginIndex{}{circular letters}%
+\EndIndex{}{lco-file=\File{lco}-file}%
+\EndIndex{}{letter class option}%
+\EndIndex{}{letter>class option}%
-When people write circular letters one of the more odious tasks is the
-typing of many different addresses. The class \Class{scrlttr2}, as
-did its predecessor \Class{scrlettr} as well, provides basic support
-for this task. Currently there are plans for much enhanced support.
-\typeout{^^J--- Ignore underfull and overfull \string\hbox:}%
-\begin{Declaration}
- \Macro{adrentry}\Parameter{Lastname}\Parameter{Firstname}%
- \Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}%
- \Parameter{Comment}\Parameter{Key}
+\section{Address Files and Circular Letters}
+\label{sec:scrlttr2.addressFile}%
+\BeginIndex{}{address>file}%
+\BeginIndex{}{circular letters}%
+\index{serial letters|see circular letters}%
+
+When people write circular letters one of the more odious tasks is the typing
+of many different addresses. The class \Class{scrlttr2}%
+\iffalse% Umbruchkorrekturtext
+, as did its predecessor \Class{scrlettr} as well,%
+\fi%
+\ provides basic support for this task.%
+\iffalse% Umbruchkorrekturtext
+\ Currently there are plans for much enhanced support.%
+\fi
+
+\begin{Declaration}
+ \Macro{adrentry}\Parameter{last-name}\Parameter{first-name}%
+ \Parameter{address}\Parameter{phone}\Parameter{F1}\Parameter{F2}%
+ \Parameter{comment}\Parameter{key}
\end{Declaration}%
-\typeout{^^J--- Don't ignore underfull and overfull \string\hbox:}
-\BeginIndex{Cmd}{adrentry}
-\label{decl:adrentry}
-
+\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
\Macro{adrentry} command with eight parameters, for example:
-\begin{lstlisting}
+\begin{lstcode}
\adrentry{McEnvy}
{Flann}
{Main Street 1\\ Glasgow}
@@ -3802,28 +3191,27 @@ extension of the address file has to be \File{.adr}. Each entry is an
{}
{niggard}
{FLANN}
-\end{lstlisting}
-The 5\textsuperscript{th} and 6\textsuperscript{th} elements,
-\PValue{F1} and \PValue{F2}, can be used freely: for example, for the
-gender, the academic grade, the birthday, or the date on which the
-person joined a society. The last parameter \PName{Key} should only
-consist of uppercase letters in order to not interfere with existing
-{\TeX} or {\LaTeX} commands.
+\end{lstcode}
+The 5\textsuperscript{th} and 6\textsuperscript{th} elements, \PValue{F1} and
+\PValue{F2}, can be used freely: for example, for the gender, the academic
+grade, the birthday, or the date on which the person joined a society. The
+last parameter \PName{key} should only consist of more than one uppercase
+letters in order to not interfere with existing {\TeX} or {\LaTeX} commands.
\begin{Example}
- Mr.\,McEnvy is one of your most important business partners, but
+ Mr McEnvy is one of your most important business partners, but
every day you receive correspondence from him. Before long you do
not want to bother typing his boring address again and again. Here
\Class{scrlttr2} can help. Assume that all your business partners
have an entry in your \File{partners.adr} address file. If you now
- have to reply to Mr.\,McEnvy again, then you can save typing as
+ have to reply to Mr~McEnvy again, then you can save typing as
follows:
- \begin{lstlisting}
+ \begin{lstcode}
\input{partners.adr}
\begin{letter}{\FLANN}
Your correspondence of today \dots
\end{letter}
- \end{lstlisting}
+ \end{lstcode}
Your {\TeX} system must be configured to have access to your address
file. Without access, the \Macro{input} command results in an
error. You can either put your address file in the same directory
@@ -3833,29 +3221,26 @@ consist of uppercase letters in order to not interfere with existing
%
\EndIndex{Cmd}{adrentry}
-\typeout{^^J--- Ignore underfull and overfull \string\hbox:}%
\begin{Declaration}
- \Macro{addrentry}\Parameter{Lastname}\Parameter{Firstname}%
- \Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}%
- \Parameter{F3}\Parameter{F4}\Parameter{Key}
+ \Macro{addrentry}\Parameter{last-name}\Parameter{first-name}%
+ \Parameter{address}\Parameter{phone}\Parameter{F1}\Parameter{F2}%
+ \Parameter{F3}\Parameter{F4}\Parameter{key}
\end{Declaration}%
-\typeout{^^J--- Dont't ignore underfull and overfull \string\hbox:}
\BeginIndex{Cmd}{addrentry}%
-Over the years people have objected that the \Macro{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}.
-
-Both \Macro{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 \File{adr} files,
-but it has currently no support for command \Macro{addrentry}. In
-this case, the only choice is to extend the package yourself.
+Over the years people have objected that the \Macro{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}.
+
+Both \Macro{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
+\File{adr} files, but it has currently no support for command
+\Macro{addrentry}. In this case, the only choice is to extend the package
+yourself.%
%
\EndIndex{Cmd}{addrentry}
@@ -3866,30 +3251,30 @@ requirement to access a complicated database system via {\TeX}.
\begin{Example}
Suppose you are member of a society and want write an invitation for
the next general meeting to all members.
- \begin{lstlisting}
- \documentclass{scrlttr2}
- \begin{document}
- \renewcommand*{\adrentry}[8]{
- \begin{letter}{#2 #1\\#3}
- \opening{Dear members,} Our next general meeting will be on
- Monday, August 12, 2002. The following topics are \dots
- \closing{Regards,}
- \end{letter}
- }
- \input{members.adr}
+\begin{lstcode}
+ \documentclass{scrlttr2}
+ \begin{document}
+ \renewcommand*{\adrentry}[8]{
+ \begin{letter}{#2 #1\\#3}
+ \opening{Dear members,} Our next general meeting will be on
+ Monday, August 12, 2002. The following topics are \dots
+ \closing{Regards,}
+ \end{letter}
+ }
+ \input{members.adr}
\end{document}
-\end{lstlisting}
-If the address file contains \Macro{addrentry} commands too, than an
-additional definition for \Macro{addrentry} is required before loading
-the address file:
-\begin{lstlisting}
+\end{lstcode}
+ If the address file contains \Macro{addrentry} commands too, than an
+ additional definition for \Macro{addrentry} is required before loading
+ the address file:
+\begin{lstcode}
\renewcommand*{\addrentry}[9]{%
\adrentry{#1}{#2}{#3}{#4}{#5}{#6}{#7}{#9}%
}
-\end{lstlisting}
-In this simple example the extra freely-definable parameter is not
-used, and therefore \Macro{addrentry} is defined with the help of
-\Macro{adrentry}.
+\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}.
\end{Example}
With some additional programming one can let the content of the
@@ -3903,7 +3288,7 @@ the \Macro{adrentry} and and \Macro{addrentry} commands can be used.
has not yet been paid by the member. If you would like to write a
more personal reminder to each such member, then the next example
can help you:
-\begin{lstlisting}
+\begin{lstcode}
\renewcommand*{\adrentry}[8]{
\ifdim #6pt>0pt\relax
% #6 is an amount greater than 0.
@@ -3921,32 +3306,32 @@ the \Macro{adrentry} and and \Macro{addrentry} commands can be used.
\end{letter}
\fi
}
-\end{lstlisting}
+\end{lstcode}
\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.
+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.
+
\begin{Declaration}
\Macro{adrchar}\Parameter{initial letter}\\
\Macro{addrchar}\Parameter{initial letter}
\end{Declaration}
-\BeginIndex{Cmd}{adrchar}\BeginIndex{Cmd}{addrchar}
+\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 \Package{adrconv} by Axel Kielhorn (see
-\cite{package:adrconv}) is needed. This package contains interactive
-{\LaTeX} documents which help to create those lists.
+As already mentioned above, it is possible to create address and telephone
+lists using \File{adr} files. For that, the additional package
+\Package{adrconv} by Axel Kielhorn (see \cite{package:adrconv}) is needed.
+This package contains interactive {\LaTeX} documents which help to create
+those lists.
The address files have to be sorted already in order to obtain sorted
-lists. It is recommended to separate the sorted entries at each
-different initial letter of \PName{Lastname}. As a separator, the
-commands \Macro{adrchar} and \Macro{addrchar} can be used.. These
-commands will be ignored if the address files are utilized in
-\Class{scrlettr2}.
+lists. It is recommended to separate the sorted entries at each different
+initial letter of \PName{last name}. As a separator, the commands
+\Macro{adrchar} and \Macro{addrchar} can be used. These commands will be
+ignored if the address files are utilized in \Class{scrlettr2}.
%
\begin{Example}
Suppose you have the following short address file:
@@ -3995,114 +3380,26 @@ commands will be ignored if the address files are utilized in
command. The definition can be found in \File{adrdir.tex}.
\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}.
+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}.%
%
-\EndIndex{Cmd}{adrchar}\EndIndex{Cmd}{addrchar}%
+\EndIndex{Cmd}{adrchar}%
+\EndIndex{Cmd}{addrchar}%
%
-\EndIndex{}{address>file}\EndIndex{}{circular letters}%
-
-\section{From \Class{scrlettr} to \Class{scrlttr2}}
-\label{sec:scrlttr2.fromscrlettr}
-
-The first step in the conversion of an old letter written with the
-\Class{scrlettr} class is to load the appropriate \File{lco} file
-using option \Option{KOMAold} at \Macro{documentclass}. Thereupon
-most commands of the old class should work. However, you will
-encounter some differences in the output, since the page layout of the
-old class is not realized exactly. The reason is that the calculation
-of the type area in \Class{scrlettr} has some minor bugs. For example,
-the position of the folding marks used to depend on the height of the
-page header, which again depended on the font size. That was
-unambiguously a design error.
-
-There is no compatibility regarding the defined lengths in
-\Class{scrlettr}. Thus, if a user has changed the page layout of
-\Class{scrlettr}, then the relevant statements should be deleted or
-commented out. In some cases, the modification of a length can cause
-an error, since this length is no longer defined in \Class{scrlttr2}.
-The user should delete or comment out such modifications as well.
-
-After the switch from \Class{scrlettr} to \Class{scrlttr2}, the old
-letter example can be successfully compiled already alone through the
-setting of the option \Option{KOMAold}:
-\begin{lstlisting}
- \documentclass[10pt,KOMAold]{scrlttr2}
- \name{{\KOMAScript} team}
- \address{Class Alley 1\\12345 {\LaTeX} City}
- \signature{Your {\KOMAScript} team}
- \begin{document}
- \begin{letter}{{\KOMAScript} users\\
- Everywhere\\world-wide}
- \opening{Dear {\KOMAScript} users,}
- the {\KOMAScript} team is proud to announce \dots
- \closing{Happy {\TeX}ing}
- \end{letter}
- \end{document}
-\end{lstlisting}
-
-The next step is that while wanting the old commands to be still be
-available, the layout of the old letter should no longer be used. If,
-for example, one wants to sue the layout of the letter class option
-\Option{DIN}, then this option can be given in \Macro{documentclass},
-but is has to be specified \emph{after} the option \Option{KOMAold}:
-
-\begin{lstlisting}
- \documentclass[10pt,KOMAold,DIN]{scrlttr2}
- \name{{\KOMAScript} team}
- \address{Class Alley 1\\12345 {\LaTeX} City}
- \signature{Your {\KOMAScript} team}
- \begin{document}
- \begin{letter}{{\KOMAScript} users\\
- Everywhere\\world-wide}
- \opening{Dear {\KOMAScript} users,}
- the {\KOMAScript} team is proud to announce \dots
- \closing{Happy {\TeX}ing}
- \end{letter}
- \end{document}
-\end{lstlisting}
-By using more options this way, you can further influence the
-layout. However, the author recommends a more inherent change right
-away.
-
-The last step is to replace all old commands with their new
-equivalents, and to omit the option \Option{KOMAold}. For this task,
-it may help to read the contents of \File{KOMAold.lco}. In that file
-the old commands are defined using the new commands and variables.
-
-\begin{lstlisting}
- \documentclass{scrlttr2}
- \setkomavar{fromname}{{\KOMAScript} team}
- \setkomavar{fromaddress}{Class Alley 1\\
- 12345 {\LaTeX} City}
- \setkomavar{signature}{Your {\KOMAScript} team}
- \let\raggedsignature=\raggedright
- \begin{document}
- \begin{letter}{{\KOMAScript} users\\
- Everywhere\\
- world-wide}
- \opening{Dear {\KOMAScript} users,}
- the {\KOMAScript} team is proud to announce \dots
- \closing{Happy {\TeX}ing}
- \end{letter}
- \end{document}
-\end{lstlisting}
-This example shows also the possibility to change the alignment of the
-signature by redefining the command \Macro{raggedsignature}. This is
-always recommended when the width of the explanation of the signature as
-defined by the command
-\Macro{setkomavar}\PParameter{signature}\PParameter{\dots} is greater than the
-width of the argument of \Macro{closing}.
+\EndIndex{}{circular letters}%
+\EndIndex{}{address>file}%
%
-\EndIndex{Class}{scrlttr2}\EndIndex{}{letters}
+\EndIndex{Class}{scrlttr2}%
+\EndIndex{}{letters}%
+
%%% Local Variables:
%%% mode: latex
-%%% coding: iso-latin-1
+%%% coding: us-ascii
%%% TeX-master: "../guide"
%%% End:
-% LocalWords: scrlttr simpleSwitchValues afteropening beforeopening
-% LocalWords: locfield
+% LocalWords: scrlttr simpleSwitchValues afteropening beforeopening Combinable
+% LocalWords: locfield Hennig Kohm