summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex101
1 files changed, 46 insertions, 55 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
index 79e17f6d679..a4a7c5454e2 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scraddr.tex
-% Copyright (c) Markus Kohm, 2001-2015
+% Copyright (c) Markus Kohm, 2001-2017
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scraddr.tex
-% Copyright (c) Markus Kohm, 2001-2015
+% Copyright (c) Markus Kohm, 2001-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,28 +46,28 @@
% ======================================================================
\KOMAProvidesFile{scraddr.tex}
- [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (chapter: scraddr)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm}
-% Date of translated german file: 2015-03-31
+% Date of the translated German file: 2017-01-02
\chapter{Access to Address Files with \Package{scraddr}}%
\labelbase{scraddr}%
+\BeginIndexGroup
\BeginIndex{Package}{scraddr}
\section{Overview}\seclabel{overview}
The package \Package{scraddr} is a small extension to the {\KOMAScript} letter
class. Its aim is to make access to the data of address files more flexible
and easier. Basically, the package implements a new loading mechanism for
-address files which contain address entries in the form of \Macro{adrentry}
-and newer \Macro{addrentry} commands, as described in \autoref{cha:scrlttr2}
-from \autopageref{desc:scrlttr2.cmd.adrentry}.
+address files which contain address entries in the form of \DescRef{\LabelBase.cmd.adrentry}
+and newer \DescRef{\LabelBase.cmd.addrentry} commands, as described in \autoref{cha:scrlttr2}
+from \DescPageRef{scrlttr2.cmd.adrentry}.
\begin{Declaration}
\Macro{InputAddressFile}\Parameter{file name}
\end{Declaration}%
-\BeginIndex{Cmd}{InputAddressFile}%
The command \Macro{InputAddressFile} is the main command of the
\Package{scraddr}, and reads the content of the address
file\Index{address>file} given as its parameter. If the file does not
@@ -75,53 +75,45 @@ exist the command returns an error message.
For every entry in the address file the command generates a set of
macros for accessing the data. For large address files this will take
-a lot of {\TeX} memory.
+a lot of {\TeX} memory.
\begin{Declaration}%
\Macro{adrentry}\Parameter{Lastname}\Parameter{Firstname}%
\Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}%
- \Parameter{Comment}\Parameter{Key}\\
+ \Parameter{Comment}\Parameter{Key}%
%
\Macro{addrentry}\Parameter{Lastname}\Parameter{Firstname}%
\Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}%
- \Parameter{F3}\Parameter{F4}\Parameter{Key}\\
+ \Parameter{F3}\Parameter{F4}\Parameter{Key}%
%
- \Macro{adrchar}\Parameter{initial}\\
+ \Macro{adrchar}\Parameter{initial}%
\Macro{addrchar}\Parameter{initial}%
\end{Declaration}%
-\IndexCmd{adrentry}%
-\IndexCmd{addrentry}%
-\IndexCmd{adrchar}%
-\IndexCmd{addrchar}%
-
The structure of the address entries in the address file was discussed
in detail in \autoref{sec:scrlttr2.addressFile} from
-\autopageref{desc:scrlttr2.cmd.adrentry} onwards. The division of
+\DescPageRef{scrlttr2.cmd.adrentry} onwards. The division of
the address file with the help of \Macro{adrchar} or \Macro{addrchar},
also discussed therein, has no meaning for \Package{scraddr} and is
simply ignored.
The commands for accessing the data are given by the name of the data
field they are intended for.
+
\begin{Declaration}
- \Macro{Name}\Parameter{key}\\
- \Macro{FirstName}\Parameter{key}\\
- \Macro{LastName}\Parameter{key}\\
- \Macro{Address}\Parameter{key}\\
- \Macro{Telephone}\Parameter{key}\\
- \Macro{FreeI}\Parameter{key}\\
- \Macro{FreeII}\Parameter{key}\\
- \Macro{Comment}\Parameter{key}\\
- \Macro{FreeIII}\Parameter{key}\\
+ \Macro{Name}\Parameter{key}%
+ \Macro{FirstName}\Parameter{key}%
+ \Macro{LastName}\Parameter{key}%
+ \Macro{Address}\Parameter{key}%
+ \Macro{Telephone}\Parameter{key}%
+ \Macro{FreeI}\Parameter{key}%
+ \Macro{FreeII}\Parameter{key}%
+ \Macro{Comment}\Parameter{key}%
+ \Macro{FreeIII}\Parameter{key}%
\Macro{FreeIV}\Parameter{key}
\end{Declaration}%
-\BeginIndex{Cmd}{Name}\BeginIndex{Cmd}{FirstName}\BeginIndex{Cmd}{LastName}%
-\BeginIndex{Cmd}{Address}\BeginIndex{Cmd}{Telephone}\BeginIndex{Cmd}{FreeI}%
-\BeginIndex{Cmd}{FreeII}\BeginIndex{Cmd}{FreeIII}\BeginIndex{Cmd}{FreeIV}%
-\BeginIndex{Cmd}{Comment}%
These commands give access to data of your address file. The last
-parameter, i.\,e., parameter 8 for the \Macro{adrentry} entry and
-parameter 9 for the \Macro{addrentry} entry, is the identifier of an
+parameter, i.\,e., parameter 8 for the \DescRef{\LabelBase.cmd.adrentry} entry and
+parameter 9 for the \DescRef{\LabelBase.cmd.addrentry} entry, is the identifier of an
entry, thus the \PName{key} has to be unique and non-blank. The
\PName{key} should only be composed of multiple uppercase letters out of the
namespace of \TeX{} macro names.
@@ -129,11 +121,11 @@ namespace of \TeX{} macro names.
If the file contains more than one entry with the same \PName{key}
value, the last occurrence will be used.%
%
-\EndIndex{Cmd}{InputAddressFile}%
-\EndIndex{Cmd}{Name}\EndIndex{Cmd}{FirstName}\EndIndex{Cmd}{LastName}%
-\EndIndex{Cmd}{Address}\EndIndex{Cmd}{Telephone}\EndIndex{Cmd}{FreeI}%
-\EndIndex{Cmd}{FreeII}\EndIndex{Cmd}{FreeIII}\EndIndex{Cmd}{FreeIV}%
-\EndIndex{Cmd}{Comment}%
+\EndIndexGroup
+%
+\EndIndexGroup
+%
+\EndIndexGroup
\section{Usage}\seclabel{usage}
@@ -163,7 +155,7 @@ should simply be possible to leave them out.
The command
\Macro{InputAddressFile} is used to load the address file shown above:
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\InputAddressFile{lotr}
\end{lstcode}
@@ -171,7 +163,7 @@ The command
With the help of the commands introduced in this chapter we can now
write a letter to old \textsc{Tom Bombadil}. In this letter we ask
him if he can remember two fellow-travelers from Elder Days.
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\begin{letter}{\Name{TOM}\\\Address{TOM}}
\opening{Dear \FirstName{TOM} \LastName{TOM},}
@@ -194,38 +186,36 @@ him if he can remember two fellow-travelers from Elder Days.
\end{letter}
\end{lstcode}
In the address of letters often both firstname and lastname are required, als
-shown above in \Macro{opening}. Thus, the command
+shown above in \DescRef{scrlttr2.cmd.opening}. Thus, the command
\Macro{Name}\PParameter{key} is an abridgement for
\Macro{FirstName}\PParameter{key} \Macro{LastName}\PParameter{key}.
-The 5th and 6th parameters of the \Macro{adrentry} or \Macro{adrentry}
+The 5th and 6th parameters of the \DescRef{\LabelBase.cmd.adrentry} or \DescRef{\LabelBase.cmd.adrentry}
commands are for free use. They are accessible with the commands
\Macro{FreeI} and \Macro{FreeII}. In this example, the 5th parameter contains
the name of a person who is the most important in the life of the entry's
person, the 6th contains the person's passion. The 7th parameter is a comment
or in general also a free parameter. The commands \Macro{Comment} or
\Macro{FreeIII} give access to this data. Use of \Macro{FreeIV} is only valid
-for \Macro{addrentry} entries; for \Macro{adrentry} entries it results in an
-error. More on this is covered in the next section.
-\EndIndex{Package}{scraddr}
+for \DescRef{\LabelBase.cmd.addrentry} entries; for \DescRef{\LabelBase.cmd.adrentry} entries
+it results in an error. More on this is covered in the next section.
+
\section{Package Warning Options}
-As mentioned above, the command \Macro{FreeIV} leads to an error if it
-is used for \Macro{adrentry} entries. How \Package{scraddr} reacts in
+As mentioned above, the command \Macro{FreeIV} leads to an error if it is used
+for \DescRef{\LabelBase.cmd.adrentry} entries. How \Package{scraddr} reacts in
such a situation is decide by package options.
\begin{Declaration}
- \Option{adrFreeIVempty}\\
- \Option{adrFreeIVshow}\\
- \Option{adrFreeIVwarn}\\
+ \Option{adrFreeIVempty}%
+ \Option{adrFreeIVshow}%
+ \Option{adrFreeIVwarn}%
\Option{adrFreeIVstop}%
\end{Declaration}%
-\BeginIndex{Option}{adrFreeIVempty}\BeginIndex{Option}{adrFreeIVshow}%
-\BeginIndex{Option}{adrFreeIVwarn}\BeginIndex{Option}{adrFreeIVstop}%
These four options allow the user to choose between \emph{ignore} and
\emph{rupture} during the {\LaTeX} run if \Macro{FreeIV} has been used
-with an \Macro{adrentry} entry.
+with an \DescRef{\LabelBase.cmd.adrentry} entry.
\begin{labeling}[~--]{\Option{adrFreeIVempty}}
\item[\Option{adrFreeIVempty}]
@@ -242,8 +232,9 @@ To choose the desired reaction, one of these options can be given in
the optional argument of the \Macro{usepackage} command. The default
setting is \Option{adrFreeIVshow}.%
%
-\EndIndex{Option}{adrFreeIVempty}\EndIndex{Option}{adrFreeIVshow}%
-\EndIndex{Option}{adrFreeIVwarn}\EndIndex{Option}{adrFreeIVstop}
+\EndIndexGroup
+%
+\EndIndexGroup
\endinput