summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex')
-rw-r--r--macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex59
1 files changed, 43 insertions, 16 deletions
diff --git a/macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex b/macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex
index e56824c156..e21205f8b7 100644
--- a/macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex
+++ b/macros/latex/contrib/koma-script/source-doc/english/scrlayer.tex
@@ -46,12 +46,12 @@
% ============================================================================
\KOMAProvidesFile{scrlayer.tex}
- [$Date: 2019-10-10 09:50:23 +0200 (Thu, 10 Oct 2019) $
+ [$Date: 2019-12-06 12:04:10 +0100 (Fri, 06 Dec 2019) $
KOMA-Script guide (chapter:scrlayer)]
\translator{Markus Kohm\and Karl Hagen}
-% Date of the translated German file: 2019-10-09
+% Date of the translated German file: 2019-12-03
\chapter[{Defining Layers and Page Styles with \Package{scrlayer}}]
{Defining\ChangedAt{v3.12}{\Package{scrlayer}} Layers and Page Styles with
@@ -774,26 +774,29 @@ it will be set to \Macro{relax}. In page styles already defined with
redefined using \DescRef{\LabelBase.cmd.DeclareNewLayer} or
\DescRef{\LabelBase.cmd.ProvideLayer}, but they can no longer be changed using
\DescRef{\LabelBase.cmd.RedeclareLayer} or
-\DescRef{\LabelBase.cmd.ModifyLayer}.
-
+\DescRef{\LabelBase.cmd.ModifyLayer}.%
+\iffalse % See the note at the beginning of the end user interface section
+\par
The command is intended to be used inside
\DescRef{\LabelBase.cmd.scrlayerOnAutoRemoveInterface} (see
\autoref{sec:scrlayer.enduserinterfaces},
\DescPageRef{scrlayer.cmd.scrlayerOnAutoRemoveInterface})
to remove layers defined using removable macros of an interface along with
that interface.%
+\fi
\EndIndexGroup
\begin{Declaration}
+ \OptionVName{draft}{simple switch}
\Macro{layercontentsmeasure}%
\end{Declaration}
-The \Macro{layercontentsmeasure} command prints a ruler at each layer edge, of
-which the top and left one is labelled in centimetres and the right and bottom
-one in inches. This command is used internally if the
-\DescRef{\LabelBase.option.draft}\IndexOption{draft} option is enabled. The
-rulers are drawn behind the content of each layer. This command can also be
-used as exclusive content of a layer.%
+The \KOMAScript{} option \Option{draft} can be used to active the draft mode
+of \Package{scrlayer}. The draft mode uses the \Macro{layercontentsmeasure}
+command to print a ruler at each layer edge, of which the top and left one is
+labelled in centimetres and the right and bottom one in inches. The rulers are
+drawn behind the content of each layer. This command can also be used as
+exclusive content of a layer.%
\EndIndexGroup
@@ -875,7 +878,7 @@ If \DescRef{maincls.cmd.pagestyle} activates an alias page style,
the real page style. You\ChangedAt{v3.16}{\Package{scrlayer}} can get the
alternative name using \Macro{toplevelpagestyle}. However, it is not
recommended to define page styles that produce different results depending on
-\Macro{toplevelpagestyle}, e.\,g., using \DescRef{scrbase.cmd.ifstr}. If you
+\Macro{toplevelpagestyle}, e.\,g., using \DescRef{scrbase.cmd.Ifstr}. If you
were to activate such a page style using \DescRef{maincls.cmd.thispagestyle}
you could get the wrong result.%
\EndIndexGroup
@@ -967,12 +970,14 @@ This command renders the page style named \PName{page style name} undefined
for \LaTeX{} if it is an alias for another page style. Afterwards, the page
style can be newly defined with
\DescRef{\LabelBase.cmd.DeclareNewPageStyleAlias} or
-\DescRef{\LabelBase.cmd.ProvidePageStyleAlias}.
-
+\DescRef{\LabelBase.cmd.ProvidePageStyleAlias}.%
+\iffalse % See the note at the beginning of the end user interface section
+\par
This command is intended to be used inside the argument code of
\DescRef{\LabelBase.cmd.scrlayerOnAutoRemoveInterface} to remove page styles
that have been declared as part of an end-user interface when removing this
interface automatically.%
+\fi%
\EndIndexGroup
@@ -1469,13 +1474,15 @@ automatically. If you want to destroy the layers too, you can do this with:
\begin{lstcode}
\ForEachLayerOfPageStyle{...}{\DestroyLayer{#1}}
\end{lstcode}
-before destroying the layer page style itself.
-
+before destroying the layer page style itself.%
+\iffalse % See the note at the beginning of the end user interface section
+\par
The command is intended to be used within the \PName{code} argument of
\DescRef{\LabelBase.cmd.scrlayerOnAutoRemoveInterface} to remove page styles
that are defined as part of an end-user interface. See
\autoref{sec:scrlayer.enduserinterfaces} below for more information about
auto-removal code.%
+\fi%
\EndIndexGroup
\EndIndexGroup
@@ -1486,6 +1493,25 @@ auto-removal code.%
\section{Defining and Managing Interfaces for End Users}
\seclabel{enduserinterfaces}
+\iftrue% The whole mechanism is deprecated and should not be used any
+ % longer. So the documentation is also deactivated.
+% TODO: Fix new translation
+Until version 3.27\ChangedAt{v3.28}{\Package{scrlayer}} package
+\Package{scrlayer} provided mechanism to manage concurrent end user
+interfaces. The mechanism has been marked as experimental and the usability
+limited. Only \KOMAScript{} itself has used this mechanism and from version
+3.28 it is marked as deprecated. So the commands
+\Macro{scrlayerInitInterface}\IndexCmd{scrlayerInitInterface},
+\Macro{scrlayerAddToInterface}\IndexCmd{scrlayerAddToInterface},
+\Macro{scrlayerAddCsToInterface}\IndexCmd{scrlayerAddCsToInterface},
+\Macro{scrlayerOnAutoRemoveInterface}\IndexCmd{scrlayerOnAutoRemoveInterface}%
+\important{\Macro{scrlayerOnAutoRemoveInterface}}
+and the options
+\Option{forceoverwrite}\IndexOption{forceoverwrite},
+\Option{autoremoveinterfaces}\IndexOption{autoremoveinterfaces}
+should not be used any longer.%
+% :ODOT
+\else%
The \Package{scrlayer} package provides an experimental interface to define
and manage (concurrent) interfaces for end users. \iffree{In the long run,
this interface may disappear from \Package{scrlayer} and be taken over by
@@ -1589,7 +1615,8 @@ that rely on commands from the end-user interface (see
\DescRef{\LabelBase.cmd.DestroyRealLayerPageStyle}). Regarding the default for
the optional argument, please refer to the explanation for
\DescRef{\LabelBase.cmd.scrlayerInitInterface}.%
-\EndIndexGroup
+\EndIndexGroup%
+\fi%
%
\EndIndexGroup