summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-01-19 23:43:25 +0000
committerKarl Berry <karl@freefriends.org>2015-01-19 23:43:25 +0000
commit83b4f07dfc662cf6c2632a34e88a1aad0009e35a (patch)
treed6c61dbd9ba41e2c7353bdcf23acb151b52601ff /Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx
parent3fef13606c698d4e277aaad8662b082f8f5c6fab (diff)
koma-script (19jan15)
git-svn-id: svn://tug.org/texlive/trunk@36095 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx357
1 files changed, 25 insertions, 332 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx b/Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx
index 958eecaa7ef..d936c10b64c 100644
--- a/Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx
+++ b/Master/texmf-dist/source/latex/koma-script/scrlayer-scrpage.dtx
@@ -1,4 +1,4 @@
-% \CheckSum{2418}
+% \CheckSum{2398}
% \iffalse^^A meta-comment
% ======================================================================
% scrlayer-scrpage.dtx
@@ -57,17 +57,17 @@
% Right brace \} Tilde \~}
%
% \iffalse^^A meta-comment
-%<identify>%%% From File: $Id: scrlayer-scrpage.dtx 1806 2014-10-16 06:41:25Z kohm $ (identify)
-%<init>%%% From File: $Id: scrlayer-scrpage.dtx 1806 2014-10-16 06:41:25Z kohm $ (init)
-%<options>%%% From File: $Id: scrlayer-scrpage.dtx 1806 2014-10-16 06:41:25Z kohm $ (options)
-%<body>%%% From File: $Id: scrlayer-scrpage.dtx 1806 2014-10-16 06:41:25Z kohm $ (body)
+%<identify>%%% From File: $Id: scrlayer-scrpage.dtx 1899 2015-01-08 08:57:02Z kohm $ (identify)
+%<init>%%% From File: $Id: scrlayer-scrpage.dtx 1899 2015-01-08 08:57:02Z kohm $ (init)
+%<options>%%% From File: $Id: scrlayer-scrpage.dtx 1899 2015-01-08 08:57:02Z kohm $ (options)
+%<body>%%% From File: $Id: scrlayer-scrpage.dtx 1899 2015-01-08 08:57:02Z kohm $ (body)
%<*dtx>
\ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
\begingroup
\def\filedate$#1: #2-#3-#4 #5${\gdef\filedate{#2/#3/#4}}
- \filedate$Date: 2014-10-16 08:41:25 +0200 (Thu, 16 Oct 2014) $
+ \filedate$Date: 2015-01-08 09:57:02 +0100 (Thu, 08 Jan 2015) $
\def\filerevision$#1: #2 ${\gdef\filerevision{#2}}
- \filerevision$Revision: 1806 $
+ \filerevision$Revision: 1899 $
\endgroup
\ProvidesFile{scrlayer-scrpage.dtx}[\filedate\space r\filerevision\space
%</dtx>
@@ -188,324 +188,6 @@
% \let\section\subsection
% \let\subsection\subsubsection
%
-% \chapter{End User Interface \Package{scrlayer-scrpage}}
-% \label{sec:scrlayer-scrpage}
-%
-% This interface is the implementation of the described features of
-% \KOMAScript{} package \Package{scrpage2}. It is extended by some additional
-% options and commands. Some features, that has been described for
-% \Package{scrpage2} have been removed or declared to be deprecated.
-%
-% While this is mainly the implementation documentation, you may find only some
-% additional information about differences to \Package{scrpage2}. See the
-% \KOMAScript{} manual (\File{scrguien.pdf}) for more information.
-%
-% \section{Head and Foot Width and Offset}
-% \label{sec:scrlayer.headfoot.width}
-%
-% From \Package{scrpage2} you already know commands \Macro{setheadwidth} and
-% \Macro{setfootwidth}. Package \Package{scrlayer-scrpage} provides them too and
-% they are still supported.
-%
-% \DescribeOption{headwidth}
-% \DescribeOption{footwidth}
-% Options
-% \KOption{headwidth}\PName{width}\texttt{:}\PName{offset}
-% and
-% \KOption{footwidth}\PName{width}\texttt{:}\PName{offset}
-% could be used to setup the width and the horizontal offset of the page head
-% respectively the page foot. By default the \PName{width} is
-% \Length{textwidth}, the width of the text area. The default of \PName{offset}
-% is a little bit more complex. Normally the default of \PName{offset} in
-% single-side mode is half of the difference of the text area width minus
-% \PName{width}. In two-side mode it's only a third of that difference. But if
-% \PName{width} is the width of the text area plus the marginal note column, the
-% default of \PName{offset} is zero.
-%
-% An \PName{offset} of zero means, that the head respectively foot is aligned to
-% the inner edge of the text area. In single-side mode this is the left edge of
-% the text area. In double-side mode, this is the left edge of the text area of
-% odd pages or the right edge of the text area of even pages. An positive
-% \PName{offset} will move the head respectively the foot towards the outer
-% margin respectively the right margin in single-side mode.
-%
-% You may omit the \PName{width} or the \PName{offset}. In this case also the
-% defaults of the values will be used. If you omit both, you may also omit the
-% colon. If you omit one value and the colon, the existent value is the
-% \PName{width}.
-%
-% Instead of using lengths for \PName{width} or \PName{offset}, you may use also
-% some symbolic values. These are
-% \begin{description}
-% \item[\PValue{foot}:] the current width of the page foot,
-% \item[\PValue{footbotline}:] the current length of the horizontal line below
-% the page foot,
-% \item[\PValue{footsepline}:] the current length of the horizontal line above
-% the page foot,
-% \item[\PValue{head}:] the current width of the page head,
-% \item[\PValue{headsepline}:] the current length of the horizontal line below
-% the page head,
-% \item[\PValue{headtopline}:] the current length of the horizontal line above
-% the page head,
-% \item[\PValue{marginpar}:] the width of the marginal note column plus the
-% distance of that column to the text area,
-% \item[\PValue{page}:] the paper width without binding correction, that has
-% been set using package \Package{typearea},
-% \item[\PValue{paper}:] the whole paper width inclusive a binding correction
-% if used,
-% \item[\PValue{text}:] the width of the text area,
-% \item[\PValue{textwidthmarginpar}:] the width of the text area plus the
-% marginal note column (and the distance between them).
-% \end{description}
-% If none of the symbolic values has been used, you may alternatively use a
-% dimensional expression. Those may contain basic arithmetic operations and
-% round brackets. For more information about dimensional expressions see the
-% \eTeX{} manual.
-%
-%
-% \section{Horizontal Separation Lines above and below Page Head and Foot}
-% \label{sec:scrlayer-headfoot.lines}
-%
-% From \Package{scrpage2} you already know options \Option{headtopline},
-% \Option{headsepline}, \Option{footsepline}, \Option{footbotline},
-% \Option{plainheadtopline}, \Option{plainheadsepline},
-% \Option{plainfootsepline}, and \Option{plainfootbotline}. These were
-% implemented as \LaTeX{} package options and could be used to switch on the
-% lines only. With \Package{scrlayer-scrpage} this has been changed.
-%
-% \DescribeOption{headtopline}
-% \DescribeOption{headsepline}
-% \DescribeOption{footsepline}
-% \DescribeOption{footbotline}
-% The option
-% \KOption{headtopline}\PName{thickness}\texttt{:}\PName{length}
-% May be used to activate a horizontal line above the page head and to configure
-% it's \PName{thickness} and \PName{length}. You may omit both, the
-% \PName{thickness} and \PName{length}. In this case you may also omit the
-% colon. This would result in the default \PName{thickness} 0.4\,pt and the
-% default \PName{length}, that is the current width of the page head. If you use
-% only one value without colon, this will be interpreted as \PName{thickness}
-% and \PName{width} will become also the default. For \PName{length} you may
-% also use a symbolic value. Alternatively you may use a dimensional expression
-% again. See option \Option{headwidth} for more information about valid symbolic
-% values and dimensional expressions.
-%
-% Options \Option{headsepline}, \Option{footsepline}, and \Option{footbotline}
-% are similar to \Option{headtopline}, but for a horizontal line below the page
-% head, above the page foot, and below the page foot. The default \PName{length}
-% of \Option{footsepline} and \Option{footbotline} is the width of the page foot
-% instead of the page head.
-%
-% Instead of \PName{thickness}\texttt{:}\PName{length} you may alternatively use
-% one of the values for \emph{simple switches}. Switching on a line, will also
-% set \PName{thickness} and \PName{length} to their defaults. Switching off a
-% line, will set both values to zero. This makes the lines invisible.
-%
-% All of them are also font elements, that may be configured using
-% \Macro{setkomafont} or \Macro{addtokomafont}, but you should not change the
-% font size. The elements are provided to make it easier to change the colour of
-% the lines. See package \Package{color} or \Package{xcolor} for more
-% information about colour with \LaTeX.
-%
-% \DescribeOption{plainheadtopline}
-% \DescribeOption{plainheadsepline}
-% \DescribeOption{plainfootsepline}
-% \DescribeOption{plainfootbotline}
-% The option
-% \KOption{plainheadtopline}\PName{simple switch}
-% may be used to switch on or off the horizontal line above the page head of
-% \emph{plain} pages, defined using on of the commands from
-% \autoref{sec:scrlayer.definepairs}. Page style \Pagestyle{scrplain} is one of
-% those. You cannot give them another length or thickness than the lines of the
-% \emph{headings} or \emph{main} page style. You may only switch them on or off
-% and they will use the settings of the \emph{main} page style. By default they
-% are switched off, because that's the usual style of chapter start pages.
-%
-% Options \Option{plainheadsepline}, \Option{plainfootsepline}, and
-% \Option{plainfootbotline} are similar for the corresponding other horizontal
-% lines below or above the page head or foot.
-%
-% \DescribeOption{ilines}
-% \DescribeOption{clines}
-% \DescribeOption{olines}
-% You already know these options from \Package{scrpage2}. But now they are not
-% only package options, but \KOMAScript{} options, that may be used anywhere at
-% the document preamble or document body. Nevertheless, they don't expect any
-% value. Maybe these options will become deprecated in a future release of
-% \Package{scrlayer-scrpage} and will become a single option with (at least)
-% three values.
-%
-%
-% \section{Predefined Page Styles}
-% \label{sec:scrlayer.predefined}
-%
-% Package \Package{scrlayer-scrpage} still defines page styles
-% \Pagestyle{scrheadings} and \Pagestyle{scrplain}, but \Pagestyle{scrplain}
-% is only an alias for \Pagestyle{plain.scrheadings} now.
-%
-% \DescribeOption{pagestyleset}
-% \KOMAScript{} option
-% \KOption{pagestyleset}\PName{name}
-% may be used to configure the page styles \Pagestyle{scrheadings} and
-% \Pagestyle{scrplain}. For \PName{name} currently one of \PValue{standard} or
-% \PValue{KOMA-Script} is allowed. The first one selects settings for the
-% elements of the page head and foot, that are compatible with the standard
-% classes. The second one selects defaults compatible with the \KOMAScript{}
-% classes.
-%
-%
-% \section{Defining Pairs Like \Pagestyle{scrheadings} and
-% \Pagestyle{plain.scrheadings}}
-% \label{sec:scrlayer.definepairs}
-%
-% You already know the page style pair \Pagestyle{scrheadings} and
-% \Pagestyle{scrplain} from package \Package{scrpage2}. As told above with
-% \Package{scrlayer-scrpage} page style \Package{scrplain} is an alias of
-% \Pagestyle{plain.scrheadings}. So page styles \Pagestyle{scrheadings} and
-% \Pagestyle{plain.scrheadings} build the real pair of a \emph{headings} page
-% style and a \emph{plain} page style.
-%
-% You should\,---\,at this point\,---\,also note, that the commands
-% \Macro{ihead}, \Macro{chead}, \Macro{ohead}, \Macro{lehead}, \Macro{cehead},
-% \Macro{rehead}, \Macro{lohead}, \Macro{lohead}, \Macro{rohead},
-% \Macro{ifoot}, \Macro{cfoot}, \Macro{ofoot}, \Macro{lefoot}, \Macro{cefoot},
-% \Macro{refoot}, \Macro{lofoot}, \Macro{lofoot}, \Macro{rofoot},
-% \Macro{clearscrheadfoot}, \Macro{clearscrplain}, and \Macro{clearscrheadings}
-% does not only configure \Pagestyle{scrplain} and \Pagestyle{scrheadings}, but
-% the current pair of page styles. If the current page style is not a member of
-% a pair of page styles, that last pair, that has been used, is the current
-% one. Only if this is unknown too, the pair \Pagestyle{scrheadings} and
-% \Pagestyle{plain.scrheadings}\footnote{\Pagestyle{plain.scrheadings} is the
-% real name of the \emph{plain} page style to \Pagestyle{scrheadings}.} is
-% current.
-%
-% \DescribeMacro{\defpairofpagestyles}
-% \DescribeMacro{\newpairofpagestyles}
-% \DescribeMacro{\renewpairofpagestyles}
-% \DescribeMacro{\providepairofpagestyles}
-% The command
-% \Macro{defpairofpagestyles}%
-% \OParameter{parent page style name}\Parameter{name}\Parameter{definition}
-% may be used to define a pair of page styles like \PName{scrheadings} and
-% \PName{plain.scrheadings}. \PName{name} is the name of the \emph{headings}
-% page style of the pair. We also say \emph{main} page style alternatively to
-% \emph{headings} page style. The \emph{plain} page style will become the name
-% \PValue{plain.}\PName{name}.
-%
-% The \PName{definition} will be executed, whenever either the main or the plain
-% page style will be selected. You may use here, e.g., commands like
-% \Macro{ihead} or \Macro{clearpairofpagestyles} to configure the pair of page
-% styles. But note, if you redefine things like \Macro{chaptermark} inside of
-% \PName{definition}, this would also influence other page styles. So it's
-% recommended to use only commands, that do not influence other page styles or
-% other features of \Package{scrlayer} or other packages or classes!
-%
-% The difference between \Macro{newpairofpagestyles} and
-% \Macro{defpairofpagestyles} is, that the first one would raise an error, if
-% there has been a page style \PName{name} or \PValue{plain.}\PName{name}
-% already before. In opposite to this \Macro{renewpairofpagestyles} would raise
-% the error, if those page style hasn't been already before. Last but not least
-% \Macro{providepairofpagestyles} won't raise an error, but it defines
-% \PName{name} and \PValue{plain.}\PName{name} only, if they were not defined
-% already before.
-%
-% \DescribeMacro{\clearmainofpairofpagestyles}
-% \DescribeMacro{\clearplainofpairofpagestyles}
-% \DescribeMacro{\clearpairofpagestyles}
-% With \Package{scrlayer-scrpage} pairs of page styles are more general that
-% with the single pair of \Package{scrpage2}. So command names like
-% \Macro{clearscrheadings}, \Macro{clearscrplain} and even
-% \Macro{clearscrheadfoot} are somehow to specific. Therefore
-% \Macro{clearmainofpairofpagestyles} is the new name of
-% \Macro{clearscrheadings} to set all fields of the main page style of the
-% current pair of page styles to an empty value;
-% \Macro{clearplainofpairofpagestyles} is the new name of \Macro{clearscrplain}
-% to set all fields of the plain page style of the current pair of page styles
-% to an empty value; \Macro{clearpariofpagestyles} is the new name of
-% \Macro{clearscrheadfoot} to set all fields of the plain and the main page
-% style if the current pair of page styles to an empty value. The old names are
-% obsolete, but still valid for compatibility reason. But they have the new
-% meanings, if \Pagestyle{scrheadings} and \Pagestyle{plain.scrheadings} are not
-% the only existing pair of page styles.
-%
-%
-% \section{Defining Page Styles With Expert Interface}
-% \label{sec:scrlayer.expert}
-%
-% You already know \Macro{defpagestyle}, \Macro{newpagestyle},
-% \Macro{renewpagestyle}, and \Macro{providepagestyle} from package
-% \Package{scrpage2}. Package \Package{scrlayer-scrpage} provides those
-% too. Nevertheless there are some differences, e.g., \Package{scrpage2} didn't
-% support a configurable height for the page foot, but supposed
-% \Length{baselineskip} for the total height of the foot. Package
-% \Package{scrlayer-scrpage} uses length \Length{footheight} provided by
-% \Package{scrlayer} for the total height of the foot.
-%
-% \DescribeOption{hmode}
-% The option
-% \KOption{hmode}\PName{simple switch}%
-% may be used to make \Package{scrlayer-scrpage} more compatible with
-% \Package{scrpage2}. By default \Package{scrlayer-scrpage} sets the elements of
-% the page head and page foot in vertical mode. But \Package{scrpage2} did the
-% same job in horizontal mode. If the option has been switched on,
-% \Package{scrlayer-scrpage} will also leave the vertical mode before setting a
-% page head or foot element.
-%
-%
-% \section{Removed or Deprecated Package Options}
-% \label{sec:scrlayer.deprecated.options}
-%
-% Package \Package{scrpage2} never supported \KOMAScript{} options. Instead it
-% only supports standard \LaTeX{} package options. Options \Option{headinclude},
-% \Option{headexclude}, \Option{footinclude}, and \Option{footexclude} became
-% deprecated since 2008-12-08. Package \Package{scrlayer-scrpage} doesn't
-% provide them any longer. Options \Option{mpinclude} and \Option{mpexclude} has
-% never been official in \Package{scrpage2}. So it was an easy decision to not
-% provide them by \Package{scrlayer-scrpage}.
-%
-% Options \Option{komastyle} and \Option{standardstyle} have been replaced by
-% \Option{pagestyleset}. Nevertheless, they are still implemented as simple
-% package options, but declared to be deprecated. You should not use them any
-% longer, because they might be removed in a future release.
-%
-% Options \Option{markuppercase}, \Option{markusedcase}, and
-% \Option{nouppercase} have been replaced by \Option{markcase}. Nevertheless,
-% they are still implemented as simple package options, but declared to be
-% deprecated. You should not use them any longer, because they might be removed
-% in a future release.
-%
-%
-% \section{Deprecated Commands}
-% \label{sec:scrlayer.deprecated.commands}
-%
-% The commands \Macro{setheadtopline}, \Macro{setheadsepline},
-% \Macro{setfootsepline}, and \Macro{setfootbotline} of \Package{scrpage2} has
-% been intended to configure the lines above and below the page head and
-% foot. They \emph{never} has been intended to switch the lines on an
-% off. Switching on the lines should have been done using the package options
-% \Option{headtopline}, \Option{headsepline}, \Option{footsepline}, and
-% \Option{footbotline}, and their plain equivalents \Option{plainheadtopline},
-% \Option{plainheadsepline}, \Option{plainfootsepline}, and
-% \Option{plainfootbotline}. Nevertheless, a lot of users have used the commands
-% also to switch on the lines. This commands became deprecated with
-% \Package{scrlayer-scrpage}, but nevertheless are still
-% implemented. Nevertheless, with \Package{scrlayer-scrpage} users should
-% absolutely use the \KOMAScript{} options and the font elements not only for
-% switching on the lines, but also for configuration of the lines.
-%
-% Commands \Macro{headfont} and \Macro{footfont} are deprecated, because
-% \Package{scrlayer-scrpage} provides the font element interface of the
-% \KOMAScript{} classes. You should use \Macro{setkomafont} and
-% \Macro{addtokomafont} to configure fonts and colours of page head and foot.
-%
-% Package \Package{scrpage2} provided an additional user page style definition
-% interface using command \Macro{deftripstyle}. This became obsolete with
-% \Package{scrlayer-scrpage}, because the other interfaces are easier to
-% understand and more powerful. Nevertheless additional commands
-% \Macro{deftriplepagestyle}, \Macro{newtriplepagestyle},
-% \Macro{renewtriplepagestyle}, and \Macro{providetriplepagestyle} has been
-% implemented to have a more consistent user interface.
-%
%\iffalse
%</dtx>
%\fi
@@ -513,6 +195,7 @@
% \StopEventually{}
%
% \chapter{Implementation of \Package{scrlayer-scrpage}}
+% \label{sec:scrlayer-scrpage}
%
% This section if for developers only.
%
@@ -579,9 +262,11 @@
% with \KOMAScript{} options. Those options will become the primary interface.
%
% \begin{option}{headwidth}
-% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}
+% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}^^A
% \begin{option}{footwidth}
-% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}
+% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}^^A
+% \changes{v3.15}{2014/12/28}{fix: missing colon in call of
+% \cs{sls@split@at@iicolons}}^^A
% \begin{description}
% \item[\texttt{=\meta{special dimensional expression}:\meta{special
% dimensional expression}}:] see \Macro{sls@settowidthof} for information
@@ -613,7 +298,7 @@
\scrlayer@AddCsToInterface{KV@KOMA.scrlayer-scrpage.sty@headwidth@default}
\KOMA@key{footwidth}{%
\begingroup
- \sls@split@at@iicolons#1::\@nil
+ \sls@split@at@iicolons#1:::\@nil
\ifx\reserved@a\@empty \let\reserved@a\sls@footwidth\fi
\edef\reserved@a{%
\noexpand\endgroup
@@ -2318,8 +2003,12 @@
\sls@def@pair@page@style@member{#2}%
\AddToLayerPageStyleOptions{#2}{%
onselect={%
- \expandafter\let\expandafter\ps@plain\csname ps@plain.#2\endcsname
- \expandafter\let\expandafter\ps@headings\csname ps@#2\endcsname
+% \end{macrocode}
+% \changes{v3.15}{2015/01/08}{usage of \cs{DeclarePageStyleAlias} instead of
+% \cs{let}}^^A fixme: Is this correct?
+% \begin{macrocode}
+ \DeclarePageStyleAlias{plain}{plain.#2}%
+ \DeclarePageStyleAlias{headings}{#2}%
\def\sls@currentheadings{#2}%
\def\sls@currentplain{plain.#2}%
#3%
@@ -2328,8 +2017,12 @@
\sls@def@pair@page@style@member{plain.#2}%
\AddToLayerPageStyleOptions{plain.#2}{%
onselect={%
- \expandafter\let\expandafter\ps@plain\csname ps@plain.#2\endcsname
- \expandafter\let\expandafter\ps@headings\csname ps@#2\endcsname
+% \end{macrocode}
+% \changes{v3.15}{2015/01/08}{usage of \cs{DeclarePageStyleAlias} instead of
+% \cs{let}}^^A fixme: Is this correct?
+% \begin{macrocode}
+ \DeclarePageStyleAlias{plain}{plain.#2}%
+ \DeclarePageStyleAlias{headings}{#2}%
\def\sls@currentheadings{#2}%
\def\sls@currentplain{plain.#2}%
#3%