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.tex1271
1 files changed, 651 insertions, 620 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 b7254e0df94..d3c50bfef00 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-2017
+% Copyright (c) Markus Kohm, 2013-2018
%
% 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-2017
+% Copyright (c) Markus Kohm, 2013-2018
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -44,192 +44,215 @@
% ============================================================================
\KOMAProvidesFile{scrlayer-scrpage.tex}%
- [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
+ [$Date: 2018-03-30 11:57:25 +0200 (Fri, 30 Mar 2018) $
KOMA-Script guide (chapter: scrlayer-scrpage)]
-\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}
+\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne\and Karl Hagen}
-% Date version of the translated file: 2015-03-31
+% Date version of the translated file: 2018-02-13
-\chapter[{Adapting Page Headers and Footers with \Package{scrlayer-scrpage}}]
- {Adapting\ChangedAt{v3.12}{\Package{scrlayer-scrpage}} Page Headers and
+\chapter[{Headers and Footers with \Package{scrlayer-scrpage}}]
+ {Headers\ChangedAt{v3.12}{\Package{scrlayer-scrpage}} and
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{}
-classes. Until 2001 there was also package \Package{scrpage} as a supported
-solution for the same purpose. It was then made obsolete and in 2013, more
-than ten years later, it was finally removed from the regular
-\KOMAScript~distribution.
-
-In 2013 package \Package{scrlayer}\IndexPackage{scrlayer} became a basic
-module of \KOMAScript. That package provides a layer scheme and a new page
-style scheme based upon the layer scheme. Nevertheless, the flexibility it
-provides and the resulting complexity may be too demanding for the average
-user to handle. More about \Package{scrlayer} may be found in
-\autoref{cha:scrlayer} of \autoref{part:forExperts}. Potential problems with
-the controllability of \Package{scrlayer} apart, there are lots of users who
-are already familiar with the user interface of package \Package{scrpage2}.
-
-As a consequence the additional package \Package{scrlayer-scrpage} provides a
-user interface, which is largely compatible with \Package{scrpage2} and based
-on \Package{scrlayer}. Thus, if you are already familiar with \Package{scrpage2}
-and refrain from using dirty tricks, like calling internal commands of
-\Package{scrpage2} directly, it should be easy for you to use
-\Package{scrlayer-scrpage} as a drop-in replacement. Most examples covering
-\Package{scrpage2} in \LaTeX{} books or online resources should also work
-with \Package{scrlayer-scrpage} either directly or with only minor
-code changes provided that they stick to the standard interfaces.
-
-Apart from the aforementioned \KOMAScript{} packages, you could in principle
-also use \Package{fancyhdr}\IndexPackage{fancyhdr} (see
-\cite{package:fancyhdr}) in conjunction with a \KOMAScript{} class. However,
-\Package{fancyhdr}\ has no support for several \KOMAScript{} features, e.\,g.,
-the element scheme (see \DescRef{\LabelBase.cmd.setkomafont},
+\begin{Explain}
+ Until version 3.11b of \KOMAScript, the \Package{scrpage2}%
+ \IndexPackage[indexmain]{scrpage2}\important{\Package{scrpage2}} package was
+ the recommended way to customise headers and footers beyond the options
+ provided by the \PageStyle{headings}, \PageStyle{myheadings},
+ \PageStyle{plain}, and \PageStyle{empty} page styles of the \KOMAScript{}
+ classes.
+ \iffalse%
+ The still older \Package{scrpage}\IndexPackage{scrpage} package was marked
+ obsolete in 2001 and removed from the regular \KOMAScript{} distribution in
+ 2013.\par
+ \fi%
+ Since 2013, the \hyperref[cha:scrlayer]{\Package{scrlayer}}%
+ \important{\hyperref[cha:scrlayer]{\Package{scrlayer}}}%
+ \IndexPackage{scrlayer} package has been included as a basic module of
+ \KOMAScript. This package provides a layer model and a new page-style model
+ based upon it. However, the package's interface is almost too flexible and
+ consequently not easy for the average user to comprehend. For more
+ information about this interface, see \autoref{cha:scrlayer} in
+ \autoref{part:forExperts}. However, a few of the options that are actually
+ part of \Package{scrlayer}, and which are therefore taken up again in that
+ chapter, are also documented here because they are required to use
+ \Package{scrlayer-scrpage}.
+
+ Many users are already familiar with the commands from \Package{scrpage2}.
+ For this reason, \Package{scrlayer-scrpage} provides a method for
+ manipulating headers and footers which is based on \Package{scrlayer}, is
+ largely compatible with \Package{scrpage2}, and at the same time greatly
+ expands the user interface. If you are already familiar with
+ \Package{scrpage2} and refrain from direct calls to its internal commands,
+ you can usually use \Package{scrlayer-scrpage} as a drop-in replacement.
+ This also applies to most examples using \Package{scrpage2} found in
+ \LaTeX{} books or on the Internet.%
+ \iffalse%
+ \iffree{}{\par With the release of this book, \Package{scrlayer-scrpage}
+ for \KOMAScript{} is recommended as the tool of choice when it comes to
+ changing the predefined page styles. Using the obsolete package
+ \Package{scrpage2}\IndexPackage[indexmain]{scrpage2}%
+ \important{\Package{scrpage2}} is now deprecated. Therefore, the
+ commands for this outdated package are no longer part of this book. If
+ you encounter older documents that still use \Package{scrpage2},
+ consider switching to \Package{scrlayer-scrpage}. Notwithstanding, this
+ chapter does contain some hints for using \Package{scrpage2}.}%
+ \fi
+\end{Explain}
+
+In addition to \Package{scrlayer-scrpage}\iffree{ or \Package{scrpage2}}{},
+you could also use \Package{fancyhdr}\IndexPackage{fancyhdr} (see
+\cite{package:fancyhdr}) to configure the headers and footers of pages.
+However, this package has no support for several \KOMAScript{} features,
+for example the element scheme (see \DescRef{\LabelBase.cmd.setkomafont},
\DescRef{\LabelBase.cmd.addtokomafont}, and
-\DescRef{\LabelBase.cmd.usekomafont} in \autoref{sec:maincls.textmarkup}, from
+\DescRef{\LabelBase.cmd.usekomafont} in \autoref{sec:maincls.textmarkup},
\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
+for dynamic headers (see the \DescRef{maincls.option.numbers} option and,
+for example, \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.
-
-Besides the features described in this chapter, \Package{scrlayer-scrpage}
-provides several more that are likely only of minor interest to the average
-user and for this reason are described from
-\autopageref{cha:scrlayer-scrpage-experts} onwards in
-\autoref{cha:scrlayer-scrpage-experts} of \autoref{part:forExperts}.
-Nevertheless, should the options described in \autoref{part:forAuthors} be
-insufficient for your purposes you are encouraged to examine
-\autoref{cha:scrlayer-scrpage-experts}.
+\KOMAScript{} class, you should use the new \Package{scrlayer-scrpage}
+package. \iffree{If you have problems, you can still use
+\Package{scrpage2}.}{\ignorespaces} Of course, you can also use
+\Package{scrlayer-scrpage} with other classes, such as the standard \LaTeX{}
+ones.
+
+Apart from the features described in this chapter, \Package{scrlayer-scrpage}
+provides several more functions that are likely only of interest to a very
+small number of users and therefore are described in
+\autoref{cha:scrlayer-scrpage-experts} of \autoref{part:forExperts}, starting
+at \autopageref{cha:scrlayer-scrpage-experts}. Nevertheless, if the options
+described in \autoref{part:forAuthors} are insufficient for your purposes, you
+should examine \autoref{cha:scrlayer-scrpage-experts}.
\LoadCommonFile{options} % \section{Early or late Selection of Options}
-\LoadCommonFile{headfootheight} % \section{Head and Foot Width}
+\LoadCommonFile{headfootheight} % \section{Header and Footer Height}
\LoadCommonFile{textmarkup} % \section{Text Markup}
-\section{Usage of Predefined Page Styles}
+\section{Using Predefined Page Styles}
\seclabel{predefined.pagestyles}
-The easiest way to your desired design for page header and footer with
+The easiest way to create custom headers and footers with
\Package{scrlayer-scrpage} is to use one of the predefined page styles.
+%
+\iffalse % Umbruchoptimierung
+ This section introduces the page styles defined by the
+ \Package{scrlayer-scrpage} package as it loads. It also explains the
+ commands that you can use to create basic settings for these page
+ styles. You can find further options, commands, and background information
+ in the following sections and in
+ \autoref{sec:scrlayer-scrpage-experts.pagestyle.pairs} in
+ \autoref{part:forExperts}.%
+\fi
\begin{Declaration}
\PageStyle{scrheadings}%
\PageStyle{plain.scrheadings}
\end{Declaration}
-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
-running heads. Its defaults are similar to the page style
-\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},
-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
-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
+The \Package{scrlayer-scrpage} package provides two page styles that you can
+reconfigure to your liking. The first page style is
+\PageStyle{scrheadings}\important{\PageStyle{scrheadings}}, which is intended
+as a page style with running heads. Its defaults are similar to the page style
+\PageStyle{headings}\IndexPagestyle{headings} of the standard \LaTeX{} or
+\KOMAScript{} classes. You can configure exactly what appears in the header or
+footer with the commands and options described below.
+
+The second page style is \PageStyle{plain.scrheadings}%
+\important{\PageStyle{plain.scrheadings}}, which is intended to be a style
+with no running head. Its defaults resemble those of the
+\PageStyle{plain}\IndexPagestyle{plain} page style of the standard or
+\KOMAScript{} classes. You can configure exactly what appears in the header or
+footer with the commands and options described below.
+
+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}
-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}.
-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}.%
-\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}.}
-%
+with a running head. It is, however, advisable to adhere to the conventions
+mentioned above. The two page styles mutually influence one another. Once you
+apply one of these page styles, \PageStyle{scrheadings} will become accessible
+as \PageStyle{headings}\important{\PageStyle{headings}}%
+\IndexPagestyle{headings} and the page style \PageStyle{plain.scrheadings}
+will become accessible as \PageStyle{plain}\important{\PageStyle{plain}}%
+\IndexPagestyle{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. Direct
+patches to the corresponding classes or packages are not necessary. This pair
+of page styles can thus serve as a drop-in replacement for
+\PageStyle{headings} and \PageStyle{plain}. If you need more such pairs,
+please refer to \autoref{sec:scrlayer-scrpage-experts.pagestyle.pairs} in
+\autoref{part:forExperts}.%
\EndIndexGroup
\begin{Declaration}
- \Macro{lehead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cehead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{rehead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{lohead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cohead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{rohead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}
+ \Macro{lehead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cehead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{rehead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{lohead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cohead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{rohead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}
\end{Declaration}
-The contents of the header of page style \PageStyle{plain.scrheadings} and
-\PageStyle{scrheadings} can be defined using these commands. Thereby the
-optional argument defines the content of an element of page style
-\PageStyle{plain.scrheadings}, while the mandatory argument sets the content
-of the corresponding element of page style \PageStyle{scrheadings}.
-
-Contents of left\,---\,so called even\,---\,pages can be set with
-\Macro{lehead}, \Macro{cehead}, and \Macro{rohead}. Remark: The ``\texttt{e}''
-at the second position of the commands' names means ``\emph{even}''.
-
-Contents of right\,---\,so called odd\,---\,pages can be set with
-\Macro{lohead}, \Macro{cohead}, and \Macro{rohead}. Remark: The ``\texttt{o}''
-at the second position of the commands' names means ``\emph{odd}''.
-
-Please note\textnote{Attention!} that there are only odd pages within single
-side layouts independent of whether or not they have an odd page number.
-
-Each header consists of a left aligned element that will be defined by
-\Macro{lehead} respectively \Macro{lohead}. Remark: The ``\texttt{l}'' at the
-first position of the commands' names means ``\emph{left aligned}''.
-
-Similarly each header has a centred element that will be defined by
-\Macro{cehead} respectively \Macro{cohead}. Remark: The ``\texttt{c}'' at the
-first position of the command' names means ``\emph{centred}''.
-
-Similarly each header has a right aligned element that will be defined by
-\Macro{rehead} respectively \Macro{rohead}. Remark: The ``\texttt{r}'' at the
-first position of the commands' names means ``\emph{right aligned}''.
+You can set the contents of the header for the
+\DescRef{\LabelBase.pagestyle.plain.scrheadings} and
+\DescRef{\LabelBase.pagestyle.scrheadings} page styles with these commands.
+The optional argument sets the content of an element of the
+\DescRef{\LabelBase.pagestyle.plain.scrheadings} page style, while the
+mandatory argument sets the content of the corresponding element of the
+\DescRef{\LabelBase.pagestyle.scrheadings} page style.
+
+The contents of even\,---\,or left-hand\,---\,pages\textnote{left-hand pages}
+can be set with \Macro{lehead}, \Macro{cehead}, and \Macro{rehead}. The
+``\texttt{e}'' appearing as the second letter of the commands' names stands
+for ``\emph{even}''.
+
+The contents of odd\,---\,or right-hand\,---\,pages\textnote{right-hand pages}
+can be set with \Macro{lohead}, \Macro{cohead}, and \Macro{rohead}. The
+``\texttt{o}'' appearing as the second letter of the commands' names stands
+for ``\emph{odd}''.
+
+Note\textnote{Attention!} that in one-sided printing, only right-hand pages
+exist, and \LaTeX{} designates these as odd pages regardless of their page
+number.
+
+Each header consists of a left-aligned\textnote{left aligned} element that can
+be set with \Macro{lehead} or \Macro{lohead}. The ``\texttt{l}'' appearing as
+the first letter of the commands' names stands for ``\emph{left aligned}''.
+
+Similarly, each header has a centred\textnote{centred} element that can be set
+with \Macro{cehead} or \Macro{cohead}. The ``\texttt{c}'' appearing as the
+first letter of the command' names stands for ``\emph{centred}''.
+
+Likewise, each header has a right-aligned\textnote{right aligned} element that
+can be set with \Macro{rehead} or \Macro{rohead}. The ``\texttt{r}'' appearing
+as the first letter of the commands' names stands for ``\emph{right
+aligned}''.
+\BeginIndexGroup
\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 \DescRef{\LabelBase.cmd.setkomafont} and
+These elements do not have individual font attributes that you can
+change using the 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
+\DescPageRef{maincls.cmd.setkomafont}). Instead, they use an element named
+\FontElement{pagehead}. Before this element is applied, the
+\FontElement{pageheadfoot} element will also be applied. See
+\autoref{tab:scrlayer-scrpage.fontelements} for the defaults of these
elements.%
-\EndIndex{FontElement}{pageheadfoot}%
-\EndIndex{FontElement}{pagehead}%
+\EndIndexGroup
-The semantics of the described commands within two-sided layouts are also
-sketched in \autoref{fig:scrlayer-scrpage.head}.%
+The meaning of each command for headers in two-sided printing is illustrated
+in \autoref{fig:scrlayer-scrpage.head}.%
%
\begin{figure}[tp]
\centering
@@ -242,7 +265,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\multiput(0,0)(0,-1mm){10}{\line(0,-1){.5mm}}%
\put(.49\textwidth,5mm){\line(0,1){15mm}}%
\put(.05\textwidth,10mm){%
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(-.5em,0){\line(1,0){4em}}%
\multiput(3.5em,0)(.25em,0){5}{\line(1,0){.125em}}%
\put(-.5em,0){\line(0,1){\baselineskip}}%
@@ -251,7 +274,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\makebox(4em,5mm)[l]{\Macro{lehead}}%
}%
\put(.465\textwidth,10mm){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(-4em,0){\line(1,0){4em}}%
\multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
\put(0,0){\line(0,1){\baselineskip}}%
@@ -260,7 +283,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{rehead}}}%
}%
\put(.2525\textwidth,10mm){%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(-2em,0){\line(1,0){4em}}%
\multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
\multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
@@ -275,7 +298,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\put(\textwidth,0){\line(0,1){20mm}}%
\multiput(\textwidth,0)(0,-1mm){10}{\line(0,-1){.5mm}}%
\put(.5325\textwidth,10mm){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(0,0){\line(1,0){4em}}%
\multiput(4em,0)(.25em,0){5}{\line(1,0){.125em}}%
\put(0,0){\line(0,1){\baselineskip}}%
@@ -284,7 +307,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\put(.5em,0){\makebox(4em,5mm)[l]{\Macro{lohead}}}%
}%
\put(.965\textwidth,10mm){%
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(-4em,0){\line(1,0){4em}}%
\multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
\put(0,0){\line(0,1){\baselineskip}}%
@@ -293,7 +316,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{rohead}}}%
}%
\put(.75\textwidth,10mm){%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(-2em,0){\line(1,0){4em}}%
\multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
\multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
@@ -303,53 +326,53 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\put(-2em,0){\makebox(4em,5mm)[c]{\Macro{cohead}}}%
}%
% commands for both pages
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(.5\textwidth,0){\makebox(0,\baselineskip)[c]{\Macro{ihead}}}%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(.5\textwidth,-5mm){\makebox(0,\baselineskip)[c]{\Macro{chead}}}
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(.5\textwidth,-10mm){\makebox(0,\baselineskip)[c]{\Macro{ohead}}}
\put(\dimexpr.5\textwidth-2em,.5\baselineskip){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(0,0){\line(-1,0){1.5em}}%
\put(-1.5em,0){\vector(0,1){5mm}}%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(0,-1.25\baselineskip){\line(-1,0){\dimexpr .25\textwidth-2em\relax}}%
\put(-\dimexpr
.25\textwidth-2em\relax,-1.25\baselineskip){\vector(0,1){\dimexpr
5mm+1.25\baselineskip\relax}}
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(0,-2.5\baselineskip){\line(-1,0){\dimexpr .45\textwidth-4em\relax}}%
\put(-\dimexpr
.45\textwidth-4em\relax,-2.5\baselineskip){\vector(0,1){\dimexpr
5mm+2.5\baselineskip\relax}}
}%
\put(\dimexpr.5\textwidth+2em,.5\baselineskip){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(0,0){\line(1,0){1.5em}}%
\put(1.5em,0){\vector(0,1){5mm}}%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(0,-1.25\baselineskip){\line(1,0){\dimexpr .25\textwidth-2em\relax}}
\put(\dimexpr
.25\textwidth-2em\relax,-1.25\baselineskip){\vector(0,1){\dimexpr
5mm+1.25\baselineskip\relax}}
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(0,-2.5\baselineskip){\line(1,0){\dimexpr .45\textwidth-4em\relax}}
\put(\dimexpr
.45\textwidth-4em\relax,-2.5\baselineskip){\vector(0,1){\dimexpr
5mm+2.5\baselineskip\relax}}
}%
\end{picture}
- \caption[Commands to define the page head]%
- {The meaning of the commands to define the contents of the page head
- of the page styles sketched on a schematic double page}
+ \caption[Commands for setting the page header]%
+ {The meaning of the commands for setting the contents of page headers
+ shown on a two-page schematic}
\label{fig:scrlayer-scrpage.head}
\end{figure}
%
\begin{Example}
- Assume you're writing a short article and you want the title of that
- article to be shown left aligned and the author's name to be
- shown right aligned at the page head. You may for example use:
+ Suppose you're writing a short article and you want the author's name to
+ appear on the left side of the page and the article's title to appear
+ right. You can write, for example:
\begin{lstcode}
\documentclass{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -362,29 +385,30 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\maketitle
\end{document}
\end{lstcode}
- But what happens: On the first page there's only a page number at the page
- foot, but the header is empty!
+ But what happens? On the first page there's only a page number in the
+ footer, while the header remains 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
+ The explanation is simple: The \Class{scrartcl} class, like the default
+ \Class{article} class, switches to the \PageStyle{plain} page style for the
+ page which contains the title. After the 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.
-
- 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
+ our example, this actually refers to the
+ \DescRef{\LabelBase.pagestyle.plain.scrheadings} page style. The default for
+ this page style when using a \KOMAScript{} class is an empty page header and
+ a page number in the footer. In the example, the optional arguments of
+ \Macro{lohead} and \Macro{rohead} are omitted, so the
+ \DescRef{\LabelBase.pagestyle.plain.scrheadings} page style remains
+ unchanged and the result for the first page is actually correct.
+
+ Now add enough text to the example after \DescRef{maincls.cmd.maketitle}
+ so that a second page is printed. You can simply add
+ \Macro{usepackage}\PParameter{lipsum}\IndexPackage{lipsum} to the document
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.
+ \DescRef{maincls.cmd.maketitle}. You will see that the header of the second
+ page now contains the author and the document title as we wanted.
- To see the difference you should also add an optional argument to
- \Macro{lohead} and \Macro{rohead} containing some content. To do so, change
- the example above:
+ For comparison, you should also add the optional argument to
+ \Macro{lohead} and \Macro{rohead}. Change the example as follows:
\begin{lstcode}
\documentclass{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -399,48 +423,56 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
\maketitle
\end{document}
\end{lstcode}
- Now, you also get a page header above the title head of the first
- page. That is because you have reconfigured page style
- \PageStyle{plain.scrheadings} with the two optional arguments. Most of you
- will also recognise that it would be better to leave this page style
- unchanged, because the running head above the document title is certainly
+ Now you have a header on the first page just above the title itself.
+ That is because you have reconfigured page style
+ \DescRef{\LabelBase.pagestyle.plain.scrheadings} with the two optional
+ arguments. As you probably appreciate, it would be better to leave this page
+ style unchanged, as a running head above the document title is rather
annoying.
+
+ By the way, as an alternative to configuring
+ \DescRef{\LabelBase.pagestyle.plain.scrheadings} you could, if you were
+ using a \KOMAScript{} class, have changed the page style for pages that
+ contain title headers. See \DescRef{maincls.cmd.titlepagestyle}%
+ \important{\DescRef{maincls.cmd.titlepagestyle}}%
+ \IndexCmd{titlepagestyle} in \autoref{sec:maincls.pagestyle},
+ \DescPageRef{maincls.cmd.titlepagestyle}.
\end{Example}
-Allow me an important note:\textnote{Attention!} You should never put a
-section heading or section number directly into the page head using a new
-declaration by one of these commands. This could result in a wrong number or
-heading text in the running head, because of the asynchronous page generation
-and output of \TeX. Instead you should use the mark mechanism and ideally you
-should use it together with the automatism described in the following
-section.%
+Note\textnote{Attention!} that you should never put a section
+heading or section number directly into the header using one of these
+commands. Because of the asynchronous way that \TeX{} lays out and outputs
+pages, doing so can easily result in the wrong number or heading text in the
+running head. Instead you should use the mark mechanism, ideally in
+conjunction with the procedures explained in the next section.%
\EndIndexGroup
\begin{Declaration}
- \Macro{lehead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cehead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{rehead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{lohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{rohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}
+ \Macro{lehead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cehead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{rehead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{lohead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cohead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{rohead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}
\end{Declaration}
-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
-the obligatory argument \PName{scrheading's content} also as default for
-\PageStyle{plain.scrheadings}. So, if both arguments should be the same, you
-can simply use the star version with the obligatory argument only.%
+The starred versions\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} of the
+previously described commands differ from the ordinary versions only if you
+omit the optional argument \PName{plain.scrheadings content}. In this case,
+the version without the star does not change the contents of
+\DescRef{\LabelBase.pagestyle.plain.scrheadings}. The starred version, on the
+other hand, uses the mandatory argument \PName{scrheading content}
+for \DescRef{\LabelBase.pagestyle.plain.scrheadings} as well. So if both
+arguments should be the same, you can simply use the starred version with only
+the mandatory argument.%
\begin{Example}
- You can shorten the previous example using the star version of
+ You can shorten the previous example using the starred versions of
\DescRef{\LabelBase.cmd.lohead} and \DescRef{\LabelBase.cmd.rohead}:
\begin{lstcode}
\documentclass{scrartcl}
@@ -453,73 +485,76 @@ can simply use the star version with the obligatory argument only.%
\author{John Doe}
\maketitle
\end{document}
-\end{lstcode}
-\end{Example}
-
-The obsolete package \Package{scrpage2}\important{\Package{scrpage2}} does not
-provide this feature.%
-%
+\end{lstcode}%
+\end{Example}%
\EndIndexGroup
\begin{Declaration}
- \Macro{lefoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cefoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{refoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{lofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{rofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}
+ \Macro{lefoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cefoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{refoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{lofoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cofoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{rofoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}
\end{Declaration}
-The contents of the footer of page style \PageStyle{plain.scrheadings} and
-\PageStyle{scrheadings} can be defined using these commands. Thereby the
-optional argument defines the content of an element of page style
-\PageStyle{plain.scrheadings}, while the mandatory argument sets the content
-of the corresponding element of page style \PageStyle{scrheadings}.
-
-Contents of left\,---\,so called even\,---\,pages can be set with
-\Macro{lefoot}, \Macro{cefoot}, and \Macro{rohead}. Remark: The ``\texttt{e}''
-at the second position of the commands' names means ``\emph{even}''.
-
-Contents of odd pages can be set with \Macro{lofoot}, \Macro{cofoot}, and
-\Macro{rofoot}. Remark: The ``\texttt{o}'' at the second position of the
-commands' names means ``\emph{odd}''.
-
-Please note\textnote{Attention!} that there are only odd pages within single
-side layouts independent of whether or not they have an odd page number.
-
-Each footer consists of a left aligned element that will be defined by
-\Macro{lefoot} respectively \Macro{lofoot}. Remark: The ``\texttt{l}'' at the
-first position of the commands' names means ``\emph{left aligned}''.
-
-Similarly each footer has a centred element that will be defined by
-\Macro{cefoot} respectively \Macro{cofoot}. Remark: The ``\texttt{c}'' at the
-first position of the command' names means ``\emph{centred}''.
-
-Similarly each footer has a right aligned element that will be defined by
-\Macro{refoot} respectively \Macro{rofoot}. Remark: The ``\texttt{r}'' at the
-first position of the commands' names means ``\emph{right aligned}''.
+You can define the contents of the footer for
+\DescRef{\LabelBase.pagestyle.scrheadings} and
+\DescRef{\LabelBase.pagestyle.plain.scrheadings} with these commands. The
+optional argument defines the content of an element of
+\DescRef{\LabelBase.pagestyle.plain.scrheadings}, while the mandatory argument
+sets the content of the corresponding element of
+\DescRef{\LabelBase.pagestyle.scrheadings}.
+
+The contents of even\,---\,or left-hand\,---\,pages\textnote{left-hand page}
+are set with \Macro{lefoot}, \Macro{cefoot}, and \Macro{refoot}. The
+``\texttt{e}'' appearing as the second letter of the commands' names stands
+for ``\emph{even}''.
+
+The contents of odd\,---\,or right-hand\,---\,pages\textnote{right-hand page}
+are set with \Macro{lofoot}, \Macro{cofoot}, and \Macro{rofoot}. The
+``\texttt{o}'' appearing as the second letter of the commands' names stands
+for ``\emph{odd}''.
+
+Note\textnote{Attention!} that in one-sided printing, only right-hand pages
+exist, and \LaTeX{} designates these as odd pages regardless of their page
+number.
+
+Each footer consists of a left-aligned\textnote{left aligned} element that can
+be set with \Macro{lefoot} or \Macro{lofoot}. The ``\texttt{l}'' appearing as
+the first letter of the commands' names stands for ``\emph{left aligned}''.
+
+Similarly, each footer has a centred\textnote{centred} element that can be set
+with \Macro{cefoot} or \Macro{cofoot}. The ``\texttt{c}'' in the first letter
+of the command' names stands for ``\emph{centred}''.
+
+Likewise, each footer has a right-aligned\textnote{right aligned} element that
+can be set with \Macro{refoot} or \Macro{rofoot}. The ``\texttt{r}'' in the
+first letter of the commands' names stands for ``\emph{right aligned}''.
+\BeginIndexGroup
\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 \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}%
-\EndIndex{FontElement}{pagefoot}%
-
-The semantics of the described commands within two-sided layouts are also
-sketched in \autoref{fig:scrlayer-scrpage.foot}.%
+However, these elements do not have individual font attributes that can be
+changed with the \DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} commands (see
+\autoref{sec:maincls.textmarkup}, \DescPageRef{maincls.cmd.setkomafont}).
+Instead, they use an element named
+\FontElement{pagefoot}\important{\FontElement{pagefoot}}. Before this element
+is applied, the font element
+\FontElement{pageheadfoot}\important{\FontElement{pageheadfoot}} is also
+applied. See \autoref{tab:scrlayer-scrpage.fontelements} for the defaults of
+the fonts of these elements.%
+\EndIndexGroup
+
+The meaning of each command for footers in two-sided printing is illustrated
+in \autoref{fig:scrlayer-scrpage.foot}.%
%
\begin{figure}[bp]
\centering
@@ -532,7 +567,7 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\multiput(0,20mm)(0,1mm){10}{\line(0,1){.5mm}}%
\put(.49\textwidth,0){\line(0,1){15mm}}%
\put(.05\textwidth,5mm){%
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(-.5em,0){\line(1,0){4em}}%
\multiput(3.5em,0)(.25em,0){5}{\line(1,0){.125em}}%
\put(-.5em,0){\line(0,1){\baselineskip}}%
@@ -541,7 +576,7 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\makebox(4em,5mm)[l]{\Macro{lefoot}}%
}%
\put(.465\textwidth,5mm){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(-4em,0){\line(1,0){4em}}%
\multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
\put(0,0){\line(0,1){\baselineskip}}%
@@ -550,7 +585,7 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{refoot}}}%
}%
\put(.2525\textwidth,5mm){%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(-2em,0){\line(1,0){4em}}%
\multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
\multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
@@ -565,7 +600,7 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\put(\textwidth,0){\line(0,1){20mm}}%
\multiput(\textwidth,20mm)(0,1mm){10}{\line(0,1){.5mm}}%
\put(.5325\textwidth,5mm){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(0,0){\line(1,0){4em}}%
\multiput(4em,0)(.25em,0){5}{\line(1,0){.125em}}%
\put(0,0){\line(0,1){\baselineskip}}%
@@ -574,7 +609,7 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\put(.5em,0){\makebox(4em,5mm)[l]{\Macro{lofoot}}}%
}%
\put(.965\textwidth,5mm){%
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(-4em,0){\line(1,0){4em}}%
\multiput(-4em,0)(-.25em,0){5}{\line(1,0){.125em}}%
\put(0,0){\line(0,1){\baselineskip}}%
@@ -583,7 +618,7 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\put(-4.5em,0){\makebox(4em,5mm)[r]{\Macro{rofoot}}}%
}%
\put(.75\textwidth,5mm){%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(-2em,0){\line(1,0){4em}}%
\multiput(2em,0)(.25em,0){5}{\line(1,0){.125em}}%
\multiput(-2em,0)(-.25em,0){5}{\line(1,0){.125em}}%
@@ -593,45 +628,45 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\put(-2em,0){\makebox(4em,5mm)[c]{\Macro{cofoot}}}%
}%
% both pages
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(.5\textwidth,15mm){\makebox(0,\baselineskip)[c]{\Macro{ifoot}}}%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(.5\textwidth,20mm){\makebox(0,\baselineskip)[c]{\Macro{cfoot}}}
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(.5\textwidth,25mm){\makebox(0,\baselineskip)[c]{\Macro{ofoot}}}
\put(\dimexpr.5\textwidth-2em,.5\baselineskip){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(0,15mm){\line(-1,0){1.5em}}%
\put(-1.5em,15mm){\vector(0,-1){5mm}}%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(0,20mm){\line(-1,0){\dimexpr .25\textwidth-2em\relax}}%
\put(-\dimexpr .25\textwidth-2em\relax,20mm){\vector(0,-1){10mm}}%
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(0,25mm){\line(-1,0){\dimexpr .45\textwidth-4em\relax}}%
\put(-\dimexpr .45\textwidth-4em\relax,25mm){\vector(0,-1){15mm}}%
}%
\put(\dimexpr.5\textwidth+2em,.5\baselineskip){%
- \iffree{\color{blue}}{}%
+ \color{ImageBlue}%
\put(0,15mm){\line(1,0){1.5em}}%
\put(1.5em,15mm){\vector(0,-1){5mm}}%
- \iffree{\color{green}}{}%
+ \color{ImageGreen}%
\put(0,20mm){\line(1,0){\dimexpr .25\textwidth-2em\relax}}%
\put(\dimexpr .25\textwidth-2em\relax,20mm){\vector(0,-1){10mm}}%
- \iffree{\color{red}}{}%
+ \color{ImageRed}%
\put(0,25mm){\line(1,0){\dimexpr .45\textwidth-4em\relax}}%
\put(\dimexpr .45\textwidth-4em\relax,25mm){\vector(0,-1){15mm}}%
}%
\end{picture}
- \caption[Commands to define the page footer]%
- {The meaning of the commands to define the contents of the page
- footer of the page styles sketched on a schematic double page}%
+ \caption[Commands for setting the page footer]%
+ {The meaning of the commands for setting the contents of page
+ footers shown on a two-page schematic}%
\label{fig:scrlayer-scrpage.foot}
\end{figure}
%
\begin{Example}
- Let's return to the example of the short article. Assuming you want to print
- the publisher at the left side of the page footer, you would change the
- example above into:
+ Let's return to the example of the short article. Let's say you want to
+ specify the publisher in the left side of the footer. You would change the
+ example above to:
\begin{lstcode}
\documentclass{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -647,49 +682,51 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\lipsum
\end{document}
\end{lstcode}
- Once again the publisher is not printed on the first page with the title
- head. For the reason see the explanation about \Macro{lohead} in the example
- above. And again the solution to print the publisher on the first page would
- be similar:
+ Once again the publisher is not printed on the first page with the title.
+ The reason is the same as in the example with
+ \DescRef{\LabelBase.cmd.lohead} above. And the solution for getting the
+ publisher on the first page is similar:
\begin{lstcode}
\lofoot[Smart Alec Publishing]
{Smart Alec Publishing}
\end{lstcode}
- But now you also want to replace the slanted font used in page head and
- footer by a upright smaller font. This may be done using:
+ Now you decide\textnote{font change}\important{\FontElement{pageheadfoot}}%
+ \IndexFontElement{pageheadfoot} that the header and footer should use an
+ upright but smaller font in place of the default slanted font:
\begin{lstcode}
\setkomafont{pageheadfoot}{\small}
\end{lstcode}
- Furthermore, the head but not the footer should be bold:
+ In addition, the header, but not the footer, should be bold:
\begin{lstcode}
\setkomafont{pagehead}{\bfseries}
\end{lstcode}
- For the last command it is important to have it just after
- \Package{scrpage-scrlayer} has been loaded, because the \KOMAScript{} class
- already defines \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{}
- class.
-
- Simultaneously the author, document title and publisher will vanish from
- page~2. It only appears on page~3. This is a consequence of using only
- commands for odd pages. You can recognise this by the ``\texttt{o}'' on the
- second position of the commands' names.
-
- Now, we could simply copy those commands and replace the ``\texttt{o}'' by
+ It is important\textnote{Attention!} that this command does not occur until
+ after \Package{scrpage-scrlayer} has been loaded because the \KOMAScript{}
+ class defines \DescRef{\LabelBase.fontelement.pagehead} as an alias for
+ \DescRef{\LabelBase.fontelement.pageheadfoot}. Only by loading
+ \Package{scrpage-scrlayer} will \DescRef{\LabelBase.fontelement.pagehead}
+ become an element independent of
+ \DescRef{\LabelBase.fontelement.pageheadfoot}.
+
+ Now add one more \Macro{lipsum} and the
+ \Option{twoside}\IndexOption{twoside}\important{\Option{twoside}} option
+ when loading \Class{scrartcl}. First of all, you will see the page number
+ moves from the centre to the outer margin of the page footer, due to the
+ changed defaults of \DescRef{\LabelBase.pagestyle.scrheadings} and
+ \DescRef{\LabelBase.pagestyle.plain.scrheadings} for two-sided printing with
+ a \KOMAScript{} class.
+
+ Simultaneously, the author, document title, and publisher will vanish from
+ page~2. They only appear on page~3. That's because we've only used
+ commands for odd pages. You can recognise this by the ``\texttt{o}'' in the
+ second position of the command names.
+
+ Now, we could simply copy those commands and replace the ``\texttt{o}'' with
an ``\texttt{e}'' to define the contents of \emph{even} pages. But with
- double sided layout it makes more sense to use mirror-inverted elements. So
- the left element of an odd page should become the right element of the even
- page and visa versa. To achieve this, we also replace the first letter
- ``\texttt{l}'' by ``\texttt{r}'':
+ two-sided printing, it makes more sense to use mirror-inverted elements,
+ i.\,e. the left element of an even page should become the right element of
+ the odd page and visa versa. To achieve this, we also replace the first
+ letter ``\texttt{l}'' with ``\texttt{r}'':
\begin{lstcode}
\documentclass[twoside]{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -712,45 +749,45 @@ sketched in \autoref{fig:scrlayer-scrpage.foot}.%
\end{lstcode}
\end{Example}
%
-After reading the example it may appear to you that it is somehow
-uncomfortable to duplicate commands to have the same contents on mirror
-positions of the page header or footer of a double page. Therefore you will
-learn to know an easier solution for this standard case next.
-
-Before allow me an important note:\textnote{Attention!} You should never put a
-section heading or section number directly into the page's footer using a new
-declaration by one of these commands. This could result in a wrong number or
-heading text in the running footer, because of the asynchronous page
-generation and output of \TeX. Instead you should use the mark mechanism
-ideally together with the automatism described in the following section.%
+Since it is a bit cumbersome to define left and right pages separately in
+cases such as the previous example, a simpler solution for this common case is
+introduced below.
+
+Allow me once again an important note:\textnote{Attention!} you should
+never put a section heading or section number directly into the footer using
+one of these commands. Because of the asynchronous way that \TeX{} lays out and
+outputs pages, doing so can easily result in the wrong number or heading text
+in the running head. Instead you should use the mark mechanism, ideally in
+conjunction with the procedures explained in the next section.%
\EndIndexGroup
\begin{Declaration}
- \Macro{lefoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cefoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{refoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{lofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{rofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}
+ \Macro{lefoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cefoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{refoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{lofoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cofoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{rofoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}
\end{Declaration}
-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
-the obligatory argument \PName{scrheading's content} also as default for
-\PageStyle{plain.scrheadings}. So, if both arguments should be the same, you
-can simply use the star version with the obligatory argument only.
+The starred versions\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} of the
+previously described commands differ only if you omit the optional argument
+\OParameter{plain.scrheadings content}. In this case, the version without the
+star does not change the contents of
+\DescRef{\LabelBase.pagestyle.plain.scrheadings}. The starred version, on the
+other hand, uses the mandatory argument \PName{scrheading content} for
+\DescRef{\LabelBase.pagestyle.plain.scrheadings} as well. So if both arguments
+should be the same, you can simply use the starred version with just the
+mandatory argument.%
\begin{Example}
- You can shorten the previous example using the star version of
+ You can shorten the previous example using the star versions of
\DescRef{\LabelBase.cmd.lofoot} and \DescRef{\LabelBase.cmd.refoot}:
\begin{lstcode}
\documentclass[twoside]{scrartcl}
@@ -771,50 +808,46 @@ can simply use the star version with the obligatory argument only.
\end{document}
\end{lstcode}
\end{Example}
-
-The obsolete package \Package{scrpage2}\important{\Package{scrpage2}} does not
-provide this feature.%
%
\EndIndexGroup
\begin{Declaration}
- \Macro{ohead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{chead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{ihead}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{ofoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cfoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{ifoot}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}
+ \Macro{ohead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{chead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{ihead}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{ofoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cfoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{ifoot}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}
\end{Declaration}
-To define the contents of page headers and footers of odd and the even pages
-of a double-sided layout using the commands described before, you would have to
-define the contents of the even page different from the contents of the odd
-page. But in general the pages should be symmetric. An element, that should be
-printed left aligned on an even page, should be right aligned on an odd page
-and vise versa. Elements, that are centred on odd pages, should be centred on
-even pages too.
+To configure the headers and footers for two-sided printing with the
+previously described commands, you would have to configure the left and right
+sides separately from one another. In most cases, however, the left and right
+sides are more or less symmetrical. An item that appears on the left of an
+even page should appear on the right of an odd page and vice versa. Centred
+elements are usually centred on both sides.
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 \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.
+\Package{scrlayer-scrpage} has shortcuts. The \Macro{ohead} command
+corresponds to a call to both \DescRef{\LabelBase.cmd.lehead} and
+\DescRef{\LabelBase.cmd.rohead}. The \Macro{chead} command corresponds to a
+call to both \DescRef{\LabelBase.cmd.cehead} and
+\DescRef{\LabelBase.cmd.cohead}. And the \Macro{ihead} command corresponds to
+a call to both \DescRef{\LabelBase.cmd.rehead} and
+\DescRef{\LabelBase.cmd.lohead}. The same applies to the equivalent commands
+for the page footer. An outline of these relationships can also be found in
+\autoref{fig:scrlayer-scrpage.head} on \autopageref{fig:scrlayer-scrpage.head}
+and \autoref{fig:scrlayer-scrpage.foot} on
+\autopageref{fig:scrlayer-scrpage.foot}.
%
\begin{Example}
- You can simplify the example before using the new commands:
+ You can simplify the previous example using the new commands:
\begin{lstcode}
\documentclass[twoside]{scrartcl}
\usepackage{scrlayer-scrpage}
@@ -831,46 +864,48 @@ together with the relationships of all the page header and footer commands.
\lipsum\lipsum
\end{document}
\end{lstcode}
- As you can see, you can spare half of the commands but get the same result.
-\end{Example}
-%
-In single-sided layouts all pages are odd pages. So in LaTeX's single-sided
-mode these commands are synonymous for the odd page commands. Therefore in
-most cases you will only need these six commands instead of the twelve
-described before.
-
-Once again, allow me an important note:\textnote{Attention!} You should never
-put a section heading or section number directly into the page head or
-page foot using a new declaration by one of these commands. This could result in
-a wrong number or heading text in the running header or footer, because of the
-asynchronous page generation and output of \TeX. Instead you should use the
-mark mechanism ideally together with the automatism described in the following
-section.%
+\iffalse%
+ As you can see, you can use half the number of commands but get the same
+ result. %
+\fi%
+\end{Example}%
+Because one-sided printing treats all pages as odd pages, these commands are
+synonymous with the corresponding right-side commands when in one-sided mode.
+Therefore in most cases you will only need these six commands instead of the
+twelve described before.
+
+Allow me once again an important note:\textnote{Attention!} you should never
+put a section heading or section number directly into the footer using one of
+these commands. Because of the asynchronous way that \TeX{} lays out and
+outputs pages, doing so can easily result in the wrong number or heading text
+in the running head. Instead you should use the mark mechanism, ideally in
+conjunction with the procedures explained in the next section.%
\EndIndexGroup
\begin{Declaration}
- \Macro{ohead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{chead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{ihead*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{ofoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{cfoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}%
- \Macro{ifoot*}\OParameter{plain.scrheadings's content}%
- \Parameter{scrheadings's content}
+ \Macro{ohead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{chead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{ihead*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{ofoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{cfoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}%
+ \Macro{ifoot*}\OParameter{plain.scrheadings content}%
+ \Parameter{scrheadings content}
\end{Declaration}
-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
-the obligatory argument \PName{scrheading's content} also as default for
-\PageStyle{plain.scrheadings}. So, if both arguments should be the same, you
-can simply use the star version with the obligatory argument only.%
+The previously described commands also have starred
+versions\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} that differ only if you
+omit the optional argument \OParameter{plain.scrheadings content}. In this
+case, the version without a star does not change the content of
+\DescRef{\LabelBase.pagestyle.plain.scrheadings}. The version with the star,
+on the other hand, also uses the mandatory argument \PName{scrheadings
+content} for \DescRef{\LabelBase.pagestyle.plain.scrheadings}. So if both
+arguments should be the same, you can simply use the starred version with only
+the mandatory argument.%
\begin{Example}
You can shorten the previous example using the star version of
@@ -889,157 +924,168 @@ can simply use the star version with the obligatory argument only.%
\maketitle
\lipsum\lipsum
\end{document}
-\end{lstcode}
-\end{Example}
-
-The obsolete package \Package{scrpage2}\important{\Package{scrpage2}} does not
-provide this feature.%
-%
+\end{lstcode}%
+\end{Example}%
\EndIndexGroup
\begin{Declaration}
\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
-\Package{scrlayer-scrpage} provides two different defaults yet. You may select
-one of those defaults manually using option \Option{pagestyleset}.
-
-If \PName{setting} is \PValue{KOMA-Script} the defaults will be used that
-would also be activated automatically if a \KOMAScript{} class has been
-detected. In this case and within double-sided layout \PageStyle{scrheadings}
-uses running heads outer aligned in the page head. The page number will be
-printed outer aligned in the page footer. Within single-sided layout the
-running head will be printed in the middle of the page head and the page
-number in the middle of the page footer. Upper and lower case will be used for
-the automatic running head as given by the words you have typed. This would be
-same like using Option
-\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
-running heads aligned inner in the page head and the page numbers will be
-printed\,---\,also in the page head\,---\,aligned outer. Within single-sided
-layout \PageStyle{scrheadings} is the same. But because of single side layout
-knows only odd pages, the running head will be aligned left always and the
-page number will be aligned right. In spite of typographic objection, the
-automatic running head will be converted into upper cases like they would
-using
-\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.
-
-Please note\textnote{Attention!} that together with this option page style
-\PageStyle{scrheadings} will be activated. This will be also the case, if you
-use the option inside the document.
-
-\BeginIndex{Option}{komastyle}%
-\BeginIndex{Option}{standardstyle}%
-Options \Option{komastyle} and \Option{standardstyle}, provided by
-\Package{scrpage}, are defined only for compatibility reasons in
-\Package{scrlayer-scrpage}. But they are implemented using option
-\Option{pagestyleset}. They are deprecated and you should not use them.%
+The examples above refer several times to the default settings of the page
+styles \DescRef{\LabelBase.pagestyle.scrheadings}\IndexPagestyle{scrheadings}
+and \DescRef{\LabelBase.pagestyle.plain.scrheadings}%
+\IndexPagestyle{plain.scrheadings}. In fact, \Package{scrlayer-scrpage}
+currently provides two different defaults for these page styles. You can
+select them manually with the \Option{pagestyleset} option.
+
+The
+\PValue{KOMA-Script}\important{\OptionValue{pagestyleset}{KOMA-Script}}
+\PName{setting} selects the defaults, which are also set automatically if the
+option is not specified and a \KOMAScript{} class is detected. In two-sided
+printing, \DescRef{\LabelBase.pagestyle.scrheadings} uses outer-aligned
+running heads in the header and outer-aligned page numbers in the footer.
+In one-sided printing, the running head will be printed in the
+middle of the header and the page number in the middle of the footer. Upper-
+and lower-case letters are used in the automatic running heads as they
+actually appear in the sectioning headings. This corresponds to the
+\OptionValueRef{\LabelBase}{markcase}{used}\IndexOption{markcase~=used}%
+\important{\OptionValueRef{\LabelBase}{markcase}{used}} option. The
+\DescRef{\LabelBase.pagestyle.plain.scrheadings} page style has no running
+heads, but the page numbers are printed in the same manner.
+
+However, if the \hyperref[cha:scrlttr2]{\Class{scrlttr2}}%
+\important{\hyperref[cha:scrlttr2]{\Class{scrlttr2}}}%
+\IndexClass{scrlttr2} class is detected, the default settings are based on the
+page styles of that class. See \autoref{sec:scrlttr2.pagestyle},
+\autopageref{sec:scrlttr2.pagestyle}.
+
+The
+\PValue{standard}\important{\OptionValue{pagestyleset}{standard}}
+\PName{setting} selects defaults that match the page styles of the standard
+classes. This is also activated automatically if the option has not been
+specified and no \KOMAScript{} class is detected. In this case, for two-sided
+printing \DescRef{\LabelBase.pagestyle.scrheadings} uses running heads
+inner-aligned in the header, and the page numbers will be printed\,---\,also
+in the header\,---\,outer-aligned. One-sided printing uses the same settings,
+but since only right-hand pages exist in this mode, the running head will
+always be left-aligned and the page number right-aligned. The automatic
+running heads\,---\,despite considerable typographic objections\,---\,are
+converted to capital letters, as they would be with
+\OptionValueRef{\LabelBase}{markcase}{upper}\IndexOption{markcase~=upper}%
+\important{\OptionValueRef{\LabelBase}{markcase}{upper}}. In one-sided
+printing, the \DescRef{\LabelBase.pagestyle.plain.scrheadings} page style
+differs considerably from \DescRef{\LabelBase.pagestyle.scrheadings} because
+the page number is printed in the middle of the footer.
+Unlike\textnote{\KOMAScript{} vs. standard classes} the \PageStyle{plain} page
+style in the standard classes,
+\DescRef{\LabelBase.pagestyle.plain.scrheadings} omits the page number in
+two-sided printing. The standard classes print the page number in the middle
+of the footer, which does not match the rest of the page styles in two-sided
+printing.
+\iffalse % Umbruchkorrekturtext
+ If you want the page number back
+\begin{lstcode}
+ \cfoot[\pagemark]{}
+\end{lstcode}
+ will restore it. %
+\fi%
+The running head is omitted in \DescRef{\LabelBase.pagestyle.plain.scrheadings}.
+
+Note\textnote{Attention!} that using this option activates the
+\DescRef{\LabelBase.pagestyle.scrheadings}\IndexPagestyle{scrheadings}%
+\important{\DescRef{\LabelBase.pagestyle.scrheadings}} page style.
+\iffalse% Umbruchkorrektur
+ This also applies if you use the option within the document.%
+\fi
%
\EndIndexGroup
-\LoadCommonFile{pagestylemanipulation} % \section{Manipulation of Defined Page Styles}
+\LoadCommonFile{pagestylemanipulation} % \section{Manipulating Defined Page Styles}
\begin{Declaration}
\OptionVName{headwidth}{width\textup{:}offset\textup{:}offset}%
\OptionVName{footwidth}{width\textup{:}offset\textup{:}offset}
\end{Declaration}
-By default the page head\Index{head>width} and foot\Index{foot>width} are as
-wide as the type area. This can be changed using these \KOMAScript{}
-options. The value \PName{width} is the wanted width of the head respective
-foot. The \PName{offset} defines how much the head or foot should be moved
-towards the outer\,---\,in single side layout to the right\,---\,margin. All
-three\ChangedAt{v3.14}{\Package{scrlayer-scrpage}} values are optional and can
-be omitted. If you omit a value, you can also omit the corresponding colon
-left beside. If there is only one \PName{offset} it is used for both, odd and
-even pages. Otherwise, the first \PName{offset} is used for odd and the second
-\PName{offset} for even pages in two-side mode. If you only use one value
-without colon, this will be the \PName{width}.
-
-For the \PName{width} as well as the \PName{offset} you can use any valid
-length value, \LaTeX{} length, \TeX{} dimension or \TeX{} skip. In addition
-you may use an \eTeX{} dimension expression with basic arithmetic operations
-\texttt{+}, \texttt{-}, \texttt{*}, \texttt{/}, and parenthesis. See
-\cite[section~3.5]{manual:eTeX} for more information on such expressions. See
-\autoref{sec:scrlayer-scrpage.options} for more information on using,
-e.\,g., a \LaTeX{} length as an option value. The \PName{width} can
-alternatively be one of the symbolic values shown in
-\autoref{tab:scrlayer-scrpage.symbolic.values}.
-
-By default the head and the foot are as wide as the text area. The default
-\PName{offset} depends on the used \PName{width}. In single side layout
-generally the half of the difference of \PName{width} and the width of the
-text area will be used. This results in horizontal centring the page head
-above or the page footer below the text area. In difference to this, in double
-side layout generally a third of the difference of \PName{offset} and the
-width of the text area will be used. But if \PName{width} is the width of the
-whole text area plus the marginal note column, default \PName{offset} will be
-zero. If you think, this is complicated, you should simply use an explicit
-\PName{offset}.
+By default the header\Index{header>width} and footer\Index{footer>width} are
+as wide as the type area. However, you can change this using these
+\KOMAScript{} options. The value \PName{width} is the desired width of the
+header or footer. The \PName{offset} defines how far the header or footer
+should be moved towards the outer\,---\,in one-sided printing to the
+right\,---\,margin. All three\ChangedAt{v3.14}{\Package{scrlayer-scrpage}}
+values are optional and can be omitted. If you omit a value, you can also omit
+the associated colon to the left of it. If only one \PName{offset} is
+specified, it is used for both odd and even pages. Otherwise, the first
+\PName{offset} is used for odd and the second \PName{offset} for even pages in
+two-sided mode. If you only use one value without a colon, this will be the
+\PName{width}.
+
+For both the \PName{width} and the \PName{offset} you can use any valid length
+value, \LaTeX{} length, \TeX{} dimension, or \TeX{} skip. In addition, you can
+use an \eTeX{} dimension expression with the basic arithmetic operations
+\texttt{+}, \texttt{-}, \texttt{*}, \texttt{/}, and parentheses. See
+\cite[section~3.5]{manual:eTeX} for more information on such expressions. See
+\autoref{sec:scrlayer-scrpage.options} for more information on using a
+\LaTeX{} length as an option value. The \PName{width} can also be one of the
+symbolic values shown in \autoref{tab:scrlayer-scrpage.symbolic.values}.
+
+By default the header and the footer are the width of the text area. The
+default \PName{offset} depends on the selected \PName{width}. One-sided
+printing typically uses half the difference between \PName{width} and the
+width of the text area. This centres the header horizontally above the text
+area. Two-sided printing, on the other hand, uses only a third of the
+difference between \PName{width} and the width of the text area. However, if
+\PName{width} is the width of the whole text area and the marginal note
+column, the default \PName{offset} will be zero. If this is too complicated
+for you, you should simply specify the desired \PName{offset} yourself.
%
\begin{table}
\centering
- \caption[Symbolic values for options \Option{headwidth} and
- \Option{footwidth}]{Possible symbolic values for the \PName{width} value of
- options \Option{headwidth} and \Option{footwidth}}
+ \caption[Symbolic values for the \Option{headwidth} and \Option{footwidth}
+ options]{Available symbolic values for the \PName{width} value of options
+ \Option{headwidth} and \Option{footwidth}}
\label{tab:scrlayer-scrpage.symbolic.values}
\begin{desctabular}
- \ventry{foot}{%
- the current width of the page foot%
+ \entry{\PValue{foot}}{%
+ the current width of the footer%
}%
- \ventry{footbotline}{%
- the current length of the horizontal line below the page foot%
+ \entry{\PValue{footbotline}}{%
+ the current length of the horizontal line below the footer%
}%
- \ventry{footsepline}{%
- the current length of the horizontal line above the page foot%
- } \ventry{head}{%
- the current width of the page head%
+ \entry{\PValue{footsepline}}{%
+ the current length of the horizontal line above the footer%
+ } \entry{\PValue{head}}{%
+ the current width of the header%
}%
- \ventry{headsepline}{%
- the current length of the horizontal line below the page head%
+ \entry{\PValue{headsepline}}{%
+ the current length of the horizontal line below the header%
}%
- \ventry{headtopline}{%
- the current length of the horizontal line above the page head%
+ \entry{\PValue{headtopline}}{%
+ the current length of the horizontal line above the header%
}%
- \ventry{marginpar}{%
- the current width of the marginal note column including the distance
+ \entry{\PValue{marginpar}}{%
+ the width of the marginal note column including the distance
between the text area and the marginal note column%
}%
- \ventry{page}{%
- the current width of the page considering a binding correction of
- package \Package{typearea} (see option \DescRef{typearea.option.BCOR} in
- \autoref{sec:typearea.typearea},
- \DescPageRef{typearea.option.BCOR})%
+ \entry{\PValue{page}}{%
+ the width of the page taking into account any binding correction defined
+ with the help of the \Package{typearea} package (see the
+ \DescRef{typearea.option.BCOR} option in
+ \autoref{sec:typearea.typearea}, \DescPageRef{typearea.option.BCOR})%
}%
- \ventry{paper}{%
- the current width of the paper without considering a binding correction%
+ \entry{\PValue{paper}}{%
+ the width of the paper without considering any binding correction%
}%
- \ventry{text}{%
- the current width of the text area%
+ \entry{\PValue{text}}{%
+ the width of the text area%
}%
- \ventry{textwithmarginpar}{%
- the current width of the text area plus the marginal note column
- including the distance between them (note: in this case and only in this
- case the default of \PName{offset} would be zero)%
+ \entry{\PValue{textwithmarginpar}}{%
+ the width of the text area including the marginal note column and
+ the distance between the two (Note: only in this case is
+ the default for \PName{offset} zero)%
}%
\end{desctabular}
\end{table}
@@ -1053,66 +1099,51 @@ zero. If you think, this is complicated, you should simply use an explicit
\OptionVName{footsepline}{thickness\textup{:}length}%
\OptionVName{footbotline}{thickness\textup{:}length}
\end{Declaration}
-The \KOMAScript{} classes provide only a separation line below the page head
-and above the page head, and you may only switch each of these lines on or
-off. But package \Package{scrlayer-scrpage} provides four such horizontal
-lines: one above the head, one below the head, one above the foot, and one
-below the foot. And you can not only switch them on an off, but also configure
-the \PName{length} and \PName{thickness} of each of these lines.
+\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 one separation line below the header
+and another above the footer, and you can only switch these lines on or off.
+But the \Package{scrlayer-scrpage} package also lets you place lines above the
+header and below the footer. And for all four lines, you can not only switch
+them on an off but also configure their \PName{length} and \PName{thickness}.
Both values are optional. If you omit the \PName{thickness}, a default value
-of 0.4\Unit{pt} will be used, a so called \emph{hairline}. If you omit the
-\PName{length}, the width of the head respective the foot will be used. If you
+of 0.4\Unit{pt} is used, producing a so-called \emph{hairline}. If you omit
+the \PName{length}, the width of the header or footer will be used. If you
omit both, you can also omit the colon. If you use only one value without
-colon, this will be the \PName{thickness}.
-
-For sure, the \PName{length} can be not only shorter than the current width of
-the page head respectively the page foot, but also longer. See additionally
-options \DescRef{\LabelBase.option.ilines}\IndexOption{ilines},
-\DescRef{\LabelBase.option.clines}\IndexOption{clines}, and
+colon, this is the \PName{thickness}.
+
+Of course, the \PName{length} can be not just shorter than the current width
+of the header or footer but also longer. See also the options
+\DescRef{\LabelBase.option.ilines}\IndexOption{ilines}%
+\important{\DescRef{\LabelBase.option.ilines},
+\DescRef{\LabelBase.option.clines}, \DescRef{\LabelBase.option.olines}},
+\DescRef{\LabelBase.option.clines}\IndexOption{clines} and
\DescRef{\LabelBase.option.olines}\IndexOption{olines} later in this section.
+\BeginIndexGroup
\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 \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}%
-\EndIndex{FontElement}{headsepline}%
-\EndIndex{FontElement}{headtopline}%
-
-\BeginIndex{Cmd}{setheadtopline}%
-\BeginIndex{Cmd}{setheadsepline}%
-\BeginIndex{Cmd}{setfootsepline}%
-\BeginIndex{Cmd}{setfootbotline}%
-Package \Package{scrpage2} has additionally to the options that do not take
-any values, also four commands
-\Macro{setheadtopline}\IndexCmd[indexmain]{setheadtopline},
-\Macro{setheadsepline}\IndexCmd[indexmain]{setheadsepline},
-\Macro{setfootsepline}\IndexCmd[indexmain]{setfootsepline}, and
-\Macro{setfootbotline}\IndexCmd[indexmain]{setfootbotline}. These have a first
-optional argument for the \PName{length}, a second mandatory argument for the
-\PName{thickness}, and a third optional argument for the setting of font or
-colour. Package \Package{scrlayer-scrpage} does also provide those
-commands. Nevertheless, these commands are deprecated and should not be used
-any longer. To get it clear: These commands have never been made to
-switch the lines on or off. They have been made to configure already switched
-on lines. Users often ignored this!%
-\EndIndex{Cmd}{setfootbotline}%
-\EndIndex{Cmd}{setfootsepline}%
-\EndIndex{Cmd}{setheadsepline}%
-\EndIndex{Cmd}{setheadtopline}%
+In addition to the length and thickness, you can also change the colour of the
+lines. Initially the colour depends on the colour of the header or footer. In
+addition to this, however, the settings of the corresponding elements
+\important[i]{\FontElement{headtopline}\\
+ \FontElement{headsepline}\\
+ \FontElement{footsepline}\\
+ \FontElement{footbotline}} \FontElement{headtopline},
+\FontElement{headsepline}, \FontElement{footsepline} and
+\FontElement{footbotline} are applied. You can
+change these using the \DescRef{\LabelBase.cmd.setkomafont} or
+\DescRef{\LabelBase.cmd.addtokomafont} commands (see
+\autoref{sec:maincls.textmarkup}, \DescPageRef{maincls.cmd.setkomafont}).
+By default these elements are empty, so they do not change the current font or
+colour. Font changes at this point, unlike colour changes, make little sense
+anyway and are therefore not recommended for these elements.%
+\EndIndexGroup
%
\EndIndexGroup
@@ -1123,10 +1154,10 @@ on lines. Users often ignored this!%
\OptionVName{plainfootsepline}{simple switch}%
\OptionVName{plainfootbotline}{simple switch}
\end{Declaration}
-These options can be used to inherit the settings of the lines also for the
-\PageStyle{plain} page style. Possible values for \PName{simple switch} can be
-found in \autoref{tab:truefalseswitch} on
-\autopageref{tab:truefalseswitch}. If a option is activated, the
+You can use these options to apply the settings for the lines to the
+\PageStyle{plain} page style. You can find the available values for
+\PName{simple switch} in \autoref{tab:truefalseswitch} on
+\autopageref{tab:truefalseswitch}. If one of these options is activated, the
\PageStyle{plain} page style will use the line settings given by the options
and commands described above. If the option is deactivated, the
\PageStyle{plain} will not show the corresponding line.%
@@ -1138,14 +1169,14 @@ and commands described above. If the option is deactivated, the
\Option{clines}%
\Option{olines}
\end{Declaration}
-You have already been told that the horizontal lines above or below the page
-head or foot can be shorter or longer than the page head or page foot
-itself. Only the answer to the question about the alignment of those lines is
-still missing. By default all lines are left aligned at single side layout and
-aligned to the inner margin of the head or foot at double side layout. This
-is same like using option \Option{ilines}. Alternatively, you can use option
-\Option{clines} to centre the lines in the head or foot, or option
-\Option{olines} to align them right respectively to the outer margin.%
+As previously explained, dividing lines for the header or footer can be longer
+or shorter than the width of the header or footer respectively. But the
+question remains how these lines are aligned. By default, all lines are
+aligned to the left margin in one-sided printing and to the inner margin in
+two-sided printing. This corresponds to using the \Option{ilines} option.
+Alternatively, you can use the \Option{clines} option to centre the lines with
+respect to the width of the header or footer, or the \Option{olines} option to
+align them to the outer (or right) margin.%
\EndIndexGroup
%
\EndIndexGroup