summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex147
1 files changed, 114 insertions, 33 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
index efeb9ed247e..639e64fa792 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2-experts.tex
-% Copyright (c) Markus Kohm, 2002-2013
+% 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-experts.tex
-% Copyright (c) Markus Kohm, 2002-2013
+% 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-experts.tex}
- [$Date: 2014-12-17 08:42:06 +0100 (Wed, 17 Dec 2014) $
+ [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
KOMA-Script guide (chapter: scrlttr2 for experts)]
\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe
Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm}
-% Date of the translated German file: 2014/12/16
+% Date of the translated German file: 2015-03-31
\chapter{Additional Information about the Letter Class
\Class{scrlttr2} and the Letter Package \Package{scrletter}}
@@ -82,7 +82,7 @@ described later in this section.%
\section{Pseudo-Lengths for Experienced Users}
-\label{sec:scrlttr2-experts.pseudoLengths}
+\seclabel{pseudoLengths}
\BeginIndex{}{pseudo-lengths}
{\TeX} works with a fixed number of registers. There are registers for tokens,
@@ -425,7 +425,7 @@ but can, for example, be used within an \File{lco}-file.\iffree{}{
\subsection{Folding Marks}
-\label{sec:scrlttr2-experts.foldmarks}
+\seclabel{foldmarks}
\index{marks>folding|see{folding marks}}
\BeginIndex{}{folding marks}%
@@ -578,7 +578,7 @@ changed, this can be too thin!%
\subsection{Letterhead}
-\label{sec:scrlttr2-experts.firstHead}
+\seclabel{firstHead}
\BeginIndex{}{letterhead}
The term letterhead here refers to all of the data pertaining to the sender
@@ -674,7 +674,7 @@ the line\ChangedAt{v2.97c}{\Class{scrlttr2}}, \PLength{fromrulethickness}, is
\subsection{Addressee}
-\label{sec:scrlttr2-experts.addressee}%
+\seclabel{addressee}%
\BeginIndex{}{addressee}
\index{address|seealso{addressee}}
@@ -879,7 +879,7 @@ head.%
\subsection{Sender's Extensions}
-\label{sec:scrlttr2-experts.locationField}
+\seclabel{locationField}
\BeginIndex{}{sender's extension}
\index{sender>extension|see{sender's extension}}
@@ -926,7 +926,7 @@ left edge of the paper. The meaning is thus the opposite to that of
\subsection{Business Line}
-\label{sec:scrlttr2-experts.refLine}%
+\seclabel{refLine}%
\BeginIndex{}{business line}
\index{reference>field line|see{business line}}
\index{reference>line|see{business line}}
@@ -1016,7 +1016,7 @@ between one and two lines.%
\EndIndex{}{business line}%
\subsection{Subject}
-\label{sec:scrlttr2-experts.subject}%
+\seclabel{subject}%
\BeginIndex{}{subject}
In different countries the letter's subject will be set different. Some like
@@ -1075,7 +1075,7 @@ default for the space after the subject is two lines.%
\subsection{Closing}
-\label{sec:scrlttr2-experts.closing}
+\seclabel{closing}
\BeginIndex{}{closing}
The closing consists of three parts: besides the closing phrase there
@@ -1109,9 +1109,9 @@ this is set to two lines. In this space you can then write your inscription.%
\subsection{Letter Footer}
-\label{sec:scrlttr2-experts.firstFoot}%
+\seclabel{firstFoot}%
\BeginIndex{}{letter>footer}%
-\index{note paper>footer|see{letter footer}}
+\index{note paper>footer|see{letter footer}}%|
As the first page of a letter, the note paper, holds a letterhead of its own,
@@ -1199,7 +1199,7 @@ value is set equal to that of the pseudo-length
\EndIndex{}{pseudo-lengths}%
\section{Variables for Experienced Users}
-\label{sec:scrlttr2-experts.variables}
+\seclabel{variables}
\BeginIndex{}{variables}
\KOMAScript{} provides beside the feature of using predefined variable also
@@ -1325,29 +1325,110 @@ to be used as the argument of, e.\,g., \Macro{markboth} or \Macro{footnote}.%
\section{Differences in the Page Styles of \Package{scrletter}}
-\label{sec:scrlttr2-experts.pagestyleatscrletter}
+\seclabel{pagestyleatscrletter}
\BeginIndex{Package}{scrletter}
\BeginIndex{}{page>style}
-\BeginIndex{Pagestyle}{letter}
As described in \autoref{sec:scrlttr2.pagestyle}, the page style
\Pagestyle{headings} shows the content of variables \Variable{nexthead} and
\Variable{nextfoot}. Page style \Pagestyle{headings} has already another
meaning in the \KOMAScript{} classes \Class{scrbook}, \Class{scrreprt}, and
-\Class{scrartcl}. Therefore \Package{scrletter} defines page
-style\ChangedAt{v3.15}{\Package{scrletter}} \Pagestyle{letter} instead. The
-definition is done using package
-\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}. Hence,
-you cannot use the outdated packages \Package{scrpage2}\IndexPackage{scrpage2}
-and \Package{scrpage} or package \Package{fancyhdr}\IndexPackage{fancyhdr}
-with \Package{scrletter}.%
-%
-\EndIndex{Pagestyle}{letter}
+\Class{scrartcl}. Therefore \Package{scrletter} defines a new pair of page
+styles (see \autoref{sec:scrlayer-scrpage-experts.pagestyle.pairs},
+\autopageref{sec:scrlayer-scrpage-experts.pagestyle.pairs}). The definition
+is done using package
+\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}.
+
+Hence, you cannot use \Package{scrletter} with the outdated packages
+\Package{scrpage2}\IndexPackage{scrpage2} and
+\Package{scrpage}\IndexPackage{scrpage}. Same applies to
+\Package{fancyhdr}\IndexPackage{fancyhdr} that is in general not recommended
+for use with \KOMAScript. Additionally, internally loading package
+\Package{scrlayer-scrpage} automatically activates page style
+\Pagestyle{scrheadings}\IndexPagestyle{scrheadings}. This activation
+changes page styles \Pagestyle{headings} and \Pagestyle{plain} into aliases of
+\Pagestyle{scrheadings} and \Pagestyle{plain.scrheadings}. So these page
+styles are also controlled by \Package{scrlayer-scrpage}.
+
+\begin{Declaration}
+ \XMacro{pagestyle}\PParameter{\Pagestyle{letter}}\\
+ \XMacro{pagestyle}\PParameter{\Pagestyle{plain.letter}}\\
+ \XMacro{setkomavar}\PParameter{\Variable{nexthead}}%
+ \OParameter{description}\Parameter{content}\\
+ \XMacro{setkomavar}\PParameter{\Variable{nextfoot}}%
+ \OParameter{description}\Parameter{content}
+\end{Declaration}
+\BeginIndex{Pagestyle}{letter}%
+\BeginIndex{Pagestyle}{plain.letter}%
+\BeginIndex{Variable}{nexthead}%
+\BeginIndex{Variable}{nextfoot}%
+Package \Package{scrletter} defines the pair of page style \Pagestyle{letter}
+using \Package{scrlayer-scrpage} to become independent from the page styles of
+the document class. Variables \Variable{nexthead} and \Variable{nextfoot} are
+used by \Package{scrletter}'s \Pagestyle{letter} in the same way as for
+\Class{scrlttr2}'s \Pagestyle{headings}. The corresponding \Pagestyle{plain}
+page style is also similar to \Class{scrlttr2}'s page style
+\Pagestyle{plain}. Notably the position of the page number depends on option
+\Option{pagenumber}\IndexOption{pagenumber} (see
+\autopageref{desc:scrlttr2.option.pagenumber}).%
+\EndIndex{Variable}{nextfoot}%
+\EndIndex{Variable}{nexthead}%
+\EndIndex{Pagestyle}{plain.letter}%
+\EndIndex{Pagestyle}{letter}%
+
+\begin{Declaration}
+ \Option{headsepline}\\
+ \Option{footsepline}
+\end{Declaration}
+\BeginIndex{Option}{headsepline}%
+\BeginIndex{Option}{footsepline}%
+Because of the different internal approach of \Package{scrletter}, the options
+\Option{headsepline}\important[i]{\Option{headsepline}\\%
+ \Option{footsepline}} and \Option{footsepline} differ slightly from
+class \Class{scrlttr2}, because they are controlled by package
+\Package{scrlayer-scrpage}. Especially the horizontal lines in page head and
+foot of the \Pagestyle{plain} page style depend on the options of
+\Package{scrlayer-scrpage}. See
+\autoref{sec:scrlayer-scrpage.pagestyle.content},
+\autopageref{desc:scrlayer-scrpage.option.headsepline} and
+\autopageref{desc:scrlayer-scrpage.option.plainheadsepline} for information
+about those options.%
+\EndIndex{Option}{footsepline}%
+\EndIndex{Option}{headsepline}%
+
+\begin{Declaration}
+ \Macro{pagemark}\\
+ \Macro{letterpagemark}
+\end{Declaration}
+\BeginIndex{Cmd}{pagemark}%
+\BeginIndex{Cmd}{letterpagemark}%
+The \KOMAScript{} classes already define and use \Macro{pagemark}. So when
+\Package{scrletter} is loaded, it cannot simply redefine \Macro{pagemark} to
+add the prefix ``Page'' using \Macro{pagename}, because this would not only
+influence the pagination of the letter pages but the pagination of the whole
+document. Therefore\ChangedAt{v3.17}{\Package{scrletter}} \Package{scrletter}
+defines a new command \Macro{letterpagemark} with the prefix and lets
+\Macro{pagemark} become \Macro{letterpagemark} in
+\Macro{begin}\PParameter{letter} until the end of the letter only. If you want
+to redefine \Macro{pagemark} for the whole document including the letter
+pages, you have to add
+\begin{lstcode}[belowskip=\dp\strutbox]
+ \let\letterpagemark\pagemark
+\end{lstcode}
+just after the normal redefinition of \Macro{pagemark}. This add-on also will
+not violate anything if you later decide to switch from package
+\Package{scrletter} to class \Class{scrlttr2}. Note that the class
+\Class{scrlttr2} does not provide or use \Macro{letterpagemark}.%
+\EndIndex{Cmd}{letterpagemark}%
+\EndIndex{Cmd}{pagemark}%
+%
+%
\EndIndex{}{page>style}
-\section{Differences in the Handling of \File{lco}-Files in \Package{scrletter}}
-\label{sec:scrlttr2-experts.lcoatscrletter}
+\section{Differences in the Handling of \File{lco}-Files in
+ \Package{scrletter}}
+\seclabel{lcoatscrletter}
\BeginIndex{File}{lco}
\BeginIndex{}{letter>class option}%
\BeginIndex{}{letter class option}%
@@ -1379,7 +1460,7 @@ these commands at the earliest after loading \Package{scrletter}.%
\section{\File{lco}-Files for Experienced Users}
-\label{sec:scrlttr2-experts.lcoFile}
+\seclabel{lcoFile}
\BeginIndex{File}{lco}%
\BeginIndex{}{lco-file=\File{lco}-file}%
@@ -1397,7 +1478,7 @@ paper size that is needed.%
\subsection{Survey of Paper Size}
-\label{sec:scrlttr2-experts.papersize}
+\seclabel{papersize}
At present there exist only parameter sets and \File{lco}-files for A4-sized
or letter-sized paper. Nevertheless, class \Class{scrlttr2} supports many more
@@ -1456,7 +1537,7 @@ forget about this option and skip the example.%
\subsection{Visualization of Positions}
-\label{sec:scrlttr2-experts.visualize}
+\seclabel{visualize}
\BeginIndex{Option}{visualize}
If someone develops a new \File{lco}-file, e.\,g., to adapt the positions of
@@ -1644,7 +1725,7 @@ limitations of \TeX.
\section{Language Support}
-\label{sec:scrlttr2-experts.languages}%
+\seclabel{languages}%
\BeginIndex{}{language}%
The document class \Class{scrlttr2} supports many languages. These include
@@ -1947,7 +2028,7 @@ How\important[i]{%
\EndIndex{}{language}
\section{From Obsolete \Class{scrlettr} to Current \Class{scrlttr2}}
-\label{sec:scrlttr2-experts.fromscrlettr}
+\seclabel{fromscrlettr}
\BeginIndex{Class}{scrlettr}
With\textnote{Attention!} the June 2002 release of \Class{scrlttr2} (see