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.tex129
1 files changed, 78 insertions, 51 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 f6353972ce1..bda60ec0e3a 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-2014
+% Copyright (c) Markus Kohm, 2002-2015
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-2014
+% Copyright (c) Markus Kohm, 2002-2015
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,13 +46,13 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2.tex}%
- [$Date: 2014-10-07 08:53:12 +0200 (Tue, 07 Oct 2014) $
+ [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
KOMA-Script guide (chapter: scrlttr2)]
\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe
Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm}
-% Date of translated german file: 2014/10/07
+% Date of translated german file: 2015-03-31
\chapter{The New Letter Class \Class{scrlttr2}}
\labelbase{scrlttr2}
@@ -77,7 +77,7 @@ users will benefit from its advantages.
\section{Variables}
-\label{sec:scrlttr2.variables}%
+\seclabel{variables}%
\BeginIndex{}{variables}
Apart from options, commands, environments, counters and lengths,
@@ -394,7 +394,7 @@ the unstarred variant handles the contents.%
\section{Pseudo-Lengths}
-\label{sec:scrlttr2.pseudoLength}
+\seclabel{pseudoLength}
\BeginIndex{}{pseudo-lengths}
\LaTeX{} processes length with commands \Macro{newlength}, \Macro{setlength},
@@ -495,7 +495,7 @@ description of \Macro{raggedbottom} and \Macro{flushbottom} in
\section{General Structure of Letter Documents}
-\label{sec:scrlttr2.document}
+\seclabel{document}
\BeginIndex{}{letter>structure}
The general structure of a letter document differs somewhat from the
@@ -938,7 +938,7 @@ and content of the variable
\LoadCommon[scrlttr]{5} % \section{Text Markup}
\section{Note Paper}
-\label{sec:scrlttr2.firstpage}
+\seclabel{firstpage}
\BeginIndex{}{note paper}%
\BeginIndex{}{letter>first page}
@@ -1604,7 +1604,9 @@ 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
+is \PValue{true}. With values \PValue{true},
+\PValue{topaligned}\ChangedAt{v3.17}{\Class{scrlttr2}\and
+ \Package{scrletter}}, \PValue{PP}, and
\PValue{backgroundimage} name and address of the addressee will be defined by
the mandatory argument of the \Environment{letter} environment (see
\autoref{sec:scrlttr2.document},
@@ -1631,18 +1633,6 @@ define modifications from the \FontElement{addressee} configuration.%
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},
@@ -1650,11 +1640,28 @@ define modifications from the \FontElement{addressee} configuration.%
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{false}, \PValue{off}, \PValue{no}}{%
+ Omits the address field.}%
\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.}%
+ \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{topaligned}, \PValue{alignedtop}%
+ \ChangedAt{v3.17}{\Class{scrlttr2}\and \Package{scrletter}}}{%
+ Prints an address field including a return address and a mode of
+ dispatch or priority without centring the address vertically in the
+ available space.}%
+ \entry{\PValue{true}, \PValue{on}, \PValue{yes}}{%
+ Prints an address field including a return address and a mode of
+ dispatch or priority.}%
\end{desctabular}
\end{table}%
@@ -1686,7 +1693,14 @@ 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}%
-%
+
+By default, \OptionValue{addrfield}{true}, the address will be vertically
+centred in the available space below the mode of dispatch or
+priority. In\ChangedAt{v3.17}{\Class{scrlttr2}\and \Package{scrletter}}
+opposite to this, \OptionValue{addrfield}{topaligned}%
+\important{\OptionValue{addrfield}{topaligned}} will not centre the address
+but follow it aligned top at the available space. This is the only difference
+to \OptionValue{addrfield}{true}.%
\EndIndex{Variable}{backaddressseparator}%
\EndIndex{Variable}{backaddress}%
\EndIndex{Option}{backaddress~=\PName{value}}%
@@ -1995,7 +2009,7 @@ the date using option \Option{refline}, that will be described next.
\KOption{refline}\PName{selection}
\end{Declaration}
\BeginIndex{}{reference line}%
-\index{business line|see{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
@@ -2190,17 +2204,24 @@ commands \Macro{setkomafont} and \Macro{addtokomafont} (see
\end{Declaration}
\BeginIndex{}{title}%
\BeginIndex{Variable}{title}%
+\BeginIndex{FontElement}{lettertitle}%
\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
+\FontElement{lettertitle}\important{\FontElement{lettertitle}} can be changed
+with commands \Macro{setkomafont} und \Macro{addtokomafont} (see
\autoref{sec:scrlttr2.textmarkup},
\autopageref{desc:scrlttr2.cmd.setkomafont}). Font size declarations are
-allowed. Font size \Macro{Large} is not part of the predefined default
+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.
+used before the font style of the element. With \Class{scrlttr2} you can also
+use \FontElement{title}\important{\FontElement{title}} as an alias of
+\FontElement{lettertitle}. This is not provided using \Package{scrletter} with
+a \KOMAScript{} class, because these classes already define an element
+\FontElement{title} with different meaning for the document title.%
+\EndIndex{FontElement}{title}%
+\EndIndex{FontElement}{lettertitle}%
\begin{Example}
Assume that you are to write a reminder. Thus you put as title:
\begin{lstlisting}
@@ -2211,7 +2232,6 @@ used before the font style of the element.
Like shown in the example, the \PName{content} of the variable defines the
title. \KOMAScript{} will not use the \PName{description}.%
%
-\EndIndex{FontElement}{title}%
\EndIndex{Variable}{title}%
\EndIndex{}{title}%
@@ -2300,15 +2320,21 @@ the while subject must fit at one line! Defaults are
\end{captionbeside}
\end{table}
+\BeginIndex{FontElement}{lettersubject}%
\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}.%
+\autopageref{desc:scrlttr2.cmd.setkomafont}). For element
+\FontElement{lettersubject}\important{\FontElement{lettersubject}} the
+predetermined font is \Macro{normalcolor}\Macro{bfseries}. With
+\Class{scrlttr2} you can also use
+\FontElement{subject}\important{\FontElement{subject}} as an alias of
+\FontElement{lettersubject}. This is not provided using \Package{scrletter}
+with a \KOMAScript{} class, because these classes already define an element
+\FontElement{subject} with different meaning for the document title.%
\EndIndex{FontElement}{subject}%
-
+\EndIndex{FontElement}{lettersubject}%
\begin{Example}
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
@@ -2460,7 +2486,7 @@ suffice. In that case, you may need to reduce \PLength{firstfootvpos} (see
\section{Head and Foot Using Predefined Page Style}
-\label{sec:scrlttr2.pagestyle}
+\seclabel{pagestyle}
\BeginIndex{}{page>style}%
\BeginIndex{}{page>head}%
\BeginIndex{}{page>foot}%
@@ -2492,17 +2518,17 @@ 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} does not influence page styles
-\PValue{empty}\important[i]{\Pagestyle{empty}\\
- \Pagestyle{plain}} and \PValue{plain} (see afterwards at this
-section). These page styles explicitly do not use any page head.
+Obviously option \Option{headsepline} does not influence page style
+\PValue{empty}\important[i]{\Pagestyle{empty}} (see afterwards at this
+section). This page style explicitly does not use any page head.
Typographically\important[i]{\Pagestyle{headings}\\
- \Pagestyle{myheadings}} such a rule make a hard optical connection of head
-or foot and the text area. This would not mean, that the distance between head
-and text or text and foot should be increased. Instead of this the head or
-foot should be seen as parts of the typing area, while calculation of margins
-and typing area. To achieve this \KOMAScript{} will pass option
+ \Pagestyle{myheadings}\\\Pagestyle{plain}} such a rule make a hard optical
+connection of head or foot and the text area. This would not mean, that the
+distance between head and text or text and foot should be increased. Instead
+of this the head or foot should be seen as parts of the typing area, while
+calculation of margins and typing area. To achieve this \KOMAScript{} will
+pass option
\Option{headinclude}\important[i]{\Opton{headinclude}\\
\Option{footinclude}} or \Option{footinclude}, respectively, to the
\Package{typearea} package, if option \Option{headsepline} or
@@ -2510,9 +2536,10 @@ and typing area. To achieve this \KOMAScript{} will pass option
option. In\important{\Pagestyle{plain}} opposite to \Option{headsepline}
option \Option{footsepline} does influence page style \PValue{plain} also,
because \PValue{plain} uses a page number at the foot. Package
-\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}\important{\Package{scrlayer-scrpage}}
-(see \autoref{cha:scrlayer-scrpage}) provides additional features for rules at
-head and foot and may be combined with \Class{scrlttr2}.%
+\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}%
+\important{\Package{scrlayer-scrpage}} (see \autoref{cha:scrlayer-scrpage})
+provides additional features for rules at head and foot and may be combined
+with \Class{scrlttr2}.%
%
\EndIndex{Option}{headsepline~=\PName{simple switch}}%
\EndIndex{Option}{footsepline~=\PName{simple switch}}%
@@ -2650,7 +2677,7 @@ page number within the header or footer is named
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}.
+\autopageref{example:maincls.pagestyle}.
%
\EndIndex{FontElement}{pagenumber}%
\EndIndex{FontElement}{pagefoot}%
@@ -2736,7 +2763,7 @@ those.%
\section{Math}
-\label{sec:scrlttr2.math}%
+\seclabel{math}%
\BeginIndex{}{equations}%
\BeginIndex{}{formulas}%
\BeginIndex{}{mathematics}%
@@ -2763,7 +2790,7 @@ recommended (see \cite{package:amsmath}).%
\EndIndex{}{equations}
\section{Floating Environments of Tables and Figures}
-\label{sec:scrlttr2.floats}
+\seclabel{floats}
Floating environments for tables or figures are very unusual in
letters. Therefore\textnote{Attention!} \Class{scrlttr2} does not provide
@@ -2779,7 +2806,7 @@ without floating environment may still be done with the letter class
\section{Closing}
-\label{sec:scrlttr2.closing}
+\seclabel{closing}
\BeginIndex{}{closing}%
\BeginIndex{}{letter>closing}%
\BeginIndex{}{signature}%
@@ -2860,7 +2887,7 @@ command can be redefined in the same way as \Macro{raggedsection} (see
\section{Letter Class Option Files}
-\label{sec:scrlttr2.lcoFile}%
+\seclabel{lcoFile}%
\BeginIndex{}{lco-file=\File{lco}-file}%
\BeginIndex{}{letter class option}%
\BeginIndex{}{letter>class option}%
@@ -3111,7 +3138,7 @@ and \Package{keyval} packages.%
\section{Address Files and Circular Letters}
-\label{sec:scrlttr2.addressFile}%
+\seclabel{addressFile}%
\BeginIndex{}{address>file}%
\BeginIndex{}{circular letters}%
\index{serial letters|see circular letters}%