summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer.tex86
1 files changed, 63 insertions, 23 deletions
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}%