diff options
author | Karl Berry <karl@freefriends.org> | 2018-04-02 21:16:13 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-04-02 21:16:13 +0000 |
commit | 1610548529befd1cb7d72da00a3a889261436642 (patch) | |
tree | 04d20de3c80be1f24b619689213ebb794979c0ee /Master/texmf-dist/source/latex/koma-script/doc/ngerman/scrbase.tex | |
parent | 635bc4f06033428fe01440c71f242ec9b68fe092 (diff) |
koma-script (2apr18)
git-svn-id: svn://tug.org/texlive/trunk@47249 c570f23f-e606-0410-a88d-b1316a301751
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 | 950 |
1 files changed, 580 insertions, 370 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 ea55f54c140..f7f3f533d33 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-2017 +% Copyright (c) Markus Kohm, 2002-2018 % % 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-2017 +% Copyright (c) Markus Kohm, 2002-2018 % % 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: 2017-04-22 16:16:15 +0200 (Sat, 22 Apr 2017) $ + [$Date: 2018-02-16 04:42:17 +0100 (Fri, 16 Feb 2018) $ KOMA-Script package scrbase] \chapter{Grundlegende Funktionen im Paket \Package{scrbase}} @@ -64,62 +64,25 @@ haben, können von der Funktionalität von \Package{scrbase} profitieren. \seclabel{loadit} Während Anwender ein Paket mit Hilfe von \Macro{usepackage} laden, verwenden -Paket- und Klassenautoren \Macro{RequirePackage}. Autoren von Wrapper-Paketen -nutzen auch \Macro{RequirePackageWithOptions}. Bei Verwendung von -\Macro{RequirePackage} können wie bei \Macro{usepackage} Optionen angegeben +Paket- und Klassenautoren +\Macro{RequirePackage}\IndexCmd{RequirePackage}. Autoren von Wrapper-Paketen +nutzen auch +\Macro{RequirePackageWithOptions}\IndexCmd{RequirePackageWithOptions}. Bei +Verwendung von \Macro{RequirePackage} können wie bei +\Macro{usepackage}\IndexCmd{usepackage} Optionen angegeben werden. Demgegenüber erhält das Paket bei \Macro{RequirePackageWithOptions} alle Optionen, mit denen zuvor das Wrapper-Paket geladen wurde. Näheres zu diesen Anweisungen ist \cite{latex:clsguide} zu entnehmen. Das Paket \Package{scrbase} benötigt intern die Funktionalität des Pakets -\Package{keyval}\IndexPackage{keyval}. Diese kann auch vom Paket -\Package{xkeyval} zur Verfügung gestellt werden. Bei Bedarf lädt -\Package{scrbase} selbst \Package{keyval}. +\Package{keyval}\IndexPackage{keyval}\important{\Package{keyval}}. Diese kann +auch vom Paket \Package{xkeyval} zur Verfügung gestellt werden. Bei Bedarf +lädt \Package{scrbase} selbst \Package{keyval}. 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}. - -\begin{Declaration} - \OptionVName{internalonly}{Wert} -\end{Declaration} -Von \Package{scrbase} werden einige Verzweigungsanweisungen -bereitgestellt. Dabei verwendet es primär die Bezeichnungen -\Macro{scr@\PName{Name}}. Es handelt sich somit um interne -Anweisungen. Diese werden auch intern von \KOMAScript{} verwendet. Paket- und -Klassenautoren können diese Anweisungen ebenfalls verwenden, sollten sie aber -nicht umdefinieren. Da einige dieser Anweisungen auch für Benutzer nützlich -sein können, werden die gleichen Anweisungen normalerweise auch als -\Macro{\PName{Name}} bereitgestellt. Da eventuell andere Pakete -gleichnamige Anweisungen mit anderer Syntax bereitstellen könnten und es so zu -Konflikten kommen könnte, kann der Anwender die Definition von -\Macro{\PName{Name}} verhindern. Dazu gibt er entweder die Option -ohne Wertangabe an. In diesem Fall werden nur die internen -Verzweigungsanweisungen definiert. Oder er gibt genau die Anweisungen, die -nicht definiert werden sollen, als Wert an, wobei er »\Macro{}« durch -»\texttt{/}« ersetzt. - -Paket- und Klassenautoren sollten diese Option normalerweise nicht verwenden. -Anwender können sie mit oder ohne Wertangabe entweder als globale Option bei -\Macro{documentclass} oder per \Macro{PassOptionsToPackage} angeben. -\begin{Example} - Der Anwender will nicht, dass die Anweisungen \Macro{ifVTeX} und - \DescRef{\LabelBase.cmd.ifundefinedorrelax} von \Package{scrbase} definiert werden. Also - verwendet er beim Laden der Klasse: -\begin{lstcode} - \documentclass% - [internalonly=/ifVTeX/ifundefinedorrelax]% - {foo} -\end{lstcode} - Der Klassenname \Class{foo} wird hier als Platzhalter für irgendeine Klasse - verwendet. Die Bedeutungen der Anweisungen \Macro{ifVTeX} und - \DescRef{\LabelBase.cmd.ifundefinedorrelax} sowie weitere Verzweigungsanweisungen sind - \autoref{sec:scrbase.if}, %\DescPageRef{scrbase.cmd.ifVTeX} und - %\DescPageRef{scrbase.cmd.ifundefinedorrelax} - ab \autopageref{sec:scrbase.if} zu entnehmen. -\end{Example} -% -\EndIndexGroup +verwenden die \Package{keyval}-Syntax: \OptionVName{\PName{Schlüssel}}{Wert}% +\important{\OptionVName{\PName{Schlüssel}}{Wert}}. \section{Schlüssel als Eigenschaften von Familien und deren Mitgliedern} @@ -155,20 +118,20 @@ des Ladens einer Klasse oder eines Pakets sind \Macro{@currname} und 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 +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, 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 -Familie »\PValue{KOMA}« \KOMAScript{} vorbehalten. Es wird empfohlen für -eigene Pakete den Namen des Gesamtpakets als Familie und den Namen einzelner -Pakete im Gesamtpaket als Mitglied zu verwenden. +fügt ihr das Mitglied »\PValue{.scrbase.sty}« hinzu. Grundsätzlich sind die +Familien »\PValue{KOMA}« und »\PValue{KOMAarg}« \KOMAScript{} vorbehalten. Es +wird empfohlen, für eigene Pakete den Namen des Gesamtpakets als Familie und +den Namen einzelner Pakete im Gesamtpaket als Mitglied zu verwenden. % \begin{Example} - Angenommen Sie schreiben ein neues Gesamtpaket »Fleischermeister«. Darin + Angenommen, Sie schreiben ein neues Gesamtpaket »Fleischermeister«. Darin befinden sich die Pakete \File{Salami.sty}, \File{Mettwurst.sty} und \File{Krakauer.sty}. Daher entscheiden Sie sich für den Familienname »\PValue{Fleischermeister}« und fügen in jedem der Pakete die Zeilen @@ -199,17 +162,20 @@ Pakete im Gesamtpaket als Mitglied zu verwenden. \end{Declaration} 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 -angegeben, so wird wieder das Mitglied -»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« angenommen. Wird -später dem \PName{Schlüssel} ein Wert zugewiesen, so wird \PName{Aktion} +dieses Mitglieds der angegebenen \PName{Familie}. Ist\textnote{Hinweis} +\OParameter{Mitglied} nicht angegeben, so wird wieder das Mitglied +»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« angenommen. Ist das +\PName{Mitglied} hingegen leer, so wird ein Familienschlüssel anstelle eines +Mitgliederschlüssels definiert. + +Wird später dem \PName{Schlüssel} ein Wert zugewiesen, so wird \PName{Aktion} ausgeführt, wobei der Wert als Parameter übergeben wird. Innerhalb von \PName{Aktion} steht also »\lstinline{#1}« für den übergebenen Wert. Wurde kein Wert übergeben, so wird stattdessen der \PName{Säumniswert} eingesetzt. Falls kein \PName{Säumniswert} angegeben wird, kann später der \PName{Schlüssel} nur mit Wertübergabe verwendet werden. -\begin{Explain} +%\begin{Explain} \phantomsection\label{explain:scrbase.macro.DefineFamilyKey}% Letztlich führt \begin{lstcode}[escapeinside=»«] @@ -225,18 +191,21 @@ eingesetzt. Falls kein \PName{Säumniswert} angegeben wird, kann später der definiert ist (siehe \cite{package:keyval}). Allerdings kommen zu dem Aufruf von \Macro{define@key} noch einige zusätzliche Vorkehrungen und auch die \PName{Aktion} wird um zusätzliche Vorkehrungen erweitert. -\end{Explain} +%\end{Explain} Erfolg\ChangedAt{v3.12}{\Package{scrbase}} oder Misserfolg der Ausführung der \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 +an \Package{scrbase} zurückgemeldet, damit dieses je nach Bedarf und +Verwendung des Schlüssels weitere Maßnahmen ergreifen kann. Dies kann +beispielsweise eine Fehlermeldung aber auch nur die Signalisierung einer +unbekannten Option sein. + +Der Zustand \Macro{FamilyKeyState} ist in der Voreinstellung identisch mit dem +Zustand \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. @@ -251,9 +220,9 @@ 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 +beispielsweise \hyperref[cha:typearea]{\Package{typearea}}, wenn versucht +wird, an Option \DescRef{typearea.option.twoside} den Wert \PValue{unbekannt} +zuzuweisen. Die Umschaltung auf den Zustand erfolgt einfach durch Aufruf von \Macro{FamilyKeyStateUnknownValue} selbst. Der Zustand @@ -265,7 +234,7 @@ wurde. Dieser Zustand wird automatisch gesetzt, wenn ein Schlüssel, der keinen 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 +Des Weiteren können zusätzliche Fehlerzustände definiert werden, indem man \Macro{FamilyKeyState} auf eine kurze Meldung umdefiniert. In der Regel sollten jedoch die vier vordefinierten Zustände verwendet werden. @@ -279,7 +248,8 @@ sollten jedoch die vier vordefinierten Zustände verwendet werden. \newif\if@Salami@Aufschnitt \DefineFamilyKey{Fleischermeister}% {Aufschnitt}[true]{% - \expandafter\let\expandafter\if@Salami@Aufschnitt + \expandafter\let + \expandafter\if@Salami@Aufschnitt \csname if#1\endcsname \FamilyKeyStateProcessed } @@ -289,8 +259,8 @@ sollten jedoch die vier vordefinierten Zustände verwendet werden. 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. + Wertzuweisung verwendet werden. In letzterem Fall kommt der Säumniswert + \PName{true} zum Einsatz. Für die anderen beiden Pakete kann das fast identisch definiert werden. Lediglich die Zeichenfolge »\texttt{Salami}« ist jeweils zu @@ -309,22 +279,31 @@ Wurde\ChangedAt{v3.15}{\Package{scrbase}} \PName{Schlüssel} zuvor als quasi aufgehoben. Der \PName{Schlüssel} ist dann für dieses \PName{Mitglied} der \PName{Familie} nicht mehr definiert. Die Verwendung für einen \PName{Schlüssel}, der für dieses \PName{Mitglied} der \PName{Familie} gar -nicht definiert ist, ist ebenfalls zulässig.% +nicht definiert ist, ist ebenfalls zulässig. + +Ist kein \PName{Mitglied} angegeben, so wird genau wie bei Anweisung +\DescRef{\LabelBase.cmd.DefineFamilyKey} wieder das Mitglied +»\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« angenommen. Allerdings +wird \Macro{RelaxFamilyKey} selten während des Ladens eines Pakets, +sondern häufiger zur Laufzeit verwendet. Daher ist \PName{Mitglied} in der +Regel auch explizit anzugeben.% \EndIndexGroup \begin{Declaration} \Macro{FamilyProcessOptions}\OParameter{Mitglied}\Parameter{Familie} \end{Declaration} -Grundsätzlich ist die Erweiterung der Schlüssel von Familien auf Familien -und Familienmitglieder dazu gedacht, dass Schlüssel beziehungsweise die +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 können. Diese Anweisung stellt daher eine Erweiterung von -\Macro{ProcessOptions*} aus dem \LaTeX-Kern dar (siehe +\Macro{ProcessOptions*}\IndexCmd{ProcessOptions*}% +\important{\Macro{ProcessOption*}} 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 -eines angegebenen Familienmitglieds abgearbeitet. Wird das optionale Argument -\PName{Mitglied} nicht angegeben, so wird wieder das Mitglied +die mit \Macro{DeclareOption}\IndexCmd{DeclareOption}% +\important{\Macro{DeclareOption}} definiert wurden. Es werden auch alle +Schlüssel eines angegebenen Familienmitglieds abgearbeitet. Wird das optionale +Argument \PName{Mitglied} nicht angegeben, so wird wieder das Mitglied »\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}« verwendet. Eine Besonderheit sind Schlüssel, die nicht einem Familienmitglied, sondern @@ -332,14 +311,16 @@ der Familie selbst zugeordnet sind, bei der also das Mitglied leer geblieben ist. Diese werden ebenfalls gesetzt und zwar noch bevor der Schlüssel des Mitglieds gesetzt wird. \begin{Example} - Wenn in den Paketen aus den zurückliegenden Beispielen die Zeile + Wenn in den Paketen aus den zurückliegenden Beispielen nach der Definition + der Schlüssel die Zeile \begin{lstcode} \FamilyProcessOptions{Fleischermeister} \end{lstcode} - ergänzt wird, so kann der Anwender bereits beim Laden der Pakete die - Eigenschaft \Option{Aufschnitt} wählen. Wird die Option global, also bei - \Macro{documentclass} angegeben, so wird die Eigenschaft automatisch bei - allen drei Paketen gesetzt, wenn alle drei Pakete geladen werden. + ergänzt wird, so kann der Anwender bereits beim Laden der Pakete mit + \Macro{usepackage} die Eigenschaft \Option{Aufschnitt} als Option + angeben. Wird die Option global, also bei \Macro{documentclass}, angegeben, + so wird die Eigenschaft automatisch bei allen drei Paketen gesetzt, wenn + alle drei Pakete einzeln geladen werden. \end{Example} Es\textnote{Achtung!} wird darauf hingewiesen, dass bei Paketen globale Optionen vor den lokal dem Paket zugewiesenen Optionen ausgeführt @@ -370,39 +351,45 @@ Ausführung von Optionen Pakete zu laden.%, die selbst Insbesondere\ChangedAt{v3.18}{\Package{scrbase}} Autoren von Wrapper-Klassen wünschen manchmal, in ein Paket oder eine Klasse noch vor der Verarbeitung der Optionen eines zukünftig geladenen Pakets oder einer zukünftig geladenen -Klasse mit \DescRef{\LabelBase.cmd.FamilyProcessOptions} eingreifen zu können. Dies ist mit -\Macro{BeforeFamilyProcessOptions} möglich. Das Paket \Package{scrbase} bietet -dafür einen sogenannten Haken (engl. \emph{hook}). Diesem kann man mit -\Macro{BeforeFamilyProcessOptions} neuen \PName{Code} hinzufügen. Die -Parameter \PName{Mitglied} und \PName{Familie} entsprechen dabei denen von +Klasse mit \DescRef{\LabelBase.cmd.FamilyProcessOptions} eingreifen zu +können. Dies ist mit \Macro{BeforeFamilyProcessOptions} möglich. Das Paket +\Package{scrbase} bietet dafür einen sogenannten Haken\Index{Haken} +(engl. \emph{hook}). Diesem kann man mit \Macro{BeforeFamilyProcessOptions} +neuen \PName{Code} hinzufügen. Die Parameter \PName{Mitglied} und +\PName{Familie} entsprechen dabei denen von \Macro{FammilyProcessOptions}. Allerdings kann man auch den Haken von Familien-Mitgliedern \PName{Code} hinzufügen, wenn bisher die \PName{Familie} oder das \PName{Mitglied} noch gar nicht definiert ist. Der Haken eines Familien-Mitglieds wird übrigens nach dessen Ausführung automatisch gelöscht. Verwendet man hingegen ein leeres \PName{Mitglied}, so -wird dieser Haken für alle Mitglieder der \PName{Familie} ausgeführt und -bleibt auch über die Ausführung hinaus erhalten. +wird dieser Haken\Index{Haken} für alle Mitglieder der \PName{Familie} +ausgeführt und bleibt auch über die Ausführung hinaus erhalten. \begin{Example} - Sie schreiben ein Paket, das selbst \Package{Mettwurst} lädt. Allerdings - wollen Sie nicht, dass für dieses Paket die Option \Option{Aufschnitt} - gesetzt werden kann. Daher deaktivieren sie die Option vor dem Laden des - Pakets über \Macro{BeforeFamilyProcessOptions}. + Sie schreiben ein Paket \Package{Rauchwurst}, das selbst \Package{Mettwurst} + lädt. Allerdings wollen Sie nicht, dass für dieses Paket die Option + \Option{Aufschnitt} gesetzt werden kann. Daher deaktivieren sie die Option + vor dem Laden des Pakets über \Macro{BeforeFamilyProcessOptions}. \begin{lstcode} \RequirePackage{scrbase} - \BeforeFamilyProcessOptions[.Mettwurst.sty]{Fleischermeister}{% - \RelaxFamilyKey[.Mettwurst.sty]{Fleischermeister}{Aufschnitt}% + \BeforeFamilyProcessOptions[.Mettwurst.sty]% + {Fleischermeister}{% + \RelaxFamilyKey[.Mettwurst.sty]% + {Fleischermeister}{Aufschnitt}% } \RequirePackageWithOptions{Mettwurst} \end{lstcode} - Versucht nun jemand Ihr Paket mit Option \Option{Aufschnitt} zu laden, so - meldet das Paket \Package{Mettwurst}, dass diese Option nicht bekannt - ist. Wird die Option \Option{Aufschnitt} als globale Option angegeben, so - ignoriert Paket \Package{Mettwurst} diese. Voreinstellungen innerhalb des - Pakets beispielsweise mit \DescRef{\LabelBase.cmd.FamilyExecuteOptions} noch vor - \DescRef{\LabelBase.cmd.FamilyProcessOptions} sind allerdings davon - unabhängig. + Versucht nun jemand Ihr Paket mit Option + \Option{Aufschnitt} zu laden, so meldet das Paket \Package{Mettwurst}, dass + diese Option nicht bekannt ist. Wird die Option \Option{Aufschnitt} als + globale Option angegeben, so ignoriert Paket \Package{Mettwurst} + diese. Voreinstellungen innerhalb des Pakets \Package{Mettwurst}, die + beispielsweise mit \DescRef{\LabelBase.cmd.FamilyExecuteOptions} noch vor + \DescRef{\LabelBase.cmd.FamilyProcessOptions} erfolgen könnten, wären + allerdings davon unabhängig. Aber natürlich kann man eigene + Voreinstellungen von \Package{Rauchwurst} aus ebenfalls per + \Macro{BeforeFamilyProcessOptions} in \Package{Mettwurst} einschleusen.% \end{Example} \EndIndexGroup @@ -421,14 +408,15 @@ eines angegebenen Familienmitglieds abgearbeitet. Wird das optionale Argument Eine Besonderheit sind Schlüssel, die nicht einem Familienmitglied, sondern der Familie selbst zugeordnet sind, bei der also das Mitglied leer geblieben -ist. Diese werden ebenfalls gesetzt und zwar noch bevor der Schlüssel des +ist. Diese werden ebenfalls gesetzt, und zwar noch bevor der Schlüssel des Mitglieds gesetzt wird. \begin{Example} Angenommen, die Option \Option{Aufschnitt} soll in den zurückliegenden Beispielen bereits als Voreinstellung gesetzt werden, so müssen die Pakete - nur um die Zeile + nur um den Aufruf \begin{lstcode} - \FamilyExecuteOptions{Fleischermeister}{Aufschnitt} + \FamilyExecuteOptions{Fleischermeister} + {Aufschnitt} \end{lstcode} ergänzt werden. \end{Example} @@ -436,11 +424,12 @@ Mitglieds gesetzt wird. Wird\ChangedAt{v3.20}{\Package{scrbase}} \Macro{FamilyExecuteOptions} mit einer nicht definierten Option in der \PName{Optionenliste} aufgerufen, so wird normalerweise ein Fehler ausgegeben. Eine Ausnahme von dieser Regel ist, -wenn für das \PName{Mitglied} eine Option namens \Option{@else@} definiert -wurde. In diesem Fall wird statt der unbekannten Option eben diese Option -\Option{@else@} verwendet. Innerhalb von \KOMAScript{} wird das -beispielsweise verwendet, um die Stil-Option bei der Definition von -Gliederungsbefehlen vor allen anderen auszuwerten. +wenn für das \PName{Mitglied} eine Option namens +\Option{@else@}\important{\Option{@else@}} definiert wurde. In diesem Fall +wird statt der unbekannten Option eben diese Option \Option{@else@} +verwendet. Innerhalb von \KOMAScript{} wird das beispielsweise genutzt, um +die Stil-Option bei der Definition von Gliederungsbefehlen vor allen anderen +auszuwerten. Diese Anweisung darf auch innerhalb der Ausführung von Optionen verwendet werden.% @@ -451,18 +440,18 @@ werden.% \begin{Declaration} \Macro{FamilyOptions}\Parameter{Familie}\Parameter{Optionenliste}% \end{Declaration} -Die \PName{Optionenliste} hat dabei die Form: -\begin{flushleft}\begin{tabular}{l} - \PName{Schlüssel}\texttt{=}\PName{Wert}\texttt{,}% - \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. - Im Gegensatz zu normalen Optionen, die mit \Macro{DeclareOption} definiert wurden, können die \PName{Schlüssel} auch noch nach dem Laden der Klasse oder des Pakets gesetzt werden. Dazu verwendet der Anwender -\Macro{FamilyOptions}. Dabei werden die \PName{Schlüssel} aller Mitglieder der +\Macro{FamilyOptions}. Die \PName{Optionenliste} hat dabei die Form: +%\begin{flushleft}\begin{tabular}{l} + \PName{Schlüssel}\texttt{=}\PName{Wert}\texttt{,}\linebreak[1]% + \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. + +Durch die Anweisung werden die \PName{Schlüssel} aller Mitglieder der angegebenen \PName{Familie} gesetzt. Existiert ein \PName{Schlüssel} auch als Eigenschaft der Familie selbst, so wird dieser Familien-Schlüssel zuerst gesetzt. Danach folgen die Mitglieder-Schlüssel in der Reihenfolge, in der die @@ -470,7 +459,8 @@ Mitglieder definiert wurden. Existiert ein angegebener \PName{Schlüssel} weder für die Familie noch für ein Mitglied der Familie, so wird von \Macro{FamilyOptions} ein Fehler ausgegeben. Dies geschieht ebenfalls, wenn zwar für einige Mitglieder ein Schlüssel existiert, jedoch jedes dieser -Mitglieder über \DescRef{\LabelBase.cmd.FamilyKeyState} einen Fehler zurückmeldet. +Mitglieder über \DescRef{\LabelBase.cmd.FamilyKeyState} einen Fehler +zurückmeldet. \begin{Example} Sie ergänzen das Fleischermeister-Projekt um ein weiteres Paket \Package{Wurstsalat}. Wird dieses Paket verwendet, so sollen alle @@ -492,7 +482,7 @@ Mitglieder über \DescRef{\LabelBase.cmd.FamilyKeyState} einen Fehler zurückmelde \DefineFamilyKey{Fleischermeister}% {Aufschnitt}[true]{}% \end{lstcode} - Allerdings produzieren so Wurstpakete, die nach + Allerdings produzieren so Wurstpakete, die nach Paket \Package{Wurstsalat} geladen werden, keinen Aufschnitt. Dies kann man ebenfalls ändern: \begin{lstcode} @@ -503,21 +493,32 @@ Mitglieder über \DescRef{\LabelBase.cmd.FamilyKeyState} einen Fehler zurückmelde } \DefineFamilyKey{Fleischermeister}% {Aufschnitt}[true]{% - \AtBeginDocument{\FamilyOptions{Fleischermeister}% - {Aufschnitt=#1}}% + \AtBeginDocument{% + \FamilyOptions{Fleischermeister}% + {Aufschnitt=#1}% + }% }% \end{lstcode} 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 - \DescRef{\LabelBase.cmd.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} + ausübt. Da nach dem Laden von \Package{Wurstsalat}, innerhalb von + \Macro{begin}\PParameter{document} die beiden Anweisungen \Macro{@currname} + und \Macro{@currext} nicht mehr den Dateinamen des Pakets enthalten, muss + zwingend das optionale Argument von \DescRef{\LabelBase.cmd.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 Familie und all ihre Mitglieder ausführt und damit auch für andere + Wurstpakete setzt. Die Verzögerung der Ausführung von \Macro{FamilyOptions} + ist hier entscheidend. Zum einen werden nur so später geladene Wurstpakete + erfasst. Zum anderen wird dadurch sichergestellt, dass die eigene Option + \Option{Aufschnitt} bereits umdefiniert wurde. Dadurch wird eine endlose + Rekursion vermieden.% +\end{Example}% % \EndIndexGroup +\vskip-\ht\strutbox% Umbruchkorrektur wegen Beispiel am Ende \begin{Declaration} @@ -526,14 +527,14 @@ Mitglieder über \DescRef{\LabelBase.cmd.FamilyKeyState} einen Fehler zurückmelde \end{Declaration} 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 \DescRef{\LabelBase.cmd.FamilyOptions} notwendig, der Option mehrfach -einen Wert zuzuweisen und dabei die Option selbst mehrfach +wäre es bei Verwendung von \DescRef{\LabelBase.cmd.FamilyOptions} notwendig, +der Option mehrfach einen Wert zuzuweisen und dabei die Option selbst mehrfach 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 -\end{tabular}\end{flushleft} +%\begin{flushleft}\begin{tabular}{l} + \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 weitere Funktionsweise ist der vorhergehenden Erklärung zu @@ -554,7 +555,7 @@ setzt. Die weitere Funktionsweise ist der vorhergehenden Erklärung zu definiert. Eine Fehlerbehandlung für den Fall, dass der Anwender unbekannte Zutaten fordert, existiert nicht. - Für einen Salat mit Zwiebeln und Gurken, kann der Anwender + Für einen Salat mit Zwiebeln und Gurken kann der Anwender \begin{lstcode} \FamilyOptions{Fleischermeister}{% SalatZusatz=Zwiebeln,SalatZusatz=Gurken} @@ -586,7 +587,7 @@ oder \DescRef{\LabelBase.cmd.FamilyOption}\IndexCmd{FamilyOptions} abgeschlossen sind. Genau das ist mit Hilfe von \Macro{AtEndOfFamilyOptions} und dessen Sternvariante\ChangedAt{v3.23}{\Package{scrbase}} 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 +möglich wie die Verwendung dieser Anweisung außerhalb der Ausführung von Optionen. Die beiden Variante unterscheiden sich im Falle von verschachtelt definierten @@ -595,8 +596,10 @@ anderen Option bedingt. In diesem Fall werden alle per \Macro{AtEndOfFamilyOptions} festgelegten Aktionen ausgeführt, sobald der innerste Optionenaufruf endet. Dagegen werden die per \Macro{AtEndOfFamilyOptions*} festgelegten Aktionen erst mit dem Ende des -äußersten Optionenaufrufs ausgeführt. Die Reihenfolge der Aktionen ist dabei -jedoch ausdrücklich unbestimmt!% +äußersten Optionenaufrufs ausgeführt. Die Reihenfolge\textnote{Achtung!} der +Aktionen ist dabei jedoch ausdrücklich unbestimmt! Weder ist sichergestellt, +dass zuerst angeforderte Aktionen auch zuerst ausgeführt werden, noch die +umgekehrte Reihenfolge.% \EndIndexGroup @@ -615,13 +618,13 @@ 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 \DescRef{\LabelBase.cmd.DefineFamilyKey} (siehe -\DescPageRef{scrbase.cmd.DefineFamilyKey}). Das Argument -\PName{Schaltername} ist der Name eines Schalter ohne den Präfix -\Macro{if}. Existiert dieser Schalter noch nicht, so wird er automatisch -definiert und mit \PName{false} voreingestellt. Intern verwendet -\Macro{FamilyBoolKey} dann \Macro{FamilySetBool} als \PName{Aktion} für -\DescRef{\LabelBase.cmd.DefineFamilyKey}. Der Säumniswert für eine solche Option ist immer -\PValue{true}. +\DescPageRef{scrbase.cmd.DefineFamilyKey}). Das Argument \PName{Schaltername} +ist der Name eines Schalter ohne den Präfix \Macro{if}. Existiert dieser +Schalter noch nicht, so wird er automatisch definiert und mit \PName{false} +voreingestellt. Intern verwendet \Macro{FamilyBoolKey} dann +\Macro{FamilySetBool} als \PName{Aktion} für +\DescRef{\LabelBase.cmd.DefineFamilyKey}. Der Säumniswert für eine solche +Option ist immer \PValue{true}. \Macro{FamilySetBool} wiederum versteht als \PName{Wert} neben \PValue{true} auch die Werte \PValue{on} und \PValue{yes} zum Einschalten und neben @@ -650,35 +653,41 @@ dann gegebenenfalls eine Meldung über eine unbekannte Wertzuweisung ausgegeben ... \fi \end{lstcode} - Dies wäre dann in allen drei Wurstpaketen identisch. Damit könnte man + Dies wäre in allen drei Wurstpaketen identisch. Damit könnte man prinzipiell die Eigenschaft »Aufschnitt« auch als Eigenschaft der Familie definieren: \begin{lstcode}[moretexcs={define@key}] \@ifundefined{if@Aufschnitt}{% - \expandafter\newif\csname if@Aufschnitt\endcsname + \expandafter\newif + \csname if@Aufschnitt\endcsname }{}% - \DefineFamilyKey[]{Fleischermeister} + \DefineFamilyKey[]{Fleischermeister}% {Aufschnitt}[true]{% - \FamilySetBool{Fleischermeister}{Aufschnitt}% - {@Aufschnitt}% - {#1}% + \FamilySetBool{Fleischermeister}% + {Aufschnitt}% + {@Aufschnitt}% + {#1}% } \end{lstcode} oder einfacher \begin{lstcode} - \FamilyBoolKey[]{Fleischermeister}{Aufschnitt}% - {@Aufschnitt} + \FamilyBoolKey[]{Fleischermeister}% + {Aufschnitt}% + {@Aufschnitt} \end{lstcode} - unter Ausnutzung des weiterführenden Hinweises auf - \autopageref{explain:scrbase.macro.DefineFamilyKey}, der nicht nur für - \DescRef{\LabelBase.cmd.DefineFamilyKey}, sondern entsprechend auch für \Macro{FamilyBoolKey} - gilt. - - Da \DescRef{\LabelBase.cmd.FamilyKeyState} bereits von \Macro{FamilySetBool} gesetzt wird, - kann innerhalb der Definition der Option mit Hilfe von - \DescRef{\LabelBase.cmd.DefineFamilyKey} der Status gegebenenfalls auch abgefragt werden. So - könnte man im ersten Fall beispielsweise nach \Macro{FamilySetBool} einen - Test der Art: + unter Ausnutzung des Hinweises bezüglich leerer Mitglieder + \iftrue% Umbruchkorrekturtext + im Gegensatz zum Weglassen des optionalen Arguments + \fi% + auf \autopageref{explain:scrbase.macro.DefineFamilyKey}, der nicht nur für + \DescRef{\LabelBase.cmd.DefineFamilyKey}, sondern entsprechend auch für + \Macro{FamilyBoolKey} gilt. + + Da \DescRef{\LabelBase.cmd.FamilyKeyState} bereits von \Macro{FamilySetBool} + gesetzt wird, kann innerhalb der Definition der Option mit Hilfe von + \DescRef{\LabelBase.cmd.DefineFamilyKey} der Status gegebenenfalls auch + abgefragt werden. So könnte man im ersten Fall beispielsweise nach + \Macro{FamilySetBool} einen Test der Art: \begin{lstcode} \ifx\FamilyKeyState\FamilyKeyStateProcessed ... @@ -687,10 +696,12 @@ dann gegebenenfalls eine Meldung über eine unbekannte Wertzuweisung ausgegeben \fi \end{lstcode} 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. + \Macro{FamilySetBool} erfolgreich war oder nicht, + auszuführen. Es\textnote{Achtung!} 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. Sie können abhängig vom + aktuellen Status und dem Vergleichszustand zu unterschiedlichen + Fehlermeldungen und auch zu falschen Ergebnissen führen.% \end{Example} % \EndIndexGroup @@ -706,24 +717,25 @@ dann gegebenenfalls eine Meldung über eine unbekannte Wertzuweisung ausgegeben \Parameter{Wert} \end{Declaration} 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 +mehrere Werte kennen. So kann beispielsweise eine Ausrichtung nicht nur +entweder links oder nicht links, sondern auch links, mittig oder rechts sein. Intern unterscheidet man solche Einstellungen dann gerne mit Hilfe von -\Macro{ifcase}. Diese \TeX-Anweisung erwartet wiederum einen nummerischen -Wert. Daher heißt bei \Package{scrbase} die Anweisung, mit der man via -\PName{Schlüssel} einem Makro eine Definition zuweisen kann, entsprechend -\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} % - \dots -\end{tabular}\vskip\dp\strutbox\end{flushleft} +\Macro{ifcase}\IndexCmd{ifcase}. Diese \TeX-Anweisung erwartet wiederum einen +nummerischen Wert. Daher heißt bei \Package{scrbase} die Anweisung, mit der +man via \PName{Schlüssel} einem Makro eine Definition zuweisen kann, +entsprechend \Macro{FamilyNumericalKey}. + +Die \PName{Werteliste} hat dabei die Form: +%\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l} + \Parameter{Wert}\Parameter{Definition}\texttt{,}\linebreak[1]% + \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 -\PName{Schlüssels} angegeben. Für jeden erlaubten \PName{Wert} wird auch +\PName{Schlüssel} angegeben. Für jeden erlaubten \PName{Wert} wird auch gleich angegeben, wie bei Verwendung desselben das Makro \Macro{\PName{Makroname}} definiert werden soll. Üblicherweise werden als -\PName{Definition} schlicht Zahlenwerte angegeben. Es sind aber auch andere -Angaben möglich. Derzeit gibt es aber die Einschränkung, dass +\PName{Definition} schlicht Zahlenwerte angegeben. Es sind zwar auch andere +Angaben möglich, derzeit gibt es aber die Einschränkung, dass \PName{Definition} voll expandierbar sein muss und bei der Zuweisung auch expandiert wird. \begin{Example} @@ -775,7 +787,7 @@ expandiert wird. \end{lstcode} unterschieden werden. \end{Example} -% + Intern wird von \Macro{FamilyNumericalKey} dann \DescRef{\LabelBase.cmd.DefineFamilyKey} mit der Anweisung \Macro{FamilySetNumerical} verwendet. Wird an einen solchen Schlüssel ein @@ -802,9 +814,9 @@ Erfolg via \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} in \end{Declaration} Während\ChangedAt{v3.12}{\Package{scrbase}} bei \DescRef{\LabelBase.cmd.FamilyNumericalKey} ein Makro aufgrund eines -symbolischen \PName{Wert}s auf einen korrespondierenden nummerischen Wert +symbolischen Wertes 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 +direkt einen \PName{\LaTeX-Zähler} reprä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 @@ -819,6 +831,12 @@ Wurde\ChangedAt{v3.15}{\Package{scrbase}} kein Wert übergeben, so wird stattdessen der \PName{Säumniswert} eingesetzt. Falls kein \PName{Säumniswert} angegeben wird, kann später der \PName{Schlüssel} nur mit Wertübergabe verwendet werden.% +\iffalse% Umbruchkorrekturtext +\ Anderenfalls wir mit +\DescRef{\LabelBase.cmd.FamilyKeyStateNeedValue} ein entsprechender Fehler +signalisiert und beispielsweise innerhalb \Macro{FamilyOptions} auch als +solcher gemeldet.% +\fi% \EndIndexGroup @@ -832,9 +850,11 @@ verwendet werden.% \end{Declaration} Diese\ChangedAt{v3.12}{\Package{scrbase}} beiden Anweisungen unterscheiden sich von den zuvor erklärten \DescRef{\LabelBase.cmd.FamilyCounterKey} und -\DescRef{\LabelBase.cmd.FamilySetCounter} nur dadurch, dass nicht ein \LaTeX-Zähler auf einen -Wert gesetzt wird, sondern ein \PName{Makro} mit diesem Wert definiert -wird.% +\DescRef{\LabelBase.cmd.FamilySetCounter} nur dadurch, dass nicht ein +\LaTeX-Zähler auf einen Wert gesetzt wird, sondern ein \PName{Makro} mit +diesem Wert definiert wird. Auch dabei wird \PName{Wert} lokal einem Zähler +zugewiesen und dann dessen expandierter Wert verwendet. Es gilt daher der Wert +zum Zeitpunkt des Aufrufs der Option.% \EndIndexGroup @@ -862,8 +882,8 @@ 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 \DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} -signalisiert. +kann. Erkannte Fehler werden hingegen über +\DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} signalisiert. Wurde\ChangedAt{v3.15}{\Package{scrbase}} kein Wert übergeben, so wird stattdessen der \PName{Säumniswert} eingesetzt. Falls kein \PName{Säumniswert} @@ -871,9 +891,8 @@ angegeben wird, kann später der \PName{Schlüssel} nur mit Wertübergabe verwendet werden. 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.% +\Macro{FamilySetLengthMacro} findet die Speicherung des Wertes nicht in einer +\PName{Länge}, sondern in einem \PName{Makro} statt.% \EndIndexGroup @@ -881,11 +900,14 @@ statt.% \Macro{FamilyStringKey}\OParameter{Mitglied}\Parameter{Familie} \Parameter{Schlüssel} \OParameter{Säumniswert}\Parameter{Makro} + \Macro{FamilyCSKey}\OParameter{Mitglied}\Parameter{Familie} + \Parameter{Schlüssel} + \OParameter{Säumniswert}\Parameter{Makronamen} \end{Declaration} 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 optionale Argument für den -\PName{Säumniswert} weggelassen, so entspricht die Anweisung: +\PName{Säumniswert} weggelassen, so entspricht \Macro{FamilyStringKey}: \begin{lstcode}[escapeinside=»«] \DefineFamilyKey[»\PName{Mitglied}«]{»\PName{Familie}«}{»\PName{Schlüssel}«} {\def»\PName{Makro}«{#1}} @@ -898,8 +920,6 @@ das optionale Argument für den \PName{Säumniswert} so entspricht die Anweisung: {\def»\PName{Makro}«{#1}\FamilyKeyStateProcessed} \end{lstcode} -Ist -\PName{Makro} noch nicht definiert, so wird es als leeres Makro definiert. \begin{Example} In der Voreinstellung sollen 250\,g Wurstsalat erzeugt werden. Die Menge soll jedoch einfach per Option geändert werden können. Dazu wird die zu @@ -909,9 +929,17 @@ Ist \begin{lstcode} \newcommand*{\Salatgewicht}{250g} \FamilyStringKey{Fleischermeister}% - {Salatgewicht}[250g]{\Salatgewicht} + {Salatgewicht}[250g]% + {\Salatgewicht} +\end{lstcode} + Soll nach einer Änderung + \iffalse% Umbruchkorrekturtext + wie +\begin{lstcode} + \FamilyOptions{Fleichermeister}{Salatgewicht=100g} \end{lstcode} - Soll nach einer vorherigen Änderung wieder die Standardmenge hergestellt + \fi% + wieder die Standardmenge hergestellt werden, so kann der Anwender die Option einfach ohne Gewichtsangabe aufrufen: \begin{lstcode} @@ -923,6 +951,11 @@ Ist In diesem Fall existieren keine unbekannten Werte, da alle Werte schlicht für eine Makrodefinition verwendet werden. Es ist jedoch zu beachten, dass in der Wertzuweisung an den Schlüssel keine Absätze enthalten sein dürfen. + +Im\ChangedAt{v3.25}{\Package{scrbase}} Unterschied zu \Macro{FamilyStringKey} +erwartet \Macro{FamilyCSKey} kein Makro als letztes Argument, sondern +lediglich den Namen eines Makros, also beispielsweise nicht +\PParameter{\Macro{Salatgewicht}}, sondern \PParameter{Salatgewicht}.% % \EndIndexGroup @@ -932,14 +965,15 @@ Wertzuweisung an den Schlüssel keine Absätze enthalten sein dürfen. \Parameter{Wert}\Parameter{Werteliste} \end{Declaration} Diese Anweisung signalisiert über \DescRef{\LabelBase.cmd.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} +einen Fehler aufgrund eines unbekannten oder unerlaubten Wertes. 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} erwartet. Allerdings\ChangedAt{v3.12}{\Package{scrbase}} wird die \PName{Werteliste} derzeit nicht ausgewertet. + \begin{Example} Für den Aufschnitt soll nun zusätzlich wählbar sein, ob er grob oder fein geschnitten werden soll. Dabei ist grob die Voreinstellung, die auch @@ -964,20 +998,36 @@ erwartet. Allerdings\ChangedAt{v3.12}{\Package{scrbase}} wird die \@Aufschnitttrue \@Feinschnittrue \FamilyKeyStateProcessed - }{}% + }{% + \FamilyUnknownKeyValue{Fleichermeister}% + {Aufschnitt}% + {#1}{% + `true', `on', `yes', + `false`, `off`, `no', + `fein'% + }% + }% \fi }% \end{lstcode} Zunächst wird versucht, den booleschen Schalter für Aufschnitt über \DescRef{\LabelBase.cmd.FamilySetBool} zu setzen. Gelingt dies, wurde also - \DescRef{\LabelBase.cmd.FamilyKeyState} zu \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} definiert, wird - der Feinschnitt abgeschaltet. Anderenfalls wird überprüft, ob an - Stelle eines gültigen Werts für einen booleschen Schalter %der Wert + \DescRef{\LabelBase.cmd.FamilyKeyState} zu + \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} definiert, wird + der Feinschnitt abgeschaltet. Anderenfalls wird überprüft, ob anstelle + eines gültigen Wertes 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 - \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} der Erfolgs-Status gesetzt. Ist auch das - nicht der Fall, bleibt der von \DescRef{\LabelBase.cmd.FamilySetBool} signalisierte - Fehler-Zustand bestehen. + \DescRef{\LabelBase.cmd.FamilyKeyStateProcessed} der Erfolgs-Status + gesetzt. Ist auch das nicht der Fall, wird der von + \DescRef{\LabelBase.cmd.FamilySetBool} signalisierte Fehler-Zustand + neu auf \DescRef{\LabelBase.cmd.FamilyKeyStateUnknownValue} gesetzt. Die + Liste der üblichen erlaubten Werte von + \DescRef{\LabelBase.cmd.FamilySetBool} wird dabei um \PValue{fein} + ergänzt. Da diese Liste jedoch inzwischen nicht mehr verwendet wird, hätte + man auf den Aufruf von \Macro{FamilyUnknownKeyValue} im Beispiel auch + einfach verzichten und damit den Fehlerstatus von + \DescRef{\LabelBase.cmd.FamilySetBool} übernehmen können. Die bei den Tests verwendete Anweisung \Macro{ifstr}\IndexCmd{ifstr} ist auf \DescPageRef{scrbase.cmd.ifstr} in \autoref{sec:scrbase.if} erklärt. @@ -989,13 +1039,16 @@ erwartet. Allerdings\ChangedAt{v3.12}{\Package{scrbase}} wird die \begin{Declaration} \Macro{FamilyElseValues} \end{Declaration} -In\ChangedAt{v3.12}{\Package{scrbase}} früheren Versionen von -\Package{scrbase} konnte man über die Anweisung \Macro{FamilyElseValues} +In\ChangedAt{v3.12}{\Package{scrbase}} früheren\textnote{Veraltet!} Versionen +von \Package{scrbase} konnte man über die Anweisung \Macro{FamilyElseValues} weitere erlaubte Werte für die Bearbeitung durch -\DescRef{\LabelBase.cmd.FamilyUnknownKeyValue} in der Form +\DescRef{\LabelBase.cmd.FamilyUnknownKeyValue} +\iffalse% Umbruchkorrekturtext +in der Form \begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l} \texttt{,} `\PName{Wert}'\texttt{,} `\PName{Wert}' \dots \end{tabular}\vskip\dp\strutbox\end{flushleft} +\fi% ablegen, die dann ebenfalls in einer Fehlermeldung mit ausgegeben wurden. Seit Version~3.12 gibt \DescRef{\LabelBase.cmd.FamilyUnknownKeyValue} keine Fehlermeldungen mehr aus, sondern setzt nur noch @@ -1011,7 +1064,7 @@ 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 +von Verzweigungen wie beispielsweise \begin{lstcode} \iftrue ... @@ -1026,18 +1079,54 @@ kennt. Einige Paketautoren ziehen es allerdings vor, die \TeX-Syntax auch für Anwender in die \LaTeX-Ebene zu bringen. Da es sich bei den Verzweigungen von \Package{scrbase} um recht grundlegende Möglichkeiten handelt, ist die Wahrscheinlichkeit gegeben, dass dabei gleichnamige Anwenderanweisungen -verwendet würden. Dies würde selbst bei eigentlich gleicher Semantik -zwangsläufig zu einem Problem aufgrund der unterschiedlichen Syntax -führen. Deshalb definiert \Package{scrbase} einige dieser Anweisungen zunächst -als interne Anweisungen mit dem Präfix \Macro{scr@}. Für den Anwender werden -dann gleichbedeutende Anweisungen ohne diesen Präfix bereit -gestellt. Letzteres kann jedoch mit Hilfe der Option -\DescRef{\LabelBase.option.internalonly} (siehe \autoref{sec:scrbase.loadit}, -\DescPageRef{scrbase.option.internalonly}) verhindert werden. +verwendet würden. Dies könnte selbst bei eigentlich gleicher Semantik +zu einem Problem aufgrund unterschiedlichen Syntax +führen. \Package{scrbase} geht daher auf Nummer sicher. + +\begin{Declaration} + \OptionVName{internalonly}{Wert} +\end{Declaration} +Von \Package{scrbase} werden einige Verzweigungsanweisungen +bereitgestellt. Dabei verwendet es primär die Bezeichnungen +\Macro{scr@\PName{Name}}\textnote{Paketautoren}. Es handelt sich somit +um interne Anweisungen. Diese werden auch intern von \KOMAScript{} +verwendet. Paket- und Klassenautoren können diese Anweisungen ebenfalls +verwenden, sollten sie aber nicht umdefinieren. Da einige dieser Anweisungen +auch für Benutzer nützlich sein können, werden die gleichen Anweisungen +normalerweise auch als \Macro{\PName{Name}}\textnote{Anwender} +bereitgestellt. Da eventuell andere Pakete gleichnamige Anweisungen mit +anderer Syntax bereitstellen könnten und es so zu Konflikten kommen könnte, +kann der Anwender die Definition von \Macro{\PName{Name}} verhindern. Dazu +gibt er entweder die Option ohne Wertangabe an. In diesem Fall werden nur die +internen Verzweigungsanweisungen definiert. Oder er gibt genau die +Anweisungen, die nicht definiert werden sollen, als Wert an, wobei er +»\Macro{}« durch »\texttt{/}« ersetzt. + +Paket- und Klassenautoren sollten diese Option normalerweise nicht verwenden. +Anwender können sie mit oder ohne Wertangabe entweder als globale Option bei +\DescRef{maincls.cmd.documentclass} oder per +\Macro{PassOptionsToPackage}\IndexCmd{PassOptionsToPackage} angeben. +\begin{Example} + Der Anwender will nicht, dass die Anweisungen + \DescRef{\LabelBase.cmd.ifVTeX} und + \DescRef{\LabelBase.cmd.ifundefinedorrelax} von \Package{scrbase} definiert + werden. Also verwendet er beim Laden der Klasse: +\begin{lstcode} + \documentclass[% + internalonly=/ifVTeX/ifundefinedorrelax% + ]{foo} +\end{lstcode} + Der Klassenname \Class{foo} wird hier als Platzhalter für irgendeine Klasse + verwendet. Die Anweisungen \DescRef{\LabelBase.cmd.ifVTeX} + und \DescRef{\LabelBase.cmd.ifundefinedorrelax} werden im weiteren Verlauf + dieses Abschnittes erklärt.% +\end{Example} Paket- und Klassenautoren sollten wie \KOMAScript{} selbst auch die internen -Namen verwenden. Zur Vollständigkeit sind aber auch die Anwenderanweisungen -angegeben. +Namen verwenden. Zur Vollständigkeit sind in den nachfolgenden Erklärungen +aber auch die Anwenderanweisungen angegeben.% +\EndIndexGroup + \begin{Declaration} \Macro{scr@ifundefinedorrelax} @@ -1045,30 +1134,83 @@ angegeben. \Macro{ifundefinedorrelax} \Parameter{Name}\Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -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 -Name einer undefinierten Anweisung oder \Macro{\PName{Name}} derzeit -\Macro{relax} ist. Im Unterschied zu \Macro{@ifundefined} wird -allerdings \Macro{\PName{Name}} nicht als \Macro{relax} definiert, -wenn es zuvor undefiniert war. Unter Verwendung von \eTeX{} wird in diesem Fall -noch nicht einmal Hash-Speicher belegt. -% +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 Name einer undefinierten Anweisung oder +\Macro{\PName{Name}} derzeit \Macro{relax} ist. Im Unterschied zu +\Macro{@ifundefined} wird % +\iftrue% Umbruchvarianten +weder Hash-Speicher belegt noch \Macro{\PName{Name}} % +\else% +\Macro{\PName{Name}} nicht % +\fi% +zu \Macro{relax}, wenn \Macro{\PName{Name}} zuvor undefiniert war.% \EndIndexGroup \begin{Declaration} + \Macro{ifnotundefined}\Parameter{Name}% + \Parameter{Dann-Teil}\Parameter{Sonst-Teil} +\end{Declaration} +Ist die Anweisung mit dem angegebenen Namen bereits definiert wird der +\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Da es bei +\eTeX{} bereits ein Primitiv \Macro{ifdefined} gibt, musste leider diese +etwas unhandliche Bezeichnung gewählt werden. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% +\EndIndexGroup + + +\begin{Declaration} + \Macro{scr@ifluatex} + \Parameter{Dann-Teil}\Parameter{Sonst-Teil} +\end{Declaration} +Wird\ChangedAt{v3.21}{\Package{scrbase}} mit lua\TeX{} gearbeitet, wird der +\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. +\iftrue% Umbruchkorrekturtext +Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. % +\fi% +In der Regel sollte man besser auf die gewünschte Anweisung +testen. Von\textnote{Achtung!} dieser Anweisung gibt es kein +Benutzeräquivalent. Verwenden Sie stattdessen bei Bedarf das Paket +\Package{ifluatex}\important{\Package{ifluatex}} (siehe +\cite{package:ifluatex}).% +\EndIndexGroup + + +\iffalse% Es ergibt keinen Sinn, diese Anweisung noch zu dokumentieren +\begin{Declaration} + \Macro{scr@ifpdforluatex} + \Parameter{Dann-Teil}\Parameter{Sonst-Teil} +\end{Declaration} +Bis lua\TeX~0.85 war es meist unerheblich, ob mit pdf\TeX{} oder lua\TeX{} +gearbeitet wurde. Von daher stammt diese Anweisung, die in beiden Fällen den +\PName{Dann-Teil} ausführt. Wird weder mit pdf\TeX{} noch mit lua\TeX{} +gearbeitet, so wird der \PName{Sonst-Teil} ausgeführt. +Seit Version 0.85 wurde bei lua\TeX{} die Kompatibilität bei vielen der +zusätzlichen Befehle jedoch aufgegeben. Daher ist diese Unterscheidung in der +Praxis nicht mehr von Nutzen und wird von \KOMAScript{} selbst auch nicht mehr +verwendet. Von dieser Anweisung gibt es auch kein Benutzeräquivalent.% +\EndIndexGroup +\fi + + +\begin{Declaration} \Macro{scr@ifpdftex} \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \Macro{ifpdftex} \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -Wird mit pdf\TeX{} gearbeitet, so wird der \PName{Dann-Teil} ausgeführt, +Wird mit pdf\TeX{} gearbeitet, 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 -nur sehr selten wirklich von Nutzen. In der Regel sollte man eher auf die -gewünschte Anweisung testen. -% +eine PDF-Datei ausgegeben werden soll oder nicht. +\iftrue% Umbruchkorrekturtext +Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. % +\fi% +In der Regel sollte man besser auf die gewünschte Anweisung testen.% \EndIndexGroup @@ -1078,11 +1220,12 @@ gewünschte Anweisung testen. \Macro{ifVTeX} \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -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 -testen. -% +Wird mit V\TeX{} gearbeitet, wird der \PName{Dann-Teil} ausgeführt, +anderenfalls der \PName{Sonst-Teil}. +\iftrue% Umbruchkorrekturtext +Diese Unterscheidung ist nur sehr selten wirklich von Nutzen. % +\fi% +In der Regel sollte man besser auf die gewünschte Anweisung testen.% \EndIndexGroup @@ -1092,10 +1235,10 @@ testen. \Macro{ifpdfoutput} \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -Wird eine PDF-Datei erzeugt, so wird der \PName{Dann-Teil} ausgeführt, +Wird eine PDF-Datei erzeugt, 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. -% +PDF-Datei mit Hilfe von lua\TeX{}, pdf\TeX{}, V\TeX{} oder \XeTeX{} erzeugt +wird.% \EndIndexGroup @@ -1105,12 +1248,13 @@ PDF-Datei mit Hilfe von pdf\TeX{} oder mit Hilfe von V\TeX{} erzeugt wird. \Macro{ifpsoutput} \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -Wird eine PostScript-Datei erzeugt, so wird der \PName{Dann-Teil} ausgeführt, +Wird eine PostScript-Datei erzeugt, wird der \PName{Dann-Teil} ausgeführt, 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 +was hier 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. -% +getroffen. \KOMAScript{} stellt \Macro{if@dvips} in +\hyperref[cha:typearea]{\Package{typearea}}\IndexPackage{typearea}% +\IndexCmd{if@dvips} bereit.% \EndIndexGroup @@ -1123,18 +1267,22 @@ getroffen. \KOMAScript{} stellt \Macro{if@dvips} in \Package{typearea} bereit. 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 -Postscript-Datei erkannt werden kann. -% +Postscript-Datei erkannt werden kann.% \EndIndexGroup \begin{Declaration} - \Macro{ifnotundefined}\Parameter{Name}% - \Parameter{Dann-Teil}\Parameter{Sonst-Teil} + \Macro{if@atdocument}\ \PName{Dann-Teil}\ % + \textMacro{else}\ \PName{Sonst-Teil} \textMacro{fi} \end{Declaration} -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. +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@atdocument} hingegen +\Macro{iftrue}. Klassen und Paketautoren können dieses Anweisung manchmal +sinnvoll nutzen, wenn sich Anweisungen in der Dokumentpräambel anders +verhalten sollen als innerhalb des Dokuments. Es\textnote{Achtung!} ist zu +beachten, dass es sich bei dieser Anweisung um eine Verzweigung in \TeX-Syntax +und nicht in \LaTeX-Syntax handelt! % \EndIndexGroup @@ -1145,9 +1293,12 @@ gibt es keine interne Variante. \end{Declaration} 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 -interne Variante. -% +anderenfalls der \PName{Sonst-Teil}. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1156,11 +1307,14 @@ interne Variante. \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} Die\ChangedAt{v3.12}{\Package{scrbase}} beiden Argumente \PName{Zeichenfolge} -werden expandiert und dann verglichen. Beginnt die erste Zeichenfolge von -Leerzeichen abgesehen mit der zweiten Zeichenfolge, so wird der -\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Von dieser -Anweisung gibt es keine interne Variante.% -% +werden expandiert und dann verglichen. Beginnt die erste Zeichenfolge, von +Leerzeichen abgesehen, mit der zweiten Zeichenfolge, so wird der +\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1170,8 +1324,12 @@ Anweisung gibt es keine interne Variante.% Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in einem \Macro{dimen}, also einem \TeX-Längenregister, resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die -Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +Anweisung ist nicht voll expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1183,8 +1341,28 @@ Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in etwas resultiert, das syntaktisch dem Wert einer Länge entspricht, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass derzeit unbekannte Einheiten zu einer -Fehlermeldung führen. Die Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +Fehlermeldung führen. Die Anweisung ist nicht voll expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% +\EndIndexGroup + + +\begin{Declaration} + \Macro{ifdimen}\Parameter{Zeichenfolge}% + \Parameter{Dann-Teil}\Parameter{Sonst-Teil} +\end{Declaration} +Der \PName{Dann-Teil} wird 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. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% +% \EndIndexGroup @@ -1193,11 +1371,16 @@ Anweisung gibt es keine interne Variante.% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in -einer \Macro{dimexpr}, also einem \TeX-Längenausdruck resultiert, wird der -\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu -beachten,\textnote{Achtung!} dass fehlerhafte Ausdrücke zu Fehlermeldungen -führen! Die Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +einer \Macro{dimexpr}\IndexCmd{dimexpr}, also einem \eTeX-Längenausdruck +resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der +\PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass fehlerhafte +Ausdrücke zu Fehlermeldungen führen! Die Anweisung ist nicht voll +expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1207,8 +1390,12 @@ Anweisung gibt es keine interne Variante.% Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in einem \Macro{skip}, also einem \TeX-Abstand, resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die -Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +Anweisung ist nicht voll expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1220,8 +1407,12 @@ Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in etwas resultiert, das syntaktisch dem Wert eines Abstandes entspricht, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass derzeit unbekannte Einheiten zu einer -Fehlermeldung führen. Die Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +Fehlermeldung führen. Die Anweisung ist nicht voll expandierbar. % +\iffalse% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1230,11 +1421,31 @@ Anweisung gibt es keine interne Variante.% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in -einer \Macro{glueexpr}, also einem \TeX-Abstandsausdruck resultiert, wird der -\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu +einer \Macro{glueexpr}\IndexCmd{glueexpr}, also einem +\mbox{\eTeX}-Abstandsausdruck resultiert, wird der \PName{Dann-Teil} +ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass fehlerhafte Ausdrücke zu Fehlermeldungen -führen! Die Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +führen! Die Anweisung ist nicht voll expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% +\EndIndexGroup + + +\begin{Declaration} + \Macro{ifiscounter}\Parameter{Zähler}% + \Parameter{Dann-Teil}\Parameter{Sonst-Teil} +\end{Declaration} +Wenn\ChangedAt{v3.12}{\Package{scrbase}} \PName{Zähler} ein definierter +\LaTeX-Zähler ist, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der +\PName{Sonst-Teil}. Die Anweisung ist nicht voll expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1245,8 +1456,12 @@ Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in einem \Macro{count}, also einem \TeX-Zähler, resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die Anweisung ist nicht voll expandierbar. Für einen Test auf einen \LaTeX-Zähler -siehe \DescRef{\LabelBase.cmd.ifiscounter}. Von dieser -Anweisung gibt es keine interne Variante.% +siehe \DescRef{\LabelBase.cmd.ifiscounter}. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1258,31 +1473,12 @@ Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in etwas resultiert, das syntaktisch dem Wert eines Zählers entspricht, also eine negative oder positive ganze Zahl ist, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Die Anweisung ist nicht voll -expandierbar. Von dieser Anweisung gibt es keine interne Variante.% -\EndIndexGroup - - -\begin{Declaration} - \Macro{ifisnumexpr}\Parameter{Code}% - \Parameter{Dann-Teil}\Parameter{Sonst-Teil} -\end{Declaration} -Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in -einer \Macro{numexpr}, also einem \TeX-Zahlenausdruck resultiert, wird der -\PName{Dann-Teil} ausgeführt, anderenfalls der \PName{Sonst-Teil}. Es ist zu -beachten,\textnote{Achtung!} dass fehlerhafte Ausdrücke zu Fehlermeldungen -führen! Die Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% -\EndIndexGroup - - -\begin{Declaration} - \Macro{ifiscounter}\Parameter{Zähler}% - \Parameter{Dann-Teil}\Parameter{Sonst-Teil} -\end{Declaration} -Wenn\ChangedAt{v3.12}{\Package{scrbase}} \PName{Zähler} ein definierter -\LaTeX-Zähler ist, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der -\PName{Sonst-Teil}. Die Anweisung ist nicht voll expandierbar. Von dieser -Anweisung gibt es keine interne Variante.% +expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1290,39 +1486,32 @@ Anweisung gibt es keine interne Variante.% \Macro{ifnumber}\Parameter{Zeichenfolge}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -Hier werden keine Zahlen verglichen. Der \PName{Dann-Teil} wird vielmehr -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.% +Der \PName{Dann-Teil} wird ausgeführt, wenn die einfache Expansion der +\PName{Zeichenfolge} nur aus Ziffern besteht. In allen anderen Fällen wird der +\PName{Sonst-Teil} verwendet. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup \begin{Declaration} - \Macro{ifdimen}\Parameter{Zeichenfolge}% + \Macro{ifisnumexpr}\Parameter{Code}% \Parameter{Dann-Teil}\Parameter{Sonst-Teil} \end{Declaration} -Hier werden keine Längen verglichen. Der \PName{Dann-Teil} wird vielmehr -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. -% -\EndIndexGroup - - -\begin{Declaration} - \Macro{if@atdocument}\ \PName{Dann-Teil}\ % - \textMacro{else}\ \PName{Sonst-Teil} \textMacro{fi} -\end{Declaration} -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@atdocument} hingegen -\Macro{iftrue}. Klassen und Paketautoren können dieses Anweisung manchmal -sinnvoll nutzen, wenn sich Anweisungen in der Dokumentpräambel anders -verhalten sollen als innerhalb des Dokuments. Es\textnote{Achtung!} ist zu -beachten, dass es sich bei dieser Anweisung um eine Verzweigung in \TeX-Syntax -und nicht in \LaTeX-Syntax handelt! -% +Wenn\ChangedAt{v3.12}{\Package{scrbase}} die Expansion von \PName{Code} in +einer \Macro{numexpr}\IndexCmd{numexpr}, also einem \eTeX-Zahlenausdruck +resultiert, wird der \PName{Dann-Teil} ausgeführt, anderenfalls der +\PName{Sonst-Teil}. Es ist zu beachten,\textnote{Achtung!} dass fehlerhafte +Ausdrücke zu Fehlermeldungen führen! Die Anweisung ist nicht voll +expandierbar. % +\iftrue% Umbruchvaritanten +Von dieser Anweisung gibt es keine interne Variante.% +\else% +Es gibt keine interne Variante.% +\fi% \EndIndexGroup @@ -1331,19 +1520,33 @@ und nicht in \LaTeX-Syntax handelt! \BeginIndexGroup \BeginIndex{}{Sprachdefinition} +\iftrue +Anfänger haben häufig Probleme damit, sprachabhängige Begriffe wie +\Macro{listfigurename}\IndexCmd{listfigurename}, in der Voreinstellung meist +»List of Figures« beziehungsweise in Deutsch: »Abbildungsverzeichnis«, zu +ändern. Werden diese beispielsweise einfach mit \Macro{renewcommand} in der +Dokumentpräambel umdefiniert, so überleben sie eine spätere Umschaltung der +Sprache nicht. Bei Verwendung von \Package{babel}\IndexCmd{babel} wird die +Umdefinierung in der Dokumentpräambel bereits von +\Macro{begin}\PParameter{document} wieder überschrieben. +\fi + Normalerweise muss man zur Definition oder zur Änderung sprachabhängiger Begriffe Anweisungen wie \Macro{captionsngerman} so umdefinieren, dass zusätzlich zu den bisherigen Begriffen auch die neuen oder geänderten definiert werden. Erschwert wird dieses Vorhaben dadurch, dass beim Laden -eines Paketes wie \Package{german}\IndexPackage{german} oder +eines Pakets wie \Package{german}\IndexPackage{german} oder \Package{ngerman}\IndexPackage{ngerman} diese Anweisungen von den Paketen erneut definiert werden. Bei den genannten Paketen geschieht dies leider in einer Form, die alle zuvor gemachten Änderungen zunichte macht. Aus diesem -Grund ist es sinnvoll die Änderungen mit Hilfe von \Macro{AtBeginDocument} bis +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} +verzögern. +\iftrue +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. +\fi Darüber hinaus kommt erschwerend hinzu, dass einige Pakete zusätzliche, sprachabhängige Begriffe in \Macro{captions\PName{Sprache}} definieren, @@ -1351,9 +1554,11 @@ 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. +Das Paket \Package{scrbase} bietet dem Anwender daher für die Definition und +Änderung selbst einige zusätzliche Anweisungen, die ihn von vielen dieser +Überlegungen entlasten. Gleichzeitig erlauben diese Befehle, die +sprachabhängigen Begriffe mehrerer Dialekte oder Ausprägungen einer Sprache +gleichzeitig zu definieren oder zu ändern. \begin{Declaration} \Macro{defcaptionname} @@ -1380,18 +1585,18 @@ zuzuweisen. Mehrere Sprachen können durch Komma voneinander getrennt als 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. +innerhalb der Sprache zum Zeitpunkt des Aufrufs bereits definiert ist. -Ist eine Sprache nicht definiert, so tut \Macro{providecaptionname} -nichts weiter, als dies in der \File{log}-Datei zu vermerken. Dabei wird für -jede Sprache nur einmal eine entsprechende Information in die \File{log}-Datei +Ist eine Sprache nicht definiert, so tut \Macro{providecaptionname} nichts +weiter, als dies in der \File{log}-Datei zu vermerken. Dabei wird für jede +Sprache nur einmal eine entsprechende Information in die \File{log}-Datei geschrieben. Ist die Sprache definiert, enthält aber bisher keinen entsprechenden \PName{Begriff}, so wird er mit dem angegebenen \PName{Inhalt} -definiert. Ist der \PName{Begriff} hingegen in der Sprache bereits -definiert, so wird er nicht umdefiniert, sondern ein entsprechender Hinweis in +definiert. Ist der \PName{Begriff} hingegen in der Sprache bereits definiert, +so wird er nicht umdefiniert, sondern ebenfalls ein entsprechender Hinweis in die \File{log}-Datei geschrieben. -Die Anweisung \Macro{newcaptionname} verhält sich etwas anders. Ist bei ihr +Ist dagegen bei \Macro{newcaptionname} eine Sprache nicht definiert, dann wird diese neu definiert, indem eine entsprechende Anweisung definiert wird. Für die Sprache \PValue{ngerman} wäre das beispielsweise \Macro{captionsngerman}. Außerdem @@ -1471,7 +1676,9 @@ 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 -finden. +finden.\iffree{}{ \KOMAScript{} selbst definiert noch einige weitere + Begriffe. Siehe dazu \autoref{sec:scrlttr2-experts.languages} ab + \DescPageRef{scrlttr2-experts.cmd.yourrefname}.} \begin{desclist} \renewcommand*{\abovecaptionskipcorrection}{-\normalbaselineskip}% @@ -1578,10 +1785,11 @@ finden. \section{Identifikation von \KOMAScript} \seclabel{identify} -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. +Obwohl -- oder gerade weil -- \Package{scrbase} ganz allgemein als Paket für +Klassen- und Paketautoren konzipiert ist, wird es natürlich von den +\KOMAScript-Klassen und den meisten \KOMAScript-Paketen verwendet. Es enthält +daher auch zwei Anweisungen, die in allen \KOMAScript-Klassen und allen +grundlegenden \KOMAScript-Paketen vorhanden sind. \begin{Declaration} @@ -1591,8 +1799,9 @@ 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 \KOMAScript-Klassen und "~Paketen definiert. Die Definition erfolgt mit -\Macro{DeclareRobustCommand}. -% +\Macro{DeclareRobustCommand}. Da auch Pakete, die nicht zu \KOMAScript{} +gehören, diese Wortmarke definieren können, sollte man die Anweisung jedoch +nicht als Indiz für die Verwendung eines \KOMAScript-Pakets verstehen.% \EndIndexGroup @@ -1605,8 +1814,8 @@ abgelegt. Diese Hauptversion ist für alle \KOMAScript-Klassen und alle \KOMAScript-Pakete, die von den Klassen verwendet werden, gleich. Daher kann sie auch nach dem Laden von \Package{scrbase} abgefragt werden. Diese Anleitung wurde beispielsweise mit der \KOMAScript-Version -»\KOMAScriptVersion« erstellt. -% +»\KOMAScriptVersion« erstellt. Das Vorhandensein dieser Anweisung ist ein +starkes Indiz dafür, dass zumindest ein \KOMAScript-Paket verwendet wird.% \EndIndexGroup @@ -1628,7 +1837,7 @@ Zeilennummer in die Log-Datei zu schreiben. Er bietet neben \Macro{PackageWarning} und \Macro{ClassWarning}, die Warnungen mit aktueller Zeilennummer ausgeben, auch die beiden Anweisungen \Macro{PackageWarningNoLine} und \Macro{ClassWarningNoLine}, um Warnungen ohne -Zeilennummer auszugeben. Die nahe liegenden Anweisungen +Zeilennummer auszugeben. Die naheliegenden Anweisungen \Macro{ClassInfoNoLine} und \Macro{PackageInfoNoLine}, um auch Informationen ohne Zeilennummer in die Log-Datei zu schreiben, fehlen jedoch. Diese werden von \Package{scrbase} bereit gestellt. @@ -1684,8 +1893,8 @@ Zahlen und \textit{Rest} außerdem größer oder gleich 0 und kleiner als 0). Der Wert kann jeweils zur Zuweisung an einen Zähler oder direkt innerhalb -eines Ausdrucks mit \Macro{numexpr} verwendet werden. Zur Ausgabe als -arabische Zahl ist \Macro{the} voran zu stellen.% +eines Ausdrucks mit \Macro{numexpr}\IndexCmd{numexpr} verwendet werden. Zur +Ausgabe als arabische Zahl ist \Macro{the} voranzustellen.% % \EndIndexGroup % @@ -1710,5 +1919,6 @@ arabische Zahl ist \Macro{the} voran zu stellen.% % LocalWords: AtEndOfFamilyOptions FamilyBoolKey FamilySetBool Schaltername % LocalWords: FamilyLengthKey FamilySetLength FamilyLengthMacroKey % LocalWords: FamilySetLengthMacro Wertübergabe Gliederungsbefehlen - -% LocalWords: Sternvariante +% LocalWords: Sternvariante Anwenderanweisungen Signalisierung Paketautoren +% LocalWords: Familienschlüssel Mitgliederschlüssels Vergleichszustand +% LocalWords: Benutzeräquivalent Dokumentpräambel voranzustellen |