summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scraddr.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/ngerman/scraddr.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/ngerman/scraddr.tex168
1 files changed, 86 insertions, 82 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scraddr.tex b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scraddr.tex
index e5333131808..0c64ff8a3d7 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scraddr.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/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,11 +46,12 @@
% ======================================================================
\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)]
\chapter{Adressdateien mit \Package{scraddr} erschließen}%
\labelbase{scraddr}%
+\BeginIndexGroup
\BeginIndex{Package}{scraddr}
\section{Überblick}\seclabel{overview}
@@ -58,15 +59,14 @@ Das Paket \Package{scraddr} ist eine kleine Beigabe zur
Briefklasse von \KOMAScript. Ziel ist, die Benutzung von Adressdateien zu
vereinfachen und ihre Anwendung flexibler zu gestalten. Im Grunde stellt das
Paket nur einen Lademechanismus für Adressdateien bereit, die aus
-\Macro{adrentry}- und neueren \Macro{addrentry}-Einträgen bestehen, wie sie in
-\autoref{cha:scrlttr2} ab \autopageref{desc:scrlttr2.cmd.adrentry} beschrieben
+\DescRef{\LabelBase.cmd.adrentry}- und neueren \DescRef{\LabelBase.cmd.addrentry}-Einträgen bestehen, wie sie in
+\autoref{cha:scrlttr2} ab \DescPageRef{scrlttr2.cmd.adrentry} beschrieben
sind.
\begin{Declaration}
\Macro{InputAddressFile}\Parameter{Dateiname}
\end{Declaration}%
-\BeginIndex{Cmd}{InputAddressFile}%
Der Befehl \Macro{InputAddressFile} ist der zentrale Ladebefehl
von \Package{scraddr}.
Er erwartet als obligatorisches Argument den
@@ -77,54 +77,48 @@ Für jeden Eintrag dieser Adressdatei wird eine Reihe von Makros generiert,
die es ermöglichen, auf die Daten der Adressdatei zuzugreifen. Es soll an
dieser Stelle nicht verschwiegen werden, dass dies bei großen Adressdateien
sehr viel \TeX-Speicher kostet.
+%
+\EndIndexGroup
\begin{Declaration}%
- \Macro{adrentry}\Parameter{Name}\Parameter{Vorname}\Parameter{Adresse}%
- \Parameter{Tel.}\Parameter{F1}\Parameter{F2}%
- \Parameter{Kommentar}\\
- \hphantom{\Macro{adrentry}}\Parameter{Kürzel}\\
- %
- \Macro{addrentry}\Parameter{Name}\Parameter{Vorname}\Parameter{Adresse}%
- \Parameter{Tel.}\Parameter{F1}\Parameter{F2}%
- \Parameter{F3}\Parameter{F4}\\
- \hphantom{\Macro{addrentry}}\Parameter{Kürzel}\\
- %
- \Macro{adrchar}\Parameter{Anfangsbuchstaben}\\
- \Macro{addrchar}\Parameter{Anfangsbuchstaben}%
+ \Macro{adrentry}\Parameter{Name}\Parameter{Vorname}\Parameter{Adresse}
+ \Parameter{Tel.}\Parameter{F1}\Parameter{F2}
+ \Parameter{Kommentar}\Parameter{Kürzel}
+ \Macro{addrentry}\Parameter{Name}\Parameter{Vorname}\Parameter{Adresse}
+ \Parameter{Tel.}\Parameter{F1}\Parameter{F2}
+ \Parameter{F3}\Parameter{F4}
+ \Parameter{Kürzel}
+ \Macro{adrchar}\Parameter{Anfangsbuchstaben}
+ \Macro{addrchar}\Parameter{Anfangsbuchstaben}
\end{Declaration}%
-\IndexCmd{adrentry}%
-\IndexCmd{addrentry}%
-\IndexCmd{adrchar}%
-\IndexCmd{addrchar}%
Der Aufbau der Adresseinträge in der Adressdatei wurde in
\autoref{sec:scrlttr2.addressFile} ab
-\autopageref{desc:scrlttr2.cmd.adrentry} ausführlich besprochen. Die
+\DescPageRef{scrlttr2.cmd.adrentry} ausführlich besprochen. Die
ebenfalls dort erwähnte Unterteilung der Adressdatei mit Hilfe von
\Macro{adrchar} oder \Macro{addrchar} hat für \Package{scraddr} keine
Bedeutung und wird vom Paket ignoriert.
Die Zugriffsbefehle sind mit englischen, den Argumenten entsprechenden
Bezeichnungen versehen.
+%
+\EndIndexGroup
+
\begin{Declaration}
-\Macro{Name}\Parameter{Kürzel}\\
-\Macro{FirstName}\Parameter{Kürzel}\\
-\Macro{LastName}\Parameter{Kürzel}\\
-\Macro{Address}\Parameter{Kürzel}\\
-\Macro{Telephone}\Parameter{Kürzel}\\
-\Macro{FreeI}\Parameter{Kürzel}\\
-\Macro{FreeII}\Parameter{Kürzel}\\
-\Macro{Comment}\Parameter{Kürzel}\\
-\Macro{FreeIII}\Parameter{Kürzel}\\
-\Macro{FreeIV}\Parameter{Kürzel}
+ \Macro{Name}\Parameter{Kürzel}
+ \Macro{FirstName}\Parameter{Kürzel}
+ \Macro{LastName}\Parameter{Kürzel}
+ \Macro{Address}\Parameter{Kürzel}
+ \Macro{Telephone}\Parameter{Kürzel}
+ \Macro{FreeI}\Parameter{Kürzel}
+ \Macro{FreeII}\Parameter{Kürzel}
+ \Macro{Comment}\Parameter{Kürzel}
+ \Macro{FreeIII}\Parameter{Kürzel}
+ \Macro{FreeIV}\Parameter{Kürzel}
\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}%
Der Zugriff erfolgt anhand des Kürzels im letzten Argument eines
Eintrags, das heißt Argument Nummer 8
-für \Macro{adrentry}-Einträge beziehungsweise Argument Nummer 9
-für \Macro{addrentry}-Einträge. Das bedeutet auch, dass dieses Argument
+für \DescRef{\LabelBase.cmd.adrentry}-Einträge beziehungsweise Argument Nummer 9
+für \DescRef{\LabelBase.cmd.addrentry}-Einträge. Das bedeutet auch, dass dieses Argument
nicht leer sein darf.
Um eine sichere Funktionsweise zu garantieren, empfiehlt es sich,
das Kürzel nur als Folge von Buchstaben aufzubauen,
@@ -134,15 +128,14 @@ Weiterhin ist zu beachten, dass bei mehrmaligem Auf"|treten
eines Kürzels in den Einträgen die Angaben beim
letzten Auf"|treten die gültigen sind.%
%
-\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
\section{Benutzung}\seclabel{usage}
+\BeginIndexGroup
+\BeginIndex[indexother]{Cmd}{addrentry}%
+\BeginIndex[indexother]{Cmd}{adrentry}%
Um das Paket benutzen zu können, ist eine gültige
Adressdatei zu erstellen.
Diese, hier \File{lotr.adr} genannt, könnte beispielsweise
@@ -166,17 +159,30 @@ Das vierte Argument, die Telefonnummer, wurde hier leer gelassen.
Erstens hat es in dem Zusammenhang keinen Sinn und zweitens sollte
dies ja auch möglich sein.
+\BeginIndexGroup
+\BeginIndex[indexother]{Cmd}{InputAddressFile}
Mit dem oben beschriebenen Ladebefehl lesen wir die Adressdatei
in unser Briefdokument ein:
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\InputAddressFile{lotr}
\end{lstcode}
+\EndIndexGroup
+\BeginIndexGroup
+\BeginIndex[indexother]{Cmd}{Name}%
+\BeginIndex[indexother]{Cmd}{Address}%
+\BeginIndex[indexother]{Cmd}{FirstName}%
+\BeginIndex[indexother]{Cmd}{LastName}%
+\BeginIndex[indexother]{Cmd}{FreeI}%
+\BeginIndex[indexother]{Cmd}{FreeII}%
+\BeginIndex[indexother]{Cmd}{FreeIII}%
+\BeginIndex[indexother]{Cmd}{FreeIV}%
+\BeginIndex[indexother]{Cmd}{Comment}%
Mit Hilfe der vorgestellten Makros können wir dann einen Brief
an den alten \textsc{Tom Bombadil} schreiben, in dem wir ihn
fragen, ob er sich noch an zwei Gefährten aus alter Zeit
erinnern kann.
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\begin{letter}{\Name{TOM}\\\Address{TOM}}
\opening{Lieber \FirstName{TOM} \LastName{TOM},}
@@ -199,49 +205,49 @@ erinnern kann.
und Lachen des Laubes!"'}
\end{letter}
\end{lstcode}
-Die in diesem Beispiel in \Macro{opening} verwendete Zusammensetzung aus
-\Macro{FirstName}\Parameter{Kürzel} und \Macro{LastName}\Parameter{Kürzel}
-kann auch direkt mittels \Macro{Name}\Parameter{Kürzel} erhalten werden.
+Die in diesem Beispiel in \DescRef{scrlttr2.cmd.opening} verwendete
+Zusammensetzung aus \Macro{FirstName}\Parameter{Kürzel} und
+\Macro{LastName}\Parameter{Kürzel} kann auch direkt mittels
+\Macro{Name}\Parameter{Kürzel} erhalten werden.
+
+Das fünf"|te und sechste Argument von \DescRef{\LabelBase.cmd.adrentry} und
+\DescRef{\LabelBase.cmd.addrentry} steht zur freien Verfügung. Mit den Makros
+\Macro{FreeI} und \Macro{FreeII} kann auf diese Inhalte zugegriffen werden. Im
+vorliegenden Fall wurde das fünf"|te Argument für die Person benutzt, die der
+Person des Eintrags am nächsten steht. Das sechste Argument enthält im
+Beispiel die besondere Vorliebe der jeweiligen Person. Das siebente Argument
+ist ebenfalls ein freier Eintrag. Der Zugriff erfolgt per \Macro{Comment} oder
+\Macro{FreeIII}. Der Zugriff auf das vierte freie Argument mittels
+\Macro{FreeIV} ist nur für \DescRef{\LabelBase.cmd.addrentry}-Einträge gültig.
+Bei \DescRef{\LabelBase.cmd.adrentry}-Einträgen ist seine Verwendung nicht
+zulässig. Näheres hierzu findet sich im nächsten Abschnitt.
+%
+\EndIndexGroup
+\EndIndexGroup
-Das fünf"|te und sechste Argument von \Macro{adrentry} und
-\Macro{addrentry} steht zur freien Verfügung.
-Mit den Makros \Macro{FreeI} und \Macro{FreeII} kann auf
-diese Inhalte zugegriffen werden. Im vorliegenden Fall wurde
-das fünf"|te Argument für die Person benutzt, die der Person des
-Eintrags am nächsten steht. Das sechste Argument
-enthält im Beispiel die besondere Vorliebe der jeweiligen Person.
-Das siebente Argument ist ebenfalls ein freier Eintrag. Der Zugriff
-erfolgt per \Macro{Comment} oder \Macro{FreeIII}.
-Der Zugriff auf das vierte freie Argument mittels \Macro{FreeIV}
-ist nur für \Macro{addrentry}-Einträge gültig.
-Bei \Macro{adrentry}-Einträgen ist seine Verwendung nicht zulässig. Näheres
-hierzu findet sich im nächsten Abschnitt.
\section{Paketoptionen für Warnungen}
Wie im vorherigen Abschnitt erwähnt, ist die Benutzung des Zugriffsbefehls
-\Macro{FreeIV} bei \Macro{adrentry}-Einträgen nicht zulässig. Wie
+\Macro{FreeIV} bei \DescRef{\LabelBase.cmd.adrentry}-Einträgen nicht zulässig. Wie
\Package{scraddr} darauf reagiert, ist allerdings durch Paketoptionen
konfigurierbar. Bitte beachten Sie\textnote{Achtung!}, dass dieses Paket die
-erweiterte Optionenschnittstelle mit \Macro{KOMAoptions} und
-\Macro{KOMAoption} nicht unterstützt. Die Optionen sind also entweder als
-globale Optionen bei \Macro{documentclass} oder als lokale Optionen bei
-\Macro{usepackage} anzugeben.
+erweiterte Optionenschnittstelle mit \DescRef{maincls.cmd.KOMAoptions} und
+\DescRef{maincls.cmd.KOMAoption} nicht unterstützt. Die Optionen sind also
+entweder als globale Optionen bei \DescRef{maincls.cmd.documentclass} oder als
+lokale Optionen bei \DescRef{maincls.cmd.usepackage} anzugeben.
\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}%
-Diese vier Optionen erlauben die Auswahl aus vier verschiedenen
-Reaktionen zwischen \emph{Ignorieren} bis \emph{Abbruch} falls bei einem
-\Macro{adrentry}-Eintrag der Zugriffsbefehl \Macro{FreeIV} verwendet wird:
+Diese vier Optionen erlauben die Auswahl aus vier verschiedenen Reaktionen
+zwischen \emph{Ignorieren} bis \emph{Abbruch} falls bei einem
+\DescRef{\LabelBase.cmd.adrentry}-Eintrag der Zugriffsbefehl \Macro{FreeIV}
+verwendet wird:
%
\begin{labeling}[~--]{\Option{adrFreeIVempty}}
\item[\Option{adrFreeIVempty}]
@@ -256,11 +262,9 @@ Reaktionen zwischen \emph{Ignorieren} bis \emph{Abbruch} falls bei einem
\end{labeling}
Wird für das Paket keine Option angegeben, so ist \Option{adrFreeIVshow}
voreingestellt.%
-\EndIndex{Option}{adrFreeIVstop}%
-\EndIndex{Option}{adrFreeIVwarn}%
-\EndIndex{Option}{adrFreeIVshow}%
-\EndIndex{Option}{adrFreeIVempty}%
-
+\EndIndexGroup
+%
+\EndIndexGroup
\endinput
%%% Local Variables: