diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex')
| -rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex | 591 |
1 files changed, 371 insertions, 220 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex index 0f84bda93e0..958a9e47f7e 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex @@ -1,6 +1,6 @@ % ====================================================================== % scrbase.tex -% Copyright (c) Markus Kohm, 2002-2013 +% Copyright (c) Markus Kohm, 2002-2014 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -18,7 +18,7 @@ % This work consists of all files listed in manifest.txt. % ---------------------------------------------------------------------- % scrbase.tex -% Copyright (c) Markus Kohm, 2002-2013 +% Copyright (c) Markus Kohm, 2002-2014 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -46,7 +46,7 @@ % ====================================================================== \KOMAProvidesFile{scrbase.tex} - [$Date: 2013-11-06 12:44:59 +0100 (Mi, 06. Nov 2013) $ + [$Date: 2014-09-19 10:04:02 +0200 (Fri, 19 Sep 2014) $ KOMA-Script package scrbase] \chapter{Grundlegende Funktionen im Paket \Package{scrbase}} @@ -80,10 +80,10 @@ Das Paket \Package{keyval} erlaubt es, Schlüssel zu definieren und diesen Werten zuzuweisen. Auch die Optionen, die \Package{scrbase} bereitstellt, verwenden die \Package{keyval}-Syntax: \PName{Schlüssel}\texttt{=}\PName{Wert}. -\BeginIndex{Option}{internalonly~=\PName{Wert}}% \begin{Declaration} \KOption{internalonly}\PName{Wert} \end{Declaration} +\BeginIndex{Option}{internalonly~=\PName{Wert}}% Von \Package{scrbase} werden einige Verzweigungsanweisungen bereitgestellt. Dabei verwendet es primär die Bezeichnungen \Macro{scr@\PName{Name}}. Es handelt sich somit um interne @@ -112,10 +112,12 @@ Anwender können sie mit oder ohne Wertangabe entweder als globale Option bei [internalonly=/ifVTeX/ifundefinedorrelax]% {foo} \end{lstcode} - Der Klassenname \Class{foo} wird hier als Platzhalter für irgend eine Klasse + Der Klassenname \Class{foo} wird hier als Platzhalter für irgendeine Klasse verwendet. Die Bedeutungen der Anweisungen \Macro{ifVTeX} und \Macro{ifundefinedorrelax} sowie weitere Verzweigungsanweisungen sind - \autoref{sec:scrbase.if} zu entnehmen. + \autoref{sec:scrbase.if}, %\autopageref{desc:scrbase.cmd.ifVTeX} und + %\autopageref{desc:scrbase.cmd.ifundefinedorrelax} + ab \autopageref{sec:scrbase.if} zu entnehmen. \end{Example} % \EndIndex{Option}{internalonly~=\PName{Wert}}% @@ -125,7 +127,7 @@ Anwender können sie mit oder ohne Wertangabe entweder als globale Option bei \label{sec:scrbase.keyvalue} Wie bereits in \autoref{sec:scrbase.loadit} erwähnt, setzt \Package{scrbase} -bei Schlüsseln und deren Werte auf das Paket \Package{keyval}. Allerdings +bei Schlüsseln und deren Werten auf das Paket \Package{keyval}. Allerdings erweitert es dessen Funktionalität. Während bei \Package{keyval} ein Schlüssel einer Familie gehört, kennt \Package{scrbase} zu jeder Familie auch noch Familienmitglieder. Ein Schlüssel kann dann sowohl einer Familie als auch @@ -133,12 +135,12 @@ einem oder mehreren Familienmitgliedern gehören. Außerdem kann ein Wert einem Schlüssel eines Familienmitglieds, einem Schlüssel einer Familie oder einem Schlüssel aller Familienmitglieder zugewiesen werden. -\BeginIndex{Cmd}{DefineFamily}% -\BeginIndex{Cmd}{DefineFamilyMember}% \begin{Declaration} \Macro{DefineFamily}\Parameter{Familienname}\\ \Macro{DefineFamilyMember}\OParameter{Mitglied}\Parameter{Familienname} \end{Declaration} +\BeginIndex{Cmd}{DefineFamily}% +\BeginIndex{Cmd}{DefineFamilyMember}% \Package{scrbase} muss aus verschiedenen Gründen die Mitglieder einer Familie kennen. Daher ist es notwendig, eine neue Familie zunächst mit \Macro{DefineFamily} zu definieren und so eine leere Mitgliederliste zu @@ -158,8 +160,9 @@ Theoretisch wäre es möglich, mit einem leeren optionalen Argument \PName{Mitglied} auch ein Mitglied ohne Name zu definieren. Dies würde jedoch der Familie selbst entsprechen. Es wird empfohlen als \PName{Familienname} nur Buchstaben und Ziffern zu verwenden und das \PName{Mitglied} immer mit einem -anderen Zeichen zu verwenden. Anderenfalls könnte es passieren, dass sich -Mitglieder einer Familie mit Mitgliedern anderer Familien überdecken. +anderen Zeichen, vorzugsweise einem Punkt, zu beginnen. Anderenfalls könnte +es passieren, dass sich Mitglieder einer Familie mit Mitgliedern anderer +Familien überdecken. \Package{scrbase} definiert selbst bereits die Familie »\PValue{KOMA}« und fügt ihr das Mitglied »\PValue{.scrbase.sty}« hinzu. Grundsätzlich ist die @@ -177,7 +180,7 @@ Pakete im Gesamtpaket als Mitglied zu verwenden. \DefineFamily{Fleischermeister} \DefineFamilyMember{Fleischermeister} \end{lstcode} - ein. Dadurch werden dann beim Laden der drei genannten Pakete der Familie + ein. Dadurch wird beim Laden der drei genannten Pakete der Familie »\PValue{Fleischermeister}« je nach Paket eines der drei Mitglieder »\PValue{.Salami.sty}«, »\PValue{.Mettwurst.sty}« und »\PValue{.Krakauer.sty}« zugefügt. Am Ende sind dann alle drei Mitglieder @@ -187,12 +190,6 @@ Pakete im Gesamtpaket als Mitglied zu verwenden. \EndIndex{Cmd}{DefineFamilyMember}% \EndIndex{Cmd}{DefineFamily}% -\BeginIndex{Cmd}{DefineFamilyKey}% -\BeginIndex{Cmd}{FamilyKeyState}% -\BeginIndex{Cmd}{FamilyKeyStateUnknown}% -\BeginIndex{Cmd}{FamilyKeyStateProcessed}% -\BeginIndex{Cmd}{FamilyKeyStateUnknownValue}% -\BeginIndex{Cmd}{FamilyKeyStateNeedValue}% \begin{Declaration} \Macro{DefineFamilyKey}\OParameter{Mitglied}\Parameter{Familie}% \Parameter{Schlüssel}\OParameter{Säumniswert}\\ @@ -203,6 +200,12 @@ Pakete im Gesamtpaket als Mitglied zu verwenden. \Macro{FamilyKeyStateUnknownValue}\\ \Macro{FamilyKeyStateNeedValue} \end{Declaration} +\BeginIndex{Cmd}{DefineFamilyKey}% +\BeginIndex{Cmd}{FamilyKeyState}% +\BeginIndex{Cmd}{FamilyKeyStateUnknown}% +\BeginIndex{Cmd}{FamilyKeyStateProcessed}% +\BeginIndex{Cmd}{FamilyKeyStateUnknownValue}% +\BeginIndex{Cmd}{FamilyKeyStateNeedValue}% Mit dieser Anweisung wird ein \PName{Schlüssel} definiert. Ist ein \PName{Mitglied} angegeben, so ist der \PName{Schlüssel} eine Eigenschaft dieses Mitglieds der angegebenen \PName{Familie}. Ist kein Mitglied @@ -218,12 +221,12 @@ eingesetzt. Falls kein \PName{Säumniswert} angegeben wird, kann später der \begin{Explain} \phantomsection\label{explain:scrbase.macro.DefineFamilyKey}% Letztlich führt -\begin{lstcode}[escapeinside=»«] +\begin{lstcode}[belowskip=\dp\strutbox,escapeinside=»«] \DefineFamilyKey[»\PName{Mitglied}«]{»\PName{Familie}«}{»\PName{Schlüssel}«} [»\PName{Säumniswert}«]{»\PName{Aktion}«} \end{lstcode} zu dem Aufruf -\begin{lstcode}[moretexcs={define@key},escapeinside=»«] +\begin{lstcode}[belowskip=\dp\strutbox,moretexcs={define@key},escapeinside=»«] \define@key{»\PName{Familie\,Mitglied}«}{»\PName{Schlüssel}«} [»\PName{Säumniswert}«]{»\PName{erweiterte Aktion}«} \end{lstcode} @@ -234,33 +237,42 @@ eingesetzt. Falls kein \PName{Säumniswert} angegeben wird, kann später der \end{Explain} Erfolg\ChangedAt{v3.12}{\Package{scrbase}} oder Misserfolg der Ausführung der -\PName{Aktion} werden über \Macro{FamilyKeyState} an \Package{scrbase} zurück -gemeldet, damit dieses je nach Bedarf und Verwendung der Option weitere -Maßnahmen ergreifen kann. In der Voreinstellung ist \Macro{FamilyKeyState} -identisch mit \Macro{FamilyKeyStateUnknown}. Das bedeutet, dass es nicht -sicher ist, ob die Option korrekt verarbeitet werden konnte. Findet -\Package{scrbase} nach Ausführung der \PName{Aktion} noch immer diesen Zustand -vor, so wird ein Hinweis in die \File{log}-Datei geschrieben und im weiteren -der Zustand \Macro{FamilyKeyStateProcessed} angenommen. - -Der Zustand \Macro{FamilyKeyStateProcessed} signalisiert, dass die Option und -die Wertzuweisung an die Option vollständig abgeschlossen wurde und alles in -Ordnung ist. Auf den Zustand kann einfach durch Aufruf von -\Macro{FamilyKeyStateProcessed} selbst umgeschaltet werden. - -Der Zustand \Macro{FamilyKeyStateUnknownValue} signalisiert, dass die Option -zwar verarbeitet wurde, ihr jedoch ein Wert zugewiesen werden sollte, der -nicht erlaubt ist. Diesen Zustand meldet beispielsweise \Package{typearea}, -wenn versucht wird, an Option \Option{twoside} den Wert \PValue{unbekannt} -zuzuweisen. Die Umschaltung auf den Zustand erfolgt einfach durch Aufruf von +\PName{Aktion} werden über +\Macro{FamilyKeyState} %\important{\Macro{FamilyKeyState}} % einige davon sind + % schlicht zu breit! +an \Package{scrbase} zurück gemeldet, damit dieses je nach Bedarf und +Verwendung des Schlüssels weitere Maßnahmen ergreifen kann. In der +Voreinstellung ist \Macro{FamilyKeyState} identisch mit +\Macro{FamilyKeyStateUnknown}. Das bedeutet, dass es nicht sicher ist, ob der +Schlüssel korrekt verarbeitet werden konnte. Findet \Package{scrbase} nach +Ausführung der \PName{Aktion} noch immer diesen Zustand vor, so wird ein +Hinweis in die \File{log}-Datei geschrieben und im weiteren der Zustand +\Macro{FamilyKeyStateProcessed} angenommen. + +Der Zustand +\Macro{FamilyKeyStateProcessed} %\important{\Macro{FamilyKeyStateProcessed}} +signalisiert, dass der Schlüssel und die Wertzuweisung an den Schlüssel +vollständig abgeschlossen wurde und alles in Ordnung ist. Auf den Zustand kann +einfach durch Aufruf von \Macro{FamilyKeyStateProcessed} selbst umgeschaltet +werden. + +Der Zustand +\Macro{FamilyKeyStateUnknownValue} %\important{\Macro{FamilyKeyStateUnknownValue}} +signalisiert, dass der Schlüssel zwar verarbeitet wurde, ihm jedoch ein Wert +zugewiesen werden sollte, der nicht erlaubt ist. Diesen Zustand meldet +beispielsweise \Package{typearea}, wenn versucht wird, an Option +\Option{twoside} den Wert \PValue{unbekannt} zuzuweisen. Die Umschaltung auf +den Zustand erfolgt einfach durch Aufruf von \Macro{FamilyKeyStateUnknownValue} selbst. -Der Zustand \Macro{FamilyKeyStateNeedValue} signalisiert, dass die Option nicht -verarbeitet werden konnte, weil sie zwingend einen Wert erwartet, sie aber -ohne Wertzuweisung aufgerufen wurde. Dieser Zustand wird automatisch gesetzt, -wenn eine Option, die keinen \PName{Säumniswert} besitzt, ohne Wertzuweisung -verwendet wird. Theoretisch wäre aber auch eine explizite Umschaltung darauf -durch Aufruf von \Macro{FamilyKeyStateNeedValue} selbst möglich. +Der Zustand +\Macro{FamilyKeyStateNeedValue} %\important{\Macro{FamilyKeyStateNeedValue}} +signalisiert, dass der Schlüssel nicht verarbeitet werden konnte, weil er +zwingend einen Wert erwartet, er aber ohne Wertzuweisung aufgerufen +wurde. Dieser Zustand wird automatisch gesetzt, wenn ein Schlüssel, der keinen +\PName{Säumniswert} besitzt, ohne Wertzuweisung verwendet wird. Theoretisch +wäre aber auch eine explizite Umschaltung darauf durch Aufruf von +\Macro{FamilyKeyStateNeedValue} selbst möglich. Desweiteren können zusätzliche Fehlerzustände definiert werden, indem man \Macro{FamilyKeyState} auf eine kurze Meldung umdefiniert. In der Regel @@ -281,10 +293,10 @@ sollten jedoch die vier vordefinierten Zustände verwendet werden. \FamilyKeyStateProcessed } \end{lstcode} - Als Wert sind daher beim Aufruf \PValue{true} oder \PValue{false} + Als Wert ist daher beim Aufruf \PValue{true} oder \PValue{false} erlaubt. Ein Test auf unerlaubte Werte existiert in diesem Beispiel - nicht. Stattdessen wird immer zurück gemeldet, dass die Option vollständig - und korrekt verarbeitet wwurde. Wird der Schlüssel später verwendet, so muss + nicht. Stattdessen wird immer zurückgemeldet, dass der Schlüssel vollständig + und korrekt verarbeitet wurde. Wird der Schlüssel später verwendet, so muss entweder einer der erlaubten Werte zugewiesen oder ein Aufruf ohne Wertzuweisung verwendet werden. In letzterem Fall wird der Säumniswert \PName{true} zugewiesen. @@ -302,14 +314,14 @@ sollten jedoch die vier vordefinierten Zustände verwendet werden. \EndIndex{Cmd}{DefineFamilyKey}% -\BeginIndex{Cmd}{FamilyProcessOptions}% \begin{Declaration} \Macro{FamilyProcessOptions}\OParameter{Mitglied}\Parameter{Familie} \end{Declaration} +\BeginIndex{Cmd}{FamilyProcessOptions}% Grundsätzlich ist die Erweiterung der Schlüssel von Familien auf Familien und Familienmitglieder dazu gedacht, dass Schlüssel beziehungsweise die Wertzuweisung an Schlüssel als ganz normale Klassen- oder Paketoptionen -verwendet werden kann. Diese Anweisung stellt daher ein Erweiterung von +verwendet werden können. Diese Anweisung stellt daher eine Erweiterung von \Macro{ProcessOptions*} aus dem \LaTeX-Kern dar (siehe \cite{latex:clsguide}). Dabei verarbeitet die Anweisung nicht nur Optionen, die mit \Macro{DeclareOption} definiert wurden. Es werden auch alle Schlüssel @@ -344,20 +356,21 @@ Man kann \Macro{FamilyProcessOptions} wahlweise als Erweiterung von werden mit Hilfe von \Macro{FamilyProcessOptions} aus \PName{Schlüssel=Wert}-Paaren Optionen. -Während der Ausführung von Optionen darf \Macro{FamilyProcessOptions} nicht -verwendet werden. Es ist also insbesondere nicht erlaubt, innerhalb der -Ausführung von Optionen Pakete zu laden, die selbst -\Macro{FamilyProcessOptions} verwenden.% +Wie\textnote{Achtung!} auch \Macro{ProcessOptions} darf +\Macro{FamilyProcessOptions} nicht während der Ausführung von Optionen +verwendet werden. Es ist also insbesondere auch nicht erlaubt, innerhalb der +Ausführung von Optionen Pakete zu laden.%, die selbst +%\Macro{FamilyProcessOptions} verwenden.% % \EndIndex{Cmd}{FamilyProcessOptions}% -\BeginIndex{Cmd}{FamilyExecuteOptions}% \begin{Declaration} \Macro{FamilyExecuteOptions}\OParameter{Mitglied}\Parameter{Familie}% \Parameter{Optionenliste} \end{Declaration} -Diese Anweisung stellt ein Erweiterung von +\BeginIndex{Cmd}{FamilyExecuteOptions}% +Diese Anweisung stellt eine Erweiterung von \Macro{ExecuteOptions} aus dem \LaTeX-Kern dar (siehe \cite{latex:clsguide}). Dabei verarbeitet die Anweisung nicht nur Optionen, die mit \Macro{DeclareOption} definiert wurden. Es werden auch alle Schlüssel @@ -379,20 +392,20 @@ Mitglieds gesetzt wird. ergänzt werden. \end{Example} -Diese Anweisung darf auch innerhalb dere Ausführung von Optionen verwendet +Diese Anweisung darf auch innerhalb der Ausführung von Optionen verwendet werden.% % \EndIndex{Cmd}{FamilyExecuteOptions}% -\BeginIndex{Cmd}{FamilyOptions}% \begin{Declaration} \Macro{FamilyOptions}\Parameter{Familie}\Parameter{Optionenliste}% \end{Declaration} +\BeginIndex{Cmd}{FamilyOptions}% Die \PName{Optionenliste} hat dabei die Form: -\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l} +\begin{flushleft}\begin{tabular}{l} \PName{Schlüssel}\texttt{=}\PName{Wert}\texttt{,}% - \PName{Schlüssel}\texttt{=}\PName{Wert}\dots + \PName{Schlüssel}\texttt{=}\PName{Wert} \dots \end{tabular}\vskip\dp\strutbox\end{flushleft} wobei für \PName{Schlüssel}, für die ein Säumniswert definiert ist, die Wertzuweisung natürlich auch entfallen kann. @@ -416,40 +429,52 @@ Mitglieder über \Macro{FamilyKeyState} einen Fehler zurückmeldet. \begin{lstcode} \ProvidesPackage{Wurstsalat}% [2008/05/06 nonsense package] + \RequirePackage{scrbase} \DefineFamily{Fleischermeister} \DefineFamilyMember{Fleischermeister} \FamilyProcessOptions{Fleischermeister}\relax \FamilyOptions{Fleischermeister}{Aufschnitt} \end{lstcode} - Sollte noch kein Wurst-Paket geladen sein, so würde nun eine Fehlermeldung + Sollte noch kein Wurstpaket geladen sein, so würde nun eine Fehlermeldung wegen der nicht definierten Option »\Option{Aufschnitt}« ausgegeben. Das - kann vermieden werden, wenn die letzte Zeile in -\begin{lstcode}[moretexcs={Family@Options}] - \Family@Options{Fleischermeister}{Aufschnitt}{} + kann vermieden werden, indem vor der letzten Zeile für das Paket selbst + ebenfalls ein entsprechender Schlüssel definiert wird: +\begin{lstcode} + \DefineFamilyKey{Fleischermeister}% + {Aufschnitt}[true]{}% \end{lstcode} - geändert wird. Allerdings produzieren so Wurst-Pakete, die nach + Allerdings produzieren so Wurstpakete, die nach \Package{Wurstsalat} geladen werden, keinen Aufschnitt. Dies kann man - ebenfalls ändern, wenn die letzte Zeile erneut überarbeitet wird: -\begin{lstcode}[moretexcs={Family@Options}] + ebenfalls ändern: +\begin{lstcode} \AtBeginDocument{% - \Family@Options{Fleischermeister}{Aufschnitt}{% - \PackageWarning{Wurstsalat}{% - Wurstsalat benötigt mindestens ein - Wurst-Paket}% - }% + \DefineFamilyKey[.Wurstsalat.sty]% + {Fleischermeister}% + {Aufschnitt}[true]{}% + } + \DefineFamilyKey{Fleischermeister}% + {Aufschnitt}[true]{% + \AtBeginDocument{\FamilyOptions{Fleischermeister}% + {Aufschnitt=#1}}% }% \end{lstcode} - Statt auf jegliche Meldung zu verzichten, falls kein Wurst-Paket geladen - ist, wird nun auch gleich noch eine Warnung ausgegeben. + Somit wird zunächst während \Macro{begin}\PParameter{document} die Option so + definiert, dass sie für das Paket \Package{Wurstsalat} keine Funktion mehr + ausübt. Da zu diesem Zeitpunkt \Macro{@currname} und \Macro{@currext} nicht + mehr gültig sind, muss dabei das optionale Argument von + \Macro{DefineFamilyKey} verwendet werden. Bis zu dieser Umdefinierung der + Option wird jedoch eine Definition verwendet, die während + \Macro{begin}\PParameter{document} die Option erneut für die gesamte Familie + ausführt und damit auch für andere Wurstpakete setzt. \end{Example} % \EndIndex{Cmd}{FamilyOptions}% -\BeginIndex{Cmd}{FamilyOption}% \begin{Declaration} \Macro{FamilyOption}\Parameter{Familie}% \Parameter{Option}\Parameter{Werteliste}% \end{Declaration} +\BeginIndex{Cmd}{FamilyOption}% Neben Optionen, die sich gegenseitig ausschließende Werte besitzen, kann es auch Optionen geben, die gleichzeitig mehrere Werte annehmen können. Für diese wäre es bei Verwendung von \Macro{FamilyOptions} notwendig, der Option mehrfach @@ -458,11 +483,11 @@ anzugeben. Stattdessen kann man einfach mit \Macro{FamilyOption} einer einzigen \PName{Option} eine ganze \PName{Werteliste} zuweisen. Die \PName{Werteliste} ist dabei eine durch Komma separierte Liste von Werten: \begin{flushleft}\begin{tabular}{l} - \PName{Wert}\texttt{,}\PName{Wert}\dots + \PName{Wert}\texttt{,}\PName{Wert} \dots \end{tabular}\end{flushleft} In diesem Zusammenhang sei darauf hingewiesen, dass die Verwendung eines Kommas in einem Wert möglich ist, wenn man den Wert in geschweifte Klammern -setzt. Die weiteren Funktionsweise ist der vorhergehenden Erklärung zu +setzt. Die weitere Funktionsweise ist der vorhergehenden Erklärung zu \Macro{FamilyOptions} zu entnehmen. \begin{Example} Das Paket \Package{Wurstsalat} soll eine Option bekommen, über die man @@ -501,30 +526,32 @@ setzt. Die weiteren Funktionsweise ist der vorhergehenden Erklärung zu \end{Declaration} \BeginIndex{Cmd}{AtEndOfFamilyOptions}% Manchmal\ChangedAt{v3.12}{\Package{scrbase}} ist es vorteilhafter, wenn nicht -jede Wertzuweisung an eine Option eine \PName{Aktion} auslöst, sondern dies -erst geschieht, wenn alle Wertzuweisungen innerhalb eines Aufrufs von -\Macro{FamilyProcessOptions}, \Macro{FamilyExecuteOptions}, -\Macro{FamilyOptions} oder \Macro{FamilyOption} abgeschlossen sind. Genau dies -ist mit Hilfe von \Macro{AtEndOfFamilyOptions} möglich. Die Rückmeldung von +jede Wertzuweisung an eine Option unmittelbar eine \PName{Aktion} auslöst, +sondern dies erst geschieht, wenn alle Wertzuweisungen innerhalb eines Aufrufs +von \Macro{FamilyProcessOptions}\IndexCmd{FamilyProcessOptions} oder +\Macro{FamilyExecuteOptions}\IndexCmd{FamilyExecuteOptions} beziehungsweise +\Macro{FamilyOptions}\IndexCmd{FamilyOptions} oder +\Macro{FamilyOption}\IndexCmd{FamilyOptions} abgeschlossen sind. Genau das ist +mit Hilfe von \Macro{AtEndOfFamilyOptions} möglich. Die Rückmeldung von Fehlerzuständen ist über diese Anweisung jedoch ebenso wenig möglich, wie die Verwendung dieser Anweisung außerhalb der Ausführung von Optionen. % \EndIndex{Cmd}{AtEndOfFamilyOptions}% -\BeginIndex{Cmd}{FamilyBoolKey}% -\BeginIndex{Cmd}{FamilySetBool}% \begin{Declaration} \Macro{FamilyBoolKey}\OParameter{Mitglied}\Parameter{Familie}% \Parameter{Schlüssel}\Parameter{Schaltername}\\ \Macro{FamilySetBool}\Parameter{Familie}% \Parameter{Schlüssel}\Parameter{Schaltername}\Parameter{Wert} \end{Declaration} +\BeginIndex{Cmd}{FamilyBoolKey}% +\BeginIndex{Cmd}{FamilySetBool}% In den vorherigen Beispielen wurden schon mehrfach Schalter gesetzt. Im Beispiel der Option \Option{Aufschnitt} war es dabei notwendig, dass der -Anwender als Werte \PValue{true} oder \PValue{false} angibt. Es existierte +Anwender als Wert \PValue{true} oder \PValue{false} angibt. Es existierte keine Fehlerbehandlung, falls der Anwender einen falschen Wert verwendet. Da -solche boolschen Schalter ein häufiger Anwendungsfall sind, kann man sie bei +solche booleschen Schalter ein häufiger Anwendungsfall sind, kann man sie bei \Package{scrbase} einfach mit \Macro{FamilyBoolKey} definieren. Dabei sind die Argumente \PName{Mitglied}, \PName{Familie} und \PName{Schlüssel} die gleichen wie bei \Macro{DefineFamilyKey} (siehe @@ -540,11 +567,11 @@ definiert und mit \PName{false} voreingestellt. Intern verwendet auch die Werte \PValue{on} und \PValue{yes} zum Einschalten und neben \PValue{false} auch die Werte \PValue{off} und \PValue{no} zum Ausschalten. Wird ein unbekannter Wert übergeben, so wird die Anweisung -\Macro{FamilyUnkownKeyValue} mit den Argumenten \PName{Familie}, +\Macro{FamilyUnknownKeyValue} mit den Argumenten \PName{Familie}, \PName{Schlüssel} und \PName{Wert} aufgerufen und so \Macro{FamilyKeyState} entsprechend gesetzt. Dadurch wird dann gegebenenfalls eine Meldung über -unbekannte Wertzuweisung ausgegeben (siehe auch -\autopageref{desc:scrbase.cmd.FamilyUnkownKeyValue} und +eine unbekannte Wertzuweisung ausgegeben (siehe auch +\autopageref{desc:scrbase.cmd.FamilyUnknownKeyValue} und \autopageref{desc:scrbase.cmd.FamilyKeyState}). \begin{Example} Der Schlüssel \Option{Aufschnitt} soll in den Wurstpaketen etwas robuster @@ -555,7 +582,7 @@ unbekannte Wertzuweisung ausgegeben (siehe auch \FamilyBoolKey{Fleischermeister}{Aufschnitt}% {@Aufschnitt} \end{lstcode} - Ein Test, ob Aufschnitt produziert wird sähe dann so aus: + Ein Test, ob Aufschnitt produziert wird, sähe dann so aus: \begin{lstcode} \if@Aufschnitt ... @@ -570,7 +597,8 @@ unbekannte Wertzuweisung ausgegeben (siehe auch \@ifundefined{if@Aufschnitt}{% \expandafter\newif\csname if@Aufschnitt\endcsname }{}% - \DefineFamilyKey[]{Fleischermeister}{Aufschnitt}[true]{% + \DefineFamilyKey[]{Fleischermeister} + {Aufschnitt}[true]{% \FamilySetBool{Fleischermeister}{Aufschnitt}% {@Aufschnitt}% {#1}% @@ -598,18 +626,17 @@ unbekannte Wertzuweisung ausgegeben (siehe auch ... \fi \end{lstcode} - zusätzliche Aktionen in Abhängigkeit davon, ob \Macro{FamilySetBool} - erfolgreich war oder nicht, ausführen. Es ist zu beachten, dass an dieser - Stelle unbedingt ein Test mit Hilfe von \Macro{ifx} vorzunehmen - ist. Expandierende Tests wie \Macro{ifstr} sind hier zu vermeiden. + ergänzen, um zusätzliche Aktionen in Abhängigkeit davon, ob + \Macro{FamilySetBool} erfolgreich war oder nicht, auszuführen. Es ist zu + beachten, dass an dieser Stelle unbedingt ein Test mit Hilfe von \Macro{ifx} + vorzunehmen ist. Expandierende Tests wie \Macro{ifstr} sind hier zu + vermeiden. \end{Example} % \EndIndex{Cmd}{FamilySetBool}% \EndIndex{Cmd}{FamilyBoolKey} -\BeginIndex{Cmd}{FamilyNumericalKey}% -\BeginIndex{Cmd}{FamilySetNumerical}% \begin{Declaration} \Macro{FamilyNumericalKey}\OParameter{Mitglied}\Parameter{Familie}% \Parameter{Schlüssel}\\ @@ -621,7 +648,8 @@ unbekannte Wertzuweisung ausgegeben (siehe auch \Parameter{Makroname}\Parameter{Werteliste}% \Parameter{Wert} \end{Declaration} -% +\BeginIndex{Cmd}{FamilyNumericalKey}% +\BeginIndex{Cmd}{FamilySetNumerical}% Während Schalter nur zwei Werte annehmen können, gibt es auch Schlüssel, die mehrere Werte kennen. So kann beispielsweise eine Ausrichtung nicht nur links oder nicht links, sondern beispielsweise links, mittig oder rechts @@ -632,7 +660,7 @@ Wert. Daher heißt bei \Package{scrbase} die Anweisung, mit der man via \Macro{FamilyNumericalKey}. Die \PName{Werteliste} hat dabei die Form \begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l} \Parameter{Wert}\Parameter{Definition}\texttt{,}% - \Parameter{Wert}\Parameter{Definition}\texttt{,}% + \Parameter{Wert}\Parameter{Definition} % \dots \end{tabular}\vskip\dp\strutbox\end{flushleft} Über diese \PName{Werteliste} werden so nicht nur die erlaubten Werte für den @@ -666,8 +694,8 @@ expandiert wird. \FamilyOptions{Fleischermeister}{SalatSchnitt=Nein} \end{lstcode} angegeben werden. In beiden Fällen würde \Macro{Schnitt} mit dem Inhalt - \PValue{Kein} definiert. Es kann durchaus sinnvoll sein, wie in diesem - Beispiel dem Anwender mehrere Werte für denselben Zweck anzubieten. + \PValue{Kein} definiert. Es kann durchaus sinnvoll sein, dem Anwender wie in + diesem Beispiel mehrere Werte für denselben Zweck anzubieten. Nun ist es sehr wahrscheinlich, dass die Schnittart nicht ausgegeben, sondern später ausgewertet werden soll. In diesem Fall sind die textuellen @@ -692,47 +720,127 @@ expandiert wird. \end{lstcode} unterschieden werden. \end{Example} -Intern wird von \Macro{FamilyNumericalKey} dann \Macro{DefineFamilyKey} -mit der Anweisung \Macro{FamilySetNumerical} verwendet. Wird an einen solchen +% +Intern wird von \Macro{FamilyNumericalKey} dann \Macro{DefineFamilyKey} mit +der Anweisung \Macro{FamilySetNumerical} verwendet. Wird an einen solchen Schlüssel ein unbekannter Wert übergeben, so wird von -\Macro{FamilySetNumerical} die Anweisung \Macro{FamilyUnkownKeyValue} mit den +\Macro{FamilySetNumerical} Anweisung \Macro{FamilyUnknownKeyValue} mit den Argumenten \PName{Familie}, \PName{Schlüssel} und \PName{Wert} -aufgerufen. Dadurch wird dann eine Fehlermeldung über unbekannte Wertzuweisung -ausgegeben. - -Beim Aufruf von \Macro{FamilySetNumerical} wird wiederum auch der Erfolg oder -Misserfolg automatisch via \Macro{FamilyKeyState} signalisiert. +aufgerufen. Dies führt zu einer Fehlersignalisierung in \Macro{FamilyKeyState} +mit Hilfe des Status \Macro{FamilyKeyStateUnknownValue} und beispielsweise bei +der Verwendung als lokale Option zu einer Fehlermeldung. Ebenso wird beim +Aufruf von \Macro{FamilySetNumerical} auch der Erfolg via +\Macro{FamilyKeyStateProcessed} in \Macro{FamilyKeyState} signalisiert.% % \EndIndex{Cmd}{FamilySetNumerical}% \EndIndex{Cmd}{FamilyNumericalKey}% -\BeginIndex{Cmd}{FamilyStringKey}% \begin{Declaration} - \Macro{FamilyStringKey}\OParameter{Mitglied}\Parameter{Familie}\Parameter{Schlüssel}\\ + \Macro{FamilyCounterKey}\OParameter{Mitglied}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{\LaTeX-Zähler}\\ +% \hphantom{\XMacro{FamilyCounterKey}}% +% \Parameter{\LaTeX-Zähler} + \Macro{FamilySetCounter}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{\LaTeX-Zähler}\Parameter{Wert} +\end{Declaration} +\BeginIndex{Cmd}{FamilyCounterKey}% +\BeginIndex{Cmd}{FamilySetCounter}% +Während\ChangedAt{v3.12}{\Package{scrbase}} bei \Macro{FamilyNumericalKey} ein +Makro aufgrund eines symbolischen \PName{Wert}s auf einen korrespondierenden +nummerischen Wert gesetzt wurde, gibt es natürlich auch Fälle, in denen ein +\PName{Schlüssel} direkt einen \PName{\LaTeX-Zähler} rerpäsentiert, dem +unmittelbar ein nummerischer \PName{Wert} zugewiesen werden soll. Dazu dient +die Anweisung \Macro{FamilyCounterKey}, von der intern dann +\Macro{FamilySetCounter} aufgerufen wird. Dabei finden einige grundlegende +Prüfungen des \PName{Wert}-Arguments statt um festzustellen, ob dieses +Argument für eine Zuweisung an einen Zähler in Frage kommt. Die Zuweisung +findet nur statt, wenn diese Prüfungen gelingen. Allerdings können hier nicht +alle Fehler erkannt werden, so dass eine falsche Zuweisung auch zu einer +Fehlermeldung von \TeX{} selbst führen kann. Erkannte Fehler werden hingegen +über \Macro{FamilyKeyStateUnknownValue} signalisiert. + +Bitte beachten\textnote{Achtung!} Sie, dass diese Anweisungen keinen +Säumniswert unterstützen.% +\EndIndex{Cmd}{FamilySetCounter}% +\EndIndex{Cmd}{FamilyCounterKey}% + +\begin{Declaration} + \Macro{FamilyCounterMacroKey}\OParameter{Mitglied}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{Makro}\\ + \Macro{FamilySetCounterMacro}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{Makro}\Parameter{Wert}% +\end{Declaration} +\BeginIndex{Cmd}{FamilyCounterMacroKey}% +\BeginIndex{Cmd}{FamilySetCounterMacro}% +Diese\ChangedAt{v3.12}{\Package{scrbase}} beiden Anweisungen unterscheiden +sich von den zuvor erklärten \Macro{FamilyCounterKey} und +\Macro{FamilySetCounter} nur dadurch, dass nicht ein \LaTeX-Zähler auf einen +Wert gesetzt wird, sondern ein \PName{Makro} mit diesem Wert definiert +wird. Auch\textnote{Achtung!} dabei wird kein Säumniswert unterstützt.% +\EndIndex{Cmd}{FamilySetCounterMacro}% +\EndIndex{Cmd}{FamilyCounterMacroKey}% + +\begin{Declaration} + \Macro{FamilyLengthKey}\OParameter{Mitglied}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{Länge}\\ + \Macro{FamilySetLength}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{Länge}\Parameter{Wert}\\ + \Macro{FamilyLengthMacroKey}\OParameter{Mitglied}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{Makro}\\ + \Macro{FamilySetLengthMacro}\Parameter{Familie}% + \Parameter{Schlüssel}\Parameter{Makro}\Parameter{Wert}% +\end{Declaration} +\BeginIndex{Cmd}{FamilyLengthKey}% +\BeginIndex{Cmd}{FamilySetLength}% +\BeginIndex{Cmd}{FamilyLengthMacroKey}% +\BeginIndex{Cmd}{FamilySetLengthMacro}% +Über\ChangedAt{v3.12}{\Package{scrbase}} \Macro{FamilyLengthKey} kann ein +\PName{Schlüssel} definiert werden, der eine \PName{Länge} +repräsentiert. Dabei spielt es keine Rolle, ob eine \LaTeX-Länge, ein +\TeX-Abstand oder eine \TeX-Ausdehnung als \PName{Länge} verwendet +wird. Intern wird die \PName{Länge} über \Macro{FamilySetLength} gesetzt. +Dabei finden einige grundlegende Prüfungen des \PName{Wert}-Arguments statt um +festzustellen, ob dieses Argument für eine Zuweisung an eine \PName{Länge} in +Frage kommt. Die Zuweisung findet nur statt, wenn diese Prüfungen +gelingen. Allerdings können hier nicht alle Fehler erkannt werden, so dass +eine falsche Zuweisung auch zu einer Fehlermeldung von \TeX{} selbst führen +kann. Erkannte Fehler werden hingegen über \Macro{FamilyKeyStateUnknownValue} +signalisiert.% + +Bei Verwendung der Anweisungen \Macro{FamilyLengthMacroKey} und +\Macro{FamilySetLengthMacro} findet die Speicherung des Werts nicht in einer +\Macro{Länge}, sondern in einem \Macro{Makro} statt.% + +Bitte beachten Sie\textnote{Achtung!}, dass auch diese Anweisungen keinen +Säumniswert unterstützen.% +\EndIndex{Cmd}{FamilySetLengthMacro}% +\EndIndex{Cmd}{FamilyLengthMacroKey}% +\EndIndex{Cmd}{FamilySetLength}% +\EndIndex{Cmd}{FamilyLengthKey}% + +\begin{Declaration} + \Macro{FamilyStringKey}\OParameter{Mitglied}\Parameter{Familie}% + \Parameter{Schlüssel}\\ \hphantom{\XMacro{FamilyStringKey}}% \OParameter{Säumniswert}\Parameter{Makro} \end{Declaration} -% +\BeginIndex{Cmd}{FamilyStringKey}% Hier wird nun\ChangedAt{v3.08}{\Package{scrbase}} ein Schlüssel definiert, der jeden beliebigen Wert annehmen kann. Der Wert wird in dem angegebenen \PName{Makro} gespeichert. Wird das optionales Argument für den -\PName{Säumniswert} weg gelassen, so entspricht der Aufruf -\begin{quote} -\Macro{DefineFamilyKey}\OParameter{Mitglied}\Parameter{Familie}% -\Parameter{Schlüssel}\\ -\hphantom{\Macro{DefineFamilyKey}}% -\PParameter{\Macro{def}\PName{Makro}\string{\#1\string}}. -\end{quote} +\PName{Säumniswert} weggelassen, so entspricht die Anweisung: +\begin{lstcode}[belowskip=\dp\strutbox plus 1pt,escapeinside=»«] + \DefineFamilyKey[»\PName{Mitglied}«]{»\PName{Familie}«}{»\PName{Schlüssel}«} + {\def»\PName{Makro}«{#1}} +\end{lstcode} Existiert -das optionale Argument für den \PName{Säumniswert} so entspricht der Aufruf -\begin{quote} -\Macro{DefineFamilyKey}\OParameter{Mitglied}\Parameter{Familie}% -\Parameter{Schlüssel}\\ -\hphantom{\Macro{DefineFamilyKey}}% -\OParameter{Säumniswert}% -\PParameter{\Macro{def}\PName{Makro}\string{\#1\string}% -\Macro{FamilyKeyStateProcessed}}. -\end{quote} +das optionale Argument für den \PName{Säumniswert} so entspricht die Anweisung: +\begin{lstcode}[belowskip=\dp\strutbox plus 1pt,escapeinside=»«] + \DefineFamilyKey[»\PName{Mitglied}«]{»\PName{Familie}«}{»\PName{Schlüssel}«} + [»\PName{Säumniswert}«] + {\def»\PName{Makro}«{#1}\FamilyKeyStateProcessed} +\end{lstcode} + Ist \PName{Makro} noch nicht definiert, so wird es als leeres Makro definiert. \begin{Example} @@ -761,15 +869,14 @@ Wertzuweisung an den Schlüssel keine Absätze enthalten sein dürfen. % \EndIndex{Cmd}{FamilyStringKey}% -\BeginIndex{Cmd}{FamilyUnkownKeyValue}% \begin{Declaration} - \Macro{FamilyUnkownKeyValue}\Parameter{Familie}\Parameter{Schlüssel}% + \Macro{FamilyUnknownKeyValue}\Parameter{Familie}\Parameter{Schlüssel}% \Parameter{Wert}\Parameter{Werteliste} \end{Declaration} -Die Anweisung \Macro{FamilyUnkownKeyValue} signalisiert über -\Macro{FamilyKeyState} einen Fehler aufgrund eines unbekannten oder -unerlaubten Werts. Als \PName{Werteliste} -wird dabei eine durch Komma separierte Liste von erlaubten Werten der Form +\BeginIndex{Cmd}{FamilyUnknownKeyValue}% +Diese Anweisung signalisiert über \Macro{FamilyKeyState} einen Fehler aufgrund +eines unbekannten oder unerlaubten Werts. Dabei wird als \PName{Werteliste} +eine durch Komma separierte Liste von erlaubten Werten der Form \begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l} `\PName{Wert}'\texttt{,} `\PName{Wert}' \dots \end{tabular}\vskip\dp\strutbox\end{flushleft} @@ -803,27 +910,27 @@ erwartet. Allerdings\ChangedAt{v3.12}{\Package{scrbase}} wird die \fi }% \end{lstcode} - Hier wird zunächst versucht, den boolschen Schalter für Aufschnitt über - \Macro{FamilySetBool} zu setzen. Wenn dies über \Macro{FamilyKeyState} den - Erfolgs-Status \Macro{FamilyKeyStateProcessed} zurück liefert, wird nur noch - der Feinschnitt abgeschaltet. Anderenfalls wird überprüft, ob als Wert - keiner für den boolschen Schalter, sondern \PValue{fein} übergeben wurde. In - diesem Fall wird sowohl der Feinschnitt, als auch Aufschnitt aktiviert und - mit Hilfe von \Macro{FamilyKeyStateProcessed} der Erfolgs-Status - gesetzt. Ist auch das nicht der Fall, bleibt der von \Macro{FamilySetBool} - signalisierte Fehler-Zustand bestehen. - - Die bei den Tests verwendete Anweisung \Macro{ifstr} ist auf - \autopageref{desc:scrbase.cmd.ifstr} in \autoref{sec:scrbase.if} - erklärt. + Zunächst wird versucht, den booleschen Schalter für Aufschnitt über + \Macro{FamilySetBool} zu setzen. Gelingt dies, wurde also + \Macro{FamilyKeyState} zu \Macro{FamilyKeyStateProcessed} definiert, wird + der Feinschnitt abgeschaltet. Anderenfalls wird überprüft, ob an + Stelle eines gültigen Werts für einen booleschen Schalter %der Wert + \PValue{fein} übergeben wurde. In diesem Fall wird sowohl der Feinschnitt, + als auch Aufschnitt aktiviert und mit Hilfe von + \Macro{FamilyKeyStateProcessed} der Erfolgs-Status gesetzt. Ist auch das + nicht der Fall, bleibt der von \Macro{FamilySetBool} signalisierte + Fehler-Zustand bestehen. + + Die bei den Tests verwendete Anweisung \Macro{ifstr}\IndexCmd{ifstr} ist auf + \autopageref{desc:scrbase.cmd.ifstr} in \autoref{sec:scrbase.if} erklärt. \end{Example} % -\EndIndex{Cmd}{FamilyUnkownKeyValue}% +\EndIndex{Cmd}{FamilyUnknownKeyValue}% -\BeginIndex{Cmd}{FamilyElseValues}% \begin{Declaration} \Macro{FamilyElseValues} \end{Declaration} +\BeginIndex{Cmd}{FamilyElseValues}% In\ChangedAt{v3.12}{\Package{scrbase}} früheren Versionen von \Package{scrbase} konnte man über die Anweisung \Macro{FamilyElseValues} weitere erlaubte Werte für die Bearbeitung durch \Macro{FamilyUnknownValue} in der Form @@ -831,12 +938,11 @@ erlaubte Werte für die Bearbeitung durch \Macro{FamilyUnknownValue} in der Form \texttt{,} `\PName{Wert}'\texttt{,} `\PName{Wert}' \dots \end{tabular}\vskip\dp\strutbox\end{flushleft} ablegen, die dann ebenfalls in einer Fehlermeldung mit ausgegeben wurden. Seit -Version~3.12 gibt \Macro{FamilyUnknownValue} selbst keine Fehlermeldungen mehr +Version~3.12 gibt \Macro{FamilyUnknownValue} keine Fehlermeldungen mehr aus, sondern setzt nur noch \Macro{FamilyKeyState} entsprechend. Damit ist die Verwendung von \Macro{FamilyElseValue} ebenfalls überholt. Ihre Verwendung wird jedoch erkannt und führt dann zu einer Aufforderung, den Code -entsprechend anzupassen. -% +entsprechend anzupassen.% \EndIndex{Cmd}{FamilyElseValues}% @@ -846,7 +952,6 @@ entsprechend anzupassen. Das Paket \Package{scrbase} stellt eine ganze Reihe von Verzweigungsanweisungen zur Verfügung. Dabei wird nicht auf die \TeX-Syntax von Verzweigungen, wie beispielsweise -% Umbruchkorrektur \begin{lstcode}[belowskip=\dp\strutbox] \iftrue ... @@ -874,14 +979,14 @@ Paket- und Klassenautoren sollten wie \KOMAScript{} selbst auch die internen Namen verwenden. Zur Vollständigkeit sind aber auch die Anwenderanweisungen angegeben. -\BeginIndex{Cmd}{scr@ifundefinedorrelax}% -\BeginIndex{Cmd}{ifundefinedorrelax}% \begin{Declaration} \Macro{scr@ifundefinedorrelax}% \Parameter{Name}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}\\ \Macro{ifundefinedorrelax}% \Parameter{Name}\Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{scr@ifundefinedorrelax}% +\BeginIndex{Cmd}{ifundefinedorrelax}% Diese Anweisung funktioniert prinzipiell wie \Macro{@ifundefined} aus dem \LaTeX-Kern (siehe \cite{latex:source2e}). Es wird also der \PName{Dann-Teil} ausgeführt, wenn \PName{Name} der @@ -894,14 +999,14 @@ noch nicht einmal Hash-Speicher belegt. \EndIndex{Cmd}{ifundefinedorrelax}% \EndIndex{Cmd}{scr@ifundefinedorrelax}% -\BeginIndex{Cmd}{scr@ifpdftex} -\BeginIndex{Cmd}{ifpdftex} \begin{Declaration} \Macro{scr@ifpdftex}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil}\\ \Macro{ifpdftex}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{scr@ifpdftex}% +\BeginIndex{Cmd}{ifpdftex}% Wird mit pdf\TeX{} gearbeitet, so wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Dabei ist es unerheblich, ob tatsächlich eine PDF-Datei ausgegeben werden soll, oder nicht. Diese Unterscheidung ist @@ -911,14 +1016,14 @@ gewünschte Anweisung testen. \EndIndex{Cmd}{ifpdftex} \EndIndex{Cmd}{scr@ifpdftex} -\BeginIndex{Cmd}{scr@ifVTeX} -\BeginIndex{Cmd}{ifVTeX} \begin{Declaration} \Macro{scr@ifVTeX}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil}\\ \Macro{ifVTeX}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{scr@ifVTeX}% +\BeginIndex{Cmd}{ifVTeX}% Wird mit V\TeX{} gearbeitet, so wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. In der Regel sollte man eher auf die gewünschte Anweisung @@ -927,14 +1032,14 @@ testen. \EndIndex{Cmd}{ifVTeX} \EndIndex{Cmd}{scr@ifVTeX} -\BeginIndex{Cmd}{scr@ifpdfoutput} -\BeginIndex{Cmd}{ifpdfoutput} \begin{Declaration} \Macro{scr@ifpdfoutput}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil}\\ \Macro{ifpdfoutput}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{scr@ifpdfoutput}% +\BeginIndex{Cmd}{ifpdfoutput}% Wird eine PDF-Datei erzeugt, so wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Dabei ist es unerheblich, ob die PDF-Datei mit Hilfe von pdf\TeX{} oder mit Hilfe von V\TeX{} erzeugt wird. @@ -942,16 +1047,16 @@ PDF-Datei mit Hilfe von pdf\TeX{} oder mit Hilfe von V\TeX{} erzeugt wird. \EndIndex{Cmd}{ifpdfoutput} \EndIndex{Cmd}{scr@ifpdfoutput} -\BeginIndex{Cmd}{scr@ifpsoutput} -\BeginIndex{Cmd}{ifpsoutput} \begin{Declaration} \Macro{scr@ifpsoutput}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil}\\ \Macro{ifpsoutput}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{scr@ifpsoutput}% +\BeginIndex{Cmd}{ifpsoutput}% Wird eine PostScript-Datei erzeugt, so wird der \PName{Dann-Teil} ausgeführt, -anderenfalls der \PName{Sonst-Teil}. V\TeX{} kann PostScript direkt erzeugten, +anderenfalls der \PName{Sonst-Teil}. V\TeX{} kann PostScript direkt erzeugen, was hier auch erkannt wird. Wird hingegen kein V\TeX{} verwendet, ist aber ein Schalter \Macro{if@dvips} definiert, so wird die Entscheidung darüber getroffen. \KOMAScript{} stellt \Macro{if@dvips} in \Package{typearea} bereit. @@ -959,14 +1064,14 @@ getroffen. \KOMAScript{} stellt \Macro{if@dvips} in \Package{typearea} bereit. \EndIndex{Cmd}{ifpsoutput} \EndIndex{Cmd}{scr@ifpsoutput} -\BeginIndex{Cmd}{scr@ifdvioutput} -\BeginIndex{Cmd}{ifdvioutput} \begin{Declaration} \Macro{scr@ifdvioutput}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil}\\ \Macro{ifdvioutput}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{scr@ifdvioutput}% +\BeginIndex{Cmd}{ifdvioutput}% Wird eine DVI-Datei erzeugt, so wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es wird immer dann davon ausgegangen, dass eine DVI-Datei erzeugt wird, wenn keine direkte Ausgabe einer PDF- oder @@ -975,22 +1080,22 @@ Postscript-Datei erkannt werden kann. \EndIndex{Cmd}{ifdvioutput} \EndIndex{Cmd}{scr@ifdvioutput} -\BeginIndex{Cmd}{ifnotundefined} \begin{Declaration} \Macro{ifnotundefined}\Parameter{Name}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{ifnotundefined}% Unter Verwendung von \eTeX{} wird hier tatsächlich getestet, ob die Anweisung mit dem angegebenen \PName{Name} noch undefiniert ist. Von dieser Anweisung gibt es keine interne Variante. % \EndIndex{Cmd}{ifnotundefined} -\BeginIndex{Cmd}{ifstr} \begin{Declaration} \Macro{ifstr}\Parameter{Zeichenfolge}\Parameter{Zeichenfolge}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{ifstr}% Die beiden Argumente \PName{Zeichenfolge} werden expandiert und dann verglichen. Sind sie dabei gleich, so wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Von dieser Anweisung gibt es keine @@ -999,8 +1104,8 @@ interne Variante. \EndIndex{Cmd}{ifstr} \begin{Declaration} - \Macro{ifstrstart}\Parameter{Zeichenfolge}\Parameter{Zeichenfolge}% - \Parameter{Dann-Teil}\Parameter{Sonst-Teil} + \Macro{ifstrstart}\Parameter{Zeichenfolge}\Parameter{Zeichenfolge}\\ + \hphantom{\XMacro{ifstrstart}}\Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} \BeginIndex{Cmd}{ifstrstart}% Die\ChangedAt{v3.12}{\Package{scrbase}} beiden Argumente \PName{Zeichenfolge} @@ -1131,34 +1236,35 @@ Wenn\ChangedAt{v3.12}{\Package{scrbase}} \PName{Zähler} ein definierter Anweisung gibt es keine interne Variante.% \EndIndex{Cmd}{ifiscounter}% -\BeginIndex{Cmd}{ifnumber} \begin{Declaration} \Macro{ifnumber}\Parameter{Zeichenfolge}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{ifnumber}% Hier werden keine Zahlen verglichen. Der \PName{Dann-Teil} wird vielmehr -ausgeführt, wenn die Expansion der \PName{Zeichenfolge} nur aus Ziffern -besteht. Anderenfalls wird der \PName{Sonst-Teil} verwendet. Von dieser -Anweisung gibt es keine interne Variante.% +ausgeführt, wenn die einfache Expansion der \PName{Zeichenfolge} nur aus +Ziffern besteht. Anderenfalls wird der \PName{Sonst-Teil} verwendet. Von +dieser Anweisung gibt es keine interne Variante.% \EndIndex{Cmd}{ifnumber} -\BeginIndex{Cmd}{ifdimen} \begin{Declaration} \Macro{ifdimen}\Parameter{Zeichenfolge}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} +\BeginIndex{Cmd}{ifdimen}% Hier werden keine Längen verglichen. Der \PName{Dann-Teil} wird vielmehr -ausgeführt, wenn die Expansion der \PName{Zeichenfolge} eine gültige Länge mit -einer gültigen Längeneinheit ist. Anderenfalls wird der \PName{Sonst-Teil} -verwendet. Von dieser Anweisung gibt es keine interne Variante. +ausgeführt, wenn die einfache Expansion der \PName{Zeichenfolge} eine gültige +Länge mit einer gültigen Längeneinheit ist. Anderenfalls wird der +\PName{Sonst-Teil} verwendet. Von dieser Anweisung gibt es keine interne +Variante. % \EndIndex{Cmd}{ifdimen} -\BeginIndex{Cmd}{if@atdocument}% \begin{Declaration} \Macro{if@atdocument}\ \PName{Dann-Teil} \Macro{else}\ \PName{Sonst-Teil} \Macro{fi} \end{Declaration} +\BeginIndex{Cmd}{if@atdocument}% Diese Verzweigung existiert ganz bewusst nur als interne Anweisung. Dabei entspricht \Macro{if@atdocument} in der Dokumentpräambel \Macro{iffalse}, nach \Macro{begin}\PParameter{document} entspricht \Macro{if@document} hingegen @@ -1187,14 +1293,18 @@ Grund ist es sinnvoll die Änderungen mit Hilfe von \Macro{AtBeginDocument} bis \Macro{begin}\PParameter{document}, also bis nach dem Laden aller Pakete, zu verzögern. Auch der Anwender muss entweder von \Macro{AtBeginDocument} Gebrauch machen oder aber seine Änderungen nicht in die Dokumentpräambel, -sondern hinter \Macro{begin}\PParameter{document} einfügen. Das Paket -\Package{scrbase} bietet ihm für die Definition selbst einige zusätzliche -Anweisungen. +sondern hinter \Macro{begin}\PParameter{document} einfügen. + +Darüber hinaus kommt erschwerend hinzu, dass einige Pakete zusätzliche, +sprachabhängige Begriffe in \Macro{captions\PName{Sprache}} definieren, +während andere dafür \Macro{extras\PName{Sprache}} verwenden. So muss der +Anwender sich schon sehr genau auskennen, um die richtige Anweisung auf die +richtige Weise zu ergänzen. + +Das Paket \Package{scrbase} bietet dem Anwender daher für die Definition +selbst einige zusätzliche Anweisungen, die ihn von vielen dieser Überlegungen +entlasten. -\BeginIndex{Cmd}{defcaptionname}% -\BeginIndex{Cmd}{providecaptionname}% -\BeginIndex{Cmd}{newcaptionname}% -\BeginIndex{Cmd}{renewcaptionname}% \begin{Declaration} \Macro{defcaptionname}% \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt}\\ @@ -1213,12 +1323,16 @@ Anweisungen. \Macro{renewcaptionname*}% \Parameter{Sprachliste}\Parameter{Begriff}\Parameter{Inhalt} \end{Declaration} -Mit Hilfe dieser drei Anweisungen ist es möglich, einem \PName{Begriff} in -Abhängigkeit der Sprache einen \PName{Inhalt} zuzuweisen. Mehrere Sprachen -können durch Komma voneinander getrennt als +\BeginIndex{Cmd}{defcaptionname}% +\BeginIndex{Cmd}{providecaptionname}% +\BeginIndex{Cmd}{newcaptionname}% +\BeginIndex{Cmd}{renewcaptionname}% +Mit Hilfe dieser vier Anweisungen und ihrer Sternvarianten ist es möglich, +einem \PName{Begriff} in Abhängigkeit der Sprache einen \PName{Inhalt} +zuzuweisen. Mehrere Sprachen können durch Komma voneinander getrennt als \PName{Sprachliste}\ChangedAt{v3.12}{\Package{scrbase}} angegeben werden. -Der \PName{Begriff} ist immer ein Makro. Die Arbeitsweise der drei Anweisungen +Der \PName{Begriff} ist immer ein Makro. Die Arbeitsweise der Anweisungen unterscheidet sich je nachdem, ob eine Sprache und ein \PName{Begriff} innerhalb dieser Sprache zum Zeitpunkt des Aufrufs bereits definiert ist. @@ -1248,30 +1362,53 @@ Sprache jedoch nicht, so wird ebenfalls eine Fehlermeldung ausgegeben. Ist der \PName{Begriff} in der Sprache definiert, so wird er auf den gewünschten \PName{Inhalt} umdefiniert. +Die\ChangedAt{v3.12}{\Package{scrbase}} Anweisung \Macro{defcaptionname} +definiert einen \PName{Begriff} immer, überschreibt also eventuell vorhandene +Definitionen. Wie bei \Macro{providecaptionname} braucht eine angegebene +Sprache nicht definiert zu sein. + \KOMAScript{} selbst verwendet \Macro{providecaptionname} um die Begriffe aus -\autoref{sec:scrlttr2-experts.languages} zu definieren. +\autoref{sec:scrlttr2-experts.languages}, +\autopageref{desc:scrlttr2-experts.cmd.yourrefname} zu definieren. \begin{Example} - Möchten Sie statt »Abbildung« in den Abbildungsunterschriften lieber »Abb.« - stehen haben, so erreichen Sie dies mit: + Möchten Sie »Abb.« statt »Abbildung« in den Abbildungsunterschriften, so + erreichen Sie dies mit: \begin{lstcode} \renewcaptionname{ngerman}{\figurename}{Abb.} \end{lstcode} - Soll dieselbe Änderung nicht nur für die Sprache \PValue{ngerman}, sondern - auch für Sprache \PValue{naustrian}, also für Österreichisch gelten, so ist - es nicht notwendig eine zweite Anweisung: + + Soll dieselbe Änderung nicht nur für \PValue{ngerman}, sondern + auch für die Sprachen \PValue{naustrian} und \PValue{nswissgerman}, also für + Österreichisch und Schweizer Deutsch gelten, so ist + es nicht notwendig zwei weitere Anweisungen: \begin{lstcode} \renewcaptionname{naustrian}{\figurename}{Abb.} + \renewcaptionname{nswissgerman}{\figurename}{Abb.} \end{lstcode} hinzuzufügen. Stattdessen kann einfach, die \PName{Sprachliste} erweitert werden: \begin{lstcode} - \renewcaptionname{ngerman,naustrian{\figurename}{Abb.} + \renewcaptionname{ngerman,naustrian,nswissgerman}% + {\figurename}{Abb.} \end{lstcode} - In gleicher Weise können auch \PValue{german} und \PValue{austrian}, also - Deutsch und Österreichisch nach der veralteten Rechtschreibung, hinzugefügt - werden. + In gleicher Weise können auch \PValue{german}, \PValue{austrian} und + \PValue{swissgerman}, also Deutsch, Österreichisch und Schweizer Deutsch + nach der veralteten Rechtschreibung, hinzugefügt werden. \end{Example} +\begin{Explain} + Die Sprachen \PValue{swissgerman} und \PValue{nswissgerman} werden übrigens + von älteren Versionen von \Package{babel} noch nicht unterstützt. Sie sind + erst seit Dezember~2013 Bestandteil des deutschen Sprachpakets für + \Package{babel}. Für die Anweisungen \Macro{defcaptionname}, + \Macro{newcaptionname} und \Macro{providecaptionname} spielt dies kaum eine + Rolle, da diese auch Begriffe für nicht existierende Sprachen definieren + können. Da mit \Macro{renewcaptionname} jedoch nur existierende Begriffe von + existierenden Sprachen umdefiniert werden können, resultiert die + Umdefinierung für \Option{nswissgerman} und \Option{swissgerman} bei + Verwendung einer älteren Version von \Package{babel} in einer entsprechenden + Fehlermeldung. +\end{Explain} Seit \KOMAScript~3.12\ChangedAt{v3.12}{\Package{scrbase}} ist es auch nicht mehr erforderlich, die Definierung oder Umdefinierung mit Hilfe von @@ -1281,9 +1418,10 @@ Anweisungen in der Dokumentpräambel aufgerufen werden. Außerdem prüft \Package{scrbase} nun auch, ob ein umzudefinierender Begriff statt in \Macro{captions\PName{Sprache}} in \Macro{extras\PName{Sprache}} zu definieren ist. Die neuen Sternvarianten der Befehle verwenden grundsätzlich -\Macro{captions\PName{Sprache}}. Damit funktioniert nun in der Regel auch das -Umdefinieren von sprachabhängigen Bezeichnern von Paketen wie -\Package{hyperref}, die dafür \Macro{extras\PName{Sprache}} verwenden. +\Macro{extras\PName{Sprache}}, da dessen Definitionen in der Regel nach +\Macro{captions\PName{Sprache}} Anwendung finden. Damit funktioniert nun in +der Regel auch das Umdefinieren von sprachabhängigen Bezeichnern von Paketen +wie \Package{hyperref}, die dafür \Macro{extras\PName{Sprache}} verwenden. In \autoref{tab:scrbase.commonNames} ist ein Überblick über die üblicherweise von Klassen und Sprachpaketen definierten Begriffe und deren Verwendung zu @@ -1397,16 +1535,16 @@ finden. \section{Identifikation von \KOMAScript} \label{sec:scrbase.identify} -Auch wenn \Package{scrbase} unabhängig von \KOMAScript{} auch für andere +Obwohl \Package{scrbase} unabhängig von \KOMAScript{} auch für andere Pakete und Klassen verwendet werden kann, so ist es dennoch ein \KOMAScript-Paket. Als solches enthält es auch Anweisungen, die es als \KOMAScript-Paket identifizieren. -\BeginIndex{Cmd}{KOMAScript}% \begin{Declaration} \Macro{KOMAScript} \end{Declaration} +\BeginIndex{Cmd}{KOMAScript}% Diese Anweisung setzt schlicht die Wortmarke »\KOMAScript« in serifenloser Schrift und mit leichter Sperrung des in Versalien gesetzten Teils. \Macro{KOMAScript} wird übrigens bei Bedarf von allen @@ -1416,10 +1554,10 @@ Teils. \Macro{KOMAScript} wird übrigens bei Bedarf von allen \EndIndex{Cmd}{KOMAScript} -\BeginIndex{Cmd}{KOMAScriptVersion}% \begin{Declaration} \Macro{KOMAScriptVersion} \end{Declaration} +\BeginIndex{Cmd}{KOMAScriptVersion}% Bei \KOMAScript{} ist in dieser Anweisung die Hauptversion von \KOMAScript{} in der Form »\PName{Datum} \PName{Version} \texttt{KOMA-Script}« abgelegt. Diese Hauptversion ist für alle \KOMAScript-Klassen und alle @@ -1439,12 +1577,12 @@ lässt aber ganz ähnliche Anweisungen, die ebenfalls häufiger benötigt werden oder eigentlich nahe liegen, vermissen. Einige wenige solcher Anweisungen für Klassen- und Paketautoren stellt \Package{scrbase} zur Verfügung. -\BeginIndex{Cmd}{PackageInfoNoLine}% -\BeginIndex{Cmd}{ClassInfoNoLine}% \begin{Declaration} \Macro{ClassInfoNoLine}\Parameter{Klassenname}\Parameter{Information}\\ \Macro{PackageInfoNoLine}\Parameter{Paketname}\Parameter{Information}% \end{Declaration}% +\BeginIndex{Cmd}{PackageInfoNoLine}% +\BeginIndex{Cmd}{ClassInfoNoLine}% Der \LaTeX-Kern bietet dem Klassen- und Paketautor zwar Anweisungen wie \Macro{PackageInfo} und \Macro{ClassInfo}, um Informationen mit aktueller Zeilennummer in die Log-Datei zu schreiben. Er bietet neben @@ -1459,13 +1597,13 @@ von \Package{scrbase} bereit gestellt. \EndIndex{Cmd}{ClassInfoNoLine}% \EndIndex{Cmd}{PackageInfoNoLine} -\BeginIndex{Cmd}{l@addto@macro}% \begin{Declaration} \Macro{l@addto@macro}\Parameter{Anweisung}\Parameter{Erweiterung}% \end{Declaration}% +\BeginIndex{Cmd}{l@addto@macro}% Der \LaTeX-Kern bietet mit \Macro{g@addto@macro} eine interne Anweisung, um die Definition eines Makro \PName{Anweisung} global um den Code -\PName{Erweiterung} zu erweitern. Dies funktioniert in dieser Form nur für +\PName{Erweiterung} zu erweitern. Das funktioniert in dieser Form nur für Makros ohne Argumente. Dennoch könnte man diese Anweisung in einigen Fällen auch in einer Form benötigen, die lokal zur aktuellen Gruppe arbeitet. Diese wird mit \Macro{l@addto@macro} von \Package{scrbase} bereit gestellt. Eine @@ -1482,28 +1620,29 @@ Anweisungen für unterschiedliche Zwecke bietet (siehe Das für \LaTeX{} inzwischen verwendete und von \KOMAScript{} vorausgesetzte \eTeX{} besitzt mit \Macro{numexpr}\IndexCmd{numexpr} erweiterte Möglichkeiten -zur Berechnung einfacher Ausrücke mit \TeX-Zählern und ganze Zahlen. Als +zur Berechnung einfacher Ausdrücke mit \TeX-Zählern und ganzen Zahlen. Als Operationen werden dabei die vier Grundrechenarten und Klammern unterstützt. Bei der Division wird korrekt gerundet. Manchmal sind weitere Operationen nützlich. -\BeginIndex{Cmd}{XdivY}% -\BeginIndex{Cmd}{XmodY}% \begin{Declaration} \Macro{XdivY}\Parameter{Dividend}\Parameter{Divisor}\\ \Macro{XmodY}\Parameter{Dividend}\Parameter{Divisor}% \end{Declaration}% +\BeginIndex{Cmd}{XdivY}% +\BeginIndex{Cmd}{XmodY}% Die\ChangedAt{v3.05a}{\Package{scrbase}} Anweisung \Macro{XdivY} liefert den -Wert des Ganzzahlquotienten, die Anweisung \Macro{XmodY} den Wert des Rests -der Division mit Rest. Diese Art der Division ist nach der Gleichung +Wert des ganzzahligen Quotienten, die Anweisung \Macro{XmodY} den Wert des +Rests der Division mit Rest. Diese Art der Division ist nach der Gleichung \[ \textit{Dividend} = \textit{Divisor} \cdot -\textit{Ganzzahlquotient} + \textit{Rest} +\textit{Quotient} + \textit{Rest} \] % -definiert, wobei \textit{Dividend} und \textit{Rest} ganze Zahlen und -\textit{Rest} außerdem größer oder gleich 0 und kleiner als \textit{Divisor} -ist. Der \textit{Divisor} ist eine natürliche Zahl (ohne die 0). +definiert, wobei \textit{Dividend}, \textit{Divisor} und \textit{Rest} ganze +Zahlen und \textit{Rest} außerdem größer oder gleich 0 und kleiner als +\textit{Divisor} ist. Der \textit{Divisor} ist eine natürliche Zahl (ohne die +0). Der Wert kann jeweils zur Zuweisung an einen Zähler oder direkt innerhalb eines Ausdrucks mit \Macro{numexpr} verwendet werden. Zur Ausgabe als @@ -1518,6 +1657,18 @@ arabische Zahl ist \Macro{the} voran zu stellen.% %%% Local Variables: %%% mode: latex +%%% mode: flyspell %%% coding: iso-latin-1 -%%% TeX-master: "guide.tex" +%%% ispell-local-dictionary: "de_DE" +%%% TeX-master: "../guide.tex" %%% End: + +% LocalWords: Paketoptionen Familienmitglieder Familienmitglieds Säumniswert +% LocalWords: Fleischermeister FamilyProcessOptions ProcessOption keyval Cmd +% LocalWords: documentclass ProcessOptions FamilyExecuteOptions currname +% LocalWords: Optionenliste ExecuteOptions DeclareOption currext Wurstsalat +% LocalWords: FamilyOptions FamilyKeyState Wurstpakete nonsense package true +% LocalWords: Wurstpaket FamilyOption salatmit SalatZusatz scrbase false +% LocalWords: AtEndOfFamilyOptions FamilyBoolKey FamilySetBool Schaltername +% LocalWords: FamilyLengthKey FamilySetLength FamilyLengthMacroKey +% LocalWords: FamilySetLengthMacro |