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.tex274
1 files changed, 232 insertions, 42 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 34d3a727741..4cbc046c797 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
+% Copyright (c) Markus Kohm, 2013-2014
%
% 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
+% Copyright (c) Markus Kohm, 2013-2014
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -44,11 +44,11 @@
% ============================================================================
\KOMAProvidesFile{scrlayer-scrpage.tex}%
- [$Date: 2013-12-13 12:11:01 +0100 (Fr, 13. Dez 2013) $
+ [$Date: 2014-10-27 08:39:00 +0100 (Mon, 27 Oct 2014) $
KOMA-Script guide (chapter: scrlayer-scrpage)]
\translator{Markus Kohm\and Jana Schubert\and Jens H\"uhne}
-% Date version of the translated file: 2013-11-15
+% Date version of the translated file: 2014-10-27
\chapter[{Adapting Page Headers and Footers with \Package{scrlayer-scrpage}}]
{Adapting\ChangedAt{v3.12}{\Package{scrlayer-scrpage}} Page Headers and
@@ -116,8 +116,8 @@ insufficient for your purposes you are encouraged to examine
\section{Usage of Predefined Page Styles}
\label{sec:scrlayer-scrpage.predefined.pagestyles}
-The easiest way to get a requested design of page head and foot with
-\Package{scrlayer-scrpage} is the usage of a predefined page style.
+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}\\
@@ -125,41 +125,47 @@ The easiest way to get a requested design of page head and foot with
\end{Declaration}
\BeginIndex{Pagestyle}{scrheadings}%
\BeginIndex{Pagestyle}{plain.scrheadings}%
-Package \Package{scrlayer-scrpage} provides two page styles that may be
-reconfigured depending on your own requests. Let's first of all talk about
-page style \Pagestyle{scrheadings} which has been designed to be used with
+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 \LaTeX's standard classes or
-the \KOMAScript{} classes. The commands and options that may be used to
-configure the exact contents of the header and footer will be described
-consecutively.
-
-Second there's page style \Pagestyle{plain.scrheadings} which has been
-designed to be used without any running head. Its defaults are very similar to
-page style \Pagestyle{plain}\IndexPagestyle{plain} of \LaTeX's standard
-classes or the \KOMAScript{} classes. Once more the commands and options that
-may be used to configure the exact contents of the header and footer will be
-described consecutively.
-
-Fore sure, you could configure \Pagestyle{scrheadings} to be a 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
without a running head and \Pagestyle{plain.scrheadings} to be a page style
-with running heads. Nevertheless, it is more useful to fit the conventions
-declared above, mainly, because both page styles influence each other. If you
-select 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}. So,
-if you have a class or package that automatically switches between
-\Pagestyle{headings} and \Pagestyle{plain}, you need to select
-\Pagestyle{scrheadings} or \Pagestyle{plain.scrheadings} only once and then
-the class or package will switch between \Pagestyle{scrheadings} and
-\Pagestyle{plain.scrheadings} without even knowing these page styles. Patches
-or other adaptions of classes (or packages) will not be necessary. So these page
-styles are something like a pair that may be used as a drop-in replacement
-for \Pagestyle{headings} and \Pagestyle{plain}.
-
-At this point I'd like to mention that for compatibility with
-\Package{scrpage2} page style \Pagestyle{plain.scrheadings} can also be used
-with the alias name \Pagestyle{scrplain}\IndexPagestyle[indexmain]{scrplain}.
+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.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}.}
%
\EndIndex{Pagestyle}{plain.scrheadings}%
\EndIndex{Pagestyle}{scrheadings}%
@@ -458,7 +464,7 @@ sketched in \autoref{fig:scrlayer-scrpage.head}.%
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:
- \begin{lstcode}
+\begin{lstcode}
\documentclass{scrartcl}
\usepackage{scrlayer-scrpage}
\lohead[John Doe]
@@ -494,6 +500,65 @@ section.%
\EndIndex{Cmd}{cehead}%
\EndIndex{Cmd}{lehead}%
+
+\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}
+\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}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}} 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.%
+
+\begin{Example}
+ You can shorten the previous example using the star version of
+ \Macro{lohead} and \Macro{rohead}:
+\begin{lstcode}
+ \documentclass{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \lohead*{John Doe}
+ \rohead*{Page style with \KOMAScript}
+ \pagestyle{scrheadings}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \end{document}
+\end{lstcode}
+\end{Example}
+
+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*}%
+
+
\begin{Declaration}
\Macro{lefoot}\OParameter{plain.scrheadings's content}%
\Parameter{scrheadings's content}\\
@@ -767,6 +832,71 @@ ideally together with the automatism described in the following section.%
\EndIndex{Cmd}{cefoot}%
\EndIndex{Cmd}{lefoot}%
+
+\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}
+\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}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}} 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.
+
+\begin{Example}
+ You can shorten the previous example using the star version of
+ \Macro{lofoot} and \Macro{refoot}:
+\begin{lstcode}
+ \documentclass[twoside]{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \lohead{John Doe}
+ \rohead{Page style with \KOMAScript}
+ \lofoot*{Smart Alec Publishing}
+ \rehead{John Doe}
+ \lohead{Page style with \KOMAScript}
+ \refoot*{Smart Alec Publishing}
+ \pagestyle{scrheadings}
+ \usepackage{lipsum}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \lipsum\lipsum
+ \end{document}
+\end{lstcode}
+\end{Example}
+
+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*}%
+
+
\begin{Declaration}
\Macro{ohead}\OParameter{plain.scrheadings's content}%
\Parameter{scrheadings's content}\\
@@ -847,6 +977,66 @@ section.%
\EndIndex{Cmd}{cfoot}%
\EndIndex{Cmd}{ofoot}%
+\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}
+\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}{\Class{scrbook}\and \Class{scrreprt}\and
+ \Class{scrartcl}} 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.%
+
+\begin{Example}
+ You can shorten the previous example using the star version of
+ \Macro{ifoot}:
+\begin{lstcode}
+ \documentclass[twoside]{scrartcl}
+ \usepackage{scrlayer-scrpage}
+ \ihead{John Doe}
+ \ohead{Page style with \KOMAScript}
+ \ifoot*{Smart Alec Publishing}
+ \pagestyle{scrheadings}
+ \usepackage{lipsum}
+ \begin{document}
+ \title{Page styles with \KOMAScript}
+ \author{John Doe}
+ \maketitle
+ \lipsum\lipsum
+ \end{document}
+\end{lstcode}
+\end{Example}
+
+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*}%
+
\begin{Declaration}
\KOption{pagestyleset}\PName{setting}
@@ -1048,7 +1238,7 @@ elements.%
\EndIndex{FontElement}{headtopline}%
\BeginIndex{Cmd}{setheadtopline}%
-\BeginIndex{Cmd}{setheadseoline}%
+\BeginIndex{Cmd}{setheadsepline}%
\BeginIndex{Cmd}{setfootsepline}%
\BeginIndex{Cmd}{setfootbotline}%
Package \Package{scrpage2} has additionally to the options that do not take
@@ -1066,7 +1256,7 @@ 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}{setheadseoline}%
+\EndIndex{Cmd}{setheadsepline}%
\EndIndex{Cmd}{setheadtopline}%
%
\EndIndex{Option}{footbotline~=\PName{thickness\textup{:}length}}%