summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/Makefile14
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-0.tex24
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-1.tex16
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-10.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-11.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex10
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-13.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-14.tex163
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-2.tex10
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-20.tex127
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-21.tex765
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-3.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-4.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-5.tex379
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-6.tex23
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-7.tex9
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-8.tex20
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/common-9.tex14
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/expertpart.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex12
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/guide.tex6
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup5
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/preface.tex31
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex928
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle-experts.tex26
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex263
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex15
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex41
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrhack.tex18
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-notecolumn.tex317
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage-experts.tex660
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex1128
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex1242
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex110
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex97
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex277
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex18
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrwfile.tex68
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex229
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/typearea-experts.tex61
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex221
45 files changed, 6273 insertions, 1154 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile b/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile
index e9c2b0cd026..9ac3413dfaf 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile
@@ -53,7 +53,7 @@ tocbasic.tex: ../../tocbasic.tex
if [ -L $@ ] || ! [ -f $@ ]; then $(SYMLINK) $< .; else touch $@; fi
../../tocbasic.tex: ../../tocbasic.dtx
- cd ../.. && tex \\nonstopmode\\input tocbasic.dtx
+ cd ../.. && tex \\nonstopmode\\input $(basename $<)
# ----------------------------------------------------------------------
# ----------------------------------------------------------------------
@@ -63,7 +63,17 @@ scrwfile.tex: ../../scrwfile.tex
if [ -L $@ ] || ! [ -f $@ ]; then $(SYMLINK) $< .; else touch $@; fi
../../scrwfile.tex: ../../scrwfile.dtx
- cd ../.. && tex \\nonstopmode\\input scrwfile.dtx
+ cd ../.. && tex \\nonstopmode\\input $(basename $<)
+# ----------------------------------------------------------------------
+
+# ----------------------------------------------------------------------
+# NOTE: Remove these rules after real translation of scrlayer-notecolumn.tex
+# is available.
+scrlayer-notecolumn.tex: ../../scrlayer-notecolumn.tex
+ if [ -L $@ ] || ! [ -f $@ ]; then $(SYMLINK) $< .; else touch $@; fi
+
+../../scrlayer-notecolumn.tex: ../../scrlayer-notecolumn.dtx
+ cd ../.. && tex \\nonstopmode\\input $(basename $<)
# ----------------------------------------------------------------------
#
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-0.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-0.tex
index f950ed11530..deced1e00ca 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-0.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-0.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-0.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-0.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ======================================================================
-\ProvidesFile{common-0.tex}[2012/04/02 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-0.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Krickette Murabayashi}
-% Date of the translated German file: 2011/08/26
+% Date of the translated German file: 2013/08/08
\makeatletter
\@ifundefined{ifCommonmaincls}{\newif\ifCommonmaincls}{}%
@@ -109,7 +111,7 @@ may also have the form \PName{option}\texttt{=}\PName{value}. Apart
from this difference \Macro{documentclass} and \Macro{usepackage}
function the same in {\KOMAScript} as described in
\cite{latex:usrguide} or any introduction to \LaTeX, for example
-\cite{l2short}.%
+\cite{lshort}.%
%
\IfNotCommon{scrextend}{\par%
When using a {\KOMAScript} class, no options should be passed on
@@ -124,7 +126,17 @@ function the same in {\KOMAScript} as described in
packages.}%
\IfCommon{scrlttr2}{\ Actually, it is no longer necessary when using
any {\KOMAScript} class to explicity load either one of these
- packages.}}%
+ packages.}}
+
+You should note\textnote{Attention!}, that in opposite to the interface
+described below the options interface of \Macro{documentclass} and
+\Macro{usepackage} is not robust. So commands, lengths, counters and such
+constructs may break inside the optional argument of these commands. Because
+of this, the usage of a \LaTeX{} length inside the value of an option would
+cause an error before \KOMAScript{} can get the control over the option
+execution. So, if you want to use a \LaTeX{} length, counter or command a part
+of the value of an option, you have to use \Macro{KOMAoptions} or
+\Macro{KOMAoption}. These commands will be described next.%
%
\EndIndex{Cmd}{usepackage}%
\EndIndex{Cmd}{documentclass}%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-1.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-1.tex
index 3dbcdad259b..69e02610745 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-1.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-1.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-1.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-1.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-1.tex}[2012/04/08 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-1.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2011/09/20
@@ -127,7 +129,7 @@ poses possibilities of compatibility issues for future \LaTeX{} runs. Option
\Option{version} without any \PName{value} means the
same. \ChangedAt{v3.01a}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}\and \Class{scrlttr2}\and \Package{scrextend}}This is the
-default behaviour as long as you don't use any deprecated options.
+default behaviour as long as you do not use any deprecated options.
If\textnote{Attention!} you use a deprecated option of \KOMAScript~2,
\KOMAScript~3 will switch to \OptionValue{version}{first} automatically. This
@@ -137,7 +139,7 @@ switching. Alternatively you may select another adjustment using option
Compatibility is primarily make-up compatibility. New features not related to
the mark-up will be available even if you switch compatibility to a version
-before first implementation of the feature. Option \Option{version} doesn't
+before first implementation of the feature. Option \Option{version} does not
influence make-up changes that are motivated by bug fixes. If you need bug
compatibility you should physically save the used \KOMAScript{} version
together with your document.
@@ -151,8 +153,8 @@ together with your document.
latest version.%
\end{Example}}
-Please note\textnote{Attention!} that you can't change option \Option{version}
-anymore after loading the %
+Please note\textnote{Attention!} that you cannot change option
+\Option{version} anymore after loading the %
\IfCommon{maincls}{class}%
\IfCommon{scrlttr2}{class}%
\IfCommon{typearea}{package \Package{typearea}}%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-10.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-10.tex
index 2b10f4ae9c9..a3c209f6806 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-10.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-10.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-10.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-10.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-10.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-10.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2012/01/01
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-11.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-11.tex
index 55f9aeb02a8..e4f3ebb325b 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-11.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-11.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-11.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-11.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-11.tex}[2012/02/07 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-11.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm}
% Date of the translated German file: 2012/01/01
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex
index a57b75f9624..a567512ef83 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-12.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-12.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-12.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-12.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-12.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2011/09/21
@@ -415,7 +417,7 @@ with the commands \Macro{setkomafont} and \Macro{addtokomafont} (see \autoref{se
\end{labeling}
\end{ShowOutput}
As can be seen in this example, a font changing command may be set
- in the usual way. But if you don't want the font of the separator to
+ in the usual way. But if you do not want the font of the separator to
be changed in the same way as the font of the label, you have to set
the font of the separator as well.
\end{Example}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-13.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-13.tex
index 62a79e01ef9..e4f69fb2f48 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-13.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-13.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-13.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-13.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-13.tex}[2012/02/14 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-13.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm}
% Date of the translated German file: 2011/09/03
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-14.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-14.tex
index afbd0583800..15f222f283b 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-14.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-14.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-14.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-14.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ======================================================================
-\ProvidesFile{common-14.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-14.tex}
+ [$Date: 2013-11-21 16:13:48 +0100 (Do, 21. Nov 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
-% Date of the translated German file: 2012/01/01
+% Date of the translated German file: 2013/11/21
\makeatletter
\@ifundefined{ifCommonmaincls}{\newif\ifCommonmaincls}{}%
@@ -103,9 +105,11 @@ should be used.
\else %------------------------------------------------------- nur maincls -
\begin{Declaration}
- \KOption{titlepage}\PName{simple switch}
+ \KOption{titlepage}\PName{simple switch}\\
+ \OptionValue{titlepage}{firstiscover}
\end{Declaration}%
\BeginIndex{Option}{titlepage~=\PName{simple switch}}%
+\BeginIndex{Option}{titlepage~=\PValue{firstiscover}}%
Using \Macro{maketitle} (see \autopageref{desc:\csname
label@base\endcsname.cmd.maketitle}), this option\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} switches between document title pages\Index{title>pages}
@@ -127,6 +131,27 @@ specially emphasized, but it may be followed by more material on the same
page, for instance by an abstract or a section.%
\EndIndex{Option}{titlepage~=\PName{simple switch}}%
+The third choice,\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}}
+\OptionValue{titlepage}{firstiscover}%
+\important{\OptionValue{titlepage}{firstiscover}} does not only select title
+pages. It additionally prints the first title page of
+\Macro{maketitle}\IndexCmd{maketitle}, this is either the extra title or the
+main title, as a cover\Index{cover} page. Every other setting of option
+\Option{titlepage} would cancel this setting. The margins\important{%
+ \Macro{coverpagetopmargin}\\
+ \Macro{coverpagebottommargin}\\
+ \Macro{coverpageleftmargin}\\
+ \Macro{coverpagerightmargin}} of the cover page are given by
+\Macro{coverpagetopmargin}\IndexCmd[indexmain]{coverpagetopmargin},
+\Macro{coverpagebottommargin}\IndexCmd[indexmain]{coverpagebottommargin},
+\Macro{coverpageleftmargin}\IndexCmd[indexmain]{coverpageleftmargin} und
+\Macro{coverpagerightmargin}\IndexCmd[indexmain]{coverpagerightmargin}. The
+defaults of these depend on the lengths
+\Length{topmargin}\IndexLength{topmargin} and
+\Length{evensidemargin}\IndexLength{evensidemargin} and can be changed using
+\Macro{renewcommand}.
+
\IfCommon{maincls}{The default of classes \Class{scrbook} and \Class{scrreprt}
is usage of title pages. Class \Class{scrartcl}, on the other hand, uses
in-page titles as default.}%
@@ -335,69 +360,16 @@ the top of the page. It can be freely designed by the user.
The\important{\Macro{subject}} \PName{subject}\Index[indexmain]{subject} is
output immediately above the \PName{title}.
-Thereby\ChangedAt{v2.95}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} the font switching of element
-\FontElement{subject}\IndexFontElement{subject}\important{\FontElement{subject}}
-will be used. The default, that may be found in
-\autoref{tab:maincls.titlefonts}, %
-\IfNotCommon{maincls}{\autopageref{tab:maincls.titlefonts}, }%
-may be changed using the commands \Macro{setkomafont} and
-\Macro{addtokomafont} (see \autoref{sec:\csname
- label@base\endcsname.textmarkup}, \autopageref{desc:\csname
- label@base\endcsname.cmd.setkomafont}).
The\important{\Macro{title}} \PName{title} is output with a very large font
-size. Besides\ChangedAt{v2.8p}{%
- \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} the change of size,
-the settings for the element
-\FontElement{title}\IndexFontElement{title}\important{\FontElement{title}}
-also take effect. By default these settings are identical to the settings for
-the element \FontElement{disposition}\IndexFontElement{disposition} (see
-\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). The default settings may be
-changed using the commands \Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:\csname label@base\endcsname.textmarkup},
-\autopageref{desc:\csname label@base\endcsname.cmd.setkomafont}). The font
-size\textnote{Attention!} is, however, not affected (see
+size. Beside all other element the font size\textnote{Attention!} is,
+however, not affected by the font switching element \FontElement{title} (see
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.mainTitle}).
The\important{\Macro{subtitle}}
\PName{subtitle}\ChangedAt{v2.97c}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} is set just below the title, in a font determined by the
-element \FontElement{subtitle}\IndexFontElement{subtitle}%
-\important{\FontElement{subtitle}}. The default, seen in
-\autoref{tab:maincls.titlefonts}%
-\IfNotCommon{maincls}{, \autopageref{tab:maincls.titlefonts}}, %
-can be changed with the help of the commands \Macro{setkomafont} and
-\Macro{addtokomafont} (see \autoref{sec:\csname
- label@base\endcsname.textmarkup}, \autopageref{desc:\csname
- label@base\endcsname.cmd.setkomafont}).
-
-\IfCommon{maincls}{%
-\begin{table}
-% \centering
- \KOMAoptions{captions=topbeside}%
- \setcapindent{0pt}%
-% \caption
- \begin{captionbeside}
- [{Font defaults for the elements of the title}]
- {\label{tab:maincls.titlefonts}%
- Font defaults for the elements of the title}
- [l]
- \begin{tabular}[t]{ll}
- \toprule
- Element name & Default \\
- \midrule
- \FontElement{subject} &
- \Macro{normalfont}\Macro{normalcolor}\Macro{bfseries}\Macro{Large} \\
- \FontElement{title} & \Macro{usekomafont}\PParameter{disposition} \\
- \FontElement{subtitle} &
- \Macro{usekomafont}\PParameter{title}\Macro{large} \\
- \bottomrule
- \end{tabular}
- \end{captionbeside}
-\end{table}}
+ \Class{scrartcl}} is set just below the title.
Below\important{\Macro{author}} the \PName{subtitle} appears the
\PName{author}\Index[indexmain]{author}. Several authors can be
@@ -424,6 +396,44 @@ markers instead of numbers. Note\textnote{Attention!}, that \Macro{thanks} has
to be used inside the argument of another command, e.\,g., at the argument
\PName{author} of the command \Macro{author}.
+While\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}} printing the title elements the
+equal named font switching elements will be used for all them. The defaults,
+that may be found in \autoref{tab:maincls.titlefonts}, %
+\IfNotCommon{maincls}{\autopageref{tab:maincls.titlefonts}, }%
+may be changed using the commands \Macro{setkomafont} and
+\Macro{addtokomafont} (see \autoref{sec:\csname
+ label@base\endcsname.textmarkup}, \autopageref{desc:\csname
+ label@base\endcsname.cmd.setkomafont}). \IfCommon{maincls}{%
+\begin{table}
+% \centering
+ \KOMAoptions{captions=topbeside}%
+ \setcapindent{0pt}%
+% \caption
+ \begin{captionbeside}
+ [{Font defaults for the elements of the title}]
+ {\label{tab:maincls.titlefonts}%
+ Font defaults for the elements of the title}
+ [l]
+ \begin{tabular}[t]{ll}
+ \toprule
+ Element name & Default \\
+ \midrule
+ \FontElement{author} & \Macro{Large} \\
+ \FontElement{date} & \Macro{Large} \\
+ \FontElement{dedication} & \Macro{Large} \\
+ \FontElement{publishers} & \Macro{Large} \\
+ \FontElement{subject} &
+ \Macro{normalfont}\Macro{normalcolor}\Macro{bfseries}\Macro{Large} \\
+ \FontElement{subtitle} &
+ \Macro{usekomafont}\PParameter{title}\Macro{large} \\
+ \FontElement{title} & \Macro{usekomafont}\PParameter{disposition} \\
+ \FontElement{titlehead} & \\
+ \bottomrule
+ \end{tabular}
+ \end{captionbeside}
+\end{table}}
+
With the exception of \PName{titlehead} and possible footnotes, all
the items are centered horizontally. The information is summarised in
\autoref{tab:maincls.mainTitle}%
@@ -436,7 +446,7 @@ the items are centered horizontally. The information is summarised in
\setcapindent{0pt}%
% \caption
\begin{captionbeside}[Main title]{%
- Font size and horizontal positioning of the
+ Font and horizontal positioning of the
elements in the main title page in the order of their vertical
position from top to bottom when typeset with \Macro{maketitle}}
[l]
@@ -445,19 +455,21 @@ the items are centered horizontally. The information is summarised in
\toprule
Element & Command & Font & Orientation \\
\midrule
- Title head & \Macro{titlehead} & \Macro{normalsize} & justified \\
+ Title head & \Macro{titlehead} & \Macro{usekomafont}\PParameter{titlehead} & justified \\
Subject & \Macro{subject} & \Macro{usekomafont}\PParameter{subject} & centered \\
- Title & \Macro{title} & \Macro{huge}\Macro{usekomafont}\PParameter{title} & centered \\
+ Title & \Macro{title} & \Macro{usekomafont}\PParameter{title}\Macro{huge} & centered \\
Subtitle & \Macro{subtitle} & \Macro{usekomafont}\PParameter{subtitle} & centered \\
- Authors & \Macro{author} & \Macro{Large} & centered \\
- Date & \Macro{date} & \Macro{Large} & centered \\
- Publishers & \Macro{publishers} & \Macro{Large} & centered \\
+ Authors & \Macro{author} & \Macro{usekomafont}\PParameter{author} & centered \\
+ Date & \Macro{date} & \Macro{usekomafont}\PParameter{date} & centered \\
+ Publishers & \Macro{publishers} & \Macro{usekomafont}\PParameter{publishers} & centered \\
\bottomrule
\end{tabular}
\end{captionbeside}
\label{tab:maincls.mainTitle}
-\end{table}}
-
+ \end{table}}
+Please note\textnote{Attention!}, that for the main title \Macro{huge} will be
+used after the font switching element \Macro{title}. So you cannot change the
+size of the main title using \Macro{setkomafont} or \Macro{addtokomafont}.
\begin{Example}
Assume you are writing a dissertation. The title page should have
@@ -510,9 +522,9 @@ the items are centered horizontally. The information is summarised in
\begin{Explain}
A frequent misunderstanding concerns the role of the full title page. It is
- often erroneously assumed that the cover or dust cover is meant. Therefore,
- it is frequently expected that the title page does not follow the normal
- page layout, but has equally large left and right margins.
+ often erroneously assumed that the cover\Index{cover} or dust cover is
+ meant. Therefore, it is frequently expected that the title page does not
+ follow the normal page layout, but has equally large left and right margins.
However, if one takes a book and opens it, one notices very quickly at least
one title page under the cover within the so-called inner book. Precisely
@@ -525,6 +537,13 @@ the items are centered horizontally. The information is summarised in
be designed with the help of a graphics or DTP program. A separate document
should also be used because the cover will be printed on a different medium,
possibly cardboard, and possibly with another printer.
+
+ Nevertheless, since \KOMAScript~3.12 the first title page of
+ \Macro{maketitle} can be printed as a cover page with different margins. For
+ more information about this see the description of option
+ \OptionValue{titlepage}{firstiscover}%
+ \IndexOption{titlepage~=\PValue{firstiscover}} on \autopageref{desc:\csname
+ label@base\endcsname.option.titlepage}.
\end{Explain}
%
\EndIndex{Cmd}{titlehead}%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex
index 2f8f870f71d..ff61582d756 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-15.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-15.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-15.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-15.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-15.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2011/09/21
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-2.tex
index 81a5e22d550..8ac590a8100 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-2.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-2.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-2.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-2.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Markus Kohm\and Gernot Hassenpflug\and Krickette Murabayashi}
% Date of the translated German file: 2011/09/20
@@ -71,7 +73,7 @@ Many classes and packages provide a draft mode aside from the final
typesetting mode. The difference of draft and final mode may be as manifold as
the classes and package that support these modes. For instance, the
\Package{graphics}\IndexPackage{graphics} and the
-\Package{graphicx}\IndexPackage{graphicx} packages don't actually output the
+\Package{graphicx}\IndexPackage{graphicx} packages do not actually output the
graphics in their own draft mode. Instead they output a framed box of the
appropriate size containing only the graphic's file name (see
\cite{package:graphics}).%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-20.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-20.tex
new file mode 100644
index 00000000000..85fdea3b1a8
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-20.tex
@@ -0,0 +1,127 @@
+% ======================================================================
+% common-20.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% This file is part of the LaTeX2e KOMA-Script bundle.
+%
+% This work may be distributed and/or modified under the conditions of
+% the LaTeX Project Public License, version 1.3c of the license.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later and of this work.
+%
+% This work has the LPPL maintenance status "author-maintained".
+%
+% The Current Maintainer and author of this work is Markus Kohm.
+%
+% This work consists of all files listed in manifest.txt.
+% ----------------------------------------------------------------------
+% common-20.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
+% Version 1.3c, verteilt und/oder veraendert werden.
+% Die neuste Version dieser Lizenz ist
+% http://www.latex-project.org/lppl.txt
+% und Version 1.3c ist Teil aller Verteilungen von LaTeX
+% Version 2005/12/01 oder spaeter und dieses Werks.
+%
+% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
+% (allein durch den Autor verwaltet).
+%
+% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
+%
+% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
+% ======================================================================
+%
+% Text that is common for several chapters of the KOMA-Script guide
+% Maintained by Markus Kohm
+%
+% ----------------------------------------------------------------------
+%
+% Absaetze, die mehreren Kapitels in der KOMA-Script-Anleitung gemeinsam sind
+% Verwaltet von Markus Kohm
+%
+% ============================================================================
+
+\KOMAProvidesFile{common-20.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraph: Head and Foot Height)]
+\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}
+
+% Date of the translated German file: 2013-10-18
+
+\makeatletter
+\@ifundefined{ifCommonscrlayer}{\newif\ifCommonscrlayer}{}%
+\@ifundefined{ifCommoonscrlayer-scrpage}{\expandafter\newif\csname ifCommonscrlayer-scrpage\endcsname}{}%
+\@ifundefined{ifIgnoreThis}{\newif\ifIgnoreThis}{}%
+\makeatother
+
+\section{Head and Foot Height}
+\label{sec:\csname label@base\endcsname.height}
+
+\IfCommon{scrlayer-scrpage}{%
+ The \LaTeX{} standard classes do not use the page footer a lot and if they do
+ use it, they put the contents into a \Macro{mbox} which results in the
+ footer being a single text line. This is probably the reason that \LaTeX{} itself
+ does not have a well-defined foot height. Actually there is
+ \Length{footskip}\IndexLength{footskip} giving the distance between the last base
+ line of the text area and the base line of the footer. However, if the footer
+ consists of more than one text line, there is no definite statement whether this
+ length should be the distance to the first or the last base line of the footer.
+
+ Despite the fact that the page header of the standard classes will also be
+ put into a horizontal box and therefore is a single text line too, \LaTeX{}
+ indeed has a length to setup the height of the page header. The reason for
+ this may be that the height will be needed to determine the start of the
+ text area. }
+
+\ifshortversion\IgnoreThisfalse\IfNotCommon{scrlayer-scrpage}{\IgnoreThistrue}\fi
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++++++ not scrlayer-scrpage +
+You may find basic information about the height of the page header and footer
+in \autoref{sec:scrlayer-scrpage.height},
+\autopageref{sec:scrlayer-scrpage.height}.
+\else % ---------------------------------------------- only scrlayer-scrpage -
+
+\begin{Declaration}
+ \Length{footheight}\\
+ \Length{headheight}
+\end{Declaration}
+\BeginIndex{Length}{footheight}%
+\BeginIndex{Length}{headheight}%
+The package \Package{scrlayer} introduces \Length{footheight} as a new length
+similar to \Length{headheight} of the \LaTeX{} kernel. Additionally
+\Package{scrlayer-scrpage} interprets \Length{footskip} to be the distance
+from the last possible base line of the text area to the first normal base
+line of the footer. Package \Package{typearea}\IndexPackage{typearea}
+interprets \Package{footheight} in the same way. So \Package{typearea}'s foot
+height options may also be used to setup the values for packages
+\Package{scrlayer} and \Package{scrlayer-scrpage}. See option
+\Option{footheight} and \Option{footlines} in \autoref{sec:typearea.typearea},
+\autopageref{desc:typearea.option.footheight}) and option \Option{footinclude}
+at \autopageref{desc:typearea.option.footinclude} of the same section.
+
+If you do not use package \Package{typearea}, you should setup the head and
+foot height using the lengths directly where necessary. At least for the head
+package \Package{geometry} provides similar settings. If you setup a head or
+foot height that is too small for the effective content,
+\Package{scrlayer-scrpage} will try to adjust the corresponding lengths
+properly. Furthermore, it will warn you and give you additional information
+about the changes and proper settings you may use yourself. The automatic
+changes will become valid immediately after the need for them has been
+detected. They will never be removed automatically, however, even if content
+with a lower height requirement should be detected at a later point in time.%
+\EndIndex{Length}{headheight}%
+\EndIndex{Length}{footheight}%
+
+\fi % ********************************************* Ende nur scrlayer-scrpage *
+
+%%% Local Variables:
+%%% mode: latex
+%%% mode: flyspell
+%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
+%%% TeX-master: "../guide.tex"
+%%% TeX-PDF-mode: t
+%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-21.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-21.tex
new file mode 100644
index 00000000000..92397fe2f17
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-21.tex
@@ -0,0 +1,765 @@
+% ======================================================================
+% common-21.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% This file is part of the LaTeX2e KOMA-Script bundle.
+%
+% This work may be distributed and/or modified under the conditions of
+% the LaTeX Project Public License, version 1.3c of the license.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later and of this work.
+%
+% This work has the LPPL maintenance status "author-maintained".
+%
+% The Current Maintainer and author of this work is Markus Kohm.
+%
+% This work consists of all files listed in manifest.txt.
+% ----------------------------------------------------------------------
+% common-21.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
+% Version 1.3c, verteilt und/oder veraendert werden.
+% Die neuste Version dieser Lizenz ist
+% http://www.latex-project.org/lppl.txt
+% und Version 1.3c ist Teil aller Verteilungen von LaTeX
+% Version 2005/12/01 oder spaeter und dieses Werks.
+%
+% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
+% (allein durch den Autor verwaltet).
+%
+% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
+%
+% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
+% ======================================================================
+%
+% Text that is common for several chapters of the KOMA-Script guide
+% Maintained by Markus Kohm
+%
+% ----------------------------------------------------------------------
+%
+% Absaetze, die mehreren Kapitels in der KOMA-Script-Anleitung gemeinsam sind
+% Verwaltet von Markus Kohm
+%
+% ============================================================================
+
+\KOMAProvidesFile{common-21.tex}
+ [$Date: 2013-10-22 11:17:09 +0200 (Di, 22 Okt 2013) $
+ KOMA-Script guide (common paragraph:
+ Manipulation of defined page styles)]
+\translator{Markus Kohm\and Jana Schubert}
+
+% Date version of the translated file: 2013-10-23
+
+\makeatletter
+\@ifundefined{ifCommonscrlayer}{\newif\ifCommonscrlayer}{}%
+\@ifundefined{ifCommoonscrlayer-scrpage}{\expandafter\newif\csname ifCommonscrlayer-scrpage\endcsname}{}%
+\@ifundefined{ifIgnoreThis}{\newif\ifIgnoreThis}{}%
+\makeatother
+
+\section{Manipulation of Defined Page Styles}
+\label{sec:\csname label@base\endcsname.pagestyle.content}
+
+\IfCommon{scrlayer}{%
+ Even though \Package{scrlayer} itself does not define a concrete page style
+ with content\,---\,the already mentioned page styles \Pagestyle{@everystyle@}
+ and \Pagestyle{empty} are initially defined without any level and so empty
+ and without content\,---\,, it provides some options and commands for the
+ manipulation of the contents.%
+}
+
+\IfCommon{scrlayer-scrpage}{%
+ \hyperref[sec:scrlayer-scrpage.predefined.pagestyles]%
+ {Section~\ref*{sec:scrlayer-scrpage.predefined.pagestyles}}
+ states the predefined defaults for the page style \Pagestyle{scrheadings}
+ and \Pagestyle{plain.scrheadings} and how they can be adapted. But
+ information about the generation of, i.\,e., the running heads, the
+ manipulation of the widths of page head and footer, and how you can get
+ horizontal lines printed above or below the page head or footer are still
+ missing. Even though all these are features of package \Package{scrlayer},
+ they will be described consecutively, because these basic features of
+ \Package{scrlayer} are also a fundamental part of the features of
+ \Package{scrlayer-scrpage}.%
+}
+
+\ifshortversion\IgnoreThistrue\IfCommon{scrlayer-scrpage}{\IgnoreThisfalse}\fi
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++++++ not scrlayer-scrpage +
+\else %----------------------------------------------- only scrlayer-scrpage -
+
+\begin{Declaration}
+ \Macro{automark}\OParameter{section level of the right mark}%
+ \Parameter{section level of the left mark}\\
+ \Macro{automark*}\OParameter{section level of the right mark}%
+ \Parameter{section level of the left mark}\\
+ \Macro{manualmark}\\
+ \Option{automark}\\
+ \KOption{autooneside}\PName{simple switch}\\
+ \Option{manualmark}
+\end{Declaration}
+\BeginIndex{Cmd}{automark}%
+\BeginIndex{Cmd}{manualmark}%
+\BeginIndex{Option}{automark}%
+\BeginIndex{Option}{manualmark}%
+\BeginIndex{Option}{autooneside~=\PName{simple switch}}%
+With the \LaTeX{} standard classes or the \KOMAScript{} classes the decision
+whether using automatic running heads\Index{running heads>automatic}, or
+static or manual running heads\Index{running heads>static}\Index{running
+ heads>manual} would be done using either page style \Pagestyle{headings} or
+\Pagestyle{myheadings}. Automatic running heads are replications of a
+significant, characterizing text snippet of the page mostly inside the page
+head, sometimes in the page footer.
+
+The article classes\OnlyAt{\Class{article}\and \Class{scrartcl}}
+\Class{article} or \Class{scrartcl} with page style
+\Pagestyle{headings}\IndexPagestyle{headings} use the section heading, which
+is either the mandatory or the optional argument of \Macro{section}, for the
+automatic running head of single side documents. Double side documents use
+this section heading as the \emph{left mark} and at once use the subsection
+heading as the \emph{right mark}. The left mark will be printed on left pages,
+which founds the name \emph{left mark}. The right mark will be printed on
+right\,---\,in single side mode this means every\,---\,page. The classes by
+default also remove the right mark whenever they put the section heading into
+the left mark.
+
+The report and book classes \OnlyAt{\Class{report}\and
+ \Class{scrreprt}\and \Class{book}\and \Class{scrbook}} start one level
+higher. So they use the chapter heading to be the right mark in single side
+layout. In double side layout they use the chapter heading to be the left mark
+and the section heading to be the right mark.
+
+If you are using \Pagestyle{myheadings} instead of
+\Pagestyle{headings}\IndexPagestyle{myheadings}, the marks in the page header
+still exists and would be printed same like using \Pagestyle{headings}. But
+section commands will not automatically set the marks any longer. So you can
+fill them only using the commands \Macro{markright}, \Macro{markleft}, and
+\Macro{markboth}, which will be described later in this section.
+
+This difference between two page styles has been abolished by
+\Package{scrpage2} and also by \Package{scrlayer}. Instead of distinguishing
+between automatic and manual running head by the selection of a page style,
+two new commands, \Macro{automark} and \Macro{manualmark}, are provided. The
+command \Macro{manualmark} switches to manual marks and deactivates the
+automatic filling of the marks. In contrast to this \Macro{automark} and
+\Macro{automark*} can be used to define, which section levels should be used
+for the automatic mark filling. The optional argument is the \PName{section
+ level of the right mark}, the mandatory argument the \PName{section level of
+ the left mark}. The arguments always should be the name of a section level
+like \PValue{part}, \PValue{chapter}, \PValue{section}, \PValue{subsection},
+\PValue{subsubsection}, \PValue{paragraph}, or \PValue{subparagraph}.
+
+Generally the higher level should be used for the left mark and the lower
+level for the right mark. This is only a convention and not a need, but it
+makes sense.
+
+The difference in \Macro{automark} and \Macro{automark*} is, that
+\Macro{automark} deletes all prior usages of \Macro{automark} or
+\Macro{automark*}, while \Macro{automark*} changes only the behaviour of the
+section levels of its arguments. So you can even build more complex cases.
+
+\begin{Example}
+ Assume you want the chapter heading to be the running head of even pages
+ and the section heading to be the running head of odd pages like this is
+ usual for books. But on odd pages you also want the chapter headings as a
+ running head as long as the first section appears. To do so, you first have
+ to load \Package{scrlayer-scrpage} and select page style
+ \Pagestyle{scrheadings}. So you're document starts with:
+\begin{lstcode}
+ \documentclass{scrbook}
+ \usepackage{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+\end{lstcode}
+ Next you will setup the chapter heading to be not only the left but also the
+ right mark:
+\begin{lstcode}
+ \automark[chapter]{chapter}
+\end{lstcode}
+ Then the section heading should also become a right mark:
+\begin{lstcode}
+ \automark*[section]{}
+\end{lstcode}
+ Here the star version is used, because the prior \Macro{automark} command
+ should be still valid. Additionally the mandatory argument for the
+ \PName{section level of the left mark} is empty, because this mark should be
+ unchanged.
+
+ Now you just need some document contents to see a result:
+\begin{lstcode}
+ \usepackage{lipsum}
+ \begin{document}
+ \chapter{Chapter Heading}
+ \lipsum[1-20]
+ \section{Section Heading}
+ \lipsum[21-40]
+ \end{document}
+\end{lstcode}
+ We once again use package \Package{lipsum}\IndexPackage{lipsum} to generate
+ some dummy text with command \Macro{lipsum}\IndexCmd{lipsum}. The package is
+ really useful.
+
+ If you'd test the example, you'd see, that the chapter start page does not
+ have a running head as usual. This is, because it automatically uses the
+ \Pagestyle{plain} page style \Pagestyle{plain.scrheadings}. Pages~2--4 have
+ the chapter headings in the running head. After the section heading on
+ page~4 the running head of page~5 changes into this section heading. From
+ this page to the end the running head alternates between chapter and section
+ heading from page to page.
+\end{Example}
+
+Instead of the commands you may also use the options \Option{manualmark} and
+\Option{automark} to switch between manual and automatic running
+heads. Thereby \Option{automark} always uses the default
+\begin{lstcode}[belowskip=\dp\strutbox]
+ \automark[section]{chapter}
+\end{lstcode}
+for classes with \Macro{chapter} and
+\begin{lstcode}[belowskip=\dp\strutbox]
+ \automark[subsection]{section}
+\end{lstcode}
+for classes without \Macro{chapter}.
+
+But normally in single side mode you do not want that the lower level
+influences the right mark, you want the higher level, that
+will fill only the left mark in double side layout, to be the running head of
+all pages. The default option \Option{autooneside} corresponds to this
+behaviour. The option understands the values for simple switches, that can be
+found in \autoref{tab:truefalseswitch} on
+\autopageref{tab:truefalseswitch}. If you'd deactivate the option, in single
+side layout the optional and the obligatory arguments of \Macro{automark} and
+\Macro{automark*} will influence the running head again.%
+%
+\begin{Example}
+ Assume you have a single sided report but want similar running heads as in
+ the book example before. The chapter headings should be used as a running
+ head as long as the first section appears. From the first section on, the
+ section heading should be used. So we modify the previous example a little
+ bit:
+\begin{lstcode}
+ \documentclass{scrreprt}
+ \usepackage[autooneside=false]{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \automark[section]{chapter}
+ \usepackage{lipsum}
+ \begin{document}
+ \chapter{Chapter Heading}
+ \lipsum[1-20]
+ \section{Section Heading}
+ \lipsum[21-40]
+ \end{document}
+\end{lstcode}
+ You can see, that we do not need a \Macro{automark*} command in this
+ case. Please try the example also with \Option{autooneside} set to
+ \PValue{true} or remove the option and its value. You should find a
+ difference at the running head in the pages' head from page~4 on.
+\end{Example}
+
+Please note\textnote{Attention!}, only loading the package does not have
+any effect on the fact whether automatic or manual running heads are used or
+what kind of section headings do fill up the marks. Only using an explicit
+option \Option{automark} or \Option{manualmark} or one of the commands
+\Macro{automark} or \Macro{manualmark} can reach a well defined state.%
+\EndIndex{Option}{autooneside~=\PName{simple switch}}%
+\EndIndex{Option}{manualmark}%
+\EndIndex{Option}{automark}%
+\EndIndex{Cmd}{manualmark}%
+\EndIndex{Cmd}{automark}%
+\fi % ******************************************** End only scrlayer-scrpage *
+
+\ifshortversion\IgnoreThistrue\IfCommon{scrlayer}{\IgnoreThisfalse}\fi
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++++++++++++++ not scrlayer +
+\else %------------------------------------------------------- only scrlayer -
+
+\begin{Declaration}
+ \KOption{draft}\PName{simple switch}
+\end{Declaration}
+\BeginIndex{Option}{draft~=\PName{simple switch}}%
+This \KOMAScript{} option understands the values for simple switches, that are
+shown in \autoref{tab:truefalseswitch} on \autopageref{tab:truefalseswitch}. If
+the option is active, all elements of the page styles will also show dimension
+lines. This might be useful while draft editing. If the option has been set as
+a global option (see the optional argument of \Macro{documentclass}), but you
+do not want the dimension lines, you can deactivate them for the package only
+using \OptionValue{draft}{false} as an optional argument of \Macro{usepackage}
+while loading the package.%
+\EndIndex{Option}{draft~=\PName{Ein-Aus-Wert}}%
+
+\begin{Declaration}
+ \Macro{MakeMarkcase}\Parameter{string}
+\end{Declaration}
+\BeginIndex{Cmd}{MakeMarkcase}%
+The automatic running head and only this uses \Macro{MakeMarkcase} for its
+output. If the command has not been defined, e.\,g., by the class, while
+loading \Package{scrlayer}, it would be defined with the default of outputting
+the argument \PName{string} without changes. But the default can be change
+either redefining \Macro{MakeMarkcase} or using option \Option{markcase}, that
+\ifshortversion has been described in
+\autoref{sec:scrlayer-scrpage.pagestyle.content}%
+\else will be described next%
+\fi%
+. Depending on the setting the argument could, e.\,g., be converted into upper
+or lower cases.
+%
+\EndIndex{Cmd}{MakeMarkcase}%
+\fi %***************************************************** End only scrlayer *
+
+\ifshortversion\IgnoreThistrue\IfCommon{scrlayer-scrpage}{\IgnoreThisfalse}\fi
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++++++ not scrlayer-scrpage +
+\else %----------------------------------------------- only scrlayer-scrpage -
+\begin{Declaration}
+ \KOption{markcase}\PName{Wert}
+\end{Declaration}
+\BeginIndex{Option}{markcase~=\PName{Wert}}%
+As already mentioned with \Package{scrlayer} you may switch between manual and
+automatic running heads. Using automatic running heads the corresponding marks
+will be filled by the section heading commands. Some culture areas do convert
+the running heads into upper case letters in opposite to the German
+typographic habit. The \LaTeX{} standard classes do so by default. Package
+\Package{scrlayer} optionally provides this too. Therefor you'd use option
+\OptionValue{markcase}{upper} which results in a redefinition of
+\Macro{MakeMarkcase}\IndexCmd[indexmain]{MakeMarkcase}, a command, that is
+used by \Package{scrlayer} for automatic running heads.
+
+Unfortunately \LaTeX's command for upper case letter typesetting,
+\Macro{MakeUppercase}\IndexCmd{MakeUppercase} results in an very inadequate
+typesetting, because it neither uses letter spacing nor does it space
+balancing. One reason for this behaviour might be, that a glyph analyzing
+would be needed, to incorporate the letter shapes and their combination while
+space balancing. Because of this \KOMAScript{} author suggests to abstain from
+upper case letter typesetting for running heads. This could be achieved using
+\OptionValue{markcase}{used}. Nevertheless, some classes would add
+\Macro{MarkUppercase} or even \TeX{} command \Macro{uppercase} into the
+running heads. For such cases option \OptionValue{markcase}{noupper} can be
+used. This will also deactivate \Macro{MakeUppercase} and \Macro{uppercase}
+inside the running heads.
+
+You can find all valid values for \Option{markcase} in
+\autoref{tab:scrlayer-scrpage.markcase}.%
+%
+\begin{table}
+ \centering
+ \caption[Possible values for option \Option{markcase}]{Possible values for
+ option \Option{markcase} to select upper/lower case letter typesetting in
+ automatic running heads}%
+ \label{tab:scrlayer-scrpage.markcase}%
+ \begin{desctabular}
+ \pventry{lower}{\IndexOption{markcase~=\PValue{lower}}%
+ redefines \Macro{MakeMarkcase} to convert the automatic running heads
+ into lower case letters using \Macro{MakeLowercase}
+ (lower case typesetting).%
+ }%
+ \pventry{upper}{\IndexOption{markcase~=\PValue{upper}}%
+ redefines \Macro{MakeMarkcase} to convert the automatic running heads
+ into upper case letters using \Macro{MakeUppercase}
+ (upper case typesetting).%
+ }%
+ \pventry{used}{\IndexOption{markcase~=\PValue{used}}%
+ redefines \Macro{MakeMarkcase} to use automatic running heads without
+ any case changes.%
+ }%
+ \entry{\PValue{ignoreuppercase}, \PValue{nouppercase},
+ \PValue{ignoreupper},
+ \PValue{noupper}}{\IndexOption{markcase~=\PValue{noupper}}%
+ redefines not only \Macro{MakeMarkcase} but also locally to the running
+ heads \Macro{MakeUppercase} and \Macro{uppercase} to leave the automatic
+ running heads unchanged.%
+ }%
+ \end{desctabular}
+\end{table}
+%
+\EndIndex{Option}{markcase~=\PName{Wert}}%
+
+\begin{Declaration}
+ \Macro{leftmark}\\
+ \Macro{rightmark}\\
+ \Macro{headmark}\\
+ \Macro{pagemark}
+\end{Declaration}
+\BeginIndex{Cmd}{leftmark}%
+\BeginIndex{Cmd}{rightmark}%
+\BeginIndex{Cmd}{headmark}%
+\BeginIndex{Cmd}{pagemark}%
+If you want to differ from the predefined page styles, usually you need to
+decide, where to place the marks' contents. With \Macro{leftmark} you can state
+the contents of the left mark.
+
+Similar you can use \Macro{rightmark} to state the contents of the right
+mark. For more information about some intricacies of this see the further
+description of \Macro{rightmark} in \autoref{sec:maincls-experts.addInfos},
+\autopageref{desc:maincls-experts.cmd.rightmark}.
+
+Somehow easier would be usage of \Macro{headmark}. This extension of
+\Package{scrlayer} aliases either \Macro{leftmark} or \Macro{rightmark}
+depending on whether the current page is even or odd.
+
+Strictly thought command \Macro{pagemark} is not involved by \TeX's mark
+mechanism. It is only used to output a formatted page number.
+\BeginIndex{FontElement}{pagenumber}%
+The font of element
+\FontElement{pagenumber}\important{\FontElement{pagenumber}} will be used for
+the output. This can be changed using command \Macro{setkomafont} or
+\Macro{addtokomafont} (see also \autoref{sec:maincls.textmarkup},
+\autopageref{desc:maincls.cmd.setkomafont}).%
+\EndIndex{FontElement}{pagenumber}%
+%
+\begin{Example}
+ Assume you want to use a left aligned running head and right aligned page
+ number in the head of the pages of a document in single side layout. The
+ following minimal but working examples would do so:
+\begin{lstcode}
+ \documentclass{scrreprt}
+ \usepackage{blindtext}
+ \usepackage[automark]{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \ihead{\headmark}
+ \ohead[\pagemark]{\pagemark}
+ \chead{}
+ \cfoot[]{}
+ \begin{document}
+ \blinddocument
+ \end{document}
+\end{lstcode}
+ Here package \Package{blindtext}\IndexPackage{blindtext} with its command
+ \Macro{blinddocument}\IndexCmd{blinddocument} has been used to easily
+ generate content for an example document.
+
+ Commands \Macro{ihead} and \Macro{ohead} have been used to place the wanted
+ marks. Although the page mark will be place not only to pages in page style
+ \Pagestyle{scrheadings} but using the optional argument also to pages in
+ page style \Pagestyle{plain.scrheadings}.
+
+ Because of both page styles already have marks in the middle of the page
+ head and page foot, those elements will be cleared using \Macro{chead} and
+ \Macro{cfoot} with empty arguments. Alternatively you'd use
+ \Macro{clearpairofpagestyles} \emph{before} \Macro{ihead}. You will find a
+ description of this command in
+ \autoref{sec:scrlayer-scrpage.pagestyle.pairs}.
+\end{Example}
+
+Please note\textnote{Attention!}, that the empty optional argument of
+\Macro{cfoot} in the example above is not the same like omitting the optional
+argument. Please try it out and have a look at the difference in the footer of
+the first page.%
+%
+\EndIndex{Cmd}{pagemark}%
+\EndIndex{Cmd}{headmark}%
+\EndIndex{Cmd}{rightmark}%
+\EndIndex{Cmd}{leftmark}%
+
+\begin{Declaration}
+ \Macro{partmarkformat}\\
+ \Macro{chaptermarkformat}\\
+ \Macro{sectionmarkformat}\\
+ \Macro{subsectionmarkformat}\\
+ \Macro{subsubsectionmarkformat}\\
+ \Macro{paragraphmarkformat}\\
+ \Macro{subparagraphmarkformat}
+\end{Declaration}
+\BeginIndex{Cmd}{partmarkformat}%
+\BeginIndex{Cmd}{chaptermarkformat}%
+\BeginIndex{Cmd}{sectionmarkformat}%
+\BeginIndex{Cmd}{subsectionmarkformat}%
+\BeginIndex{Cmd}{subsubsectionmarkformat}%
+\BeginIndex{Cmd}{paragraphmarkformat}%
+\BeginIndex{Cmd}{subparagraphmarkformat}%
+Usually the \KOMAScript{} classes and package \Package{scrlayer} use these
+commands internally to bring the section numbers into wanted form and
+additionally they support the \Macro{autodot} mechanism of the \KOMAScript{}
+classes. If wanted these commands may be redefined to get another form of
+section numbers.%
+%
+\begin{Example}
+ Assume you do not want section numbers but section heading text only in the
+ running head. So:
+\begin{lstcode}
+ \renewcommand*{\sectionmarkformat}{}
+\end{lstcode}
+ would be a simple solution for this.
+\end{Example}
+%
+\EndIndex{Cmd}{subparagraphmarkformat}%
+\EndIndex{Cmd}{paragraphmarkformat}%
+\EndIndex{Cmd}{subsubsectionmarkformat}%
+\EndIndex{Cmd}{subsectionmarkformat}%
+\EndIndex{Cmd}{sectionmarkformat}%
+\EndIndex{Cmd}{chaptermarkformat}%
+\EndIndex{Cmd}{partmarkformat}%
+
+\begin{Declaration}
+ \Macro{partmark}\Parameter{Text}\\
+ \Macro{chaptermark}\Parameter{Text}\\
+ \Macro{sectionmark}\Parameter{Text}\\
+ \Macro{subsectionmark}\Parameter{Text}\\
+ \Macro{subsubsectionmark}\Parameter{Text}\\
+ \Macro{paragraphmark}\Parameter{Text}\\
+ \Macro{subparagraphmark}\Parameter{Text}
+\end{Declaration}
+\BeginIndex{Cmd}{partmark}%
+\BeginIndex{Cmd}{chaptermark}%
+\BeginIndex{Cmd}{sectionmark}%
+\BeginIndex{Cmd}{subsectionmark}%
+\BeginIndex{Cmd}{subsubsectionmark}%
+\BeginIndex{Cmd}{paragraphmark}%
+\BeginIndex{Cmd}{subparagraphmark}%
+Most classes use these commands to setup marks corresponding to the
+section commands. Thereby the only argument is the text without the number of
+the section heading, that should be used for the running head. For the number
+simply the number of the current section level will be used, if the current
+level uses numbers.
+
+If users redefine these commands, they should\textnote{Attention!} take care
+to also use the counter \Counter{secnumdepth} for the test whether or not the
+section level should output a number, even in the case the user
+does not change counter \Counter{secnumdepth} himself, because packages and
+classes may do so locally and rely on correct handling of
+\Counter{secnumdepth}.
+
+However, package \Package{scrlayer} redefines these commands whenever you use
+\Macro{automark} or \Macro{manualmark} or the corresponding options, to
+activate or deactivate the wanted running heads.%
+%
+\EndIndex{Cmd}{subparagraphmark}%
+\EndIndex{Cmd}{paragraphmark}%
+\EndIndex{Cmd}{subsubsectionmark}%
+\EndIndex{Cmd}{subsectionmark}%
+\EndIndex{Cmd}{sectionmark}%
+\EndIndex{Cmd}{chaptermark}%
+\EndIndex{Cmd}{partmark}%
+
+\begin{Declaration}
+ \Macro{markleft}\Parameter{left mark}\\
+ \Macro{markright}\Parameter{right mark}\\
+ \Macro{markboth}\Parameter{left mark}\Parameter{right mark}
+\end{Declaration}
+\BeginIndex{Cmd}{markleft}%
+\BeginIndex{Cmd}{markright}%
+\BeginIndex{Cmd}{markboth}%
+Independent of whether currently manual or automatic running heads are active,
+you may change the contents of the \PName{left mark} or the \PName{right mark}
+at any time using these commands. You should note, that the resulting contents
+of \Macro{leftmark}\IndexCmd{leftmark} is the \PName{left
+ mark} of the last \Macro{markleft} or \Macro{markboth} command of the
+current page. In opposite to this the resulting contents of
+\Macro{rightmark}\IndexCmd{rightmark} is the \PName{right mark} of the first
+\Macro{rightmark} or \Macro{markboth} command of the current page.
+
+If you are using manual running heads, the marks will stay valid until one of
+the corresponding commands will be used again. If you are using automatic
+running heads the marks can loose their validity with the next section heading
+depending on the configuration of the automatism.
+
+You may also use these commands together with the star versions of the section
+commands.%
+%
+\begin{Example}
+ Assume you are using a preface with several pages just before the table of
+ contents, that should not have an entry at the table of contents
+ itself. Because of using a separation line at the page head, you want also a
+ running head for this preface:
+\begin{lstcode}
+ \documentclass[headsepline]{book}
+ \usepackage{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \usepackage{blindtext}
+ \begin{document}
+ \chapter*{Preface}
+ \markboth{Preface}{Preface}
+ \blindtext[20]
+ \tableofcontents
+ \blinddocument
+ \end{document}
+\end{lstcode}
+ First of all this seems to produce the wanted result. But have a closer
+ look: In difference to the other running heads ``\texttt{Preface}'' is not in
+ upper case letters. But you can fix this easily:
+\begin{lstcode}
+ \documentclass[headsepline]{book}
+ \usepackage{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \usepackage{blindtext}
+ \begin{document}
+ \chapter*{Preface}
+ \markboth{\MakeMarkcase{Preface}}{\MakeMarkcase{Preface}}
+ \blindtext[20]
+ \tableofcontents
+ \blinddocument
+ \end{document}
+\end{lstcode}
+ Using command \Macro{MakeMarkcase} results in getting the same letter case
+ as for automatic running heads.
+
+ Now, let's move command \Macro{tableofcontents} in front of the
+ preface. Let's remove the \Macro{markboth} command too. You'll realise, that
+ the preface now has the running head ``\texttt{CONTENTS}''. This is because
+ of a quirk of \Macro{chapter*} (see also \autoref{sec:maincls.structure} on
+ \autopageref{desc:maincls.cmd.chapter*}). If in such cases the running head
+ should be removed, \Macro{markboth} with two empty arguments would be
+ useful:
+\begin{lstcode}
+ \documentclass[headsepline]{book}
+ \usepackage{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \usepackage{blindtext}
+ \begin{document}
+ \tableofcontents
+ \chapter*{Preface}
+ \markboth{}{}
+ \blindtext[20]
+ \blinddocument
+ \end{document}
+\end{lstcode}
+\end{Example}
+%
+\EndIndex{Cmd}{markboth}%
+\EndIndex{Cmd}{markright}%
+\EndIndex{Cmd}{markleft}%
+
+\fi %********************************************* End only scrlayer-scrpage *
+
+
+\ifshortversion\IgnoreThistrue\IfCommon{scrlayer}{\IgnoreThisfalse}\fi
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++++++++++++++ not scrlayer +
+\else %------------------------------------------------------- only scrlayer -
+
+\begin{Declaration}
+ \Macro{GenericMarkFormat}\Parameter{name of the section level}
+\end{Declaration}
+\BeginIndex{Cmd}{GenericMarkFormat}%
+At the running head this command will be used by default for the formatting of
+all section numbers below the subsection and with classes without
+\Macro{chapter} also for the section level and the subsection level, if the
+mark commands for those numbers have not been defined before loading
+\Package{scrlayer}. Thereby the package uses \Macro{@seccntmarkformat} if such
+a command has been defined, like the \KOMAScript{} classes do. Otherwise
+\Macro{@seccntformat} will be used, which is provided by the \LaTeX{}
+kernel. The expected, mandatory argument of the command is the \PName{name of
+ a section level}, i.\,e., \PValue{chapter} or \PValue{section}
+\emph{without} the backslash prefix.
+
+You can change the default formatting of the numbers, that use this command,
+by redefining only this single command. Classes can change the default
+formatting also by defining this command.%
+%
+\begin{Example}
+ Assume you want the section numbers of all levels at the running head of
+ an article to be printed in white colour inside a black coloured box. Using
+ standard \LaTeX{} \Class{article} class, package \Package{scrlayer} defines
+ the number mark commands \Macro{sectionmarkformat} and
+ \Macro{subsectionmarkformat} using \Macro{GenericMarkFormat}. So you need to
+ redefine only this single command:
+\begin{lstcode}
+ \documentclass{article}
+ \usepackage{blindtext}
+ \usepackage[automark]{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \usepackage{xcolor}
+ \newcommand*{\numberbox}[1]{%
+ \colorbox{black}{\strut~\textcolor{white}{#1}~}}
+ \renewcommand*{\GenericMarkFormat}[1]{%
+ \protect\numberbox{\csname the#1\endcsname}\enskip}
+ \begin{document}
+ \blinddocument
+ \end{document}
+\end{lstcode}
+ The colour has been done using package
+ \Package{xcolor}\IndexPackage{xcolor}. See the package manual for more
+ information about this. Additionally a not visible strut has been
+ used. Every complete \LaTeX{} introduction should explain the related
+ command \Macro{strut}. A helper macro \Macro{numberbox} has been defined for
+ the formatting of the number within a box. In the redefinition of
+ \Macro{GenericMarkFormat} this has been prefixed by
+ \Macro{protect} to protect it from expansion. This is necessary because
+ otherwise the upper case letter conversion of \Macro{MakeUppercase} that
+ will be used for the running head, would result in an ask for colours
+ ``\texttt{BLACK}'' and ``\texttt{WHITE}'' instead of ``\texttt{black}'' and
+ ``\texttt{white}'' and those colours are undefined. Alternatively you may
+ define \Macro{numberbox} using \Macro{DeclareRobustCommand*} instead of
+ \Macro{newcommand*} and then omit \Macro{protect} (see
+ \cite{latex:clsguide}).
+
+ If you'd do the same with a \KOMAScript{} class or with one of the \LaTeX{}
+ standard classes \Class{book} or \Class{report}, you'd additionally have to
+ redefine \Macro{sectionmarkformat} and \Macro{subsectionmarkformat}
+ respectively \Macro{chaptermarkformat} and \Macro{sectionmarkformat} too,
+ because then these would not have been defined using
+ \Macro{GenericMarkFormat}:
+\begin{lstcode}
+ \documentclass{scrbook}
+ \usepackage{blindtext}
+ \usepackage[automark]{scrlayer-scrpage}
+ \pagestyle{scrheadings}
+ \usepackage{xcolor}
+ \newcommand*{\numberbox}[1]{%
+ \colorbox{black}{\strut~\textcolor{white}{#1}~}}
+ \renewcommand*{\GenericMarkFormat}[1]{%
+ \protect\numberbox{\csname the#1\endcsname}\enskip}
+ \renewcommand*{\chaptermarkformat}{\GenericMarkFormat{chapter}}
+ \renewcommand*{\sectionmarkformat}{\GenericMarkFormat{section}}
+ \begin{document}
+ \blinddocument
+ \end{document}
+\end{lstcode}
+\end{Example}
+%
+\EndIndex{Cmd}{GenericMarkFormat}%
+
+\begin{Declaration}
+ \Macro{@mkleft}\Parameter{left mark}\\
+ \Macro{@mkright}\Parameter{right mark}\\
+ \Macro{@mkdouble}\Parameter{mark}\\
+ \Macro{@mkboth}\Parameter{left mark}\Parameter{right mark}
+\end{Declaration}
+\BeginIndex{Cmd}{@mkleft}%
+\BeginIndex{Cmd}{@mkright}%
+\BeginIndex{Cmd}{@mkdouble}%
+\BeginIndex{Cmd}{@mkboth}%
+Sometimes inside classes and packages the marks for running heads should be
+filled up only if automatic running heads are active (see option
+\Option{automark} and command \Macro{automark} on
+\autopageref{desc:scrlayer-scrpage.cmd.automark}). In the \LaTeX{} standard
+classes only \Macro{@mkboth} has been used for this. This command is either
+\Macro{@gobbletwo}, that simply destroys both mandatory arguments, or
+\Macro{markboth}, a command that fills up the left and \PValue{left mark} and
+the \PValue{right mark}. Packages like \Package{babel} also change
+\Macro{\@mkboth}, i.\,e., to add language switching to the running head.
+
+But if a class or package author only wants to change either the \PName{left
+ mark} or the \PName{right mark} without the other one, a proper command is
+missing. Package \Package{scrlayer} itself needs such commands for the
+implementation of all cases of automatic running heads. So if command
+\Macro{@mkleft} to fill up only the left mark or \Macro{@mkright} to fill up
+only the right mark or \Macro{@mkdouble} to fill up both marks with the same
+content is undefined while loading \Package{scrlayer}, the package will define
+them. Thereby the actual definition of \Macro{@mkboth} will be used as an
+indicator whether or not automatic running heads should be used. The new
+commands will full up the marks only in the case of automatic running heads.
+
+Class and package authors can use these commands too, if they want to fill up
+only one of the marks or both marks with the same content but only if
+automatic running heads are activated. This condition is also the difference
+to the commands \Macro{markleft}, \Macro{markright}, and \Macro{markboth}.%
+\EndIndex{Cmd}{@mkboth}%
+\EndIndex{Cmd}{@mkdouble}%
+\EndIndex{Cmd}{@mkright}%
+\EndIndex{Cmd}{@mkleft}%
+
+
+\fi %***************************************************** End only scrlayer *
+
+
+\ifshortversion%
+\IfCommon{scrlayer}{%
+ For more information about manipulation of the contents of page styles see
+ also \autoref{sec:scrlayer-scrpage.pagestyle.content} from
+ \autopageref{sec:scrlayer-scrpage.pagestyle.content}.%
+}%
+\fi
+
+%%% Local Variables:
+%%% mode: latex
+%%% mode: flyspell
+%%% coding: iso-latin-1
+%%% ispell-local-dictionary: "en_GB"
+%%% TeX-master: "scrlayer-de.tex"
+%%% TeX-PDF-mode: t
+%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-3.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-3.tex
index 4ab9ce77ef9..a747b1f68e2 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-3.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-3.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-3.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-3.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-3.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-3.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Markus Kohm\and Krickette Murabayashi}
% Date of the translated german file: 2009/11/28
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-4.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-4.tex
index 38c0e9e2730..8388bc8a938 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-4.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-4.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-4.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-4.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-4.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-4.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2011/09/05
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-5.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-5.tex
index dfbf6fd9aff..fea58a3a5ee 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-5.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-5.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-5.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-5.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ======================================================================
-\ProvidesFile{common-5.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-5.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs)]
\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
-% Date of the translated German file: 2012/01/01
+% Date of the translated German file: 2013/07/31
\makeatletter
\@ifundefined{ifCommonmaincls}{\newif\ifCommonmaincls}{}%
@@ -60,11 +62,12 @@
\section{Text Markup}
\label{sec:\csname label@base\endcsname.textmarkup}%
-\ifshortversion\IgnoreThisfalse\IfCommon{scrlttr2}{\IgnoreThistrue}\fi%
-\ifIgnoreThis %++++++++++++++++++++++++++++++++++++++++++++++ nur scrlttr2 +
+\IgnoreThisfalse
+\ifshortversion\IgnoreThistrue\ifCommonmaincls\IgnoreThisfalse\fi\fi%
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++ short version (maincls) +
What is described in
\autoref{sec:maincls.textmarkup} applies, mutatis mutandis.
-\else %---------------------------------------------------- nicht scrlttr2 -
+\else %----------------------------------------- long version (not maincls) -
\BeginIndex{}{text>markup}%
\BeginIndex{}{font}%
@@ -177,8 +180,8 @@ You should\textnote{Attention!}, however, absolutely limit yourself to those
statements that really switch only one font attribute. This will usually be
the commands \Macro{normalfont}, \Macro{rmfamily}, \Macro{sffamily},
\Macro{ttfamily}, \Macro{mdseries}, \Macro{bfseries}, \Macro{upshape},
-\Macro{itshape}, \Macro{slshape}, and \Macro{scshape}, as well as the font size
-commands \Macro{Huge}, \Macro{huge}, \Macro{LARGE}, \Macro{Large},
+\Macro{itshape}, \Macro{slshape}, and \Macro{scshape}, as well as the font
+size commands \Macro{Huge}, \Macro{huge}, \Macro{LARGE}, \Macro{Large},
\Macro{large}, \Macro{normalsize}, \Macro{small}, \Macro{footnotesize},
\Macro{scriptsize}, and \Macro{tiny}. The description of these commands can be
found in \cite{lshort}, \cite{latex:usrguide}, or \cite{latex:fntguide}. Color
@@ -192,7 +195,7 @@ completely new definition. In contrast to this, the \Macro{addtokomafont}
command merely extends an existing definition. It is recommended to not use
both commands inside the document body, but only in the document preamble.
Usage examples can be found in the paragraphs on the corresponding element.
-\fi %************************************************* Ende nicht scrlttr2 *
+\fi %**************************************** End long version (not maincls) *
Names and meanings of the individual items are listed in %
\IfNotCommon{scrextend}{\autoref{tab:\csname
label@base\endcsname.elementsWithoutText}}%
@@ -206,6 +209,362 @@ Names and meanings of the individual items are listed in %
the \KOMAScript{} classes. }%
The default values are shown in the corresponding paragraphs.
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++ short version (maincls) +
+\else %----------------------------------------- long version (not maincls) -
+With command \Macro{usekomafont} the current font style may be changed into
+the font style of the selected \PName{element}.
+%
+\ifCommonmaincls %++++++++++++++++++++++++++++++++++++++++++++ maincls only +
+%
+\begin{Example}
+ \phantomsection\label{desc:maincls.setkomafont.example}%
+ Assume that you want to use for the element \FontElement{captionlabel} the
+ same font specification that is used with
+ \FontElement{descriptionlabel}. This can be easily done with:
+\begin{lstcode}
+ \setkomafont{captionlabel}{%
+ \usekomafont{descriptionlabel}%
+ }
+\end{lstcode}
+ You can find other examples in the paragraphs on each element.
+\end{Example}
+
+\begin{desclist}
+ \desccaption{%
+ Elements whose type style can be changed with the {\KOMAScript} command
+ \Macro{setkomafont} or
+ \Macro{addtokomafont}\label{tab:maincls.elementsWithoutText}%
+ }{%
+ Elements whose type style can be changed (\emph{continuation})%
+ }%
+ \feentry{author}{%
+ \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}}%
+ author of the document on the main title, i.\,e., the argument of
+ \Macro{author} when \Macro{maketitle} will be used (see
+ \autoref{sec:maincls.titlepage}, \autopageref{desc:maincls.cmd.author})}%
+ \feentry{caption}{text of a table or figure caption (see
+ \autoref{sec:maincls.floats}, \autopageref{desc:maincls.cmd.caption})}%
+ \feentry{captionlabel}{label of a table or figure caption; used according to
+ the element \FontElement{caption} (see \autoref{sec:maincls.floats},
+ \autopageref{desc:maincls.cmd.caption})}%
+ \feentry{chapter}{title of the sectional unit \Macro{chapter} (see
+ \autoref{sec:maincls.structure}, \autopageref{desc:maincls.cmd.chapter})}%
+ \feentry{chapterentry}{%
+ table of contents entry of the sectional unit \Macro{chapter} (see
+ \autoref{sec:maincls.toc},
+ \autopageref{desc:maincls.cmd.tableofcontents})}%
+ \feentry{chapterentrypagenumber}{%
+ page number of the table of contents entry of the sectional unit
+ \Macro{chapter}, variation on the element \FontElement{chapterentry} (see
+ \autoref{sec:maincls.toc},
+ \autopageref{desc:maincls.cmd.tableofcontents})}%
+ \feentry{chapterprefix}{%
+ chapter number line at setting \OptionValue{chapterprefix}{true} or
+ \OptionValue{appendixprefix}{true} (see \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.option.chapterprefix})}%
+ \feentry{date}{%
+ \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}}%
+ date of the document on the main title, i.\,e., the argument of
+ \Macro{date} when \Macro{maketitle} will be used (see
+ \autoref{sec:maincls.titlepage}, \autopageref{desc:maincls.cmd.date})}%
+ \feentry{dedication}{%
+ \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}}%
+ dedication page after the main title, i.\,e., the argument of
+ \Macro{dedication} when \Macro{maketitle} will be used (see
+ \autoref{sec:maincls.titlepage},
+ \autopageref{desc:maincls.cmd.dedication})}%
+ \feentry{descriptionlabel}{labels, i.\,e., the optional argument of
+ \Macro{item} in the \Environment{description} environment (see
+ \autoref{sec:maincls.lists}, \autopageref{desc:maincls.env.description})}%
+ \feentry{dictum}{dictum, wise saying, or smart slogan (see
+ \autoref{sec:maincls.dictum}, \autopageref{desc:maincls.cmd.dictum})}%
+ \feentry{dictumauthor}{author of a dictum, wise saying, or smart slogan;
+ used according to the element \FontElement{dictumtext} (see
+ \autoref{sec:maincls.dictum}, \autopageref{desc:maincls.cmd.dictum})}%
+ \feentry{dictumtext}{another name for \FontElement{dictum}}%
+ \feentry{disposition}{all sectional unit titles, i.\,e., the arguments of
+ \Macro{part} down to \Macro{subparagraph} and \Macro{minisec}, including
+ the title of the abstract; used before the element of the corresponding
+ unit (see \autoref{sec:maincls.structure} ab
+ \autopageref{sec:maincls.structure})}%
+ \feentry{footnote}{footnote text and marker (see
+ \autoref{sec:maincls.footnotes},
+ \autopageref{desc:maincls.cmd.footnote})}%
+ \feentry{footnotelabel}{mark of a footnote; used according to the element
+ \FontElement{footnote} (see \autoref{sec:maincls.footnotes},
+ \autopageref{desc:maincls.cmd.footnote})}%
+ \feentry{footnotereference}{footnote reference in the text (see
+ \autoref{sec:maincls.footnotes},
+ \autopageref{desc:maincls.cmd.footnote})}%
+ \feentry{footnoterule}{%
+ horizontal rule\ChangedAt{v3.07}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}} above the footnotes at the end of the text area (see
+ \autoref{sec:maincls.footnotes},
+ \autopageref{desc:maincls.cmd.setfootnoterule})}%
+ \feentry{labelinglabel}{labels, i.\,e., the optional argument of
+ \Macro{item} in the \Environment{labeling} environment (see
+ \autoref{sec:maincls.lists}, \autopageref{desc:maincls.env.labeling})}%
+ \feentry{labelingseparator}{separator, i.\,e., the optional argument of the
+ \Environment{labeling} environment; used according to the element
+ \FontElement{labelinglabel} (see \autoref{sec:maincls.lists},
+ \autopageref{desc:maincls.env.labeling})}%
+ \feentry{minisec}{title of \Macro{minisec} (see
+ \autoref{sec:maincls.structure} ab
+ \autopageref{desc:maincls.cmd.minisec})}%
+ \feentry{pagefoot}{only used if package \Package{scrpage2} has been loaded
+ (see \autoref{cha:scrpage},
+ \autopageref{desc:scrpage.fontelement.pagefoot})}%
+ \feentry{pagehead}{another name for \FontElement{pageheadfoot}}%
+ \feentry{pageheadfoot}{the head of a page, but also the foot of a page (see
+ \autoref{sec:maincls.pagestyle} ab \autopageref{sec:maincls.pagestyle})}%
+ \feentry{pagenumber}{page number in the header or footer (see
+ \autoref{sec:maincls.pagestyle})}%
+ \feentry{pagination}{another name for \FontElement{pagenumber}}%
+ \feentry{paragraph}{title of the sectional unit \Macro{paragraph} (see
+ \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.cmd.paragraph})}%
+ \feentry{part}{title of the \Macro{part} sectional unit, without the line
+ containing the part number (see \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.cmd.part})}%
+ \feentry{partentry}{%
+ table of contents entry of the sectional unit \Macro{part} (see
+ \autoref{sec:maincls.toc},
+ \autopageref{desc:maincls.cmd.tableofcontents})}%
+ \feentry{partentrypagenumber}{%
+ Page number of the table of contents entry of the sectional unit
+ \Macro{part} variation on the element \FontElement{partentry} (see
+ \autoref{sec:maincls.toc},
+ \autopageref{desc:maincls.cmd.tableofcontents})}%
+ \feentry{partnumber}{line containing the part number in a title of the
+ sectional unit \Macro{part} (see \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.cmd.part})}%
+ \feentry{publishers}{%
+ \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}}%
+ publishers of the document on the main title, i.\,e., the argument of
+ \Macro{publishers} when \Macro{maketitle} will be used (see
+ \autoref{sec:maincls.titlepage},
+ \autopageref{desc:maincls.cmd.publishers})}%
+ \feentry{section}{title of the sectional unit \Macro{section} (see
+ \autoref{sec:maincls.structure}, \autopageref{desc:maincls.cmd.section})}%
+ \feentry{sectionentry}{%
+ table of contents entry of sectional unit \Macro{section} (only available
+ in \Class{scrartcl}, see \autoref{sec:maincls.toc},
+ \autopageref{desc:maincls.cmd.tableofcontents})}%
+ \feentry{sectionentrypagenumber}{%
+ page number of the table of contents entry of the sectional unit
+ \Macro{section}, variation on element \FontElement{sectionentry} (only
+ available in \Class{scrartcl, see \autoref{sec:maincls.toc},
+ \autopageref{desc:maincls.cmd.tableofcontents}})}%
+ \feentry{sectioning}{another name for \FontElement{disposition}}%
+ \feentry{subject}{%
+ categorization of the document, i.\,e., the argument of \Macro{subject} on
+ the main title page (see \autoref{sec:maincls.titlepage},
+ \autopageref{desc:maincls.cmd.subject})}%
+ \feentry{subparagraph}{title of the sectional unit \Macro{subparagraph} (see
+ \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.cmd.subparagraph})}%
+ \feentry{subsection}{title of the sectional unit \Macro{subsection} (see
+ \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.cmd.subsection})}%
+ \feentry{subsubsection}{title of the sectional unit \Macro{subsubsection}
+ (see \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.cmd.subsubsection})}%
+ \feentry{subtitle}{%
+ subtitle of the document, i.\,e., the argument of \Macro{subtitle} on the
+ main title page (see \autoref{sec:maincls.titlepage},
+ \autopageref{desc:maincls.cmd.title})}%
+ \feentry{title}{main title of the document, i.\,e., the argument of
+ \Macro{title} (for details about the title size see the additional note in
+ the text of \autoref{sec:maincls.titlepage} from
+ \autopageref{desc:maincls.cmd.title})}%
+ \feentry{titlehead}{%
+ \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}}%
+ head above the main title of the document, i.\,e., the argument of
+ \Macro{titlehead} when \Macro{maketitle} will be used (see
+ \autoref{sec:maincls.titlepage},
+ \autopageref{desc:maincls.cmd.titlehead})}%
+\end{desclist}
+\fi %************************************************** end of maincls only *
+\ifCommonscrextend %++++++++++++++++++++++++++++++++++++++++ scrextend only +
+\begin{Example}
+ Assumed, you want to print the document title in a serif font and with red
+ color. You may do this using:
+\begin{lstcode}
+ \setkomafont{title}{\color{red}}
+\end{lstcode}
+ Package \Package{color} or \Package{xcolor} will be needed for command
+ \lstinline|\color{red}|. The additional usage of \Macro{normalfont} is not
+ needed in this case, because it is already part of the definition of the
+ title itself. This\textnote{Attention!} example also needs option
+ \OptionValue{extendedfeature}{title} (see
+ \autoref{sec:scrextend.optionalFeatures},
+ \autopageref{desc:scrextend.option.extendedfeature}).
+\end{Example}
+\fi %************************************************ end of scrextend only *
+\ifCommonscrlttr %+++++++++++++++++++++++++++++++++++++++++++ scrlttr2 only +
+A general example for the usage of \Macro{setkomafont} and \Macro{usekomafont}
+may be found in \autoref{sec:maincls.textmarkup} at
+\autopageref{desc:maincls.setkomafont.example}.
+%
+\fi %************************************************* End of scrlttr2 only *
+\fi %*************************************** End long version (not maincls) *
+\ifCommonscrlttr % ++++++++++++++++++++++++++++++++++++++++++ scrlttr2 only +
+\begin{desclist}
+ \desccaption{%
+ Alphabetical list of elements whose font can be changed in
+ \Class{scrlttr2} using the commands \Macro{setkomafont} and
+ \Macro{addtokomafont}\label{tab:scrlttr2.elementsWithoutText}%
+ }{%
+ Elements whose font can be changed (\emph{continuation})%
+ }%
+ \feentry{addressee}{name und address in address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.option.addrfield})}%
+ \feentry{backaddress}{%
+ return address for a window envelope %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.option.backaddress})}%
+ \feentry{descriptionlabel}{%
+ label, i.\,e., the optional argument of \Macro{item}, in a
+ \Environment{description} environment %
+ (\autoref{sec:scrlttr2.lists},
+ \autopageref{desc:scrlttr2.env.description})}%
+ \feentry{foldmark}{%
+ foldmark on the letter page; intended for color settings %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.option.foldmarks})}%
+ \feentry{footnote}{%
+ footnote text and marker %
+ (see \autoref{sec:scrlttr2.footnotes},
+ \autopageref{desc:scrlttr2.cmd.footnote})}%
+ \feentry{footnotelabel}{%
+ mark of a footnote; used according to the element \FontElement{footnote} %
+ (see \autoref{sec:scrlttr2.footnotes},
+ \autopageref{desc:scrlttr2.cmd.footnote})}%
+ \feentry{footnotereference}{%
+ footnote reference in the text %
+ (see \autoref{sec:scrlttr2.footnotes},
+ \autopageref{desc:scrlttr2.cmd.footnote})}%
+ \feentry{footnoterule}{%
+ horizontal rule\ChangedAt{v3.07}{\Class{scrlttr2}} above the footnotes at
+ the end of the text area %
+ (see \autoref{sec:maincls.footnotes},
+ \autopageref{desc:maincls.cmd.setfootnoterule})}%
+ \feentry{labelinglabel}{%
+ labels, i.\,e., the optional argument of \Macro{item} in the
+ \Environment{labeling} environment %
+ (see \autoref{sec:scrlttr2.lists},
+ \autopageref{desc:scrlttr2.env.labeling})}%
+ \feentry{labelingseparator}{%
+ separator, i.\,e., the optional argument of the \Environment{labeling}
+ environment; used according to the element \FontElement{labelinglabel} %
+ (see \autoref{sec:scrlttr2.lists},
+ \autopageref{desc:scrlttr2.env.labeling})}%
+ \feentry{pagefoot}{%
+ used after element \FontElement{pageheadfoot} for the page foot, that has
+ been defined with variable \Variable{nextfoot}\IndexVariable{nextfoot}, or
+ for the page foot of package \Package{scrpage2} %
+ (\autoref{cha:scrpage}, \autopageref{desc:scrpage.fontelement.pagefoot})}%
+ \feentry{pagehead}{%
+ another name for \FontElement{pageheadfoot}}%
+ \feentry{pageheadfoot}{%
+ the head of a page, but also the foot of a page at all page style, that
+ has been defined using \KOMAScript{} %
+ (see \autoref{sec:scrlttr2.pagestyle},
+ \autopageref{desc:scrlttr2.fontelement.pageheadfoot})}%
+ \feentry{pagenumber}{%
+ page number in the header or footer %
+ (see \autoref{sec:scrlttr2.pagestyle},
+ \autopageref{desc:scrlttr2.fontelement.pagenumber})}%
+ \feentry{pagination}{%
+ another name for \FontElement{pagenumber}}%
+ \feentry{placeanddate}{%
+ \ChangedAt{v3.12}{\Class{scrlttr2}}%
+ place and date, if a date line will be used instead of a normal reference
+ line (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.placeseparator})}%
+ \feentry{refname}{%
+ description or title of the fields in the reference line %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.yourref})}%
+ \feentry{refvalue}{%
+ content of the fields in the reference line %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.yourref})}%
+ \feentry{specialmail}{%
+ mode of dispatch in the address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.specialmail})}%
+ \feentry{subject}{%
+ subject in the opening of the letter %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.subject})}%
+ \feentry{title}{%
+ title in the opening of the letter %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.title})}%
+ \feentry{toaddress}{%
+ variation of the element \FontElement{addressee} for setting the addressee
+ address (less the name) in the address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.toaddress})}%
+ \feentry{toname}{%
+ variation of the element \FontElement{addressee} for the name (only) of
+ the addressee in the address field %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.toname})}%
+\end{desclist}
+\fi %************************************************* End of scrlttr2 only *
+\ifIgnoreThis %++++++++++++++++++++++++++++++++++++ short version (maincls) +
+\else %----------------------------------------- long version (not maincls) -
+%
+\EndIndex{Cmd}{setkomafont}%
+\EndIndex{Cmd}{addtokomafont}%
+\EndIndex{Cmd}{usekomafont}%
+
+\begin{Declaration}
+ \Macro{usefontofkomafont}\Parameter{element}\\
+ \Macro{useencodingofkomafont}\Parameter{element}\\
+ \Macro{usesizeofkomafont}\Parameter{element}\\
+ \Macro{usefamilyofkomafont}\Parameter{element}\\
+ \Macro{useseriesofkomafont}\Parameter{element}\\
+ \Macro{useshapeofkomafont}\Parameter{element}
+\end{Declaration}
+\BeginIndex{Cmd}{usefontofkomafont}%
+\BeginIndex{Cmd}{useencodingofkomafont}%
+\BeginIndex{Cmd}{usesizeofkomafont}%
+\BeginIndex{Cmd}{usefamilyofkomafont}%
+\BeginIndex{Cmd}{useseriesofkomafont}%
+\BeginIndex{Cmd}{useshapeofkomafont}%
+Sometimes\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}\and \Package{scrextend}} and despite the recommendation
+users use the font setting feature of elements not only for font settings but
+for other settings too. In this case it may be useful to switch only to the
+font setting of an element but not to those other settings. You may use
+\Macro{usefontofkomafont} in such cases. This will activate the font size and
+baseline skip, the font encoding, the font family, the font series, and the
+font shape of an element, but no further settings as long as those further
+settings are local.
+
+You may also switch to one of those attributes only using one of the other
+commands. Note, that \Macro{usesizeofkomafont} will activate both, the font
+size and the baseline skip.%
+\EndIndex{Cmd}{useshapeofkomafont}%
+\EndIndex{Cmd}{useseriesofkomafont}%
+\EndIndex{Cmd}{usefamilyofkomafont}%
+\EndIndex{Cmd}{usesizeofkomafont}%
+\EndIndex{Cmd}{useencodingofkomafont}%
+\EndIndex{Cmd}{usefontofkomafont}%
+%
+\EndIndex{}{font}%
+\EndIndex{}{text>markup}
+\fi %*************************************** End long version (not maincls) *
+
%%% Local Variables:
%%% mode: latex
%%% coding: us-ascii
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-6.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-6.tex
index 06051e8a95a..9636b3eb4c1 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-6.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-6.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-6.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-6.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-6.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-6.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraph: Paragraph Markup)]
\translator{Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2012/01/01
@@ -91,8 +93,8 @@
\IfCommon{scrlttr2}{%
In the preliminaries of \autoref{sec:maincls.parmarkup},
\autopageref{sec:maincls.parmarkup} it was argued why paragraph indent is
- preferred over paragraph spacing. But the elements the argumentation depends on,
- i.\,e., figures, tables, lists, equations, and even new pages,
+ preferred over paragraph spacing. But the elements the argumentation depends
+ on, i.\,e., figures, tables, lists, equations, and even new pages,
are rare. Often letters are not so long that an oversighted paragraph will
have serious consequences to the readability of the document. Because of
this, the arguments are less serious for standard letters. This may be one
@@ -100,7 +102,7 @@
indentation of the first line, but with a vertical skip between
them. But there may be still some advantages of the paragraph indent. One
may be that such a letter is highlighted in the mass of letters. Another may
- be that the \emph{corporate identity} needn't be broken for letters only.}%
+ be that the \emph{corporate identity} need not be broken for letters only.}%
\ifIgnoreThis %+++++++++++++++++++++++++++++++++++++++++++++ nicht maincls +
\IfCommon{scrlttr2}{Apart from these suggestions, everything that has been
written at \autoref{sec:maincls.parmarkup} for the other \KOMAScript{}
@@ -126,11 +128,12 @@
The \PName{manner} consists of two elements. The first element is either
\PValue{full} or \PValue{half}, meaning the space amount of one line or only
half of a line. The second element is ``\PValue{*}'', ``\PValue{+}'', or
-``\PValue{-}'', and may be omitted. Without the second element the last line of
-a paragraph will end with white space of at least 1\Unit{em}. With the plus
+``\PValue{-}'', and may be omitted. Without the second element the last line
+of a paragraph will end with white space of at least 1\Unit{em}. With the plus
character as second element the white space amount will be a third, and with
-the asterisk a fourth, of the width of a normal line. The minus variant doesn't
-take care about the white space at the end of the last line of a paragraph.
+the asterisk a fourth, of the width of a normal line. The minus variant does
+not take care about the white space at the end of the last line of a
+paragraph.
The setting may be changed at any place inside the document. In this case the
command \Macro{selectfont}\IndexCmd{selectfont}%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-7.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-7.tex
index aeef2455ac2..3648bf1abb6 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-7.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-7.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-7.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-7.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,10 @@
%
% ======================================================================
-\ProvidesFile{common-7.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-7.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraph: Detection of Odd and
+ Even Pages)]
\translator{Markus Kohm\and Krickette Murabayashi}
% Date of translated German file: 2011/08/26
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-8.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-8.tex
index 784129a0fa8..29eb6a19a78 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-8.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-8.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-8.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-8.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ======================================================================
-\ProvidesFile{common-8.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-8.tex}%
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs: Interleaf Pages)]
\translator{Markus Kohm\and Gernot Hassenpflug\and Krickette Murabayashi}
-% Date of the translated German file: 2011/09/21
+% Date of the translated German file: 2013/11/07
\makeatletter
\@ifundefined{ifCommonmaincls}{\newif\ifCommonmaincls}{}%
@@ -78,7 +80,7 @@
books commonly start on odd pages, sometimes a left page without
contents has to be added before. This is also the reason that
interleaf pages only exist in double-sided printing. The unused back
- sides of the one-sided printings aren't interleaf pages, really,
+ sides of the one-sided printings are not interleaf pages, really,
although % . Nevertheless at the printing paper
they may seem to be such pages.}
\fi %**************************************************** Ende nur maincls *
@@ -88,7 +90,7 @@
\IfCommon{scrlttr2}{%
at letters interleaf pages are unusual. This may be benefited by the
case, that real two-sided letters are seldom, because binding of
- letters won't be done often. Nevertheless \Class{scrlttr2} supports
+ letters is not done often. Nevertheless \Class{scrlttr2} supports
interleaf pages in the case of two-sided letters. Because the
following described commands are seldom used in letters no examples
are shown. If you need examples, please note them at
@@ -126,7 +128,7 @@ compatibility to an earlier version (see option \Option{version},
means you want to use page style \Pagestyle{plain}. You may use following to
achieve this:
\begin{lstcode}
- \KOMAoption{cleardoublepage=plain}
+ \KOMAoptions{cleardoublepage=plain}
\end{lstcode}
More information about page style \Pagestyle{plain} may be found at
\autoref{sec:maincls.pagestyle}, \autopageref{desc:maincls.pagestyle.plain}.
@@ -139,7 +141,7 @@ compatibility to an earlier version (see option \Option{version},
means you want to use page style \Pagestyle{plain}. You may use following to
achieve this:
\begin{lstcode}
- \KOMAoption{cleardoublepage=plain}
+ \KOMAoptions{cleardoublepage=plain}
\end{lstcode}
More information about page style \Pagestyle{plain} may be found at
\autoref{sec:maincls.pagestyle}, \autopageref{desc:maincls.pagestyle.plain}.
@@ -288,6 +290,8 @@ the standard command \Macro{cleardoublepage}, that may be either
%%% Local Variables:
%%% mode: latex
+%%% mode: flyspell
%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
%%% TeX-master: "../guide"
%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/common-9.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/common-9.tex
index 150e563f87d..408de83c117 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/common-9.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/common-9.tex
@@ -1,6 +1,6 @@
% ======================================================================
% common-9.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% common-9.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{common-9.tex}[2012/05/15 KOMA-Script guide (common paragraphs)]
+\KOMAProvidesFile{common-9.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (common paragraphs: Footnotes)]
\translator{Markus Kohm\and Krickette Murabayashi}
% Date of the translated German file: 2012/01/01
@@ -83,7 +85,7 @@
Package \Package{scrextend} supports all the footnote features of
\KOMAScript
\ifIgnoreThis %+++++++++++++++++++++++++++++++++++++++++++++ nicht maincls +
- , that are described at \autoref{sec:maincls.footnotes}%
+ \ that are described in \autoref{sec:maincls.footnotes}%
\fi %**************************************************** Ende nur maincls *
. Nevertheless, by default the footnotes are under full control of the used
class. This changes as soon as command \Macro{deffootnote} (see
@@ -168,7 +170,7 @@ automatically. See\important{\Option{footnote}} the previously documented
option \Option{footnotes} for this.
If you want to set the separator manually, you may use
-\Macro{multiplefootnoteseparator}. Note that this command shouldn't be
+\Macro{multiplefootnoteseparator}. Note that this command should not be
redefined, because it has been defined not only to be the separator string but
also the type style, i.\,e., font size and superscript. The separator string
without type style may be found at \Macro{multfootsep}. The
@@ -200,7 +202,7 @@ and may be changed by redefining the command.
\footnote{2nd footnote}
\end{lstcode}
This should give you the wanted result even if the automatic solution would
- fail or couldn't be used.
+ fail or could not be used.
Further, assume you want the footnotes separated not only by a single
comma, but by a comma and a white space. In this case you may redefine
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/expertpart.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/expertpart.tex
index 4556bf6a940..b8ba50618ee 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/expertpart.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/expertpart.tex
@@ -1,6 +1,6 @@
% ======================================================================
% expertpart.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% expertpart.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{expertpart.tex}[2012/01/13 Part KOMA-Script for Experts]
+\KOMAProvidesFile{expertpart.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ Part KOMA-Script for Experts]
\translator{Markus Kohm}
\setpartpreamble{%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex
index 9137bd523ab..947254a3ce5 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex
@@ -1,6 +1,6 @@
% ======================================================================
% guide-english.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% guide-english.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,7 @@
%
% ======================================================================
%
-\ProvidesFile{guide-english.tex}[{2012/03/14
+\ProvidesFile{guide-english.tex}[{2013/08/05
KOMA-Script guide language dependencies}]
%
% \section{Extra Packages}
@@ -71,9 +71,9 @@
% Ugly note
\vfill
\noindent Note: This document is a translation of the German \KOMAScript{}
- manual. Several authors has been involved to this translation. Some of them
- are native English speakers, others like me are not. Improvement of the
- translation by native speakers or experts would be welcome always!%
+ manual. Several authors have been involved to this translation. Some of them
+ are native English speakers, others like me are not. Improvements of the
+ translation by native speakers or experts are welcome at all times!%
}%
\newcommand*{\GuideAuthorHeadline}{Authors of the {\KOMAScript} Bundle}%
\newcommand*{\GuideTranslatorHeadline}{English translation of this manual by:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/guide.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/guide.tex
index 6fc6a8c55dd..41ba9402133 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/guide.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/guide.tex
@@ -45,7 +45,7 @@
%
% ======================================================================
-\ProvidesFile{guide.tex}[2012/02/22 KOMA-Script guide main file]
+\ProvidesFile{guide.tex}[2013/10/14 KOMA-Script guide main file]
\documentclass[\languagename]{scrguide}
@@ -95,6 +95,7 @@
\include{scrbookreportarticle}
\include{scrlttr2}
\include{scrpage2}
+\include{scrlayer-scrpage}
\include{scrdatetime}
\include{scraddr}
\include{adrconvnote}
@@ -106,6 +107,9 @@
\include{scrwfile}
\include{tocbasic}
\include{scrhack}
+\include{scrlayer}
+\include{scrlayer-scrpage-experts}
+\include{scrlayer-notecolumn}
\include{typearea-experts}
\include{scrbookreportarticle-experts}
\include{scrlttr2-experts}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup b/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup
index fd90a64e075..8c30c6ed561 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup
@@ -1,6 +1,6 @@
# ======================================================================
# htmlsetup
-# Copyright (c) Markus Kohm, 2002-2009
+# Copyright (c) Markus Kohm, 2002-2013
#
# This file is part of the LaTeX2e KOMA-Script bundle.
#
@@ -18,7 +18,7 @@
# This work consists of all files listed in manifest.txt.
# ----------------------------------------------------------------------
# htmlsetup
-# Copyright (c) Markus Kohm, 2002-2009
+# Copyright (c) Markus Kohm, 2002-2013
#
# Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
# Version 1.3c, verteilt und/oder veraendert werden.
@@ -54,6 +54,7 @@ alt=\"Valid HTML 4.0 Strict\" height=\"31\" width=\"88\"></a>
%titles=( "option" => "Options",
"macro" => "Commands",
"environment" => "Environments",
+ "length" => "Lengths",
"plength" => "Pseudolengths",
"variable" => "Variables",
"pagestyle" => "Page Styles",
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
index fe43c56e545..28569628ad8 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
@@ -1,6 +1,6 @@
% ======================================================================
% introduction.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% introduction.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{introduction.tex}[2012/03/14 KOMA-Script guide introduction]
+\KOMAProvidesFile{introduction.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide introduction]
\translator{Kevin Pfeiffer\and Gernot Hassenpflug\and
Krickette Murabayashi\and Markus Kohm}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex
index 1ceb9bbe6cc..54a6d3f0782 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex
@@ -1,6 +1,6 @@
% ======================================================================
% japanlco.tex
-% Copyright (c) Gernot Hassenpflug and Markus Kohm, 2001-2012
+% Copyright (c) Gernot Hassenpflug and Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% japanlco.tex
-% Copyright (c) Gernot Hassenpflug und Markus Kohm, 2001-2012
+% Copyright (c) Gernot Hassenpflug und Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -49,7 +49,9 @@
% KOMA-Script bundle.
%
-\ProvidesFile{japanlco.tex}[2007/12/17 KOMA-Script guide (appendix: japanlco)]
+\KOMAProvidesFile{japanlco.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (appendix: japanlco)]
\appendix
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/preface.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/preface.tex
index 17ed62fca68..f98815f546b 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/preface.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/preface.tex
@@ -1,6 +1,6 @@
% ======================================================================
% preface.tex
-% Copyright (c) Markus Kohm, 2008-2012
+% Copyright (c) Markus Kohm, 2008-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% preface.tex
-% Copyright (c) Markus Kohm, 2008-2012
+% Copyright (c) Markus Kohm, 2008-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -35,7 +35,9 @@
% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
-\ProvidesFile{preface.tex}[2012/05/15 Preface to the KOMA-Script book]
+\KOMAProvidesFile{preface.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ Preface to the KOMA-Script book]
%\translator{Markus Kohm}
% Date of the translated German file: 0000/00/00
@@ -46,15 +48,24 @@ This is not a translation of the preface of the German \KOMAScript{} guide,
because this translation of the German \KOMAScript{} guide is still a work in
progress. Currently the chapters of \autoref{part:forAuthors} and
\autoref{cha:scrbase}, \autoref{cha:scrlfile}, \autoref{cha:scrhack},
+\autoref{cha:scrlayer}, \autoref{cha:scrlayer-scrpage-experts},
\autoref{cha:typearea-experts}, \autoref{cha:maincls-experts},
-\autoref{cha:scrlttr2-experts} are up-to-date. There may still be dead-links
-and broken references at these chapters, because the referenced information in
-chapters of other parts could be missing.
+\autoref{cha:scrlttr2-experts} are up-to-date.
-The descriptions in \autoref{cha:scrwfile}, \autoref{cha:tocbasic} aren't
-translations from the German manual but are primary descriptions from the
-implementation of these packages. They should be up-to-date\,---\,sometimes
-even more than the chapters from the German manual.
+Nevertheless, for \autoref{cha:scrlayer}, \autoref{cha:scrlayer-scrpage},
+\autoref{cha:scrlayer-scrpage-experts} a native speaker or someone with
+advanced knowledge of the English language would be needed to improve it.
+% AFAIK currently there are not any dead links or broken references, otherwise
+% I would use the following:
+% There may still be dead links and broken references in these chapters,
+% because the referenced information in chapters of other parts could be
+% missing.
+
+The descriptions in \autoref{cha:scrwfile}, \autoref{cha:tocbasic},
+\autoref{cha:scrlayer-notecolumn} are not translations from the German manual
+but are primary descriptions from the implementation of these packages. They
+should be up-to-date\,---\,sometimes even more than the chapters from the
+German manual.
So this English guide is complete but nevertheless not as good as the German
one, because my English is not as good as my German. Currently there's only
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
index beec72d274b..3c383597324 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scraddr.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scraddr.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ======================================================================
-\ProvidesFile{scraddr.tex}[2012/02/23 KOMA-Script guide (chapter: scraddr)]
+\KOMAProvidesFile{scraddr.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scraddr)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm}
% Date of translated german file: 2011/09/30
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 ce472d81292..376319b4d06 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
@@ -1,6 +1,6 @@
% ======================================================================
% scrbase.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% 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-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,21 +45,23 @@
%
% ======================================================================
-\ProvidesFile{scrbase.tex}[2012/03/04 KOMA-Script package scrbase]
-\translator{Markus Kohm}
+\KOMAProvidesFile{scrbase.tex}
+ [$Date: 2013-12-13 16:32:18 +0100 (Fr, 13 Dez 2013) $
+ KOMA-Script package scrbase]
+\translator{Markus Kohm\and Melvin Hendrix}
-% Date of the translated German file: 2012/03/04
+% Date of the translated German file: 2013/11/06
-\chapter{Basic Functions at Package \Package{scrbase}}
+\chapter{Basic Functions of Package \Package{scrbase}}
\labelbase{scrbase}
\BeginIndex{Package}{scrbase}%
-The package \Package{scrbase} provides basic features, that are designed and
-implemented to be used by authors of packages and classes. Thereby it may not
-only used for wrapper classes, that use a \KOMAScript{} class. Authors of
-classes, that aren't related to anything else from \KOMAScript{}, may also
-benefit from the functionality of \Package{scrbase}.
+The package \Package{scrbase} provides basic features designed and implemented
+for use by authors of packages and classes. However, \Package{scrbase} cannot
+only by used for wrapper classes related to \KOMAScript{} class. Authors of
+classes that have nothing to do with \KOMAScript{} can benefit from
+\Package{scrbase} functionality.
\section{Loading the Package}
\label{sec:scrbase.loadit}
@@ -68,10 +70,10 @@ Whereas users load packages using \Macro{usepackage}, authors of packages or
classes should use \Macro{RequirePackage}\IndexCmd{RequirePackage}. Authors of
wrapper packages may also use \Macro{RequirePackageWithOptions}. Command
\Macro{RequirePackage} has the same optional argument for package options like
-\Macro{usepackage}. In opposite to this \Macro{RequirePackageWithOptions}
-doesn't have an optional argument but passes all options given while loading
-the wrapper package to the required package. See \cite{latex:clsguide} for
-more information about these commands.
+\Macro{usepackage}. In contrast, \Macro{RequirePackageWithOptions} does not
+have an optional argument but passes all options given when loading the
+wrapper package to the required package. See \cite{latex:clsguide} for more
+information about these commands.
The package \Package{scrbase} needs the functionality of package
\Package{keyval}\IndexPackage{keyval} internally. This may be provided by
@@ -79,7 +81,7 @@ package \Package{xkeyval} alternatively. Package \Package{scrbase} loads
\Package{keyval} as needed.
The package \Package{keyval} provides definition of keys and assignment of
-values to this keys. The options provided by \Package{scrbase} also use
+values to these keys. The options provided by \Package{scrbase} also use
\Package{keyval} syntax: \PName{key}\texttt{=}\PName{value}.
\begin{Declaration}
@@ -87,35 +89,37 @@ values to this keys. The options provided by \Package{scrbase} also use
\end{Declaration}
\BeginIndex{Option}{internalonly~=\PName{value}}%
Package \Package{scrbase} provides some commands for conditional
-execution. The primary names of those are build like
-\Macro{scr@\PName{name}}. With this those are internal commands. \KOMAScript{}
-really uses this internal commands internally. Authors of packages and classes
-may use those internal commands too, but should not redefine them. Because
-some of those commands may be useful for users too, they are also provided as
-\Macro{\PName{name}} normally. But eventually other packages provide commands
-with the same name but different syntax or different functionality. This would
-result in an conflict. So \Package{scrbase} provides to suppress the
-definition of the user commands, \Macro{\PName{name}}, only. Using option
-\Option{internalonly} without \PName{value} will define only the internal
-commands and suppress definition of all the user commands for conditional
-execution. Alternatively, the user may give all the commands, that shouldn't
-be defined as \PName{value}, but replaces ``\Macro{}'' by ``\texttt{/}''.
+execution. The primary names for these are builds like
+\Macro{scr@\PName{name}}, which are internal commands. \KOMAScript{} only uses
+these internal commands internally. Authors of packages and classes may use
+these internal commands, too, but should not redefine them. Because some of
+these commands are useful for users, too, they are provided as
+\Macro{\PName{name}} normally. But eventually, other packages may provide
+commands with the same name but different syntax or different
+functionality. As this would result in an conflict, \Package{scrbase} can
+suppress the definition of the user commands \Macro{\PName{name}}. Using
+option \Option{internalonly} without \PName{value} will define only the
+internal commands and suppress definition of all the user commands for
+conditional execution. Alternatively, the user may give all the commands that
+should not be defined as \PName{value}, but replaces ``\Macro{}'' by
+``\texttt{/}''.
Authors of packages and classes normally should not use this option. Users may
use it with or without \PName{value} either as a global option with
\Macro{documentclass} or using \Macro{PassOptionsToPackage}.
\begin{Example}
- The user doesn't want \Package{scrbase} to define commands \Macro{ifVTeX}
- and \Macro{ifundefinedorrelax}. Because of this, user uses:
+ The user does not want \Package{scrbase} to define commands \Macro{ifVTeX}
+ and \Macro{ifundefinedorrelax}. Because of this, to load the class, the user
+ writes:
\begin{lstcode}
\documentclass%
[internalonly=/ifVTeX/ifundefinedorrelax]%
{foo}
\end{lstcode}
- to load the class. Class name \Class{foo} has been used as an placeholder
+ Class name \Class{foo} is, therefore, an placeholder
for any class in this example. The meanings of commands \Macro{ifVTeX} and
\Macro{ifundefinedorrelax} and many more commands for conditional execution
- may be found in \autoref{sec:scrbase.if}.
+ is located in \autoref{sec:scrbase.if}.
\end{Example}
%
\EndIndex{Option}{internalonly~=\PName{value}}%
@@ -127,54 +131,55 @@ use it with or without \PName{value} either as a global option with
As already mentioned in \autoref{sec:scrbase.loadit}, \Package{scrbase} uses
package \Package{keyval} for keys and values of keys. Nevertheless
\Package{scrbase} extends the functionality of \Package{keyval}. Whereas only
-one family owns all keys of \Package{keyval}, \Package{scrbase} knows also
-family members. Now, a key may be owned by a family or by one or more family
-members. Additionally a value may be assigned to the key of a family member,
-of a family or of all family members.
+one family owns all keys of \Package{keyval}, \Package{scrbase} recognises
+also family members. Therefore, a key may be owned by a family or by one or
+more family members. Additionally, a value may be assigned to the key of a
+family member, to the key of a family, or to the keys of all family members.
\begin{Declaration}
\Macro{DefineFamily}\Parameter{family}\\
- \Macro{DefineFamilyMember}\OParameter{family member}\Parameter{family}
+ \Macro{DefineFamilyMember}\OParameter{family member}\Parameter{family}%
\end{Declaration}
\BeginIndex{Cmd}{DefineFamily}%
\BeginIndex{Cmd}{DefineFamilyMember}%
\Package{scrbase} needs to know the members of a family for different
-reasons. So it's necessary first to define a new family using
-\Macro{DefineFamily}, that produces also an empty member list. If the family
-has already been defined nothing would happen. Nothing means also, that an
+reasons. First, you have to define a new family using
+\Macro{DefineFamily}, which produces an empty member list. If the family
+has already been defined nothing would happen. Nothing also means that an
already existing member list would not be overwritten.
-A new member may be added to the family using \Macro{DefineFamilyMember}. If
-the family doesn't exist, this would result in an error message. If the member
-already exists, nothing happens. If the member is omitted, the member won't
-stay empty, but ``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' will
-be assumed. While loading a class or package \Macro{@currname} and
-\Macro{@currext} together represent the file name of the class or package.
-
-Theoretically is would be possible, to define a member without a name using an
-empty optional argument \PName{family member}. But this would be same like the
-family itself. It is recommended to use only letters and digits at the
-\PName{family} an start the \PName{family member} with another char like a
-period. Otherwise it could happen, that members of one family are same like
-members of another family.
-
-\Package{scrbase} itself defines family ``\PValue{KOMA}'' and adds member
-``\PValue{.scrbase.sty}'' to is. Generally family ``\PValue{KOMA}'' is
-reserved to \KOMAScript{}. For your own packages it is recommended to use the
-name of the bundle as \PName{family} and the name of the package as
-\PName{family member} of that \PName{family}.
+Next, a new member can be added to the family using
+\Macro{DefineFamilyMember}. If the family does not exist, this would result in
+an error message. If the member already exists, nothing happens. If the
+optional \PName{family member} is omitted, the default value
+``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' is used. During
+class or package loading \Macro{@currname} and \Macro{@currext} together
+represent the file name of the class or package.
+
+Theoretically, it is possible, to define a member without a name using an
+empty optional \PName{family member} argument. But this is the same as the
+family itself. It is recommended that only letters and digits be used for
+\PName{family} and the first character of \PName{family member} should not be
+a letter or digit. Otherwise, it could happen that members of one family are
+the same as members of another family.
+
+\Package{scrbase} assigns family ``\PValue{KOMA}'' to itself and adds member
+``\PValue{.scrbase.sty}'' to it. Family ``\PValue{KOMA}'' is reserved to
+\KOMAScript{}. For your own packages, use the name of the bundle as
+\PName{family} and the name of the package as \PName{family member} of that
+\PName{family}.
%
\begin{Example}
- Assumed you're writing a bundle ``master butcher''. Within that bundle you
- have packages \File{salami.sty}, \File{liversausage.sty}, and
- \File{kielbasa.sty}. Therefor you decide to use family name
- ``\PValue{butcher}'' and add the lines
+ Assume you are writing a bundle called ``master butcher''. Within that
+ bundle you have packages \File{salami.sty}, \File{liversausage.sty}, and
+ \File{kielbasa.sty}. Therefore, you decide to use family name
+ ``\PValue{butcher}'' and,to each of the package file, you add the lines
\begin{lstcode}
\DefineFamily{butcher}
\DefineFamilyMember{butcher}
\end{lstcode}
- to each of the package files. While loading the three packages this will
- all the members ``\PValue{.salami.sty}'', ``\PValue{.liversausage.sty}'',
+ When loading the three packages, this will
+ add the members ``\PValue{.salami.sty}'', ``\PValue{.liversausage.sty}'',
and ``\PValue{.kielbasa.sty}'' to the family ``\PValue{butcher}''. After
loading all three packages, all three member will be defined.
\end{Example}
@@ -186,18 +191,29 @@ name of the bundle as \PName{family} and the name of the package as
\begin{Declaration}
\Macro{DefineFamilyKey}\OParameter{family member}\Parameter{family}%
\Parameter{key}\OParameter{default}\\
- \hphantom{\Macro{DefineFamilyKey}}\Parameter{action}
+ \hphantom{\Macro{DefineFamilyKey}}\Parameter{action}\\
+ \Macro{FamilyKeyState}\\
+ \Macro{FamilyKeyStateUnknown}\\
+ \Macro{FamilyKeyStateProcessed}\\
+ \Macro{FamilyKeyStateUnknownValue}\\
+ \Macro{FamilyKeyStateNeedValue}
\end{Declaration}
\BeginIndex{Cmd}{DefineFamilyKey}%
-This command defines a \PName{key}. If a \PName{family member} is given, the
-\PName{key} will become an attribute of that member of the also given
-\PName{family}. If no \PName{family member} is given, the member
-``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' will be assumed. If
-later a value will be assigned to the \PName{key}, the \PName{action} will be
-executed and the value will be an argument of this. So inside of
-\PName{action} ``\lstinline{#1}'' would be that value. If the value will be
-omitted, the \PName{default} will be used instead. If there's no
-\PName{default}, the \PName{key} can be used only with value.
+\BeginIndex{Cmd}{FamilyKeyState}%
+\BeginIndex{Cmd}{FamilyKeyStateUnknown}%
+\BeginIndex{Cmd}{FamilyKeyStateProcessed}%
+\BeginIndex{Cmd}{FamilyKeyStateUnknownValue}%
+\BeginIndex{Cmd}{FamilyKeyStateNeedValue}%
+The command \Macro{DefineFamilyKey} defines a \PName{key}. If a \PName{family
+ member} is given, the \PName{key} becomes an attribute of that member in the
+given \PName{family}. If a \PName{family member} is not given, the member
+``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' is assumed. If,
+later, a value is assigned to the \PName{key}, the \PName{action} will be
+executed and the value made an argument of \PName{action}. So inside
+\PName{action} ``\lstinline{#1}'' would be that value. If 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.
+
\begin{Explain}
\phantomsection\label{explain:scrbase.macro.DefineFamilyKey}%
At least
@@ -208,33 +224,73 @@ omitted, the \PName{default} will be used instead. If there's no
will result in a call of
\begin{lstcode}[moretexcs={define@key},escapeinside=`']
\define@key{`\PName{family\,member}'}{`\PName{key}'}
- [`\PName{default}']{`\PName{action}'}
+ [`\PName{default}']{`\PName{extended action}'}
\end{lstcode}
- with \Macro{define@key} is provided by package
- \Package{keyval}\IndexPackage{keyval} (see \cite{package:keyval}).
+ with \Macro{define@key} provided by package
+ \Package{keyval}\IndexPackage{keyval} (see \cite{package:keyval}). However,
+ the call of \Macro{define@key} and the \PName{action} is, in fact,
+ extended by additional arrangements.
\end{Explain}
+
+Success\ChangedAt{v3.12}{\Package{scrbase}} or failure of the execution of the
+\PName{action} should be reported back to \Package{scrbase} by
+\Macro{FamilyKeyState}. The package itself will take care of additional
+procedures if needed. You should not report errors by yourself! The default
+state before execution of \PName{action} is
+\Macro{FamilyKeyStateUnknown}. This signals that it is not known whether or
+not the execution is successful. If this state does not change until end of
+execution of the \PName{action}, \Package{scrbase} will write a message into
+the \File{log} file and assumes state \Macro{FamilyKeyStateProcessed} during
+the further procedure.
+
+State \Macro{FamilyKeyStateProcessed} signals that the option and the value
+assignment to the option are completely and successfully finished. You may
+switch to this state by using \Macro{FamilyKeyStateProcessed} itself.
+
+State \Macro{FamilyKeyStateUnknownValue} indicates that the option was
+handled, but the value, that should be assigned to the key, was unknown or not
+allowed. You should use \Macro{FamilyKeyStateUnknownValue} to switch to
+this state.
+
+State \Macro{FamilyKeyStateNeedValue} signals that the option could not be
+set because it needs a value, but no value was assigned to the
+key. This state is used automatically, whenever an option has been
+defined without \PName{default} value and is used without value
+assignment. You should not set the state using \Macro{FamilyKeyStateNeedValue}
+yourself.
+
+Last but not least you may switch to additional failure states, simply
+re-defining \Macro{FamilyKeyState} with a very short text message.
+Generally, the four predefined states should be sufficient.
+
\begin{Example}
- Assumed, each of the three packages from the previous example should get a
- key \PValue{coldcuts}. If this is used, a switch should be set at each of
- the packages. For package \Package{salami} this may be, e.\,g.,
+ Assume each of the three packages from the previous example should get a
+ key named \PValue{coldcuts}. When used, a switch is set at each of
+ the packages. For package \Package{salami} this may be:
\begin{lstcode}
\newif\if@Salami@Aufschnitt
\DefineFamilyKey{butcher}%
{coldcut}[true]{%
\expandafter\let\expandafter\if@salami@coldcut
\csname if#1\endcsname
+ \FamilyKeyStateProcessed
}
\end{lstcode}
Available values for the key are \PValue{true} or \PValue{false} in this
- case. There's no test on inappropriate values in this example. If the key
- will be used later, this has to be done with one of the allowed values or
- without assignment. In the second case the default \PName{true} will be
- used.
+ case. Instead of testing on inappropriate values, success will be signalled
+ for any case in this example. If the key is used later, it is executed with
+ one of the allowed values or without assignment. In the second case, the
+ default \PName{true} will be used.
The definitions in the other packages are similar. Only ``\texttt{salami}''
has to be replaced by the corresponding names.
\end{Example}
%
+\EndIndex{Cmd}{FamilyKeyStateNeedValue}%
+\EndIndex{Cmd}{FamilyKeyStateUnknownValue}%
+\EndIndex{Cmd}{FamilyKeyStateProcessed}%
+\EndIndex{Cmd}{FamilyKeyStateUnknown}%
+\EndIndex{Cmd}{FamilyKeyState}%
\EndIndex{Cmd}{DefineFamilyKey}%
@@ -243,38 +299,37 @@ omitted, the \PName{default} will be used instead. If there's no
\end{Declaration}
\BeginIndex{Cmd}{FamilyProcessOptions}%
Generally the extension of keys of families to keys of families and family
-members was mentioned to use keys or key-value settings as class or package
-options. This command therefor is an extension of \Macro{ProcessOption*} from
-\LaTeX{} kernel (see \cite{latex:clsguide}. Thereby the command processes not
-only options that has been declared using \Macro{DeclareOption}. It processes
-even all keys of the given family member. If the optional argument
+members, as mentioned earlier, uses keys or key-value settings as class or
+package options. The command \Macro{FamilyProcessOptions} is an extension of
+\Macro{ProcessOption*} from \LaTeX{} kernel (see \cite{latex:clsguide}, which
+processes not only options that has been declared using \Macro{DeclareOption},
+it processes all keys of the given family member. If the optional argument
\PName{family member} is omitted, family member
-``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' will be used.
+``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' is used.
-Somehow special are keys, that are not attached to a family member, but to a
-family. These are keys with an empty family member. Such keys will be set also
-and before the keys of the family members.
+Somehow special are keys that are not attached to a family member, but to a
+family. These are keys with an empty family member. Such keys are set before
+the keys of the family members.
\begin{Example}
If a package in the previous example would be extended by the line
\begin{lstcode}
\FamilyProcessOptions{butcher}
\end{lstcode}
- then the user may select the option \Option{coldcut} while loading the
- package. If the option will be used globally, this means at the optional
+ then the user may select the option \Option{coldcut} when loading the
+ package. If the option is used globally, this means at the optional
argument of \Macro{documentclass}, then the option would be passed
- automatically to all three packages, if all three packages will be loaded
+ automatically to all three packages, if all three packages are loaded
later.
\end{Example}
-Please note\textnote{Attention!} that packages process global options always
-before local options, that has been assigned locally to the package. In
-opposite to unknown options while processing of global options, that will only
-result in an information in the \File{log}-file, unknown options assigned to
-the package result in error messages.
+Please note\textnote{Attention!} that packages always process global options
+before local options. When processing unknown options initiate an entry in the
+\File{log}-file and the option is otherwise ignored. By contrast, unknown
+options assigned to the package locally leads to an error message.
\Macro{FamilyProcessOptions} may be interpreted either as an extension of
\Macro{ProcessOption*} or as an extension of the \PName{key=value} mechanism
-of \Package{keyval}. Finally \PName{key=value} pairs become options with help
-of \Macro{FamilyProcessOptions}.%
+of \Package{keyval}. Ultimately, with the help of
+\Macro{FamilyProcessOptions}, \PName{key=value} pairs become options.%
%
\EndIndex{Cmd}{FamilyProcessOptions}%
@@ -285,17 +340,17 @@ of \Macro{FamilyProcessOptions}.%
\end{Declaration}
\BeginIndex{Cmd}{FamilyExecuteOptions}%
This command is an extension of \Macro{ExecuteOptions} from the \LaTeX{}
-kernel (see \cite{latex:clsguide}). Thereby the command processes not only
-options, that has been defined using \Macro{DeclareOption}. Also all keys of
-the given family member will be processed. If the optional argument
-\Macro{family member} is omitted, then
+kernel (see \cite{latex:clsguide}). The command processes not only options
+that are defined using \Macro{DeclareOption}, but also processes all keys of
+the given \PName{family member}. If the optional argument \Macro{family
+ member} is omitted, then
``\texttt{.}\Macro{@currname}\texttt{.}\Macro{@currext}'' is used.
-Somehow special are keys, that are not attached to a family member, but to a
-family. These are keys with an empty family member. Such keys will be set also
-and before the keys of the family members.
+Somehow special are keys of empty family members, which are not attached to a
+family member, but to a family. Such keys are set before the keys of family
+members.
\begin{Example}
- Assumed, option \Option{coldcut} should be set by default already in the
+ Assume option \Option{coldcut} should be set by default in the
previous example. In this case only line
\begin{lstcode}
\FamilyExecuteOptions{butcher}{coldcut}
@@ -307,31 +362,27 @@ and before the keys of the family members.
\begin{Declaration}
- \Macro{FamilyOptions}\Parameter{family}\Parameter{options list}\\
- \Macro{Family@Options}\Parameter{family}\Parameter{options list}%
- \Parameter{error action}
+ \Macro{FamilyOptions}\Parameter{family}\Parameter{options list}%
\end{Declaration}
\BeginIndex{Cmd}{FamilyOptions}%
-\BeginIndex{Cmd}{Family@Options}%
-Thereby \PName{options list} is like:
+Hence \PName{options list} is like:
\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
\PName{key}\texttt{=}\PName{value}\texttt{,}%
\PName{key}\texttt{=}\PName{value}\dots
\end{tabular}\vskip\dp\strutbox\end{flushleft}
-whereby the value assignment may be omitted for \PName{key}s, that have a
+after which the value assignment may be omitted for \PName{key}s that have a
defined default.
-In opposite to average options, that has been defined using
-\Macro{DeclareOption}, the \PName{key}s may also be set after loading a class
-or package. For this the user uses \Macro{FamilyOptions}. Thereby the
-\PName{key}s of all members of the given family will be set. If a \PName{key}
-also exists as an family attribute, then the family key will be set
-first. After this the member keys will follow in the order, the members has
-been defined. If a given \PName{key} does exist neither in the family nor in
-any member of the family, then \Macro{FamilyOptions} will result in an
-error. In opposite to this with \Macro{Family@Options} the user may declare
-his own \PName{error action}. But this internal command is reserved for
-authors of classes and packages.
+In contrast to average options that are defined using \Macro{DeclareOption},
+the \PName{key}s also may be set after loading a class or package. For this,
+the user calls \Macro{FamilyOptions}. Thereafter, the \PName{key}s of all
+members of the specified family are set. If a \PName{key} also exists as a
+family attribute, then the family key is set first. After this, the member
+keys follow in the order in which the members have been defined. If a given
+\PName{key} does not exist, either for the family or for any member of the
+family, then \Macro{FamilyOptions} will result in an error. Package
+\Package{scrbase} reports an error also if there are members with key
+\PName{key}, but all those members signal failure via \Macro{FamilyKeyState}.
\begin{Example}
You extend your butcher project by a package \Package{sausagesalad}. If this
package has been loaded, all sausage package should generate cold cut:
@@ -343,15 +394,15 @@ authors of classes and packages.
\FamilyProcessOptions{butcher}\relax
\FamilyOptions{butcher}{coldcut}
\end{lstcode}
- If currently non of the sausage packages has been loaded, then an error
- message would result because of undefined option ``\Option{coldcut}''. Dies
- may be avoided changing the last line of the previous code into:
+ If currently none of the sausage packages are loaded, then an error
+ message results because of undefined option ``\Option{coldcut}''. This is
+ avoided by changing the last line of the code to:
\begin{lstcode}[moretexcs={Family@Options}]
\Family@Options{butcher}{coldcut}{}
\end{lstcode}
- Nevertheless, sausage packages, that will be loaded after
- \Package{sausagesalad}, won't produce cold cut. This may be changed
- additionally, by changing the last line again:
+ Despite this, sausage packages loaded after
+ \Package{sausagesalad} still do not produce cold cut. This may be corrected
+ by editing the last line of the code again to:
\begin{lstcode}[moretexcs={Family@Options}]
\AtBeginDocument{%
\Family@Options{butcher}{coldcut}{%
@@ -361,40 +412,34 @@ authors of classes and packages.
}%
}%
\end{lstcode}
- This will also throw a warning message, if non of the sausage packages will
- be loaded.
+ This may throw a warning message if none of the sausage packages are loaded.
\end{Example}
%
-\EndIndex{Cmd}{Family@Options}%
\EndIndex{Cmd}{FamilyOptions}%
\begin{Declaration}
\Macro{FamilyOption}\Parameter{family}%
- \Parameter{option}\Parameter{values list}\\
- \Macro{Family@Option}\Parameter{family}%
- \Parameter{option}\Parameter{values list}%
- \Parameter{error action}
+ \Parameter{option}\Parameter{values list}%
\end{Declaration}
\BeginIndex{Cmd}{FamilyOption}%
-\BeginIndex{Cmd}{Family@Option}%
-Beside options that have concurrently excluding values, there may be options,
-that have several values at the same time. Using \Macro{FamilyOptions} for
-that kind of options would result in using the same option several times with
+Besides options that have concurrently excluding values, there may be options
+that produce several values at the same time. Using \Macro{FamilyOptions} for
+that type of option would result in using the same option several times with
different value assignments. Instead of this, \Macro{FamilyOption} may be used
to assign a whole \PName{values list} to the same \PName{option}. The
-\PName{values list} is a comma separated list of values:
+\PName{values list} is a comma separated list of values, also known as
+\emph{csv}:
\begin{flushleft}\begin{tabular}{l}
\PName{value}\texttt{,}\PName{value}\dots
\end{tabular}\end{flushleft}
-By the way please note, that usage of a comma inside a value may be done only,
-if the value is put into braces. The general functionality of these commands
-is the same like that of the previous commands \Macro{FamilyOptions} and
-\Macro{Family@Options}.
+By the way, please note that usage of a comma inside a value may be done only
+if the value is put inside braces. The general functionality of this command
+is the same as that of the previous command \Macro{FamilyOptions}.
\begin{Example}
Package \Package{sausagesalad} should have one mire option, to add
- additional ingredients. Each of the ingredients will set a switch like done
- before for the cold cut.
+ additional ingredients. Each of the ingredients sets a switch as was done
+ previously for the cold cut.
\begin{lstcode}
\newif\if@saladwith@onions
\newif\if@saladwith@gherkins
@@ -403,8 +448,9 @@ is the same like that of the previous commands \Macro{FamilyOptions} and
\csname @saladwith@#1true\endcsname
}
\end{lstcode}
- Here the three ingredients ``onions'', ``gherkins'', and ``chillies'' has
- been defined. An error message for not defined ingredients doesn't exist.
+ Here the three ingredients ``onions'', ``gherkins'', and ``chillies'' have
+ been defined. An error message for ``not defined'' ingredients does not
+ exist.
For a salad with onions and gherkins the user may use
\begin{lstcode}
@@ -418,11 +464,26 @@ is the same like that of the previous commands \Macro{FamilyOptions} and
\end{lstcode}
\end{Example}
%
-\EndIndex{Cmd}{Family@Option}%
\EndIndex{Cmd}{FamilyOption}%
\begin{Declaration}
+ \Macro{AtEndOfFamilyOptions}\Parameter{action}%
+\end{Declaration}
+\BeginIndex{Cmd}{AtEndOfFamilyOptions}%
+Sometimes\ChangedAt{v3.12}{\Package{scrbase}} it is useful to delay the
+execution of an \PName{action} that is part of a value assignment to a key
+until all assignments inside one \Macro{FamilyProcessOptions},
+\Macro{FamilyExecuteOptions}, \Macro{FamilyOptions}, or \Macro{FamilyOption}
+is finished. This may be done using \Macro{AtEndOfFamilyOptions} inside
+an option definition. Reporting failure states of \PName{action} is not
+possible in this case. Furthermore, the command should not be used outside an
+option definition.
+%
+\EndIndex{Cmd}{AtEndOfFamilyOptions}%
+
+
+\begin{Declaration}
\Macro{FamilyBoolKey}\OParameter{family member}\Parameter{family}%
\Parameter{key}\Parameter{switch name}\\
\Macro{FamilySetBool}\Parameter{family}%
@@ -430,31 +491,33 @@ is the same like that of the previous commands \Macro{FamilyOptions} and
\end{Declaration}
\BeginIndex{Cmd}{FamilyBoolKey}%
\BeginIndex{Cmd}{FamilySetBool}%
-In the previous examples boolean switches often have been used. In the example
-with option \Option{coldcut} is was necessary, that the user assigns either
-value \PValue{true} or value \PValue{false}. No error message existed on wrong
-value assignment. Because of such boolean switches are an often needed
-feature, \Package{scrbase} provides \Macro{FamilyBoolKey} for definition of
-such options. Thereby the arguments \PName{family member}, \PName{family},
-and \PName{key} are same like used by \Macro{DefineFamilyKey} (see
+In the previous examples, boolean switches often have been used. In the example
+with option \Option{coldcut}, it is necessary that the user assigns either
+value \PValue{true} or value \PValue{false}. There is no error message for
+wrong value assignment. Because of this, boolean switches are a necessary
+feature. Package \Package{scrbase} provides \Macro{FamilyBoolKey} for definition of
+such options. Therefore, the arguments \PName{family member}, \PName{family}, and
+\PName{key} are the same as that used by \Macro{DefineFamilyKey} (see
\autopageref{desc:scrbase.cmd.DefineFamilyKey}). Argument \PName{switch name}
is the name of the switch without the prefix \Macro{if}. If a switch with this
-name doesn't exist already, \Macro{FamilyBoolKey} will define it and
+name does not exist already, \Macro{FamilyBoolKey} will define it and
initialize it to \PName{false}. Internally \Macro{FamilyBooKey} uses
\Macro{FamilySetBool} as \PName{action} of \Macro{DefineFamilyKey}. The
\PName{default} for those options is always \PValue{true}.
-\Macro{FamilySetBool} on the other side understands \PName{value} \PValue{on}
+On the other hand, \Macro{FamilySetBool} understands \PName{value} \PValue{on}
and \PValue{yes} beside \PName{true} for switching on and \PName{off} and
\PName{no} beside \PName{false} for switching off. Unknown values will result
in a call of \Macro{FamilyUnknownKeyValue} with the arguments \PName{family},
-\PName{key}, and \PName{value}. This will normally result in an error message
-about unknown value assignment (see also
-\autopageref{desc:scrbase.cmd.FamilyUnkownKeyValue}).
+\PName{key}, and \PName{value}, which results in setting of
+\Macro{FamilyKeyState}. Depending on the command used and other family
+members, this may result in an error message about unknown value assignment
+(see also \autopageref{desc:scrbase.cmd.FamilyUnkownKeyValue} and
+\autopageref{desc:scrbase.cmd.FamilyKeyState}).
\begin{Example}
- The key \Option{coldcut} should be declared somehow more robust. Additionally
- all sausage packages should use the same key. So either all or none of them
- will produce cold cut.
+ The key \Option{coldcut} should be declared somehow more
+ robust. Additionally, all sausage packages should use the same key. So
+ either all or none of them will produce cold cut.
\begin{lstcode}
\FamilyBoolKey{butcher}{coldcut}%
{@coldcut}
@@ -467,13 +530,13 @@ about unknown value assignment (see also
...
\fi
\end{lstcode}
- This would be the same in each of the three sausage packages. With this the
- attribute ``coldcut'' may be defined as a family option:
+ This would be the same in each of the three sausage packages, thereby
+ defining the attribute ``coldcut'' as a family option:
\begin{lstcode}[moretexcs={define@key}]
\@ifundefined{if@coldcut}{%
\expandafter\newif\csname if@coldcut\endcsname
}{}%
- \define@key{butcher}{coldcut}[true]{%
+ \DefineFamilyKey[]{butcher}{coldcut}[true]{%
\FamilySetBool{butcher}{coldcut}%
{@coldcut}%
{#1}%
@@ -485,7 +548,7 @@ about unknown value assignment (see also
{@coldcut}
\end{lstcode}
using the additional information at
- \autopageref{explain:scrbase.macro.DefineFamilyKey}, that's not only valid
+ \autopageref{explain:scrbase.macro.DefineFamilyKey}, this is not only valid
for \Macro{DefineFamilyKey} but for \Macro{FamilyBoolKey} too.
\end{Example}
%
@@ -506,10 +569,10 @@ about unknown value assignment (see also
\end{Declaration}
\BeginIndex{Cmd}{FamilyNumericalKey}%
\BeginIndex{Cmd}{FamilySetNumerical}%
-In opposite to switches that may be either true or false, also key exists,
+In contrast to switches that may be either true or false, a key exists
that accept several values. For example an alignment may not only be left or
-not left, but, e.\,g., left, centered, or right. Internally such
-differentiations are often made using \Macro{ifcase}. This \TeX{} command
+not left, but left, centered, or right. Internally such
+differentiation often is made using \Macro{ifcase}. This \TeX{} command
expects a numerical value. Because of this the command to define a macro by
a \PName{key} has been named \Macro{FamilyNumericalKey} in
\Package{scrbase}. The \PName{values list} thereby has the form:
@@ -518,16 +581,16 @@ a \PName{key} has been named \Macro{FamilyNumericalKey} in
\Parameter{value}\Parameter{definition}\texttt{,}%
\dots
\end{tabular}\vskip\dp\strutbox\end{flushleft}
-So the \PName{values list} does not only define the supported values to the
-\PName{key}. For each of the \PName{value}s it also gives the
-\PName{definition} of macro \Macro{\PName{command}}. Usually
-\PName{definition} is just a numerical value. Nevertheless other content is
-possible and allowed. Currently the only limitation is, that
-\PName{definition} has to be fully expandable and will be expanded while the
+Therefore, the \PName{values list} does not solely define the supported values to the
+\PName{key}. For each of the \PName{value}s, the
+\PName{definition} of macro \Macro{\PName{command}} also is given. Usually,
+\PName{definition} is just a numerical value. Nevertheless, other content is
+possible and allowed. Currently, the only limitation is that
+\PName{definition} has to be fully expandable and will be expanded during the
assignment.
\begin{Example}
The sausage may be cut different. For example the cold cut may stay uncut or
- will by cut roughly or may be cut thinly. This information should be stored
+ will be cut roughly or may be cut thinly. This information should be stored
in command \Macro{cuthow}.
\begin{lstcode}
\FamilyNumericalKey{butcher}%
@@ -551,10 +614,10 @@ assignment.
\end{lstcode}
In all three cases \Macro{cuthow} would be defined with content
\PValue{none}. It may be very useful to provide several values for the same
- result like shown in this example.
+ result as shown in this example.
Now, it's most likely, that the kind of cutting will not be printed, but
- should be evaluated later. In this case a textual definition wouldn't be
+ should be evaluated later. In this case a textual definition would not be
useful. If the key is defined like this:
\begin{lstcode}
\FamilyNumericalKey{butcher}%
@@ -564,7 +627,7 @@ assignment.
{thin}{2}%
}
\end{lstcode}
- then a condition like this:
+ then a condition like the following may be used:
\begin{lstcode}
\ifcase\cuthow
% no cut
@@ -574,9 +637,8 @@ assignment.
% thin cut
\fi
\end{lstcode}
- may be used.
\end{Example}
-Internally \Macro{FamilyNumericalKey} uses \Macro{FamilySetNumerical} as
+Internally, \Macro{FamilyNumericalKey} uses \Macro{FamilySetNumerical} as
\PName{action} of \Macro{DefineFamilyKey}. If a unknown value is assigned to
such a key, \Macro{FamilySetNumerical} will call \Macro{FamilyUnkownKeyValue}
with the arguments \PName{family}, \PName{key} and \PName{value}. This will
@@ -593,18 +655,19 @@ normally result in an error message about assigning an unknown value.
\OParameter{default}\Parameter{command}
\end{Declaration}
\BeginIndex{Cmd}{FamilyStringKey}%
-This defines\ChangedAt{v3.08}{\Package{scrbase}} a \PName{key}, that accepts
-every value. The value will be stored into the given \Macro{command}. If their
+This defines\ChangedAt{v3.08}{\Package{scrbase}} a \PName{key} that accepts
+every value. The value will be stored into the given \Macro{command}. If there
is no optional argument for the \PName{default}, \Macro{FamilyStringKey} is
-the same like
+the same as:
\begin{quote}
\Macro{DefineFamilyKey}\OParameter{family member}\Parameter{family}%
\Parameter{key}\\
\hphantom{\Macro{DefineFamilyKey}}%
-\PParameter{\Macro{def}\PName{command}\string{\#1\string}}.
+\PParameter{\Macro{def}\PName{command}\string{\#1\string}%
+\Macro{FamilyKeyStateProcessed}}.
\end{quote}
-If an optional argument \PName{default} has been used, \Macro{FamilyStringKey}
-is the same like
+If an optional argument \PName{default} is used, \Macro{FamilyStringKey}
+is the same as:
\begin{quote}
\Macro{DefineFamilyKey}\OParameter{family member}\Parameter{family}%
\Parameter{key}\\
@@ -612,13 +675,12 @@ is the same like
\OParameter{default}%
\PParameter{\Macro{def}\PName{command}\string{\#1\string}}.
\end{quote}
-If \PName{command} hasn't been defined already, an empty macro will be
-defined.
+If \PName{command} is not been defined, an empty macro will be defined.
\begin{Example}
By default an amount of 250\Unit{g} sausage salad should be produced. The
amount should be configurable by an option. The wanted amount will be stored
in the macro \Macro{saladweight}. The option should be named
- \PValue{saladweight} too:
+ \PValue{saladweight}, too:
\begin{lstcode}
\newcommand*{\saladweight}{250g}
\FamilyStringKey{butcher}%
@@ -629,11 +691,11 @@ defined.
\begin{lstcode}
\FamilyOptions{butcher}{saladweight}
\end{lstcode}
- That may be done, because the default weight has been set as default at the
+ This may be done, because the default weight has been set as default at the
definition of the option above.
\end{Example}
-In this case there are no unknown values, because all values are simply used
-for a macro definition. Nevertheless, you should note, that paragraph breaks
+In this case there are not unknown values because all values are simply used
+for a macro definition. Nevertheless, you should note that paragraph breaks
at the value assignment to the key are not allowed.
%
\EndIndex{Cmd}{FamilyStringKey}%
@@ -641,8 +703,7 @@ at the value assignment to the key are not allowed.
\begin{Declaration}
\Macro{FamilyUnkownKeyValue}\Parameter{family}\Parameter{key}%
- \Parameter{value}\Parameter{values list}\\
- \Macro{FamilyElseValues}
+ \Parameter{value}\Parameter{values list}%
\end{Declaration}
\BeginIndex{Cmd}{FamilyUnkownKeyValue}%
\BeginIndex{Cmd}{FamilyElseValues}%
@@ -652,17 +713,10 @@ separated list of allowed values in the form:
\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
`\PName{value}'\texttt{,} `\PName{value}' \dots
\end{tabular}\vskip\dp\strutbox\end{flushleft}
-Additional allowed values may be set by \Macro{FamilyElseValues} in
-the form:
-\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
- \texttt{,} `\PName{value}'\texttt{,} `\PName{value}' \dots
-\end{tabular}\vskip\dp\strutbox\end{flushleft}
-These will also be shown in the error message. \Macro{FamilySetBool} as well
-as \Macro{FamilySetNumerical} will reset \Macro{FamilyElseValue} to an empty
-definition automatically\,---\,independent of whether or not a error has been
-thrown.
+Currently\ChangedAt{v3.12}{\Package{scrbase}}, \PName{values list} is
+not used by \Package{scrbase}.
\begin{Example}
- Now, for the cold cut the choices should be cut or no cut and in case of cut
+ Now, for the cold cut, the choices should be cut or no-cut and in case of cut
rough or thin. Rough should be the default for cutting.
\begin{lstcode}
\@ifundefined{if@thincut}{%
@@ -673,31 +727,62 @@ thrown.
\newif\csname if@coldcut\endcsname}{}
\DefineFamilyKey{butcher}%
{coldcut}[true]{%
- \ifstr{#1}{thin}{%
- \@coldcuttrue
- \@thincuttrue
- }{%
+ \FamilySetBool{butcher}{coldcut}%
+ {@coldcut}%
+ {#1}%
+ \ifx\FamilyKeyState\FamilyKeyStateProcessed
\@thincutfalse
- \def\FamilyElseValue{, `thin'}%
- \FamilySetBool{butcher}{coldcut}%
- {@coldcut}%
- {#1}%
- }%
+ \else
+ \ifstr{#1}{thin}{%
+ \@coldcuttrue
+ \@thincuttrue
+ \FamilyKeyStateProcessed
+ }{}%
+ \fi
}%
\end{lstcode}
- Command \Macro{ifstr} used at the example code above will be described at
- \autopageref{desc:scrbase.cmd.ifstr} in \autoref{sec:scrbase.if}.
+ Let's have a look at the definition of \Option{butcher}:
+ First of all, we try to set the boolean switch of cold cut using
+ \Macro{FamilySetBool}. After this command, we test whether or not
+ \Macro{FamilyKeyState} signals the success of the command with state
+ \Macro{FamilyKeyStateProcessed}. If so, only the thin cut has to be
+ deactivated.
+
+ In the other case, the value will be tested to be equal to \PValue{thin}. In
+ that case, cold cut and thin cut are activated and the state will be
+ switched to \Macro{FamilyKeyStateProcessed}. If the last test failed also,
+ the failure state of \Macro{FamilySetBool} is still valid at the end of the
+ execution.
+
+ Command \Macro{ifstr} is used for the thin test. It is
+ described on \autopageref{desc:scrbase.cmd.ifstr} in
+ \autoref{sec:scrbase.if}.
\end{Example}
%
-\EndIndex{Cmd}{FamilyElseValues}%
\EndIndex{Cmd}{FamilyUnkownKeyValue}%
+\begin{Declaration}
+ \Macro{FamilyElseValues}
+\end{Declaration}
+\BeginIndex{Cmd}{FamilyElseValues}%
+With former releases\ChangedAt{v3.12}{\Package{scrbase}} of \Package{scrbase},
+additional allowed values reported by \Macro{FamilyUnknownKeyValue} can be
+set re-defining \Macro{FamilyElseValues} in the form:
+\begin{flushleft}\vskip\dp\strutbox\begin{tabular}{l}
+ \texttt{,} `\PName{value}'\texttt{,} `\PName{value}' \dots
+\end{tabular}\vskip\dp\strutbox\end{flushleft}
+Since release~3.12 \Macro{FamilyUnknownValue} does not report errors itself,
+but signals them using \Macro{FamilyKeyState}. Therefore,
+\Macro{FamilyElseValues} became deprecated. Nevertheless, its former usage is
+recognised by \Package{scrbase} and results in a code change demand message.%
+\EndIndex{Cmd}{FamilyElseValues}%
+
\section{Conditional Execution}
\label{sec:scrbase.if}
The package \Package{scrbase} provides several commands for conditional
-execution. Thereby not the \TeX{} syntax of conditionals, e.\,g.,
+execution. other than the \TeX{} syntax of conditionals, e.\,g.,
% Umbruchkorrektur
\begin{lstcode}[belowskip=\dp\strutbox]
\iftrue
@@ -706,21 +791,21 @@ execution. Thereby not the \TeX{} syntax of conditionals, e.\,g.,
...
\fi
\end{lstcode}
-but the \LaTeX{} syntax also known from \LaTeX{} commands like
+yet the \LaTeX{} syntax also known from \LaTeX{} commands like
\Macro{IfFileExists}, \Macro{@ifundefined}, \Macro{@ifpackageloaded}, and many
-others will be used. Nevertheless, some package authors prefer to use the
-\TeX{} syntax even for users at the \LaTeX{} interface level. In fact the
-conditionals of \Package{scrbase} are very basic conditionals, this could
-result in conditionals with the same name but different syntax and though in
-naming conflicts. Because of this \Package{scrbase} firstly defines these
-conditionals as internal commands with prefix \Macro{scr@}. Additional user
-commands without this prefix are additionally defined. But the definition of
-the user commands may be suppressed with option \Option{internalonly} (see
+others, is used. Nevertheless, some package authors prefer to use the \TeX{}
+syntax even for users at the \LaTeX{} interface level that could inevitably
+lead to naming conflicts with the \Package{scrbase} conditionals. In fact, the
+conditionals of \Package{scrbase} are very basic. Because of this
+\Package{scrbase} firstly defines these conditionals as internal commands with
+prefix \Macro{scr@}. Additional user commands without this prefix are
+subsequently defined. But the definition of the user commands may be
+suppressed with option \Option{internalonly} (see
\autoref{sec:scrbase.loadit}, \autopageref{desc:scrbase.option.internalonly}).
-Authors of packages and classes should use the internal commands like
+Authors of packages and classes should use the internal commands as
\KOMAScript{} itself does. Nevertheless, for completeness the user commands
-are described additionally.
+are described separately.
\begin{Declaration}
@@ -733,12 +818,12 @@ are described additionally.
\BeginIndex{Cmd}{ifundefinedorrelax}%
This command has almost the same functionality as \Macro{@ifundefined} from
the \LaTeX{} kernel (see \cite{latex:source2e}). So the \PName{then
- instructions} will be executed, if \PName{name} is the name of a command,
-that is currently either not defined or \Macro{relax}. Otherwise the
-\PName{else instructions} will be executed. In opposite to
-\Macro{@ifundefined} \Macro{\PName{name}} won't be defined to be \Macro{relax}
-in the case it wasn't defined before. Using \eTeX{} this case won't at least
-consume any hash memory.%
+ instructions} will be executed if \PName{name} is the name of a command
+that is currently either not defined or \Macro{relax}. Otherwise, the
+\PName{else instructions} will be executed. In contrast to
+\Macro{@ifundefined}, \Macro{\PName{name}} is not defined to be \Macro{relax}
+in the event it was not defined before. Moreover, using \eTeX{} this case will
+not consume any hash memory.%
%
\EndIndex{Cmd}{ifundefinedorrelax}%
\EndIndex{Cmd}{scr@ifundefinedorrelax}%
@@ -753,11 +838,10 @@ consume any hash memory.%
\BeginIndex{Cmd}{scr@ifpdftex}%
\BeginIndex{Cmd}{ifpdftex}%
If pdf\TeX{} has been used, the \PName{then instructions} will be executed,
-otherwise the \PName{else instructions}. Whether or not a PDF-file will be
-out, doesn't matter. Nevertheless, this pdf\TeX{} test seems so make sense
-seldom only. Generally it's recommended to test for the wanted commands
-instead (see previous \Macro{scr@ifundefinedorrelax} and
-\Macro{ifundefinedorrelax}).
+otherwise the \PName{else instructions}. Whether or not a PDF-file is
+generated does not matter, and the pdf\TeX{} test is rarely useful. In
+general, test for the desired command instead (see previous
+\Macro{scr@ifundefinedorrelax} and \Macro{ifundefinedorrelax}).
%
\EndIndex{Cmd}{ifpdftex}%
\EndIndex{Cmd}{scr@ifpdftex}%
@@ -772,9 +856,9 @@ instead (see previous \Macro{scr@ifundefinedorrelax} and
\BeginIndex{Cmd}{scr@ifVTeX}%
\BeginIndex{Cmd}{ifVTeX}%
If V\TeX{} has been used, the \PName{then instructions} will be executed,
-otherwise the \PName{else instructions}. This test seems so make sense
-seldom only. Generally it's recommended to test for the wanted commands instead
-(see previous \Macro{scr@ifundefinedorrelax} and \Macro{ifundefinedorrelax}).
+otherwise the \PName{else instructions}. This test is seldom useful. Test for
+the desired command instead (see previous \Macro{scr@ifundefinedorrelax} and
+\Macro{ifundefinedorrelax}).
%
\EndIndex{Cmd}{ifVTeX}%
\EndIndex{Cmd}{scr@ifVTeX}%
@@ -788,9 +872,9 @@ seldom only. Generally it's recommended to test for the wanted commands instead
\end{Declaration}
\BeginIndex{Cmd}{scr@ifpdfoutput}%
\BeginIndex{Cmd}{ifpdfoutput}%
-While PDF-file generation the \PName{then instructions} will be executed,
-otherwise the \PName{else instructions}. Whether, e.\,g., pdf\TeX{} or V\TeX{}
-is used to generate the PDF-file doesn't matter.
+When generating a PDF-file the \PName{then instructions} will be executed,
+otherwise the \PName{else instructions}. Whether pdf\TeX{} or V\TeX{} or
+another \TeX{} engine is used to generate the PDF-file does not matter.
%
\EndIndex{Cmd}{ifpdfoutput}%
\EndIndex{Cmd}{scr@ifpdfoutput}%
@@ -804,12 +888,11 @@ is used to generate the PDF-file doesn't matter.
\end{Declaration}
\BeginIndex{Cmd}{scr@ifpsoutput}%
\BeginIndex{Cmd}{ifpsoutput}%
-While PostScript-file generation the \PName{then instructions} will be executed,
-otherwise the \PName{else instructions}. V\TeX{} provides direct PostScript
-generation, that will be recognized here. If V\TeX{} is not used but a switch
-\Macro{if@dvips} has been defined, the decision depends on that
-switch. \KOMAScript{}, e.\,g., provides \Macro{if@dvips} in
-\Package{typearea}.
+When generating a PostScript-file the \PName{then instructions} will be
+executed, otherwise the \PName{else instructions}. V\TeX{} provides direct
+PostScript generation that will be recognised here. If V\TeX{} is not used,
+but a switch \Macro{if@dvips} has been defined, the decision depends on that
+switch. \KOMAScript{} provides \Macro{if@dvips} in \Package{typearea}.
%
\EndIndex{Cmd}{ifpsoutput}%
\EndIndex{Cmd}{scr@ifpsoutput}%
@@ -823,7 +906,7 @@ switch. \KOMAScript{}, e.\,g., provides \Macro{if@dvips} in
\end{Declaration}
\BeginIndex{Cmd}{scr@ifdvioutput}%
\BeginIndex{Cmd}{ifdvioutput}%
-While DVI-file generation the \PName{then instructions} will be executed,
+When generating a DVI-file the \PName{then instructions} will be executed,
otherwise the \PName{else instructions}. If neither a direct PDF-file
generation nor a direct PostScript-file generation has been detected, DVI-file
generation is assumed.
@@ -839,8 +922,8 @@ generation is assumed.
\BeginIndex{Cmd}{ifnotundefined}%
\eTeX{} will be used to test, whether or not a command with the given
\PName{name} has already been defined. The \PName{then instructions} will be
-executed, if the command is defined, the \PName{else instructions}
-otherwise. There's no corresponding internal command for this.
+executed if the command is defined, otherwise the \PName{else
+ instructions}. There is no corresponding internal command.
%
\EndIndex{Cmd}{ifnotundefined}%
@@ -850,23 +933,159 @@ otherwise. There's no corresponding internal command for this.
\Parameter{then instructions}\Parameter{else instructions}
\end{Declaration}
\BeginIndex{Cmd}{ifstr}%
-Both \PName{string} arguments will be expanded and afterward compared. If the
-expansions are same, the \PName{then instructions} will be
-executed, otherwise the \PName{else instructions}. There's no corresponding
-internal command for this.
+Both \PName{string} arguments are expanded and afterwards compared. If the
+expansions are the same, the \PName{then instructions} will be executed,
+otherwise the \PName{else instructions}. There is no corresponding internal
+command.
%
\EndIndex{Cmd}{ifstr}%
+\begin{Declaration}
+ \Macro{ifstrstart}\Parameter{string}\Parameter{string}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifstrstart}%
+Both\ChangedAt{v3.12}{\Package{scrbase}} \PName{string} arguments are
+expanded and afterwards compared. If aside from white spaces the first string
+starts with the second one, 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}{ifstrstart}%
+
+\begin{Declaration}
+ \Macro{ifisdimen}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisdimen}%
+If\ChangedAt{v3.12}{\Package{scrbase}} the expansion of\PName{code} results in
+a \Macro{dimen}, which is also known as \TeX{} length register, 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}{ifisdimen}%
+
+\begin{Declaration}
+ \Macro{ifisdimension}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisdimension}%
+If\ChangedAt{v3.12}{\Package{scrbase}} \PName{code} expands to something with
+the syntax of the value of a length, the \PName{then instructions} will be
+executed, otherwise the \PName{else instructions}. Please
+note\textnote{Attention!} that currently an invalid unit will result in an
+error message. The command is not completely expandable and there is no
+corresponding internal command.%
+\EndIndex{Cmd}{ifisdimension}%
+
+\begin{Declaration}
+ \Macro{ifisdimexpr}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisdimexpr}%
+If\ChangedAt{v3.12}{\Package{scrbase}} the expansion of\PName{code} results in
+a \Macro{dimexpr}, which is also known as \TeX{} length expression, the
+\PName{then instructions} will be executed, otherwise the \PName{else
+ instructions}. Note\textnote{Attention!} that illegal expressions will
+result in error messages. The command is not completely expandable and there
+is no corresponding internal command.%
+\EndIndex{Cmd}{ifisdimexpr}%
+
+\begin{Declaration}
+ \Macro{ifisskip}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisskip}%
+If\ChangedAt{v3.12}{\Package{scrbase}} the expansion of\PName{code} results in
+a \Macro{skip}, which is also known as \TeX{} distance register, 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}{ifisskip}%
+
+\begin{Declaration}
+ \Macro{ifisglue}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisglue}%
+If\ChangedAt{v3.12}{\Package{scrbase}} \PName{code} expands to something with
+the syntax of the value of a skip, the \PName{then instructions} will be
+executed, otherwise the \PName{else instructions}. Please
+note\textnote{Attention!} that currently an invalid unit will result in an
+error message. The command is not completely expandable and there is no
+corresponding internal command.%
+\EndIndex{Cmd}{ifisglue}%
+
+\begin{Declaration}
+ \Macro{ifisglueexpr}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisglueexpr}%
+If\ChangedAt{v3.12}{\Package{scrbase}} the expansion of\PName{code} results in
+a \Macro{glueexpr}, which is also known as \TeX{} distance expression, the
+\PName{then instructions} will be executed, otherwise the \PName{else
+ instructions}. Note,\textnote{Attention!} that illegal expressions will
+result in error messages. The command is not completely expandable and there
+is no corresponding internal command.%
+\EndIndex{Cmd}{ifisglueexpr}%
+
+\begin{Declaration}
+ \Macro{ifiscount}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifiscount}%
+If\ChangedAt{v3.12}{\Package{scrbase}} the expansion of\PName{code} results in
+a \Macro{count}, which is also known as \TeX{} counter register, 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. For test with \LaTeX{} counters, see
+\Macro{ifiscounter}.%
+\EndIndex{Cmd}{ifiscount}%
+
+\begin{Declaration}
+ \Macro{ifisnumber}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisnumber}%
+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}%
+
+\begin{Declaration}
+ \Macro{ifisnumexpr}\Parameter{code}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifisnumexpr}%
+If\ChangedAt{v3.12}{\Package{scrbase}} the expansion of\PName{code} results in
+a \Macro{numexpr}, which is also known as \TeX{} number expression, the
+\PName{then instructions} will be executed, otherwise the \PName{else
+ instructions}. Note\textnote{Attention!} that illegal expressions will
+result in error messages. The command is not completely expandable and there
+is no corresponding internal command.%
+\EndIndex{Cmd}{ifisnumexpr}%
+
+\begin{Declaration}
+ \Macro{ifiscounter}\Parameter{counter}%
+ \Parameter{then instructions}\Parameter{else instructions}
+\end{Declaration}
+\BeginIndex{Cmd}{ifiscounter}%
+If\ChangedAt{v3.12}{\Package{scrbase}} \PName{counter} is an already defined
+\LaTeX{} counter, 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}{ifiscounter}%
\begin{Declaration}
\Macro{ifnumber}\Parameter{string}%
\Parameter{then instructions}\Parameter{else instructions}
\end{Declaration}
\BeginIndex{Cmd}{ifnumber}%
-Note, that this does not compare numbers. The \PName{then instructions} will
-be executed, if the expansion of \PName{string} consists of digits
-only. Otherwise the \PName{else instructions} will be used. There's no
-corresponding internal command for this.
+Note that this does not compare numbers. The \PName{then instructions} will
+be executed if the expansion of \PName{string} consists of digits
+only. Otherwise the \PName{else instructions} will be used. There is no
+corresponding internal command.
%
\EndIndex{Cmd}{ifnumber}%
@@ -876,10 +1095,10 @@ corresponding internal command for this.
\Parameter{then instructions}\Parameter{else instructions}
\end{Declaration}
\BeginIndex{Cmd}{ifdimen}%
-Note, that this does not compare dimensions. The \PName{then instructions} will
+Note that this does not compare dimensions. The \PName{then instructions} will
be executed, if the expansion of \PName{string} consists of digits and a valid
-unit of length. Otherwise the \PName{else instructions} will be used. There's no
-corresponding internal command for this.
+unit of length. Otherwise, the \PName{else instructions} will be used. There
+is no corresponding internal command.
%
\EndIndex{Cmd}{ifdimen}%
@@ -890,11 +1109,11 @@ corresponding internal command for this.
\end{Declaration}
\BeginIndex{Cmd}{if@atdocument}%
This command exists intentionally as internal command only. In the document
-preamble \Macro{if@atdocument} is same like \Macro{iffalse}. After
-\Macro{begin}\PParameter{document} it's same like \Macro{iftrue}. Authors of
-classes and packages may use this, if a command should work somehow different
-depending in whether it has been used in the preamble or inside the documents
-body. Please note\textnote{Attention!}, that this is a condition in \TeX{}
+preamble \Macro{if@atdocument} is same as \Macro{iffalse}. After
+\Macro{begin}\PParameter{document} it's the same as \Macro{iftrue}. Authors of
+classes and packages may use this if a command should work somehow different
+depending on whether it has been used in the preamble or inside the documents
+body. Please note\textnote{Attention!} that this is a condition in \TeX{}
syntax not in \LaTeX{} syntax!
%
\EndIndex{Cmd}{if@atdocument}%
@@ -906,77 +1125,106 @@ syntax not in \LaTeX{} syntax!
\index{language>dependent terms|see{language definition}}
\index{terms>language-dependent|see{language definition}}
-Normally one has to change or define language-dependent terms like
-\Macro{captionsenglish} in such a way that in addition to the available terms
+Normally, one has to change or define language-dependent terms like
+\Macro{captionsenglish} in such a way that, in addition to the available terms,
the new or redefined terms are defined. This is made more difficult by the
fact that some packages like \Package{german}\IndexPackage{german} or
\Package{ngerman}\IndexPackage{ngerman} redefine those settings when the
-packages are loaded. This definitions unfortunately occurs in such a manner as
+packages are loaded. These definitions unfortunately occur in such a manner as
to destroy all previous private settings. That is also the reason why it makes
-sense to delay own changes with \Macro{AtBeginDocument} until
-\Macro{begin}\PParameter{document}, that is, after package loading is
-completed. The user can also use \Macro{AtBeginDocument}, or redefine the
-language-dependent terms after \Macro{begin}\PParameter{document}, that is,
+sense to delay changes with \Macro{AtBeginDocument} until
+\Macro{begin}\PParameter{document}; that is, after package loading is
+completed. The user can also use \Macro{AtBeginDocument} or redefine the
+language-dependent terms after \Macro{begin}\PParameter{document}; that is,
not put them in the preamble at all. The package \Package{scrbase}
provides some additional commands for defining language-dependent terms.
\begin{Declaration}
+ \Macro{defcaptionname}%
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
\Macro{providecaptionname}%
- \Parameter{language}\Parameter{term}\Parameter{definition}\\
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
\Macro{newcaptionname}%
- \Parameter{language}\Parameter{term}\Parameter{definition}\\
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
\Macro{renewcaptionname}%
- \Parameter{language}\Parameter{term}\Parameter{definition}
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
+ \Macro{defcaptionname*}%
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
+ \Macro{providecaptionname*}%
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
+ \Macro{newcaptionname*}%
+ \Parameter{language list}\Parameter{term}\Parameter{definition}\\
+ \Macro{renewcaptionname*}%
+ \Parameter{language list}\Parameter{term}\Parameter{definition}
\end{Declaration}
+\BeginIndex{Cmd}{defcaptionname}%
\BeginIndex{Cmd}{providecaptionname}%
\BeginIndex{Cmd}{newcaptionname}%
\BeginIndex{Cmd}{renewcaptionname}%
Using one of these commands, the user can assign a \PName{definition} for a
-particular \PName{language} to a \PName{term}. The \PName{term} is always a
-macro. The commands differ dependent on whether a given \PName{language} or a
-\PName{term} within a given \PName{language} are already defined or not at the
+particular language to a \PName{term}. Several languages can be concatenated
+with comma to a \PName{language list}. The \PName{term} is always a
+macro. The commands differ depending on whether a given language or a
+\PName{term} within a given language are already defined or not at the
time the command is called.
-If \PName{language} is not defined, then \Macro{providecaptionname} does
-nothing other than writes a message in the log file. This happens only once
-for each language. If \PName{language} is defined but \PName{term} is not yet
+If a language is not defined, then \Macro{providecaptionname} does
+nothing other than write a message in the log file. This happens only once
+for each language. If a language is defined, but \PName{term} is not yet
defined for it, then it will be defined using \PName{definition}. The
-\PName{term} will not be redefined if the \PName{language} already has such a
+\PName{term} will not be redefined if the language already has such a
definition; instead, an appropriate message is written to the log file.
-The command \Macro{newcaptionname} has a slightly different behaviour. If the
-\PName{language} is not yet defined, then a new language command will be
-created and a message written to the log file. For \PName{language}
-\PValue{USenglish}, e.\,g.\, this would be the language command
-\Macro{captionsUSenglish}. If \PName{term} is not yet defined in
-\PName{language}, then it will be defined using \PName{definition}. If
-\PName{term} already exists in \PName{language}, then this results in an error
+The command \Macro{newcaptionname} has a slightly different behaviour. If a
+language is not yet defined, then a new language command will be
+created and a message written to the log file. For language
+\PValue{USenglish}, for example, this would be the language command
+\Macro{captionsUSenglish}. If \PName{term} is not yet defined in a
+language, then it will be defined using \PName{definition}. If
+\PName{term} already exists in a language, then this results in an error
message.
The command \Macro{renewcaptionname} again behaves differently. It requires an
-existing definition of \PName{term} in \PName{language}. If neither
-\PName{language} nor \PName{term} exist or \PName{term} is unknown in a
-defined language then a error message will be given. Otherwise, the
-\PName{term} for \PName{language} will be redefined according to
+existing definition of \PName{term} in the languages. If neither
+a language nor \PName{term} exist or \PName{term} is unknown in a
+defined language, then an error message is given. Otherwise, the
+\PName{term} for the language will be redefined according to
\PName{definition}.
-\KOMAScript{} itself employs \Macro{providecaptionname} in order to define the
+\KOMAScript{} employs \Macro{providecaptionname} in order to define the
commands in \autoref{sec:scrlttr2-experts.languages}.
\begin{Example}
- If you prefer ``fig.'' instead of ``figure'', you may achieve this using:
+ If you prefer ``fig.'' instead of ``figure'' in \PValue{USenglish}, you may
+ achieve this using:
\begin{lstcode}
\renewcaptionname{USenglish}{\figurename}{fig.}
\end{lstcode}
+ If you want the same change not only in \PValue{USenglish} but also in
+ \PValue{UKenglish}, you do not need an additional:
+\begin{lstcode}
+ \renewcaptionname{UKenglish}{\figurename}{fig.}
+\end{lstcode}
+ but can simply extend the \PName{language list}:
+\begin{lstcode}
+ \renewcaptionname{USenglish,UKenglish}{\figurename}{fig.}
+\end{lstcode}
+ You can extend the \PName{language list} in the same manner by
+ \PValue{american}, \PValue{australian}, \PValue{british}, \PValue{canadian},
+ and \PValue{newzealand}.
\end{Example}
-Since\textnote{Attention!} only existing terms in available languages can be
-redefined using \Macro{renewcaptionname}, you have to put the command after
-\Macro{begin}\PParameter{document} or delay the command by using
-\Macro{AtBeginDocument}. Furthermore, you will get an error message if there
-is no package used that switches language selection to, e.\,g.,
-\PName{USenglish} in the example above.
+Since \KOMAScript~3.12\ChangedAt{v3.12}{\Package{scrbase}} you do not need to
+delay the definition or redefinition until \Macro{begin}\PParameter{document}
+using \Macro{AtBeginDocument} any longer because \Package{scrbase} does the
+delay automatically for (re)definitions in the document's
+preamble. Additionally, \Package{scrbase} tests if a redefinition should be
+made in \Macro{extras\PName{language}} instead of
+\Macro{captions\PName{language}} and does so automatically. The new star
+variants of the commands always use \Macro{extras\PName{language}}. So
+redefinition of language dependent terms for packages like \Package{hyperref}
+that use \Macro{extras\PName{language}} should work as expected by the user.
Language dependent terms usually defined by classes and language
packages are listed and described in \autoref{tab:scrbase.commonNames}.
@@ -1081,6 +1329,7 @@ packages are listed and described in \autoref{tab:scrbase.commonNames}.
\EndIndex{Cmd}{providecaptionname}%
\EndIndex{Cmd}{newcaptionname}%
\EndIndex{Cmd}{renewcaptionname}%
+\EndIndex{Cmd}{defcaptionname}%
%
\EndIndex{}{language>definition}
@@ -1088,18 +1337,18 @@ packages are listed and described in \autoref{tab:scrbase.commonNames}.
\section{Identification of \KOMAScript}
\label{sec:scrbase.identify}
-\Package{scrbase} may be used independent of \KOMAScript{} with
-other packages and classes, nevertheless it's a \KOMAScript{} package. For
-this is also provides commands to identify \KOMAScript{} and itself as a
-\KOMAScript{} package.
+Package \Package{scrbase} may be used independent of \KOMAScript{} with
+other packages and classes. Nevertheless, it is a \KOMAScript{} package. For
+this, \Package{scrbase} also provides commands to identify \KOMAScript{} and
+to identify itself as a \KOMAScript{} package.
\begin{Declaration}
\Macro{KOMAScript}
\end{Declaration}
\BeginIndex{Cmd}{KOMAScript}%
This command only sets the word ``\KOMAScript'' with sans-serif font and
-a little bit tracking of the capitals. Bay the way: All \KOMAScript{} classes
-and packages define this command, if it hasn't been defined already. The
+a little bit tracking for the capitals. By the way: All \KOMAScript{} classes
+and packages define this command, if it has not been defined already. The
definition is robust using \Macro{DeclareRobustCommand}.
%
\EndIndex{Cmd}{KOMAScript}
@@ -1111,9 +1360,9 @@ definition is robust using \Macro{DeclareRobustCommand}.
\BeginIndex{Cmd}{KOMAScriptVersion}%
\KOMAScript{} defines the main version of \KOMAScript{} in this command. It
has the form ``\PName{date} \PName{version} \texttt{KOMA-Script}''. This main
-version is same for all \KOMAScript{} classes and the \KOMAScript{} packages,
+version is same for all \KOMAScript{} classes and the \KOMAScript{} packages
that are essential for the classes. Because of this, it may be inquired after
-loading \Package{scrbase} too. This document has been made, e.\,g., using
+loading \Package{scrbase}, too. For example, this document has been made using
\KOMAScript{} version ``\KOMAScriptVersion''.
%
\EndIndex{Cmd}{KOMAScriptVersion}%
@@ -1122,8 +1371,8 @@ loading \Package{scrbase} too. This document has been made, e.\,g., using
\section{Extension of the \LaTeX{} Kernel}
\label{sec:scrbase:latexkernel}
-Sometimes the \LaTeX{} kernel itself provides commands, but lacks of other,
-similar commands, that would often be useful too. Some of those commands for
+Sometimes the \LaTeX{} kernel itself provides commands, but lacks other,
+similar commands that would often be useful, too. Some of those commands for
authors of packages and classes are provided by \Package{scrbase}.
\begin{Declaration}
@@ -1133,14 +1382,14 @@ authors of packages and classes are provided by \Package{scrbase}.
\BeginIndex{Cmd}{PackageInfoNoLine}%
\BeginIndex{Cmd}{ClassInfoNoLine}%
For authors of classes and package the \LaTeX{} kernel already provides
-commands like \Macro{ClassInfo} and \Macro{PackageInfo} to write information
-together with the current line number into the log-file. Beside
+commands like \Macro{ClassInfo} and \Macro{PackageInfo} to write information.
+together with the current line number, into the log-file. Besides
\Macro{PackageWarning} and \Macro{ClassWarning} to throw warning messages with
line numbers, it also provides \Macro{PackageWarningNoLine} and
\Macro{ClassWarningNoLine} for warning messages without line
numbers. Nevertheless, the commands \Macro{ClassInfoNoLine} and
-\Macro{PackageInfoNoLine}, to write information without line numbers into the
-log-file, are missing. Package \Package{scrbase} provides them.
+\Macro{PackageInfoNoLine} for writing information without line numbers into the
+log-file are missing. Package \Package{scrbase} provides them.
%
\EndIndex{Cmd}{ClassInfoNoLine}%
\EndIndex{Cmd}{PackageInfoNoLine}
@@ -1156,8 +1405,8 @@ globally. This may be used only for macros that have no
arguments. Nevertheless, sometimes a command like this, that works locally to
a group instead of globally, could be useful. Package \Package{scrbase}
provides such a command with \Macro{l@addto@macro}. An alternative may be
-usage of package \Package{etoolbox}\IndexPackage{etoolbox}, that provides
-several of such commands for different purpose (see \cite{package:etoolbox}).
+usage of package \Package{etoolbox}\IndexPackage{etoolbox}, which provides
+several of such commands for different purposes (see \cite{package:etoolbox}).
%
\EndIndex{Cmd}{l@addto@macro}
@@ -1166,7 +1415,7 @@ several of such commands for different purpose (see \cite{package:etoolbox}).
\label{sec:scrbase:etex}
\eTeX{}, that is meanwhile used by \LaTeX{} and needed by \KOMAScript{},
-provides with \Macro{numexpr}\IndexCmd{numexpr} an extended feature for
+provided with \Macro{numexpr}\IndexCmd{numexpr}, an extended feature for
calculation of simple arithmetic with \TeX{} counters and
integers. The four basic arithmetic operations and brackets are
supported. Correct rounding is done while division. Sometimes additional
@@ -1178,9 +1427,10 @@ operators would be useful.
\end{Declaration}%
\BeginIndex{Cmd}{XdivY}%
\BeginIndex{Cmd}{XmodY}%
-Having a division with remainder, command\ChangedAt{v3.05a}{\Package{scrbase}}
-\Macro{XdivY} gives the value of the integer quotient, command \Macro{XmodY}
-the value of the remainder. This kind of division is defined:
+Having a division with remainder command\ChangedAt{v3.05a}{\Package{scrbase}}
+\Macro{XdivY} gives the value of the integer quotient, with command
+\Macro{XmodY} giving the value of the remainder. This kind of division is
+defined:
\[
\textit{dividend} = \textit{divisor} \cdot
\textit{integer quotient} + \textit{remainder}
@@ -1190,7 +1440,7 @@ is greater or equal to \textit{divisor}, and \textit{divisor} is a natural
number greater than 0.
The value may be used for assignment to a counter or directly in the
-expression of \Macro{numexpr}. For output the value as an Arabic number is has
+expression of \Macro{numexpr}. For output the value as an Arabic number has
to be prefixed by \Macro{the}.%
%
\EndIndex{Cmd}{XmodY}%
@@ -1203,7 +1453,7 @@ to be prefixed by \Macro{the}.%
%%% Local Variables:
%%% mode: latex
%%% mode: flyspell
-%%% ispell-local-dictionary: "english"
+%%% ispell-local-dictionary: "en_GB"
%%% coding: us-ascii
%%% TeX-master: "../guide.tex"
%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle-experts.tex
index b718bccf6f8..9fc393d423e 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle-experts.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle-experts.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrbookreportarticle-experts.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrbookreportarticle-experts.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -47,8 +47,10 @@
%
% ============================================================================
-\ProvidesFile{scrbookreportarticle-experts.tex}[2012/02/28 KOMA-Script guide
-(chapter: scrbook, scrreprt, scrartcl for experts)]
+\KOMAProvidesFile{scrbookreportarticle-experts.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl for
+ experts)]
\translator{Gernot Hassenpflug\and Markus Kohm}
@@ -64,14 +66,14 @@ This chapter gives additional information about the \KOMAScript{} classes
\Class{scrbook}, \Class{scrreprt}, and \Class{scrartcl}. Some of the features
are also available for package \Package{scrextend}. \iffree{Some parts of the
chapter are subject to the \KOMAScript{} book \cite{book:komascript}
- only. This shouldn't be a problem, because the}{The} average user, who only
-want to use the package, won't need the information, that is addressed to
+ only. This should not be a problem, because the}{The} average user, who only
+want to use the package, will not need the information, that is addressed to
users with non-standard requirements or who want to write their own classes
using a \KOMAScript{} class. Another part of the information describes features
of the classes that exist only because of compatibility to former
releases of \KOMAScript{} or the standard classes. The features, that exist
only because of compatibility to former \KOMAScript{} releases, are printed
-with a sans serif font. You shouldn't use them any longer.
+with a sans serif font. You should not use them any longer.
\LoadNonFree{scrbookreportarticle-experts}{0}
@@ -108,7 +110,7 @@ difference to this, \Macro{ClassName} tells which would be the standard class,
that has been replaced by a \KOMAScript{} class.
Please note\textnote{Attention!}, that the existence of
-\Macro{KOMAScript}\IndexCmd{KOMAScript} isn't a indication for the usage of a
+\Macro{KOMAScript}\IndexCmd{KOMAScript} is not a indication for the usage of a
\KOMAScript{} class. First of all: Every \KOMAScript{} package and not only
\KOMAScript{} classes define \Macro{KOMAScript}. Furthermore other packages
may also define the \KOMAScript{} word mark with this name.%
@@ -122,7 +124,7 @@ may also define the \KOMAScript{} word mark with this name.%
\end{Declaration}
\BeginIndex{Cmd}{addtocentrydefault}%
The\ChangedAt{v3.08}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} \KOMAScript{} classes don't use
+ \Class{scrartcl}} \KOMAScript{} classes do not use
\Macro{addcontentsline}\IndexCmd{addcontentsline}%
\important{\Macro{addcontentsline}} directly. Instead they
call \Macro{addtocentrydefault} with similar arguments. The command may be used
@@ -168,7 +170,7 @@ manipulate the entries. For example\textnote{Example} one could suggest
}%
}%
\end{lstcode}
-to omit entries with empty \PName{heading}. In real live this wouldn't be
+to omit entries with empty \PName{heading}. In real live this would not be
needed, because the \KOMAScript{} classes already use another method to
suppress empty entries. See the description of the structuring commands in
\autoref{sec:maincls.structure} from \autopageref{desc:maincls.cmd.part}
@@ -218,7 +220,7 @@ The prefix \File{scrsize} for file names of font size files, that has been
mentioned\iffree{ in \autoref{sec:maincls-experts.addInfos}}{} at
\autopageref{desc:maincls-experts.option.fontsize} is only the default of the
internal macro \Macro{@fontsizefilebase}\IndexCmd{@fontsizefilebase}. This
-default is used only, if the macro hasn't already be defined when loading a
+default is used only, if the macro has not already be defined when loading a
\KOMAScript{} class or package \Package{scrextend}. Authors of wrapper classes
may define this macro with another file name prefix to use completely
different font size files. Also\textnote{Hint!} authors of wrapper classes
@@ -569,7 +571,7 @@ the\,---\,list environment, that will be used for the bibliography. It should
be assumed, that many packages will execute this command in the same kind, if
they redefine the bibliography.
-The \KOMAScript{} classes do something similar. Nevertheless, they don't
+The \KOMAScript{} classes do something similar. Nevertheless, they do not
redefine \Macro{@openbib@code} at the end of the class. Instead of, the
bibliography style \PValue{openstyle} is defined using
\Macro{newbibstyle}. The \PName{instructions}, that has been defined as part
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
index 08633a351a6..2d9a75f5718 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrbookreportarticle.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrbookreportarticle.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,11 +45,13 @@
%
% ============================================================================
-\ProvidesFile{scrbookreportarticle.tex}[2012/05/15 KOMA-Script guide (chapter:
-scrbook, scrreprt, scrartcl)]
+\KOMAProvidesFile{scrbookreportarticle.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)]
+
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm\and Krickette Murabayashi}
-% Date of translated german file: 2012-02-15
+% Date of translated german file: 2013-05-31
\chapter{The Main Classes: \Class{scrbook}, \Class{scrreprt}, and
\Class{scrartcl}}
@@ -188,160 +190,8 @@ class.%
\LoadCommon{5}% \section{Text Markup}
-The command \Macro{usekomafont} can change the current font specification to
-the one currently used with the specified \PName{element}.
-
-\begin{Example}
- \phantomsection\label{desc:maincls.setkomafont.example}%
- Assume that you want to use for the element \FontElement{captionlabel} the
- same font specification that is used with
- \FontElement{descriptionlabel}. This can be easily done with:
-\begin{lstcode}
- \setkomafont{captionlabel}{%
- \usekomafont{descriptionlabel}%
- }
-\end{lstcode}
- You can find other examples in the paragraphs on each element.
-\end{Example}
-
-\begin{desclist}
- \desccaption{%
- Elements whose type style can be changed with the {\KOMAScript} command
- \Macro{setkomafont} or
- \Macro{addtokomafont}\label{tab:maincls.elementsWithoutText}%
- }{%
- Elements whose type style can be changed (\emph{continuation})%
- }%
- \feentry{caption}{text of a table or figure caption (see
- \autoref{sec:maincls.floats}, \autopageref{desc:maincls.cmd.caption})}%
- \feentry{captionlabel}{label of a table or figure caption; used according to
- the element \FontElement{caption} (see \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.cmd.caption})}%
- \feentry{chapter}{title of the sectional unit \Macro{chapter} (see
- \autoref{sec:maincls.structure}, \autopageref{desc:maincls.cmd.chapter})}%
- \feentry{chapterentry}{%
- table of contents entry of the sectional unit \Macro{chapter} (see
- \autoref{sec:maincls.toc},
- \autopageref{desc:maincls.cmd.tableofcontents})}%
- \feentry{chapterentrypagenumber}{%
- page number of the table of contents entry of the sectional unit
- \Macro{chapter}, variation on the element \FontElement{chapterentry} (see
- \autoref{sec:maincls.toc},
- \autopageref{desc:maincls.cmd.tableofcontents})}%
- \feentry{chapterprefix}{%
- chapter number line at setting \OptionValue{chapterprefix}{true} or
- \OptionValue{appendixprefix}{true} (see \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.option.chapterprefix})}%
- \feentry{descriptionlabel}{labels, i.\,e., the optional argument of
- \Macro{item} in the \Environment{description} environment (see
- \autoref{sec:maincls.lists}, \autopageref{desc:maincls.env.description})}%
- \feentry{dictum}{dictum, wise saying, or smart slogan (see
- \autoref{sec:maincls.dictum}, \autopageref{desc:maincls.cmd.dictum})}%
- \feentry{dictumauthor}{author of a dictum, wise saying, or smart slogan;
- used according to the element \FontElement{dictumtext} (see
- \autoref{sec:maincls.dictum}, \autopageref{desc:maincls.cmd.dictum})}%
- \feentry{dictumtext}{another name for \FontElement{dictum}}%
- \feentry{disposition}{all sectional unit titles, i.\,e., the arguments of
- \Macro{part} down to \Macro{subparagraph} and \Macro{minisec}, including
- the title of the abstract; used before the element of the corresponding
- unit (see \autoref{sec:maincls.structure} ab
- \autopageref{sec:maincls.structure})}%
- \feentry{footnote}{footnote text and marker (see
- \autoref{sec:maincls.footnotes},
- \autopageref{desc:maincls.cmd.footnote})}%
- \feentry{footnotelabel}{mark of a footnote; used according to the element
- \FontElement{footnote} (see \autoref{sec:maincls.footnotes},
- \autopageref{desc:maincls.cmd.footnote})}%
- \feentry{footnotereference}{footnote reference in the text (see
- \autoref{sec:maincls.footnotes},
- \autopageref{desc:maincls.cmd.footnote})}%
- \feentry{footnoterule}{%
- horizontal rule\ChangedAt{v3.07}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} above the footnotes at the end of the text area (see
- \autoref{sec:maincls.footnotes},
- \autopageref{desc:maincls.cmd.setfootnoterule})}%
- \feentry{labelinglabel}{labels, i.\,e., the optional argument of
- \Macro{item} in the \Environment{labeling} environment (see
- \autoref{sec:maincls.lists}, \autopageref{desc:maincls.env.labeling})}%
- \feentry{labelingseparator}{separator, i.\,e., the optional argument of the
- \Environment{labeling} environment; used according to the element
- \FontElement{labelinglabel} (see \autoref{sec:maincls.lists},
- \autopageref{desc:maincls.env.labeling})}%
- \feentry{minisec}{title of \Macro{minisec} (see
- \autoref{sec:maincls.structure} ab
- \autopageref{desc:maincls.cmd.minisec})}%
- \feentry{pagefoot}{only used if package \Package{scrpage2} has been loaded
- (see \autoref{cha:scrpage},
- \autopageref{desc:scrpage.fontelement.pagefoot})}%
- \feentry{pagehead}{another name for \FontElement{pageheadfoot}}%
- \feentry{pageheadfoot}{the head of a page, but also the foot of a page (see
- \autoref{sec:maincls.pagestyle} ab \autopageref{sec:maincls.pagestyle})}%
- \feentry{pagenumber}{page number in the header or footer (see
- \autoref{sec:maincls.pagestyle})}%
- \feentry{pagination}{another name for \FontElement{pagenumber}}%
- \feentry{paragraph}{title of the sectional unit \Macro{paragraph} (see
- \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.cmd.paragraph})}%
- \feentry{part}{title of the \Macro{part} sectional unit, without the line
- containing the part number (see \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.cmd.part})}%
- \feentry{partentry}{%
- table of contents entry of the sectional unit \Macro{part} (see
- \autoref{sec:maincls.toc},
- \autopageref{desc:maincls.cmd.tableofcontents})}%
- \feentry{partentrypagenumber}{%
- Page number of the table of contents entry of the sectional unit
- \Macro{part} variation on the element \FontElement{partentry} (see
- \autoref{sec:maincls.toc},
- \autopageref{desc:maincls.cmd.tableofcontents})}%
- \feentry{partnumber}{line containing the part number in a title of the
- sectional unit \Macro{part} (see \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.cmd.part})}%
- \feentry{section}{title of the sectional unit \Macro{section} (see
- \autoref{sec:maincls.structure}, \autopageref{desc:maincls.cmd.section})}%
- \feentry{sectionentry}{%
- table of contents entry of sectional unit \Macro{section} (only available
- in \Class{scrartcl}, see \autoref{sec:maincls.toc},
- \autopageref{desc:maincls.cmd.tableofcontents})}%
- \feentry{sectionentrypagenumber}{%
- page number of the table of contents entry of the sectional unit
- \Macro{section}, variation on element \FontElement{sectionentry} (only
- available in \Class{scrartcl, see \autoref{sec:maincls.toc},
- \autopageref{desc:maincls.cmd.tableofcontents}})}%
- \feentry{sectioning}{another name for \FontElement{disposition}}%
- \feentry{subject}{%
- categorization of the document, i.\,e., the argument of \Macro{subject} on
- the main title page (see \autoref{sec:maincls.titlepage},
- \autopageref{desc:maincls.cmd.subject})}%
- \feentry{subparagraph}{title of the sectional unit \Macro{subparagraph} (see
- \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.cmd.subparagraph})}%
- \feentry{subsection}{title of the sectional unit \Macro{subsection} (see
- \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.cmd.subsection})}%
- \feentry{subsubsection}{title of the sectional unit \Macro{subsubsection}
- (see \autoref{sec:maincls.structure},
- \autopageref{desc:maincls.cmd.subsubsection})}%
- \feentry{subtitle}{%
- subtitle of the document, i.\,e., the argument of \Macro{subtitle} on the
- main title page (see \autoref{sec:maincls.titlepage},
- \autopageref{desc:maincls.cmd.title})}%
- \feentry{title}{main title of the document, i.\,e., the argument of
- \Macro{title} (for details about the title size see the additional note in
- the text of \autoref{sec:maincls.titlepage} from
- \autopageref{desc:maincls.cmd.title})}%
-\end{desclist}
-%
-\EndIndex{Cmd}{setkomafont}%
-\EndIndex{Cmd}{addtokomafont}%
-\EndIndex{Cmd}{usekomafont}%
-%
-\EndIndex{}{font}%
-\EndIndex{}{text>markup}%
-
\LoadCommon{14} %\section{Document Titles}
-
\section{Abstract}
\label{sec:maincls.abstract}
\BeginIndex{}{summary}%
@@ -408,8 +258,8 @@ When using an in-page title\Index{title>in-page} (see option \Option{titlepage},
the abstract is set using the environment
\Environment{quotation}\IndexEnv{quotation} (see \autoref{sec:maincls.lists},
\autopageref{desc:maincls.env.quotation}) internally. Thereby paragraphs will
-be set with intention of the first line. If that first paragraph of the
-abstract should not be intended, this indent may be disabled using
+be set with indentation of the first line. If that first paragraph of the
+abstract should not be indented, this indent may be disabled using
\Macro{noindent}\IndexCmd{noindent}\important{\Macro{noindent}} \iffree{just
after \Macro{begin}\PParameter{abstract}}{at the begin of the environment}.%
%
@@ -662,7 +512,7 @@ macros \Macro{chapterlevel}, \Macro{sectionlevel}, and so on, down to
\Macro{subparagraphlevel}.
\begin{Example}
Assume that you are preparing an article that uses the sectional
- unit \Macro{subsubsection}. However, you don't want this sectional
+ unit \Macro{subsubsection}. However, you do not want this sectional
unit to appear in the table of contents. The preamble of your
document might contain the following:
\begin{lstcode}
@@ -723,7 +573,7 @@ rule.
These options have no effect with the page styles \PValue{empty} and
\PValue{plain}, because there is no header in this case. Such a line always
has the effect of visually bringing header and text body closer together. That
-doesn't mean that the header must now be moved farther from the text
+does not mean that the header must now be moved farther from the text
body. Instead, the header should be considered as belonging to the text body
for the purpose of page layout calculations. {\KOMAScript} takes this into
account by automatically passing the option \Option{headinclude} to the
@@ -1002,7 +852,7 @@ The page styles can be redefined with the \Macro{renewcommand} macro.
\renewcommand*{\chapterpagestyle}{plain}
\end{lstcode}
Instead of the above you may do a local redefinition using a group. The
- advantage will be that you don't need to know the current page style before
+ advantage will be that you do not need to know the current page style before
the change to switch back at the end.
\begin{lstcode}
\clearpage
@@ -1238,12 +1088,12 @@ starts, the option influences also the explicit usage of the commands
\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, and
\Macro{cleardoubleemptypage}. See \autoref{sec:maincls.pagestyle},
\autopageref{desc:maincls.cmd.cleardoublepage} for more information
-about these. Since \LaTeX{} doesn't differentiate between left-hand
-and right-hand pages in single-sided printing, the option doesn't have
+about these. Since \LaTeX{} does not differentiate between left-hand
+and right-hand pages in single-sided printing, the option does not have
any influence in that case.
In class \Class{scrartcl} the section is the first structural element below
-the part. Because of this, \Class{scrartcl} doesn't support this option.
+the part. Because of this, \Class{scrartcl} does not support this option.
%
\EndIndex{Option}{open~=\PName{method}}%
@@ -1414,7 +1264,7 @@ description of the structural commands.
structural commands \Macro{part} down to \Macro{subparagraph} will be
activated. By default the optional argument will be used for the running
head only.%
- \IndexOption{headings=~optiontohead}%
+ \IndexOption{headings~=\PValue{optiontohead}}%
}%
\entry{\PValue{optiontoheadandtoc}, \PValue{optiontotocandhead}%
\IndexOption{headings~=\PValue{optiontoheadandtoc}}}{%
@@ -1430,7 +1280,7 @@ description of the structural commands.
structural commands \Macro{part} down to \Macro{subparagraph} will be
activated. By default the optional argument will be used for the table of
contents only.%
- \IndexOption{headings=~optiontohead}%
+ \IndexOption{headings~=\PValue{optiontohead}}%
}%
\pventry{small}{%
Use small headings with small distances above and below.%
@@ -1578,13 +1428,13 @@ In addition to this, with\ChangedAt{v3.10}{\Class{scrbook}\and
classes} option \important{\Option{headings}}
\OptionValue{headings}{optiontohead}%
\IndexOption[indexmain]{headings~=\PValue{optiontohead}}, \KOMAScript{}
-doesn't use
+does not use
the optional argument \PName{short version} at the table of
contents, but for the running head only. Nevertheless, such a running head
needs an appropriate page style. See \autoref{sec:maincls.pagestyle} and
\autoref{cha:scrpage} about this. With option
\OptionValue{headings}{optiontotoc}%
-\IndexOption[indexmain]{headings~=\PValue{optiontotoc}}, \KOMAScript{} doesn't
+\IndexOption[indexmain]{headings~=\PValue{optiontotoc}}, \KOMAScript{} does not
use the
optional argument \PName{short version} for the running head, but
at the table of contents. Nevertheless, the entry will be shown only if
@@ -1594,7 +1444,7 @@ counter \Counter{tocdepth} (see \autoref{sec:maincls.toc},
\IndexOption[indexmain]{headings~=\PValue{optiontoheadandtoc}}, \KOMAScript{}
uses the optional argument \PName{short version} in both the table of contents
and running head. All these three selections will also activate the extended
-interpretation of the optional argument \PName{short version}, which isn't
+interpretation of the optional argument \PName{short version}, which is not
active by default.
The \ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
@@ -2121,7 +1971,7 @@ horizontally centered instead of set ragged right. This is because command
\end{lstcode}
You may also redefine this using \Macro{renewcommand} too.
\begin{Example}
- You don't want different alignment at headings of \Macro{part}. So you
+ You do not want different alignment at headings of \Macro{part}. So you
put
\begin{lstcode}
\renewcommand*{\raggedpart}{\raggedsection}
@@ -2270,12 +2120,16 @@ Since chapters only exist in the classes \Class{scrbook} and
\begin{Declaration}
\Macro{chaptermark}\Parameter{running head}\\
+ \Macro{addchapmark}\Parameter{running head}\\
\Macro{sectionmark}\Parameter{running head}\\
+ \Macro{addsecmark}\Parameter{running head}\\
\Macro{subsectionmark}\Parameter{running head}\\
\Macro{chaptermarkformat}\\
\Macro{sectionmarkformat}\\
\Macro{subsectionmarkformat}
\end{Declaration}%
+\BeginIndex{Cmd}{addchapmark}%
+\BeginIndex{Cmd}{addsecmark}%
\BeginIndex{Cmd}{chaptermark}%
\BeginIndex{Cmd}{sectionmark}%
\BeginIndex{Cmd}{subsectionmark}%
@@ -2297,6 +2151,18 @@ Since chapters only exist in the classes \Class{scrbook} and
\Macro{chaptermarkformat}, \Macro{sectionmarkformat}, or
\Macro{subsectionmarkformat}.
+ Because\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}} \KOMAScript{} provides additional commands
+ \Macro{addchap} and \Macro{addsec} to make headings without numbers, there
+ also exist corresponding commands for making the running heads of those.
+ Please note\textnote{Attention!}, that the predefined \Macro{addchapmark}
+ and \Macro{addsecmark} use \Macro{chaptermark} and
+ \Macro{sectionmark} while they set counter
+ \Counter{secnumdepth} to -1 locally. You should pay attention for this
+ exspecially if you redefine \Macro{chaptermark} or
+ \Macro{sectionmark}, e.\,g., you should also redefine \Macro{addchapmark}
+ and \Macro{addsecmark} suitable.
+
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no
command \Macro{chaptermark} or \Macro{chaptermarkformat} in
\Class{scrartcl}. \OnlyAt{\Class{scrartcl}}Accordingly,
@@ -2336,6 +2202,8 @@ As you can see, both the commands \Macro{chapappifchapterprefix} and
\EndIndex{Cmd}{chaptermarkformat}%
\EndIndex{Cmd}{sectionmarkformat}%
\EndIndex{Cmd}{subsectionmarkformat}%
+\EndIndex{Cmd}{addsecmark}%
+\EndIndex{Cmd}{addchapmark}%
\begin{Declaration}
@@ -2476,7 +2344,7 @@ classes. Instead of this, the math features of the \LaTeX{} kernel have been
supported. With this also, the options \Option{leqno} and \Option{fleqn} are
available.
-You won't find a description of the math environments of the \LaTeX{} kernel
+You will not find a description of the math environments of the \LaTeX{} kernel
here. If you want to use \Environment{displaymath}\IndexEnv{displaymath},
\Environment{equation}\IndexEnv{equation}, and
\Environment{eqnarray}\IndexEnv{eqnarray} you should read a short introduction
@@ -2493,7 +2361,7 @@ standard option \Option{leqno} causes the standard option file
\File{leqno.clo} to be loaded. The equations are then numbered on the
left. This\textnote{Attention!} option has to be used as an optional argument
of \Macro{documentclass}. Usage as an argument of \Macro{KOMAoptions} or
-\Macro{KOMAoption} is not supported. This wouldn't make sense, because the
+\Macro{KOMAoption} is not supported. This would not make sense, because the
recommended math package \Package{amsmath} supports the option at loading
time only too and would not react on run-time changes of the option.
%
@@ -2508,7 +2376,7 @@ standard option \Option{fleqn} causes the standard option file
\File{fleqn.clo} to be loaded. Displayed equations are then
left-justified. This option may be used as an optional argument of
\Macro{documentclass} but not as an argument of \Macro{KOMAoptions} or
-\Macro{KOMAoption}. The latter wouldn't make sense, because the recommended
+\Macro{KOMAoption}. The latter would not make sense, because the recommended
math package \Package{amsmath} supports the option at loading time only too
and would not react on run-time changes of the option.
%
@@ -2600,7 +2468,7 @@ Of course similar features exist\ChangedAt{v3.09}{\Class{scrbook}\and
\IndexOption{captions~=\PValue{figuresignature}}. Nevertheless,
figures like photos will be viewed as a whole, and a diagram or graph
will mostly be examined from left bottom to the right. Therefore, in
-general, signatures should be used and it wouldn't be useful to change
+general, signatures should be used and it would not be useful to change
the caption format from signatures to headings.
Nevertheless sometimes all floating environments shall use headings. For this
@@ -2630,7 +2498,7 @@ Furthermore, \KOMAScript{} supports to switch off the distinguish of captions
with only one line or more than one line using option
\OptionValue{captions}{nooneline}\IndexOption{captions~=\PValue{nooneline}}%
\important{\OptionValue{captions}{nooneline}}. This may be useful, if one-line
-captions shouldn't be centered. The default of centering one-line captions
+captions should not be centered. The default of centering one-line captions
corresponds to \OptionValue{captions}{oneline}.
Another special feature of \KOMAScript{} is to alternatively put the caption
@@ -3156,7 +3024,7 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
placed on the inner side beside the figure. The figure itself is
shifted 2\Unit{em} into the outer margin.
- With \Macro{dimexp} a \eTeX{} command has been used. This shouldn't be a
+ With \Macro{dimexp} a \eTeX{} command has been used. This should not be a
problem at all, because \KOMAScript{} itself needs \eTeX{} and every almost
up-to-date \LaTeX{} distribution uses \eTeX already.
@@ -3606,13 +3474,13 @@ will become their final result.
Setting \OptionValue{listof}{entryprefix}\ChangedAt{v3.06}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} will automatically activate
\OptionValue{listof}{flat}
-too. Normally\important{\OptionValue{listof}{entryprefix}} it wouldn't make
+too. Normally\important{\OptionValue{listof}{entryprefix}} it would not make
sense to add the prefix ``figure'' to each entry of the list of figures and
the prefix ``table'' to each entry of the list of tables, because nothing else
than figures would be and should be expected at the list of figures and
nothing else than tables would be and should be expected at the list of
-tables. So this prefixes wouldn't give any additional information and for this
-wouldn't be useful. Nevertheless, such prefixes may be added using option
+tables. So this prefixes would not give any additional information and for this
+would not be useful. Nevertheless, such prefixes may be added using option
\OptionValue{listof}{entryprefix}. With this all entries of the same list will
get the same prefix. The prefix will depend on the file extension of the
helper file, that will be used for the corresponding list. For the list of
@@ -3640,7 +3508,7 @@ with \OptionValue{listof}{nochaptergap}%
\IndexOption{listof~=\PValue{chapterentry}} is somehow special. Instead of a
gap it adds the table of contents entry for the chapter additionally to the
lists of floating environments. Please\textnote{Attention!} note, that this
-would also happen, if the chapter doesn't have any floating
+would also happen, if the chapter does not have any floating
environment. Additional influence of chapters to the lists of floating
environments is available with option \Option{chapteratlists}. See
\autoref{sec:maincls.structure},
@@ -3693,11 +3561,11 @@ An overview about all settings to option \Option{listof} may be found at
sectioning level than default.%
\IndexOption{listof~=\PValue{leveldown}}}%
\entry{\PValue{nochaptergap}, \PValue{ignorechapter}}{%
- Chapter starts won't be marked at the lists of floating environments.%
+ Chapter starts are not marked at the lists of floating environments.%
\IndexOption{listof~=\PValue{nochaptergap}}}%
\entry{\PValue{notoc}, \PValue{plainheading}}{%
The lists of floating environments, e.\,g., list of figures and list of
- tables, won't generate an entry at the table of contents.%
+ tables do not generate an entry at the table of contents.%
\IndexOption{listof~=\PValue{notoc}}}%
\entry{\PValue{numbered}, \PValue{totocnumbered}, \PValue{tocnumbered},
\PValue{numberedtotoc}}{%
@@ -3708,7 +3576,7 @@ An overview about all settings to option \Option{listof} may be found at
\entry{\PValue{totoc}, \PValue{toc}, \PValue{notnumbered}}{%
The lists of floating environments, e.\,g., list of figures and list of
tables, would generate an entry at the table of contents, but their
- headings won't be numbered.%
+ headings are not numbered.%
\IndexOption{listof~=\PValue{totoc}}}%
\end{desclist}
%
@@ -3863,6 +3731,17 @@ neither a number nor an entry to the table of contents and corresponds to
\PValue{nobibliography} to this option at
\autopageref{desc:maincls.option.toc.bibliography}.
+Sometimes\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}} it is not usefull to have one bibliography for the whole
+document but a bibliography at every chapter of a document made using
+\Class{scrbook} or \Class{scrreprt}. In that case
+you'd\important{\OptionValue{bibliography=leveldown}} need the bibliography
+itself not to be a chapter but one level below, a section. You may achieve
+this using Option \OptionValue{bibliography}{leveldown}%
+\IndexOption{bibliography~=\PValue{leveldown}}. You may use this also if you'd
+combine several lists and the bibliography together below one heading. So this
+option is also available with \Class{scrartcl}.
+
A summary of all available values for option \Option{bibliography} may be
found in \autoref{tab:maincls.bibliography}. Nevertheless you should note,
that additional values may be generated using
@@ -3874,6 +3753,12 @@ that additional values may be generated using
of the bibliography}
\label{tab:maincls.bibliography}
\begin{desctabular}
+ \pventry{leveldown}{%
+ \ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}}%
+ The bibliography will use a heading of one step lower section level than
+ default.%
+ \IndexOption{bibliography~=\PValue{leveldown}}}%
\pventry{nottotoc}{%
The bibliography will neither have an entry at the table of contents nor
a number,%
@@ -3907,7 +3792,7 @@ that additional values may be generated using
\BeginIndex{Cmd}{setbibpreamble}%
The command \Macro{setbibpreamble} can be used to set a preamble for the
bibliography\Index{bibliography}. This can be achieved by placing the preamble
-before the command for issuing the bibliography. However, it needn't be
+before the command for issuing the bibliography. However, it need not be
directly in front of it. For example, it could be placed at the beginning of
the document. Similar\textnote{Attention!} to the options
\OptionValue{bibliography}{totoc} and
@@ -4001,10 +3886,10 @@ index hardly. This would be valid, e.\,g., for usage of package
The index is chapter (\Class{scrbook} or \Class{scrreprt}) or section
(\Class{scrartcl}) without heading number or entry at the table of contents by
default or option
-\OptionValue{index}{default}\IndexOption{index~=\PValue{default}}. The\important{\OptionValue{index}{totoc}} index
-doesn't need an entry at the table of contents, because it should always be
-the last element of a document. Nevertheless, such an entry may be achieved
-using option
+\OptionValue{index}{default}\IndexOption{index~=\PValue{default}}.
+The\important{\OptionValue{index}{totoc}} index does not need an entry at the
+table of contents, because it should always be the last element of a
+document. Nevertheless, such an entry may be achieved using option
\OptionValue{index}{totoc}\IndexOption{index~=\PValue{totoc}}. See also option
\Option{toc} with value \PValue{index} in \autoref{sec:maincls.toc} from
\autopageref{desc:maincls.option.toc.index} onward.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
index 39be1185e0f..82ec269a6aa 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrdatetime.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrdatetime.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,8 +45,9 @@
%
% ============================================================================
-\ProvidesFile{scrdatetime.tex}[{2012/02/23 KOMA-Script guide (chapter:
- scrdate, scrtime)}]
+\KOMAProvidesFile{scrdatetime.tex}
+ [$Date: 2013-12-13 12:13:03 +0100 (Fr, 13 Dez 2013) $
+ KOMA-Script guide (chapter: scrdate, scrtime)]
\translator{Markus Kohm\and Gernot Hassenpflug}
% Date of translated German file: 2012/02/23
@@ -88,7 +89,7 @@ The\ChangedAt{v3.05a}{\Package{scrdate}} command \Macro{CenturyPart} offers
the value of the century digits\,---\,hundreds and thousands\,---\,of a
\PName{year}. The command \Macro{DecadePart} in difference offers the other
digits which are the units and tens. The number of digits of \PName{year}
-doesn't care. The value may be assigned to a counter or may be used for
+does not care. The value may be assigned to a counter or may be used for
calculations, i.\,e., using \Macro{numexpr}\IndexCmd{numexpr}. For output of
an Arabic number of the value prefix it with \Macro{the}\IndexCmd{the}.
@@ -125,7 +126,7 @@ differ only in the kind of date declaration. Command \Macro{DayNumber} needs
\PName{year}, \PName{month}, and \PName{day} as separate parameters. Command
\Macro{ISODayNumber} expects an \PName{ISO-date} as a single argument. The
expected format of the \PName{ISO-date} is:
-\PName{year}\texttt{-}\PName{month}\texttt{-}\PName{day}. It doesn't matter
+\PName{year}\texttt{-}\PName{month}\texttt{-}\PName{day}. It does not matter
whether \PName{month} or \PName{day} have one or two digits. The result of
both commands may be assigned to a counter or used for calculations, i.\,e.,
using \Macro{numexpr}\IndexCmd{numexpr}. For output of
@@ -179,7 +180,7 @@ Wednesday\,=\,3, Thursday\,=\,4, Friday\,=\,5, and Saturday\,=\,6.%
\BeginIndex{Cmd}{DayNameByNumber}%
\BeginIndex{Cmd}{DayName}%
\BeginIndex{Cmd}{ISODayName}%
-Usually\ChangedAt{v3.05a}{\Package{scrdate}} you don't want to know the number
+Usually\ChangedAt{v3.05a}{\Package{scrdate}} you do not want to know the number
of the day of the week, but the name of the day of the week. Because of this,
the command \Macro{DayNameByNumber} offers the name of the day of the week
corresponding with a number. The number may be the result of \Macro{DayNumber}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex
index 05e7dea5eb5..5baf6701c96 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrextend.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrextend.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrextend.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ======================================================================
-\ProvidesFile{scrextend.tex}[2012/02/16 KOMA-Script package scrextend]
+\KOMAProvidesFile{scrextend.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script package scrextend]
\translator{Markus Kohm}
-% Date of the translated German file: 2008/09/12
+% Date of the translated German file: 2013/05/31
\chapter{Making Basic Feature of the \KOMAScript{} Classes Available with
Package \Package{scrextend} while Using Other Classes}
@@ -62,7 +64,7 @@ classes \Class{book}, \Class{report}, and \Class{article}, but also for
several features of the \KOMAScript{} class \Class{scrlttr2}, the successor of
\Class{scrlettr}, that may be used for letters. These basic features, that may
be found in the above-named classes, are also provided by package
-\Package{scrextend} since \KOMAScript{} release~3.00. This package shouldn't
+\Package{scrextend} since \KOMAScript{} release~3.00. This package should not
be used together with a \KOMAScript{} class, but may be used together with
many other classes. Package \Package{scrextend} would recognize, if it would
be used with a \KOMAScript{} class, and would terminate with a warning message
@@ -86,7 +88,7 @@ In difference to the above, only the \KOMAScript{} classes \Class{scrbook},
\Class{scrreprt}, and \Class{scrartcl} load package \Package{tocbasic} (see
\autoref{cha:tocbasic} from \autopageref{cha:tocbasic}), that has been
designed to be used by authors of classes and packages too. Because of this
-\Package{scrextend} doesn't provide the features of this package. Nevertheless
+\Package{scrextend} does not provide the features of this package. Nevertheless
you may use \Package{tocbasic} together with \Package{scrextend}.%
\fi
@@ -157,31 +159,6 @@ argument of \Macro{usepackage}\OParameter{optional
\LoadCommon{5}% \section{Text Markup}
-With command \Macro{usekomafont} the current font style may be changed into
-the font style, that has been defined for the given \PName{element}.
-
-\begin{Example}
- Assumed, you want to print the document title in a serif font and with red
- color. You may do this using:
-\begin{lstcode}
- \setkomafont{title}{\color{red}}
-\end{lstcode}
- Package \Package{color} or \Package{xcolor} will be needed for command
- \lstinline|\color{red}|. The additional usage of \Macro{normalfont} is not
- needed in this case, because it is already part of the definition of the
- title itself. This\textnote{Attention!} example also needs option
- \OptionValue{extendedfeature}{title} (see
- \autoref{sec:scrextend.optionalFeatures},
- \autopageref{desc:scrextend.option.extendedfeature}).
-\end{Example}
-%
-\EndIndex{Cmd}{setkomafont}%
-\EndIndex{Cmd}{addtokomafont}%
-\EndIndex{Cmd}{usekomafont}%
-%
-\EndIndex{}{font>style}%
-\EndIndex{}{text>markup}
-
\LoadCommon{14} %\section{Document Title Pages}
\LoadCommon{7}% \section{Detection of Odd and Even Pages}
@@ -191,7 +168,7 @@ the font style, that has been defined for the given \PName{element}.
One of the basic features of a document is the page
style\Index[indexmain]{page>style}. Page style in \LaTeX{} means mainly header
-and footer of the page. Package \Package{scrextend} doesn't define any page
+and footer of the page. Package \Package{scrextend} does not define any page
style, but it uses and expects the definition some page styles.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrhack.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrhack.tex
index fce50ee9fda..901ae104649 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrhack.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrhack.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrhack.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrhack.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,7 +45,9 @@
%
% ============================================================================
-\ProvidesFile{scrhack.tex}[2012/03/06 KOMA-Script guide (chapter: scrhack)]
+\KOMAProvidesFile{scrhack.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrhack)]
\translator{Markus Kohm}
% Date of the translated German file: 2011/10/07
@@ -71,13 +73,13 @@ been used by lot of users, there's one problem with it. While redefinition of
macros of foreign packages, it depend on the exact definition an usage of
those macros. This means additionally, that it depends on dedicated releases
of those packages. If a unknown release of such a package will be used,
-\Package{scrhack} eventually couldn't do the needed patch. Contrary, in
+\Package{scrhack} eventually could not do the needed patch. Contrary, in
extreme cases the patch may cause errors and fault.
So \Package{scrhack} has to be continuously modified to fit new releases of
foreign packages and will never be finished. Because of this \Package{scrhack}
will stay in beta state forever. Though the usage will generally be a
-benefit, the correct function couldn't be guaranteed forever.
+benefit, the correct function could not be guaranteed forever.
\LoadCommon{0}
@@ -105,7 +107,7 @@ will need a certain package loading order, though all these packages are not
related to each other. Wrong loading order may result in an error or break the
functionality of the commands.
-To clear all this disadvantages and problems, \KOMAScript{} officially doesn't
+To clear all this disadvantages and problems, \KOMAScript{} officially does not
support this old interface any more. Instead \KOMAScript{} warns, if the old
interface is used. At the same time package
\Package{tocbasic}\IndexPackage{tocbasic}\important{\Package{tocbasic}} (see
@@ -115,7 +117,7 @@ lists. Usage of this package provides much more advantages and features than
the two old commands, that has been alluded above.
Though the effort using that package is very small, the authors of most of the
-packages, that are using the old interface, haven't done so currently. Because
+packages, that are using the old interface, have not done so currently. Because
of this \Package{scrhack} contains appropriate modifications of packages
\Package{float}\IndexPackage{float}\important{\Package{float},
\Package{floatrow}, \Package{listings}},
@@ -144,7 +146,7 @@ Before version~6.79h package \Package{hyperref} set the link anchors after
instead of before the heading of star version commands like \Macro{part*},
\Macro{chapter*}, and so on. In the meantime this problem have been solved at
the \KOMAScript{} author's suggestion. But because the \KOMAScript{} author
-wasn't patient enough to wait more than a year for the change of
+was not patient enough to wait more than a year for the change of
\Package{hyperref}, a corresponding patch has been added to
\Package{scrhack}. This may be deactivated by
\OptionValue{hyperref}{false}. Nevertheless, it is recommended to use the
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-notecolumn.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-notecolumn.tex
new file mode 100644
index 00000000000..63606d0b3a6
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-notecolumn.tex
@@ -0,0 +1,317 @@
+\immediate\write17{^^J%
++----------------------------------------------------------------------^^J%
+| WARNING (`scrlayer-notecolumn.tex'):^^J%
++----------------------------------------------------------------------^^J%
+| YOU SHOULD NOTE, THAT THIS IS NOT AN OFFICIAL RELEASE!^^J%
+| THIS VERSION IS INTENDED TO BE USED FOR TESTING ONLY!^^J%
+| USAGE FOR PURPOSES OTHER THAN INTENDED IS DANGEROUS!^^J%
+| DON'T EXPECT ANY SUPPORT FOR THIS VERSION!^^J%
++----------------------------------------------------------------------^^J%
+}
+%%
+%% This is file `scrlayer-notecolumn.tex',
+%% generated with the docstrip utility, extended by scrdocstrip.
+%%
+%% The original source files were:
+%%
+%% scrlayer-notecolumn.dtx (with options: `doc')
+%%
+%% Copyright (c) 1994-2013 Markus Kohm [komascript at gmx info]
+%%
+%% This file was generated from file(s) of the KOMA-Script bundle.
+%% ---------------------------------------------------------------
+%%
+%% It may be distributed under the conditions of the
+%% LaTeX Project Public License in the version distributed together
+%% with KOMA-Script, see file `lppl.txt' or `lppl-de.txt'.
+%%
+%% This file may only be distributed together with a copy of the
+%% KOMA-Script bundle. You may however distribute the
+%% KOMA-Script bundle without all such generated files. See also
+%% `lppl.txt' or `lppl-de.txt' for additional information.
+%%
+%% The list of files belonging to KOMA-Script distribution is given in
+%% the file `manifest.txt'. See also `lppl.txt' or `lppl-de.txt' for
+%% additional information.
+%%
+%% If this file is a beta version, you may not be allowed to distribute
+%% it. Look at the comments below to see if this is the case.
+%%
+%% English and German manuals are part of KOMA-Script bundle.
+%% ----------------------------------------------------------
+%%
+%% See `README'.
+%%
+%% The KOMA-Script bundle (but maybe not this file) was based upon the
+%% LaTeX 2.09 Script family created by Frank Neukam 1993 and the LaTeX2e
+%% standard classes created by The LaTeX3 Project 1994-1996. You may
+%% find a complete unmodified copy of LaTeX2e at
+%% <http://www.ctan.org/pub/tex-archive/macros/latex/base/>.
+%%
+\ProvidesFile{scrlayer-notecolumn.tex}[%
+ 15/11/2013 v0.1.1514
+ (end user interface for scrlayer)]
+
+\chapter[{End User Interface \Package{scrlayer-notecolumn}}]{End User
+ Interface \Package{scrlayer-notecolumn}\footnote{This is not a translation
+ of the corresponding chapter of the German \KOMAScript{} manual but the
+ tentative and primary implementation manual of package
+ \Package{scrlayer-notecolumn}. As long as \Package{scrlayer-notecolumn} is
+ primary a proof of concept this doesn't matter. But nevertheless, a
+ German to English translator would still be welcome.}}
+\label{sec:scrlayer.notecolumn}
+\labelbase{scrlayer-notecolumn}
+
+Sometimes documents need an additional notes column beside the main text
+column and maybe beside the marginal note column. Problematicly may be
+having page breaks inside the notes column. This package provides a
+solution based on the layer interface of \Package{scrlayer}. You may
+define several notes columns, each of them with page breaks
+inside. It supports automatic page break inside of notes and recognises
+note collisions and solve them by moving notes.
+
+The idea of this package raised while an e-mail contact with Heiner
+Richter from FH~Stralsund, who told me of a book project, and asked
+whether or not such a functionality may be added to another package of
+mine easily. It couldn't, but design and implementation of a first test
+alpha of \Package{scrlayer-notecolumn} has been done in about three
+hours. So maybe it was a really good idea to ask me the question.
+
+\begin{Declaration}
+ \Macro{DeclareNoteColumn}%
+ \OParameter{option list}\Parameter{note column name}%
+ \\
+ \Macro{DeclareNewNoteColumn}%
+ \OParameter{option list}\Parameter{note column name}\\%^^A
+ \Macro{ProvideNoteColumn}%
+ \OParameter{option list}\Parameter{note column name}\\%^^A
+ \Macro{RedeclareNoteColumn}%
+ \OParameter{option list}\Parameter{note column name}%
+\end{Declaration}
+\BeginIndex{Cmd}{DeclareNoteColumn}%
+\BeginIndex{Cmd}{DeclareNewNoteColumn}%
+\BeginIndex{Cmd}{ProvideNoteColumn}%
+\BeginIndex{Cmd}{RedeclareNoteColumn}%
+Command \Macro{DeclareNoteColumn}
+may be used to declare a note column. Each note column is referenced by its
+name, defined by the obligatory argument \PName{note column name}. A note
+column vertically span the text area.
+
+By default its horizontal position is the current position of the marginal
+note column. It also regards \Macro{reversemarginpar} and
+\Macro{normalmarginpar}, while output of a note. Note that this is not the
+same like making a margin note. The default width is
+\Length{marginparwidth}. But you may use the optional argument \PName{option
+ list} to change this behaviour.
+
+The \PName{option list} is a comma-separated list of
+\texttt{\PName{key}=\PName{value}} options. Currently the following
+\PName{key}s are supported:
+\begin{labeling}[\ --]{\KOption{position}\PName{horizontal offset}}
+\item [\KOption{font}\PName{font declaration}] set the initial font attributes
+ to be used for the note column. Everything, that is allowed to be set by
+ \Macro{setkomafont} or \Macro{addtokomafont} can be used as
+ \PName{font declaration}. Note, that
+ \Macro{normalfont}\Macro{normalsize} will be used
+ before. So you don't need one of them at your own initialisation.
+\item [\Option{marginpar}] set up \Option{position} and \Option{width} to use
+ the marginal note column of \Macro{marginpar}.
+\item [\Option{normalmarginpar}] set up \Option{position} and \Option{width}
+ to use the normal marginal note column and ignore \Macro{reversemarginpar}
+ and \Macro{normalmarginpar}.
+\item [\KOption{position}\PName{horizontal offset}] set up the horizontal
+ offset of the note column from the left edge of the paper. The
+ \PName{horizontal offset} can be either a \LaTeX{} length, a \TeX{}
+ dimension, a \TeX{} skip, a length value, or a dimensional expression using
+ \texttt{+}, \texttt{-}, \texttt{*}, \texttt{/} and parenthesis (see
+ \cite[section~3.5]{manual:eTeX} for more information about dimensional
+ expressions). The value will be calculated at usage time not at definition
+ time. So you may even use more complex constructs like:
+\begin{lstcode}
+ \ifodd\value{page}
+ \oddsidemargin+1in
+ +\textwidth+\marginparsep
+ \else
+ \evensidemargin+1in
+ -\marginparsep
+ -\marginparwidth
+ \fi
+\end{lstcode}
+\item [\Option{reversemarginpar}] set up \Option{position} and \Option{width}
+ to use the reverse marginal note column and ignore \Macro{reversemarginpar}
+ and \Macro{normalmarginpar}.
+\item [\KOption{width}\PName{size}] set up the horizontal size of the note
+ column. You can use the same values for \PName{size} like for
+ \PName{horizontal offset} of option \Option{position}.
+\end{labeling}
+
+You may use as much note columns as \LaTeX{} provides free box registers,
+because every note column needs one box register. You may use package
+\Package{etex} to increase the normal amount of box registers from 256 to
+32768. This should be enough to avoid the ``\texttt{no room for
+ \Macro{newbox}}'' error.
+
+The implementation of note columns uses foreground layers from package
+\Package{scrlayer}. Every \Macro{DeclareNoteColumn} generates a layer and adds
+this layer to the pseudo page style \Pagestyle{@everystyle@}. Theoretically
+you may modify the generated layer, but it is recommended not to modify them.
+
+Overlapping of different note columns is allowed. There's one predefined note
+column named ``\texttt{marginpar}''.
+
+\BeginIndex{FontElement}{notecolumn.\PName{note column name}}%
+Note, that if you change the initial font using
+\begin{quote}
+ \Macro{setkomafont}\linebreak[1]\PParameter{marginnote.\PName{note column
+ name}}\Parameter{font declaration}
+\end{quote}
+or
+\begin{quote}
+ \Macro{addtokomafont}\linebreak[1]\PParameter{marginnote.\PName{note column
+ name}}\Parameter{font declaration}
+\end{quote}
+the font of all succeeding note column outputs would change. This could make it
+hard to find out, which notes will be affected by the change.
+See \autoref{sec:maincls.textmarkup},
+\autopageref{desc:maincls.cmd.setkomafont} for more information about
+\Macro{setkomafont} and \Macro{addtokomafont}.%
+\EndIndex{FontElement}{notecolumn.\PName{note column name}}%
+
+The difference between \Macro{DeclareNoteColumn} and the other commands is,
+that \Macro{DeclareNoteColumn} defines the note column independent whether a
+note column with the same name has already been defined or
+not. \Macro{DeclareNewNoteColumn} defined only note columns which names are
+not yet used for another note column. It's an error to use it with an already
+used \PName{note column name}. \Macro{ProvideNoteColumn} is like
+\Macro{DeclareNewNoteColumn}, but if the \PName{note column name} is already
+used for a note column nothing happens. \Macro{RedeclareNoteColumn} may be
+used to declare a note column with a name, that is already used. Using it with
+a new name is an error.
+\EndIndex{Cmd}{RedeclareNoteColumn}%^^A
+\EndIndex{Cmd}{ProvideNoteColumn}%^^A
+\EndIndex{Cmd}{DeclareNewNoteColumn}%^^A
+\EndIndex{Cmd}{DeclareNoteColumn}%^^A
+
+\begin{Declaration}
+ \Macro{makenote}%
+ \OParameter{note column name}\Parameter{note text}
+\end{Declaration}
+\BeginIndex{Cmd}{makenote}%
+This command
+may be used to make a new note. The note will be written to a helper file with
+extension \File{.slnc} in this run. In the next run, it will be
+typeset. Normally it will be typeset with the same vertical position, that
+would be used for a \Macro{parbox[t]}, but horizontally moved to the note
+column. Collisions at this position of this note column (but not of other note
+columns) will be recognised. In such a case the note may be moved down and
+even to another page. Automatic page breaks at the note columns are
+supported. This is something different to \Macro{marginpar},
+\Macro{marginline} (\KOMAScript{} classes), or \Macro{marginnote} (package
+\Package{marginnote}).
+
+Note, that after changing the document, at least two \LaTeX{} runs are needed
+to move the note to its final position.
+
+Note, that fragile commands should be protected to avoid error messages while
+writing or reading the helper file.
+
+Note, that \Package{scrlayer-notecolumn} needs only one helper file for all
+note columns together. You should not edit or change that helper file, because
+the syntax is fragile. It won't be read using \Macro{input} but
+\Macro{read}. Because of this, line breaks, empty lines and \Macro{par} should
+be avoided.
+
+Currently it is unknown where you may use \Macro{makenote} and where not. But
+you must not use \Macro{makenote} inside of \Macro{makenote}!
+
+The default for the optional argument \PName{makenote} is \PValue{marginpar},
+that is the \PName{note column name} of the pre-defined note column.
+\EndIndex{Cmd}{makenote}
+
+\begin{Declaration}
+ \KOption{autoclearnotecolumns}\PName{simple switch}\\
+ \Macro{clearnotecolumn}\OParameter{name of a note column}%
+ \\
+ \Macro{clearnotecolumns}\OParameter{list of note column names}
+\end{Declaration}
+\BeginIndex{Cmd}{clearnotcolumn}%
+\BeginIndex{Cmd}{clearnotcolumns}%
+The commands
+may be used to output all hanging notes for either one or several note
+columns. With \Macro{clearnotecolumn} only the notes of the note column with
+the given \PName{name of a note column} will be output. If you omit the
+optional argument (this is not the same like using an empty value!) note
+column \PValue{marginnote} will be used.
+
+With \Macro{clearnotecolumns} the notes of all note columns of the comma
+separated \PName{list of note column names} will be output. If you omit the
+optional Argument or if the optional Argument is empty (or start with
+\Macro{relax}) the notes of all note columns will be output.
+
+Macro \Macro{clearpage} will be used to output hanging notes and several
+\LaTeX{} runs may be needed to terminate with the correct number of
+\Macro{clearpage} for the whole document. You will get the message ``\LaTeX{}
+Warning: Label(s) may have changed. Rerun to get cross-references right.'' as
+long as the process hasn't been terminated.
+
+But normally you don't need to us \Macro{clearnotecolum} or
+\Macro{clearnotecolumns} yourself. Because by default option
+\Option{autoclearnotecolumns} is switched on, which means, that
+\Macro{clearnotecolumns} will be done at every \Macro{clearpage}. You may
+change this, switching off \Macro{autoclearnotecolumns} using one of the
+values for simple switches.
+
+Note, that it is not allowed to use \Macro{clearnotecolumn} or
+\Macro{clearnotecolumns} inside a note. You can use these commands only inside
+the main text of the document.%
+\EndIndex{Cmd}{clearnotcolumns}%
+\EndIndex{Cmd}{clearnotcolumn}%
+
+\begin{Declaration}
+ \Macro{syncwithnotecolumn}\OParameter{name of a note column}%
+ \\
+ \Macro{syncwithnotecolumns}\OParameter{list of note column names}%
+\end{Declaration}
+\BeginIndex{Cmd}{syncwithnotecolumn}%
+\BeginIndex{Cmd}{syncwithnotecolumns}%
+These commands
+may be used to synchronise the vertical position of the main text with one or
+several note columns. If you use the optional argument of
+\Macro{syncwithnotecolumn} it should be one \PName{name of a note column}. If
+you omit it, \PValue{marginpar} will be used as the \PName{name of a note
+ column}. Usage of \Macro{syncwithnotecolumn} is exactly the same like usage
+of \Macro{syncwithnotecolumns} with exactly one \PName{name of a note column}.
+
+The optional argument of \Macro{syncwithnotecolumns} is a comma-separated list
+of names of note columns. If you omit this optional argument or if you use an
+empty argument or if the argument starts with \Macro{relax} synchronisation
+will be done with all declared note columns.
+
+Synchronisation with a note column means, that the current position of the
+main text will be changed to be the current vertical position of the note
+column after cleaning the note column. This differs in several point from
+cleaning a note column:
+\begin{itemize}
+\item After cleaning a note column the text position would change to be at a
+ new page, even if the note column doesn't fill the whole page
+ before. Synchronisation will change the vertical position just after the
+ last vertical position of the note column.
+\item Cleaning a note column needs less \LaTeX{} runs than synchronising a
+ note column.
+\end{itemize}
+Both, cleaning an synchronising a note column, uses the label mechanism of
+\LaTeX{} without using \Macro{label}, \Macro{ref}, or \Macro{pageref} itself
+(but \Macro{newlabel}). So you should have a look at \LaTeX{} rerun messages,
+because of undefined or changed labels.
+
+Note, that it is not allowed to use \Macro{syncwithnotecolumn} or
+\Macro{syncwithnotecolumns} inside a note. If you do so, you need endless
+\LaTeX{} runs without reaching a final state. But synchronisation of several
+note columns in the main text of a document will also synchronise the notes
+columns with each others.%
+\EndIndex{Cmd}{syncwithnotecolumns}
+\EndIndex{Cmd}{syncwithnotecolumn}
+
+\endinput
+%%
+%% End of file `scrlayer-notecolumn.tex'.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage-experts.tex
new file mode 100644
index 00000000000..ba5a99e60b3
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage-experts.tex
@@ -0,0 +1,660 @@
+% ======================================================================
+% scrlayer-scrpage-experts.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% This file is part of the LaTeX2e KOMA-Script bundle.
+%
+% This work may be distributed and/or modified under the conditions of
+% the LaTeX Project Public License, version 1.3c of the license.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later and of this work.
+%
+% This work has the LPPL maintenance status "author-maintained".
+%
+% The Current Maintainer and author of this work is Markus Kohm.
+%
+% This work consists of all files listed in manifest.txt.
+% ----------------------------------------------------------------------
+% scrlayer-scrpage-experts.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
+% Version 1.3c, verteilt und/oder veraendert werden.
+% Die neuste Version dieser Lizenz ist
+% http://www.latex-project.org/lppl.txt
+% und Version 1.3c ist Teil aller Verteilungen von LaTeX
+% Version 2005/12/01 oder spaeter und dieses Werks.
+%
+% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
+% (allein durch den Autor verwaltet).
+%
+% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
+%
+% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
+% ======================================================================
+%
+% Expert chapter about scrlayer-scrpage of the KOMA-Script guide
+%
+% ----------------------------------------------------------------------
+%
+% Expertenkapitel ueber scrlayer-scrpage in der KOMA-Script-Anleitung
+%
+% ============================================================================
+
+\KOMAProvidesFile{scrlayer-scrpage-experts.tex}%
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrlayer-scrpage-experts)]
+\translator{Markus Kohm}
+
+% Date version of the translated file: 2013-10-28
+
+\chapter[{Additional Features of \Package{scrlayer-scrpage}}]
+ {Additional Features\ChangedAt{v3.12}{\Package{scrlayer-scrpage}} with
+ package \Package{scrlayer-scrpage}}
+\labelbase{scrlayer-scrpage-experts}
+%
+\BeginIndex{Package}{scrlayer-scrpage}%
+Package \Package{scrlayer-scrpage} provides features that have not been
+described in \autoref{cha:scrlayer-scrpage} of \autoref{part:forAuthors} of this
+\iffree{user guide}{book}. But the most average user will not need those
+extensions and some of them are only implemented for compatibility with
+\Package{scrpage2}. So most users do not need to know them. Therefore all those
+things are described here in \autoref{part:forExperts} only.
+
+\section{Definition of new Pairs of Page Styles}
+\label{sec:scrlayer-scrpage.pagestyle.pairs}
+
+In \autoref{sec:scrlayer-scrpage.predefined.pagestyles} the page styles
+\Pagestyle{scrheadings} and \Pagestyle{plain.scrheadings} have been
+described. Those build quasi a pair of page styles, with
+\Pagestyle{scrheadings} as the main page style with running head and
+\Pagestyle{plain.scrheadings} as the corresponding \Pagestyle{plain} page
+style without running head but generally with pagination. Beside the
+configuration of these page styles, \Package{scrlayer-scrpage} provides also
+the feature of defining new such pairs of page styles. Thereby the name of the
+main page style, e.\,g., \Pagestyle{scrheadings}, is quasi the name of the
+pair of page styles.
+
+Most users will not need more than the predefined pair
+\Pagestyle{scrheadings}. So the commands of this section may be understood as
+an addition for special cases. And because each such case is very special,
+this section also lacks of handsome examples. Nevertheless, if the support
+will show me a real nice example in future, I perhaps could use it in
+future. Nevertheless, I'm almost sure that all such cases could also be
+solved using the predefined pair only.
+
+\begin{Declaration}
+ \Macro{defpairofpagestyles}%
+ \OParameter{parent pair}\Parameter{name}\Parameter{definition}\\
+ \Macro{newpairofpagestyles}%
+ \OParameter{parent pair}\Parameter{name}\Parameter{definition}\\
+ \Macro{renewpairofpagestyles}%
+ \OParameter{parent pair}\Parameter{name}\Parameter{definition}\\
+ \Macro{providepairofpagestyles}%
+ \OParameter{parent pair}\Parameter{name}\Parameter{definition}
+\end{Declaration}
+\BeginIndex{Cmd}{defpairofpagestyles}%
+\BeginIndex{Cmd}{newpairofpagestyles}%
+\BeginIndex{Cmd}{renewpairofpagestyle}%
+\BeginIndex{Cmd}{providepairofpagestyles}%
+With these commands you may define pairs of page styles similar to
+\Pagestyle{scrheadings} and \Pagestyle{plain.scrheadings}. Thereby
+\PName{name} is the name of the main page style that is similar to
+\Pagestyle{scrheadings}. The name of the corresponding \Pagestyle{plain} page
+style will be prefixed by \PValue{plain.} automatically. So \PName{name} is
+not only the name of the pair of page styles, but also the name of the main
+page style of that pair, while \PValue{plain.}\PName{name} is the name of the
+\Pagestyle{plain} page style of this pair.
+
+If the optional argument \PName{parent pair} is given, the settings of the
+pair of page styles with that name are the initial settings of the new pair of
+page styles. So the new pair inherits the configuration of the \PName{parent
+ pair}.
+
+While reading \autoref{sec:scrlayer-scrpage.predefined.pagestyles} you might
+have the impression that the commands of this section were related to
+\Pagestyle{scrheadings} and \Pagestyle{plain.scrheadings} only. Nevertheless,
+this is only as long true, as this is the only existing pair of page
+styles. As soon as there exist more pairs of page styles, they are related to
+the pair that has been activated last. In fact, this is the case for \Macro{lehead}, \Macro{cehead}, \Macro{rehead}, \Macro{lohead},
+\Macro{cohead}, \Macro{rohead}, \Macro{lefoot}, \Macro{cefoot},
+\Macro{refoot}, \Macro{lofoot}, \Macro{cofoot}, \Macro{rofoot}, \Macro{ihead},
+\Macro{chead}, \Macro{ohead}, \Macro{ifoot}, \Macro{cfoot}, and \Macro{ofoot}
+from \autoref{sec:scrlayer-scrpage.predefined.pagestyles}.
+
+All those commands and the below described commands \Macro{clearmainofpairofpagestyles}, \Macro{clearplainofpairofpagestyles}, and
+\Macro{clearpairofpagestyles} are also mentioned to be used inside the
+argument \PName{definition}. In that case, they are a kind of default
+configuration of the pair of page styles that will be executed each time the
+pair will be activated. A pair of page styles will be activated, if one of the
+page styles of the pair will be activated. This will be done mostly using
+\Macro{pagestyle}\IndexCmd{pagestyle}.
+
+Please note that the commands of
+\autoref{sec:scrlayer-scrpage.pagestyle.content} are for general purpose,
+anyway. So they are related to every page style that has been defined using
+\Package{scrlayer-scrpage}.
+
+Whereas \Macro{defpairofpagestyles} will define a pair independent whether or
+not the corresponding page styles are already defined, will
+\Macro{newpairofpagestyles} and \Macro{providepairofpagestyles} define the pair
+only, if the page styles are currently undefined. If at least one of the page
+styles is already defined, the new definition of
+\Macro{providepairofpagestyles} will be ignored, but usage of
+\Macro{newpairofpagestyles} would result in an error message. To redefine
+already existing pairs of page styles you may use
+\Macro{renewpairofpagestyles}. With this an error would be thrown, if at least
+one of the page styles of the pair does not already exist.%
+\EndIndex{Cmd}{providepairofpagestyles}%
+\EndIndex{Cmd}{renewpairofpagestyles}%
+\EndIndex{Cmd}{newpairofpagestyles}%
+\EndIndex{Cmd}{defpairofpagestyles}%
+
+\begin{Declaration}
+ \Macro{clearmainofpairofpagestyles}\\
+ \Macro{clearplainofpairofpagestyles}\\
+ \Macro{clearpairofpagestyles}
+\end{Declaration}
+\BeginIndex{Cmd}{clearmainofpairofpagestyles}%
+\BeginIndex{Cmd}{clearplainofpairofpagestyles}%
+\BeginIndex{Cmd}{clearpairofpagestyles}%
+Command \Macro{clearmainofpairofpagestyles} will configure the main page style
+of the lastly activated pair of page styles to be empty. In contrast to this
+\Macro{clearplainofpairofpagestyles} will configure the \Pagestyle{plain} page
+style of the lastly activated pair of page styles to be empty. Last but not
+least \Macro{clearpairofpagestyle} will configure both page styles of the
+lastly activated pair of page styles to be empty.
+
+But please note\textnote{Attention!} that none of these commands will remove
+the definitions of argument \PName{definition} that has been used when
+defining the pair of page styles (see above). So if you activate the pair of
+page styles again, those definitions will be used again!
+
+These commands may be used inside of \PName{definition} themselves. But you
+may use them outside the definition of a pair of page styles too. In this case
+they are related to the lastly activated pair of page styles.
+
+\BeginIndex{Cmd}{clearscrheadings}%
+\BeginIndex{Cmd}{clearscrplain}%
+\BeginIndex{Cmd}{clearscrheadfoot}%
+The commands \Macro{clearscrheadings}, \Macro{clearscrplain}, and
+\Macro{clearscrheadfoot} are aliases for these commands that have been
+implemented for compatibility with \Package{scrpage2} only. Nevertheless, they
+are deprecated and should not be used any longer.%
+\EndIndex{Cmd}{clearscrheadfoot}%
+\EndIndex{Cmd}{clearscrplain}%
+\EndIndex{Cmd}{clearscrheadings}%
+%
+\EndIndex{Cmd}{clearpairofpagestyles}%
+\EndIndex{Cmd}{clearplainofpairofpagestyles}%
+\EndIndex{Cmd}{clearmainofpairofpagestyles}%
+
+
+\section{Definition of Simple Page Styles with Three Parts in Head and Foot }
+\label{sec:scrlayer-scrpage.pagestyle.triple}
+
+Beside predefined page styles and beside the definition of new pairs of page
+styles, package \Package{scrlayer-scrpage} also provides the Definition of
+page styles with three parts in head and foot. But this user interface exists
+for compatibility with \Package{scrpage2} only. Nevertheless, it has been
+extended to have a more consistent set of commands in difference to
+\Package{scrpage2}. However, for new documents it is recommended to use the
+advanced features that have been described in the previous section, instead
+of the commands of this section.
+
+\begin{Declaration}
+ \Macro{deftriplepagestyle}%
+ \Parameter{name of the page style}\\
+ \hphantom{\XMacro{deftriplepagestyle}}%
+ \OParameter{thickness of the outer line}%
+ \OParameter{thickness of the inner line}\\
+ \hphantom{\XMacro{deftriplepagestyle}}%
+ \Parameter{inner head element}%
+ \Parameter{centre head element}%
+ \Parameter{outer head element}\\
+ \hphantom{\XMacro{deftriplepagestyle}}%
+ \Parameter{inner foot element}%
+ \Parameter{centre foot element}%
+ \Parameter{outer foot element}\\
+ \Macro{newtriplepagestyle}%
+ \Parameter{name of the page style}\\
+ \hphantom{\XMacro{newtriplepagestyle}}%
+ \OParameter{thickness of the outer linen}%
+ \OParameter{thickness of the inner linen}\\
+ \hphantom{\XMacro{newtriplepagestyle}}%
+ \Parameter{inner head element}%
+ \Parameter{centre head element}%
+ \Parameter{outer head element}\\
+ \hphantom{\XMacro{newtriplepagestyle}}%
+ \Parameter{inner foot element}%
+ \Parameter{centre foot element}%
+ \Parameter{outer foot element}\\
+ \Macro{renewtriplepagestyle}%
+ \Parameter{name of the page style}\\
+ \hphantom{\XMacro{renewtriplepagestyle}}%
+ \OParameter{thickness of the outer line}%
+ \OParameter{thickness of the inner line}\\
+ \hphantom{\XMacro{renewtriplepagestyle}}%
+ \Parameter{inner head element}%
+ \Parameter{centre head element}%
+ \Parameter{outer head element}\\
+ \hphantom{\XMacro{renewtriplepagestyle}}%
+ \Parameter{inner foot element}%
+ \Parameter{centre foot element}%
+ \Parameter{outer foot element}\\
+ \Macro{providetriplepagestyle}%
+ \Parameter{name of the page style}\\
+ \hphantom{\XMacro{providetriplepagestyle}}%
+ \OParameter{thickness of the outer line}%
+ \OParameter{thickness of the inner line}\\
+ \hphantom{\XMacro{providetriplepagestyle}}%
+ \Parameter{inner head element}%
+ \Parameter{centre head element}%
+ \Parameter{outer head element}\\
+ \hphantom{\XMacro{providetriplepagestyle}}%
+ \Parameter{inner foot element}%
+ \Parameter{centre foot element}%
+ \Parameter{outer foot element}
+\end{Declaration}
+\BeginIndex{Cmd}{deftriplepagestyle}%
+\BeginIndex{Cmd}{newtriplepagestyle}%
+\BeginIndex{Cmd}{renewtriplepagestyle}%
+\BeginIndex{Cmd}{providetriplepagestyle}%
+With these commands you can define a single page style, whose head and foot are
+parted into three elements: an inner element, a centre element, and an outer
+element. The contents of the elements are given three mandatory arguments for
+the head and three mandatory arguments for the foot.
+
+Each of the two inner elements will be printed right aligned on left pages and
+left aligned on right pages. The centre elements will be printed centred in
+the head respectively foot of left and right pages. Each of the two outer
+elements will be printed left aligned on left pages and right aligned on right
+pages.
+
+Please remember once again:\textnote{Attention!} There are only right pages in
+single side layout!
+
+The two optional arguments can be used to activate horizontal lines in the
+head and foot of the page style. To do so, you put the wanted thickness of the
+line as an optional argument. The first optional argument is the
+\PName{thickness of the outer line} in both, the page head and footer. In the
+page head it will be printed above the head contents. In the page footer it
+will be printed below the foot contents. The second optional argument is the
+\PName{thickness of the inner line}. This will be printed below the page head
+and additionally above the page footer. If you have only one optional
+argument, this is the \PName{thickness of the inner line}. In this case no
+outer line will be printed. And if you omit both optional arguments, both
+lines will be omitted.
+
+Please note\textnote{Attention!} that an empty optional argument is not the
+same like omitting the optional argument! Empty optional arguments are not
+allowed in this case. But you may use simple dimension expressions for the
+optional arguments, like they have been explained for \KOMAScript{} option
+\Option{headwidth} (see \autoref{sec:scrlayer-scrpage.pagestyle.content},
+\autopageref{desc:scrlayer-scrpage.option.headwidth}).
+
+The meaning of the arguments is also shown in
+\autoref{fig:scrlayer-scrpage.triplepagestyle} for an schematic double
+page. Thereby ``\texttt{outer}'', ``\texttt{inner}'', and ``\texttt{centre}''
+are example contents. The corresponding arrows illustrate the expansion of
+those contents. The \iffree{coloured }{}texts inside the pages are only the
+names of the arguments of these commands. The related arrows \iffree{in
+ the same colour }{} point to the corresponding elements of the page.
+
+\begin{figure}
+ \centering
+ \begin{picture}(\textwidth,80mm)
+ \put(0,50mm){%
+ %\
+ \begin{picture}(\textwidth,30mm)(0,-10mm)
+ \thinlines
+ \small
+ % linke Seite
+ \put(0,20mm){\line(1,0){.49\textwidth}}%
+ \put(0,0){\line(0,1){20mm}}%
+ \multiput(0,0)(0,-1mm){10}{\line(0,-1){.5mm}}%
+ \put(.49\textwidth,5mm){\line(0,1){15mm}}%
+ \put(.05\textwidth,15mm){\thicklines\line(1,0){.415\textwidth}}%
+ \put(.05\textwidth,10mm){\makebox(0em,5mm)[l]{\slshape outer\strut$\longrightarrow$}}%
+ \put(.465\textwidth,10mm){\makebox(0em,5mm)[r]{\slshape $\longleftarrow$inner\strut}}%
+ \put(.2575\textwidth,10mm){\makebox(0em,5mm)[c]{\slshape $\longleftarrow$centre\strut$\longrightarrow$}}%
+ \put(.05\textwidth,10mm){\thicklines\line(1,0){.415\textwidth}}%
+ % rechte Seite
+ \put(0.51\textwidth,20mm){\line(1,0){.49\textwidth}}%
+ \put(0.51\textwidth,5mm){\line(0,1){15mm}}%
+ \multiput(\textwidth,0)(0,-1mm){10}{\line(0,-1){.5mm}}%
+ \put(\textwidth,0mm){\line(0,1){20mm}}%
+ \put(.535\textwidth,15mm){\thicklines\line(1,0){.415\textwidth}}%
+ \put(.535\textwidth,10mm){\makebox(0em,5mm)[l]{\slshape inner\strut$\longrightarrow$}}%
+ \put(.95\textwidth,10mm){\makebox(0em,5mm)[r]{\slshape $\longleftarrow$outer\strut}}%
+ \put(.7425\textwidth,10mm){\makebox(0em,5mm)[c]{\slshape $\longleftarrow$centre\strut$\longrightarrow$}}%
+ \put(.535\textwidth,10mm){\thicklines\line(1,0){.415\textwidth}}%
+ % commands for both pages
+ \iffree{\color{red}}{}%
+ \put(.5\textwidth,0){\makebox(0,\baselineskip)[c]{\PName{inner head element}}}%
+ \put(.5\textwidth,-5mm){\makebox(0,\baselineskip)[c]{\PName{centre
+ head element}}}%
+ \put(.5\textwidth,-10mm){\makebox(0,\baselineskip)[c]{\PName{outer
+ head element}}}%
+ \put(\dimexpr.5\textwidth-2em,.5\baselineskip){%
+ \put(-1.5em,.5\baselineskip){\vector(0,1){7mm}}%
+ \put(-3.5em,-1\baselineskip){\line(-1,0){\dimexpr .25\textwidth-6.5em\relax}}%
+ \put(-\dimexpr
+ .25\textwidth-3em\relax,-1\baselineskip){\vector(0,1){\dimexpr
+ 7mm+1.5\baselineskip\relax}}
+ \put(-3.25em,-2.25\baselineskip){\line(-1,0){\dimexpr .45\textwidth-8em\relax}}%
+ \put(-\dimexpr
+ .45\textwidth-4.75em\relax,-2.25\baselineskip){\vector(0,1){\dimexpr
+ 7mm+2.75\baselineskip\relax}}
+ }%
+ \put(\dimexpr.5\textwidth+2em,.5\baselineskip){%
+ \put(1.5em,.5\baselineskip){\vector(0,1){7mm}}%
+ \put(3.5em,-1\baselineskip){\line(1,0){\dimexpr .25\textwidth-6.5em\relax}}
+ \put(\dimexpr
+ .25\textwidth-3em\relax,-1\baselineskip){\vector(0,1){\dimexpr
+ 7mm+1.5\baselineskip\relax}}
+ \put(3.25em,-2.25\baselineskip){\line(1,0){\dimexpr .45\textwidth-8em\relax}}
+ \put(\dimexpr
+ .45\textwidth-4.75em\relax,-2.25\baselineskip){\vector(0,1){\dimexpr
+ 7mm+2.75\baselineskip\relax}}
+ }%
+ \end{picture}
+ %
+ }%
+ \put(0,0){%
+ \begin{picture}(\textwidth,30mm)
+ \thinlines
+ \small
+ % linke Seite
+ \put(0,0){\line(1,0){.49\textwidth}}%
+ \put(0,0){\line(0,1){20mm}}%
+ \multiput(0,20mm)(0,1mm){10}{\line(0,1){.5mm}}%
+ \put(.49\textwidth,0){\line(0,1){15mm}}%
+ \put(.05\textwidth,15mm){\thicklines\line(1,0){.415\textwidth}}%
+ \put(.05\textwidth,10mm){\makebox(0em,5mm)[l]{\slshape outer\strut$\longrightarrow$}}%
+ \put(.465\textwidth,10mm){\makebox(0em,5mm)[r]{\slshape $\longleftarrow$inner\strut}}%
+ \put(.2575\textwidth,10mm){\makebox(0em,5mm)[c]{\slshape $\longleftarrow$centre\strut$\longrightarrow$}}%
+ \put(.05\textwidth,10mm){\thicklines\line(1,0){.415\textwidth}}%
+ % rechte Seite
+ \put(.51\textwidth,0){\line(1,0){.49\textwidth}}%
+ \put(.51\textwidth,0){\line(0,1){15mm}}%
+ \put(\textwidth,0){\line(0,1){20mm}}%
+ \multiput(\textwidth,20mm)(0,1mm){10}{\line(0,1){.5mm}}%
+ \put(.535\textwidth,15mm){\thicklines\line(1,0){.415\textwidth}}%
+ \put(.535\textwidth,10mm){\makebox(0em,5mm)[l]{\slshape inner\strut$\longrightarrow$}}%
+ \put(.95\textwidth,10mm){\makebox(0em,5mm)[r]{\slshape $\longleftarrow$outer\strut}}%
+ \put(.7425\textwidth,10mm){\makebox(0em,5mm)[c]{\slshape $\longleftarrow$centre\strut$\longrightarrow$}}%
+ \put(.535\textwidth,10mm){\thicklines\line(1,0){.415\textwidth}}%
+ % commands for both pages
+ \iffree{\color{red}}{}%
+ \put(.5\textwidth,20mm){\makebox(0,\baselineskip)[c]{\PName{inner foot
+ element}}}%
+ \put(.5\textwidth,25mm){\makebox(0,\baselineskip)[c]{\PName{centre
+ foot element}}}%
+ \put(.5\textwidth,30mm){\makebox(0,\baselineskip)[c]{\PName{outer foot
+ element}}}%
+ \put(\dimexpr.5\textwidth-2em,.5\baselineskip){%
+ \put(-1.5em,\dimexpr 20mm-.5\baselineskip\relax){\vector(0,-1){6mm}}%
+ \put(-3.5em,25mm){\line(-1,0){\dimexpr .25\textwidth-6.5em\relax}}%
+ \put(-\dimexpr .25\textwidth-3em\relax,25mm){\vector(0,-1){\dimexpr
+ .5\baselineskip + 11mm\relax}}%
+ \put(-3em,30mm){\line(-1,0){\dimexpr .45\textwidth-7.5em\relax}}%
+ \put(-\dimexpr .45\textwidth-4.5em\relax,30mm){\vector(0,-1){\dimexpr
+ .5\baselineskip + 16mm\relax}}%
+ }%
+ \put(\dimexpr.5\textwidth+2em,.5\baselineskip){%
+ \put(1.5em,\dimexpr 20mm-.5\baselineskip\relax){\vector(0,-1){6mm}}%
+ \put(3.5em,25mm){\line(1,0){\dimexpr .25\textwidth-6.5em\relax}}%
+ \put(\dimexpr .25\textwidth-3em\relax,25mm){\vector(0,-1){\dimexpr
+ .5\baselineskip + 11mm\relax}}%
+ \put(3em,30mm){\line(1,0){\dimexpr .45\textwidth-7.5em\relax}}%
+ \put(\dimexpr .45\textwidth-4.5em\relax,30mm){\vector(0,-1){\dimexpr
+ .5\baselineskip + 16mm\relax}}%
+ }%
+ \end{picture}
+ }%
+ \thinlines\small\iffree{\color{blue}}{}%
+ \put(0.055\textwidth,45mm){\vector(0,1){25mm}}%
+ \put(0.945\textwidth,45mm){\vector(0,1){25mm}}%
+ \put(0.055\textwidth,45mm){\vector(0,-1){30mm}}%
+ \put(0.945\textwidth,45mm){\vector(0,-1){30mm}}%
+ \put(0.055\textwidth,45mm){\line(1,0){\dimexpr
+ .445\textwidth-7.5em\relax}}%
+ \put(0.945\textwidth,45mm){\line(-1,0){\dimexpr
+ .445\textwidth-7.5em\relax}}%
+ \put(0.5\textwidth,45mm){\makebox(0,0)[c]{\PName{thickness of the inner lines}}}%
+ \iffree{\color{green}}{}%
+ \put(0.025\textwidth,40mm){\line(0,1){35mm}}%
+ \put(0.025\textwidth,75mm){\vector(1,0){3.75mm}}%
+ \put(0.975\textwidth,40mm){\line(0,1){35mm}}%
+ \put(0.975\textwidth,40mm){\line(0,1){35mm}}%
+ \put(0.975\textwidth,75mm){\vector(-1,0){3.75mm}}%
+ \put(0.025\textwidth,40mm){\line(0,-1){30mm}}%
+ \put(0.025\textwidth,10mm){\vector(1,0){3.75mm}}%
+ \put(0.975\textwidth,40mm){\line(0,-1){30mm}}%
+ \put(0.975\textwidth,40mm){\line(0,-1){30mm}}%
+ \put(0.975\textwidth,10mm){\vector(-1,0){3.75mm}}%
+ \put(0.025\textwidth,40mm){\line(1,0){\dimexpr
+ .475\textwidth-7.5em\relax}}%
+ \put(0.975\textwidth,40mm){\line(-1,0){\dimexpr
+ .475\textwidth-7.5em\relax}}%
+ \put(0.5\textwidth,40mm){\makebox(0,0)[c]{\PName{thickness of the outer lines}}}%
+ \end{picture}
+ \caption[{Elements of a three parts page style}]{Schematic double page with
+ the elements of a tripartite page style of commands
+ \Macro{deftriplepagestyle}, \Macro{newtriplepagestyle},
+ \Macro{providetriplepagestyle}, and \Macro{renewtriplepagestyle}}
+ \label{fig:scrlayer-scrpage.triplepagestyle}
+\end{figure}
+
+With the commands that are described here, it is not possible to activate only
+a single line, e.\,g., only below the page head but not above the page
+footer. If you need so, you should either use the commands of the previous or
+the following section.
+
+The length of a single element\textnote{Attention!} is not limited by the
+existence of a neighbour element. So in inappropriate circumstances it can
+happen that one elements overwrites a neighbour element or even both of
+them. The user himself is responsible to avoid such inappropriate cases. With
+automatic running heads this could, e.\,g., be done using the optional
+argument of the section commands. See the manual of the document class for
+more information about those commands.
+
+Command \Macro{deftriplepagestyle} defines a page style independent from
+whether or not a page style with the same \PName{name of the page style}
+already exists. In difference to this \Macro{newtriplepagestyle} and
+\Macro{providetriplepagestyle} define the page style only, if the \PName{name
+ of the page style} is not the name of an already defined page
+style. Otherwise \Macro{providepagestyle} will simply do nothing, but
+\Macro{newtriplepagestyle} would throw an error. Command
+\Macro{renewtriplepagestyle} is something like the opposite of
+\Macro{newtriplepagestyle}. It would throw an error, if there has not been
+a page style with the \PName{name of the page style} before, and defines the
+page style only, if there has been already a page style with the given name.
+
+\BeginIndex{Cmd}{deftripstyle}%
+The command \Macro{deftriplestyle} of \Package{scrpage2} conforms to
+\Macro{deftriplepagestyle}. Because of unification reasons it has been renamed
+and should not be used with it's old name any longer. Using the old name would
+result in a warning message. Nevertheless, the result would be the expected
+one.%
+\EndIndex{Cmd}{deftripstyle}%
+\EndIndex{Cmd}{providetriplepagestyle}%
+\EndIndex{Cmd}{renewtriplepagestyle}%
+\EndIndex{Cmd}{newtriplepagestyle}%
+\EndIndex{Cmd}{deftriplepagestyle}%
+
+
+\section{Definition of Complex Page Styles}
+\label{sec:scrlayer-scrpage.pagestyle.experts}
+
+Beside predefined page styles and the definition of new pairs of page styles,
+and beside the definition of page styles with tripartite head and foot that
+are not recommended any longer, package \Package{scrlayer-scrpage} provides
+also a more basic features to define new page styles. All already described
+page style definitions of \Package{scrlayer-scrpage} use internally these basic
+features. Because of the complexity of this user interface it is recommended
+for advanced users only. Less advanced users should be able to reach almost all
+using one of the previously described features. So less advanced users do not
+need to read this section.
+
+\begin{Declaration}
+ \Macro{defpagestyle}%
+ \Parameter{name}\Parameter{head definition}\Parameter{foot definition}\\
+ \Macro{newpagestyle}%
+ \Parameter{name}\Parameter{head definition}\Parameter{foot definition}\\
+ \Macro{providepagestyle}%
+ \Parameter{name}\Parameter{head definition}\Parameter{foot definition}\\
+ \Macro{renewpagestyle}%
+ \Parameter{name}\Parameter{head definition}\Parameter{foot definition}%
+\end{Declaration}
+\BeginIndex{Cmd}{defpagestyle}%
+\BeginIndex{Cmd}{newpagestyle}%
+\BeginIndex{Cmd}{providepagestyle}%
+\BeginIndex{Cmd}{renewpagestyle}%
+These commands can be used to define a single page style with maximum
+flexibility. Thereby \PName{name} is the name of the page style that should
+be defined.
+
+The arguments \PName{head definition} and \PName{foot definition} have
+identical structure:
+\begin{quote}\raggedright
+ \texttt{%
+ (\PName{length of the line above},\PName{thickness of the line above})\%\\
+ \Parameter{definition for the left page in two-side layout}\%\\
+ \Parameter{definition for the right page in two-side layout}\%\\
+ \Parameter{definition for all pages in one-side laypout}\%\\
+ (\PName{length of the line below},\PName{thickness of the line below})%
+ }
+\end{quote}
+Thereby the arguments in the round brackets are options, this means, you may
+omit them together with the brackets. In that case, the length and thickness
+of the corresponding horizontal line would be given by the \KOMAScript{}
+options \Option{headtopline}, \Option{headsepline}, \Option{footsepline} or
+\Option{footbotline} (see \autoref{sec:scrlayer-scrpage.pagestyle.content},
+\autopageref{desc:scrlayer-scrpage.option.headtopline}).
+
+All three definition arguments are mandatory and will be used depending on the
+page and the layout settings. The contents of the definitions are
+arbitrary. But for page styles with running heads usage of \Macro{headmark},
+\Macro{leftmark}, or \Macro{rightmark} is recommended inside the
+definition. In no case section numbers or section headings should be used in
+the definition. Ignoring this could result in wrong numbers or texts in the
+page head or footer, because of the asynchronous page building of \LaTeX{}.
+
+Command \Macro{defpagestyle} will define the page style independent from
+whether or not a page style with the same \PName{name} already exists. Command
+\Macro{newpagestyle} would throw an error, if such a page style already
+exists. In difference to this, \Macro{providepagestyle} will simple do nothing
+in such a case. In opposite to \Macro{newpagestyle} command
+\Macro{renewpagestyle} would throw the error, if a page style with the
+\PName{name} does not already exist, and therefore may be used to redefine an
+existing page style.
+
+All these commands base on command \Macro{DeclareLayerPageStyle} of package
+\Package{scrlayer} internally. Thereby for a page style \PName{Name} the
+layer \PName{Name}\PValue{.head.above.line} will be defined for the horizontal
+line above the page head, the layer \PName{Name}\PValue{.head.odd} will be
+defined for the page head of odd pages in two-side layout,
+\PName{Name}\PValue{.head.even} will be defined for the page head of even pages
+in two-side layout, \PName{Name}\PValue{.head.oneside} will be defined for the
+page head of all pages in one-side layout, \PName{Name}\PValue{.head.below}
+will be defined for the horizontal line below the page head,
+\PName{Name}\PValue{.foot.above.line} will be defined for the horizontal line
+above the page foot, \PName{Name}\PValue{.foot.odd} will be defined for the
+page foot of odd pages in two-side layout, \PName{Name}\PValue{.foot.even} for
+the page foot of even pages in two-side layout,
+\PName{Name}\PValue{.foot.oneside} for the page foot of all pages in one-side
+layout, and last but not least \PName{Name}\PValue{.foot.below} for the
+horizontal line below the page foot. More information about layers and layer
+page styles can be found from \autopageref{cha:scrlayer} in
+\autoref{cha:scrlayer} also in \autoref{part:forExperts}.%
+%
+\begin{Example}
+ Assume you want to background the whole head of page style
+ \Pagestyle{scrheadings} with a colour. Because you read the introduction to
+ this chapter, you know, that \Pagestyle{scrheadings} last but not least is a
+ layer page style with, e.\,g., layers \PValue{scrheadings.head.even},
+ \PValue{scrheadings.head.odd}, and \PValue{scrheadings.head.oneside}. So you
+ define three more layers for the backgrounds and add them at the very
+ beginning of the page style:
+\begin{lstcode}
+ \documentclass{scrartcl}
+ \usepackage[automark]{scrlayer-scrpage}
+ \usepackage{xcolor}
+ \usepackage{blindtext}
+ \DeclareLayer[clone=scrheadings.head.oneside,
+ contents={%
+ \color{yellow}\rule[-\dp\strutbox]{\layerwidth}{\layerheight}%
+ }%
+ ]{scrheadings.head.oneside.background}
+ \DeclareLayer[clone=scrheadings.head.odd,
+ contents={%
+ \color{yellow}\rule[-\dp\strutbox]{\layerwidth}{\layerheight}%
+ }%
+ ]{scrheadings.head.odd.background}
+ \DeclareLayer[clone=scrheadings.head.even,
+ contents={%
+ \color{yellow}\rule[-\dp\strutbox]{\layerwidth}{\layerheight}%
+ }%
+ ]{scrheadings.head.even.background}
+ \AddLayersAtBeginOfPageStyle{scrheadings}{%
+ scrheadings.head.oneside.background,%
+ scrheadings.head.odd.background,%
+ scrheadings.head.even.background%
+ }
+ \pagestyle{scrheadings}
+ \begin{document}
+ \blinddocument
+ \end{document}
+\end{lstcode}
+ As you can see, the example uses three layers, so the position and size of
+ that background layers may simply be copied from the corresponding head
+ layer using option \Option{clone}. This is much easier than using only one
+ background layer and dynamically calculate the position time by time.
+
+ The coloured background have been printed using a \Macro{rule} command in
+ this example. The size arguments of this \Macro{rule} are given by
+ \Macro{layerwidth} and \Macro{layerheight} which contain the current width
+ and height of the layer itself. The optional argument of \Macro{rule} has
+ been used to move the rule down by the height of a descender.
+\end{Example}
+%
+Instead of using new layers for the background colours like in the example
+above, \Macro{colorbox} and \Macro{chead} could have been used. It is
+recommended to build such a solution as an exercise. Another change could be
+to add the background layers one by one and just before the contents
+layers. You may do this as an exercise too.%
+\EndIndex{Cmd}{renewpagestyle}%
+\EndIndex{Cmd}{providepagestyle}%
+\EndIndex{Cmd}{newpagestyle}%
+\EndIndex{Cmd}{defpagestyle}%
+
+\begin{Declaration}
+ \KOption{hmode}\PValue{simple switch}
+\end{Declaration}
+\BeginIndex{Option}{hmode}%
+Package \Package{scrpage2} outputs page heads and page foots in horizontal
+mode always. In opposite to this \Package{scrlayer-scrpage} does not switch
+into horizontal mode itself, but the output of horizontal material will do
+so. Nevertheless, you can activate option \Option{hmode} to make
+\Package{scrlayer-scrpage} more compatible with \Package{scrpage2} in this
+aspect. But this would have implications to, i.\,e., white
+spaces at the start of the output or the vertical alignment of the output.
+
+The options knows the standard values for simple switches that are given at
+\autoref{tab:truefalseswitch} on \autopageref{tab:truefalseswitch}. The option
+is deactivated by default.%
+\EndIndex{Option}{hmode}%
+%
+\EndIndex{Package}{scrlayer-scrpage}%
+
+%%% Local Variables:
+%%% mode: latex
+%%% mode: flyspell
+%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
+%%% TeX-master: "../guide"
+%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex
new file mode 100644
index 00000000000..34d3a727741
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex
@@ -0,0 +1,1128 @@
+% ======================================================================
+% scrlayer-scrpage.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% This file is part of the LaTeX2e KOMA-Script bundle.
+%
+% This work may be distributed and/or modified under the conditions of
+% the LaTeX Project Public License, version 1.3c of the license.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later and of this work.
+%
+% This work has the LPPL maintenance status "author-maintained".
+%
+% The Current Maintainer and author of this work is Markus Kohm.
+%
+% This work consists of all files listed in manifest.txt.
+% ----------------------------------------------------------------------
+% scrlayer-scrpage.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
+% Version 1.3c, verteilt und/oder veraendert werden.
+% Die neuste Version dieser Lizenz ist
+% http://www.latex-project.org/lppl.txt
+% und Version 1.3c ist Teil aller Verteilungen von LaTeX
+% Version 2005/12/01 oder spaeter und dieses Werks.
+%
+% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
+% (allein durch den Autor verwaltet).
+%
+% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
+%
+% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
+% ======================================================================
+%
+% Chapter about scrlayer-scrpage of the KOMA-Script guide
+%
+% ----------------------------------------------------------------------
+%
+% Kapitel ueber scrlayer-scrpage in der KOMA-Script-Anleitung
+%
+% ============================================================================
+
+\KOMAProvidesFile{scrlayer-scrpage.tex}%
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrlayer-scrpage)]
+\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}
+
+% Date version of the translated file: 2013-11-15
+
+\chapter[{Adapting Page Headers and Footers with \Package{scrlayer-scrpage}}]
+ {Adapting\ChangedAt{v3.12}{\Package{scrlayer-scrpage}} Page Headers and
+ Footers with \Package{scrlayer-scrpage}}
+\labelbase{scrlayer-scrpage}
+%
+\BeginIndex{Package}{scrlayer-scrpage}%
+
+Until version 3.11b of \KOMAScript, package \Package{scrpage2} has been the
+recommended way to customise page headers and footers beyond the options
+provided by the page styles \Pagestyle{headings}, \Pagestyle{myheadings},
+\Pagestyle{plain}, and \Pagestyle{empty} of the standard \KOMAScript{}
+classes. Until 2001 there was also package \Package{scrpage} as a supported
+solution for the same purpose. It was then made obsolete and in 2013, more
+than ten years later, it was finally removed from the regular
+\KOMAScript~distribution.
+
+In 2013 package \Package{scrlayer}\IndexPackage{scrlayer} became a basic
+module of \KOMAScript. That package provides a layer scheme and a new page
+style scheme based upon the layer scheme. Nevertheless, the flexibility it
+provides and the resulting complexity may be too demanding for the average
+user to handle. More about \Package{scrlayer} may be found in
+\autoref{cha:scrlayer} of \autoref{part:forExperts}. Potential problems with
+the controllability of \Package{scrlayer} apart, there are lots of users who
+are already familiar with the user interface of package \Package{scrpage2}.
+
+As a consequence the additional package \Package{scrlayer-scrpage} provides a
+user interface, which is largely compatible with \Package{scrpage2} and based
+on \Package{scrlayer}. Thus, if you are already familiar with \Package{scrpage2}
+and refrain from using dirty tricks, like calling internal commands of
+\Package{scrpage2} directly, it should be easy for you to use
+\Package{scrlayer-scrpage} as a drop-in replacement. Most examples covering
+\Package{scrpage2} in \LaTeX{} books or online resources should also work
+with \Package{scrlayer-scrpage} either directly or with only minor
+code changes provided that they stick to the standard interfaces.
+
+Apart from the aforementioned \KOMAScript{} packages, you could in principle
+also use \Package{fancyhdr}\IndexPackage{fancyhdr} (see
+\cite{package:fancyhdr}) in conjunction with a \KOMAScript{} class. However,
+\Package{fancyhdr}\ has no support for several \KOMAScript{} features, e.\,g.,
+the element scheme (see \Macro{setkomafont}, \Macro{addtokomafont}, and
+\Macro{usekomafont} in \autoref{sec:maincls.textmarkup}, from
+\autopageref{desc:maincls.cmd.setkomafont}) or the configurable numbering
+format for dynamic headers (see option \Option{numbers} and, e.\,g.,
+\Macro{chaptermarkformat} in \autoref{sec:maincls.structure},
+\autopageref{desc:maincls.option.numbers} and
+\autopageref{desc:maincls.cmd.chaptermarkformat}). Hence, if you are using a
+\KOMAScript{} class, the usage of package \Package{scrlayer-scrpage} is
+recommended. Of course you can use \Package{scrlayer-scrpage} with other
+classes, namely the \LaTeX{} standard classes, too.
+
+Besides the features described in this chapter, \Package{scrlayer-scrpage}
+provides several more that are likely only of minor interest to the average
+user and for this reason are described from
+\autopageref{cha:scrlayer-scrpage-experts} onwards in
+\autoref{cha:scrlayer-scrpage-experts} of \autoref{part:forExperts}.
+Nevertheless, should the options described in \autoref{part:forAuthors} be
+insufficient for your purposes you are encouraged to examine
+\autoref{cha:scrlayer-scrpage-experts}.
+
+\LoadCommon{0} % \section{Early or late Selection of Options}
+
+\LoadCommon{20} % \section{Head and Foot Width}
+
+\section{Usage of Predefined Page Styles}
+\label{sec:scrlayer-scrpage.predefined.pagestyles}
+
+The easiest way to get a requested design of page head and foot with
+\Package{scrlayer-scrpage} is the usage of a predefined page style.
+
+\begin{Declaration}
+ \Pagestyle{scrheadings}\\
+ \Pagestyle{plain.scrheadings}
+\end{Declaration}
+\BeginIndex{Pagestyle}{scrheadings}%
+\BeginIndex{Pagestyle}{plain.scrheadings}%
+Package \Package{scrlayer-scrpage} provides two page styles that may be
+reconfigured depending on your own requests. Let's first of all talk about
+page style \Pagestyle{scrheadings} which has been designed to be used with
+running heads. Its defaults are similar to the page style
+\Pagestyle{headings}\IndexPagestyle{headings} of \LaTeX's standard classes or
+the \KOMAScript{} classes. The commands and options that may be used to
+configure the exact contents of the header and footer will be described
+consecutively.
+
+Second there's page style \Pagestyle{plain.scrheadings} which has been
+designed to be used without any running head. Its defaults are very similar to
+page style \Pagestyle{plain}\IndexPagestyle{plain} of \LaTeX's standard
+classes or the \KOMAScript{} classes. Once more the commands and options that
+may be used to configure the exact contents of the header and footer will be
+described consecutively.
+
+Fore sure, you could configure \Pagestyle{scrheadings} to be a page style
+without a running head and \Pagestyle{plain.scrheadings} to be a page style
+with running heads. Nevertheless, it is more useful to fit the conventions
+declared above, mainly, because both page styles influence each other. If you
+select one of these page styles, \Pagestyle{scrheadings} will become
+accessible as \Pagestyle{headings} and the page style
+\Pagestyle{plain.scrheadings} will become accessible as \Pagestyle{plain}. So,
+if you have a class or package that automatically switches between
+\Pagestyle{headings} and \Pagestyle{plain}, you need to select
+\Pagestyle{scrheadings} or \Pagestyle{plain.scrheadings} only once and then
+the class or package will switch between \Pagestyle{scrheadings} and
+\Pagestyle{plain.scrheadings} without even knowing these page styles. Patches
+or other adaptions of classes (or packages) will not be necessary. So these page
+styles are something like a pair that may be used as a drop-in replacement
+for \Pagestyle{headings} and \Pagestyle{plain}.
+
+At this point I'd like to mention that for compatibility with
+\Package{scrpage2} page style \Pagestyle{plain.scrheadings} can also be used
+with the alias name \Pagestyle{scrplain}\IndexPagestyle[indexmain]{scrplain}.
+%
+\EndIndex{Pagestyle}{plain.scrheadings}%
+\EndIndex{Pagestyle}{scrheadings}%
+
+\begin{Declaration}
+ \Macro{lehead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{cehead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{rehead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{lohead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{cohead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{rohead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}
+\end{Declaration}
+\BeginIndex{Cmd}{lehead}%
+\BeginIndex{Cmd}{cehead}%
+\BeginIndex{Cmd}{rehead}%
+\BeginIndex{Cmd}{lohead}%
+\BeginIndex{Cmd}{cohead}%
+\BeginIndex{Cmd}{rohead}%
+The contents of the header of page style \Pagestyle{plain.scrheadings} and
+\Pagestyle{scrheadings} can be defined using these commands. Thereby the
+optional argument defines the content of an element of page style
+\Pagestyle{plain.scrheadings}, while the mandatory argument sets the content
+of the corresponding element of page style \Pagestyle{scrheadings}.
+
+Contents of left\,---\,so called even\,---\,pages can be set with
+\Macro{lehead}, \Macro{cehead}, and \Macro{rohead}. Remark: The ``\texttt{e}''
+at the second position of the commands' names means ``\emph{even}''.
+
+Contents of right\,---\,so called odd\,---\,pages can be set with
+\Macro{lohead}, \Macro{cohead}, and \Macro{rohead}. Remark: The ``\texttt{o}''
+at the second position of the commands' names means ``\emph{odd}''.
+
+Please note\textnote{Attention!} that there are only odd pages within single
+side layouts independent of whether or not they have an odd page number.
+
+Each header consists of a left aligned element that will be defined by
+\Macro{lehead} respectively \Macro{lohead}. Remark: The ``\texttt{l}'' at the
+first position of the commands' names means ``\emph{left aligned}''.
+
+Similarly each header has a centred element that will be defined by
+\Macro{cehead} respectively \Macro{cohead}. Remark: The ``\texttt{c}'' at the
+first position of the command' names means ``\emph{centred}''.
+
+Similarly each header has a right aligned element that will be defined by
+\Macro{rehead} respectively \Macro{rohead}. Remark: The ``\texttt{r}'' at the
+first position of the commands' names means ``\emph{right aligned}''.
+
+\BeginIndex{FontElement}{pagehead}%
+\BeginIndex{FontElement}{pageheadfoot}%
+However, these elements do not have their own font attributes that may be
+changed using commands \Macro{setkomafont} and \Macro{addtokomafont} (see
+\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}),
+but are grouped in an element named \FontElement{pagehead}. And before the
+font of that element additionally the font of element
+\FontElement{pageheadfoot} will be used. See
+\autoref{tab:scrlayer-scrpage.fontelements} for the font default of these
+elements.%
+\EndIndex{FontElement}{pageheadfoot}%
+\EndIndex{FontElement}{pagehead}%
+
+\begin{desclist}
+ \desccaption[{Elements of \Package{scrlayer-scrpage} whose type style can be
+ changed with \KOMAScript{} command \Macro{setkomafont} or
+ \Macro{addtokomafont}}]%
+ {Elements of \Package{scrlayer-scrpage} whose type style can be changed with
+ \KOMAScript{} command \Macro{setkomafont} or \Macro{addtokomafont} and the
+ default of those, if they have not been defined before loading
+ \Package{scrlayer-scrpage}%
+ \label{tab:scrlayer-scrpage.fontelements}%
+ }%
+ {Elements whose type style can be changed (\emph{continuation})}%
+ \feentry{footbotline}{%
+ Horizontal line below the footer of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont} and the fonts of elements
+ \FontElement{pageheadfoot}\IndexFontElement{pageheadfoot} and
+ \FontElement{pagefoot}\FontElement{pagefoot}. It is recommended to use
+ this element for colour changes only.\par
+ Default: \emph{empty}%
+ }%
+ \feentry{footsepline}{%
+ Horizontal line above the footer of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont} and the fonts of elements
+ \FontElement{pageheadfoot}\IndexFontElement{pageheadfoot} and
+ \FontElement{pagefoot}\FontElement{pagefoot}. It is recommended to use
+ this element for colour changes only.\par
+ Default: \emph{empty}%
+ }%
+ \feentry{headsepline}{%
+ Horizontal line below the header of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont} and the fonts of elements
+ \FontElement{pageheadfoot}\IndexFontElement{pageheadfoot} and
+ \FontElement{pagehead}\FontElement{pagehead}. It is recommended to use
+ this element for colour changes only.\par
+ Default: \emph{empty}%
+ }%
+ \feentry{headtopline}{%
+ Horizontal line above the header of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont} and the fonts of elements
+ \FontElement{pageheadfoot}\IndexFontElement{pageheadfoot} and
+ \FontElement{pagehead}\FontElement{pagehead}. It is recommended to use
+ this element for colour changes only.\par
+ Default: \emph{empty}%
+ }%
+ \feentry{pagefoot}{%
+ Contents of the page footer of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont} and the font of element
+ \FontElement{pageheadfoot}\IndexFontElement{pageheadfoot}.\par
+ Default: \emph{empty}%
+ }%
+ \feentry{pagehead}{%
+ Contents of the page header of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont} and the font of element
+ \FontElement{pageheadfoot}\IndexFontElement{pageheadfoot}.\par
+ Default: \emph{empty}%
+ }%
+ \feentry{pageheadfoot}{%
+ Contents of the page header or footer of a page style defined using
+ \Package{scrlayer-scrpage}. The font will be used after
+ \Macro{normalfont}\IndexCmd{normalfont}.\par
+ Default: \Macro{normalcolor}\Macro{slshape}%
+ }%
+ \feentry{pagenumber}{%
+ Pagination set with \Macro{pagemark}. If you redefine \Macro{pagemark},
+ you have to take care that your redefinition also uses
+ \Macro{usekomafont}\PParameter{pagenumber}!\par
+ Default: \Macro{normalfont}%
+ }%
+\end{desclist}
+%
+The semantics of the described commands within two-sided layouts are also
+sketched in \autoref{fig:scrlayer-scrpage.head}.%
+%
+\begin{figure}[tp]
+ \centering
+ \begin{picture}(\textwidth,30mm)(0,-10mm)
+ \thinlines
+ \small\ttfamily
+ % left/even page
+ \put(0,20mm){\line(1,0){.49\textwidth}}%
+ \put(0,0){\line(0,1){20mm}}%
+ \multiput(0,0)(0,-1mm){10}{\line(0,-1){.5mm}}%
+ \put(.49\textwidth,5mm){\line(0,1){15mm}}%
+ \put(.05\textwidth,10mm){%
+ \iffree{\color{red}}{}%
+ \put(-.5em,0){\line(1,0){4em}}%
+ \multiput(3.5em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \put(-.5em,0){\line(0,1){\baselineskip}}%
+ \put(-.5em,\baselineskip){\line(1,0){4em}}%
+ \multiput(3.5em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \makebox(4em,5mm)[l]{\Macro{lehead}}%
+ }%
+ \put(.465\textwidth,10mm){%
+ \iffree{\color{blue}}{}%
+ \put(-4em,0){\line(1,0){4em}}%
+ \multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(0,0){\line(0,1){\baselineskip}}%
+ \put(-4em,\baselineskip){\line(1,0){4em}}%
+ \multiput(-4em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{rehead}}}%
+ }%
+ \put(.2525\textwidth,10mm){%
+ \iffree{\color{green}}{}%
+ \put(-2em,0){\line(1,0){4em}}%
+ \multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,\baselineskip){\line(1,0){4em}}%
+ \multiput(2em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,0){\makebox(4em,5mm)[c]{\Macro{cehead}}}%
+ }%
+ % right/odd page
+ \put(.51\textwidth,20mm){\line(1,0){.49\textwidth}}%
+ \put(.51\textwidth,5mm){\line(0,1){15mm}}%
+ \put(\textwidth,0){\line(0,1){20mm}}%
+ \multiput(\textwidth,0)(0,-1mm){10}{\line(0,-1){.5mm}}%
+ \put(.5325\textwidth,10mm){%
+ \iffree{\color{blue}}{}%
+ \put(0,0){\line(1,0){4em}}%
+ \multiput(4em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \put(0,0){\line(0,1){\baselineskip}}%
+ \put(0em,\baselineskip){\line(1,0){4em}}%
+ \multiput(4em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \put(.5em,0){\makebox(4em,5mm)[l]{\Macro{lohead}}}%
+ }%
+ \put(.965\textwidth,10mm){%
+ \iffree{\color{red}}{}%
+ \put(-4em,0){\line(1,0){4em}}%
+ \multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(0,0){\line(0,1){\baselineskip}}%
+ \put(-4em,\baselineskip){\line(1,0){4em}}%
+ \multiput(-4em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{rohead}}}%
+ }%
+ \put(.75\textwidth,10mm){%
+ \iffree{\color{green}}{}%
+ \put(-2em,0){\line(1,0){4em}}%
+ \multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,\baselineskip){\line(1,0){4em}}%
+ \multiput(2em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,0){\makebox(4em,5mm)[c]{\Macro{cohead}}}%
+ }%
+ % commands for both pages
+ \iffree{\color{blue}}{}%
+ \put(.5\textwidth,0){\makebox(0,\baselineskip)[c]{\Macro{ihead}}}%
+ \iffree{\color{green}}{}%
+ \put(.5\textwidth,-5mm){\makebox(0,\baselineskip)[c]{\Macro{chead}}}
+ \iffree{\color{red}}{}%
+ \put(.5\textwidth,-10mm){\makebox(0,\baselineskip)[c]{\Macro{ohead}}}
+ \put(\dimexpr.5\textwidth-2em,.5\baselineskip){%
+ \iffree{\color{blue}}{}%
+ \put(0,0){\line(-1,0){1.5em}}%
+ \put(-1.5em,0){\vector(0,1){5mm}}%
+ \iffree{\color{green}}{}%
+ \put(0,-1.25\baselineskip){\line(-1,0){\dimexpr .25\textwidth-2em\relax}}%
+ \put(-\dimexpr
+ .25\textwidth-2em\relax,-1.25\baselineskip){\vector(0,1){\dimexpr
+ 5mm+1.25\baselineskip\relax}}
+ \iffree{\color{red}}{}%
+ \put(0,-2.5\baselineskip){\line(-1,0){\dimexpr .45\textwidth-4em\relax}}%
+ \put(-\dimexpr
+ .45\textwidth-4em\relax,-2.5\baselineskip){\vector(0,1){\dimexpr
+ 5mm+2.5\baselineskip\relax}}
+ }%
+ \put(\dimexpr.5\textwidth+2em,.5\baselineskip){%
+ \iffree{\color{blue}}{}%
+ \put(0,0){\line(1,0){1.5em}}%
+ \put(1.5em,0){\vector(0,1){5mm}}%
+ \iffree{\color{green}}{}%
+ \put(0,-1.25\baselineskip){\line(1,0){\dimexpr .25\textwidth-2em\relax}}
+ \put(\dimexpr
+ .25\textwidth-2em\relax,-1.25\baselineskip){\vector(0,1){\dimexpr
+ 5mm+1.25\baselineskip\relax}}
+ \iffree{\color{red}}{}%
+ \put(0,-2.5\baselineskip){\line(1,0){\dimexpr .45\textwidth-4em\relax}}
+ \put(\dimexpr
+ .45\textwidth-4em\relax,-2.5\baselineskip){\vector(0,1){\dimexpr
+ 5mm+2.5\baselineskip\relax}}
+ }%
+ \end{picture}
+ \caption[Commands to define the page head]%
+ {The meaning of the commands to define the contents of the page head
+ of the page styles sketched on a schematic double page}
+ \label{fig:scrlayer-scrpage.head}
+\end{figure}
+%
+\begin{Example}
+ Assume you're writing a short article and you want the title of that
+ article to be shown left aligned and the author's name to be
+ shown right aligned at the page head. You may for example use:
+\begin{lstcode}
+ \documentclass{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \lohead{John Doe}
+ \rohead{Page style with \KOMAScript}
+ \pagestyle{scrheadings}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \end{document}
+\end{lstcode}
+ But what happens: On the first page there's only a page number at the page
+ foot, but the header is empty!
+
+ The explanation is very easy. Document class \Class{scrartcl} switches to
+ page style \Pagestyle{plain} for the page with the title head. After command
+ \Macro{pagestyle}\PParameter{scrheadings} in the preamble of the short
+ document this will actually result in page style
+ \Pagestyle{plain.scrheadings}. Using a \KOMAScript{} class the default of
+ this page style is an empty page header and a page number in the footer. In
+ the example code the optional arguments of \Macro{lohead} and \Macro{rohead}
+ are omitted. So page style \Pagestyle{plain.scrheadings} remains
+ unchanged as default and the result for the first page is indeed correct.
+
+ Please add some text below \Macro{maketitle} until a second page will be
+ printed. Alternatively you may just add
+ \Macro{usepackage}\PParameter{lipsum}\IndexPackage{lipsum} into the document
+ preamble and \Macro{lipsum}\IndexCmd{lipsum} below \Macro{maketitle}. You
+ will see that the head of the second page will show the author and the
+ document title as we wanted.
+
+ To see the difference you should also add an optional argument to
+ \Macro{lohead} and \Macro{rohead} containing some content. To do so, change
+ the example above:
+ \begin{lstcode}
+ \documentclass{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \lohead[John Doe]
+ {John Doe}
+ \rohead[Page style with \KOMAScript]
+ {Page style with \KOMAScript}
+ \pagestyle{scrheadings}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \end{document}
+\end{lstcode}
+ Now, you also get a page header above the title head of the first
+ page. That is because you have reconfigured page style
+ \Pagestyle{plain.scrheadings} with the two optional arguments. Most of you
+ will also recognise that it would be better to leave this page style
+ unchanged, because the running head above the document title is certainly
+ annoying.
+\end{Example}
+
+Allow me an important note:\textnote{Attention!} You should never put a
+section heading or section number directly into the page head using a new
+declaration by one of these commands. This could result in a wrong number or
+heading text in the running head, because of the asynchronous page generation
+and output of \TeX. Instead you should use the mark mechanism and ideally you
+should use it together with the automatism described in the following
+section.%
+\EndIndex{Cmd}{rohead}%
+\EndIndex{Cmd}{cohead}%
+\EndIndex{Cmd}{lohead}%
+\EndIndex{Cmd}{rehead}%
+\EndIndex{Cmd}{cehead}%
+\EndIndex{Cmd}{lehead}%
+
+\begin{Declaration}
+ \Macro{lefoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{cefoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{refoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{lofoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{cofoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{rofoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}
+\end{Declaration}
+\BeginIndex{Cmd}{lefoot}%
+\BeginIndex{Cmd}{cefoot}%
+\BeginIndex{Cmd}{refoot}%
+\BeginIndex{Cmd}{lofoot}%
+\BeginIndex{Cmd}{cofoot}%
+\BeginIndex{Cmd}{rofoot}%
+The contents of the footer of page style \Pagestyle{plain.scrheadings} and
+\Pagestyle{scrheadings} can be defined using these commands. Thereby the
+optional argument defines the content of an element of page style
+\Pagestyle{plain.scrheadings}, while the mandatory argument sets the content
+of the corresponding element of page style \Pagestyle{scrheadings}.
+
+Contents of left\,---\,so called even\,---\,pages can be set with
+\Macro{lefoot}, \Macro{cefoot}, and \Macro{rohead}. Remark: The ``\texttt{e}''
+at the second position of the commands' names means ``\emph{even}''.
+
+Contents of odd pages can be set with \Macro{lofoot}, \Macro{cofoot}, and
+\Macro{rofoot}. Remark: The ``\texttt{o}'' at the second position of the
+commands' names means ``\emph{odd}''.
+
+Please note\textnote{Attention!} that there are only odd pages within single
+side layouts independent of whether or not they have an odd page number.
+
+Each footer consists of a left aligned element that will be defined by
+\Macro{lefoot} respectively \Macro{lofoot}. Remark: The ``\texttt{l}'' at the
+first position of the commands' names means ``\emph{left aligned}''.
+
+Similarly each footer has a centred element that will be defined by
+\Macro{cefoot} respectively \Macro{cofoot}. Remark: The ``\texttt{c}'' at the
+first position of the command' names means ``\emph{centred}''.
+
+Similarly each footer has a right aligned element that will be defined by
+\Macro{refoot} respectively \Macro{rofoot}. Remark: The ``\texttt{r}'' at the
+first position of the commands' names means ``\emph{right aligned}''.
+
+\BeginIndex{FontElement}{pagefoot}%
+\BeginIndex{FontElement}{pageheadfoot}%
+However, these elements do not have their own font attributes that may be
+changed using commands \Macro{setkomafont} and \Macro{addtokomafont} (see
+\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}),
+but are grouped in an element named \FontElement{pagefoot}. And before the
+font of that element additionally the font of element
+\FontElement{pageheadfoot} will be used. See
+\autoref{tab:scrlayer-scrpage.fontelements} for the defaults of the fonts of
+these elements.%
+\EndIndex{FontElement}{pageheadfoot}%
+\EndIndex{FontElement}{pagefoot}%
+
+The semantics of the described commands within two-sided layouts are also
+sketched in \autoref{fig:scrlayer-scrpage.foot}.%
+%
+\begin{figure}[bp]
+ \centering
+ \begin{picture}(\textwidth,30mm)
+ \thinlines
+ \small\ttfamily
+ % left page
+ \put(0,0){\line(1,0){.49\textwidth}}%
+ \put(0,0){\line(0,1){20mm}}%
+ \multiput(0,20mm)(0,1mm){10}{\line(0,1){.5mm}}%
+ \put(.49\textwidth,0){\line(0,1){15mm}}%
+ \put(.05\textwidth,5mm){%
+ \iffree{\color{red}}{}%
+ \put(-.5em,0){\line(1,0){4em}}%
+ \multiput(3.5em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \put(-.5em,0){\line(0,1){\baselineskip}}%
+ \put(-.5em,\baselineskip){\line(1,0){4em}}%
+ \multiput(3.5em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \makebox(4em,5mm)[l]{\Macro{lefoot}}%
+ }%
+ \put(.465\textwidth,5mm){%
+ \iffree{\color{blue}}{}%
+ \put(-4em,0){\line(1,0){4em}}%
+ \multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(0,0){\line(0,1){\baselineskip}}%
+ \put(-4em,\baselineskip){\line(1,0){4em}}%
+ \multiput(-4em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{refoot}}}%
+ }%
+ \put(.2525\textwidth,5mm){%
+ \iffree{\color{green}}{}%
+ \put(-2em,0){\line(1,0){4em}}%
+ \multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,\baselineskip){\line(1,0){4em}}%
+ \multiput(2em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,0){\makebox(4em,5mm)[c]{\Macro{cefoot}}}%
+ }%
+ % right page
+ \put(.51\textwidth,0){\line(1,0){.49\textwidth}}%
+ \put(.51\textwidth,0){\line(0,1){15mm}}%
+ \put(\textwidth,0){\line(0,1){20mm}}%
+ \multiput(\textwidth,20mm)(0,1mm){10}{\line(0,1){.5mm}}%
+ \put(.5325\textwidth,5mm){%
+ \iffree{\color{blue}}{}%
+ \put(0,0){\line(1,0){4em}}%
+ \multiput(4em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \put(0,0){\line(0,1){\baselineskip}}%
+ \put(0em,\baselineskip){\line(1,0){4em}}%
+ \multiput(4em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \put(.5em,0){\makebox(4em,5mm)[l]{\Macro{lofoot}}}%
+ }%
+ \put(.965\textwidth,5mm){%
+ \iffree{\color{red}}{}%
+ \put(-4em,0){\line(1,0){4em}}%
+ \multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(0,0){\line(0,1){\baselineskip}}%
+ \put(-4em,\baselineskip){\line(1,0){4em}}%
+ \multiput(-4em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{rofoot}}}%
+ }%
+ \put(.75\textwidth,5mm){%
+ \iffree{\color{green}}{}%
+ \put(-2em,0){\line(1,0){4em}}%
+ \multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,\baselineskip){\line(1,0){4em}}%
+ \multiput(2em,\baselineskip)(.25em,0){5}{\line(1,0){.125em}}%
+ \multiput(-2em,\baselineskip)(-.25em,0){5}{\line(1,0){.125em}}%
+ \put(-2em,0){\makebox(4em,5mm)[c]{\Macro{cofoot}}}%
+ }%
+ % both pages
+ \iffree{\color{blue}}{}%
+ \put(.5\textwidth,15mm){\makebox(0,\baselineskip)[c]{\Macro{ifoot}}}%
+ \iffree{\color{green}}{}%
+ \put(.5\textwidth,20mm){\makebox(0,\baselineskip)[c]{\Macro{cfoot}}}
+ \iffree{\color{red}}{}%
+ \put(.5\textwidth,25mm){\makebox(0,\baselineskip)[c]{\Macro{ofoot}}}
+ \put(\dimexpr.5\textwidth-2em,.5\baselineskip){%
+ \iffree{\color{blue}}{}%
+ \put(0,15mm){\line(-1,0){1.5em}}%
+ \put(-1.5em,15mm){\vector(0,-1){5mm}}%
+ \iffree{\color{green}}{}%
+ \put(0,20mm){\line(-1,0){\dimexpr .25\textwidth-2em\relax}}%
+ \put(-\dimexpr .25\textwidth-2em\relax,20mm){\vector(0,-1){10mm}}%
+ \iffree{\color{red}}{}%
+ \put(0,25mm){\line(-1,0){\dimexpr .45\textwidth-4em\relax}}%
+ \put(-\dimexpr .45\textwidth-4em\relax,25mm){\vector(0,-1){15mm}}%
+ }%
+ \put(\dimexpr.5\textwidth+2em,.5\baselineskip){%
+ \iffree{\color{blue}}{}%
+ \put(0,15mm){\line(1,0){1.5em}}%
+ \put(1.5em,15mm){\vector(0,-1){5mm}}%
+ \iffree{\color{green}}{}%
+ \put(0,20mm){\line(1,0){\dimexpr .25\textwidth-2em\relax}}%
+ \put(\dimexpr .25\textwidth-2em\relax,20mm){\vector(0,-1){10mm}}%
+ \iffree{\color{red}}{}%
+ \put(0,25mm){\line(1,0){\dimexpr .45\textwidth-4em\relax}}%
+ \put(\dimexpr .45\textwidth-4em\relax,25mm){\vector(0,-1){15mm}}%
+ }%
+ \end{picture}
+ \caption[Commands to define the page footer]%
+ {The meaning of the commands to define the contents of the page
+ footer of the page styles sketched on a schematic double page}%
+ \label{fig:scrlayer-scrpage.foot}
+\end{figure}
+%
+\begin{Example}
+ Let's return to the example of the short article. Assuming you want to print
+ the publisher at the left side of the page footer, you would change the
+ example above into:
+\begin{lstcode}
+ \documentclass{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \lohead{John Doe}
+ \rohead{Page style with \KOMAScript}
+ \lofoot{Smart Alec Publishing}
+ \pagestyle{scrheadings}
+ \usepackage{lipsum}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \lipsum
+ \end{document}
+\end{lstcode}
+ Once again the publisher is not printed on the first page with the title
+ head. For the reason see the explanation about \Macro{lohead} in the example
+ above. And again the solution to print the publisher on the first page would
+ be similar:
+\begin{lstcode}
+ \lofoot[Smart Alec Publishing]
+ {Smart Alec Publishing}
+\end{lstcode}
+ But now you also want to replace the slanted font used in page head and
+ footer by a upright smaller font. This may be done using:
+\begin{lstcode}
+ \setkomafont{pageheadfoot}{\small}
+\end{lstcode}
+ Furthermore, the head but not the footer should be bold:
+\begin{lstcode}
+ \setkomafont{pagehead}{\bfseries}
+\end{lstcode}
+ For the last command it is important to have it just after
+ \Package{scrpage-scrlayer} has been loaded, because
+ the \KOMAScript{} class already defines \FontElement{pagehead} and
+ \FontElement{pageheadfoot} but with the same meaning. Only loading
+ \Package{scrpage-scrlayer} changes the meaning of \FontElement{pagehead} and
+ makes it an element independent of \FontElement{pageheadfoot}.
+
+ Now, please add one more \Macro{lipsum} and add option \Option{twoside} to
+ the loading of \Class{scrartcl}. First of all, you will see the page number
+ moving from the middle of the page footer to the outer margin, due to the
+ changed defaults of \Pagestyle{scrheadings} and
+ \Pagestyle{plain.scrheadings} using double-sided layout and a \KOMAScript{}
+ class.
+
+ Simultaneously the author, document title and publisher will vanish from
+ page~2. It only appears on page~3. This is a consequence of using only
+ commands for odd pages. You can recognise this by the ``\texttt{o}'' on the
+ second position of the commands' names.
+
+ Now, we could simply copy those commands and replace the ``\texttt{o}'' by
+ an ``\texttt{e}'' to define the contents of \emph{even} pages. But with
+ double sided layout it makes more sense to use mirror-inverted elements. So
+ the left element of an odd page should become the right element of the even
+ page and visa versa. To achieve this, we also replace the first letter
+ ``\texttt{l}'' by ``\texttt{r}'':
+\begin{lstcode}
+ \documentclass[twoside]{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \lohead{John Doe}
+ \rohead{Page style with \KOMAScript}
+ \lofoot[Smart Alec Publishing]
+ {Smart Alec Publishing}
+ \rehead{John Doe}
+ \lohead{Page style with \KOMAScript}
+ \refoot[Smart Alec Publishing]
+ {Smart Alec Publishing}
+ \pagestyle{scrheadings}
+ \usepackage{lipsum}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \lipsum\lipsum
+ \end{document}
+\end{lstcode}
+\end{Example}
+%
+After reading the example it may appear to you that it is somehow
+uncomfortable to duplicate commands to have the same contents on mirror
+positions of the page header or footer of a double page. Therefore you will
+learn to know an easier solution for this standard case next.
+
+Before allow me an important note:\textnote{Attention!} You should never put a
+section heading or section number directly into the page's footer using a new
+declaration by one of these commands. This could result in a wrong number or
+heading text in the running footer, because of the asynchronous page
+generation and output of \TeX. Instead you should use the mark mechanism
+ideally together with the automatism described in the following section.%
+\EndIndex{Cmd}{rofoot}%
+\EndIndex{Cmd}{cofoot}%
+\EndIndex{Cmd}{lofoot}%
+\EndIndex{Cmd}{refoot}%
+\EndIndex{Cmd}{cefoot}%
+\EndIndex{Cmd}{lefoot}%
+
+\begin{Declaration}
+ \Macro{ohead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{chead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{ihead}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{ofoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{cfoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}\\
+ \Macro{ifoot}\OParameter{plain.scrheadings's content}%
+ \Parameter{scrheadings's content}
+\end{Declaration}
+\BeginIndex{Cmd}{ohead}%
+\BeginIndex{Cmd}{chead}%
+\BeginIndex{Cmd}{ihead}%
+\BeginIndex{Cmd}{ofoot}%
+\BeginIndex{Cmd}{cfoot}%
+\BeginIndex{Cmd}{ifoot}%
+To define the contents of page headers and footers of odd and the even pages
+of a double-sided layout using the commands described before, you would have to
+define the contents of the even page different from the contents of the odd
+page. But in general the pages should be symmetric. An element, that should be
+printed left aligned on an even page, should be right aligned on an odd page
+and vise versa. Elements, that are centred on odd pages, should be centred on
+even pages too.
+
+To simplify the definition of such symmetric page styles,
+\Package{scrlayer-scrpage} provides a kind of abbreviation. Command
+\Macro{ohead} is same like usage of both \Macro{lehead} and
+\Macro{rohead}. Command \Macro{chead} is same like \Macro{cehead} and
+\Macro{cohead}. And command \Macro{ihead} is same like \Macro{rehead} and
+\Macro{lohead}. The corresponding commands for the page footer are defined
+accordingly. A sketch of these commands can be found also in
+\autoref{fig:scrlayer-scrpage.head} on \autopageref{fig:scrlayer-scrpage.head}
+and \autoref{fig:scrlayer-scrpage.foot} on
+\autopageref{fig:scrlayer-scrpage.foot} together with the relationships of all
+the page header and footer commands.
+%
+\begin{Example}
+ You can simplify the example before using the new commands:
+\begin{lstcode}
+ \documentclass[twoside]{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \ihead{John Doe}
+ \ohead{Page style with \KOMAScript}
+ \ifoot[Smart Alec Publishing]
+ {Smart Alec Publishing}
+ \pagestyle{scrheadings}
+ \usepackage{lipsum}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \lipsum\lipsum
+ \end{document}
+\end{lstcode}
+ As you can see, you can spare half of the commands but get the same result.
+\end{Example}
+%
+In single-sided layouts all pages are odd pages. So in LaTeX's single-sided
+mode these commands are synonymous for the odd page commands. Therefore in
+most cases you will only need these six commands instead of the twelve
+described before.
+
+Once again, allow me an important note:\textnote{Attention!} You should never
+put a section heading or section number directly into the page head or
+page foot using a new declaration by one of these commands. This could result in
+a wrong number or heading text in the running header or footer, because of the
+asynchronous page generation and output of \TeX. Instead you should use the
+mark mechanism ideally together with the automatism described in the following
+section.%
+\EndIndex{Cmd}{ihead}%
+\EndIndex{Cmd}{chead}%
+\EndIndex{Cmd}{ohead}%
+\EndIndex{Cmd}{ifoot}%
+\EndIndex{Cmd}{cfoot}%
+\EndIndex{Cmd}{ofoot}%
+
+
+\begin{Declaration}
+ \KOption{pagestyleset}\PName{setting}
+\end{Declaration}
+\BeginIndex{Option}{pagestyleset~=KOMA-Script}%
+\BeginIndex{Option}{pagestyleset~=standard}%
+In the examples above you can already find some information about the defaults
+of \Pagestyle{scrheadings}\IndexPagestyle{scrheadings} and
+\Pagestyle{plain.scrheadings}\IndexPagestyle{plain.scrheadings}. Indeed
+\Package{scrlayer-scrpage} provides two different defaults yet. You may select
+one of those defaults manually using option \Option{pagestyleset}.
+
+If \PName{setting} is \PValue{KOMA-Script} the defaults will be used that
+would also be activated automatically if a \KOMAScript{} class has been
+detected. In this case and within double-sided layout \Pagestyle{scrheadings}
+uses running heads outer aligned in the page head. The page number will be
+printed outer aligned in the page footer. Within single-sided layout the
+running head will be printed in the middle of the page head and the page
+number in the middle of the page footer. Upper and lower case will be used for
+the automatic running head as given by the words you have typed. This would be
+same like using Option
+\OptionValue{markcase}{used}\IndexOption{markcase~=used}. Pagestyle
+\Pagestyle{plain.scrheadings} has not got running heads, but the page numbers
+will be printed in the same manner.
+
+If \PName{setting} is \PValue{standard} the defaults will be used that are
+similar to page style \Pagestyle{headings} and \Pagestyle{plain} of the
+standard classes. This \PName{setting} will also be activated automatically
+if the option has not been used and \KOMAScript{} class cannot be
+detected. Within double-sided layout thereby \Pagestyle{scrheadings} uses
+running heads aligned inner in the page head and the page numbers will be
+printed\,---\,also in the page head\,---\,aligned outer. Within single-sided
+layout \Pagestyle{scrheadings} is the same. But because of single side layout
+knows only odd pages, the running head will be aligned left always and the
+page number will be aligned right. In spite of typographic objection, the
+automatic running head will be converted into upper cases like they would
+using \OptionValue{markcase}{upper}\IndexOption{markcase~=upper}. Within
+single side layout page style \Pagestyle{plain.scrheadings} differs a lot from
+\Pagestyle{scrheading}, because the page number will be printed in the middle
+of the page footer. Using double side layout page style
+\Pagestyle{plain.scrheadings} differs from standard classes'
+\Pagestyle{plain}. The standard classes would print the page number in the
+middle of the page footer. But this would not harmonise with the
+\Pagestyle{scrheadings}, so \Pagestyle{plain.scrheadings} does not print a page
+number. But like \Pagestyle{plain} it does not print a running head.
+
+Please note\textnote{Attention!} that together with this option page style
+\Pagestyle{scrheadings} will be activated. This will be also the case, if you
+use the option inside the document.
+
+\BeginIndex{Option}{komastyle}%
+\BeginIndex{Option}{standardstyle}%
+Options \Option{komastyle} and \Option{standardstyle}, provided by
+\Package{scrpage}, are defined only for compatibility reasons in
+\Package{scrlayer-scrpage}. But they are implemented using option
+\Option{pagestyleset}. They are deprecated and you should not use them.%
+%
+\EndIndex{Option}{standardstyle}%
+\EndIndex{Option}{komastyle}%
+\EndIndex{Option}{pagestyleset~=standard}%
+\EndIndex{Option}{pagestyleset~=KOMA-Script}%
+
+\LoadCommon{21} % \section{Manipulation of Defined Page Styles}
+
+\begin{Declaration}
+ \KOption{headwidth}\PName{width\textup{:}offset}\\
+ \KOption{footwidth}\PName{width\textup{:}offset}
+\end{Declaration}
+\BeginIndex{Option}{headwidth~=\PName{offset\textup{:}width}}%
+\BeginIndex{Option}{footwidth~=\PName{offset\textup{:}width}}%
+By default the page head\Index{head>width} and foot\Index{foot>width} are as
+wide as the type area. This can be changed using these \KOMAScript{}
+options. The value \PName{width} is the wanted width of the head respective
+foot. The \PName{offset} defines how much the head or foot should be moved
+towards the outer\,---\,in single side layout to the right\,---\,margin. Both
+values are optional and can be omitted. If you omit both values, you can also
+omit the colon. If you only use one value without colon, this will be the
+\PName{width}.
+
+For the \PName{width} as well as the \PName{offset} you can use any valid
+length value, \LaTeX{} length, \TeX{} dimension or \TeX{} skip. In addition
+you may use an \eTeX{} dimension expression with basic arithmetic operations
+\texttt{+}, \texttt{-}, \texttt{*}, \texttt{/}, and parenthesis. See
+\cite[section~3.5]{manual:eTeX} for more information on such expressions. See
+\autoref{sec:scrlayer-scrpage.options} for more information on using,
+e.\,g., a \LaTeX{} length as an option value. The \PName{width} can
+alternatively be one of the symbolic values shown in
+\autoref{tab:scrlayer-scrpage.symbolic.values}.
+
+By default the head and the foot are as wide as the text area. The default
+\PName{offset} depends on the used \PName{width}. In single side layout
+generally the half of the difference of \PName{width} and the width of the
+text area will be used. This results in horizontal centring the page head
+above or the page footer below the text area. In difference to this, in double
+side layout generally a third of the difference of \PName{offset} and the
+width of the text area will be used. But if \PName{width} is the width of the
+whole text area plus the marginal note column, default \PName{offset} will be
+zero. If you think, this is complicated, you should simply use an explicit
+\PName{offset}.
+%
+\begin{table}
+ \centering
+ \caption[Symbolic values for options \Option{headwidth} and
+ \Option{footwidth}]{Possible symbolic values for the \PName{width} value of
+ options \Option{headwidth} and \Option{footwidth}}
+ \label{tab:scrlayer-scrpage.symbolic.values}
+ \begin{desctabular}
+ \ventry{foot}{%
+ the current width of the page foot%
+ }%
+ \ventry{footbotline}{%
+ the current length of the horizontal line below the page foot%
+ }%
+ \ventry{footsepline}{%
+ the current length of the horizontal line above the page foot%
+ } \ventry{head}{%
+ the current width of the page head%
+ }%
+ \ventry{headsepline}{%
+ the current length of the horizontal line below the page head%
+ }%
+ \ventry{headtopline}{%
+ the current lenght of the horizontal line above the page head%
+ }%
+ \ventry{marginpar}{%
+ the current width of the marginal note column including the distance
+ between the text area and the marginal note column%
+ }%
+ \ventry{page}{%
+ the current width of the page considering a binding correction of
+ package \Package{typearea} (see option \Option{BCOR} in
+ \autoref{sec:typearea.typearea},
+ \autopageref{desc:typearea.option.BCOR})%
+ }%
+ \ventry{paper}{%
+ the current width of the paper without considering a binding correction%
+ }%
+ \ventry{text}{%
+ the current width of the text area%
+ }%
+ \ventry{textwithmarginpar}{%
+ the current width of the text area plus the marginal note column
+ including the distance between them (note: in this case and only in this
+ case the default of \PName{offset} would be zero)%
+ }%
+ \end{desctabular}
+\end{table}
+%
+\EndIndex{Option}{footwidth~=\PName{offset\textup{:}width}}%
+\EndIndex{Option}{headwidth~=\PName{offset\textup{:}width}}%
+
+\begin{Declaration}
+ \KOption{headtopline}\PName{thickness\textup{:}length}\\
+ \KOption{headsepline}\PName{thickness\textup{:}length}\\
+ \KOption{footsepline}\PName{thickness\textup{:}length}\\
+ \KOption{footbotline}\PName{thickness\textup{:}length}
+\end{Declaration}
+\BeginIndex{Option}{headtopline~=\PName{thickness\textup{:}length}}%
+\BeginIndex{Option}{headsepline~=\PName{thickness\textup{:}length}}%
+\BeginIndex{Option}{footsepline~=\PName{thickness\textup{:}length}}%
+\BeginIndex{Option}{footbotline~=\PName{thickness\textup{:}length}}%
+The \KOMAScript{} classes provide only a separation line below the page head
+and above the page head, and you may only switch each of these lines on or
+off. But package \Package{scrlayer-scrpage} provides four such horizontal
+lines: one above the head, one below the head, one above the foot, and one
+below the foot. And you can not only switch them on an off, but also configure
+the \PName{length} and \PName{thickness} of each of these lines.
+
+Both values are optional. If you omit the \PName{thickness}, a default value
+of 0.4\Unit{pt} will be used, a so called \emph{hairline}. If you omit the
+\PName{length}, the width of the head respective the foot will be used. If you
+omit both, you can also omit the colon. If you use only one value without
+colon, this will be the \PName{thickness}.
+
+For sure, the \PName{length} can be not only shorter than the current width of
+the page head respectively the page foot, but also longer. See additionally
+options \Option{ilines}\IndexOption{ilines},
+\Option{clines}\IndexOption{clines}, and \Option{olines}\IndexOption{olines}
+later in this section.
+
+\BeginIndex{FontElement}{headtopline}%
+\BeginIndex{FontElement}{headsepline}%
+\BeginIndex{FontElement}{footsepline}%
+\BeginIndex{FontElement}{footbotline}%
+Beside the length and thickness also the colour of the lines can be
+changed. First of all the colour depends on the colour of the head or
+foot. But independent from those or additional to them the settings of the
+corresponding elements \FontElement{headtopline}, \FontElement{headsepline},
+\FontElement{footsepline}, and \FontElement{footbotline} will be used. You may
+change these using command \Macro{setkomafont} or \Macro{addtokomafont} (see
+\autoref{sec:maincls.textmarkup} from
+\autopageref{desc:maincls.cmd.setkomafont}). By default those settings are
+empty, which means no change of the current font or colour. Change of font in
+opposite to colour would not make sense and is not recommended for these
+elements.%
+\EndIndex{FontElement}{footbotline}%
+\EndIndex{FontElement}{footsepline}%
+\EndIndex{FontElement}{headsepline}%
+\EndIndex{FontElement}{headtopline}%
+
+\BeginIndex{Cmd}{setheadtopline}%
+\BeginIndex{Cmd}{setheadseoline}%
+\BeginIndex{Cmd}{setfootsepline}%
+\BeginIndex{Cmd}{setfootbotline}%
+Package \Package{scrpage2} has additionally to the options that do not take
+any values, also four commands
+\Macro{setheadtopline}\IndexCmd[indexmain]{setheadtopline},
+\Macro{setheadsepline}\IndexCmd[indexmain]{setheadsepline},
+\Macro{setfootsepline}\IndexCmd[indexmain]{setfootsepline}, and
+\Macro{setfootbotline}\IndexCmd[indexmain]{setfootbotline}. These have a first
+optional argument for the \PName{length}, a second mandatory argument for the
+\PName{thickness}, and a third optional argument for the setting of font or
+colour. Package \Package{scrlayer-scrpage} does also provide those
+commands. Nevertheless, these commands are deprecated and should not be used
+any longer. To get it clear: These commands have never been made to
+switch the lines on or off. They have been made to configure already switched
+on lines. Users often ignored this!%
+\EndIndex{Cmd}{setfootbotline}%
+\EndIndex{Cmd}{setfootsepline}%
+\EndIndex{Cmd}{setheadseoline}%
+\EndIndex{Cmd}{setheadtopline}%
+%
+\EndIndex{Option}{footbotline~=\PName{thickness\textup{:}length}}%
+\EndIndex{Option}{footsepline~=\PName{thickness\textup{:}length}}%
+\EndIndex{Option}{headsepline~=\PName{thickness\textup{:}length}}%
+\EndIndex{Option}{headtopline~=\PName{thickness\textup{:}length}}%
+
+
+\begin{Declaration}
+ \KOption{plainheadtopline}\PName{simple switch}\\
+ \KOption{plainheadsepline}\PName{simple switch}\\
+ \KOption{plainfootsepline}\PName{simple switch}\\
+ \KOption{plainfootbotline}\PName{simple switch}
+\end{Declaration}
+\BeginIndex{Option}{plainheadtopline~=\PName{simple switch}}%
+\BeginIndex{Option}{plainheadsepline~=\PName{simple switch}}%
+\BeginIndex{Option}{plainfootsepline~=\PName{simple switch}}%
+\BeginIndex{Option}{plainfootbotline~=\PName{simple switch}}%
+These options can be used to inherit the settings of the lines also for the
+\Pagestyle{plain} page style. Possible values for \PName{simple switch} can be
+found in \autoref{tab:truefalseswitch} on
+\autopageref{tab:truefalseswitch}. If a option is activated, the
+\Pagestyle{plain} page style will use the line settings given by the options
+and commands described above. If the option is deactivated, the
+\Pagestyle{plain} will not show the corresponding line.%
+\EndIndex{Option}{plainfootbotline~=\PName{simple switch}}%
+\EndIndex{Option}{plainfootsepline~=\PName{simple switch}}%
+\EndIndex{Option}{plainheadsepline~=\PName{simple switch}}%
+\EndIndex{Option}{plainheadtopline~=\PName{simple switch}}%
+
+\begin{Declaration}
+ \Option{ilines}\\
+ \Option{clines}\\
+ \Option{olines}
+\end{Declaration}
+\BeginIndex{Option}{ilines}%
+\BeginIndex{Option}{clines}%
+\BeginIndex{Option}{olines}%
+You have already been told that the horizontal lines above or below the page
+head or foot can be shorter or longer than the page head or page foot
+itself. Only the answer to the question about the alignment of those lines is
+still missing. By default all lines are left aligned at single side layout and
+aligned to the inner margin of the head or foot at double side layout. This
+is same like using option \Option{ilines}. Alternatively, you can use option
+\Option{clines} to centre the lines in the head or foot, or option
+\Option{olines} to align them right respectively to the outer margin.%
+\EndIndex{Option}{olines}%
+\EndIndex{Option}{clines}%
+\EndIndex{Option}{ilines}%
+%
+\EndIndex{Package}{scrlayer-scrpage}%
+
+%%% Local Variables:
+%%% mode: latex
+%%% mode: flyspell
+%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
+%%% TeX-master: "../guide"
+%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex
new file mode 100644
index 00000000000..2e413bf8d7d
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex
@@ -0,0 +1,1242 @@
+% ======================================================================
+% scrlayer.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% This file is part of the LaTeX2e KOMA-Script bundle.
+%
+% This work may be distributed and/or modified under the conditions of
+% the LaTeX Project Public License, version 1.3c of the license.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later and of this work.
+%
+% This work has the LPPL maintenance status "author-maintained".
+%
+% The Current Maintainer and author of this work is Markus Kohm.
+%
+% This work consists of all files listed in manifest.txt.
+% ----------------------------------------------------------------------
+% scrlayer.tex
+% Copyright (c) Markus Kohm, 2013
+%
+% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
+% Version 1.3c, verteilt und/oder veraendert werden.
+% Die neuste Version dieser Lizenz ist
+% http://www.latex-project.org/lppl.txt
+% und Version 1.3c ist Teil aller Verteilungen von LaTeX
+% Version 2005/12/01 oder spaeter und dieses Werks.
+%
+% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
+% (allein durch den Autor verwaltet).
+%
+% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
+%
+% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
+% ======================================================================
+%
+% Chapter about scrlayer of the KOMA-Script guide
+% Maintained by Markus Kohm
+%
+% ----------------------------------------------------------------------
+%
+% Kapitel ueber scrlayer in der KOMA-Script-Anleitung
+% Verwaltet von Markus Kohm
+%
+% ============================================================================
+
+\KOMAProvidesFile{scrlayer.tex}
+ [$Date: 2013-12-13 17:39:21 +0100 (Fr, 13 Dez 2013) $
+ KOMA-Script guide (chapter:scrlayer)]
+
+\translator{Markus Kohm}
+
+% Date of the translated file: 2013-10-31
+
+\chapter[{Defining Layers and Page Styles Using \Package{scrlayer}}]%
+{Defining Layers and Page Styles Using \Package{scrlayer}%
+}
+\labelbase{scrlayer}
+
+\BeginIndex{Package}{scrlayer}
+
+Most users of graphics software already know layer models for pages or working
+sheets. \LaTeX{} itself does not know layers, but there are already packages
+like \Package{eso-pic} or \Package{textpos}, that provide a kind of
+background or foreground layer. \Package{scrlayer} is another package,
+that provides such background and foreground layers, but in difference
+to the other packages mentioned above these layers are part of the
+page style definition. With this you may simply switch between usage
+of layers by switching the page style.
+
+To do so, the package also supports a low level interface to define page
+styles using a layer stack, to put layers onto a page style's layer stack, to
+put layers at the lowest position of a page style's layer stack, to put layers
+before or after a layer of a page style's layer stack, to remove a layer from
+a page style's layer stack and to remove doublets of layers of a page style's
+layer stack. In short words: The page style interface of \Package{scrlayer}
+provides commands to define layer-stack-based page styles and to manage those
+layer stacks.
+
+Nevertheless, using the layers directly is recommended for advanced users only.
+End user interfaces for beginners or average users are provided by additional
+packages, that load \Package{scrlayer} on their own. See
+\autoref{cha:scrlayer-scrpage} in \autoref{part:forAuthors} of this
+\iffree{manual}{book}.
+
+\section{State of Development Note}
+\label{sec:scrlayer.draft}
+
+Development of this package has not been finished yet. Parts of the package
+are even still experimental. Because of this, especially internal
+functionality may be changed in future. Most likely the package will be
+extended. And because of the early state of development, you should not expect
+a complete and finished user manual. Nevertheless, this manual, which is
+recommended for advanced users and developers, describes the current state of
+development and the released parts of \Package{scrlayer}. Everything, not
+documented here, should not be used for anything else but testing.
+
+\LoadCommon{0} % \section{Early or Late Selection of Options}
+
+\section{Some Generic Information}
+\label{sec:scrlayer.generic}
+
+The package needs some generic information about the class. Class authors may
+help \Package{scrlayer} by setting this information. Otherwise the package tries
+to detect the information itself. This works, e.g., for the standard classes
+and the \KOMAScript{} classes. But it may or may not fail with other classes.
+
+This section describes some of the information, that class authors may
+provide. Generally users need not to care about this.
+
+\begin{Declaration}
+ \Macro{if@chapter}\ \PName{then code} \Macro{else}\ \PName{else code}
+ \Macro{fi}%
+\end{Declaration}
+\BeginIndex{Cmd}{if@chapter}%
+If \Macro{if@chapter} is \Macro{iftrue}, \Package{scrlayer} will additionally
+consider the chapter level, e.g., processing option \Option{automark}. If it
+is defined, but differs from \Macro{iftrue}, only part, section, subsection,
+sub\dots subsection, paragraph, subparagraph, sub\dots subparagraph will be
+considered. If the macro is not defined, \Package{scrlayer} searches for
+\Macro{chapter}. If \Macro{chapter} is defined and not \Macro{relax},
+\Package{scrlayer} will define \Macro{if@chapter} to \Macro{iftrue}, otherwise
+\Macro{if@chapter} will become \Macro{iffalse}.%
+\EndIndex{Cmd}{if@chapter}
+
+\begin{Declaration}
+ \Macro{if@mainmatter}\ \PName{then code} \Macro{else}\ \PName{else code}
+ \Macro{fi}%
+\end{Declaration}
+\BeginIndex{Cmd}{if@mainmatter}%
+Classes like \Class{book} define \Macro{frontmatter}, \Macro{mainmatter}, and
+\Macro{backmatter}. They also use \Macro{if@mainmatter} to distinguish whether
+or not the current matter is the main matter. Classes like \Class{report} and
+\Class{article} do not have \Macro{frontmatter}, \Macro{mainmatter}, or
+\Macro{backmatter} and therefore also do not have \Macro{if@mainmatter}.
+
+For \Package{scrlayer} it's easier not to test always for the existence of the
+matter commands, but to use \Macro{if@mainmatter} even with classes like
+\Class{report} and \Class{article}, simply set to \Macro{iftrue}. So if
+\Macro{if@mainmatter} is not defined, it will be defined to \Macro{iftrue}.
+
+Some classes have \Macro{frontmatter}, \Macro{mainmatter}, or
+\Macro{backmatter} but not \Macro{if@mainmatter}. In this case
+\Package{scrlayer} also defines \Macro{if@mainmatter} to be \Macro{iftrue}
+and it extends definition of \Macro{frontmatter}, \Macro{mainmatter}, and
+\Macro{backmatter} to set \Macro{if@mainmatter} properly. Other matter
+commands are not known, not tested, and not extended. So if there are other
+matter commands \Package{scrlayer} needs help of the class author to set
+\Macro{if@mainmatter} correctly.%
+\EndIndex{Cmd}{if@mainmatter}
+
+\begin{Declaration}
+ \Macro{DeclareSectionNumberDepth}%^^A
+ \Parameter{level name}\Parameter{level depth}
+\end{Declaration}
+\BeginIndex{Cmd}{DeclareSectionNumberDepth}%
+Generally each section level is related to an integer number indicating its
+depth in the document structure. \LaTeX{} needs this to manage hierarchic
+section levels. But normally only the document class, that defines the section
+commands, itself knows that \PName{level depth} of a section level and uses
+these numerical values inside the corresponding commands, when needed.
+
+But \Package{scrlayer} also needs information about the section hierarchy.
+With command \Macro{DeclareSectionNumberDepth} you can map
+the name of a heading level to a \PName{level depth}. With standard class
+book, e.g., the \PName{level name} could be \PValue{part}, \PValue{chapter},
+\PValue{section}, \PValue{subsection}, \PValue{subsubsection},
+\PValue{paragraph}, or \PValue{subparagraph} and the corresponding
+\PName{level depth}s would be -1, 0, 1, 2, 3, 4, and 5.
+
+Package \Package{scrlayer} tries to determine the \PName{level depth}s on its
+own while loading and again while \Macro{begin}\PParameter{document}. But, if
+it fails, i.\,e., if completely different section commands are used, it would
+be useful, to be able to define the relationship explicitly. For such cases
+\Macro{DeclareSectionNumberDepth} gives the class author the opportunity to
+define the relationship explicitly.%
+\EndIndex{Cmd}{DeclareSectionNumberDepth}
+
+\section{Declaration of Layers}
+\label{sec:scrlayer.layers}
+
+A layer is a kind of virtual sheet of transparent paper (in opposite to a
+physical sheet of paper). One layer is stacked onto another layer and opaque
+material on one layer may hide material on the layers below. The stack of all
+layers together makes the physical page. Package \Package{scrlayer}
+provides two such layer stacks for each page: a background layer stack and a
+foreground layer stack. The background layer stack is behind the normal page
+contents, the foreground layer stack is above the normal page contents. So the
+normal contents is a kind of a separating layer between the background layer
+stack and the foreground layer stack.
+
+A layer has several attributes. The first attribute states, whether or not the
+layer is part of the foreground or the background. During page building
+background layers will be printed first, followed by the main contents and the
+foreground layers. Therefore, in the output the background layers show up
+behind the main contents and the foreground layers in front of the main
+contents. By default, a layer is both, a background layer \emph{and} a
+foreground layer and therefore will be printed twice.
+
+The horizontal position of the layer is set by the second attribute, the
+vertical position by the third. The forth and fifth attributes determine the
+horizontal and vertical size of the layer. As you can see, a layer may be
+smaller or larger than the paper.
+
+But having two numerical values of the second and third attribute does not
+directly give us the position of the layer on the page. For each dimension we
+need two reference points, one on the page and one on the layer. The
+numerical value than states the distance between these reference.
+Reference points in layouts are also known as alignment and are set by the
+sixth attribute.
+
+The seventh attribute states, whether or not a layer should be
+printed onto left or right pages. By default a layer will be printed on both,
+left and right pages. Note, that \LaTeX{} names left pages as even pages and
+right pages as odd pages and that there are no left or even pages in
+single-sided mode.
+
+The eighth attribute states, whether or not a layer should be printed in
+single-side mode or in two-side mode. By default a layer will be printed in
+both, single-side mode and two-side mode. Nevertheless, an even page layer will
+never be printed in single-side mode and therefore is not really a two-side
+mode layer.
+
+The ninth attribute is, whether or not a layer should be printed onto float
+pages or non-float pages. \LaTeX{} produces float pages for float environments
+like tables or figures, if they are allowed to be printed on a page without
+normal page contents (see option \PValue{p} for \Environment{figure} or
+\Environment{table}). So from some point of view a float page is a page, that
+may itself flow. Non-float pages are not pages without floats, but pages, that
+are not float pages. They may contain floats inside the text, on the top of
+the page, or on the bottom of the page. Very large floats may seem to be page
+floats, while in reality they are top floats.
+
+The tenth and last attribute is the contents of the layer. This is simply,
+what should be printed, whenever the layer will be printed.
+
+So we have ten attributes yet. Below in this manual we will describe
+additional attributes. However, they are just defined for convenience and can
+be expressed by a combination of the ten attributes stated above. We call
+these ten attributes the primary attributes.
+
+\begin{Declaration}
+ \Macro{DeclareLayer}\OParameter{option list}\Parameter{layer name}\\
+ \Macro{DeclareNewLayer}\OParameter{option list}\Parameter{layer name}\\
+ \Macro{ProvideLayer}\OParameter{option list}\Parameter{layer name}\\
+ \Macro{RedeclareLayer}\OParameter{option list}\Parameter{layer name}\\
+ \Macro{ModifyLayer}\OParameter{option list}\Parameter{layer name}
+\end{Declaration}
+\BeginIndex{Cmd}{DeclareLayer}%
+\BeginIndex{Cmd}{DeclareNewLayer}%
+\BeginIndex{Cmd}{ProvideLayer}%
+\BeginIndex{Cmd}{RedeclareLayer}%
+\BeginIndex{Cmd}{ModifyLayer}%
+These commands can be used to define a layer. The \PName{layer name} has to be
+fully expandable and should expand to letters only. Some additional characters
+are tolerated, but are not recommended.
+
+Command \Macro{DeclareLayer} does not care whether or not a layer with the
+given \PName{layer name} already exists. It will under all circumstances
+define the layer with the attribute defined by the \PName{option list}.
+An
+\PName{option} can be either a key or a key followed by an
+equal sign followed by a value. Several options may be concatenated to
+a \PName{option list} and have to be separated by comma. If you'd like to have
+a comma or a white space inside the value of an option, you should put the
+value inside curly brackets. See \autoref{tab:scrlayer.layerkeys} for
+more information on keys, values, and the corresponding
+attributes.
+
+In contrast to \Macro{DeclareLayer} using \Macro{DeclareNewLayer} results in
+an error, if a layer with the same \PName{layer name} already exists. So you
+may prevent yourself using the same \PName{layer name} more than once by
+mistake. This would be useful, e.\,g., if a class or package also defines
+layers internally.
+
+If you use \Macro{ProvideLayer} instead of \Macro{DeclareLayer}, the
+declaration will be ignored in case a layer with the same layer name already
+exists. It could be paraphrased by: \emph{declare the layer only, if it has not
+ been declared already.}
+
+If an existing layer should be redefined, \Macro{RedeclareLayer} or
+\Macro{ModifyLayer} can be used. \Macro{RedeclareLayer} would simply define
+the layer as if it would be defined newly. In difference to this,
+\Macro{ModifyLayer} would change only those attributes, that are represented
+by an option of the \PName{option list}. All other attributes will stay
+unchanged and will not be reset to the initial default value. Using either
+\Macro{RedeclareLayer} or \Macro{ModifyLayer} will result in an error, in case
+there has not been a layer with \PName{layer name} defined before.
+
+\begin{desclist}
+ \desccaption{%
+ Options for the definition of page layers with description of the
+ corresponding layer attribute\label{tab:scrlayer.layerkeys}%
+ }{%
+ Options for the definition of layers (\emph{Continuation})%
+ }%
+ \nentry{\KOption{align}{\PName{alignment characters}}}{%
+ The \PName{alignment characters} define the desired alignment of the
+ layer. Each \PName{alignment character} influences either, how argument
+ \PName{length} of option \Option{hoffset} or \Option{voffset} will be
+ used. Several \PName{alignment characters} may be used together (without
+ comma or space) and will be interpreted in the order of occurrence. No
+ macros should be used here! Valid \PName{alignment character}s are:
+ \begin{description}
+ \item[\PValue{b} --] align the layer at its bottom edge; the
+ value of
+ \Option{voffset} is interpreted as the distance from the top edge of the
+ paper to the bottom edge of the layer.
+ \item[\PValue{c} --] align the layer at its centre; the values of
+ \Option{voffset} and \Option{hoffset} are interpreted as the distance
+ from the top left corner of the paper to the centre of the layer.
+ \item[\PValue{l} --] align the layer at its left edge: the value of
+ \Option{hoffset} is interpreted as the distance from the left edge of
+ the paper to the left edge of the layer.
+ \item[\PValue{r} --] align the layer at its right edge; the value of
+ \Option{hoffset} is interpreted as the distance from the left edge of
+ the paper to the right edge of the layer.
+ \item[\PValue{t} --] align the layer at its top edge; the value of
+ \Option{voffset} is interpreted as the distance from the top edge of the
+ paper to the top edge of the layer.
+ \end{description}%
+ }%
+ \nentry{\KOption{area}{%^^A
+ \Parameter{hoffset}\Parameter{voffset}%^^A
+ \Parameter{width}\Parameter{height}}}{%
+ The composed option results in \OptionValue{hoffset}{\PName{hoffset}},
+ \OptionValue{voffset}{\PName{voffset}},
+ \OptionValue{width}{\PName{width}}, \OptionValue{height}{\PName{height}}.%
+ }%
+ \entry{\Option{background}}{%
+ Print the layer only in the background, but not in the foreground. This
+ makes a background-only layer in opposite to the default of layers which
+ are both, background and foreground layers and therefore would be printed
+ twice. The option does not expect any value. By the default the attribute
+ is not set.%
+ }%
+ \entry{\Option{bottommargin}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the paper from the left edge to the right and vertically span the area
+ below the footer down to the bottom edge of the paper.%
+ }%
+ \nentry{\KOption{clone}{\PName{layer name}}}{%
+ The composed option sets all primary attributes of the layer to the same
+ values as the primary attributes of the layer with the given \PName{layer
+ name}. Note, that \PName{layer name} has to be fully expandable and
+ should expand to letters only. Some additional characters are tolerated,
+ but are not recommended!%
+ }%
+ \nentry{\KOption{contents}{\PName{code}}}{%
+ The \PName{code} will be expanded whenever the layer is printed. So the
+ \PName{code} is what you will see. Code validity is not checked. So errors
+ in \PName{code} may result in several failures on each page, that prints
+ the layer.%
+ }%
+ \entry{\Option{evenpage}}{%
+ Print the layer on even pages only, but not on odd pages. The option does
+ not expect any value. By the default the option is not set and therefore
+ layers would be printed on odd pages and on even pages. Note, that this
+ attribute subsumes \Option{twoside}.%
+ }%
+ \entry{\Option{floatpage}}{%
+ Print the layer on float pages only, but not on other pages. The option
+ does not expect any value. By the default the attribute is not set and
+ therefore layers would be printed on float pages and on non-float pages.%
+ }%
+ \entry{\Option{foot}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the text area and vertically span the page footer defined by the new
+ \LaTeX{} length \Length{footheight}.%
+ }%
+ \entry{\Option{footskip}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the text area and vertically span the distance between the text area and
+ the page footer (note, that this is not the same like \Length{footskip}).%
+ }%
+ \entry{\Option{foreground}}{%
+ Print the layer only in the foreground, but not in the background. This
+ makes a foreground-only layer in opposite to the default of layers which
+ are both, background and foreground layers and therefore would be printed
+ twice. The option does not expect any value. By the default the attribute
+ is not set.%
+ }%
+ \entry{\Option{head}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the text area and vertically span the page head defined by usual \LaTeX{}
+ length \Length{headheight}.%
+ }%
+ \entry{\Option{headsep}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the text area and vertically span the distance between the page head and
+ the text area.%
+ }%
+ \nentry{\KOption{height}{\PName{length}}}{%
+ Sets the height of the layer. Note, that \PName{length} can either be a
+ \LaTeX{} length, declared using \Macro{newlength}, or a \TeX{} length,
+ declared using \Macro{newdimen} or \Macro{newskip}, a length value like
+ 10\,pt, or a dimensional expression using +, -, /, *, (, and ). For more
+ information about valid dimensional expressions see
+ \cite[section~3.5]{manual:eTeX}.%
+ }%
+ \nentry{\KOption{hoffset}{\PName{length}}}{%
+ Sets the offset of the layer (depending on \Option{align} either left edge
+ of the layer, middle of the layer or right edge of the layer) from the
+ left edge of the paper. See \Option{height} for more information about
+ valid content of \PName{length}.%
+ }%
+ \entry{\Option{innermargin}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the distance between the right edge of text area and the right edge of the
+ paper on even pages or the distance between the left edge of the paper and
+ the left edge of the text area on odd pages and vertically span the whole
+ paper from the top edge to the bottom edge.%
+ }%
+ \entry{\Option{leftmargin}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the distance between the left edge of the paper and the left edge of the
+ text area and vertically span the whole paper from the top edge to the
+ bottom edge.%
+ }%
+ \entry{\Option{nonfloatpage}}{%
+ Restricts the layer to pages, that are not float pages. The option does
+ not expect any value. By the default the attribute is not set and
+ therefore layers would be printed on float pages and on non-float pages.%
+ }%
+ \entry{\Option{oddpage}}{%
+ Print the layer on odd pages only, but not on even pages. The option does
+ not expect any value. By the default the option is not set and therefore
+ layers would be printed on odd pages and on even pages.%
+ }%
+ \entry{\Option{oneside}}{%
+ Print the layer in single-side mode only, but not in two-side mode. The
+ option does not expect any value. By the default the attribute is not set
+ and therefore layers would be printed in single-side and two-side mode.%
+ }%
+ \entry{\Option{outermargin}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the distance between the left edge of the paper and the left edge of the
+ text area on even pages or the distance between the right edge of the text
+ area and the right edge of the paper on odd pages and vertically span the
+ whole paper from the top edge to the bottom edge.%
+ }%
+ \entry{\Option{page}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally and
+ vertically span the whole paper from the left edge to the right edge and
+ the top edge to the bottom edge.%
+ }%
+ \entry{\Option{rightmargin}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the distance between the right edge of text area and the right edge of the
+ paper and vertically span the whole paper from the top edge to the bottom
+ edge.%
+ }%
+ \entry{\Option{textarea}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally and
+ vertically span the whole text area from the left edge to the right edge
+ and the top edge to the bottom edge.%
+ }%
+ \entry{\Option{topmargin}}{%
+ The composed option sets \Option{hoffset}, \Option{voffset},
+ \Option{width}, \Option{height}, and \Option{align} to horizontally span
+ the whole page from the left edge to the right edge and vertically span
+ the distance between the top edge of the paper and the page head.%
+ }%
+ \entry{\Option{twoside}}{%
+ Print the layer in two-side mode only, but not in single-side mode. The
+ option does not expect any value. By the default the attribute is not set
+ and therefore layers would be printed in single-side and two-side mode.%
+ }%
+ \nentry{\KOption{voffset}{\PName{length}}}{%
+ Sets the offset of the layer (depending on \Option{align} either top edge
+ of the layer, middle of the layer or bottom edge of the layer) from the
+ top edge of the paper. See \Option{height} for more information about
+ valid content of \PName{length}.%
+ }%
+ \nentry{\KOption{width}{\PName{length}}}{%
+ Sets the width of the layer. See \Option{height} for more information
+ about valid content of \PName{length}.%
+ }%
+\end{desclist}
+%
+\EndIndex{Cmd}{ModifyLayer}%
+\EndIndex{Cmd}{RedeclareLayer}%
+\EndIndex{Cmd}{ProvideLayer}%
+\EndIndex{Cmd}{DeclareNewLayer}%
+\EndIndex{Cmd}{DeclareLayer}%
+
+\begin{Declaration}
+ \Macro{layerxoffset}\\
+ \Macro{layeryoffset}\\
+ \Macro{layerwidth}\\
+ \Macro{layerheight}%
+\end{Declaration}
+\BeginIndex{Cmd}{layerxoffset}%
+\BeginIndex{Cmd}{layeryoffset}%
+\BeginIndex{Cmd}{layerwidth}%
+\BeginIndex{Cmd}{layerheight}%
+These commands are valid during output of the layer's contents only. So they
+can only be used inside the \PName{code} of option \Option{contents} of the
+previously described commands. In this case they give the effective position
+and dimension of the layer, that will be used for the output. However, the
+effective dimension of the layer's contents may differ, i.\,e., if the
+contents are oversized or do not fill the layer completely. Redefinition of
+the commands to change the stored values is strictly forbidden and would
+result in unpredictable issues.%
+\EndIndex{Cmd}{layerheight}%
+\EndIndex{Cmd}{layerwidth}%
+\EndIndex{Cmd}{layeryoffset}%
+\EndIndex{Cmd}{layerxoffset}%
+
+\begin{Declaration}
+ \Macro{IfLayerExists}%
+ \Parameter{string}\Parameter{then-code}\Parameter{else-code}
+\end{Declaration}
+\BeginIndex{Cmd}{IfLayerExists}%
+This command may be used to execute code depending on whether or not a layer
+has been defined already. If the layer exists \PName{then-code} will be
+executed, otherwise \PName{else-code}. Note, the command cannot really
+test whether a layer exists. It uses a heuristic, that will never be false
+negative, but may be false positive. Nevertheless, if it is false positive
+something went wrong, either an incompatible package has been used or the user
+made something he should not do.%
+\EndIndex{Cmd}{IfLayerExists}
+
+\begin{Declaration}
+ \Macro{DestroyLayer}\Parameter{layer name}
+\end{Declaration}
+\BeginIndex{Cmd}{DestroyLayer}%
+This command sets all macros corresponding with the layer with given
+\PName{layer name} to \Macro{relax}, if a layer with that name exists. As a result the layer cannot be used any longer. It does not matter, if the layer
+is still part of the layer list of a page style, because such destroyed layers
+will be ignored. Nevertheless, destroyed layers may be defined again using
+\Macro{DeclareNewLayer} or \Macro{ProvideLayer}, but cannot be changed using
+\Macro{RedeclareLayer} or \Macro{ModifyLayer} any longer.
+
+The command is intended to be used inside
+\Macro{scrlayerOnAutoRemoveInterface} to remove layers, which have been
+defined using removable macros of an interface, whenever the interface would
+be removed.%
+\EndIndex{Cmd}{DestroyLayer}
+
+\begin{Declaration}
+ \Macro{layercontentsmeasure}%
+\end{Declaration}
+\BeginIndex{Cmd}{layercontentsmeasure}%
+The command \Macro{layercontentsmeasure} is internally used, if option
+\Option{draft} has been set, so visualise the layers. The visualisation will
+be done with a centimetre ruler at the top and left edge of the layer and an
+inch ruler at the bottom and right edge of the layer. The rulers will be drawn
+behind the content of the layer. If you would, you could also use it as
+exclusive content of a layer.%
+\EndIndex{Cmd}{layercontentsmeasure}
+
+
+\section{Declaration and Management of Page Styles}
+\label{sec:scrlayer.pagestyles}
+
+Until now we know layers, but we do not know how to use them. The
+perhaps astonishing answer is: with page styles. In \LaTeX{}, page
+styles usually define heads and foots of odd and even pages.
+
+The head and foot of odd pages will be printed on pages with odd
+page number in two-side mode or on all pages in single-side mode. This is
+something like the layer attributes \Option{oddpage} and \Option{evenpage}.
+
+The page head will be printed before the main contents of a page. The page
+footer will be printed after the main contents of a page. So this is something
+like the layer attributes \Option{background} and \Option{foreground}.
+
+So it's obvious to declare page styles to be a list of layers. But instead of
+having only four attributes \Option{oddpage}, \Option{evenpage},
+\Option{background}, and \Option{foreground} all the attributes of layers
+shown in \autoref{sec:scrlayer.layers} may be used.
+
+The outcome of this is that layer page styles are one type of page styles
+\Package{scrlayer} provides. A layer page style consists of layers and
+several \emph{hooks}. For description of layers see
+\autoref{sec:scrlayer.layers}. The \emph{hooks} are points in the expansion
+or execution of page styles and you may add additional code that will be
+expanded there. Advanced users know this already from commands like
+\Macro{AtBeginDocument} (see \cite{latex:usrguide}) or
+\Macro{BeforeClosingMainAux} (see
+\autopageref{desc:scrlfile.cmd.BeforeClosingMainAux}).
+
+Alias page styles are another type of page styles, provided by
+\Package{scrlayer}. An alias page style simply consists of another page
+style. In other words, the name of an alias page style is an alias name of
+another page style, the aliased or original page style. Because of this, the
+manipulation of an alias page style results in the manipulation of the
+original page style. If the original page style is an alias page style too,
+the manipulation will result in the manipulation of the aliased page style of
+that original page style and so on until a real page style will be
+manipulated. You may not only alias layer page styles made with
+\Package{scrlayer}, but all kind of page styles.
+
+\begin{Declaration}
+ \Macro{currentpagestyle}
+\end{Declaration}
+\BeginIndex{Cmd}{currentpagestyle}%
+Package scrlayer patches \Macro{pagestyle} to set \Macro{currentpagestyle} to
+the currently active page style. Note, \Macro{thispagestyle} does not
+change \Macro{currentpagestyle}. But if you use \Macro{thispagestyle} the
+result of \Macro{currentpagestyle} may be changed while execution of the
+\LaTeX{} output routine. This may be relevant only, if
+\Macro{currentpagestyle} has been used protected until execution of the output
+routine.
+
+Note, the layer page styles described later in this section, will not need
+the patch of \Macro{pagestyle} to set \Macro{currentpagestyle}. The patch has
+been made for usage with other page styles. Note also,
+\Macro{currentpagestyle} is empty before the first \Macro{pagestyle} after
+loading \Package{scrlayer}. So if you define an end user page style interface,
+it may be useful to use an implicit \Macro{pagestyle} to set the current page
+style to a default page style.%
+\EndIndex{Cmd}{currentpagestyle}
+
+\begin{Declaration}
+ \Macro{BeforeSelectAnyPageStyle}\Parameter{code}\\
+ \Macro{AfterSelectAnyPageStyle}\Parameter{code}%^^A
+\end{Declaration}
+\BeginIndex{Cmd}{BeforeSelectAnyPageStyle}%
+\BeginIndex{Cmd}{AfterSelectAnyPageStyle}%
+The command \Macro{BeforeSelectAnyPageStyle} adds \PName{code} to the hook
+that will be executed inside of \Macro{pagestyle} just before the page style
+will be selected. You may use \texttt{\#1} as a placeholder for the argument
+of \Macro{pagestyle}.
+
+The command \Macro{AfterSelectAnyPageStyle} is similar, but the \PName{code}
+will be executed just after the page style has been selected and after
+\Macro{currentpagestyle} has been set to the name of real page style.
+
+Note\textnote{Attention!}, \PName{code} of both commands will be executed
+only, if a page style will be selected using \Macro{pagestyle}, but not,
+e.\,g., if a page style will be selected using \Macro{thispagestyle}. Note
+also, you cannot remove \PName{code} from the hook after adding it. But
+the \PName{code} will be added locally, so you may use a group to limit the
+scope of \PName{code}.%^^A
+\EndIndex{Cmd}{AfterSelectAnyPageStyle}
+\EndIndex{Cmd}{BeforeSelectAnyPageStyle}
+
+\begin{Declaration}
+ \Macro{DeclarePageStyleAlias}%
+ \Parameter{alias page style name}\Parameter{original page style name}\\
+ \Macro{DeclareNewPageStyleAlias}%
+ \Parameter{alias page style name}\Parameter{original page style name}\\
+ \Macro{ProvidePageStyleAlias}%
+ \Parameter{alias page style name}\Parameter{original page style name}\\
+ \Macro{RedeclarePageStyleAlias}%
+ \Parameter{alias page style name}\Parameter{original page style name}
+\end{Declaration}
+\BeginIndex{Cmd}{DeclarePageStyleAlias}%
+\BeginIndex{Cmd}{DeclareNewPageStyleAlias}%
+\BeginIndex{Cmd}{ProvidePageStyleAlias}%
+\BeginIndex{Cmd}{RedeclarePageStyleAlias}%
+These commands may be used to define a page style with name \PName{alias page
+ style name} that is simply an alias for an already existing page style with
+name \PName{original page style name}. If there's already a page style
+\PName{alias page style name} it will be destroyed before creating the alias
+using \Macro{DeclarePageStyleAlias} or \Macro{RedeclarePageStyleAlias}.
+
+\Macro{DeclareNewPageStyleAlias} will throw an error message, if a page style
+\PName{alias page style name} has already been defined before. It does not
+matter if the already defined page style is a layer page style, an alias page
+style or another page style.
+
+\Macro{ProvidePageStyleAlias} will define the alias only, if a page style
+\PName{alias page style name} has not been defined before. If a page style
+\PName{alias page style name} already exists nothing will be done.
+
+\Macro{RedeclarePageStyleAlias} expects an already existing page style
+\PName{alias page style name}. It will destroy that page style and afterwards
+define the alias. If the page style \PName{alias page style name} does not
+exist, then you will get an error.%
+\EndIndex{Cmd}{RedeclarePageStyleAlias}%
+\EndIndex{Cmd}{ProvidePageStyleAlias}%
+\EndIndex{Cmd}{DeclareNewPageStyleAlias}%
+\EndIndex{Cmd}{DeclarePageStyleAlias}
+
+\begin{Declaration}
+ \Macro{DestroyPageStyleAlias}\Parameter{page style name}%
+\end{Declaration}
+\BeginIndex{Cmd}{DestroyPageStyleAlias}%
+This command makes the page style with given \PName{page style name}
+\LaTeX-undefined, if it is an alias for another page style. After this, the
+page style may be defined newly with, e.g., \Macro{DeclareNewAliasPageStyle}
+or \Macro{ProvideAliasPageStyle}.
+
+The command is intended to be used inside of
+\Macro{scrlayerOnAutoRemoveInterface} to remove page styles that have been
+declared by an interface and uses removable macros of that interface.%
+\EndIndex{Cmd}{DestroyPageStyleAlias}
+
+\begin{Declaration}
+ \Macro{GetRealPageStyle}\Parameter{page style name}%
+\end{Declaration}
+\BeginIndex{Cmd}{GetRealPageStyle}%
+The command will result in the (recursive) real page name of the page style,
+if the page style with given name \PName{page style name} is an alias of
+another page style. In all other cases, even if there's no alias and no page
+style named \PName{page style name}, the result would be simply \PName{page
+ style name}. The command is fully expandable and may be used, e.g., in the
+second argument of \Macro{edef}.%
+\EndIndex{Cmd}{GetRealPageStyle}
+
+\begin{Declaration}
+ \Macro{DeclarePageStyleByLayers}%
+ \OParameter{option list}\Parameter{page style name}\Parameter{layer list}\\
+ \Macro{DeclareNewPageStyleByLayers}%
+ \OParameter{option list}\Parameter{page style name}\Parameter{layer list}\\
+ \Macro{ProvidePageStyleByLayers}%
+ \OParameter{option list}\Parameter{page style name}\Parameter{layer list}\\
+ \Macro{RedeclarePageStyleByLayers}%^
+ \OParameter{option list}\Parameter{page style name}\Parameter{layer list}%
+\end{Declaration}
+\BeginIndex{Cmd}{DeclarePageStyleByLayers}%
+\BeginIndex{Cmd}{DeclareNewPageStyleByLayers}%
+\BeginIndex{Cmd}{ProvidePageStyleByLayers}%
+\BeginIndex{Cmd}{RedeclarePageStyleByLayers}%
+These commands declare a page style with \PName{page style name}. The page
+style will consist of the layers given in \PName{layer list}, a comma
+separated list of layer names. Note, the \PName{page style name} and the
+layer names at the \PName{layer list} must be fully expandable and should
+expand to letters. Several other characters are tolerated, but,
+nevertheless, are not recommended.
+
+The \PName{option list} is a comma separated list of
+\OptionValue{\PName{key}}{\PName{value}} options. These options may be used to
+set additional features. Currently they are used to set the code that should
+be expanded or executed at several \emph{hooks}. See the introduction to this
+section for more general information about \emph{hooks}. See
+\autoref{tab:scrlayer.pagestyle.hooks} for more information about the hooks
+and their purpose.
+
+\begin{desclist}
+ \desccaption{%
+ The \emph{hook} options for page styles (in order of
+ execution)\label{tab:scrlayer.pagestyle.hooks}%
+ }{%
+ The \emph{hook} options for page styles (\emph{Continuation})%
+ }%
+ \entry{\KOption{onselect}\PName{code}}{%
+ Execute \PName{code} whenever the page style will be selected using, e.g.,
+ \Macro{pagestyle}. Note\textnote{Attention!}, \Macro{thispagestyle}
+ does not select the page style immediately, but asynchronously inside
+ \LaTeX's output routine.%
+ }%
+ \entry{\KOption{oninit}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style
+ will be initialised. Note\textnote{Attention!}, this will be done
+ twice for every page: once for background layers and once for foreground
+ layers.%
+ }%
+ \entry{\KOption{ononeside}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style in
+ single-side mode will initialised. Note\textnote{Attention!}, this
+ will be done twice for every page: once for background layers and once for
+ foreground layers.%
+ }%
+ \entry{\KOption{ontwoside}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style in
+ two-side mode will initialised. Note\textnote{Attention!}, this will
+ be done twice for every page: once for background layers and once for
+ foreground layers.%
+ }%
+ \entry{\KOption{onoddpage}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style on
+ an odd page will initialised. Note\textnote{Attention!}, this will be
+ done twice for every page: once for background layers and once for
+ foreground layers. Note\textnote{Attention!} also, in single-side
+ mode all pages are odd pages, not only pages with odd page numbers.%
+ }%
+ \entry{\KOption{onevenpage}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style on
+ an even page will initialised. Note\textnote{Attention!}, this will
+ be done twice for every page: once for background layers and once for
+ foreground layers. Note\textnote{Attention!} also, there are not even
+ pages in single-side mode, but all pages are odd pages, not only pages
+ with odd page numbers.%
+ }%
+ \entry{\KOption{onfloatpage}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style on
+ a float page will initialised. Note\textnote{Attention!}, this will
+ be done twice for every page: once for background layers and once for
+ foreground layers. Note\textnote{Attention!} also, float pages are
+ only those pages with p-placed floating objects.%
+ }%
+ \entry{\KOption{onnonfloatpage}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style on
+ a non-float page will initialised. Note\textnote{Attention!}, this
+ will be done twice for every page: once for background layers and once for
+ foreground layers. Note\textnote{Attention!} also, non-float pages
+ are all pages that are not float-pages. Those pages may have t-placed,
+ h-placed, b-placed, or no floating objects.%
+ }%
+ \entry{\KOption{onbackground}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style in
+ the background of a page will initialised. Note\textnote{Attention!},
+ this will be done once for every page.%
+ }%
+ \entry{\KOption{onforeground}\PName{code}}{%
+ Execute \PName{code} whenever the output of the layers of a page style in
+ the foreground of a page will initialised. Note\textnote{Attention!},
+ this will be done once for every page.%
+ }%
+\end{desclist}
+
+The difference of \Macro{DeclarePageStyleByLayers} and
+\Macro{DeclareNewPageStyleByLayers} is that \Macro{DeclareNewPageStyleByLayers}
+will result in an error, if a page style with name \PName{page style name}
+already exists. Note, declaring a page style, which is an alias of another
+page style (see \Macro{DeclareAliasPageStyle} prior in this section), will not
+re-declare the page style itself, but it's real page style (see
+\Macro{GetRealPageStyle} prior in this section).
+
+The difference of \Macro{DeclarePageStyleByLayers} and
+\Macro{ProvidePageStyleByLayers} is that \Macro{ProvidePageStyleByLayers}
+will simply do nothing, if there's already a page style with name \PName{page
+ style name}. In difference to \Macro{DeclareNewPageStyleByLayers} it will not
+raise an error in this case.
+
+The difference of \Macro{DeclarePageStyleByLayers} and
+\Macro{RedeclarePageStyleByLayers} is, that \Macro{RedeclarePageStyleByLayers}
+may be used only, if the real page style of \PName{page style name} already
+exists. Otherwise an error would occur.
+
+Please have also a look at the notes to following pseudo page style
+\Pagestyle{@everystyle@}.%
+\EndIndex{Cmd}{RedeclarePageStyleByLayers}%
+\EndIndex{Cmd}{ProvidePageStyleByLayers}%
+\EndIndex{Cmd}{DeclareNewPageStyleByLayers}%
+\EndIndex{Cmd}{DeclarePageStyleByLayers}%
+
+\begin{Declaration}
+ \Pagestyle{@everystyle@}\\
+ \Pagestyle{empty}
+\end{Declaration}
+\BeginIndex{Pagestyle}{@everysel@}%
+\BeginIndex{Pagestyle}{empty}%
+There are two somehow special, default layer page styles. The first one is
+\Pagestyle{@everystyle@}. This page style should not be used normally, but the
+layers of this page style will be used by all the other layer page styles. So
+adding a layer to this page style would be similar to adding this layer to all
+other layer page styles even the empty one. There's one difference: Layer
+referencing commands of the page style interface like
+\Macro{ForEachLayerOfPageStyle}, \Macro{AddLayerToPageStyleBeforeLayer}, or
+\Macro{AddLayerToPageStyleAfterLayer} ignore the layers of
+\Pagestyle{@everystyle@} if they are used for another layer page style.
+
+The other somehow special page style is \Pagestyle{empty}. Normally page style
+\Pagestyle{empty} is defined by the \LaTeX{} kernel, to be a page style
+without page head or page foot. Package \Package{scrlayer} re-defines it to be
+a layer page style without any layer. Nevertheless, you may use it like every
+other layer page style too. The main advantage above the \LaTeX{} kernel's
+empty page style is that it also executes the layers of special layer page
+style \Pagestyle{@everysel@}.%
+\EndIndex{Pagestyle}{empty}%
+\EndIndex{Pagestyle}{@everysel@}%
+
+\begin{Declaration}
+ \KOption{onpsselect}\PValue{code}\\
+ \KOption{onpsinit}\PValue{code}\\
+ \KOption{onpsoneside}\PValue{code}\\
+ \KOption{onpstwoside}\PValue{code}\\
+ \KOption{onpsoddpage}\PValue{code}\\
+ \KOption{onpsevenpage}\PValue{code}\\
+ \KOption{onpsfloatpage}\PValue{code}\\
+ \KOption{onpsnonfloatpage}\PValue{code}\\
+ \KOption{onpsbackground}\PValue{code}\\
+ \KOption{onpsforeground}\PValue{code}
+\end{Declaration}
+\BeginIndex{Option}{onpsselect~=\PName{code}}%
+\BeginIndex{Option}{onpsinit~=\PName{code}}%
+\BeginIndex{Option}{onpsoneside~=\PName{code}}%
+\BeginIndex{Option}{onpstwoside~=\PName{code}}%
+\BeginIndex{Option}{onpsoddpage~=\PName{code}}%
+\BeginIndex{Option}{onpsevenpage~=\PName{code}}%
+\BeginIndex{Option}{onpsfloatpage~=\PName{code}}%
+\BeginIndex{Option}{onpsnonfloatpage~=\PName{code}}%
+\BeginIndex{Option}{onpsbackground~=\PName{code}}%
+\BeginIndex{Option}{onpsforeground~=\PName{code}}%
+There's also a \KOMAScript{} option for each of those \texttt{hooks}. The
+names of the \KOMAScript{} options are similar to the names of the page style
+options, but with ``\texttt{ps}'' inserted behind ``\texttt{on}''. The value of
+the \KOMAScript{} options are the initial defaults of the corresponding
+\texttt{hooks}. This default will be extended by every usage of the page style
+options at the \PName{option list}. You may remove the default, using
+\Macro{ModifyLayerPageStyleOptions} described later in this section.%
+\EndIndex{Option}{onpsforeground~=\PName{code}}%
+\EndIndex{Option}{onpsbackground~=\PName{code}}%
+\EndIndex{Option}{onpsnonfloatpage~=\PName{code}}%
+\EndIndex{Option}{onpsfloatpage~=\PName{code}}%
+\EndIndex{Option}{onpsevenpage~=\PName{code}}%
+\EndIndex{Option}{onpsoddpage~=\PName{code}}%
+\EndIndex{Option}{onpstwoside~=\PName{code}}%
+\EndIndex{Option}{onpsoneside~=\PName{code}}%
+\EndIndex{Option}{onpsinit~=\PName{code}}%
+\EndIndex{Option}{onpsselect~=\PName{code}}%
+
+\begin{Declaration}
+ \KOption{deactivatepagestylelayers}\PName{simple switch}\\
+ \Macro{ForEachLayerOfPageStyle}\Parameter{page style name}\Parameter{code}
+\end{Declaration}
+\BeginIndex{Cmd}{ForEachLayerOfPageStyle}%
+As long as \KOMAScript{} option \Option{deactivatepagestylelayers} has not been
+activated command \Macro{ForEachLayerOfPageStyle} can be used to process
+\PName{code} for every layer that is a member of the layers list of a page
+style with given \PName{page style name}. Inside of \PName{code} the place
+holder \PValue{\#1} may be used for the name of the current layer.
+\begin{Example}
+ If you want to output the names of all layers of page style
+ \PValue{scrheadings}, you may us:
+\begin{lstcode}
+ \let\commaatlist\empty
+ \ForEachLayerOfPageStyle{scrheadings}{%
+ \commaatlist#1\gdef\commaatlist{, }}
+\end{lstcode}
+\end{Example}
+Usage of \Macro{gdef} instead of \Macro{def} is necessary in the example
+above, because \Macro{ForEachLayerOfPageStyle} executes the \PName{code}
+inside of a group to minimise side effects. Here \Macro{gdef} redefines
+\Macro{commaatlist} globally, so it would be still valid at the execution of
+\PName{code} for the next layer.
+
+Several other commands of \Package{scrlayer} also
+use \Macro{ForEachLayerOfPageStyle} internally. So these also do not process
+any layer if \KOMAScript{} option \Option{deactivatepagestylelayers} would be
+activated. So you may use this options, e.g., to hide all layers of all layer
+page styles.%
+\EndIndex{Cmd}{ForEachLayerOfPageStyle}%
+
+\begin{Declaration}
+ \Macro{AddLayersToPageStyle}%
+ \Parameter{page style name}\Parameter{layer list}\\
+ \Macro{AddLayersAtBeginOfPageStyle}%
+ \Parameter{page style name}\Parameter{layer list}\\
+ \Macro{AddLayersAtEndOfPageStyle}%
+ \Parameter{page style name}\Parameter{layer list}\\
+ \Macro{RemoveLayersFromPageStyle}%
+ \Parameter{page style name}\Parameter{layer list}%
+\end{Declaration}
+\BeginIndex{Cmd}{AddLayersToPageStyle}%
+\BeginIndex{Cmd}{AddLayersAtBeginOfPageStyle}%
+\BeginIndex{Cmd}{AddLayersAtEndOfPageStyle}%
+\BeginIndex{Cmd}{RemoveLayersFromPageStyle}%
+You can use these commands to add layers to a layer page style or to remove
+layers from a layer page style. The page style will be referenced by it
+\PName{page style name}. The layers are given by a comma separated
+\PName{layer list}.
+
+The commands \Macro{AddLayersToPageStyle} and \Macro{AddLayersAtEndOfPageStyle}
+add all layers of the comma separated list of layers \PName{layer list} at
+the end of the layer list of layer page style \PName{page style
+ name}. Logically the added layers would be above or in front of the old
+layers of the page style. Nevertheless, new background layers would be behind
+the text layer and therefore behind all foreground layers.
+
+Command \Macro{AddLayersAtBeginOfPageStyle} adds the new layers at the begin
+of the layer list of the page style. Note, the layers
+will be added in the order of the \PName{layer list}. The first layer at
+\PName{layer list} will be added first, the second layer will be added second
+and so on. So with \Macro{AddLayersAtBeginOfPageStyle} the last layer at
+\PName{layer list} will become the new first layer of the layer list of layer
+page style \PName{page style name}.
+
+Command \Macro{RemoveLayersFromPageStyle} may be used to remove layers from
+the layer list of layer page style \PName{page style name} instead of adding
+them. Note, layers, which are part of \PName{layer list}, but not part of
+the page style's layer list, will be ignored. But adding or removing layers
+from a page style, which is not a layer page style or an alias of a layer page
+style, would be a mistake and result in an error message.%
+\EndIndex{Cmd}{RemoveLayersFromPageStyle}%
+\EndIndex{Cmd}{AddLayersAtEndOfPageStyle}%
+\EndIndex{Cmd}{AddLayersAtBeginOfPageStyle}%
+\EndIndex{Cmd}{AddLayersToPageStyle}
+
+\begin{Declaration}
+ \Macro{AddLayersToPageStyleBeforeLayer}%
+ \Parameter{page style name}\Parameter{layer list}%
+ \Parameter{reference layer name}\\
+ \Macro{AddLayersToPageStyleAfterLayer}%
+ \Parameter{page style name}\Parameter{layer list}%
+ \Parameter{reference layer name}
+\end{Declaration}
+\BeginIndex{Cmd}{AddLayersToPageStyleBeforeLayer}%
+\BeginIndex{Cmd}{AddLayersToPageStyleAfterLayer}%
+These commands are similar to the commands described before, but they do not
+add the layers at the begin or end of the layer list of a layer page style,
+but just before or after a reference layer at the layer list of a layer page
+style. Note, in this case the order of the \PName{layer list} will be
+same in the layer list of \PName{page style name} after adding. If the
+reference layer named \PName{reference layer name} is not part of the layer
+list of the layer page style, nothing happens.%
+\EndIndex{Cmd}{AddLayersToPageStyleAfterLayer}%
+\EndIndex{Cmd}{AddLayersToPageStyleBeforeLayer}
+
+\begin{Declaration}
+ \Macro{UnifyLayersAtPageStyle}\Parameter{page style name}
+\end{Declaration}
+\BeginIndex{Cmd}{UnifyLayersAtPageStyle}%
+With the commands described before in this section you may not only add
+different layers to a page style, but even add the same layer several times to
+a page style. In most cases it does not make sense to have one layer several
+times at the layer list of a layer page style. So you may use
+\Macro{UnifyLayersAtPageStyle} to remove all dupes of layers from the layer
+list of a layer page style.
+
+Note\textnote{Attention!}, the order of layers may change! So if
+you want a special order, you should remove all layers and add the layers in
+the order you want instead of using \Macro{UnifyLayersAtPageStyle}.%
+\EndIndex{Cmd}{UnifyLayersAtPageStyle}
+
+\begin{Declaration}
+ \Macro{ModifyLayerPageStyleOptions}%
+ \Parameter{page style name}\Parameter{option list}\\
+ \Macro{AddToLayerPageStyleOptions}%
+ \Parameter{page style name}\Parameter{option list}
+\end{Declaration}
+\BeginIndex{Cmd}{ModifyLayerPageStyleOptions}%
+\BeginIndex{Cmd}{AddToLayerPageStyleOptions}%
+Command \Macro{ModifyLayerPageStyleOptions} may be used to modify the page
+style options of a layer page style. Only options at the comma separated
+\PName{option list} will be set to the new values given in \PName{option list}
+if the new value is not empty. Options, which are not at \PName{option list},
+will stay unchanged. If you want to set an option to \emph{do nothing} you may
+use value \Macro{relax}. Note, setting an option to a new value using
+\Macro{ModifyLayerPageStyleOptions} will remove the previous value including
+the global default value.
+
+\Macro{AddToLayerPageStyleOptions} differs from
+\Macro{ModifyLayerPageStyleOptions} in that point. It will not overwrite the
+previous values, but adds\,---\,or more precisely: concatenates\,---\, the new
+values to the previous values of the options at \PName{option list}.%
+\EndIndex{Cmd}{AddToLayerPageStyleOptions}%
+\EndIndex{Cmd}{ModifyLayerPageStyleOptions}%
+
+\begin{Declaration}
+ \Macro{IfLayerPageStyleExists}%
+ \Parameter{page style name}\Parameter{then code}\Parameter{else code}\\
+ \Macro{IfRealLayerPageStyleExists}%^
+ \Parameter{page style name}\Parameter{then code}\Parameter{else code}%
+\end{Declaration}
+\BeginIndex{Cmd}{IfLayerPageStyleExists}%
+\BeginIndex{Cmd}{IfRealLayerPageStyleExists}%
+Command \Macro{IfLayerPageStyleExists} tests, whether or not the real page
+style of \PName{page style name} is a layer page style. If the test is true,
+\PName{then code} will be executed. If \PName{page style name} is neither a
+layer page style, nor an alias of a layer page style, nor an alias of an alias
+of \dots\ a layer page style, \PName{else code} will be executed. Internally
+this command is often used to throw an error message if you use one of the
+layer page style commands with an \PName{page style name} that does not
+correspond with a layer page style.
+
+Command \Macro{IfRealLayerPageStyleExists} is similar, but \PName{then code}
+will only be executed, if \PName{page style name} itself is the name of a
+layer page style. So \PName{else code} will even be executed, if \PName{page
+ style name} is an alias name of a layer page style or the alias name of an
+alias name of \dots\ a layer page style.%
+\EndIndex{Cmd}{IfRealLayerPageStyleExists}%
+\EndIndex{Cmd}{IfLayerPageStyleExists}%
+
+\begin{Declaration}
+ \Macro{IfLayerAtPageStyle}%
+ \Parameter{page style name}\Parameter{layer name}%
+ \Parameter{then code}\Parameter{else code}\\
+ \Macro{IfSomeLayerAtPageStyle}%
+ \Parameter{page style name}\Parameter{layer list}%^
+ \Parameter{then code}\Parameter{else code}\\
+ \Macro{IfLayerAtPageStyle}%
+ \Parameter{page style name}\Parameter{layer list}%
+ \Parameter{then code}\Parameter{else code}%
+\end{Declaration}
+\BeginIndex{Cmd}{IfLayerAtPageStyle}%
+\BeginIndex{Cmd}{IfSomeLayersAtPageStyle}%
+\BeginIndex{Cmd}{IfLayersAtPageStyle}%
+Command \Macro{IfLayerAtPageStyle} may be used to test, whether or not a layer
+named \PName{layer name} is a member of the layer list of a given page
+style. If the test is true, the \PName{then code} will be executed. If the
+layer is not a member of the layer list of \PName{page style name}, the
+\PName{else code} will be executed.
+
+Commands \Macro{IfSomeLayerAtPageStyle} and \Macro{IfLayersAtPageStyle} do not
+only test one layer but several layers at a given, comma separated
+\PName{layer list}. \Macro{IfSomeLayerAtPageStyle} will execute the
+\PName{then code} if \emph{at least one} of the layers at \PName{layer list}
+is a member of the layer list of \PName{page style name}. In difference
+\Macro{IfLayersAtPageStyle} executes the \PName{then code} only, if \emph{all}
+of the layers at \PName{layer list} are members of the layer list of
+\PName{page style name}.%
+\EndIndex{Cmd}{IfLayersAtPageStyle}%
+\EndIndex{Cmd}{IfSomeLayersAtPageStyle}%
+\EndIndex{Cmd}{IfLayerAtPageStyle}
+
+\begin{Declaration}
+ \Macro{DestroyRealLayerPageStyle}\Parameter{page style name}
+\end{Declaration}
+\BeginIndex{Cmd}{DestroyRealLayerPageStyle}%
+Command \Macro{DestroyRealLayerPageStyle} makes the page style named
+\PName{page style name} undefined, if and only if it is a layer page
+style. Nothing will be happen if it is an alias name of a layer page style, if
+it is another page style, or if it is not a page style.
+
+If \PName{page style name} is the name of the current page style the current
+page style will become a kind of empty page style. If the special page
+style\,---\,this may be set using \Macro{thispagestyle}\,---\,is \PName{page
+ style name}, this will be simply reset. So the previous
+\Macro{thispagestyle} will become invalid.
+
+Note, the layers of the page style will not be destroyed
+automatically. If you want to destroy the layers too, you may use
+\begin{lstcode}
+ \ForEachLayerOfPageStyle{...}{\DestroyLayer{#1}}
+\end{lstcode}
+\emph{before} destroying the layer page style.
+
+The command is intended to be used inside the auto-remove code of an interface
+See \autoref{sec:scrlayer.enduserinterfaces} below for more information about
+auto-remove code.%
+\EndIndex{Cmd}{DestroyRealLayerPageStyle}
+
+\LoadCommon{20} % \section{Height of Page Head and Foot}
+
+\LoadCommon{21} % \section{Manipulation of Defined Page Styles}
+
+\section{End User Interfaces}
+\label{sec:scrlayer.enduserinterfaces}
+
+Package \Package{scrlayer} provides an interface to define and manage
+(concurrent) end user interfaces. Maybe future releases of \KOMAScript{} will
+provide parts of this by package \Package{scrbase} and remove those commands
+from \Package{scrlayer}. But currently this part if \Package{scrlayer} is very
+experimental, so package \Package{scrlayer} provides its own interface
+definition commands. Currently you should not depend on correct working of
+auto-removing a concurrent end user interface. Instead you should avoid using
+concurrent end user interfaces.
+
+This section only describes the interface commands for defining end user
+interfaces. This is not interesting for end users, but only for authors of end
+user interfaces. End users will find information about the end user interfaces
+in the sections about the particular end user interface, e.g.,
+\autoref{cha:scrlayer-scrpage}, \autoref{cha:scrlayer-scrpage-experts}, and
+\autoref{cha:scrlayer-notecolumn}.
+
+\begin{Declaration}
+ \Macro{scrlayerInitInterface}\OParameter{interface name}
+\end{Declaration}
+\BeginIndex{Cmd}{scrlayerInitInterface}%
+Command \Macro{scrlayerInitInterface}
+registers a new interface. The \PName{interface name} must be unique. If you
+try to initialise an already initialised interface an error will occur. This
+command is obligatory and mandatory for interfaces. It should be the first
+interface command and therefore has been described first. If the optional
+argument is omitted, \PValue{\Macro{@currname}.\Macro{@currext}} will be
+used instead. For classes and packages this will be the file name of the class
+or package while loading the class or package. But you may use any sequence of
+characters with category letter or other.%
+\EndIndex{Cmd}{scrlayerInitInterface}
+
+\begin{Declaration}
+ \KOption{forceoverwrite}\PName{simple switch}\\
+ \KOption{autoremoveinterfaces}\PName{simple switch}\\
+ \Macro{scrlayerAddToInterface}%
+ \OParameter{interface name}\Parameter{command}\Parameter{code}\\
+ \Macro{scrlayerAddCsToInterface}%
+ \OParameter{interface name}\Parameter{command sequence}\Parameter{code}
+\end{Declaration}
+\BeginIndex{Option}{forceoverwrite}%
+\BeginIndex{Option}{autoremoveinterfaces}%
+\BeginIndex{Cmd}{scrlayerAddToInterface}%
+\BeginIndex{Cmd}{scrlayerAddCsToInterface}%
+One of the special features of end user interfaces is that they should
+register all interface dependent commands (also known as \emph{macros}). You
+may do this using \Macro{scrlayerAddToInterface}%^^A
+. If your interface generates macros not only at load time but also at run
+time or if the interface name should not be the class's or package's name, you
+have to use the optional argument to add the command to a dedicated
+interface. An error will occur, if the interface has not been initialised
+before.
+
+The first mandatory argument is the \PName{command}\footnote{The
+ \PName{command} consists of the backslash followed by a \PName{command
+ sequence} consisting of characters with category code letter or one other
+ character, or \PName{command} consists of one active character (without
+ backslash).} that should be added to the interface. If the command can be
+added to the interface, it will be added to the interface, will be set to
+\Macro{relax} and \PName{code} will be executed. You can use, e.g.,
+\Macro{newcommand}\PName{command} inside of \PName{code} to define
+\PName{command}.
+
+But when can a command be defined? If a command is undefined or \Macro{relax}
+it can be defined. If a command has already been defined and registered for
+another interface \emph{and} if \KOMAScript{} option
+\Option{autoremoveinterface} has been switched on, the other interface will be
+removed automatically and the new command will be set to \Macro{relax} and
+will be registered for the given interface. If a command
+has already been defined but is not part of another interface \emph{and} if
+\KOMAScript{} option \Option{forceoverwrite} has been switched on, the command
+will be set to \Macro{relax} and will be registered for the given interface.
+
+Command \Macro{scrlayerAddCsToInterface} is similar to
+\Macro{scrlayerAddToInterface} but does not expect a command as first,
+mandatory argument, but a command sequence\footnote{A command sequence may
+ consist of any characters with category code letter or other.}.%
+\EndIndex{Cmd}{scrlayerAddCsToInterface}%
+\EndIndex{Cmd}{scrlayerAddToInterface}
+\EndIndex{Option}{autoremoveinterfaces}%
+\EndIndex{Option}{forceoverwrite}%
+
+\begin{Declaration}
+ \Macro{scrlayerOnAutoRemoveInterface}%^^A
+ \OParameter{interface name}\Parameter{code}
+\end{Declaration}
+\BeginIndex{Cmd}{scrlayerOnAutoRemoveInterface}%
+Command \Macro{scrlayerOnAutoRemoveInterface}
+registers \PName{code} to be executed, if the interface will be automatically
+removed (see \Option{autoremoveinterfaces} prior in this section). This may be
+used, e.g., to automatically destroy layers or page styles (see
+\Macro{DestroyLayer}, \Macro{DestroyAliasPageStyle}, and
+\Macro{DestroyRealLayerPageStyle}).%
+\EndIndex{Cmd}{scrlayerOnAutoRemoveInterface}%
+%
+\EndIndex{Package}{scrlayer}
+
+%%% Local Variables:
+%%% mode: latex
+%%% mode: flyspell
+%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
+%%% TeX-master: "../guide"
+%%% End:
+
+
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex
index a3bfa1aab2e..a01d445a1cf 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlfile.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlfile.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ============================================================================
-\ProvidesFile{scrlfile.tex}[2012/02/24 KOMA-Script guide (chapter: scrlfile)]
+\KOMAProvidesFile{scrlfile.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrlfile)]
\translator{Gernot Hassenpflug\and Markus Kohm}
-% Date of translated german file: 2012/02/25
+% Date of translated german file: 2013/11/24
\chapter{Control Package Dependencies with \Package{scrlfile}}
\labelbase{scrlfile}
@@ -210,10 +212,10 @@ The\important[i]{\Macro{AfterClass+}\\\Macro{AfterPackage+}}
plussed\ChangedAt{v3.09}{\Package{scrlfile}} version executes the
\PName{instructions} after loading of the class or package has been
finished. The difference to the starred version is only valid, if loading of
-the class or package already started but hasn't been finished
+the class or package already started but has not been finished
yet. Nevertheless, \PName{instructions} will be executed before the
instructions of \Macro{AtEndOfClass} or \Macro{AtEndOfPackage} when loading of
-the class or package hasn't been finished already.
+the class or package has not been finished already.
If\important[i]{\Macro{AfterClass!}\\\Macro{AfterPackage!}} a class uses
\Macro{AtEndOfClass} or a package uses \Macro{AtEndOfPackage} to execute
@@ -355,7 +357,7 @@ page of the document already have been shipped out before
\Macro{end}\PParameter{document}, the code above will not result in any
writing into the \File{aux}-file. If someone would try to fix this new problem
using \Macro{immediate} just before \Macro{write}, the inverse problem would
-occur: If the last page wasn't shipped out before
+occur: If the last page was not shipped out before
\Macro{end}\PParameter{document} the \Macro{writethistoaux} would be written
into \File{aux}-file before ship-out the last page. Another often seen
suggestion for this problem therefore is:
@@ -377,7 +379,7 @@ been enforced by the \Macro{clearpage}. After that, instructions like
Note at the end of the document.\par
}
\end{lstcode}
-wouldn't any longer output the note at the end of the last page of the
+would not any longer output the note at the end of the last page of the
document but at the end of one more page. Additionally \Macro{writethistoaux}
would be written one page to early into the \File{aux}-file again.
@@ -395,7 +397,7 @@ immediately after the final \Macro{clearpage}, that is part of
}
\end{lstcode}
This would be successful even if the final \Macro{clearpage} inside of
-\Macro{end}\PParameter{document} wouldn't really ship-out any page or if
+\Macro{end}\PParameter{document} would not really ship-out any page or if
someone have had used \Macro{clearpage} in the argument of
\Macro{AtEndDocument}.
@@ -517,7 +519,7 @@ Please\textnote{Attention!} note, that the \PName{replacement class} or the
\PName{replacement package} will be loaded with the same options, the
\PName{source class} or \PName{replacement class} would until it has been
replaced. Replacement of a class or package by a class or package, that
-doesn't support a requested option, would result in a warning or even an error
+does not support a requested option, would result in a warning or even an error
message. But you may declare such missing options using \Macro{BeforeClass} or
\Macro{BeforePackage}.
@@ -528,7 +530,7 @@ message. But you may declare such missing options using \Macro{BeforeClass} or
\ReplacePackage{oldfoo}{newfoo}
\end{lstcode}
Assumed the old package provides an option \Option{oldopt}, but the new
- package doesn't. Using
+ package does not. Using
\begin{lstcode}
\BeforePackage{newfoo}{%
\DeclareOption{oldopt}{%
@@ -578,6 +580,23 @@ class using \Macro{RequirePackage} instead of \Macro{usepackage}.
\EndIndex{Cmd}{ReplacePackage}%
\EndIndex{Cmd}{ReplaceClass}%
+\begin{Declaration}
+ \Macro{UnReplaceInput}\Parameter{file name}\\
+ \Macro{UnReplacePackage}\Parameter{package}\\
+ \Macro{UnReplaceClass}\Parameter{class}%
+\end{Declaration}
+\BeginIndex{Cmd}{UnReplaceInput}%
+\BeginIndex{Cmd}{UnReplacePackage}%
+\BeginIndex{Cmd}{UnReplaceClass}%
+A\ChangedAt{v3.12}{\Package{scrlfile}} replacement definition can be removed
+using one of these commands. The replacement definition of a input file should
+be removed using \Macro{UnReplaceInput}, the replacement definition of a
+package should be removed using \Macro{UnReplacePackage}, and the replacement
+definition of a class should be removed using \Macro{UnReplaceClass}.%
+\EndIndex{Cmd}{UnReplaceClass}%
+\EndIndex{Cmd}{UnReplacePackage}%
+\EndIndex{Cmd}{UnReplaceInput}%
+
\section{Prevent File Loading}
\label{sec:scrlfile.prevent}
@@ -590,9 +609,13 @@ of that package has to prevented. For this purpose \Package{scrlfile} again
provides a solution.
\begin{Declaration}
- \Macro{PreventPackageFromLoading}\Parameter{package list}
+ \Macro{PreventPackageFromLoading}\OParameter{instead code}%
+ \Parameter{package list}\\
+ \Macro{PreventPackageFromLoading*}\OParameter{instead code}%
+ \Parameter{package list}
\end{Declaration}
\BeginIndex{Cmd}{PreventPackageFromLoading}%
+\BeginIndex{Cmd}{PreventPackageFromLoading*}%
Calling this command\ChangedAt{v3.08}{\Package{scrlfile}} before loading a
package using \Macro{usepackage}\IndexCmd{usepackage},
\Macro{RequirePackage}\IndexCmd{RequirePackage}, or
@@ -610,7 +633,7 @@ the \PName{package list}.
\end{lstcode}
But now, you want to use
X\kern-.125em\lower.5ex\hbox{\reflectbox{E}}\LaTeX{} oder Lua\LaTeX{} the
- first time. In this case loading of \Package{fontenc} wouldn't be a good
+ first time. In this case loading of \Package{fontenc} would not be a good
suggestion and Latin-Modern would be the default font of the recommended
package \Package{fontspec}. Because of this you want to prevent both
packages from being loaded. This may be done, loading the class like this:
@@ -623,8 +646,21 @@ the \PName{package list}.
The example above also shows, that package \Package{scrlfile} may be loaded
before the class. In this case \Macro{RequirePackage}\IndexCmd{RequirePackage}
has to be used, because \Macro{usepackage} before \Macro{documentclass} is not
-permitted.%
-%
+permitted.
+
+If \PName{package list} is empty or contains a package, that already has been
+loaded, \Macro{PreventPackageFromLoading} will warn. If you'd prefer an
+info\ChangedAt{v3.12}{\Package{scrlfile}} at the log-file only, you may use
+\Macro{PreventPackageFromLoading*} instead.
+
+The optional argument\ChangedAt{v3.12}{\Package{scrlfile}} may be used to
+execute code instead of loading the package. But you must not load another
+packages or files inside \PName{instead code}. See \Macro{ReplacePackage} in
+\autoref{sec:scrlfile.macros} on
+\autopageref{desc:scrlfile.cmd.ReplacePackage} for information about replacing
+a package by another one. Note also, that the \PName{instead code} will be
+executed several times, if you try to load the package more than once!%
+\EndIndex{Cmd}{PreventPackageFromLoading*}%
\EndIndex{Cmd}{PreventPackageFromLoading}
\begin{Declaration}
@@ -670,9 +706,51 @@ been stored using \Macro{StorePreventPackageFromLoading} is responsible for
the correct restorability. For example the list elements must be separated by
comma, must not contain white space or group braces, and must be fully
expandable.
-%
+
+Please note\textnote{Attention!}, that \Macro{ResetPreventPackageFromLoading}
+does not clean the \PName{instead code} of a package. Only the execution is not
+done as long as the prevention is not reactivated.%
\EndIndex{Cmd}{ResetPreventPackageFromLoading}%
\EndIndex{Cmd}{StorePreventPackageFromLoading}%
+
+\begin{Declaration}
+ \Macro{UnPreventPackageFromLoading}\Parameter{package list}\\
+ \Macro{UnPreventPackageFromLoading*}\Parameter{package list}
+\end{Declaration}
+\BeginIndex{Cmd}{UnPreventPackageFromLoading}%
+\BeginIndex{Cmd}{UnPreventPackageFromLoading*}%
+Instead\ChangedAt{v3.12}{\Package{scrlfile}} of resetting the whole list of
+packages, that should prevented from being loaded, you may also remove some
+packages from that list. The star version of the command does also clean the
+\PName{instead code}. So reactivation of the prevent package list, e.\,g.,
+from a stored one, will not reactivate the \PName{instead code} of the
+packages.%
+%
+\begin{Example}
+ Assuming, you want to prevent a package \Package{foo} from being loaded, but
+ you do not want an already stored \PName{instead code} to be
+ executed. Instead of that code, you're own \PName{instead code} should be
+ executed. You can do this:
+\begin{lstcode}
+ \UnPreventPackageFromLoading*{foo}
+ \PreventPackageFromLoading[\typeout{Stattdessencode}]{foo}
+\end{lstcode}
+ For \Macro{UnPreventPackageFromLoading} it does not matter whether or not
+ the package has been prevented from being loaded before.
+
+ Surely you can use the command also to remove only the \PName{instead code}
+ of all packages:
+\begin{lstcode}
+ \StorePreventPackageFromLoading\TheWholePreventList
+ \UnPreventPackageFromLoading*{\TheWholePreventList}
+ \PreventPackageFromLoading{\TheWholePreventList}
+\end{lstcode}
+ In this case the packages, that has been prevented from being loaded, are
+ still prevented from being loaded, but their \PName{instead code} has been
+ cleaned and will not be executed any longer.%
+\end{Example}%
+\EndIndex{Cmd}{UnPreventPackageFromLoading*}%
+\EndIndex{Cmd}{UnPreventPackageFromLoading}%
%
\EndIndex{Package}{scrlfile}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
index c2d08cc4fe0..9ed1ae7f361 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2-experts.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2-experts.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlttr2-experts.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,13 +45,14 @@
%
% ============================================================================
-\ProvidesFile{scrlttr2-experts.tex}[2012/03/01 KOMA-Script guide (chapter:
-scrlttr2 for experts)]
+\KOMAProvidesFile{scrlttr2-experts.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrlttr2 for experts)]
\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe
Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm}
-% Date of the translated German file: 2012/03/01
+% Date of the translated German file: 2013/10/04
\chapter{Additional Information about the Letter Class
\Class{scrlttr2}}
@@ -59,14 +60,14 @@ scrlttr2 for experts)]
This chapter gives additional information about the \KOMAScript{} class
\Class{scrlttr2}. \iffree{Some parts of the chapter are subject to the
- \KOMAScript{} book \cite{book:komascript} only. This shouldn't be a problem,
- because the}{The} average user, who only want to use the package, won't need
-the information. Other information is addressed to users, who want additional
-information about details. For example the first section will describe
-pseudo-lengths in detail. These may be used to modify the note paper. Another
-part of the information describes features of the class that exist only
-because of compatibility to deprecated \Class{scrlettr} class. Last but not
-least it will be described in detail how to change a document from the old
+ \KOMAScript{} book \cite{book:komascript} only. This should not be a
+ problem, because the}{The} average user, who only want to use the package,
+does not need the information. Other information is addressed to users, who
+want additional information about details. For example the first section will
+describe pseudo-lengths in detail. These may be used to modify the note paper.
+Another part of the information describes features of the class that exist
+only because of compatibility to deprecated \Class{scrlettr} class. Last but
+not least it will be described in detail how to change a document from the old
\Class{scrlettr} class to be used with the current \Class{scrlttr2} class.
@@ -84,9 +85,16 @@ registers for the first page alone. {\LaTeX} itself already uses 40 of these
registers. The \Package{typearea} package needs some of them too; thus,
approximately a quarter of the precious registers would already be in
use. That is the reason why lengths specific to letters in \Class{scrlttr2}
-are defined with macros instead of lengths. The drawback of this approach is
-that computations with macros is somewhat more complicated than with real
-lengths.
+are internally defined with macros instead of lengths. The drawback of this
+approach is that computations with macros is somewhat more complicated than
+with real lengths.
+
+Please note\textnote{Attention!}: Even though these pseudo-lengths are
+internally implemented as macros, the commands for pseudo-length management
+expect only the names of the pseudo-lengths not the macros representing the
+pseudo-lengths. The names of pseudo-lengths are without backslash at the very
+beginning similar to the names of \LaTeX{} counters and in opposite to macros
+or \LaTeX{} lengths.
It can be pointed out that the now recommended {\LaTeX} installation with
{\eTeX} no longer suffers from the above-mentioned limitation. However, that
@@ -100,8 +108,8 @@ given in the table.
A schematic display of the most important distances of the note paper is shown
in \autoref{fig:scrlttr2-experts.pseudoLength} at
\autopageref{fig:scrlttr2-experts.pseudoLength}. Beside the
-pseudo-lengths for the modifiable distances, also some lengths, that may not
-be modified are shown in light gray. Some rarely needed pseudo-length of the
+pseudo-lengths for the modifiable distances, also some lengths, which may not
+be modified, are shown in light gray. Some rarely needed pseudo-length of the
note paper have been omitted to get a more clear arrangement.
%
\begin{desclist}
@@ -425,21 +433,18 @@ shifted in the vertical direction.
\BeginIndex{PLength}{tfoldmarkvpos}%
\BeginIndex{PLength}{bfoldmarkvpos}%
\BeginIndex{PLength}{mfoldmarkvpos}%
-The letter class \Class{scrlttr2} knows a total of three
-vertically placed configurable foldmarks. The position of the topmost
-foldmark, taken from the upper edge of the paper, is governed by the
-pseudo-length \PLength{tfoldmarkvpos}, that of the middle foldmark by
-pseudo-length
-\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}, and that
-of the bottommost foldmark by pseudo-length \PLength{bfoldmarkvpos}. With
-the addition of the puncher hole\Index{puncher hole mark} or
-center\Index{center mark|see{punch hole mark}}
-mark, there is still a fourth horizontal mark. This one is however
-always placed at the vertical center of the paper.
+The letter class \Class{scrlttr2} knows a total of three vertically placed
+configurable foldmarks. The position of the topmost foldmark, taken from the
+upper edge of the paper, is governed by the pseudo-length
+\PLength{tfoldmarkvpos}; the position of the middle foldmark by pseudo-length
+\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}; the position of
+the bottommost foldmark by pseudo-length \PLength{bfoldmarkvpos}. With the
+addition of the puncher hole\Index{puncher hole mark} or center\Index{center
+ mark|see{punch hole mark}} mark, there is still a fourth horizontal
+mark. This one is however always placed at the vertical center of the paper.
\iffalse% Umbruchkorrekturtext
-There's no pseudo-length for this last mark, because it vertical position
-isn't configurable.
-\fi
+There's no pseudo-length for this last mark, because it vertical position is
+not configurable. \fi
The\textnote{Attention!} topmost and bottommost foldmarks do not serve to
divide the paper into exactly equal thirds. Instead, with their help, the
@@ -777,8 +782,8 @@ For window envelopes the sender is often printed with small font at one line
above the addressee. This kind of sender's information is known as return
address\textnote{return address}\Index{return address}, because it is visible
at the address window and will be used by the post officers to return the
-letter (back) to the sender. In this return address only the information
-should be, that is needed for this purpose.
+letter (back) to the sender. In this return address only that information
+should be that is needed for this purpose.
The height, that is reserved for the return address at the top of the address
field, is given by pseudo-length \PLength{backaddrheight}. A typical value for
@@ -832,7 +837,7 @@ the height, that will be reserved for the Port-Pay\'e head using the options
\PLength{PPheadwidth} will be used only with \OptionValue{addrfield}{PP} (see
\autoref{sec:scrlttr2.firstpage},
\autopageref{desc:scrlttr2.option.addrfield}) and gives the width of the left
-field in the Port-Pay\'e head, that contains P.\,P. logo, zip-code and
+field in the Port-Pay\'e head that contains P.\,P. logo, zip-code and
place. The width of the right field with the sender's code and the priority is
the remaining width.
@@ -966,7 +971,7 @@ fields line is centered, while with
\OptionValue{refline}{narrow}\IndexOption{refline~=\PValue{narrow}} it is
aligned on the left inside the typing area.
-If \PLength{refwidth} isn't null, i.\,e., the width of the reference fields
+If \PLength{refwidth} is not null, i.\,e., the width of the reference fields
line is therefore not determined by the option \Option{refline}, then
\PLength{refhpos} gives the distance of the reference fields line from the
left edge of the paper. If\textnote{Attention!} this distance is null, then
@@ -1206,7 +1211,7 @@ variables in the business line\Index{business line}.
With \Macro{newkomavar} a new variable is defined. This variable is
addressed via \PName{name}. As an option you can define a
\PName{description} for the variable \PName{name}. In opposite to \PName{name}
-the \PName{description} won't be used to reference a variable. In fact the
+the \PName{description} is not used to reference a variable. In fact the
\PName{description} defines an addition to the content of a variable, that may
be output similar to the variable content.
@@ -1243,7 +1248,7 @@ The command \Macro{defaultreffields} acts to reset the reference
fields line to its predefined format. In doing so, all custom-defined
variables are removed from the reference fields line.
-The\textnote{Attention!} date shouldn't be added to the reference fields line
+The\textnote{Attention!} date should not be added to the reference fields line
using \Macro{addtoreffields}. Instead option \Option{date}\important[i]{\OptionValue{refline}{dateleft}\\
\OptionValue{refline}{dateright}\\
\OptionValue{refline}{nodate}}%
@@ -1310,7 +1315,7 @@ to be used as the argument of, e.\,g., \Macro{markboth} or \Macro{footnote}.%
\section{\File{lco}-Files for Experienced Users}
-\label{sec:scrlttr2-experts.variables}
+\label{sec:scrlttr2-experts.lcoFile}
\BeginIndex{File}{lco}%
\BeginIndex{}{lco-file=\File{lco}-file}%
@@ -1319,7 +1324,7 @@ Even though each paper size, that may be set up using package
\Package{typearea}, may be also used with \Class{scrlttr2}, the result of the
first page may be unwanted with some of those page sizes. The conception of
the class is not the reason for this, but the fact, that there are mainly
-parameter sets for ISO~A4 paper. Unfortunately their aren't any universal
+parameter sets for ISO~A4 paper. Unfortunately their are not any universal
rules, to calculate, e.\,g., the position of the address field or similar for
every available paper sizes. But it is possible to make parameter sets for any
paper size that is needed.%
@@ -1361,7 +1366,7 @@ forget about this option and skip the example.%
into standard C6 window envelopes. In that case, the position of the address
field would be the same as for a DIN standard letter on A4-sized paper. The
main difference is that A5 paper needs only one fold. So you want to disable
- the topmost and bottommost folding marks. If their wouldn't be options for
+ the topmost and bottommost folding marks. If their would not be options for
this, the easiest way to achieve this would be to place the marks outside of
the paper area.
\begin{lstcode}
@@ -1444,13 +1449,13 @@ commands\Macro{setkomafont} und \Macro{addtokomafont} (see
\BeginIndex{Cmd}{edgesize}
The default for the visualization of single areas are
frames\important{\PValue{frame}} around the areas. Areas with open top or
-bottom won't be framed completely but have an open edge with arrows at the end
+bottom are not framed completely but have an open edge with arrows at the end
of the ending lines. Alternatively\important{\PValue{rule}} the
\PName{visualization style} \PValue{rule} may be used. In this case a
-background color will be used to visualize the areas. This doesn't differ open
+background color will be used to visualize the areas. This does not differ open
and closed areas. Instead a minimal height will be used for open areas. The
-third\important{\PValue{edge}} available \PName{visualization style} is
-\PValue{edge}. This will mark the corners of the areas. The corner marks at
+third\important{\PValue{edges}} available \PName{visualization style} is
+\PValue{edges}. This will mark the corners of the areas. The corner marks at
the open edge of open areas will be omitted. The size of two edges of the
corner marks are given by the macro \Macro{edgesize} with default 1\Unit{ex}.%
\EndIndex{Cmd}{edgesize}%
@@ -1830,7 +1835,7 @@ How\important[i]{%
}]{%
Default settings for language-dependent terms using languages
\Option{english} and \Option{ngerman}, as long as language selection
- packages haven't been used%
+ packages have not been used%
\label{tab:scrlttr2-experts.languageTerms}%
}[l]
\begin{tabular}[t]{lll}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
index cabf94914ce..ab944d13090 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-2012
+% Copyright (c) Markus Kohm, 2002-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,12 +45,14 @@
%
% ============================================================================
-\ProvidesFile{scrlttr2.tex}[2012/05/15 KOMA-Script guide (chapter: scrlttr2)]
+\KOMAProvidesFile{scrlttr2.tex}%
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: scrlttr2)]
\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe
Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm}
-% Date of translated german file: < 2007-09-17
+% Date of translated german file: 2013/11/07
\chapter{The New Letter Class \Class{scrlttr2}}
\labelbase{scrlttr2}
@@ -175,6 +177,11 @@ of all variables is given in \autoref{tab:scrlttr2.variables}.
commands for inserting the sender's logo %
(\autoref{sec:scrlttr2.firstpage},
\autopageref{desc:scrlttr2.variable.fromlogo})}%
+ \ventry{frommobilephone}{%
+ \ChangedAt{v3.12}{\Class{scrlttr2}}%
+ sender's mobile telephone number %
+ (\autoref{sec:scrlttr2.firstpage},
+ \autopageref{desc:scrlttr2.variable.frommobilephone})}%
\ventry{fromname}{%
complete name of sender %
(\autoref{sec:scrlttr2.firstpage},
@@ -414,6 +421,12 @@ of this, definition of pseudo-lengths will be described in the expert part at
new values is also a work for advanced users. So this will be described in the
expert part too at \autopageref{desc:scrlttr2-experts.cmd.@setplength}.
+Please note\textnote{Attention!}: Even though these pseudo-lengths are
+internally implemented as macros, the commands for pseudo-length management
+expect only the names of the pseudo-lengths not the macros representing the
+pseudo-lengths. The names of pseudo-lengths are without backslash at the very
+beginning similar to the names of \LaTeX{} counters and in opposite to macros
+or \LaTeX{} lengths.
\begin{Declaration}
\Macro{useplength}\Parameter{name}
@@ -471,7 +484,7 @@ of a \PName{pseudo-length} to the \PName{length}.
\LoadCommon[scrlttr]{3} % \section{Page Layout}
Normally it makes no sense to distinguish letters with single-side layout and
-letters with double-side layout. Mostly letters won't be bound like
+letters with double-side layout. Mostly letters are not bound like
books. Therefor each page will be viewed on its own. This is also true if both
sides of the paper sheet will be used for printing. Vertical adjustment is
unusual at letters too. Nevertheless, if you need or want it, you may read the
@@ -642,7 +655,7 @@ the standard letter class.
\end{document}
\end{lstcode}
However, this would not result in any printable output. At least there
- wouldn't be an addressee at the note paper sheet. The reason for this will
+ would not be an addressee at the note paper sheet. The reason for this will
be explained at the description of command \Macro{opening} at
\autopageref{desc:scrlttr2.cmd.opening}.
\end{Example}
@@ -922,125 +935,8 @@ and content of the variable
%
\EndIndex{}{font>size}
-
\LoadCommon[scrlttr]{5} % \section{Text Markup}
-With command \Macro{usekomafont} the current font style may be changed into
-the font style of the selected \PName{element}.
-
-A general example for the usage of \Macro{setkomafont} and \Macro{usekomafont}
-may be found in \autoref{sec:maincls.textmarkup} at
-\autopageref{desc:maincls.setkomafont.example}.
-
-\begin{desclist}
- \desccaption{%
- Alphabetical list of elements whose font can be changed in
- \Class{scrlttr2} using the commands \Macro{setkomafont} and
- \Macro{addtokomafont}\label{tab:scrlttr2.elementsWithoutText}%
- }{%
- Elements whose font can be changed (\emph{continuation})%
- }%
- \feentry{addressee}{name und address in address field %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.option.addrfield})}%
- \feentry{backaddress}{%
- return address for a window envelope %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.option.backaddress})}%
- \feentry{descriptionlabel}{%
- label, i.\,e., the optional argument of \Macro{item}, in a
- \Environment{description} environment %
- (\autoref{sec:scrlttr2.lists},
- \autopageref{desc:scrlttr2.env.description})}%
- \feentry{foldmark}{%
- foldmark on the letter page; intended for color settings %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.option.foldmarks})}%
- \feentry{footnote}{%
- footnote text and marker %
- (see \autoref{sec:scrlttr2.footnotes},
- \autopageref{desc:scrlttr2.cmd.footnote})}%
- \feentry{footnotelabel}{%
- mark of a footnote; used according to the element \FontElement{footnote} %
- (see \autoref{sec:scrlttr2.footnotes},
- \autopageref{desc:scrlttr2.cmd.footnote})}%
- \feentry{footnotereference}{%
- footnote reference in the text %
- (see \autoref{sec:scrlttr2.footnotes},
- \autopageref{desc:scrlttr2.cmd.footnote})}%
- \feentry{footnoterule}{%
- horizontal rule\ChangedAt{v3.07}{\Class{scrlttr2}} above the footnotes at
- the end of the text area %
- (see \autoref{sec:maincls.footnotes},
- \autopageref{desc:maincls.cmd.setfootnoterule})}%
- \feentry{labelinglabel}{%
- labels, i.\,e., the optional argument of \Macro{item} in the
- \Environment{labeling} environment %
- (see \autoref{sec:scrlttr2.lists},
- \autopageref{desc:scrlttr2.env.labeling})}%
- \feentry{labelingseparator}{%
- separator, i.\,e., the optional argument of the \Environment{labeling}
- environment; used according to the element \FontElement{labelinglabel} %
- (see \autoref{sec:scrlttr2.lists},
- \autopageref{desc:scrlttr2.env.labeling})}%
- \feentry{pagefoot}{%
- used after element \FontElement{pageheadfoot} for the page foot, that has
- been defined with variable \Variable{nextfoot}\IndexVariable{nextfoot}, or
- for the page foot of package \Package{scrpage2} %
- (\autoref{cha:scrpage}, \autopageref{desc:scrpage.fontelement.pagefoot})}%
- \feentry{pagehead}{%
- another name for \FontElement{pageheadfoot}}%
- \feentry{pageheadfoot}{%
- the head of a page, but also the foot of a page at all page style, that
- has been defined using \KOMAScript{} %
- (see \autoref{sec:scrlttr2.pagestyle},
- \autopageref{desc:scrlttr2.fontelement.pageheadfoot})}%
- \feentry{pagenumber}{%
- page number in the header or footer %
- (see \autoref{sec:scrlttr2.pagestyle},
- \autopageref{desc:scrlttr2.fontelement.pagenumber})}%
- \feentry{pagination}{%
- another name for \FontElement{pagenumber}}%
- \feentry{refname}{%
- description or title of the fields in the reference line %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.yourref})}%
- \feentry{refvalue}{%
- content of the fields in the reference line %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.yourref})}%
- \feentry{specialmail}{%
- mode of dispatch in the address field %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.specialmail})}%
- \feentry{subject}{%
- subject in the opening of the letter %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.subject})}%
- \feentry{title}{%
- title in the opening of the letter %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.title})}%
- \feentry{toaddress}{%
- variation of the element \FontElement{addressee} for setting the addressee
- address (less the name) in the address field %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.toaddress})}%
- \feentry{toname}{%
- variation of the element \FontElement{addressee} for the name (only) of
- the addressee in the address field %
- (\autoref{sec:scrlttr2.firstpage},
- \autopageref{desc:scrlttr2.variable.toname})}%
-\end{desclist}
-%
-\EndIndex{Cmd}{setkomafont}%
-\EndIndex{Cmd}{addtokomafont}%
-\EndIndex{Cmd}{usekomafont}%
-%
-\EndIndex{}{font}%
-\EndIndex{}{text>markup}
-
-
\section{Note Paper}
\label{sec:scrlttr2.firstpage}
\BeginIndex{}{note paper}%
@@ -1136,7 +1032,7 @@ chosen for a letter. Default values are \PValue{true} and \PValue{TBMPL}.
Assume that you would like to deactivate all folding marks except the punching
mark. This you can accomplish with, for example:
\begin{lstlisting}
- \KOMAoption{foldmarks=blmt}
+ \KOMAoptions{foldmarks=blmt}
\end{lstlisting}
as long as the defaults have not been changed previously. If some changes
might have been made before, a safer method should be used. This changes our
@@ -1372,7 +1268,7 @@ information about colors.%
\label{fig:scrlttr2.letter-10-11}
\end{figure}
In difference to this, the left letter has been set once again with the
- standard letter head, that doesn't react on the additional option.
+ standard letter head, that does not react on the additional option.
\end{Example}
An\textnote{Attention!} important note concerns the sender's address: within
@@ -1394,12 +1290,16 @@ signature (see variable \Variable{signature},
\begin{Declaration}
+ \KOption{symbolicnames}\PName{simple switch}\\
\KOption{fromphone}\PName{simple switch}\\
+ \KOption{frommobilephone}\PName{simple switch}\\
\KOption{fromfax}\PName{simple switch}\\
\KOption{fromemail}\PName{simple switch}\\
\KOption{fromurl}\PName{simple switch}\\
\Macro{setkomavar}\PParameter{\Variable{fromphone}}%
\OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{frommobilephone}}%
+ \OParameter{description}\Parameter{content}\\
\Macro{setkomavar}\PParameter{\Variable{fromfax}}%
\OParameter{description}\Parameter{content}\\
\Macro{setkomavar}\PParameter{\Variable{fromemail}}%
@@ -1408,6 +1308,8 @@ signature (see variable \Variable{signature},
\OParameter{description}\Parameter{content}\\
\Macro{setkomavar}\PParameter{\Variable{phoneseparator}}%
\OParameter{description}\Parameter{content}\\
+ \Macro{setkomavar}\PParameter{\Variable{mobilephoneseparator}}%
+ \OParameter{description}\Parameter{content}\\
\Macro{setkomavar}\PParameter{\Variable{faxseparator}}%
\OParameter{description}\Parameter{content}\\
\Macro{setkomavar}\PParameter{\Variable{emailseparator}}%
@@ -1415,30 +1317,49 @@ signature (see variable \Variable{signature},
\Macro{setkomavar}\PParameter{\Variable{urlseparator}}%
\OParameter{description}\Parameter{content}%
\end{Declaration}%
+\BeginIndex{Option}{symbolicnames~=\PName{simple switch}}%
\BeginIndex{Option}{fromphone~=\PName{simple switch}}%
+\BeginIndex{Option}{frommobilephone~=\PName{simple switch}}%
\BeginIndex{Option}{fromfax~=\PName{simple switch}}%
\BeginIndex{Option}{fromemail~=\PName{simple switch}}%
\BeginIndex{Option}{fromurl~=\PName{simple switch}}%
\BeginIndex{Variable}{fromphone}%
+\BeginIndex{Variable}{frommobilephone}%
\BeginIndex{Variable}{fromfax}%
\BeginIndex{Variable}{fromemail}%
\BeginIndex{Variable}{fromurl}%
\BeginIndex{Variable}{emailseparator}%
\BeginIndex{Variable}{faxseparator}%
\BeginIndex{Variable}{phoneseparator}%
+\BeginIndex{Variable}{mobilephoneseparator}%
\BeginIndex{Variable}{urlseparator}%
-Whether or not a telephone number\Index{telephone}\Index{phone}, a fax
-number\Index{fax}, an e-mail address\Index{e-mail}, or a sender's URL should
-be set as part of the letterhead may be configured by the options
-\Option{fromphone}, \Option{fromfax}, \Option{fromemail}, and
-\Option{fromurl}. Any standard value for simple switches from
-\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch} may be
-assigned to these options. Default is \PValue{false} for all of them. The
-\PName{contents} depends on the corresponding variable. The default of the
-\PName{description} or title of each variable may be found in
-\autoref{tab:scrlttr2.fromTerm}. The separators, that will be inserted between
-\PName{description} and \PName{content}, may be found in
-\autoref{tab:scrlttr2.fromSeparator}.
+Whether or not a telephone number\Index{telephone}\Index{phone}, a
+mobile\ChangedAt{v3.12}{\Class{scrlttr2}} telephone number\Index{mobile
+ phone}\Index{cell phone}\Index{cellphone}, a fax number\Index{fax}, an
+e-mail address\Index{e-mail}, or a sender's URL should be set as part of the
+letterhead may be configured by the options \Option{fromphone},
+\Option{fromfax}, \Option{fromemail}, and \Option{fromurl}. Any standard value
+for simple switches from \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch} may be assigned to these options. Default is
+\PValue{false} for all of them. The \PName{contents} depends on the
+corresponding variable. The default of the \PName{description} or title of
+each variable may be found in \autoref{tab:scrlttr2.fromTerm}. The separators,
+that will be inserted between \PName{description} and \PName{content}, may be
+found in \autoref{tab:scrlttr2.fromSeparator}.
+
+You may\ChangedAt{v3.12}{\Class{scrlttr2}}\important{\Option{symbolicnames}}
+change the defaults for the description of the separator variables at once
+using option \Option{symbolicnames}. The option understands the values for
+simple switches from \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Switching on the option replaces the
+descriptions from the language depending terms \Macro{emailname},
+\Macro{faxname}, \Macro{mobilephonename}, and \Macro{phonename} into symbols
+of the package \Package{marvosym}\IndexPackage{marvosym}. Also the colon will
+be removed from the content of the separator variables. And in this case the
+description and the content of the URL separator will be
+empty. Note\textnote{Attention!}, that you have to load package
+\Package{marvosym} on your own, if you switch on \Option{symbolicnames}
+first time after \Macro{begin}\PParameter{document}.
\begin{table}
\centering
@@ -1451,6 +1372,10 @@ assigned to these options. Default is \PValue{false} for all of them. The
\Macro{usekomavar}\PParameter{emailseparator}}%
\ventry{fromfax}{\Macro{usekomavar*}\PParameter{faxseparator}%
\Macro{usekomavar}\PParameter{faxseparator}}%
+ \ventry{frommobilephone}{%
+ \ChangedAt{v3.12}{\Class{scrlttr2}}%
+ \Macro{usekomavar*}\PParameter{mobilephoneseparator}%
+ \Macro{usekomavar}\PParameter{mobilephoneseparator}}%
\ventry{fromname}{\Macro{headfromname}}%
\ventry{fromphone}{\Macro{usekomavar*}\PParameter{phoneseparator}%
\Macro{usekomavar}\PParameter{phoneseparator}}%
@@ -1466,7 +1391,7 @@ assigned to these options. Default is \PValue{false} for all of them. The
\setcapindent{0pt}%
% \caption
\begin{captionbeside}{Predefined description and content of the separators
- at the letterhead}
+ at the letterhead without option \Option{symbolicnames}}
[l]
\begin{tabular}[t]{lll}
\toprule
@@ -1474,6 +1399,7 @@ assigned to these options. Default is \PValue{false} for all of them. The
\midrule
\Variable{emailseparator} & \Macro{emailname} & \texttt{:\~} \\
\Variable{faxseparator} & \Macro{faxname} & \texttt{:\~} \\
+ \Variable{mobilephoneseparator} & \Macro{mobilephonename} & \Macro{usekomavaer}\PParameter{phoneseparator} \\
\Variable{phoneseparator} & \Macro{phonename} & \texttt{:\~} \\
\Variable{urlseparator} & \Macro{wwwname} & \texttt{:\~} \\
\bottomrule
@@ -1533,17 +1459,21 @@ assigned to these options. Default is \PValue{false} for all of them. The
\end{Example}
%
\EndIndex{Variable}{urlseparator}%
+\EndIndex{Variable}{mobilephoneseparator}%
\EndIndex{Variable}{phoneseparator}%
\EndIndex{Variable}{faxseparator}%
\EndIndex{Variable}{emailseparator}%
\EndIndex{Variable}{fromurl}
\EndIndex{Variable}{fromemail}
\EndIndex{Variable}{fromfax}
+\EndIndex{Variable}{frommobilephone}%
\EndIndex{Variable}{fromphone}%
\EndIndex{Option}{fromurl~=\PName{simple switch}}%
\EndIndex{Option}{fromemail~=\PName{simple switch}}%
\EndIndex{Option}{fromfax~=\PName{simple switch}}%
+\EndIndex{Option}{frommobilephone~=\PName{simple switch}}%
\EndIndex{Option}{fromphone~=\PName{simple switch}}%
+\EndIndex{Option}{symbolicnames~=\PName{simple switch}}%
\begin{Declaration}
\KOption{fromlogo}\PName{simple switch}\\
@@ -1558,7 +1488,7 @@ logo\Index{Logo} at the letterhead. The option value may be any \PName{simple
\autopageref{tab:truefalseswitch}. Default is \PValue{false}, that means no
logo. The logo itself is defined by the \PName{content} of variable
\Variable{fromlogo}. The \PName{description} of the logo is empty by default
-and \KOMAScript{} won't use it anywhere at the predefined note papers (see
+and \KOMAScript{} does not use it anywhere at the predefined note papers (see
also \autoref{tab:scrlttr2.fromTerm}).%
\begin{Example}
Mr Public likes to use a letterhead with logo. He generated a graphics file
@@ -1610,7 +1540,7 @@ construction as content of variable \Variable{firsthead}. Within
or one underneath the other. An advanced user will thus be able to
create a letterhead on his own. Of course the construct may
and should use other variables with the help of
-\Macro{usekomavar}. \KOMAScript{} doesn't use the
+\Macro{usekomavar}. \KOMAScript{} does not use the
\PName{description} of variable \Variable{firsthead}.
\iffree{}{A detailed example for the definition of a letterhead will be shown
in \autoref{cha:modernletters}.}
@@ -1733,7 +1663,7 @@ will be printed. Option \Option{backaddress} defines whether a return address
for window envelopes will be set. This
option\important{\OptionValue{backaddress}{false}} can take the standard
values for simple switches, as listed in \autoref{tab:truefalseswitch},
-\autopageref{tab:truefalseswitch}. These values don't change style of the
+\autopageref{tab:truefalseswitch}. These values do not change style of the
return address. On the other hand,
additionally\ChangedAt{v2.96}{\Class{scrlttr2}} to switching on the return
address, the style of the return address may be selected. Option value
@@ -1748,7 +1678,7 @@ The return address itself is defined by the \PName{content} of variable
and \Variable{toaddress} with redefinition of the double backslash to set the
\PName{content} of variable \Variable{backaddressseparator}. The predefined
separator \PName{content} is a comma followed by a non-breakable white
-space. The \PName{description} of variable \Variable{backaddress} isn't used
+space. The \PName{description} of variable \Variable{backaddress} is not used
by \KOMAScript. The font style of the return address is configurable via
element
\FontElement{backaddress}\important{\FontElement{backaddress}}. Default for
@@ -1813,7 +1743,7 @@ type\Index{mode of dispatch}\Index{dispatch type} can be output within the
address field between the return address and the addressee address, This will
be done only if variable \Variable{specialmail} is not empty and
\OptionValue{priority}{manual}\ChangedAt{v3.03}{\Class{scrlttr2}} has been
-selected, which is also the default. Class \Class{scrlttr2} itself doesn't use
+selected, which is also the default. Class \Class{scrlttr2} itself does not use
the \PName{description} of variable \Variable{specialmail}. The alignment is
defined by the pseudo-lengths PLength{specialmailindent} and
\PLength{specialmailrightindent} (siehe
@@ -1910,7 +1840,7 @@ With\important[i]{\begin{tabular}[t]{@{}l@{}}
\OptionValue{addrfield}{backgroundimage}\ChangedAt{v3.03}{\Class{scrlttr2}}
or \OptionValue{addrfield}{image} a picture will be print inside the address
field. The \PName{content} of variable \Variable{addresseeimage} will be used
-for this. \KOMAScript{} doesn't use the \PName{description} of that
+for this. \KOMAScript{} does not use the \PName{description} of that
variable. Nothing else but the picture will be printed with option
\OptionValue{addrfield}{image}. But with option
\OptionValue{addrfield}{backgroundimage} the addressee's name and address from
@@ -1994,7 +1924,7 @@ option are shown in \autoref{tab:scrlttr2.locfield}. Default is
The contents of the sender's extension field is determined by the
variable \Variable{location}. To set this variable's \PName{content}, it is
permitted to use formatting commands like \Macro{raggedright}. \KOMAScript{}
-doesn't use the \PName{description} of the variable.
+does not use the \PName{description} of the variable.
\begin{Example}
Mr Public likes to show some additional information about his
@@ -2048,12 +1978,14 @@ standard date presentation.
\BeginIndex{Variable}{date}%
The date in the selected presentation will become the \PName{content} of
variable \Variable{date}. The selection of option \Option{numericaldate}
-doesn't influence the date any longer, if the \PName{content} of this variable
+does not influence the date any longer, if the \PName{content} of this variable
will be changed by the user. Normally the date will be part of the reference
-line. This is the case even if all other elements of the reference line will
-be empty and therefore unused. For more information about the automatic
-printing of the date may be found in following description of option
-\Option{refline}.%
+line. If all other elements of the reference line will be empty and therefore
+unused a date line instead of a reference line will be printed. See the
+description of variable \Variable{place} on
+\autopageref{desc:scrlttr2.variable.placeseparator} for more information about
+the date line. You should note, that you can change the automatic printing of
+the date using option \Option{refline}, that will be described next.
%
\EndIndex{Variable}{date}%
\EndIndex{Option}{numericaldate~=\PName{switch}}%
@@ -2072,7 +2004,7 @@ be named \emph{reference line}\textnote{reference line} in this manual.
With the \Class{scrlttr2} class, the header, footer, address, and sender
attributes may extend beyond the normal type area to the left and to the
-right. Option \Option{refline}{wide} defines that this should also apply to
+right. Option \OptionValue{refline}{wide} defines that this should also apply to
the reference fields line. Normally, the reference fields line contains at
least the date, but it can hold additional data. Possible values for this
option are shown in \autoref{tab:scrlttr2.refline}. Default is \PValue{narrow}
@@ -2092,7 +2024,7 @@ and \PValue{dateright}\ChangedAt{v3.09}{\Class{scrlttr2}}.%
\pventry{narrow}{The reference line will be restricted to type
area.}%
\pventry{nodate}{\ChangedAt{v3.09}{\Class{scrlttr2}}%
- The date won't be placed automatically into the reference line.}%
+ The date is not placed automatically into the reference line.}%
\pventry{wide}{The with of the reference line corresponds to address and
sender's additional information.}%
\end{desctabular}
@@ -2202,6 +2134,21 @@ unset also. The predefined \PName{content} of \Variable{date} is
\Macro{today}\IndexCmd{today} and depends on the setting of the option
\Option{numericaldate} (see \autopageref{desc:scrlttr2.option.numericaldate}).
+Since version~3.09\ChangedAt{v3.09}{\Class{scrlttr2}} place and date the
+alignment of place and date is given by option \Option{refline}. The available
+alignment values for this option are listed in \autoref{tab:scrlttr2.refline}.
+
+\BeginIndex{FontElement}{placeanddate}%
+The\ChangedAt{v3.12}{\Class{scrlttr2}} font setting of place and date in the
+date line are given by font
+element\FontElement{placeanddate}\important[i]{\FontElement{placeanddate}}
+instead of element \FontElement{refvalue}, which would be used for general
+reference lines. You can change the empty default of the font element using
+commands \Macro{setkomafont} and \Macro{addtokomafont} (see
+\autoref{sec:scrlttr2.textmarkup},
+\autopageref{desc:scrlttr2.cmd.setkomafont}).%
+\EndIndex{FontElement}{placeanddate}%
+
\begin{Example}
Now Mr Public also sets the place:%
\lstinputcode[xleftmargin=1em]{letter-20.tex}%
@@ -2419,10 +2366,10 @@ the setting of the letter foot.
The first page's footer is preset to
empty. However\ChangedAt{v3.08}{\Class{scrlttr2}}, a new construction may be
made at the \PName{content} of variable \Variable{firstfoot}. \KOMAScript{}
-doesn't use the \PName{description} of the variable. For more information see
+does not use the \PName{description} of the variable. For more information see
the example following the next description. Only for compatibility reason the
deprecated command \Macro{firstfoot}\IndexCmd[indexmain]{firstfoot} of
-\Class{scrlttr2} before release~3.08 still exists. Nevertheless it shouldn't
+\Class{scrlttr2} before release~3.08 still exists. Nevertheless it should not
be used any longer.
\begin{Declaration}
@@ -2545,14 +2492,14 @@ head. Activation\important{\OptionValue{footsepline}{true}} of option
\Option{footsepline} switches on a rule above the page foot. Deactivation of
the options switches of the corresponding rules.
-Obviously option \Option{headsepline} doesn't influence page styles
+Obviously option \Option{headsepline} does not influence page styles
\PValue{empty}\important[i]{\Pagestyle{empty}\\
\Pagestyle{plain}} and \PValue{plain} (see afterwards at this
-section). These page styles explicitly don't use any page head.
+section). These page styles explicitly do not use any page head.
Typographically\important[i]{\Pagestyle{headings}\\
\Pagestyle{myheadings}} such a rule make a hard optical connection of head
-or foot and the text area. This wouldn't mean, that the distance between head
+or foot and the text area. This would not mean, that the distance between head
and text or text and foot should be increased. Instead of this the head or
foot should be seen as parts of the typing area, while calculation of margins
and typing area. To achieve this \KOMAScript{} will pass option
@@ -2761,12 +2708,12 @@ boxes side by side or one beneath the other by use of the \Macro{parbox}
command (see \cite{latex:usrguide}). A more advanced user should have no
problems creating letterheads of footers of his own. Within \PName{content}
you can and should of course also make use of other variables by using
-\Macro{usekomavar}. \KOMAScript{} doesn't use the \PName{description} of both
+\Macro{usekomavar}. \KOMAScript{} does not use the \PName{description} of both
variables.
Only\textnote{Attention!} for compatibility reason the deprecated commands \Macro{nexthead}\IndexCmd[indexmain]{nexthead} and
\Macro{nextfoot}\IndexCmd[indexmain]{nextfoot} of former \Class{scrlttr2}
-releases before 3.08 are also implemented. Nevertheless, you shouldn't use
+releases before 3.08 are also implemented. Nevertheless, you should not use
those.%
%
\EndIndex{Variable}{nextfoot}%
@@ -2798,12 +2745,12 @@ There are not math environments implemented at the \KOMAScript{}
classes. Instead of this, the math features of the \LaTeX{} kernel have been
supported. Furthermore\textnote{Attention!} regular math with numbered
equations or formulas is very unusual at letters. Because of this
-\Class{scrlttr2} doesn't actively support numbered equations. Therefore
+\Class{scrlttr2} does not actively support numbered equations. Therefore
options \Option{leqno} and \Option{fleqn}, that has been described for
\Class{scrbook}, \Class{scrreprt}, and \Class{scrartcl} at
\autoref{sec:maincls.math} are not available from \Class{scrlttr2}.
-You won't find a description of the math environments of the \LaTeX{} kernel
+You will not find a description of the math environments of the \LaTeX{} kernel
here. If you want to use \Environment{displaymath}\IndexEnv{displaymath},
\Environment{equation}\IndexEnv{equation} and
\Environment{eqnarray}\IndexEnv{eqnarray} you should read a short introduction
@@ -2819,7 +2766,7 @@ recommended (see \cite{package:amsmath}).%
\label{sec:scrlttr2.floats}
Floating environments for tables or figures are very unusual in
-letters. Therefore\textnote{Attention!} \Class{scrlttr2} doesn't provide
+letters. Therefore\textnote{Attention!} \Class{scrlttr2} does not provide
them. If someone nevertheless needs floating environments, then this is often
points out a malpractice of the letter class. In such cases you may try to
define the floating environments with help of packages like \Package{tocbasic}\important{\Package{tocbasic}} (siehe
@@ -3000,13 +2947,13 @@ If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco}-file is loaded via
\begin{Example}
Since Mr~Public often writes letters with the same options and parameters,
- he doesn't like to copy all these to each new letter. To simplify the effort
+ he does not like to copy all these to each new letter. To simplify the effort
of writing a new letter, he therefore makes a \File{lco}-file:%
\lstinputcode[xleftmargin=1em]{ich.lco}%
With this the size of the previous letter decreases to:
\lstinputcode[xleftmargin=1em]{letter-23.tex}%
Nevertheless, as shown in \autoref{fig:scrlttr2.letter-23}, the result
- doesn't change.
+ does not change.
\begin{figure}
\setcapindent{0pt}%
\begin{captionbeside}[{Example: letter with extended sender, logo,
@@ -3397,7 +3344,9 @@ current version of \Package{adrconv} supports the \Macro{addrentry} and
%%% Local Variables:
%%% mode: latex
+%%% mode: flyspell
%%% coding: us-ascii
+%%% ispell-local-dictionary: "en_GB"
%%% TeX-master: "../guide"
%%% End:
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex
index 603adeb934d..937acdec0b0 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrpage2.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrpage2.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,12 +45,14 @@
%
% ============================================================================
-\ProvidesFile{scrpage2.tex}[2012/02/22 KOMA-Script guide (chapter:scrpage2)]
+\KOMAProvidesFile{scrpage2.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter:scrpage2)]
\translator{Jens-Uwe Morawski\and Karl-Heinz Zimmer\and Christoph Bier\and
Gernot Hassenpflug\and Markus Kohm}
-% date of translated german file: 2012/02/22
+% date of translated german file: 2013/07/22
\chapter{Adapting Page Headers and Footers with \Package{scrpage2}}
\labelbase{scrpage}
@@ -97,7 +99,7 @@ documentation describes only \Package{scrpage2}. The package
\end{Explain}
-Package \Package{scrpage2} doesn't distinguish between page styles with
+Package \Package{scrpage2} does not distinguish between page styles with
automatic, running headings and page styles with manual headings. The way to
deal with automatic and manual headings is independent from the page style and
so the page style is independent from the choice of automatic or manual
@@ -745,7 +747,7 @@ elements \FontElement{headtopline}\important[i]{\FontElement{headtopline}\\
\FontElement{footbotline}. These can then be extended via
\Macro{addtokomafont}\IndexCmd{addtokomafont}. See
\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}
-for details on the \Macro{setkomafont} and \Macro{addkomafont} commands.
+for details on the \Macro{setkomafont} and \Macro{addtokomafont} commands.
\EndIndex{FontElement}{footbottomline}%
\EndIndex{FontElement}{footbotline}%
\EndIndex{FontElement}{footsepline}%
@@ -853,7 +855,7 @@ together with other package options in the next
In opposite to the \KOMAScript{} classes, where the most options may be
changed using \Macro{KOMAoptions} or \Macro{KOMAoption} also after loading the
-class, package \Package{scrpage2} doesn't provide this feature\iffree{
+class, package \Package{scrpage2} does not provide this feature\iffree{
currently}{}. All options to \Package{scrpage2} have to be global options,
i.\,e. be part of the optional argument of \Macro{documentclass}, or
package option, i.\,e. be part of the optional argument of \Macro{usepackage}.
@@ -867,7 +869,7 @@ package option, i.\,e. be part of the optional argument of \Macro{usepackage}.
\BeginIndex{Option}{headinclude}\BeginIndex{Option}{footinclude}%
\BeginIndex{Option}{headexclude}\BeginIndex{Option}{footexclude}%
Since\textnote{Attention!} \KOMAScript~3\ChangedAt{v2.3}{\Package{scrpage2}}
-this options shouldn't be passed to \Package{scrpage2} any longer using
+this options should not be passed to \Package{scrpage2} any longer using
\Macro{PassOptionsToPackage} or the optional argument of
\Macro{usepackage}. Only for compatibility reason \Package{scrpage2} still
declares them and pass them as \Option{headinclude},
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrwfile.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrwfile.tex
index baf1d38f565..9d69c9d2fc7 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrwfile.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrwfile.tex
@@ -6,7 +6,7 @@
%%
%% scrwfile.dtx (with options: `doc')
%%
-%% Copyright (c) 2010-2012 by Markus Kohm <komascript(at)gmx.info>
+%% Copyright (c) 2010-2013 by Markus Kohm <komascript(at)gmx.info>
%%
%% This file was generated from file(s) of the KOMA-Script bundle.
%% ---------------------------------------------------------------
@@ -43,9 +43,9 @@
%% EVERYTHING MAY CHANGE IN FUTURE!
%% THERE IS NO SUPPORT, IF YOU USE THIS PACKAGE!
%%
-%%% From File: scrwfile.dtx
+%%% From File: $Id: scrwfile.dtx 1562 2013-12-19 07:51:16Z mjk $
\ProvidesFile{scrwfile.tex}
- [2012/03/05 v0.1d-alpha LaTeX2e KOMA-Script package (write and clone files)]
+ [2013/08/05 v0.1f-alpha LaTeX2e KOMA-Script package (write and clone files)]
\chapter[{Spare and Replace Files Using \Package{scrwfile}}]
{Spare and Replace Files Using \Package{scrwfile}%
}
@@ -143,7 +143,7 @@ limited any longer.
Sometimes it is useful to input a file not only once but several times. As
\Macro{@starttoc} does not open files for writing any longer, this may be
-done by simply using \Macro{\@starttoc} several times with the same
+done by simply using \Macro{@starttoc} several times with the same
extension. But sometimes you may have additional entries in only some of the
content directories. Because of this, \Package{scrwfile} allows to copy all
entries of a file to another file, too. We call this cloning.
@@ -178,23 +178,53 @@ contents:
\begin{lstcode}
\usepackage{scrwfile}
\TOCclone[Short \contentsname]{toc}{stoc}
- \AtBeginDocument{%
- % aux first opened at \begin{document}. So wait until this:
- \addtocontents{toc}{% first toc entry:
- \proctect\addcontentsline{stoc}{% write to Short Contents
- \protect\tableofcontents% Contents
- }%
- }%
+\end{lstcode}
+This would create a new table of contents with the heading ^^c2^^bbShort
+Contents^^c2^^ab. The new table of contents uses a helper file with extension
+\File{stoc}. All entries to the helper file with extension \File{toc} will
+also be copied to this new helper file.
+
+The new short table of contents should only have the chapter entries. This may
+be done using:
+\begin{lstcode}
+ \addtocontents{stoc}{\protect\value{tocdepth}=0}
+\end{lstcode}
+Normally you cannot write into a helper file before
+\Macro{begin}\PParameter{document}. But using \Package{scrwfile} changes
+this. So the code above will be successful after loading \Package{scrwfile}.
+
+To show the new short contents of helper file extension \File{stoc} we will
+use
+\begin{lstcode}[moretexcs={listofsttoc}]
+ \listofstoc
+\end{lstcode}
+somewhere after \Macro{begin}\PParameter{document}.
+
+If we also want an entry for the table of contents at the short contents, we
+cannot use
+\begin{lstcode}
+ \addtocontents{toc}{% write to the Contents
+ \protect\addcontentslinedefault{stoc}% write to Short Contents
+ {chapter}% a chapter entry with
+ {\contentsname}% the Contents' name
+ }
+\end{lstcode}
+because the \Macro{addcontentsline} command would be copied to \File{stoc}
+too. So we cannot add the command to the \File{toc}-file. Package
+\Package{tocbasic}\important{\Package{tocbasic}} may be used to solve this:
+\csname phantomsection\endcsname\label{example:scrwfile.AfterStartingTOC}
+\begin{lstcode}
+ \AfterStartingTOC[toc]{%
+ \addcontentslinedefault{stoc}{chapter}
+ {\protect\contentsname}%
}
- \begin{document}
- \setcounter{tocdepth}{1}% show chapters only
- \listofstoc% Write short table of contents
- \setcounter{tocdepth}{6}% show all levels
- \tableofcontents% Write table of contents
\end{lstcode}
-You need at least three \LaTeX{} runs to get a short table of contents and a
-detailed table of contents. The detailed one produces an entry at the short
-one but this entry will not be part of the detailed table of contents.
+But this needs, that the file with extension \File{toc} is under control of
+package \Package{tocbasic}, which is indeed the case within all \KOMAScript{}
+classes.
+See \autoref{sec:tocbasic.toc} on
+\autopageref{desc:tocbasic.cmd.AfterStartingTOC} for more information about
+\Macro{AfterStartingTOC}.%
\end{Example}
\EndIndex{Cmd}{TOCclone}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
index 0e84fc54c33..3e240f8f973 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
@@ -1,48 +1,59 @@
+\immediate\write17{^^J%
++----------------------------------------------------------------------^^J%
+| WARNING (`tocbasic.tex'):^^J%
++----------------------------------------------------------------------^^J%
+| YOU SHOULD NOTE, THAT THIS IS NOT AN OFFICIAL RELEASE!^^J%
+| THIS VERSION IS INTENDED TO BE USED FOR TESTING ONLY!^^J%
+| USAGE FOR PURPOSES OTHER THAN INTENDED IS DANGEROUS!^^J%
+| DON'T EXPECT ANY SUPPORT FOR THIS VERSION!^^J%
++----------------------------------------------------------------------^^J%
+}
%%
%% This is file `tocbasic.tex',
-%% generated with the docstrip utility.
+%% generated with the docstrip utility, extended by scrdocstrip.
%%
%% The original source files were:
%%
%% tocbasic.dtx (with options: `doc')
%%
-%% Copyright (c) 2007-2012
-%% Markus Kohm and any individual authors listed elsewhere in this file.
+%% Copyright (c) 2008-2013 Markus Kohm [komascript at gmx info]
%%
%% This file was generated from file(s) of the KOMA-Script bundle.
%% ---------------------------------------------------------------
%%
-%% This work may be distributed and/or modified under the conditions of
-%% the LaTeX Project Public License, version 1.3c of the license.
-%% The latest version of this license is in
-%% http://www.latex-project.org/lppl.txt
-%% and version 1.3c or later is part of all distributions of LaTeX
-%% version 2005/12/01 or later and of this work.
+%% It may be distributed under the conditions of the
+%% LaTeX Project Public License in the version distributed together
+%% with KOMA-Script, see file `lppl.txt' or `lppl-de.txt'.
%%
-%% This work has the LPPL maintenance status "author-maintained".
+%% This file may only be distributed together with a copy of the
+%% KOMA-Script bundle. You may however distribute the
+%% KOMA-Script bundle without all such generated files. See also
+%% `lppl.txt' or `lppl-de.txt' for additional information.
%%
-%% The Current Maintainer and author of this work is Markus Kohm.
+%% The list of files belonging to KOMA-Script distribution is given in
+%% the file `manifest.txt'. See also `lppl.txt' or `lppl-de.txt' for
+%% additional information.
%%
-%% This file may only be distributed together with the files
-%% `scrlogo.dtx' and `tocbasic.dtx'. You may however distribute the files
-%% `scrlogo.dtx' and `tocbasic.dtx' without this file.
-%% See also `tocbasic.dtx' for additional information.
+%% If this file is a beta version, you may not be allowed to distribute
+%% it. Look at the comments below to see if this is the case.
%%
-%% If this file is a beta version, you are not allowed to distribute it.
+%% English and German manuals are part of KOMA-Script bundle.
+%% ----------------------------------------------------------
%%
-%% Currently there is only a short english manual at `tocbasic.dtx', that
-%% should also be found as `tocbasic.pdf'.
+%% See `README'.
%%
%% The KOMA-Script bundle (but maybe not this file) was based upon the
-%% LaTeX2.09 Script family created by Frank Neukam 1993 and the LaTeX2e
-%% standard classes created by The LaTeX3 Project 1994-1996.
+%% LaTeX 2.09 Script family created by Frank Neukam 1993 and the LaTeX2e
+%% standard classes created by The LaTeX3 Project 1994-1996. You may
+%% find a complete unmodified copy of LaTeX2e at
+%% <http://www.ctan.org/pub/tex-archive/macros/latex/base/>.
%%
-%%% From File: tocbasic.dtx
-\def\tocbasicversion{2012/04/04 v3.10b}
-\ProvidesFile{tocbasic.tex}
- [\tocbasicversion\space KOMA-Script package
- (manual)%
- ]
+%%% From File: $Id: tocbasic.dtx 1533 2013-12-10 18:06:14Z mjk $
+\ProvidesFile{tocbasic.tex}[%
+ 2013/12/19 v3.12 KOMA-Script
+ package
+ (handling toc-files)%
+]
\translator{Markus Kohm}
@@ -65,7 +76,7 @@ the list of figures and the list of tables and thereby allow other classes or
packages some types of controll about these. For examples package
\Package{tocbasic} delegates language control of all these tables and lists of
contents to package \Package{babel}\IndexPackage{babel}%^^A
-(see \cite{package:babel})%^^A
+\ (see \cite{package:babel})%^^A
. So automatic change of language will be provides inside
all these tables and lists of contents. Using \Package{tocbasic} will
exculpate authors of classes and packages from implementation of such
@@ -333,37 +344,89 @@ Commands, that shouldn't be expanded while writing, should be prefixed by
\EndIndex{Cmd}{addtoeachtocfile}%
\begin{Declaration}
- \Macro{addcontentslinetoeachtocfile}\OParameter{owner}\Parameter{level}%
- \Parameter{contentsline}
+ \Macro{addxcontentsline}%
+ \Parameter{extension}\Parameter{level}\OParameter{number}%^^A
+ \Parameter{text}
+\end{Declaration}
+\BeginIndex{Cmd}{addxcontentsline}%
+The command \Macro{addxcontentsline}
+adds an entry of given \PName{level} to toc-file with \PName{extension}. If
+the \Parameter{number} is empty or omitted the entry won't have a number for
+the entry with the given \PName{text}. Entries without number may be left
+aligned to the number of the numbered entries of the same \PName{level} or
+indented like the text of the numbered entries of the same \PName{level},
+depending on the \PValue{numberline} feature.
+
+\begin{Example}
+ Maybe you are not using a \KOMAScript{} class but need a not numbered
+ chapter with entry to the table of contents. This may be done using
+\begin{lstcode}
+ \cleardoublepage
+ \csname phantomsection\endcsname
+ \addxcontentsline{toc}{chapter}
+ {Chapters without Numbers}
+ \chapter*{Chapters without Numbers}
+ \markboth{Chapters without Numbers}{}
+\end{lstcode}
+ As you can see, you simply have to replace usual \Macro{addcontentsline} by
+ \Macro{addxcontentsline} to support the \Package{tocbasic} feature
+ \PValue{numberline}.
+\end{Example}
+
+Note, that \Macro{addxcontentsline} uses
+\Macro{add\PName{level}\PName{extension}entry} if such a macro exists and
+\Macro{tocbasic@addxcontentsline} otherwise. Therefore you cannot define
+a macro \Macro{add\PName{level}\PName{extension}entry} using
+\Macro{addxcontentsline} but \Macro{tocbasic@addxcontentsline}.
+
+It is recommended to use \Macro{addxcontentsline} instead of
+\Macro{addcontentsline} whenever possible.%
+\EndIndex{Cmd}{addxcontentsline}
+
+\begin{Declaration}
+ \Macro{addcontentslinetoeachtocfile}\OParameter{owner}\Parameter{level}%^^A
+ \Parameter{contentsline}\\
+ \Macro{addxcontentslinetoeachtocfile}\OParameter{owner}%^^A
+ \Parameter{level}\OParameter{number}\Parameter{text}
\end{Declaration}
\BeginIndex{Cmd}{addcontentslinetoeachtocfile}%
-This command
+\BeginIndex{Cmd}{addxcontentslinetoeachtocfile}%
+The first command
is something like \Macro{addcontentsline} from \LaTeX{} kernel. In difference
to that it writes the \PName{contentsline} not only
into one file, but into all files of all known file extensions or of all known
file extensions of a given owner.
+
+The Command \Macro{addxcontentslinetoeachtocfile}%^^A
+\ is similar but uses
+\Macro{addxcontentsline} instead of \Macro{addcontentsline} and
+therefore supports \Package{tocbasic} feature \PValue{numberline}.
\begin{Example}
You are a class author and want to write the chapter entry not only to the
table of contents toc-file but to all toc-files, while \texttt{\#1} is the
title, that should be written to the files.
\begin{lstcode}
- \addcontentslinetoeachtocfile{chapter}{%
- \protect\numberline{\thechapter}#1}
+ \addxcontentslinetoeachtocfile
+ {chapter}[\thechapter]{#1}%
\end{lstcode}
In this case the current chapter number should be expanded while writing
into the file. So it isn't protected from expansion using \Macro{protect}.
\end{Example}
-While writing
-\Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}} is the file
-extension of the file into which \PName{contentsline} will be written.
+While writing \Macro{@currext}\IndexCmd{@currext}\important{\Macro{@currext}}
+is the file extension of the file into which \PName{contentsline} will be
+written.
+
+It is recommended to use \Macro{addxcontentslinetoeachtocfile} instead
+of \Macro{addcontentslinetoeachtocfile} whenever possible.
+\EndIndex{Cmd}{addxcontentslinetoeachtocfile}%
\EndIndex{Cmd}{addcontentslinetoeachtocfile}%
\begin{Declaration}
- \Macro{listoftoc}\OParameter{list of title}\Parameter{extension}
+ \Macro{listoftoc}\OParameter{list of title}\Parameter{extension}%^^A
\\
- \Macro{listoftoc*}\Parameter{extension}
+ \Macro{listoftoc*}\Parameter{extension}%^^A
\\
- \Macro{listofeachtoc}\OParameter{owner}
+ \Macro{listofeachtoc}\OParameter{owner}%^^A
\\
\Macro{listof\PName{file-extension}name}
\end{Declaration}
@@ -603,6 +666,11 @@ features. \Package{tocbasic} does know following features:
\OptionValue{listof}{numbered}\important{\OptionValue{listof}{numbered}}%
\IndexOption{listof~=\PValue{numbered}} for all file extensions of the owner
\PValue{float}.
+\item[\texttt{numberline}] \leavevmode\ChangedAt{v3.12}{\Package{tocbasic}}%
+ redefines \Macro{nonumberline} to use \Macro{numberline}. With this the not
+ numbered entries generated by \KOMAScript{} or using \Macro{nonumberline} at
+ the very beginning of the last argument of \Macro{addcontentline} will also
+ be indented like numbered entries of the same type.
\item[\texttt{onecolumn}] \leavevmode\ChangedAt{v3.01}{\Package{tocbasic}}%
typesets the corresponding table of contents or list of something with
internal one column mode of
@@ -843,6 +911,18 @@ toc-entry, and running head, if it was defined. If it was not defined it will
be defined and used in \Macro{tocbasic@listhead} automatically.
\EndIndex{Cmd}{tocbasic@listhead@\PName{extension}}%
+\begin{Declaration}
+ \Macro{tocbasic@addxcontentsline}%
+ \Parameter{extension}\Parameter{level}\Parameter{number}\Parameter{text}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@addxcontentsline}%
+This command
+uses \Macro{addcontentsline} to either create a numbered or not numbered text
+entry to toc-file with given \PName{extension}. Note, that all parameters of
+\Macro{tocbasic@addxcontentsline} are mandatory. But you may use an
+empty \PName{number} argument, if you don't want a number.
+\EndIndex{Cmd}{tocbasic@addxcontentsline}
+
\section{A Complete Example}
\label{sec:tocbasic.example}
@@ -1137,6 +1217,79 @@ may be found in \autoref{tab:tocbasic.DeclareNewTOC-options}.
additionally, then a non-floating environment \Environment{remarkbox-} will
be also defined. You may use \Macro{caption}\IndexCmd{caption} inside of
that non-floating environment as usual for floating environments.
+ \hyperref[tab:tocbasic.comparison]{Figure~\ref*{tab:tocbasic.comparison}}
+ showes a comparison of the commands, counters and environments of the
+ example environment \Environment{remarkbox} and of the commands, counters
+ and environments for figures.%
+ \begin{table}
+ \centering
+ \caption{Comparison of example environment \Environment{remarkbox}
+ and environment \Environment{figure}}
+ \label{tab:tocbasic.comparison}
+ \begin{tabularx}{\textwidth}{ll>{\raggedright}p{6em}X}
+ \toprule
+ \Environment{remarkbox} & \Environment{figure}
+ & options of \Macro{DeclareNewTOC} & short description \\[1ex]
+ \midrule
+ \Environment{remarkbox} & \Environment{figure}
+ & \Option{type}, \Option{float}
+ & floating environments of the respective types\\[1ex]
+ \Environment{remarkbox*} & \Environment{figure*}
+ & \Option{type}, \Option{float}
+ & columns spanning floating environments of the respective types\\[1ex]
+ \Counter{remarkbox} & \Counter{figure}
+ & \Option{type}, \Option{float}
+ & counter used by \Macro{caption}\\[1ex]
+ \Macro{theremarkbox} & \Macro{thefigure}
+ & \Option{type}, \Option{float}
+ & output command to the respective counters\\[1ex]
+ \Macro{remarkboxformat} & \Macro{figureformat}
+ & \Option{type}, \Option{float}
+ & formating command to the respective counters used by
+ \Macro{caption}\\[1ex]
+ \Macro{remarkboxname} & \Macro{figurename}
+ & \Option{type}, \Option{float}, \Option{name}
+ & names used in the label of \Macro{caption}\\[1ex]
+ \Macro{listofremarkboxes} & \Macro{listoffigures}
+ & \Option{types}, \Option{float}
+ & command to show the list of the respective environments\\[1ex]
+ \Macro{listremarboxname} & \Macro{listfigurename}
+ & \Option{type}, \Option{float}, \Option{listname}
+ & heading text of the respective list \\[1ex]
+ \Macro{fps@remarkbox} & \Macro{fps@figure}
+ & \Option{type}, \Option{float}, \Option{floattype}
+ & numeric float type for order perputation\\[1ex]
+ \File{lor} & \File{lof}
+ &
+ & file extension of the helper file of the respective list \\
+ \bottomrule
+ \end{tabularx}
+ \end{table}
+
+ And now a possible usage of the example environment:
+\begin{lstcode}
+ \begin{remarkbox}
+ \centering
+ Equal should be typeset equally
+ and with equal formatting.
+ \caption{First theorem of typography}
+ \label{rem:typo1}
+ \end{remarkbox}
+\end{lstcode}
+ A segment of an example page with this environment could be:
+ \begin{center}\footnotesize
+ \begin{tabular}
+ {|!{\hspace{.1\linewidth}}p{.55\linewidth}!{\hspace{.1\linewidth}}|}
+ \\
+ \centering
+ Equal should be typeset equally
+ and with equal formatting.\\[\abovecaptionskip]
+ {%
+ \usekomafont{caption}\footnotesize{\usekomafont{captionlabel}%
+ Remark 1: }First theorem of typography
+ }\\
+ \end{tabular}%
+ \end{center}%
\end{Example}
\EndIndex{Cmd}{DeclareNewTOC}%
\EndIndex{Package}{tocbasic}%
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea-experts.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea-experts.tex
index 15bfc38d8dd..7a2d45bc612 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea-experts.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea-experts.tex
@@ -1,6 +1,6 @@
% ======================================================================
-% typearea.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% typearea-experts.tex
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -17,8 +17,8 @@
%
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
-% typearea.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% typearea-experts.tex
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,31 +45,33 @@
%
% ======================================================================
-\ProvidesFile{typearea-experts.tex}[2012/04/17 KOMA-Script guide (chapter: typearea)]
+\KOMAProvidesFile{typearea-experts.tex}
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: typearea)]
\translator{Markus Kohm\and Gernot Hassenpflug}
-% Date of the translated German file: 2012/04/17
+% Date of the translated German file: 2013/05/31
\chapter{Additional Information about package \Package{typearea}}
\labelbase{typearea-experts}
This chapter gives additional information about package
\Package{typearea}. \iffree{Some parts of the chapter are subject to the
- \KOMAScript{} book \cite{book:komascript} only. This shouldn't be a problem,
- because the}{The} average user, who only want to use the package, won't need
-the information, that is addressed to users with non-standard requirements or
-who want to write their own packages using \Package{typearea}. Another part of
-the information describes features of \Package{typearea} that exist only
-because of compatibility to former releases of \KOMAScript{} or the standard
-classes. The features, that exist only because of compatibility to former
-\KOMAScript{} releases, are printed with a sans serif font. You shouldn't use
-them any longer.
+ \KOMAScript{} book \cite{book:komascript} only. This should not be a
+ problem, because the}{The} average user, who only want to use the package,
+does not need the information that is addressed to users with non-standard
+requirements or who want to write their own packages using
+\Package{typearea}. Another part of the information describes features of
+\Package{typearea} that exist only because of compatibility to former releases
+of \KOMAScript{} or the standard classes. The features, that exist only
+because of compatibility to former \KOMAScript{} releases, are printed with a
+sans serif font. You should not use them any longer.
\section{Expert Commands}
\label{sec:typearea-experts.experts}
-This section describes commands, that aren't of interest for average
+This section describes commands that are not of interest for average
users. Nevertheless these commands provide additional features for
experts. Because the information is addressed to experts it's condensed.
@@ -96,7 +98,7 @@ after usage of \Macro{activateareas}. Moreover all changes of
\Macro{storeareas}\Parameter{\Macro{command}}
\end{Declaration}
\BeginIndex{Cmd}{storearea}%
-With \Macro{storeareas} a \PName{\Macro{command}} will be defined, that may be
+With \Macro{storeareas} a \PName{\Macro{command}} will be defined that may be
used to restore all current settings of typing area and margins. This provides
to store the current settings, change them, do anything with valid changed
settings and restore the previous settings afterwards.
@@ -108,21 +110,25 @@ settings and restore the previous settings afterwards.
\documentclass[pagesize]{scrartcl}
\begin{document}
- \rule{\textwidth}{\textheight}
+ \noindent\rule{\textwidth}{\textheight}
\storeareas\MySavedValues
\KOMAoptions{paper=landscape,DIV=current}
- \rule{\textwidth}{\textheight}
+ \noindent\rule{\textwidth}{\textheight}
\clearpage
\MySavedValues
- \rule{\textwidth}{\textheight}
+ \noindent\rule{\textwidth}{\textheight}
\end{document}
\end{lstcode}
Command \Macro{clearpage}\textnote{Attention} before calling
\Macro{MySavedValues} is important to restore the saved values at the next
page.
\end{Example}
+In the example \Macro{noindent} has been used to avoid the paragraph indent of
+the black boxes. Without these commands the boxes would not show the
+typing area correctly.
+
Please note\textnote{Attention!} that neither \Macro{storeareas} nor the
defined \PName{\Macro{command}} should be used inside a group. Internally
\Macro{newcommand}\IndexCmd{newcommand*}\important{\Macro{newcommand*}} is
@@ -143,13 +149,14 @@ These commands manage \emph{hooks}. \Macro{AfterCalculatingTypearea} and it's
star version provide experts to execute \PName{instructions} every time
\Package{typearea} has recalculated the typing area and margins either
implicitly or because of an explicit usage of \Macro{typearea}. Similar
-\Macro{AfterSettingArea} and it's star version provide execution of
-\PName{instructions} every time \Macro{areaset} has been used. While normal
-versions work globally the influence of the star versions is only
-local. The \PName{instructions} will be executed instantly before execution of
-\Macro{activateareas}.\iffree{}{ In \autoref{cha:modernletters}
- \Macro{AfterCalculatingTypearea} will be used in letter class option
- \File{asymTypB.lco} to change the division of the margins.}%
+\Macro{AfterSettingArea}\ChangedAt{v3.11}{\Package{typearea}} and it's star
+version provide execution of \PName{instructions} every time \Macro{areaset}
+has been used. While normal versions work globally the influence of the star
+versions is only local. The \PName{instructions} will be executed instantly
+before execution of \Macro{activateareas}.\iffree{}{ In
+ \autoref{cha:modernletters} \Macro{AfterCalculatingTypearea} will be used in
+ letter class option \File{asymTypB.lco} to change the division of the
+ margins.}%
%
\EndIndex{Cmd}{AfterCalculatingTypearea}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex
index db2bce403f2..a752145682b 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex
@@ -1,6 +1,6 @@
% ======================================================================
% typearea.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% typearea.tex
-% Copyright (c) Markus Kohm, 2001-2012
+% Copyright (c) Markus Kohm, 2001-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -45,10 +45,12 @@
%
% ======================================================================
-\ProvidesFile{typearea.tex}[2012/07/22 KOMA-Script guide (chapter: typearea)]
+\KOMAProvidesFile{typearea.tex}%
+ [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ KOMA-Script guide (chapter: typearea)]
\translator{Markus Kohm\and Gernot Hassenpflug\and Krickette Murabayashi}
-% Date of translated german file: 2012/07/22
+% Date of translated german file: 2013/11/21
\chapter{Construction of the Page Layout with \Package{typearea}}
\labelbase{typearea}
@@ -355,7 +357,7 @@ user, but rather at authors of classes and packages.
\cite{JTsch87}.
A disadvantage of this late Middle Age method is that the width of
- the text area is no longer dependent on the font. Thus, one doesn't
+ the text area is no longer dependent on the font. Thus, one does not
choose the text area to match the font, but the author or typesetter
has to choose the font according to the text area. This can be
considered a ``must''.
@@ -465,24 +467,24 @@ construction method is found in
larger the \PName{Factor}, the larger the text block and the smaller
the margins. Any integer value greater than 4 is valid for
\PName{Factor}. Please note that large values can lead to
-unfulfillment of various minor conditions in the type-area, depending
+unfulfillment of various minor conditions in the type area, depending
on further options chosen. Thus, in an extreme case, the header may
fall outside of the page. Users applying the option
\KOption{DIV}\PName{Factor} are themselves responsible for fulfillment
of the marginal conditions and setting of a typographically aesthetic
line length.
-In \autoref{tab:typearea.typearea} are found the type-area sizes for
+In \autoref{tab:typearea.typearea} are found the type area sizes for
several \Var{DIV} factors for an A4 page without binding correction. Here
the minor conditions dependent on font size are not considered.
\begin{table}
\centering
- \caption{Type-area dimensions dependent on \Var{DIV} for A4}
+ \caption{Type area dimensions dependent on \Var{DIV} for A4}
\begin{tabular}{ccccc}
\toprule
&
- \multicolumn{2}{c}{Type-area} & \multicolumn{2}{c}{Margins}\\
+ \multicolumn{2}{c}{Type area} & \multicolumn{2}{c}{Margins}\\
%\raisebox{1.5ex}[0pt]{
\Var{DIV}
%}
@@ -658,7 +660,7 @@ class is used together with a font package.
With \KOption{DIV}\PName{current}\ChangedAt{v3.00}{\Package{typearea}}
a renewed calculation of text block and margin is requested, in which
the currently set \Var{DIV} will be used. This is less of interest for
-renewed type-area calculations after loading a different font; it is
+renewed type area calculations after loading a different font; it is
rather more useful for determining, for example, after changing the
leading, while keeping \Var{DIV} the same, that the marginal condition
is fulfilled that \Length{textheight} less
@@ -670,7 +672,7 @@ exactly the same setting is used as in the last calculation.
\begin{Example}
Let us take up the previous example again, in which a good line
- length is required for a type-area using the Bookman font. At the
+ length is required for a type area using the Bookman font. At the
same time, a {\KOMAScript} class is to be used. This is easily
possible using the symbolic value \PValue{last} and the command
\Macro{KOMAoptions}:
@@ -697,25 +699,25 @@ can also lead to \LaTeX{} loading a different font.
\begin{desctabular}
\pventry{areaset}{Recalculate page
layout.\IndexOption{DIV~=areaset}}%
- \pventry{calc}{Recalculate type-area including choice of
+ \pventry{calc}{Recalculate type area including choice of
appropriate \Var{DIV} value.\IndexOption{DIV~=calc}}%
- \pventry{classic}{Recalculate type-area using Middle Age book
+ \pventry{classic}{Recalculate type area using Middle Age book
design canon (circle-based
calculation).\IndexOption{DIV~=classic}}%
- \pventry{current}{Recalculate type-area using current \Var{DIV}
+ \pventry{current}{Recalculate type area using current \Var{DIV}
value.\IndexOption{DIV~=current}}%
- \pventry{default}{Recalculate type-area using the standard value
+ \pventry{default}{Recalculate type area using the standard value
for the current page format and current font size. If no
standard value exists, \PValue{calc} is
used.\IndexOption{DIV~=default}}%
- \pventry{last}{Recalculate type-area using the same \PName{DIV}
+ \pventry{last}{Recalculate type area using the same \PName{DIV}
argument as was used in the last call.\IndexOption{DIV~=last}}%
\end{desctabular}
\end{table}
-Often the renewed type-area calculation is required in combination
+Often the renewed type area calculation is required in combination
with a change in the line spacing
-(\emph{leading})\Index{leading}. Since the type-area should be
+(\emph{leading})\Index{leading}. Since the type area should be
calculated such that an integer number of lines fit in the text block,
a change in the leading normally requires a recalculation of the page
layout.
@@ -733,7 +735,7 @@ layout.
\KOMAoptions{DIV=last}
\end{lstcode}\IndexCmd{linespread}
Since \Package{typearea} always executes the command
-\Macro{normalsize} itself upon calculation of a new type-area, it is
+\Macro{normalsize} itself upon calculation of a new type area, it is
not necessary to activate the chosen leading with \Macro{selectfont}
after \Macro{linespread}, since this will be used already in the
recalculation.
@@ -755,21 +757,26 @@ page should be reset to the normal value.
A complete example would be:
\fi
\begin{lstcode}
- \documentclass[10pt,twoside,BCOR=12mm,DIV=calc]{scrreprt}
+ \documentclass[10pt,twoside,BCOR=12mm,DIV=calc]
+ {scrreprt}
\usepackage{setspace}
\onehalfspacing
+ \AfterTOCHead{\singlespacing}
\KOMAoptions{DIV=last}
\begin{document}
\title{Title}
\author{Markus Kohm}
\begin{spacing}{1}
\maketitle
- \tableofcontents
\end{spacing}
+ \tableofcontents
\chapter{Ok}
\end{document}
\end{lstcode}
- See further also the notes in \autoref{sec:typearea.tips}.
+ See further also the notes in \autoref{sec:typearea.tips}. The command
+ \Macro{AfterTOCHead}\IndexCmd{AfterTOCHead} will be described in
+ \autoref{cha:tocbasic} of \autoref{part:forExoerts} on
+ \autopageref{desc:tocbasic.cmd.AfterTOCHead}.
\end{Example}
Please note that when using this option with one of the {\KOMAScript}
@@ -813,7 +820,7 @@ margins are automatically recalculated anew.%
\Macro{typearea}\OParameter{BCOR}\Parameter{DIV}}
\label{tab:symbolicBCOR}
\begin{desctabular}
- \pventry{current}{Recalculate type-area with the currently valid
+ \pventry{current}{Recalculate type area with the currently valid
\Var{BCOR} value.\IndexOption{BCOR~=current}}
\end{desctabular}
\end{table}
@@ -828,7 +835,7 @@ change to \PName{BCOR}.
\begin{Explain}
The command \Macro{typearea} is currently defined so as to make it
- possible to change the type-area anywhere within a
+ possible to change the type area anywhere within a
document. Several assumptions about the structure of the {\LaTeX}
kernel are however made and internal definitions and sizes of the
kernel changed. There is a definite possibility, but no guarantee,
@@ -838,7 +845,7 @@ change to \PName{BCOR}.
Since \Macro{typearea}\POParameter{current}\PParameter{last} or
\Macro{KOMAoptions}\PParameter{DIV=last} are often needed for
-recalculation of the type-area, there exists specially the
+recalculation of the type area, there exists specially the
abbreviated command
\Macro{recalctypearea}\ChangedAt{v3.00}{\Package{typearea}}.
@@ -882,38 +889,42 @@ typesetting is carried out. Deactivation of the option leads to
single-sided typesetting.
\begin{table}
- \begin{minipage}{\textwidth}
\centering
\caption{Standard values for simple switches in \KOMAScript}
\begin{tabular}{ll}
\toprule
Value & Description \\
\midrule
- \PValue{true}\footnote{This value will be used also, if you use the option
- without assigning any value.} & activates the option \\
+ \PValue{true} & activates the option \\
\PValue{on} & activates the option \\
- \PValue{yes} & activates the option \\
+ \PValue{yes} & activates the option \\
\PValue{false}& deactivates the option \\
\PValue{off} & deactivates the option \\
- \PValue{no} & deactivates the option \\
+ \PValue{no} & deactivates the option \\
\bottomrule
\end{tabular}
\label{tab:truefalseswitch}
- \end{minipage}
\end{table}
Apart from the values in \autoref{tab:truefalseswitch} the value
-\PValue{semi}\ChangedAt{v3.00}{\Package{typearea}} can also be
-given. The value \PValue{semi} results in a double-sided typesetting
-with single-sided margins and single-sided, i.\ e., not alternating,
-margin notes.
+\PValue{semi}\ChangedAt{v3.00}{\Package{typearea}} can also be given. The
+value \PValue{semi} results in a double-sided typesetting with single-sided
+margins and single-sided, i.\ e., not alternating, margin
+notes. Nevertheless\ChangedAt{v3.12}{\Package{typearea}}, since \KOMAScript{}
+version 3.12 binding corrections (see \Option{BCOR},
+\autopageref{desc:typearea.option.BCOR}) will be part of the left margin on
+odd pages but part of the right margin on even pages. But if you use
+compatibility with prior versions of \KOMAScript (see
+\autoref{sec:typearea.compatibilityOptions},
+\autopageref{sec:typearea.compatibilityOptions}), binding correction will be
+part of the left margin on both pages while using \OptionValue{twoside}{semi}.
The option can also be passed as class option in
\Macro{documentclass}, as package option to \Macro{usepackage}, or
even after loading of the \Package{typearea} package with the use of
\Macro{KOMAoptions} or \Macro{KOMAoption}. Use of the option after
loading the \Package{typearea} package results automatically in
-recalculation of the type-area using \Macro{recalctypearea} (see
+recalculation of the type area using \Macro{recalctypearea} (see
\autopageref{desc:typearea.cmd.recalctypearea}). If double-sided
typesetting was active before the option was set, then before the
recalculation a page break is made to the next odd page.%
@@ -925,11 +936,11 @@ recalculation a page break is made to the next odd page.%
\begin{Declaration}
\KOption{twocolumn}\PName{simple switch}
\end{Declaration}
-For the calculation of a good type-area with the help of
+For the calculation of a good type area with the help of
\OptionValue{DIV}{calc} it is useful to know in advance if the
document is to be typeset one-column or two-column. Since the
observations about line length in \autoref{sec:typearea.basics} then
-apply to each column, the width of a type-area in a two-column
+apply to each column, the width of a type area in a two-column
document can be up to double that in a one-column document.
To implement this difference, the \Package{typearea} package must be
@@ -945,7 +956,7 @@ The option can also be passed as class option in
even after loading of the \Package{typearea} package with the use of
\Macro{KOMAoptions} or \Macro{KOMAoption}. Use of the option after
loading the \Package{typearea} package results automatically in
-recalculation of the type-area using \Macro{recalctypearea} (see
+recalculation of the type area using \Macro{recalctypearea} (see
\autopageref{desc:typearea.cmd.recalctypearea}).%
%
\EndIndex{Option}{twocolumn~=\PName{simple switch}}
@@ -958,8 +969,8 @@ recalculation of the type-area using \Macro{recalctypearea} (see
\KOption{footinclude}\PName{simple switch}
\end{Declaration}%
\begin{Explain}%
- So far we have discussed how the type-area is
- calculated\Index{type-area} and the relationship of the
+ So far we have discussed how the type area is
+ calculated\Index{type area} and the relationship of the
margins\Index{margins} to one another and between margins and text
block. However, one important question has not been answered: What
constitutes the margins?
@@ -1039,9 +1050,9 @@ Please note that when using these options with one of the
either as a class option, or passed via \Macro{KOMAoptions} or
\Macro{KOMAoption} after loading the class. Changing of these options
after loading the \Package{typearea} package does not result in an
-automatic recalculation of the type-area. Instead, the changes only
-take effect at the next recalculation of the type-area. For
-recalculation of the type-area, refer to the \Option{DIV} option with
+automatic recalculation of the type area. Instead, the changes only
+take effect at the next recalculation of the type area. For
+recalculation of the type area, refer to the \Option{DIV} option with
the values \PValue{last} or \PValue{current} (see
\autopageref{desc:typearea.option.DIV.last}) or the
\Macro{recalctypearea} command (see
@@ -1083,7 +1094,7 @@ double-sided page layout has been chosen. The option
ragged text gives no homogeneous optical impression, the long lines
can reach right into the normal margin. This can be done using
option \Option{mpinclude} and by an enlargement of length
- \Length{marginparwidth} after the type-area has been set up. The
+ \Length{marginparwidth} after the type area has been set up. The
length can be easily enlarged with the command \Macro{addtolength}.
How much the length has to be enlarged depends on the special
situation and it requires some flair. This is another reason the
@@ -1098,7 +1109,7 @@ double-sided page layout has been chosen. The option
Currently there is no option to enlarge the margin by a given
amount. The only solution is to either not use the option
\Option{mpinclude} or to set \Option{mpinclude} to \PValue{false},
- and after the type-area has been calculated, one reduces the
+ and after the type area has been calculated, one reduces the
width of the text body \Length{textwidth} and enlarges the margin
width \Length{marginparwidth} by the same amount. Unfortunately,
this cannot be combined with automatic calculation of the
@@ -1113,9 +1124,9 @@ classes as in the example above, it must be used either as a class
option, or passed via \Macro{KOMAoptions} or \Macro{KOMAoption} after
loading the class. Changing of this option after loading the
\Package{typearea} package does not result in an automatic
-recalculation of the type-area. Instead, the changes only take effect
-at the next recalculation of the type-area. For recalculation of the
-type-area, refer to the \Option{DIV} option with the values
+recalculation of the type area. Instead, the changes only take effect
+at the next recalculation of the type area. For recalculation of the
+type area, refer to the \Option{DIV} option with the values
\PValue{last} or \PValue{current} (see
\autopageref{desc:typearea.option.DIV.last}) or the
\Macro{recalctypearea} command (see
@@ -1130,7 +1141,7 @@ type-area, refer to the \Option{DIV} option with the values
\KOption{headlines}\PName{number of lines}\\
\KOption{headheight}\PName{height}
\end{Declaration}%
-We have seen how to calculate the type-area using the
+We have seen how to calculate the type area using the
\Package{typearea} package and how to specify whether header and
footer are part of the text or the margins. However, in particular for
the header, we still have to specify the height. This is achieved with
@@ -1149,7 +1160,7 @@ its default value and adapt it only in special cases.
Assume that you want to use a header with two lines. Normally this would
result in an ``\texttt{overfull} \Macro{vbox}'' warning for each page. To
prevent this from happening, the \Package{typearea} package is told to
- calculate an appropriate type-area:
+ calculate an appropriate type area:
\begin{lstcode}
\documentclass[a4paper]{article}
\usepackage[headlines=2.1]{typearea}
@@ -1159,8 +1170,8 @@ directly as a class option:
\begin{lstcode}
\documentclass[a4paper,headlines=2.1]{scrartcl}
\end{lstcode}
-Commands that can be used to define the contents of a header with two
-lines are described in \autoref{cha:scrpage}.
+Commands that can be used to define the contents of a header with two lines
+are described in \autoref{cha:scrpage} and \autoref{cha:scrlayer-scrpage}.
\end{Example}
In some cases it is useful to be able to specify the header height not
@@ -1169,7 +1180,7 @@ with the aid of the alternative option \Option{headheight}. For
\PName{height} any lengths and sizes that \LaTeX{} understands are
valid. It should be noted though that when using a \LaTeX{} length
such as \Length{baselineskip} its value at the time of the calculation
-of the type-area and margins, not at the time of setting of the
+of the type area and margins, not at the time of setting of the
option, is decisive.
Please note that when using these options with one of the
@@ -1177,9 +1188,9 @@ Please note that when using these options with one of the
either as a class option, or passed via \Macro{KOMAoptions} or
\Macro{KOMAoption} after loading the class. Changing of these options
after loading the \Package{typearea} package does not result in an
-automatic recalculation of the type-area. Instead, the changes only
-take effect at the next recalculation of the type-area. For
-recalculation of the type-area, refer to the \Option{DIV} option with
+automatic recalculation of the type area. Instead, the changes only
+take effect at the next recalculation of the type area. For
+recalculation of the type area, refer to the \Option{DIV} option with
the values \PValue{last} or \PValue{current} (see
\autopageref{desc:typearea.option.DIV.last}) or the
\Macro{recalctypearea} command (see
@@ -1188,13 +1199,87 @@ the values \PValue{last} or \PValue{current} (see
\EndIndex{Option}{headheight~=\PName{height}}%
\EndIndex{Option}{headlines~=\PName{number}}
+\begin{Declaration}
+ \KOption{footlines}\PName{number}\\
+ \KOption{footheight}\PName{height}
+\end{Declaration}
+\BeginIndex{Option}{footlines~=\PName{number}}%
+\BeginIndex{Option}{footheight~=\PName{height}}%
+As\ChangedAt{v3.12}{\Package{typearea}} well as we needed a height value for
+the head, we need a height value for the page footer. But in difference to the
+height of the head, \LaTeX itself do not provide a length for the height of
+the page footer. So \Package{typearea} defines the new length
+\Length{footheight}\IndexLength[indexmain]{footheight}, if it does not
+exist. Wether or not this length will be used by classes or packages depends
+on the classes and packages, that will be used. The \KOMAScript{} package
+\Package{scrlayer-scrpage} incorporates \Length{footheight} and actively
+cooperates with \Package{typearea}. The \KOMAScript{} classes do not recognize
+\Length{footheight}, because without any package assistance they provide only
+page styles with single-line page footers.
+
+You can use \Option{footlines} to setup the \PName{number} of lines in the
+page footer, similar to \Option{headlines} for the number of lines in the page
+header. By default \Package{typearea} uses 1.25 footlines. This is a
+compromise, large enough for overlining or underlining footers and small
+enough that the relative weight of the bottom margin is not affected too mich
+when the footer is neither over- nor underlined. Thus in most cases you may
+leave \PName{footlines} at its default value and adapt it only in special
+cases.
+
+\begin{Example}
+ Assume a two-lined copyright note should be placed in the page
+ footer. Indeed, \LaTeX{} itself does not test, whether or not the footer has
+ room enough for that, exceeding of the available height would probably could
+ result in unbalanced margins. Moreover, for example package
+ \Package{scrlayer-scrpage}, that may be used to define such a page footer,
+ would definitely do such a test and would notify a recognised oversize. So
+ it makes sense, to declare the needed footheight already for the calculation
+ of the text area and the margins:
+\begin{lstcode}
+ \documentclass[a4paper]{article}
+ \usepackage[footlines=2.1]{typearea}
+\end{lstcode}
+ Again, if you use a \KOMAScript{} class, it is recommended to pass this
+ option directly a a class option:
+\begin{lstcode}
+ \documentclass[footlines=2.1]{scrartcl}
+\end{lstcode}
+ Commands that can be used to define the contents of a footer with two lines
+ are described in \autoref{cha:scrlayer-scrpage}.
+\end{Example}
+
+In some cases it is useful to be able to specify the footer height not
+in lines but directly as a length measurement. This is accomplished
+with the aid of the alternative option \Option{footheight}. For
+\PName{height} any lengths and sizes that \LaTeX{} understands are
+valid. It should be noted though that when using a \LaTeX{} length
+such as \Length{baselineskip} its value at the time of the calculation
+of the type area and margins, not at the time of setting of the
+option, is decisive.
+
+Please note that when using these options with one of the
+{\KOMAScript} classes as in the example above, they must be used
+either as a class option, or passed via \Macro{KOMAoptions} or
+\Macro{KOMAoption} after loading the class. Changing of these options
+after loading the \Package{typearea} package does not result in an
+automatic recalculation of the type area. Instead, the changes only
+take effect at the next recalculation of the type area. For
+recalculation of the type area, refer to the \Option{DIV} option with
+the values \PValue{last} or \PValue{current} (see
+\autopageref{desc:typearea.option.DIV.last}) or the
+\Macro{recalctypearea} command (see
+\autopageref{desc:typearea.cmd.recalctypearea}).%
+\EndIndex{Option}{footheight~=\PName{height}}%
+\EndIndex{Option}{footlines~=\PName{number}}%
+
+
\BeginIndex{Cmd}{areaset}%
\begin{Declaration}
\Macro{areaset}\OParameter{BCOR}\Parameter{Width}\Parameter{Height}
\end{Declaration}%
So far we have seen how a good or even very good
-type-area\Index{type-area} is calculated and how the
+type area\Index{type area} is calculated and how the
\Package{typearea} package can support these calculations, giving you
at the same time the freedom to adapt the layout to your needs.
However, there are cases where the text body has to fit exactly some
@@ -1230,7 +1315,7 @@ text line is \Macro{topskip} below the top margin of the type area, as
long as the height of the topmost line is less than
\Macro{topskip}. Thus, the uppermost line does not require any
height. The descenders of characters on the lowermost line, on the
-other hand, hang below the dimensions of the type-area.
+other hand, hang below the dimensions of the type area.
\item A poetry book with a square text body with a page length of
15\Unit{cm} and a binding correction of 1\Unit{cm} could be
@@ -1248,7 +1333,7 @@ other hand, hang below the dimensions of the type-area.
\OptionValue{DIV}{areaset}
\end{Declaration}%
In\ChangedAt{v3.00}{\Package{typearea}} rare cases it is useful to be
-able to reconstruct the current type-area anew. This is possible via
+able to reconstruct the current type area anew. This is possible via
the option \OptionValue{DIV}{areaset}, where
\Macro{KOMAoptions}\PParameter{DIV=areaset} corresponds to the
\begin{lstcode}[belowskip=\dp\strutbox]
@@ -1356,8 +1441,8 @@ classes, it must be used either as a class option, or passed via
\Macro{KOMAoptions} or \Macro{KOMAoption} after loading the
class. Changing of this option after loading the \Package{typearea}
package does not result in an automatic recalculation of the
-type-area. Instead, the changes only take effect at the next
-recalculation of the type-area. For recalculation of the type-area,
+type area. Instead, the changes only take effect at the next
+recalculation of the type area. For recalculation of the type area,
refer to the \Option{DIV} option with the values \PValue{last} or
\PValue{current} (see \autopageref{desc:typearea.option.DIV.last}) or
the \Macro{recalctypearea} command (see
@@ -1375,7 +1460,7 @@ the \Macro{recalctypearea} command (see
The above-mentioned mechanisms for choice of paper format only
affect the output insofar as internal {\LaTeX} lengths are set. The
\Package{typearea} package then uses them in the division of the
- page into type-area and margins.
+ page into type area and margins.
The specification of the DVI
formats\Index{DVI}, however, does not include any indications of paper
format. If printing is done directly from DVI format to a low-level
@@ -1421,7 +1506,7 @@ at \autoref{tab:typearea.outputdriver}. The default is
\Macro{mediaheight}\IndexLength{mediaheight} are defined, they will be
set additionally.\IndexOption{pagesize~=\PValue{automedia}}}%
\entry{\PValue{false}, \PValue{no}, \PValue{off}}{%
- Doesn't set any output driver and doesn't send page size information to
+ Does not set any output driver and does not send page size information to
the output driver.\IndexOption{pagesize~=\PValue{false}}}%
\pventry{dvipdfmx}{\ChangedAt{v3.05a}{\Package{typearea}}Writes paper size
into DVI files using
@@ -1516,7 +1601,7 @@ not as a fixed, but as an average or maximal value.%
As executed, record regulations are usually intended to obtain a
usable result even if the author does not know what needs to be
considered. \emph{Usable} frequently means readable and correctable. In
-the author's opinion the type-area of a text set with {\LaTeX} and the
+the author's opinion the type area of a text set with {\LaTeX} and the
\Package{typearea} package meets these criteria well right from the
start. Thus if one is confronted with regulations which deviate
obviously substantially from it, then the author recommends submitting
@@ -1527,7 +1612,7 @@ modification of option \Option{DIV}. The author advises against the
use of \Macro{areaset} for this purpose however. In the worst case
one may make use of the geometry package (see
\cite{package:geometry}), which is not part of \KOMAScript, or change
-the type-area parameters of \LaTeX. One may find the values
+the type area parameters of \LaTeX. One may find the values
determined by \Package{typearea} in the \File{log} file of one's
document. Thus moderate adjustments should be possible. However, one
should make absolutely sure that the proportions of the text area
@@ -1542,7 +1627,7 @@ too frequently, it has been obsolete since the introduction of
\Macro{linespread}. The author recommends the package
\Package{setspace}\IndexPackage{setspace} (see
\cite{package:setspace}), which is not part of \KOMAScript. Also one
-should let \Package{typearea} recalculate a new type-area after the
+should let \Package{typearea} recalculate a new type area after the
conversion of the line spacing. However, one should switch back to
the normal line spacing for the title, preferably also for the table
contents and various listings\,---\,as well as the bibliography and
@@ -1557,7 +1642,7 @@ respective document. Thus one can select a smaller value easily after
the first {\LaTeX} run.
The question is not infrequently put to the author, why he spends an
-entire chapter discussing type-area calculations, when it would be
+entire chapter discussing type area calculations, when it would be
very much simpler to merely give the world a package with which anyone
can adjust the margins like in a word processor. Often it is added
that such a package would in any case be the better solution, since