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.tex97
1 files changed, 51 insertions, 46 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 c2d08cc4fe0..9ed1ae7f361 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-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% 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-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,13 +45,14 @@
%
% ============================================================================
-\ProvidesFile{scrlttr2-experts.tex}[2012/03/01 KOMA-Script guide (chapter:
-scrlttr2 for experts)]
+\KOMAProvidesFile{scrlttr2-experts.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ 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: 2012/03/01
+% Date of the translated German file: 2013/10/04
\chapter{Additional Information about the Letter Class
\Class{scrlttr2}}
@@ -59,14 +60,14 @@ scrlttr2 for experts)]
This chapter gives additional information about the \KOMAScript{} class
\Class{scrlttr2}. \iffree{Some parts of the chapter are subject to the
- \KOMAScript{} book \cite{book:komascript} only. This shouldn't be a problem,
- because the}{The} average user, who only want to use the package, won't need
-the information. Other information is addressed to users, who want additional
-information about details. For example the first section will describe
-pseudo-lengths in detail. These may be used to modify the note paper. Another
-part of the information describes features of the class that exist only
-because of compatibility to deprecated \Class{scrlettr} class. Last but not
-least it will be described in detail how to change a document from the old
+ \KOMAScript{} book \cite{book:komascript} only. This should not be a
+ problem, because the}{The} average user, who only want to use the package,
+does not need the information. Other information is addressed to users, who
+want additional information about details. For example the first section will
+describe pseudo-lengths in detail. These may be used to modify the note paper.
+Another part of the information describes features of the class that exist
+only because of compatibility to deprecated \Class{scrlettr} class. Last but
+not least it will be described in detail how to change a document from the old
\Class{scrlettr} class to be used with the current \Class{scrlttr2} class.
@@ -84,9 +85,16 @@ 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.
+are internally defined with macros instead of lengths. The drawback of this
+approach is that computations with macros is somewhat more complicated than
+with real lengths.
+
+Please note\textnote{Attention!}: Even though these pseudo-lengths are
+internally implemented as macros, the commands for pseudo-length management
+expect only the names of the pseudo-lengths not the macros representing the
+pseudo-lengths. The names of pseudo-lengths are without backslash at the very
+beginning similar to the names of \LaTeX{} counters and in opposite to macros
+or \LaTeX{} lengths.
It can be pointed out that the now recommended {\LaTeX} installation with
{\eTeX} no longer suffers from the above-mentioned limitation. However, that
@@ -100,8 +108,8 @@ given in the table.
A schematic display of the most important distances of the note paper is shown
in \autoref{fig:scrlttr2-experts.pseudoLength} at
\autopageref{fig:scrlttr2-experts.pseudoLength}. Beside the
-pseudo-lengths for the modifiable distances, also some lengths, that may not
-be modified are shown in light gray. Some rarely needed pseudo-length of the
+pseudo-lengths for the modifiable distances, also some lengths, which may not
+be modified, are shown in light gray. Some rarely needed pseudo-length of the
note paper have been omitted to get a more clear arrangement.
%
\begin{desclist}
@@ -425,21 +433,18 @@ shifted in the vertical direction.
\BeginIndex{PLength}{tfoldmarkvpos}%
\BeginIndex{PLength}{bfoldmarkvpos}%
\BeginIndex{PLength}{mfoldmarkvpos}%
-The letter class \Class{scrlttr2} knows a total of three
-vertically placed configurable foldmarks. The position of the topmost
-foldmark, taken from the upper edge of the paper, is governed by the
-pseudo-length \PLength{tfoldmarkvpos}, that of the middle foldmark by
-pseudo-length
-\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}, and that
-of the bottommost foldmark by pseudo-length \PLength{bfoldmarkvpos}. With
-the addition of the puncher hole\Index{puncher hole mark} or
-center\Index{center mark|see{punch hole mark}}
-mark, there is still a fourth horizontal mark. This one is however
-always placed at the vertical center of the paper.
+The letter class \Class{scrlttr2} knows a total of three vertically placed
+configurable foldmarks. The position of the topmost foldmark, taken from the
+upper edge of the paper, is governed by the pseudo-length
+\PLength{tfoldmarkvpos}; the position of the middle foldmark by pseudo-length
+\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}; the position of
+the bottommost foldmark by pseudo-length \PLength{bfoldmarkvpos}. With the
+addition of the puncher hole\Index{puncher hole mark} or center\Index{center
+ mark|see{punch hole mark}} mark, there is still a fourth horizontal
+mark. This one is however always placed at the vertical center of the paper.
\iffalse% Umbruchkorrekturtext
-There's no pseudo-length for this last mark, because it vertical position
-isn't configurable.
-\fi
+There's no pseudo-length for this last mark, because it vertical position is
+not configurable. \fi
The\textnote{Attention!} topmost and bottommost foldmarks do not serve to
divide the paper into exactly equal thirds. Instead, with their help, the
@@ -777,8 +782,8 @@ For window envelopes the sender is often printed with small font at one line
above the addressee. This kind of sender's information is known as return
address\textnote{return address}\Index{return address}, because it is visible
at the address window and will be used by the post officers to return the
-letter (back) to the sender. In this return address only the information
-should be, that is needed for this purpose.
+letter (back) to the sender. In this return address only that information
+should be that is needed for this purpose.
The height, that is reserved for the return address at the top of the address
field, is given by pseudo-length \PLength{backaddrheight}. A typical value for
@@ -832,7 +837,7 @@ the height, that will be reserved for the Port-Pay\'e head using the options
\PLength{PPheadwidth} will be used only with \OptionValue{addrfield}{PP} (see
\autoref{sec:scrlttr2.firstpage},
\autopageref{desc:scrlttr2.option.addrfield}) and gives the width of the left
-field in the Port-Pay\'e head, that contains P.\,P. logo, zip-code and
+field in the Port-Pay\'e head that contains P.\,P. logo, zip-code and
place. The width of the right field with the sender's code and the priority is
the remaining width.
@@ -966,7 +971,7 @@ fields line is centered, while with
\OptionValue{refline}{narrow}\IndexOption{refline~=\PValue{narrow}} it is
aligned on the left inside the typing area.
-If \PLength{refwidth} isn't null, i.\,e., the width of the reference fields
+If \PLength{refwidth} is not null, i.\,e., the width of the reference fields
line is therefore not determined by the option \Option{refline}, then
\PLength{refhpos} gives the distance of the reference fields line from the
left edge of the paper. If\textnote{Attention!} this distance is null, then
@@ -1206,7 +1211,7 @@ variables in the business line\Index{business line}.
With \Macro{newkomavar} a new variable is defined. This variable is
addressed via \PName{name}. As an option you can define a
\PName{description} for the variable \PName{name}. In opposite to \PName{name}
-the \PName{description} won't be used to reference a variable. In fact the
+the \PName{description} is not used to reference a variable. In fact the
\PName{description} defines an addition to the content of a variable, that may
be output similar to the variable content.
@@ -1243,7 +1248,7 @@ 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.
-The\textnote{Attention!} date shouldn't be added to the reference fields line
+The\textnote{Attention!} date should not be added to the reference fields line
using \Macro{addtoreffields}. Instead option \Option{date}\important[i]{\OptionValue{refline}{dateleft}\\
\OptionValue{refline}{dateright}\\
\OptionValue{refline}{nodate}}%
@@ -1310,7 +1315,7 @@ to be used as the argument of, e.\,g., \Macro{markboth} or \Macro{footnote}.%
\section{\File{lco}-Files for Experienced Users}
-\label{sec:scrlttr2-experts.variables}
+\label{sec:scrlttr2-experts.lcoFile}
\BeginIndex{File}{lco}%
\BeginIndex{}{lco-file=\File{lco}-file}%
@@ -1319,7 +1324,7 @@ Even though each paper size, that may be set up using package
\Package{typearea}, may be also used with \Class{scrlttr2}, the result of the
first page may be unwanted with some of those page sizes. The conception of
the class is not the reason for this, but the fact, that there are mainly
-parameter sets for ISO~A4 paper. Unfortunately their aren't any universal
+parameter sets for ISO~A4 paper. Unfortunately their are not any universal
rules, to calculate, e.\,g., the position of the address field or similar for
every available paper sizes. But it is possible to make parameter sets for any
paper size that is needed.%
@@ -1361,7 +1366,7 @@ forget about this option and skip the example.%
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 topmost and bottommost folding marks. If their wouldn't be options for
+ the topmost and bottommost folding marks. If their would not be options for
this, the easiest way to achieve this would be to place the marks outside of
the paper area.
\begin{lstcode}
@@ -1444,13 +1449,13 @@ commands\Macro{setkomafont} und \Macro{addtokomafont} (see
\BeginIndex{Cmd}{edgesize}
The default for the visualization of single areas are
frames\important{\PValue{frame}} around the areas. Areas with open top or
-bottom won't be framed completely but have an open edge with arrows at the end
+bottom are not framed completely but have an open edge with arrows at the end
of the ending lines. Alternatively\important{\PValue{rule}} the
\PName{visualization style} \PValue{rule} may be used. In this case a
-background color will be used to visualize the areas. This doesn't differ open
+background color will be used to visualize the areas. This does not differ open
and closed areas. Instead a minimal height will be used for open areas. The
-third\important{\PValue{edge}} available \PName{visualization style} is
-\PValue{edge}. This will mark the corners of the areas. The corner marks at
+third\important{\PValue{edges}} available \PName{visualization style} is
+\PValue{edges}. This will mark the corners of the areas. The corner marks at
the open edge of open areas will be omitted. The size of two edges of the
corner marks are given by the macro \Macro{edgesize} with default 1\Unit{ex}.%
\EndIndex{Cmd}{edgesize}%
@@ -1830,7 +1835,7 @@ How\important[i]{%
}]{%
Default settings for language-dependent terms using languages
\Option{english} and \Option{ngerman}, as long as language selection
- packages haven't been used%
+ packages have not been used%
\label{tab:scrlttr2-experts.languageTerms}%
}[l]
\begin{tabular}[t]{lll}