summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex63
1 files changed, 42 insertions, 21 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex
index 78454dbe73b..a3aa0541ef6 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex
@@ -46,11 +46,11 @@
% ======================================================================
\KOMAProvidesFile{scrbase.tex}
- [$Date: 2014-09-19 10:04:02 +0200 (Fri, 19 Sep 2014) $
+ [$Date: 2014-12-03 11:37:52 +0100 (Wed, 03 Dec 2014) $
KOMA-Script package scrbase]
\translator{Markus Kohm\and Melvin Hendrix}
-% Date of the translated German file: 2014/09/19
+% Date of the translated German file: 2014/12/03
\chapter{Basic Functions of Package \Package{scrbase}}
\labelbase{scrbase}
@@ -190,8 +190,8 @@ the same as members of another family.
\begin{Declaration}
\Macro{DefineFamilyKey}\OParameter{family member}\Parameter{family}%
- \Parameter{key}\OParameter{default}\\
- \hphantom{\Macro{DefineFamilyKey}}\Parameter{action}\\
+ \Parameter{key}\\
+ \hphantom{\XMacro{DefineFamilyKey}}\OParameter{default}\Parameter{action}\\
\Macro{FamilyKeyState}\\
\Macro{FamilyKeyStateUnknown}\\
\Macro{FamilyKeyStateProcessed}\\
@@ -295,6 +295,19 @@ Generally, the four predefined states should be sufficient.
\begin{Declaration}
+ \Macro{RelaxFamilyKey}\OParameter{family member}\Parameter{family}%
+ \Parameter{key}
+\end{Declaration}
+\BeginIndex{Cmd}{RelaxFamilyKey}%
+If\ChangedAt{v3.15}{\Package{scrbase}} the \PName{key} of the \PName{family
+ member} of \PName{family} has been defined before, that definition will be
+cancelled. Afterwards the \PName{key} will not be defined for the \PName{family
+ member} of \PName{family} any longer. Usage of \Macro{RelaxFamilyKey} for a
+not yet defined \PName{key} of the \PName{family member} of the \PName{family}
+is also allowed.%
+\EndIndex{Cmd}{RelaxFamilyKey}%
+
+\begin{Declaration}
\Macro{FamilyProcessOptions}\OParameter{family member}\Parameter{family}
\end{Declaration}
\BeginIndex{Cmd}{FamilyProcessOptions}%
@@ -660,9 +673,9 @@ normally result in an error message about assigning an unknown value.
\begin{Declaration}
\Macro{FamilyCounterKey}\OParameter{family member}\Parameter{family}%
- \Parameter{key}\Parameter{\LaTeX{} counter}\\
-% \hphantom{\XMacro{FamilyCounterKey}}%
-% \Parameter{\LaTeX{} counter}
+ \Parameter{key}\\
+ \hphantom{\XMacro{FamilyCounterKey}}%
+ \OParameter{default}\Parameter{\LaTeX{} counter}\\
\Macro{FamilySetCounter}\Parameter{family}%
\Parameter{key}\Parameter{\LaTeX{} counter}\Parameter{value}
\end{Declaration}
@@ -680,14 +693,17 @@ successful. Nevertheless the assignment can still fail and result in a \TeX{}
error. But if the plausibility test fails already, this is signalled by
\Macro{FamilyKeyStateUnknownValue}.
-Please note\textnote{Attention!}, this command does not support an optional
-\PName{default}.%
+If\ChangedAt{v3.15}{\Package{scrbase}} the value is omitted, the
+\PName{default} is used instead. If there is no \PName{default}, the
+\PName{key} can be used only with a value being defined.%
\EndIndex{Cmd}{FamilySetCounter}%
\EndIndex{Cmd}{FamilyCounterKey}%
\begin{Declaration}
\Macro{FamilyCounterMacroKey}\OParameter{family member}\Parameter{family}%
- \Parameter{key}\Parameter{macro}\\
+ \Parameter{key}\\
+ \hphantom{\XMacro{FamilyCounterMacroKey}}%
+ \OParameter{default}\Parameter{macro}\\
\Macro{FamilySetCounterMacro}\Parameter{family}%
\Parameter{key}\Parameter{macro}\Parameter{value}%
\end{Declaration}
@@ -697,18 +713,21 @@ These\ChangedAt{v3.12}{\Package{scrbase}} two commands differ from the
previously described \Macro{FamilyCounterKey} and \Macro{FamilySetCounter}
only by the fact, that they do not assign a \PName{value} to a \PName{\LaTeX
counter}, but define a \Macro{macro} with the
-\PName{value}. Note\textnote{Attention}, that also an optional \PName{default}
-is not supported.%
+\PName{value}.%
\EndIndex{Cmd}{FamilySetCounterMacro}%
\EndIndex{Cmd}{FamilyCounterMacroKey}%
\begin{Declaration}
\Macro{FamilyLengthKey}\OParameter{family member}\Parameter{family}%
- \Parameter{key}\Parameter{length}\\
+ \Parameter{key}\\
+ \hphantom{\XMacro{FamilyLengthKey}}%
+ \OParameter{default}\Parameter{length}\\
\Macro{FamilySetLength}\Parameter{family}%
\Parameter{key}\Parameter{length}\Parameter{value}\\
\Macro{FamilyLengthMacroKey}\OParameter{family member}\Parameter{family}%
- \Parameter{key}\Parameter{Makro}\\
+ \Parameter{key}\\
+ \hphantom{\XMacro{FamilyLengthMacroKey}}%
+ \OParameter{default}\Parameter{Makro}\\
\Macro{FamilySetLengthMacro}\Parameter{family}%
\Parameter{key}\Parameter{Makro}\Parameter{value}%
\end{Declaration}
@@ -727,12 +746,14 @@ not all assignment errors can be recognised, so an inaccurate \PName{value}
can still result in \TeX{} error. Recognised errors however will be signalled
by \Macro{FamilyKeyStateUnknownValue}.
+If\ChangedAt{v3.15}{\Package{scrbase}} the value is omitted,
+the \PName{default} is used instead. If there is no \PName{default}, the
+\PName{key} can be used only with a value being defined.
+
In difference to this, \Macro{FamilyLengthMacroKey} and
\Macro{FamilySetLengthMacro} do not assign \PName{value} to a \PName{length},
-but define a \Macro{macro} with this \PName{value}.
-
-Please note\textnote{Attention!}, these commands do not support an optional
-\PName{default} argument.%
+but define a \Macro{macro} with this
+\PName{value}.%
\EndIndex{Cmd}{FamilySetLengthMacro}%
\EndIndex{Cmd}{FamilyLengthMacroKey}%
\EndIndex{Cmd}{FamilySetLength}%
@@ -1132,16 +1153,16 @@ corresponding internal command. For test with \LaTeX{} counters, see
\EndIndex{Cmd}{ifiscount}%
\begin{Declaration}
- \Macro{ifisnumber}\Parameter{code}%
+ \Macro{ifisinteger}\Parameter{code}%
\Parameter{then instructions}\Parameter{else instructions}
\end{Declaration}
-\BeginIndex{Cmd}{ifisnumber}%
+\BeginIndex{Cmd}{ifisinteger}%
If\ChangedAt{v3.12}{\Package{scrbase}} \PName{code} expands to something with
the syntax of the value of a counter, which would be a negative or positive
integer, the \PName{then instructions} will be executed, otherwise the
\PName{else instructions}. The command is not completely expandable and there
is no corresponding internal command.%
-\EndIndex{Cmd}{ifisnumber}%
+\EndIndex{Cmd}{ifisinteger}%
\begin{Declaration}
\Macro{ifisnumexpr}\Parameter{code}%