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.tex109
1 files changed, 61 insertions, 48 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 2e0af8b703d..f209b2addf2 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
@@ -46,14 +46,14 @@
% ============================================================================
\KOMAProvidesFile{scrlttr2-experts.tex}
- [$Date: 2018-03-21 10:37:34 +0100 (Wed, 21 Mar 2018) $
+ [$Date: 2018-04-26 14:55:38 +0200 (Thu, 26 Apr 2018) $
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\and
Karl Hagen}
-% Date of the translated German file: 2018-01-02
+% Date of the translated German file: 2018-04-26
\chapter{Additional Information about the \Class{scrlttr2} Class and the
\Package{scrletter} Package}
@@ -383,45 +383,37 @@ required pseudo-lengths have been omitted.
\begin{Declaration}
- \Macro{@newplength}\Parameter{name}
+ \Macro{newplength}\Parameter{name}
\end{Declaration}
-This command defines a new pseudo-length. The new pseudo-length is
-uniquely identified by its \PName{name}. Each name can therefore be
-assigned only once. If you attempt to redefine an existing pseudo-length, the
-commands exits with an error message.
-
+This\ChangedAt{v3.26}{\Class{scrlttr2}\and \Package{scrletter}} command
+defines a new pseudo-length. The new pseudo-length is uniquely identified by
+its \PName{name}. Each name can therefore be assigned only once. If you
+attempt to redefine an existing pseudo-length, the commands exits with an
+error message.
+
+% TODO: Optimize translation!
+\BeginIndex{Cmd}{@newplength}%
Since the ordinary user does not normally need to define pseudo-lengths, this
-command is not a user instruction. It cannot be used within a document, but it
-can, for example, be used within an \File{lco}
-file\Index{lco file=\File{lco} file}.
-%
-\iftrue % Umbruchoptimierung!!!
-\iffree{}{ If you want to
- define a pseudo-length inside the document anyway, you can override the
- restriction with the help of
- \Macro{makeatletter}\important[i]{\Macro{makeatletter}\\
- \Macro{makeatother}}\IndexCmd{makeatletter} and
- \Macro{makeatother}\IndexCmd{makeatother} (see
- \cite{UK:FAQ}). But\textnote{Attention!} you should never use these two
- commands inside an \File{lco} file!}%
-\fi
-%
+command has not been a user instruction until \KOMAScript~3.26. Instead of it
+there was only \Macro{@newplength} with the same functionality. For package
+authors \Macro{@newplength} still exists.%
+% :ODOT
\EndIndexGroup
\begin{Declaration}
- \Macro{@setplength}%
+ \Macro{setplength}%
\OParameter{factor}\Parameter{pseudo-length}\Parameter{value}%
- \Macro{@addtoplength}%
+ \Macro{addtoplength}%
\OParameter{factor}\Parameter{pseudo-length}\Parameter{value}
\end{Declaration}
-Using \Macro{@setplength}, you can assign the multiple of a
+Using \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 \DescRef{scrlttr2.cmd.setlengthtoplength},
\autoref{sec:scrlttr2.pseudoLength},
\DescPageRef{scrlttr2.cmd.setlengthtoplength}).
-With \Macro{@addtoplength} you can add the multiple of a \PName{value} to a
+With \Macro{addtoplength} you can add the multiple of a \PName{value} to a
\PName{pseudo-length}. Again, you can pass a \PName{factor} as an optional
argument.
@@ -432,18 +424,39 @@ within the \PName{value}. To subtract the value of one \PName{pseudo-length}
from another \PName{pseudo-length}, you use should use at the same time a
minus sign or \PValue{-1} as the \PName{factor}.
-Since the ordinary user does not normally need to define pseudo-lengths, this
-command is not a user instruction. It cannot be used within a document, but it
-can, for example, be used within an \File{lco}
-file\Index{lco file=\File{lco} file}.\iffree{}{ If you want to
- define a pseudo-length inside the document anyway, you can override the
- restriction with the help of
- \Macro{makeatletter}\important[i]{\Macro{makeatletter}\\
- \Macro{makeatother}}\IndexCmd{makeatletter} and
- \Macro{makeatother}\IndexCmd{makeatother} (see
- \cite{UK:FAQ}). But\textnote{Attention!} you should never use these two
- commands inside an \File{lco} file!}%
-%
+% TODO: Optimize translation!
+\BeginIndex{Cmd}{@setplength}%
+\BeginIndex{Cmd}{@addtoplength}%
+Since the ordinary user does not normally need to define pseudo-lengths, these
+commands has not been user instructions until \KOMAScript~3-26. Instead of
+them there where only \Macro{@setplength} and \Macro{@addtoplength} with the
+same functionality. For package authors that commands still exist.%
+% :ODOT
+\EndIndexGroup
+
+% TODO: Optimize translation!
+\begin{Declaration}
+ \Macro{setplengthtowidth}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+ \Macro{setplengthtoheight}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+ \Macro{setplengthtodepth}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+ \Macro{setplengthtototalheight}
+ \OParameter{factor}\Parameter{pseudo-length}\Parameter{content}%
+\end{Declaration}
+The\ChangedAt{v3.26}{\Class{scrlttr2}\and \Package{scrletter}} three commands
+from the beginning correspond with \Macro{settowidth},
+\Macro{settoheight}, and \Macro{settodepth} of the \LaTeX{} kernel, but to set
+a \PName{pseudo-length} instead of a length. Like
+\DescRef{\LabelBase.cmd.setplength} the commands are extended by an optional
+\PName{factor}. So they are setting a \PName{pseudo-length} to the natural
+width, height or depth of the given \PName{content} multiplied by the optional
+\PName{factor}. The additional command
+\Macro{setplengthtototalheight} sets the \PName{pseudo-length} to the sum of
+height and depth of \PName{content} multiplied by the optional
+\PName{factor}.%
+% :ODOT
\EndIndexGroup
@@ -666,7 +679,7 @@ predefined \File{lco} files, the length of this rule is calculated
automatically taking into account, for example, letterhead width or an
optional logo. You can adjust rule length manually in your own \File{lco}
files by setting this pseudo-length to positive values using
-\Macro{\@setplength} (see \DescPageRef{scrlttr2-experts.cmd.@setplength}). The
+\Macro{setplength} (see \DescPageRef{scrlttr2-experts.cmd.setplength}). The
default thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}},
\PLength{fromrulethickness}, is 0.4\Unit{pt}.%
\EndIndexGroup
@@ -735,10 +748,10 @@ standards for window envelopes. Typical values are between 70\Unit{mm} and
\ProvidesFile{SNmmarg.lco}
[2002/06/04 v0.1 my lco]
\LoadLetterOption{SN}
- \@addtoplength{toaddrwidth}{%
+ \addtoplength{toaddrwidth}{%
-\useplength{toaddrhpos}}
- \@setplength{toaddrhpos}{-15mm}
- \@addtoplength{toaddrwidth}{%
+ \setplength{toaddrhpos}{-15mm}
+ \addtoplength{toaddrwidth}{%
\useplength{toaddrhpos}}
\endinput
\end{lstcode}
@@ -1006,8 +1019,8 @@ that overlapping with other elements is unlikely.
\begin{lstcode}
\ProvidesFile{lawsubj.lco}
[2008/11/03 lawyers lco file]
- \@setplength{subjectvpos}{\useplength{refvpos}}
- \@addtoplength{refvpos}{3\baselineskip}
+ \setplength{subjectvpos}{\useplength{refvpos}}
+ \addtoplength{refvpos}{3\baselineskip}
\endinput
\end{lstcode}
If you want to leave at least one empty line between the subject and the
@@ -1369,8 +1382,8 @@ forget about this option and skip the example.%
\ProvidesFile{a5.lco}
[2002/05/02 letter class option]
\LetterOptionNeedsPapersize{a5}{a5}
- \@setplength{tfoldmarkvpos}{\paperheight}
- \@setplength{bfoldmarkvpos}{\paperheight}
+ \setplength{tfoldmarkvpos}{\paperheight}
+ \setplength{bfoldmarkvpos}{\paperheight}
\end{lstcode}
Of course, it would be more elegant to deactivate the marks with the
\DescRef{scrlttr2.option.foldmarks} option. In addition, you must adjust the
@@ -1809,7 +1822,7 @@ The exact format can be found in \autoref{tab:date}.%
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}%
% \caption
- \begin{captionbeside}{Language-dependent Forms of the Date}[l]
+ \begin{captionbeside}{Language-dependent forms of the date}[l]
\begin{tabular}[t]{ll}
\toprule
Command & Date Example \\