summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlayer-scrpage.tex486
1 files changed, 200 insertions, 286 deletions
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
index 77be57d0532..b7254e0df94 100644
--- 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
@@ -1,6 +1,6 @@
% ======================================================================
% scrlayer-scrpage.tex
-% Copyright (c) Markus Kohm, 2013-2015
+% Copyright (c) Markus Kohm, 2013-2017
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlayer-scrpage.tex
-% Copyright (c) Markus Kohm, 2013-2015
+% Copyright (c) Markus Kohm, 2013-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -44,7 +44,7 @@
% ============================================================================
\KOMAProvidesFile{scrlayer-scrpage.tex}%
- [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (chapter: scrlayer-scrpage)]
\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}
@@ -55,12 +55,13 @@
Footers with \Package{scrlayer-scrpage}}
\labelbase{scrlayer-scrpage}
%
+\BeginIndexGroup
\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{}
+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
@@ -89,13 +90,14 @@ 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
+the element scheme (see \DescRef{\LabelBase.cmd.setkomafont},
+\DescRef{\LabelBase.cmd.addtokomafont}, and
+\DescRef{\LabelBase.cmd.usekomafont} in \autoref{sec:maincls.textmarkup}, from
+\DescPageRef{maincls.cmd.setkomafont}) or the configurable numbering format
+for dynamic headers (see option \DescRef{maincls.option.numbers} and, e.\,g.,
+\DescRef{\LabelBase.cmd.chaptermarkformat} in \autoref{sec:maincls.structure},
+\DescPageRef{maincls.option.numbers} and
+\DescPageRef{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.
@@ -109,11 +111,11 @@ 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}
+\LoadCommonFile{options} % \section{Early or late Selection of Options}
-\LoadCommon{20} % \section{Head and Foot Width}
+\LoadCommonFile{headfootheight} % \section{Head and Foot Width}
-\LoadCommon{5} % \section{Text Markup}
+\LoadCommonFile{textmarkup} % \section{Text Markup}
\section{Usage of Predefined Page Styles}
\seclabel{predefined.pagestyles}
@@ -122,81 +124,73 @@ The easiest way to your desired design for page header and footer with
\Package{scrlayer-scrpage} is to use one of the predefined page styles.
\begin{Declaration}
- \Pagestyle{scrheadings}\\
- \Pagestyle{plain.scrheadings}
+ \PageStyle{scrheadings}%
+ \PageStyle{plain.scrheadings}
\end{Declaration}
-\BeginIndex{Pagestyle}{scrheadings}%
-\BeginIndex{Pagestyle}{plain.scrheadings}%
Package \Package{scrlayer-scrpage} provides two page styles, which may be
reconfigured to meet your individual reqirements. Let's first of all discuss
-page style \Pagestyle{scrheadings} which has been designed as a style using
+page style \PageStyle{scrheadings} which has been designed as a style using
running heads. Its defaults are similar to the page style
-\Pagestyle{headings}\IndexPagestyle{headings} of the \LaTeX standard classes
+\PageStyle{headings}\IndexPagestyle{headings} of the \LaTeX standard classes
or the \KOMAScript{} classes. What exactly gets printed in the header or
footer can be configured via the commands and otions described hereafter.
-The second page style to be mentioned here is \Pagestyle{plain.scrheadings},
+The second page style to be mentioned here is \PageStyle{plain.scrheadings},
which has been designed to be a style with no running head. Its defaults are
-very similar to page style \Pagestyle{plain}\IndexPagestyle{plain} of \LaTeX's
+very similar to page style \PageStyle{plain}\IndexPagestyle{plain} of \LaTeX's
standard classes or the \KOMAScript{} classes. The following will describe the
commands and options you may use to adjust the contents of the header and
footer .
-You could of course configure \Pagestyle{scrheadings} to be a page style
-without a running head and \Pagestyle{plain.scrheadings} to be a page style
+You could of course configure \PageStyle{scrheadings} to be a page style
+without a running head and \PageStyle{plain.scrheadings} to be a page style
using running heads. It is, however, far more expedient to adhere to the
conventions mentioned above, if for the only reason that both page styles
mutually influence one another. Once you have opted to apply 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}. Thus, if you use a class or package
-that automatically switches between \Pagestyle{headings} and
-\Pagestyle{plain}, you only need to select \Pagestyle{scrheadings} or
-\Pagestyle{plain.scrheadings} once and the switching class or package will
-then switch between \Pagestyle{scrheadings} and \Pagestyle{plain.scrheadings}
+page styles, \PageStyle{scrheadings} will become accessible as
+\PageStyle{headings} and the page style \PageStyle{plain.scrheadings} will
+become accessible as \PageStyle{plain}. Thus, if you use a class or package
+that automatically switches between \PageStyle{headings} and
+\PageStyle{plain}, you only need to select \PageStyle{scrheadings} or
+\PageStyle{plain.scrheadings} once and the switching class or package will
+then switch between \PageStyle{scrheadings} and \PageStyle{plain.scrheadings}
without even being aware of these page styles. Patches or other adaptions of
classes (or packages) will not be necessary. This pair of page styles may thus
-serve as a drop-in replacement for \Pagestyle{headings} and \Pagestyle{plain}.
+serve as a drop-in replacement for \PageStyle{headings} and \PageStyle{plain}.
Should additional similar pairs be required I'd like to point you to
\autoref{sec:scrlayer-scrpage-experts.pagestyle.pairs} in
\autoref{part:forExperts} for further reference.
For users of the older \Package{scrpage2}, I'd like to mention that, for
compatibility with \Package{scrpage2}, page style
-\Pagestyle{plain.scrheadings} may also be used under its alias name of
-\Pagestyle{scrplain}\IndexPagestyle[indexmain]{scrplain}.%
+\PageStyle{plain.scrheadings} may also be used under its alias name of
+\PageStyle{scrplain}\IndexPagestyle[indexmain]{scrplain}.%
\iffree{}{ If you use \Package{scrpage2}\IndexPackage{scrpage2}, however,
- \Pagestyle{plain.scrheadings} will not be available. Its function is
- completely taken over by pagestyle \Pagestyle{scrplain}.}
+ \PageStyle{plain.scrheadings} will not be available. Its function is
+ completely taken over by pagestyle \PageStyle{scrplain}.}
%
-\EndIndex{Pagestyle}{plain.scrheadings}%
-\EndIndex{Pagestyle}{scrheadings}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{lehead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cehead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{rehead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{lohead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cohead}\OParameter{plain.scrheadings's content}%
- \Parameter{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
+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}.
+\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}''
@@ -221,14 +215,14 @@ 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}%
+\BeginIndex{FontElement}{pagehead}\LabelFontElement{pagehead}%
+\BeginIndex{FontElement}{pageheadfoot}\LabelFontElement{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
+changed using commands \DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see \autoref{sec:maincls.textmarkup},
+\DescPageRef{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}%
@@ -372,21 +366,21 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
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
+ page style \PageStyle{plain} for the page with the title head. After command
+ \DescRef{maincls.cmd.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.
+ 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
+ Please add some text below \DescRef{maincls.cmd.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.
+ preamble and \Macro{lipsum}\IndexCmd{lipsum} below
+ \DescRef{maincls.cmd.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
@@ -407,7 +401,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\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
+ \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.
@@ -420,46 +414,34 @@ 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}%
-
+\EndIndexGroup
\begin{Declaration}
\Macro{lehead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cehead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{rehead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{lohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{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 previously described commands have also a version with
star\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} that differs only if you
omit the optional argument \PName{plain.scrheadings's content}. In this case
the version without star does not change the content of
-\Pagestyle{plain.scrheadings}. The version with star on the other hand uses
+\PageStyle{plain.scrheadings}. The version with star on the other hand uses
the obligatory argument \PName{scrheading's content} also as default for
-\Pagestyle{plain.scrheadings}. So, if both arguments should be the same, you
+\PageStyle{plain.scrheadings}. So, if both arguments should be the same, you
can simply use the star version with the obligatory argument only.%
\begin{Example}
You can shorten the previous example using the star version of
- \Macro{lohead} and \Macro{rohead}:
+ \DescRef{\LabelBase.cmd.lohead} and \DescRef{\LabelBase.cmd.rohead}:
\begin{lstcode}
\documentclass{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -477,39 +459,28 @@ can simply use the star version with the obligatory argument only.%
The obsolete package \Package{scrpage2}\important{\Package{scrpage2}} does not
provide this feature.%
%
-\EndIndex{Cmd}{rohead*}%
-\EndIndex{Cmd}{cohead*}%
-\EndIndex{Cmd}{lohead*}%
-\EndIndex{Cmd}{rehead*}%
-\EndIndex{Cmd}{cehead*}%
-\EndIndex{Cmd}{lehead*}%
+\EndIndexGroup
\begin{Declaration}
\Macro{lefoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cefoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{refoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{lofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{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
+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}.
+\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}''
@@ -534,14 +505,14 @@ 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}%
+\BeginIndex{FontElement}{pagefoot}\LabelFontElement{pagefoot}%
+\BeginIndex{FontElement}{pageheadfoot}\LabelFontElement[foot]{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
+changed using commands \DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see \autoref{sec:maincls.textmarkup},
+\DescPageRef{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}%
@@ -694,17 +665,18 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\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}.
+ \Package{scrpage-scrlayer} has been loaded, because the \KOMAScript{} class
+ already defines \DescRef{\LabelBase.fontelement.pagehead} and
+ \DescRef{\LabelBase.fontelement.pageheadfoot} but with the same
+ meaning. Only loading \Package{scrpage-scrlayer} changes the meaning of
+ \DescRef{\LabelBase.fontelement.pagehead} and makes it an element
+ independent of \DescRef{\LabelBase.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{}
+ 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
@@ -751,46 +723,35 @@ 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}%
+\EndIndexGroup
\begin{Declaration}
\Macro{lefoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cefoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{refoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{lofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{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 previously described commands have also a version with
star\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} that differs only if you
omit the optional argument \PName{plain.scrheadings's content}. In this case
the version without star does not change the content of
-\Pagestyle{plain.scrheadings}. The version with star on the other hand uses
+\PageStyle{plain.scrheadings}. The version with star on the other hand uses
the obligatory argument \PName{scrheading's content} also as default for
-\Pagestyle{plain.scrheadings}. So, if both arguments should be the same, you
+\PageStyle{plain.scrheadings}. So, if both arguments should be the same, you
can simply use the star version with the obligatory argument only.
\begin{Example}
You can shorten the previous example using the star version of
- \Macro{lofoot} and \Macro{refoot}:
+ \DescRef{\LabelBase.cmd.lofoot} and \DescRef{\LabelBase.cmd.refoot}:
\begin{lstcode}
\documentclass[twoside]{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -814,34 +775,23 @@ can simply use the star version with the obligatory argument only.
The obsolete package \Package{scrpage2}\important{\Package{scrpage2}} does not
provide this feature.%
%
-\EndIndex{Cmd}{rofoot*}%
-\EndIndex{Cmd}{cofoot*}%
-\EndIndex{Cmd}{lofoot*}%
-\EndIndex{Cmd}{refoot*}%
-\EndIndex{Cmd}{cefoot*}%
-\EndIndex{Cmd}{lefoot*}%
+\EndIndexGroup
\begin{Declaration}
\Macro{ohead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{chead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{ihead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{ofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cfoot}\OParameter{plain.scrheadings's content}%
- \Parameter{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
@@ -852,15 +802,16 @@ 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.
+\Macro{ohead} is same like usage of both \DescRef{\LabelBase.cmd.lehead} and
+\DescRef{\LabelBase.cmd.rohead}. Command \Macro{chead} is same like
+\DescRef{\LabelBase.cmd.cehead} and \DescRef{\LabelBase.cmd.cohead}. And
+command \Macro{ihead} is same like \DescRef{\LabelBase.cmd.rehead} and
+\DescRef{\LabelBase.cmd.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:
@@ -895,45 +846,35 @@ 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}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{ohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{chead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{ihead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{ofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}\\
+ \Parameter{scrheadings's content}%
\Macro{cfoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{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*}%
The previously described commands have also a version with
star\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} that differs only if you
omit the optional argument \PName{plain.scrheadings's content}. In this case
the version without star does not change the content of
-\Pagestyle{plain.scrheadings}. The version with star on the other hand uses
+\PageStyle{plain.scrheadings}. The version with star on the other hand uses
the obligatory argument \PName{scrheading's content} also as default for
-\Pagestyle{plain.scrheadings}. So, if both arguments should be the same, you
+\PageStyle{plain.scrheadings}. So, if both arguments should be the same, you
can simply use the star version with the obligatory argument only.%
\begin{Example}
You can shorten the previous example using the star version of
- \Macro{ifoot}:
+ \DescRef{\LabelBase.cmd.ifoot}:
\begin{lstcode}
\documentclass[twoside]{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -954,61 +895,56 @@ can simply use the star version with the obligatory argument only.%
The obsolete package \Package{scrpage2}\important{\Package{scrpage2}} does not
provide this feature.%
%
-\EndIndex{Cmd}{ihead*}%
-\EndIndex{Cmd}{chead*}%
-\EndIndex{Cmd}{ohead*}%
-\EndIndex{Cmd}{ifoot*}%
-\EndIndex{Cmd}{cfoot*}%
-\EndIndex{Cmd}{ofoot*}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{pagestyleset}\PName{setting}
+ \OptionVName{pagestyleset}{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
+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}
+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.
+\OptionValueRef{\LabelBase}{markcase}{used}\IndexOption{markcase~=used}.
+Page style \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
+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
+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
+using
+\OptionValueRef{\LabelBase}{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.
+\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
+\PageStyle{scrheadings} will be activated. This will be also the case, if you
use the option inside the document.
\BeginIndex{Option}{komastyle}%
@@ -1018,19 +954,15 @@ Options \Option{komastyle} and \Option{standardstyle}, provided by
\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}%
+\EndIndexGroup
-\LoadCommon[scrlayerscrpage]{21} % \section{Manipulation of Defined Page Styles}
+
+\LoadCommonFile{pagestylemanipulation} % \section{Manipulation of Defined Page Styles}
\begin{Declaration}
- \KOption{headwidth}\PName{width\textup{:}offset\textup{:}offset}\\
- \KOption{footwidth}\PName{width\textup{:}offset\textup{:}offset}
+ \OptionVName{headwidth}{width\textup{:}offset\textup{:}offset}%
+ \OptionVName{footwidth}{width\textup{:}offset\textup{:}offset}
\end{Declaration}
-\BeginIndex{Option}{headwidth~=\PName{width\textup{:}offset\textup{:}offset}}%
-\BeginIndex{Option}{footwidth~=\PName{width\textup{:}offset\textup{:}offset}}%
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
@@ -1086,7 +1018,7 @@ zero. If you think, this is complicated, you should simply use an explicit
the current length of the horizontal line below the page head%
}%
\ventry{headtopline}{%
- the current lenght of the horizontal line above the page head%
+ the current length of the horizontal line above the page head%
}%
\ventry{marginpar}{%
the current width of the marginal note column including the distance
@@ -1094,9 +1026,9 @@ zero. If you think, this is complicated, you should simply use an explicit
}%
\ventry{page}{%
the current width of the page considering a binding correction of
- package \Package{typearea} (see option \Option{BCOR} in
+ package \Package{typearea} (see option \DescRef{typearea.option.BCOR} in
\autoref{sec:typearea.typearea},
- \autopageref{desc:typearea.option.BCOR})%
+ \DescPageRef{typearea.option.BCOR})%
}%
\ventry{paper}{%
the current width of the paper without considering a binding correction%
@@ -1112,19 +1044,15 @@ zero. If you think, this is complicated, you should simply use an explicit
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{footwidth~=\PName{width\textup{:}offset\textup{:}offset}}%
-\EndIndex{Option}{headwidth~=\PName{width\textup{:}offset\textup{:}offset}}%
+\EndIndexGroup
+
\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}
+ \OptionVName{headtopline}{thickness\textup{:}length}%
+ \OptionVName{headsepline}{thickness\textup{:}length}%
+ \OptionVName{footsepline}{thickness\textup{:}length}%
+ \OptionVName{footbotline}{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
@@ -1140,24 +1068,24 @@ 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}%
+options \DescRef{\LabelBase.option.ilines}\IndexOption{ilines},
+\DescRef{\LabelBase.option.clines}\IndexOption{clines}, and
+\DescRef{\LabelBase.option.olines}\IndexOption{olines} later in this section.
+
+\BeginIndex{FontElement}{headtopline}\LabelFontElement{headtopline}%
+\BeginIndex{FontElement}{headsepline}\LabelFontElement{headsepline}%
+\BeginIndex{FontElement}{footsepline}\LabelFontElement{footsepline}%
+\BeginIndex{FontElement}{footbotline}\LabelFontElement{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
+change these using command \DescRef{\LabelBase.cmd.setkomafont} or
+\DescRef{\LabelBase.cmd.addtokomafont} (see \autoref{sec:maincls.textmarkup}
+from \DescPageRef{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}%
@@ -1186,42 +1114,30 @@ on lines. Users often ignored this!%
\EndIndex{Cmd}{setheadsepline}%
\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}}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{plainheadtopline}\PName{simple switch}\\
- \KOption{plainheadsepline}\PName{simple switch}\\
- \KOption{plainfootsepline}\PName{simple switch}\\
- \KOption{plainfootbotline}\PName{simple switch}
+ \OptionVName{plainheadtopline}{simple switch}%
+ \OptionVName{plainheadsepline}{simple switch}%
+ \OptionVName{plainfootsepline}{simple switch}%
+ \OptionVName{plainfootbotline}{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
+\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
+\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}}%
+\PageStyle{plain} will not show the corresponding line.%
+\EndIndexGroup
+
\begin{Declaration}
- \Option{ilines}\\
- \Option{clines}\\
+ \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
@@ -1230,11 +1146,9 @@ 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}%
+\EndIndexGroup
%
-\EndIndex{Package}{scrlayer-scrpage}%
+\EndIndexGroup
%%% Local Variables:
%%% mode: latex