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/common-21.tex20
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex45
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle-experts.tex75
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex63
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrhack.tex14
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex86
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/typearea-experts.tex30
8 files changed, 254 insertions, 83 deletions
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
index 0bdffb098da..137605e486a 100644
--- 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
@@ -51,7 +51,7 @@
Manipulation of defined page styles)]
\translator{Markus Kohm\and Jana Schubert}
-% Date version of the translated file: 2015-03-31
+% Date version of the translated file: 2015-06-18
\makeatletter
\@ifundefined{ifCommonscrlayer}{\newif\ifCommonscrlayer}{}%
@@ -170,6 +170,11 @@ 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.
+Please note\textnote{Attention} that not every class provides running heads
+for every section level. For example the standard classes never setup the
+running head of \Macro{part}. The \KOMAScript{} classes provide running heads
+for every section level.
+
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
@@ -364,23 +369,23 @@ You can find all valid values for \Option{markcase} in
automatic running heads}%
\label{tab:scrlayer-scrpage.markcase}%
\begin{desctabular}
- \pventry{lower}{\IndexOption{markcase~=\PValue{lower}}%
+ \pventry{lower}{\IndexOption[indexmain]{markcase~=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}}%
+ \pventry{upper}{\IndexOption[indexmain]{markcase~=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}}%
+ \pventry{used}{\IndexOption[indexmain]{markcase~=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}}%
+ \PValue{noupper}}{\IndexOption[indexmain]{markcase~=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.%
@@ -552,6 +557,11 @@ 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.
+Unfortunately\textnote{Attention!}, not all classes use such a command for
+every section level. The standard classes for example do not call
+\Macro{partmark}. The \KOMAScript{} classes support such commands for all
+section levels and therefore also use \Macro{partmark}.
+
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
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 a31bb2da159..7a003c40f3c 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbase.tex
@@ -46,11 +46,11 @@
% ======================================================================
\KOMAProvidesFile{scrbase.tex}
- [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
+ [$Date: 2015-06-17 12:15:52 +0200 (Wed, 17 Jun 2015) $
KOMA-Script package scrbase]
\translator{Markus Kohm\and Melvin Hendrix}
-% Date of the translated German file: 2015-03-31
+% Date of the translated German file: 2015-06-17
\chapter{Basic Functions of Package \Package{scrbase}}
\labelbase{scrbase}
@@ -348,6 +348,47 @@ of \Package{keyval}. Ultimately, with the help of
\begin{Declaration}
+ \Macro{BeforeFamilyProcessOptions}\OParameter{member}\Parameter{family}%
+ \Parameter{code}%
+\end{Declaration}
+\BeginIndex{Cmd}{BeforeFamilyProcessOptions}%
+Especially\ChangedAt{v3.18}{\Package{scrbase}} authors of wrapper classes or
+wrapper packages sometimes need a hook to execute \PName{code} just before
+\Macro{FamilyProcessOptions}. The package \Package{scrbase} provides such a
+hook and you can add \PName{code} to it using
+\Macro{BeforeFamilyProcessOptions}. The parameters \PName{member} and
+\PName{family} are same to \Macro{FamilyProcessOptions}. In difference to
+\Macro{FamilyProcessOptions} you can add \PName{code} also to the hook of not
+yet defined \PName{family} or \PName{member}.
+
+Note, the hook of a family member will be cleaned after execution. But if you
+use an empty \PName{member} the \PName{code} will be executed before the
+\Macro{FamilyProcessOptions} of every member of the \PName{family} and will
+never be deleted.
+
+\begin{Example}
+ Now, you are writing a package that loads \Package{liversausage}. But you do
+ not provide option \Option{coldcut} with this package. So you use
+ \Macro{BeforeFamilyProcessOptions} to deactivate
+ that option before loading the package:
+\begin{lstcode}
+ \RequirePackage{scrbase}
+ \BeforeFamilyProcessOptions[.liversausage.sty]{butcher}{%
+ \RelaxFamilyKey[.liversausage.sty]{butcher}{coldcut}%
+ }
+ \RequirePackageWithOptions{liversausage}
+\end{lstcode}
+ If after this a user tries to load your package with option
+ \Option{coldcut}, package \Package{liversausage} will throw an undefined
+ option error. If \Option{coldcut} is used as a global option, package
+ \Package{liversausage} will ignore it. But default settings inside
+ \Package{liversausage}, e.\,g., using \Macro{FamilyExecuteOptions} before
+ \Macro{FamilyProcessOptions} are not effected.
+\end{Example}
+\EndIndex{Cmd}{BeforeFamilyProcessOptions}%
+
+
+\begin{Declaration}
\Macro{FamilyExecuteOptions}\OParameter{family member}\Parameter{family}%
\Parameter{options list}
\end{Declaration}
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 00f2b232365..724addb592e 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
@@ -48,13 +48,13 @@
% ============================================================================
\KOMAProvidesFile{scrbookreportarticle-experts.tex}
- [$Date: 2015-04-04 11:18:50 +0200 (Sat, 04 Apr 2015) $
+ [$Date: 2015-06-17 13:12:54 +0200 (Wed, 17 Jun 2015) $
KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl for
experts)]
\translator{Gernot Hassenpflug\and Markus Kohm}
-% Date of the translated German file: 2015-04-04
+% Date of the translated German file: 2015-06-17
\chapter{Additional Information about the Main Classes \Class{scrbook},
@@ -237,9 +237,11 @@ not recommended!%
\begin{Declaration}
- \Macro{@fontsizefilebase}
+ \Macro{@fontsizefilebase}\\
+ \Macro{changefontsizes}\Parameter{font size}
\end{Declaration}
\BeginIndex{Cmd}{@fontsizefilebase}%
+\BeginIndex{Cmd}{changefontsizes}%
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
@@ -250,10 +252,10 @@ may define this macro with another file name prefix to use completely
different font size files. Also\textnote{Hint!} authors of wrapper classes
could change or deactivate the \emph{fallback} solution for unknown font sizes
by redefinition of macro
-\Macro{changefontsizes}\important{\Macro{changefontsizes}}%
-\IndexCmd{changefontsize}. This macro has exactly one argument: the wanted
-font size.%
+\Macro{changefontsizes}\important{\Macro{changefontsizes}}. This macro has
+exactly one argument: the wanted \PName{font size}.%
%
+\EndIndex{Cmd}{changefontsizes}%
\EndIndex{Cmd}{@fontsizefilebase}%
\begin{Declaration}
@@ -417,7 +419,7 @@ this reactivation of the \Macro{setparsizes} values is deactivated.%
\BeginIndex{Cmd}{DeclareNewSectionCommand}%
\BeginIndex{Cmd}{RedeclareSectionCommand}%
\BeginIndex{Cmd}{ProvideSectionCommand}%
-With\ChangedAt[2014/11]{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and
+With\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} these commands you can either define a new section-like
command \Macro{\PName{name}} or change an already defined sectioning command
\Macro{\PName{name}}. To do so you use the optional argument to setup several
@@ -426,29 +428,35 @@ command \Macro{\PName{name}} or change an already defined sectioning command
shown in \autoref{tab:maincls-experts.declaresection.keys}, there are style
dependent attributes, too. Currently the following styles are provided:
\begin{labeling}{\PValue{chapter}:}
-\item[\PValue{chapter}:] \ChangedAt[2015/03]{v3.17}{\Class{scrbook}\and
- \Class{scrreprt}\and \Class{scrartcl}}Style of chapter
- headings. Currently you cannot define new commands with this style. But you
- can configure the existing command \Macro{chapter}. To do so you can also
- use the additional attributes of
+\item[\PValue{chapter}:] \ChangedAt{v3.18}{\Class{scrbook}\and
+ \Class{scrreprt}}Style of chapter headings. This style is currently used
+ for \Macro{chapter}\IndexCmd{chapter} and indirectly for
+ \Macro{addchap}\IndexCmd{addchap}. You can define new section-like commands
+ using this style. To define new or to reconfigure existing commands you can
+ also use the additional attributes of
\autoref{tab:maincls-experts.declarechapterstyle.keys},
\autopageref{tab:maincls-experts.declarechapterstyle.keys}.
Note\textnote{Attention!} that command \Macro{addchap} and the star variants
are configured automatically together with \Macro{chapter} and should not be
changed independently. Note that \Class{scrartcl}\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}} does not provide this style.
-\item[\PValue{part}:] \ChangedAt[2015/03]{v3.17}{\Class{scrbook}\and
- \Class{scrreprt}\and \Class{scrartcl}}Style part headings. Currently you
- cannot define new commands with this style. But you can configure the
- existing command \Macro{part}. To do so you can also use the additional
- attributes of \autoref{tab:maincls-experts.declarepartstyle.keys},
+\item[\PValue{part}:] \ChangedAt{v3.18}{\Class{scrbook}\and
+ \Class{scrreprt}\and \Class{scrartcl}}Style part headings. This style is
+ currently used for \Macro{part}\IndexCmd{part} and indirectly for
+ \Macro{addpart}\IndexCmd{addpart}. You can define new section-like commands
+ using this style. To define new or to reconfigure existing commands you can
+ also use the additional attributes of
+ \autoref{tab:maincls-experts.declarepartstyle.keys},
\autopageref{tab:maincls-experts.declarepartstyle.keys}.
Note\textnote{Attention!} that command \Macro{addpart} and the star variants
are configured automatically together with \Macro{part} and should not be
changed independently.
\item[\PValue{section}:] Style of section headings. This style is currently
- used for \Macro{section}, \Macro{subsection}, \Macro{subsubsection},
- \Macro{paragraph}, and \Macro{subparagraph}. You can define new section-like
+ used for \Macro{section}\IndexCmd{section},
+ \Macro{subsection}\IndexCmd{subsection},
+ \Macro{subsubsection}\IndexCmd{subsubsection},
+ \Macro{paragraph}\IndexCmd{paragraph}, and
+ \Macro{subparagraph}\IndexCmd{subparagraph}. You can define new section-like
commands using this style. To define new or to reconfigure existing commands
you can also use the additional attributes of
\autoref{tab:maincls-experts.declaresectionstyle.keys},
@@ -598,6 +606,16 @@ dependent attributes, too. Currently the following styles are provided:
\PValue{innerskip} & \PName{length} & The vertical skip between the prefix
line and the heading's text, if a
prefix line is used.\\
+ \PValue{pagestyle} & \PName{page style name} &
+ The name of the page style that
+ should be used automatically on
+ pages with the heading. There is no
+ validation whether or not
+ \PName{page style name} is really
+ the name of a page style. Therefore,
+ wrong names will result in error
+ messages at usage of the
+ section-like command.\\
\PValue{prefixfont} & \PName{font commands} &
The initial font setting that
should be used beside
@@ -638,10 +656,27 @@ dependent attributes, too. Currently the following styles are provided:
\Macro{setkomafont} and
\Macro{addtokomafont} for the
element of the heading.\\
- \PValue{innerskip} & \PName{length} & The vertical skip between the prefix
+ \PValue{innerskip} & \PName{length} & % \OnlyAt{\Class{scrbook}\and
+ % \Class{scrreprt}}%
+ The vertical skip between the prefix
line and the heading's text of
\Class{scrbook} and
\Class{scrreprt}.\\
+ \PValue{pagestyle} & \PName{page style name} &
+ % \OnlyAt{\Class{scrbook}\and
+ % \Class{scrreprt}}%
+ The name of the page style that
+ should be used automatically on
+ pages with the heading. There is no
+ validation whether or not
+ \PName{page style name} is really
+ the name of a page style. Therefore,
+ wrong names will result in error
+ messages at usage of the
+ section-like command. This feature
+ is only available with
+ \Class{scrbook} or
+ \Class{scrreprt}.\\
\PValue{prefixfont} & \PName{font commands} &
The initial font setting that
should be used beside
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 65baf33bf8a..d0730d85b30 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
@@ -46,13 +46,13 @@
% ============================================================================
\KOMAProvidesFile{scrbookreportarticle.tex}
- [$Date: 2015-05-11 09:45:36 +0200 (Mon, 11 May 2015) $
+ [$Date: 2015-06-15 13:41:43 +0200 (Mon, 15 Jun 2015) $
KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm\and
Krickette Murabayashi\and Jana Schubert\and Jens H\"uhne}
-% Date of translated german file: 2015-05-11
+% Date of translated german file: 2015-06-15
\chapter{The Main Classes: \Class{scrbook}, \Class{scrreprt}, and
\Class{scrartcl}}
@@ -1162,10 +1162,12 @@ the part. Because of this, \Class{scrartcl} does not support this option.
\begin{Declaration}
\KOption{chapterprefix}\PName{simple switch}\\
- \KOption{appendixprefix}\PName{simple switch}
+ \KOption{appendixprefix}\PName{simple switch}\\
+ \Macro{IfChapterUsesPrefixLine}\Parameter{then code}\Parameter{else code}
\end{Declaration}%
\BeginIndex{Option}{chapterprefix~=\PName{simple switch}}%
\BeginIndex{Option}{appendixprefix~=\PName{simple switch}}%
+\BeginIndex{Cmd}{IfChapterUsesPrefixLine}%
With\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} the standard classes
\Class{book} and \Class{report}, a chapter
title\Index[indexmain]{chapter>title} consists of a line with the word
@@ -1190,7 +1192,15 @@ of an appendix\Index{appendix} to be preceded by a line with ``Appendix''
followed by the appendix letter. This is achieved by using the
\Option{appendixprefix} option (see \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}). Since this results in an inconsistent
-document layout, I advise against using this option.
+document layout, I advise against using this option. Final consequence of
+using the option is, that \Macro{appendix} changes setting of option
+\Option{chapterprefix}.
+
+You\ChangedAt{v3.18}{\Class{scrbook}\and \Class{scrreprt}} can execute code
+depending on the current setting for the chapter preceding line using
+\Macro{IfChapterUsesPrefixLine}. If \Option{chapterprefix} is currently
+active, the \PName{then code} will be executed, otherwise the \PName{else
+ code}.
The font style of the chapter number line using
\OptionValue{chapterprefix}{true} or \OptionValue{appendixprefix}{true} may be
@@ -1205,6 +1215,7 @@ changed with element
\autoref{tab:maincls.structureElementsFont},
\autopageref{tab:maincls.structureElementsFont}).%
%
+\EndIndex{Cmd}{IfChapterUsesPrefixLine}%
\EndIndex{Option}{appendixprefix~=\PName{simple switch}}%
\EndIndex{Option}{chapterprefix~=\PName{simple switch}}%
@@ -2086,6 +2097,7 @@ You may also redefine this using \Macro{renewcommand} too.
\Macro{subparagraphformat}\\
\Macro{othersectionlevelsformat}\Parameter{sectioning
name}\Parameter{}\Parameter{counter output}\\
+ \Macro{IfUsePrefixLine}\Parameter{then code}\Parameter{else code}\\
\Macro{autodot}
\end{Declaration}%
\BeginIndex{Cmd}{partformat}\Index{part>number}%
@@ -2096,6 +2108,7 @@ You may also redefine this using \Macro{renewcommand} too.
\BeginIndex{Cmd}{paragraphformat}%
\BeginIndex{Cmd}{subparagraphformat}%
\BeginIndex{Cmd}{othersectionlevelsformat}\Index{section>number}%
+\BeginIndex{Cmd}{IfUsePrefixLine}%
\BeginIndex{Cmd}{autodot}%
{\KOMAScript} has added a further logical level on top of
\Macro{the\PName{sectioning name}} to the output of the sectioning
@@ -2134,15 +2147,24 @@ are used by the {\KOMAScript} classes:
\begin{lstcode}
\newcommand*{\partformat}{\partname~\thepart\autodot}
\newcommand*{\chapterformat}{%
- \chapappifchapterprefix{\ }\thechapter\autodot\enskip}
- \newcommand*{\sectionformat}{%
- \csname thesection\endcsname\autodot\enskip
- }%
+ \mbox{\chapappifchapterprefix{\nobreakspace}\thechapter
+ \autodot\IfUsePrefixLine{}{\enskip}}}
+ \newcommand*{\sectionformat}{\thesection\autodot\enskip}
\newcommand*{\othersectionlevelsformat}[3]{%
#3\autodot\enskip}
\end{lstcode}
The definitions of the lower levels correspond to
-\Macro{sectionformat}.
+\Macro{sectionformat}.
+
+Because\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}} of
+\Macro{IfUsePrefixLine} command \Macro{chapterformat} should not be used
+outside of \Macro{chapter}. \Macro{IfUsePrefixLine} is only valid inside
+section commands of \KOMAScript{}. In this case, it executes the \PName{then
+ code} if a prefix line for the number is used, but \PName{else code}
+otherwise.
+
+Do\textnote{Attention!} not forget to change \Macro{newcommand} into
+\Macro{renewcommand} if you like to re-define one of the commands.
\begin{Example}
Assume that when using \Macro{part} you do not want the word
@@ -2179,6 +2201,7 @@ The definitions of the lower levels correspond to
\end{Example}
%
\EndIndex{Cmd}{autodot}%
+\EndIndex{Cmd}{IfUsePrefixLine}%
\EndIndex{Cmd}{othersectionlevelsformat}%
\EndIndex{Cmd}{paragraphformat}%
\EndIndex{Cmd}{subparagraphformat}%
@@ -2255,17 +2278,17 @@ 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} (see \Macro{ifnumbered} on
- \autopageref{desc:maincls.cmd.ifnumbered}) or you should also redefine
- \Macro{addchapmark} and \Macro{addsecmark} suitable.
+ Please note\textnote{Attention!}, the running heads of
+ \Macro{addchap}\IndexCmd{addchap} and \Macro{addsec}\IndexCmd{addsec} are
+ also based on \Macro{chaptermark} and \Macro{addsecmark} but locally set
+ counter \Counter{secnumdepth} to a value that makes chapters respectively
+ sections not numbered. You should pay attention for this especially if you
+ redefine \Macro{chaptermark} or \Macro{sectionmark} (see \Macro{ifnumbered}
+ on \autopageref{desc:maincls.cmd.ifnumbered}). The star variants
+ \Macro{addchap*} and \Macro{addsec*} use additional commands
+ \Macro{addchapmark} and \Macro{addsecmark} that are defined also basing on
+ \Macro{chaptermark} and \Macro{sectionmark} with local changes of
+ \Counter{secnumdepth}.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no command
\Macro{chaptermark} or \Macro{chaptermarkformat} in
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 58257bfec99..c99d8f39aeb 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
@@ -46,7 +46,7 @@
% ============================================================================
\KOMAProvidesFile{scrhack.tex}
- [$Date: 2015-04-16 10:41:14 +0200 (Thu, 16 Apr 2015) $
+ [$Date: 2015-05-18 08:58:57 +0200 (Mon, 18 May 2015) $
KOMA-Script guide (chapter: scrhack)]
\translator{Markus Kohm}
@@ -107,14 +107,14 @@ will need a certain package loading order, though all these packages are not
related to each other. Wrong loading order could result in an error or break the
functionality of the commands.
-To clear all this disadvantages and problems, \KOMAScript{} officially does not
-support this old interface any more. Instead \KOMAScript{} warns, if the old
+To clear all these 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
\autoref{cha:tocbasic}) has been designed and implemented as a central
interface for management of table of contents, lists of floats and similar
lists. Usage of this package provides much more advantages and features than
-the two old commands, that has been alluded above.
+the two old commands that have been mentioned above.
Though the effort using that package is very small, the authors of most of the
packages, that are using the old interface, have not done so currently. Because
@@ -130,7 +130,7 @@ about the features provided by the changeover to package \Package{tocbasic}
can be found in \autoref{sec:tocbasic.toc}.
If the modification for any of the packages is not wanted or causes problems,
-then is can be deactivated selectively with option
+then it can be deactivated selectively with option
\OptionValue{float}{false}\IndexOption[indexmain]{float~=\PValue{false}},
\OptionValue{floatrow}{false}\IndexOption[indexmain]{floatrow~=\PValue{false}},
or
@@ -147,7 +147,7 @@ Some packages always expect that the class-internal macro
integer. For compatibility, \KOMAScript{} defines \Macro{@ptsize} even if the
basic font size is neither 10\Unit{pt} nor 11\Unit{pt} nor
12\Unit{pt}. \KOMAScript{} also provides non-integer font sizes. So
-\Macro{@ptsize} can expand to an non-integer number, too.
+\Macro{@ptsize} can expand to a non-integer number, too.
Package \Package{setspace}\IndexPackage[indexmain]{setspace} is one of the
packages that fail with non-integer number expansion of
@@ -158,7 +158,7 @@ redefining \Macro{onehalfspacing} and \Macro{doublespacing} using always the
current font size while setting the stretch.
If the modification for the package is not wanted or causes problems,
-then is can be deactivated selectively with option
+then it can be deactivated selectively with option
\OptionValue{setspace}{false}\IndexOption[indexmain]{setspace~=\PValue{false}}.
Please note\textnote{Attention!} that changing these option after loading
\Package{setspace} would not do it! If you use \Package{setspace} with
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
index 5dee2a97c87..e81a0a8a327 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex
@@ -46,12 +46,12 @@
% ============================================================================
\KOMAProvidesFile{scrlayer.tex}
- [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
+ [$Date: 2015-05-19 11:08:32 +0200 (Tue, 19 May 2015) $
KOMA-Script guide (chapter:scrlayer)]
\translator{Markus Kohm}
-% Date of the translated file: 2015-03-31
+% Date of the translated file: 2015-05-19
\chapter[{Defining Layers and Page Styles Using \Package{scrlayer}}]%
{Defining Layers and Page Styles Using \Package{scrlayer}%
@@ -295,8 +295,7 @@ there has not been a layer with \PName{layer name} defined before.
}{%
Options for the definition of layers (\emph{Continuation})%
}%
- \ifnum\currentversionlt{3.16}\else
- \nentry{%
+ \entry{%
\ChangedAt{v3.16}{\Package{scrlayer}}%
\KOption{addcontents}\PName{Code}}{%
Value \PName{code} will be added (or appended) at the very end of the
@@ -305,35 +304,34 @@ there has not been a layer with \PName{layer name} defined before.
information about the handling of \PName{code} see option
\Option{contents}.%
}%
- \nentry{%
+ \entry{%
\ChangedAt{v3.16}{\Package{scrlayer}}%
\KOption{addheight}\PName{additional height}}{%
The current value of attribute \Option{height} will be increased by the
value of this option. You can use the same kind of values as for
\Option{height}.%
}%
- \nentry{%
+ \entry{%
\ChangedAt{v3.16}{\Package{scrlayer}}%
\KOption{addhoffset}\PName{additional horizontal offset}}{%
The current value of attribute \Option{hoffset} will be increased by the
value of this option. You can use the same kind of values as for
\Option{hoffset}.%
}%
- \nentry{%
+ \entry{%
\ChangedAt{v3.16}{\Package{scrlayer}}%
\KOption{addvoffset}\PName{additional vertical offset}}{%
The current value of attribute \Option{voffset} will be increased by the
value of this option. You can use the same kind of values as for
\Option{voffset}.%
}%
- \nentry{%
+ \entry{%
\ChangedAt{v3.16}{\Package{scrlayer}}%
\KOption{addwidth}\PName{additional width}}{%
The current value of attribute \Option{width} will be increased by the
value of this option. You can use the same kind of values as for
\Option{width}.%
}%
- \fi
\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
@@ -360,13 +358,19 @@ there has not been a layer with \PName{layer name} defined before.
paper to the top edge of the layer.
\end{description}%
}%
- \nentry{\KOption{area}{%^^A
+ \entry{\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{\ChangedAt{v3.18}{\Package{scrlayer}}%
+ \Option{backandforeground}}{%
+ This option removes any foreground or background restriction of the layer.
+ Generally usage of this option makes no sense, but it is provided for
+ completeness of the user interface. The option does not expect any value.%
+ }%
\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
@@ -380,14 +384,14 @@ there has not been a layer with \PName{layer name} defined before.
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}}}{%
+ \entry{\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}}}{%
+ \entry{\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
@@ -399,6 +403,23 @@ there has not been a layer with \PName{layer name} defined before.
layers would be printed on odd pages and on even pages. Note, that this
attribute subsumes \Option{twoside}.%
}%
+ \entry{\ChangedAt{v3.18}{\Package{scrlayer}}%
+ \Option{everypage}}{%
+ This is a combination of \Option{oddorevenpage} and
+ \Option{floatornonfloatpage}. The option does not expect any value.%
+ }%
+ \entry{\Option{everyside}}{%
+ This option removes any restriction of the layer to single side or double
+ side printing. This is also the default of layers. The option does not
+ expect any value.%
+ }%
+ \entry{\ChangedAt{v3.18}{\Package{scrlayer}}%
+ \Option{floatornonfloatpage}}{%
+ This option removes any restriction of the layer to float or non-float
+ pages. So the layer will be printed independent of whether a page is a
+ float page or not. This is also the default of layers. The option does
+ not expect any value.%
+ }%
\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
@@ -435,7 +456,7 @@ there has not been a layer with \PName{layer name} defined before.
the text area and vertically span the distance between the page head and
the text area.%
}%
- \nentry{\KOption{height}{\PName{length}}}{%
+ \entry{\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
@@ -443,7 +464,7 @@ there has not been a layer with \PName{layer name} defined before.
information about valid dimensional expressions see
\cite[section~3.5]{manual:eTeX}.%
}%
- \nentry{\KOption{hoffset}{\PName{length}}}{%
+ \entry{\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
@@ -469,6 +490,12 @@ there has not been a layer with \PName{layer name} defined before.
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{\ChangedAt{v3.18}{\Package{scrlayer}}%
+ \Option{oddorevenpage}}{%
+ Removes any restriction of the layer to odd or even pages. So it will be
+ printed independently of whether a page is odd or even. This is also the
+ default of layers. The option does not expect any value.%
+ }%
\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
@@ -493,16 +520,13 @@ there has not been a layer with \PName{layer name} defined before.
vertically span the whole paper from the left edge to the right edge and
the top edge to the bottom edge.%
}%
- \ifnum\currentversionlt{3.16}\else
- \nentry{%
- \ChangedAt{v3.16}{\Package{scrlayer}}%
+ \entry{\ChangedAt{v3.16}{\Package{scrlayer}}%
\KOption{pretocontents}\PName{code}}{%
Value \PName{code} will be added at the very beginning of the current
value of attribute \Option{contents}. So the new content will be generated
in front of the already existing content. For more information about the
handling of \PName{code} see option \Option{contents}.%
}%
- \fi
\entry{\Option{rightmargin}}{%
The composed option sets \Option{hoffset}, \Option{voffset},
\Option{width}, \Option{height}, and \Option{align} to horizontally span
@@ -527,13 +551,19 @@ there has not been a layer with \PName{layer name} defined before.
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}}}{%
+ \entry{\ChangedAt{v3.18}{\Package{scrlayer}}%
+ \Option{unrestricted}}{%
+ This option removes all output restrictions of the layer. It is a
+ combination of \Option{backandforground}, \Option{everyside}, and
+ \Option{floatornonfloatpage}. The option does not expect any value.%
+ }%
+ \entry{\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}}}{%
+ \entry{\KOption{width}{\PName{length}}}{%
Sets the width of the layer. See \Option{height} for more information
about valid content of \PName{length}.%
}%
@@ -568,7 +598,6 @@ result in unpredictable issues.%
\EndIndex{Cmd}{layeryoffset}%
\EndIndex{Cmd}{layerxoffset}%
-\ifnum\currentversionlt{3.16}\else
\begin{Declaration}
\Macro{GetLayerContents}\Parameter{layer name}
\end{Declaration}
@@ -580,7 +609,6 @@ command inside the \PName{code} of the layer attributes \Option{contents},
an infinite recursion, if the content of the current layer is referenced. You
yourself should avoid such situations!%
\EndIndex{Cmd}{GetLayerContents}%
-\fi
\begin{Declaration}
\Macro{IfLayerExists}%
@@ -971,9 +999,12 @@ style hook options via \PName{option list}. You may remove the default, using
\begin{Declaration}
\KOption{deactivatepagestylelayers}\PName{simple switch}\\
- \Macro{ForEachLayerOfPageStyle}\Parameter{page style name}\Parameter{code}
+ \Macro{ForEachLayerOfPageStyle}\Parameter{page style name}\Parameter{code}\\
+ \Macro{ForEachLayerOfPageStyle*}\Parameter{page style name}\Parameter{code}
\end{Declaration}
+\BeginIndex{Option}{deactivatepagestylelayers~=\PName{simple switch}}%
\BeginIndex{Cmd}{ForEachLayerOfPageStyle}%
+\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 member layer of \PName{page style name}'s layers
@@ -994,12 +1025,21 @@ 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.
+Alternatively,\ChangedAt{v3.18}{\Package{scrlayer}} you can use \Macro{def}
+but the star variant \Macro{ForEachLayerOfPageStyle*}. This type does not use
+an additional group for executing \PName{code}. On the other hand the user has
+to take care on side effects of \PName{code}, i.\,e., deactivation of all
+layers using \OptionValue{deactivatepagestylelayers}{true} in \PName{code}
+would persist after \Macro{ForEachLayerOfPageStyle*}.
+
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*}%
\EndIndex{Cmd}{ForEachLayerOfPageStyle}%
+\EndIndex{Option}{deactivatepagestylelayers~=\PName{simple switch}}%
\begin{Declaration}
\Macro{AddLayersToPageStyle}%
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 5b469e5ee0d..eb7397b2352 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
@@ -48,9 +48,9 @@
%% find a complete unmodified copy of LaTeX2e at
%% <http://www.ctan.org/pub/tex-archive/macros/latex/base/>.
%%
-%%% From File: $Id: tocbasic.dtx 2041 2015-03-25 08:42:54Z kohm $
+%%% From File: $Id: tocbasic.dtx 2146 2015-06-20 06:38:46Z kohm $
\ProvidesFile{tocbasic.tex}[%
- 2015/05/06 v3.17a KOMA-Script
+ 2015/07/02 v3.18 KOMA-Script
package
(handling toc-files)%
]
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 2aecb52b687..d0fb50cf691 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
@@ -46,11 +46,11 @@
% ======================================================================
\KOMAProvidesFile{typearea-experts.tex}
- [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
+ [$Date: 2015-05-21 15:48:01 +0200 (Thu, 21 May 2015) $
KOMA-Script guide (chapter: typearea)]
\translator{Markus Kohm\and Gernot Hassenpflug}
-% Date of the translated German file: 2015-03-31
+% Date of the translated German file: 2015-05-21
\chapter{Additional Information about package \Package{typearea}}
\labelbase{typearea-experts}
@@ -95,9 +95,17 @@ after usage of \Macro{activateareas}. Moreover all changes of
\EndIndex{Cmd}{activateareas}
\begin{Declaration}
- \Macro{storeareas}\Parameter{\Macro{command}}
+ \Macro{storeareas}\Parameter{\Macro{command}}\\
+ \Macro{BeforeRestoreareas}\Parameter{code}\\
+ \Macro{BeforeRestoreareas*}\Parameter{code}\\
+ \Macro{AfterRestoreareas}\Parameter{code}\\
+ \Macro{AfterRestoreareas*}\Parameter{code}
\end{Declaration}
-\BeginIndex{Cmd}{storearea}%
+\BeginIndex{Cmd}{storeareas}%
+\BeginIndex{Cmd}{BeforeRestoreareas}%
+\BeginIndex{Cmd}{BeforeRestoreareas*}%
+\BeginIndex{Cmd}{AfterRestoreareas}%
+\BeginIndex{Cmd}{AfterRestoreareas*}%
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
@@ -135,7 +143,21 @@ defined \PName{\Macro{command}} should be used inside a group. Internally
used to define the \PName{\Macro{command}}. So re-usage of a
\PName{\Macro{command}} to store settings again would result in a
corresponding error message.
+
+Often\ChangedAt{v3.18}{\Package{typearea}} it is useful to automatically
+execute commands like \Macro{cleardoubleoddpage} before restoring the settings
+of a \Macro{command} generated by \Macro{storeareas}. You can do so using
+\Macro{BeforeRestoreareas} or \Macro{BeforeRestoreareas*}. Analogously you can
+use \Macro{AfterRestoreareas} or \Macro{AfterRestoreareas*} to automatically
+execute \PName{code} after restoring the settings. The variants with and
+without star differs so that the star variant changes only the auto-execution
+\PName{code} of future \PName{command}s and the variant without star also
+changes the auto-execution \PName{code} of already defined \PName{command}s.
%
+\EndIndex{Cmd}{AfterRestoreareas*}%
+\EndIndex{Cmd}{AfterRestoreareas}%
+\EndIndex{Cmd}{BeforeRestoreareas*}%
+\EndIndex{Cmd}{BeforeRestoreareas}%
\EndIndex{Cmd}{storeareas}
\begin{Declaration}