summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx')
-rw-r--r--macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx1480
1 files changed, 603 insertions, 877 deletions
diff --git a/macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx b/macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx
index d7a264f89e..e0b8af619a 100644
--- a/macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx
+++ b/macros/latex/contrib/koma-script/source/scrlayer-scrpage.dtx
@@ -1,7 +1,7 @@
% \iffalse^^A meta-comment
% ======================================================================
% scrlayer-scrpage.dtx
-% Copyright (c) Markus Kohm, 2012-2021
+% Copyright (c) Markus Kohm, 2012-2022
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -17,28 +17,8 @@
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
-% ----------------------------------------------------------------------
-% scrlayer-scrpage.dtx
-% Copyright (c) Markus Kohm, 2012-2021
-%
-% Diese Datei ist Teil der LaTeX2e KOMA-Script-Sammlung.
-%
-% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
-% Version 1.3c.
-% Die neuste Version dieser Lizenz ist
-% http://www.latex-project.org/lppl.txt
-% und Version 1.3c ist Teil aller Verteilungen von LaTeX
-% Version 2005/12/01 und dieses Werks.
-%
-% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
-% (allein durch den Autor verwaltet).
-%
-% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
-%
-% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
-%
-%%% From File: $Id: scrlayer-scrpage.dtx 3595 2021-05-16 07:11:07Z kohm $
+%%% From File: $Id: scrlayer-scrpage.dtx 3693 2022-02-10 13:20:09Z kohm $
%<identify>%%% (run: identify)
%<init>%%% (run: init)
%<options>%%% (run: options)
@@ -47,9 +27,9 @@
\ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
\begingroup
\def\filedate$#1: #2-#3-#4 #5${\gdef\filedate{#2/#3/#4}}
- \filedate$Date: 2021-05-16 09:11:07 +0200 (Sun, 16 May 2021) $
+ \filedate$Date: 2022-02-10 14:20:09 +0100 (Do, 10. Feb 2022) $
\def\filerevision$#1: #2 ${\gdef\filerevision{r#2}}
- \filerevision$Revision: 3595 $
+ \filerevision$Revision: 3693 $
\edef\reserved@a{%
\noexpand\endgroup
\noexpand\ProvidesFile{scrlayer-scrpage.dtx}%
@@ -75,13 +55,13 @@
\KOMAdefVariable{COPYRIGHTFROM}{2012}
\generate{\usepreamble\defaultpreamble
\file{scrlayer-scrpage.sty}{%
- \from{scrlayer-scrpage.dtx}{interface,trace,scrpage,identify}%
- \from{scrlayer.dtx}{interface,trace,scrpage,init}%
- \from{scrlayer-scrpage.dtx}{interface,trace,scrpage,init}%
- \from{scrlayer.dtx}{interface,trace,scrpage,options}%
- \from{scrlayer-scrpage.dtx}{interface,trace,scrpage,options}%
- \from{scrlayer.dtx}{interface,trace,scrpage,body}%
- \from{scrlayer-scrpage.dtx}{interface,trace,scrpage,body}%
+ \from{scrlayer-scrpage.dtx}{interface,scrpage,identify}%
+ \from{scrlayer.dtx}{interface,scrpage,init}%
+ \from{scrlayer-scrpage.dtx}{interface,scrpage,init}%
+ \from{scrlayer.dtx}{interface,scrpage,options}%
+ \from{scrlayer-scrpage.dtx}{interface,scrpage,options}%
+ \from{scrlayer.dtx}{interface,scrpage,body}%
+ \from{scrlayer-scrpage.dtx}{interface,scrpage,body}%
\from{scrlogo.dtx}{logo}%
}%
}
@@ -90,182 +70,133 @@
\let\endbatchfile\relax
\fi
\endbatchfile
- \documentclass{scrdoc}
- \addtolength{\textwidth}{-1em}
- \addtolength{\marginparwidth}{2em}
- \addtolength{\oddsidemargin}{2em}
- \usepackage[ngerman,english]{babel}
- \usepackage{url,babelbib}\bibliographystyle{babalpha-fl}
- \usepackage{listings}
- \usepackage{scrhack}
- \usepackage{etoolbox}
- \pretocmd\DescribeMacro{\ifhmode\else\bigskip\noindent\fi}{}{}
- \pretocmd\DescribeEnv{\ifhmode\else\bigskip\noindent\fi}{}{}
- \pretocmd\DescribeOption{\ifhmode\else\bigskip\noindent\fi}{}{}
-
- \CodelineIndex
- \RecordChanges
- \GetFileInfo{scrlayer-scrpage.dtx}
- \title{The \texttt{scrlayer} interface \texttt{scrlayer-scrpage}%
- \footnote{This is version \fileversion\ of file \texttt{\filename}.}}
- \date{\filedate}
- \author{Markus Kohm}
-
- \newenvironment{Explain}{\par}{\par}
- \newcommand*{\length}{}
- \let\length\Length
- \let\endlength\endLength
- \let\Macro\cs
- \let\Length\Macro
- \let\Package\textsf
- \let\Class\Package
- \let\File\texttt
- \let\Option\texttt
- \newcommand*{\KOption}[1]{\Option{#1}\texttt{=}}
- \newcommand*{\OptionValue}[2]{\Option{#1}\texttt{=}\PValue{#2}}
- \let\Counter\texttt
- \let\Environment\texttt
- \let\ShowOutput\quote
- \let\endShowOutput\endquote
- \let\Pagestyle\texttt
- \newcommand*{\Parameter}[1]{\texttt{\marg{#1}}\linebreak[1]}
- \newcommand*{\OParameter}[1]{\texttt{\oarg{#1}}\linebreak[1]}
- \newcommand*{\MParameter}[2]{\texttt{(\meta{#1},\meta{#2})}\linebreak[1]}
- \providecommand\PParameter[1]{\mbox{\texttt{\{#1\}}}\linebreak[1]}
- \let\PName\meta
- \let\PValue\texttt
- \providecommand*{\autoref}[1]{\expandafter\AUTOREF#1:}
- \providecommand*{\AUTOREF}{}
- \makeatletter
- \def\AUTOREF#1:#2:{%
- \edef\@tempa{#1}%
- \edef\@tempb{tab}\ifx\@tempa\@tempb table~\fi
- \edef\@tempb{sec}\ifx\@tempa\@tempb section~\fi
- \ref{#1:#2}%
- }
- \providecommand*{\IndexCmd}[2][]{}
- \providecommand*{\textnote}[2][]{}
- \providecommand*\eTeX{\leavevmode\hbox{$\varepsilon$}-\TeX}
- \providecommand*\NTS{%
- \leavevmode\hbox{$\cal N\kern-0.35em\lower0.5ex\hbox{$\cal T$}%
- \kern-0.2emS$}}
-
- \lstnewenvironment{lstcode}{\lstset{language=[LaTeX]TeX}}{}
- \makeatother
- \sloppy% YOU SHOULD NOT DO THIS!!!
-
- \begin{document}
- \maketitle
- \tableofcontents
- \DocInput{\filename}
- \PrintChanges
- \PrintIndex
- \end{document}
+\documentclass[USenglish]{koma-script-source-doc}
+\usepackage{babel}
+\setcounter{StandardModuleDepth}{2}
+% We need (foo,bar)
+\DeclareRobustCommand*{\pparg}[2]{\texttt(\meta{#1}\texttt,\meta{#2}\texttt)}
+% and {foo:bar}
+\DeclareRobustCommand*{\mmarg}[2]{%
+ \texttt{\char`\{}\meta{#1}\texttt:\meta{#2}\texttt{\char`\}}}
+\begin{document}
+ \DocInput{scrlayer-scrpage.dtx}
+\end{document}
+%</dtx>
% \fi^^A meta-comment
%
-% \selectlanguage{english}
-%
% \changes{v0.0}{2012/01/01}{start of interface}
% \changes{v3.32}{2020/09/11}{do not use deprecated interface commands}
-% \let\restorechapter\chapter
-% \let\chapter\section
-% \let\section\subsection
-% \let\subsection\subsubsection
-%
-%\iffalse
-%</dtx>
-%\fi
-%
-% \StopEventually{}
-%
-% \chapter{Implementation of \Package{scrlayer-scrpage}}
+% \changes{v3.36}{2022/02/09}{switch over from \cls*{scrdoc} to
+% \cls*{koma-script-source-doc}}
+% \changes{v3.36}{2022/02/09}{require package \pkg*{scrlogo} instead of
+% defining \cs{KOMAScript}}
+% \changes{v3.36}{2022/02/09}{whole implementation documentation in English}
+%
+% \GetFileInfo{scrlayer-scrpage.dtx}
+% \title{The \texttt{scrlayer} Interface of
+% \href{https://komascript.de}{\KOMAScript} Package \pkg*{scrlayer-scrpage}}
+% \author{\href{mailto:komascript@gmx.info}{Markus Kohm}}
+% \date{Revision \fileversion{} of \filedate}
+% \maketitle
+% \begin{abstract}
+% This package defines several extensions above \pkg*{scrlayer} for easy
+% handling of pairs of \emph{headings} and \emph{plain} page styles. So this
+% widely is a replacement of the not any longer supported, former
+% \KOMAScript{} package \pkg{scrpage2}.
+% \end{abstract}
+% \tableofcontents
+%
+% \section{User Manual}
+%
+% You can find the user manuals of \pkg*{scrlayer-scrpage} in the \KOMAScript{}
+% manual, either the German \file{scrguide} or the English \file{scrguien}.
+%
+% \MaybeStop{\PrintIndex}
+%
+%
+% \section{Implementation of \pkg*{scrlayer-scrpage}}
% \label{sec:scrlayer-scrpage}
%
% This section if for developers only.
%
-% \iffalse
+% \begin{macrocode}
%<*interface>
-%<*identify>
-% \fi
-%
-%\iffalse
-%</identify>
-%\fi
-%
+% \end{macrocode}
+%
%
-% \section{Initialising some Values before the Options}
+% \subsection{Initialising some values before the options}
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%<*init>
-% \fi^^A meta-comment
+% \end{macrocode}
%
% Initialisation before all options (even the options from
-% \File{scrlayer.dtx}).
+% \file{scrlayer.dtx}).
%
-% Currently nothing.
+% Currently nothing to do.
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%</init>
-% \fi^^A meta-comment
+% \end{macrocode}
%
-% \section{Options}
%
-% \iffalse^^A meta-comment
-%<*options>
-% \fi
+% \subsection{Options}
%
-% Package \Package{scrpage2} doesn't support \KOMAScript{} options but only
-% regular \LaTeX{} package options. The interface will also support those
+% \begin{macrocode}
+%<*options>
+% \end{macrocode}
+%
+% Package \pkg{scrpage2} didn't support \KOMAScript{} options but only
+% regular \LaTeX{} package options. This interface will also support those
% options, but uses \KOMAScript{} options for the implementation. This
% results in additional features of the interface.
%
% Note, that some options are already defined before this by the common option
-% parts of \File{scrlayer.dtx}. All others will follow step by step in the
+% parts of \file{scrlayer.dtx}. All others will follow step by step in the
% main part.
%
-% Options \Option{headinclude}, \Option{headexclude}, \Option{footinclude} and
-% \Option{footexclude} of package \Package{scrpage2} are deprecated since
+% Options \opt{headinclude}, \opt{headexclude}, \opt{footinclude} and
+% \opt{footexclude} of package \pkg{scrpage2} are deprecated since
% package version 2.3, 2008-12-08. They won't be supported by the
-% \Package{scrlayer-scrpage} interface.
+% \pkg*{scrlayer-scrpage} interface.
%
% Additional initialisation may be done here, but currently this isn't
% needed.
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%</options>
-% \fi^^A meta-comment
-%
+% \end{macrocode}
+%
%
-% \section{Width of Header and Footer}
+% \subsection{Width of header and footer}
%
-% \Package{scrpage2} provided to set the width of the page head or footer
-% different from the width of the text area of the page using
-% \Macro{setheadwidth} and \Macro{setfootwidth}. Optionally those commands
-% allow to setup an horizontal offset for the head or footer. This interface
-% provides the same feature but also allows to set up the widths and offsets
-% with \KOMAScript{} options. Those options will become the primary interface.
+% \pkg{scrpage2} provided commands \cs{setheadwidth} and \cs{setfootwidth} to
+% set the width of the page head or footer different from the width of the
+% text area of the page. Optionally those commands allow to setup an
+% horizontal offset for the head or footer. This interface provides the same
+% feature but prefers to set up the widths and offsets with \KOMAScript{}
+% options. Those options will become the primary interface.
%
% \begin{option}{headwidth}
-% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}%^^A
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
+% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}
+% \changes{v3.17}{2015/02/25}{new: store the values}
% \begin{option}{footwidth}
-% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}%^^A
+% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}
% \changes{v3.15}{2014/12/28}{fix: missing colon in call of
-% \cs{sls@split@at@iicolons}}%^^A
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
-% \begin{description}
-% \item[\texttt{=\meta{special dimensional expression}:\meta{special
-% dimensional expression}}:] see \Macro{sls@settowidthof} for information
-% about the syntax of \meta{special dimensional expression}. The width of
-% the page head or footer will be set to the result of the first on, the
-% offset to the result of the second one. If the first one\,---\,the
-% width\,---\,is omitted, the current width will be used. If the second
-% one\,---\,the offset\,---\,is omitted and the width is the width of the
-% text area plus the margin note column, the offset will be set to
-% zero. If the second one is omitted and the width is not the width of the
-% text area plus the margin note column, a special kind of centering will
-% be used.
-% \end{description}
+% \cs{sls@split@at@iicolons}}
+% \changes{v3.17}{2015/02/25}{new: store the values}
+% \begin{description}
+% \item[\texttt{=\meta{special dimensional expression}:\meta{special
+% dimensional expression}}:] see \cs{sls@settowidthof} for information about
+% the syntax of \meta{special dimensional expression}. The width of the page
+% head or footer will be set to the result of the first on, the offset to
+% the result of the second one. If the first one\,---\,the width\,---\,is
+% omitted, the current width will be used. If the second one\,---\,the
+% offset\,---\,is omitted and the width is the width of the text area plus
+% the margin note column, the offset will be set to zero. If the second one
+% is omitted and the width is not the width of the text area plus the margin
+% note column, a special kind of centering will be used.
+% \end{description}
% These options may be used to set up the widths of head and foot.
% \begin{macrocode}
%<*options>
@@ -299,16 +230,15 @@
}
% \end{macrocode}
% \begin{macro}{\sls@split@at@iicolons}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{description}
-% \item[\texttt{\meta{balanced}:^^A
-% \meta{balanced}:^^A
-% \meta{balanced}\Macro{@nil}}:] first \meta{balanced} will be stored into
-% \Macro{reserved@a}, second into \Macro{reserved@b}, third will be eaten
-% and warn about if it is neither empty and nor a colon.
-% \end{description}
-% This little helper is used, e.g., by options \Option{headwidth} and
-% \Option{footwidth}.
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{description}
+% \item[\texttt{\meta{balanced}:\meta{balanced}:\meta{balanced}\cs{@nil}}:]
+% first \meta{balanced} will be stored into \cs{reserved@a}, second into
+% \cs{reserved@b}, third will be eaten and warn about if it is neither empty
+% and nor a colon.
+% \end{description}
+% This little helper is used, e.g., by options \opt{headwidth} and
+% \opt{footwidth}.
% \begin{macrocode}
\newcommand\sls@split@at@iicolons{}
\def\sls@split@at@iicolons#1:#2:#3:#4\@nil{%
@@ -328,17 +258,17 @@
\def\reserved@c{#3}%
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@split@at@iicolons
+% \end{macro}^^A \sls@split@at@iicolons
% \begin{macro}{\sls@set@hf@width}
% \changes{v0.9.1757}{2014/04/09}{new: two offsets available}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{description}
-% \item[\Parameter{head} or \Parameter{foot}:] to complete the macro names
-% for page head or footer.
-% \item[\Parameter{special dimensional expression}:] the offset odd page
-% \item[\Parameter{special dimensional expression}:] the offset even page
-% \item[\Parameter{special dimensional expression}:] the width
-% \end{description}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{description}
+% \item[\marg{head or foot}:] to complete the macro names for page head or
+% footer, either \texttt{head} or \texttt{foot}.
+% \item[\marg{special dimensional expression}:] the offset odd page
+% \item[\marg{special dimensional expression}:] the offset even page
+% \item[\marg{special dimensional expression}:] the width
+% \end{description}
% This helper will generally set up width an offset of either head or footer.
% \begin{macrocode}
\newcommand*{\sls@set@hf@width}[4]{%
@@ -396,13 +326,9 @@
\fi
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@set@hf@width
-% \begin{macro}{\sls@headwidth}
-% \begin{macro}{\sls@oddheadshift}
-% \begin{macro}{\sls@evenheadshift}
-% \begin{macro}{\sls@footwidth}
-% \begin{macro}{\sls@oddfootshift}
-% \begin{macro}{\sls@evenfootshift}
+% \end{macro}^^A \sls@set@hf@width
+% \begin{macro}{\sls@headwidth,\sls@oddheadshift,\sls@evenheadshift,
+% \sls@footwidth,\sls@oddfootshift,\sls@evenfootshift}
% To store width and offset of page head an footer, we use macros. Those are
% also used by the options and therefore need to be initialised before option
% usage.
@@ -426,17 +352,10 @@
\newcommand*{\sls@oddfootshift}{0pt}
\newcommand*{\sls@evenfootshift}{0pt}
% \end{macrocode}
-% \end{macro}%^^A \sls@headwidth
-% \end{macro}%^^A \sls@oddheadshift
-% \end{macro}%^^A \sls@evenheadshift
-% \end{macro}%^^A \sls@footwidth
-% \end{macro}%^^A \sls@oddfootshift
-% \end{macro}%^^A \sls@evenfootshift
-%
-% \begin{macro}{\sls@settowidthof}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{macro}{\sls@deftowidthof}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \end{macro}^^A \sls@headwidth … \sls@evenfootshift
+%
+% \begin{macro}{\sls@settowidthof,\sls@deftowidthof}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% the special dimensional expressions may be either one of the strings
% \texttt{paper}, \texttt{text}, \texttt{marginpar},
% \texttt{textwithmarginpar}, \texttt{head}, \texttt{foot},
@@ -513,62 +432,62 @@
}%
%</options>
% \end{macrocode}
-% \end{macro}%^^A \sls@deftowidthof
-% \end{macro}%^^A \sls@settowidthof
-% \end{option}%^^A footwidth
-% \end{option}%^^A footheight
+% \end{macro}^^A \sls@deftowidthof,\sls@settowidthof
+% \end{option}^^A footwidth
+% \end{option}^^A footheight
%
-% \begin{macro}{\setheadwidth}
-% \begin{macro}{\setfootwidth}
-% For compatibility with \Package{scrpage2}, map the commands to the options:
+% \begin{command}{\setheadwidth,\setfootwidth}
+% \changes{v3.36}{2022/02/09}{warning about deprecated command}
+% For compatibility with \pkg{scrpage2}, map the commands to the options:
% \begin{macrocode}
%<*body>
\newcommand*{\setheadwidth}[2][]{%
+ \PackageWarning{scrlayer-scrpage}{%
+ Command `\string\setheadwidth' is deprecated.\MessageBreak
+ I'm using \detokenize{\KOMAoptions{headwidth=#2:#1}} instead,\MessageBreak
+ and so should you do}%
\KOMAoptions{headwidth=#2:#1}%
}%
\newcommand*{\setfootwidth}[2][]{%
+ \PackageWarning{scrlayer-scrpage}{%
+ Command `\string\setfootwidth' is deprecated.\MessageBreak
+ I'm using \detokenize{\KOMAoptions{footwidth=#2:#1}} instead,\MessageBreak
+ and so should you do}%
\KOMAoptions{footwidth=#2:#1}%
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \setheadwidth
-% \end{macro}%^^A \setfootwidth
+% \end{command}^^A \setheadwidth,\setfootwidth
%
%
-% \section{Lines in Page Head and Footer}
+% \subsection{Lines in page head and footer}
%
-% The interface implements the options \Option{headtopline},
-% \Option{headsepline}, \Option{footsepline}, \Option{footbotline},
-% \Option{plainheadtopline}, \Option{plainheadsepline},
-% \Option{plainfootsepline}, \Option{plainfootbotline}, \Option{ilines},
-% \Option{clines}, and \Option{olines}, the commands \Macro{setheadtopline},
-% \Macro{setheadsepline}, \Macro{setfootsepline}, and \Macro{setfootbotline},
-% and the corresponding \KOMAScript{} font elements of package
-% \Package{scrpage2}. Some of the options are extended to understand
+% The interface implements the options \opt{headtopline}, \opt{headsepline},
+% \opt{footsepline}, \opt{footbotline}, \opt{plainheadtopline},
+% \opt{plainheadsepline}, \opt{plainfootsepline}, \opt{plainfootbotline},
+% \opt{ilines}, \opt{clines}, and \opt{olines}, the commands
+% \cs{setheadtopline}, \cs{setheadsepline}, \cs{setfootsepline}, and
+% \cs{setfootbotline}, and the corresponding \KOMAScript{} font elements of
+% package \pkg{scrpage2}. Some of the options are extended to understand
% values.
%
-% \begin{option}{headtopline}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
-% \begin{option}{headsepline}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
-% \begin{option}{footsepline}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
-% \begin{option}{footbotline}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
+% \begin{option}{headtopline,headsepline,footsepline,footbotline}
+% \changes{v3.17}{2015/02/25}{new: store the values}
% \begin{description}
% \item[{\texttt{=\meta{dimensional expression}:\meta{dimensional
% expression}}:}]
% \end{description}\noindent
% Define thickness and length of the a default separation line between:
% \begin{description}
-% \item[\Option{headtopline}:] the top margin of the page and the page head.
-% \item[\Option{headsepline}:] the page head and the text area.
-% \item[\Option{footsepline}:] the text area and the page footer.
-% \item[\Option{footbotline}:] the page footer and the bottom margin.
+% \item[\opt{headtopline}:] the top margin of the page and the page head.
+% \item[\opt{headsepline}:] the page head and the text area.
+% \item[\opt{footsepline}:] the text area and the page footer.
+% \item[\opt{footbotline}:] the page footer and the bottom margin.
% \end{description}
-% Both values may be omitted. In that case thickness would be 0.4\,pt, and
-% length would be the width of the page head or footer. If the second
-% argument, the length, has been omitted the \texttt{:} may also be omitted.
+% Both \meta{dimensional expression} values may be omitted. In that case
+% thickness would be 0.4\,pt, and length would be the width of the page head
+% or footer. If the second argument, the length, has been omitted the
+% \texttt{:} may also be omitted.
% \begin{macrocode}
%<*options>
\KOMA@key{headtopline}[:]{%
@@ -585,16 +504,15 @@
}
% \end{macrocode}
% \begin{macro}{\sls@set@values}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{description}
-% \item[\OParameter{option name}:] either empty or the name of the option
-% that sets the line,
-% \item[\Parameter{head or foot}:] either \texttt{head} or \texttt{foot},
-% \item[\Parameter{above or below}:] either \texttt{above} or
-% \texttt{below},
-% \item[\Parameter{dimension expression}\texttt{:}\Parameter{dimension
-% expression}] length an thickness of a line (both are optional).
-% \end{description}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{description}
+% \item[\oarg{option name}:] either empty or the name of the option that sets
+% the line,
+% \item[\marg{head or foot}:] either \texttt{head} or \texttt{foot},
+% \item[\marg{above or below}:] either \texttt{above} or \texttt{below},
+% \item[\mmarg{dimension expression}{dimension expression}:] length an
+% thickness of a line (both are optional).
+% \end{description}
% Helper macros for the options to set two macros by two values of one
% option. The two values are separated by a colon.
% \begin{macrocode}
@@ -656,18 +574,17 @@
}%
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@set@values
+% \end{macro}^^A \sls@set@values
% \begin{macro}{\sls@split@at@colon}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{description}
-% \item[\texttt{\meta{balanced}:^^A
-% \meta{balanced}:^^A
-% \meta{balanced}\Macro{@nil}}:] first \meta{balanced} will be stored into
-% \Macro{reserved@a}, second into \Macro{reserved@b}, third will be eaten
-% and warn about if it is neither empty and nor a colon.
-% \end{description}
-% This little helper is used, e.g., by options \Option{headwidth} and
-% \Option{footwidth}.
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{description}
+% \item[\texttt{\meta{balanced}:\meta{balanced}:\meta{balanced}\cs{@nil}}:]
+% first \meta{balanced} will be stored into \cs{reserved@a}, second into
+% \cs{reserved@b}, third will be eaten and warn about if it is neither empty
+% and nor a colon.
+% \end{description}
+% This little helper is used, e.g., by options \opt{headwidth} and
+% \opt{footwidth}.
% \begin{macrocode}
\newcommand*{\sls@split@at@colon}{}
\def\sls@split@at@colon#1:#2:#3\@nil{%
@@ -684,15 +601,11 @@
\def\reserved@b{#2}%
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@split@at@colon
-% \begin{macro}{\sls@headabove@linelength}
-% \begin{macro}{\sls@headabove@linethickness}
-% \begin{macro}{\sls@headbelow@linelength}
-% \begin{macro}{\sls@headbelow@linethickness}
-% \begin{macro}{\sls@footabove@linelength}
-% \begin{macro}{\sls@footabove@linethickness}
-% \begin{macro}{\sls@footbelow@linelength}
-% \begin{macro}{\sls@footbelow@linethickness}
+% \end{macro}^^A \sls@split@at@colon
+% \begin{macro}{\sls@headabove@linelength,\sls@headabove@linethickness,
+% \sls@headbelow@linelength,\sls@headbelow@linethickness,
+% \sls@footabove@linelength,\sls@footabove@linethickness,
+% \sls@footbelow@linelength,\sls@footbelow@linethickness}
% To store length and thickness of the lines at the page head an footer, we
% use macros. Those are also used by the options and therefore need to be
% initialised before option usage.
@@ -723,27 +636,19 @@
}
%</options>
% \end{macrocode}
-% \end{macro}%^^A \sls@footbelow@linethickness
-% \end{macro}%^^A \sls@footbelow@linelength
-% \end{macro}%^^A \sls@footabove@linethickness
-% \end{macro}%^^A \sls@footabove@linelength
-% \end{macro}%^^A \sls@headbelow@linethickness
-% \end{macro}%^^A \sls@headbelow@linelength
-% \end{macro}%^^A \sls@headabove@linethickness
-% \end{macro}%^^A \sls@headabove@linelength
-% \end{option}%^^A footbotline
-% \end{option}%^^A footsepline
-% \end{option}%^^A headsepline
-% \end{option}%^^A headtopline
-%
-% \begin{option}{plainheadtopline}
-% \begin{macro}{\ifsls@plain@head@above@line}
-% \begin{option}{plainheadsepline}
-% \begin{macro}{\ifsls@plain@head@below@line}
-% \begin{option}{plainfootsepline}
-% \begin{macro}{\ifsls@plain@foot@above@line}
-% \begin{option}{plainfootbotline}
-% \begin{macro}{\ifsls@plain@foot@below@line}
+% \end{macro}^^A \sls@headabove@linelength … \sls@footbelow@linethickness
+% \end{option}^^A headtopline … footbotline
+%
+% \begin{option}{plainheadtopline,plainheadsepline,
+% plainfootsepline,plainfootbotline}
+% \begin{macro}{\ifsls@plain@head@above@line,\sls@plain@head@above@linetrue,
+% \sls@plain@head@above@linefalse,
+% \ifsls@plain@head@below@line,\sls@plain@head@below@linetrue,
+% \sls@plain@head@below@linefalse,
+% \ifsls@plain@foot@above@line,\sls@plain@foot@above@linetrue,
+% \sls@plain@foot@above@linefalse,
+% \ifsls@plain@foot@below@line,\sls@plain@foot@below@linetrue,
+% \sls@plain@foot@below@linefalse}
% \begin{description}
% \item[\texttt{=\meta{switch value}}:]
% \end{description}\noindent
@@ -756,24 +661,14 @@
\KOMA@ifkey{plainfootbotline}{sls@plain@foot@below@line}%
%</options>
% \end{macrocode}
-% \end{macro}%^^A \ifsls@plain@foot@below@line
-% \end{option}%^^A plainfootbotline
-% \end{macro}%^^A \ifsls@plain@foot@above@line
-% \end{option}%^^A plainfootsepline
-% \end{macro}%^^A \ifsls@plain@head@below@line
-% \end{option}%^^A plainheadsepline
-% \end{macro}%^^A \ifsls@plain@head@above@line
-% \end{option}%^^A plainheadtopline
-%
-% \begin{option}{ilines}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
-% \begin{option}{clines}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
-% \begin{option}{olines}
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
+% \end{macro}^^A \ifsls@plain@foot@below@line … \sls@plain@foot@below@linefalse
+% \end{option}^^A plainheadtopline … plainfootbotline
+%
+% \begin{option}{ilines,clines,olines}
+% \changes{v3.17}{2015/02/25}{storing values}
% \begin{macro}{\sls@hfline@adjust}
% Maybe it would be more useful to be able to adjust each line on its own or
-% at most to define an offset. But \Package{scrpage2} supports only these
+% at most to define an offset. But \pkg{scrpage2} supports only these
% options. At least we can set the options inside a layer or page style. This
% may help.
% \begin{macrocode}
@@ -819,24 +714,20 @@
\KOMA@kav@add{.scrlayer-scrpage.sty}{ilines}{}
%</options>
% \end{macrocode}
-% \end{macro}%^^A \sls@hfline@adjust
-% \end{option}%^^A olines
-% \end{option}%^^A clines
-% \end{option}%^^A ilines
-%
-% \begin{macro}{\setheadtopline}
-% \begin{macro}{\setheadsepline}
-% \begin{macro}{\setfootsepline}
-% \begin{macro}{\setfootbotline}
-% \begin{description}
-% \item[\OParameter{extended dimensional expression}:] the length of the
-% line; if omitted the length will use the width of the page head or
-% footer while printing the line.
-% \item[\Parameter{dimensional expression}:] the thickness of the line.
-% \item[\OParameter{code}:] the font selection code for the line. You may
-% use it for any kind of operation, that doesn't change the position,
-% width, height, or depth, e.g., to change the colour of the line.
-% \end{description}
+% \end{macro}^^A \sls@hfline@adjust
+% \end{option}^^A ilines … olines
+%
+% \begin{command}{\setheadtopline,\setheadsepline,
+% \setfootsepline,\setfootbotline}
+% \begin{description}
+% \item[\oarg{extended dimensional expression}:] the length of the line; if
+% omitted the length will use the width of the page head or footer while
+% printing the line.
+% \item[\marg{dimensional expression}:] the thickness of the line.
+% \item[\oarg{code}:] the font selection code for the line. You may use it for
+% any kind of operation, that doesn't change the position, width, height, or
+% depth, e.g., to change the colour of the line.
+% \end{description}
% \begin{macrocode}
%<*body>
\newcommand*{\setheadtopline}{\sls@setline{head}{above}}%
@@ -846,17 +737,17 @@
% \end{macrocode}
% \begin{macro}{\sls@setline}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
% \begin{macro}{\sls@@setline}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% \begin{macro}{\sls@@@setline}
-% \changes{v3.17}[2015/02/27]{internal use of the corresponding options}%^^A
+% \changes{v3.17}[2015/02/27]{internal use of the corresponding options}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \cs{kernel@ifnextchar}}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% \begin{macro}{\sls@@@@setline}
-% \changes{v3.18}{2015/06/17}{explicit reuse of the current length}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \changes{v3.18}{2015/06/17}{explicit reuse of the current length}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% Helper to set up the line attributes processing the parameters of the
% commands above.
% \begin{macrocode}
@@ -927,15 +818,12 @@
}%
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@setline
-% \end{macro}%^^A \sls@@setline
-% \end{macro}%^^A \sls@@@setline
-% \end{macro}%^^A \sls@@@@setline
-% \begin{KOMAfont}{headtopline}
-% \begin{KOMAfont}{headsepline}
-% \begin{KOMAfont}{footsepline}
-% \begin{KOMAfont}{footbotline}
-% These are the font elements used in \Macro{sls@hf@rule} to set the rules
+% \end{macro}^^A \sls@setline
+% \end{macro}^^A \sls@@setline
+% \end{macro}^^A \sls@@@setline
+% \end{macro}^^A \sls@@@@setline
+% \begin{fontelement}{headtopline,headsepline,footsepline,footbotline}
+% These are the font elements used in \cs{sls@hf@rule} to set the rules
% with, i.e., another colour. Note, that those may already be defined and
% become only part of the interface if they are not.
% \begin{macrocode}
@@ -953,23 +841,15 @@
}{}
%</body>
% \end{macrocode}
-% \end{KOMAfont}%^^A footbotline
-% \end{KOMAfont}%^^A footsepline
-% \end{KOMAfont}%^^A headsepline
-% \end{KOMAfont}%^^A headtopline
-% \end{macro}%^^A \setfootbotline
-% \end{macro}%^^A \setfootsepline
-% \end{macro}%^^A \setheadsepline
-% \end{macro}%^^A \setheadtopline
-%
-% \begin{length}{\headheight}
-% \changes{v3.24}{2017/05/22}{warning depends on option
-% \texttt{singlespacing}}%^^A
-% Some classes set \Length{headheight} to a very, very small value. We'll
-% warn about that.
-% \begin{length}{\footheight}
-% \changes{v3.24}{2017/05/23}{also warn for low \cs{footheight}}%^^A
-% If the \Length{headheight} is OK, we also test for \Length{footheight}.
+% \end{fontelement}^^A headtopline … footbotline
+% \end{command}^^A \setheadtopline … \setfootbotline
+%
+% \begin{length}{\headheight,\footheight}
+% \changes{v3.24}{2017/05/22}{warning depends on option \opt{singlespacing}}
+% Some classes set \len{headheight} to a very, very small value. We'll
+% warn about that.
+% \changes{v3.24}{2017/05/23}{also warn for low \cs{footheight}}
+% If the \len{headheight} is OK, we also test for \len{footheight}.
% \begin{macrocode}
%<*body>
\AtBeginDocument{%
@@ -1033,40 +913,40 @@
}
%</body>
% \end{macrocode}
-% \end{length}%^^A \footheight
-% \end{length}%^^A \headheight
+% \end{length}^^A \headheight,\footheight
%
%
-% \section{Usual \LaTeX{} Kernel Commands}
+% \subsection{Usual \LaTeX{} kernel commands}
%
-% \Package{scrlayer-scrpage} some usual \LaTeX{} kernel commands, that should
-% really behave like the original \LaTeX{} kernel commands do. But some
+% \pkg*{scrlayer-scrpage} uses some very usual \LaTeX{} kernel commands, that
+% should really behave like the original \LaTeX{} kernel commands do. But some
% packages redefine them without restoring them in the output routine before
% the page head and foot is build. Such a redefinition could break
-% \Package{scrlayer-scrpage} or even provoke errors. Here we try to make sure,
-% that \Package{scrlayer-scrpage} uses the correct definitions. Note: This
-% should not be needed, if other packages would be more careful.
-%
-% \begin{macro}{\LaTeXcentering}
-% \changes{v3.27}{2019/04/05}{added}%^^A
-% \begin{macro}{\raggedright}
-% \changes{v3.27}{2019/04/05}{added}%^^A
-% \begin{macro}{\raggedleft}
-% \changes{v3.27}{2019/04/05}{added}%^^A
-% \Package{scrlayer-scrpage} needs \cs{centering} to center, \cs{raggedright}
+% \pkg*{scrlayer-scrpage} or even provoke errors. Here we try to make sure,
+% that \pkg*{scrlayer-scrpage} uses the correct definitions. Note: This should
+% not be needed, if other packages would be more careful.
+%
+% \begin{command}{\LaTeXcentering,\LaTeXraggedright,\LaTeXraggedleft}
+% \changes{v3.27}{2019/04/05}{added}
+% \pkg*{scrlayer-scrpage} needs \cs{centering} to center, \cs{raggedright}
% to left align and \cs{raggedleft} to right align the three elements of
-% three-part header and footer. \Package{ragged2e} optionally redefines
-% them. This is not perfect but does not break \Package{scrlayer-scrpage}
-% completely. But \Package{tabu} also redefines them an that breaks
-% \Package{scrlayer-scrpage} in a way, that even error messages can occur. So
-% from version 3.27 \Package{scrlayer-scrpage} does not longer use
-% \cs{centering}, \cs{raggedright} or \cs{raggedleft} but \cs{LaTeXcentering},
-% \cs{LaTeXraggedright} and \cs{LaTeXraggedleft}. With \Package{ragged2e} and
-% its option \texttt{newcommands}/\texttt{NewCommands} this would be already
-% defined and contain the original definition. On all other circumstances the
-% commands have to be defined. But these commands should not be defined as
-% part of the interface or removing the interface could break other packages
-% like \Package{ragged2e}.
+% three-part header and footer. \pkg{ragged2e} optionally redefines them. This
+% is not perfect but does not break \pkg*{scrlayer-scrpage} completely. But
+% \pkg{tabu}\footnote{Note, package \pkg{tabu} is not officially maintained by
+% anyone for several years. Unofficially some members of The \LaTeX{} Team
+% fix some problems related to new \LaTeX{} kernel changes. But the package
+% is without support for all other problems, even if they are known for
+% years. But you have to decide yourself, whether it is a good idea to use
+% such packages.} also redefines them an that breaks \pkg*{scrlayer-scrpage}
+% in a way, that even error messages can occur. So from version~3.27
+% \pkg*{scrlayer-scrpage} does not longer use \cs{centering}, \cs{raggedright}
+% or \cs{raggedleft} but \cs{LaTeXcentering}, \cs{LaTeXraggedright} and
+% \cs{LaTeXraggedleft}. With \pkg{ragged2e} and its option
+% \opt{newcommands}/\opt{NewCommands} this would be already defined and
+% contain the original definition. On all other circumstances the commands
+% have to be defined. But these commands should not be defined as part of the
+% interface or removing the interface could break other packages like
+% \pkg{ragged2e}.
% \begin{macrocode}
%<*body>
\@ifundefined{LaTeXcentering}{\let\LaTeXcentering\centering}{}
@@ -1074,23 +954,21 @@
\@ifundefined{LaTeXraggedright}{\let\LaTeXraggedright\raggedright}{}
%</body>
% \end{macrocode}
-% \end{macro}
-% \end{macro}
-% \end{macro}
+% \end{command}^^A \LaTeXcentering … \LaTeXraggedright
+%
%
-% \section{Style of Running Heads}
+% \subsection{Style of running heads}
%
-% This implements not only options \Option{komastyle} and
-% \Option{standardstyle} of \Package{scrpage2}, but also activates the default
-% style at the end of the package and takes care for the correct overwrite
-% behaviour of option \Option{markcase}.
+% This implements not only options \opt{komastyle} and \opt{standardstyle} of
+% \pkg{scrpage2}, but also activates the default style at the end of the
+% package and takes care for the correct behave of option \opt{markcase}.
%
% \begin{option}{pagestyleset}
-% \begin{description}
-% \item[\texttt{=\meta{string}}:] a valid name of a predefined
-% style-set. Currently only \texttt{KOMA-Script} and \texttt{standard} are
-% supported. Maybe more will follow.
-% \end{description}
+% \begin{description}
+% \item[\texttt{=\meta{string}}:] a valid name of a predefined
+% style-set. Currently only \optvalue{KOMA-Script} and \optvalue{standard}
+% are supported. Maybe more will follow.
+% \end{description}
% Note, that the following automatic style activation must be before the
% first option usage:
% \begin{macrocode}
@@ -1100,7 +978,7 @@
}
% \end{macrocode}
% \begin{macro}{\sls@auto@pagestyleset}
-% \changes{v0.9}{2014/01/22}{new (internal) macro}%^^A
+% \changes{v0.9}{2014/01/22}{added}
% \begin{macrocode}
\newcommand*{\sls@auto@pagestyleset}{%
\scr@ifundefinedorrelax{KOMAClassName}{%
@@ -1116,8 +994,8 @@
}
%</init>
% \end{macrocode}
-% \end{macro}%^^A \sls@auto@pagestyleset
-% \changes{v3.17}{2015/02/25}{new: store the values}%^^A
+% \end{macro}^^A \sls@auto@pagestyleset
+% \changes{v3.17}{2015/02/25}{storing the values}
% \begin{macrocode}
%<*options>
\KOMA@key{pagestyleset}{%
@@ -1131,10 +1009,8 @@
}%
}
% \end{macrocode}
-% \begin{macro}{\sls@ps@style@standard}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{macro}{\sls@ps@style@KOMA-Script}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{macro}{\sls@ps@style@standard,\sls@ps@style@KOMA-Script}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% These are the predefined page style sets.
% \begin{macrocode}
\newcommand*{\sls@ps@style@standard}{%
@@ -1159,9 +1035,9 @@
\scr@ifundefinedorrelax{KOMAClassName}{}{%
\Ifstr{\KOMAClassName}{scrlttr2}{%
% \end{macrocode}
-% We are using \Class{scrlttr2}, so we have to initialise the page style
+% We are using \cls*{scrlttr2}, so we have to initialise the page style
% different:
-% \changes{v3.18}{2015/06/24}{missing \cs{lofoot} and \cs{rofoot} added}%^^A
+% \changes{v3.18}{2015/06/24}{missing \cs{lofoot} and \cs{rofoot} added}
% \begin{macrocode}
\clearpairofpagestyles
\lehead[\ifnum\@pageat=\z@\pagemark\fi]
@@ -1192,14 +1068,12 @@
}%
%</options>
% \end{macrocode}
-% \end{macro}%^^A \sls@ps@style@KOMA-Script
-% \end{macro}%^^A \sls@ps@style@standard
-% \end{option}%^^A pagestyleset
+% \end{macro}^^A \sls@ps@style@standard,\sls@ps@style@KOMA-Script
+% \end{option}^^A pagestyleset
%
-% \begin{option}{komastyle}
-% \begin{option}{standardstyle}
+% \begin{option}{komastyle,standardstyle}
% These options are deprecated, but defined for compatibility with
-% \Package{scrpage2}:
+% \pkg{scrpage2}:
% \begin{macrocode}
%<*options>
\KOMA@DeclareDeprecatedOption[scrlayer-scrpage]{komastyle}{%
@@ -1208,20 +1082,17 @@
pagestyleset=standard}
%</options>
% \end{macrocode}
-% \end{option}%^^A standardstyle
-% \end{option}%^^A komastyle
+% \end{option}^^A komastyle,standardstyle
%
%
-% \section{Extended Mark Mechanisms}
+% \subsection{Extended mark mechanisms}
%
-% Package options \Option{markuppercase}, \Option{markusedcase}, and
-% \Option{nouppercase} of package \Package{scrpage2} will be mapped to
-% \KOMAScript{} option \Option{markcase}.
+% Package options \opt{markuppercase}, \opt{markusedcase}, and
+% \opt{nouppercase} of package \pkg{scrpage2} are mapped to \KOMAScript{}
+% option \opt{markcase}.
%
-% \begin{option}{markuppercase}
-% \begin{option}{markusedcase}
-% \begin{option}{nouppercase}
-% For compatibility with \Package{scrpage2}.
+% \begin{option}{markuppercase,markusedcase,nouppercase}
+% For compatibility with \pkg{scrpage2}.
% \begin{macrocode}
%<*options>
\KOMA@DeclareDeprecatedOption[scrlayer-scrpage]{markuppercase}{markcase=upper}
@@ -1231,18 +1102,15 @@
}
%</options>
% \end{macrocode}
-% \end{option}%^^A nouppercase
-% \end{option}%^^A markusedcase
-% \end{option}%^^A markuppercase
+% \end{option}^^A markuppercase … nouppercase
%
%
-% \section{Expert Page Style Definition Interface}
+% \subsection{Expert page style definition interface}
%
-% This is the low level interface of \Package{scrpage2} with
-% \Macro{defpagestyle}, \Macro{newpagestyle}, \Macro{renewpagestyle}, and
-% \Macro{providepagestyle}. We will also define is. In difference to
-% \Package{scrpage2} layers are used. Following layers will be defined for
-% each page style:
+% This is the low level interface of \pkg{scrpage2} with \cs{defpagestyle},
+% \cs{newpagestyle}, \cs{renewpagestyle}, and \cs{providepagestyle}. We will
+% also define is. In difference to \pkg{scrpage2} layers are used. Following
+% layers will be defined for each page style:
% \begin{description}
% \item[\texttt{\meta{page style name}.head.above.line}] line above the head
% \item[\texttt{\meta{page style name}.head.odd}] odd page head (only twoside)
@@ -1261,23 +1129,24 @@
% \item[\texttt{\meta{page style name}.foot.below.line}] line below the footer
% (only oneside)
% \end{description}
-% Note: \Package{scrpage2} also provides starred versions of the page style
+% Note: \pkg{scrpage2} also provided star versions of the page style
% definition commands, doing the same like the starless versions. This has
-% been done for compatibility reasons with deprecated \Package{scrpage} and
-% may be removed some times. The layer interface doesn't support this.
-%
-%
-% \begin{macro}{\defpagestyle}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be defined (must
-% be fully expandable and expand to a string only).
-% \item[\Parameter{head/foot definition}:] will be used to define the
-% head (see \Macro{sls@defhead}).
-% \item[\Parameter{head/foot definition}:] will be used to define the
-% foot (see \Macro{sls@deffoot}).
-% \end{description}
-% See \Package{scrpage2} implementation.
+% been done for compatibility reasons with deprecated
+% \pkg[https://www.ctan.org/pkg/koma-script-obsolete]{scrpage} and has been
+% described as to be removed some times. The layer interface doesn't support
+% this any longer.
+%
+%
+% \begin{command}{\defpagestyle}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{description}
+% \item[\marg{string}:] the name of the page style to be defined (must be
+% fully expandable and expand to a string only).
+% \item[\marg{head/foot definition}:] will be used to define the head (see
+% \cs{sls@defhead}).
+% \item[\marg{head/foot definition}:] will be used to define the foot (see
+% \cs{sls@deffoot}).
+% \end{description}
% \begin{macrocode}
%<*body>
\newcommand*{\defpagestyle}[3]{%
@@ -1291,31 +1160,27 @@
}%
}%
% \end{macrocode}
-% \begin{macro}{\sls@defhead}
-% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\sls@@defhead}
+% \begin{macro}{\sls@defhead,\sls@@defhead}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
% \begin{macro}{\sls@@@defhead}
-% \changes{v0.9}{2014/08/18}{fix names of layers \texttt{\dots head.odd} and
-% \texttt{\dots head.even}}%^^A
-% \begin{description}
-% \item[\MParameter{dimensional expression}{dimensional expression}:] length
-% and thickness of a line (ruler) above the page head. May be omitted and
-% if so the values from option \Option{headtopline} will be used.
-% \item[\Parameter{code}:] will be executed on even pages; used to define
-% the contents of layer \texttt{\meta{page style name}.head.even}.
-% \item[\Parameter{code}:] will be executed on odd pages within two-side
-% layout; used to define the contents of layer \texttt{\meta{page style
-% name}.head.odd}.
-% \item[\Parameter{code}:] will be executed on single-side pages; used to
-% define the contents of layer \texttt{\meta{page style
-% name}.head.oneside}.
-% \item[\MParameter{dimensional expression}{dimensional expression}:] length
-% and thickness of a line (ruler) below the page head. May be omitted and
-% if so the values from option \Option{headsepline} will be used.
-% \end{description}
+% \changes{v0.9}{2014/08/18}{fixed names of layers \texttt{\dots head.odd} and
+% \texttt{\dots head.even}}
+% \begin{description}
+% \item[\pparg{dimensional expression}{dimensional expression}:] length and
+% thickness of a line (ruler) above the page head. May be omitted and if so
+% the values from option \opt{headtopline} will be used.
+% \item[\marg{code}:] will be executed on even pages; used to define the
+% contents of layer \texttt{\meta{page style name}.head.even}.
+% \item[\marg{code}:] will be executed on odd pages within two-side layout;
+% used to define the contents of layer \texttt{\meta{page style
+% name}.head.odd}.
+% \item[\marg{code}:] will be executed on single-side pages; used to define
+% the contents of layer \texttt{\meta{page style name}.head.oneside}.
+% \item[\pparg{dimensional expression}{dimensional expression}:] length and
+% thickness of a line (ruler) below the page head. May be omitted and if so
+% the values from option \opt{headsepline} will be used.
+% \end{description}
% Helper to define the head layers.
% \begin{macrocode}
\newcommand*\sls@defhead[1]{%
@@ -1364,7 +1229,7 @@
% \end{macrocode}
% The odd side, even side and one side:
% \changes{v3.13b}{2014/10/16}{workaround: additional group added to avoid
-% pdf\TeX{} color stack warnings}%^^A
+% pdf\TeX{} color stack warnings}
% \begin{macrocode}
\DeclareLayer[%
background,evenpage,twoside,%
@@ -1395,31 +1260,27 @@
]{#1.head.oneside}%
}%
% \end{macrocode}
-% \begin{macro}{\sls@deffoot}
+% \begin{macro}{\sls@deffoot,\sls@@deffoot}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\sls@@deffoot}
-% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
% \begin{macro}{\sls@@@deffoot}
-% \changes{v0.9}{2014/08/18}{fix names of layers \texttt{\dots foot.odd} and
-% \texttt{\dots foot.even}}%^^A
-% \begin{description}
-% \item[\MParameter{dimensional expression}{dimensional expression}:] length
-% and thickness of a line (ruler) above the page footer. May be omitted
-% and if so the values from option \Option{footsepline} will be used.
-% \item[\Parameter{code}:] will be executed on even pages; used to define
-% the contents of layer \texttt{\meta{page style name}.foot.even}.
-% \item[\Parameter{code}:] will be executed on odd pages within two-side
-% layout; used to define the contents of layer \texttt{\meta{page style
-% name}.foot.odd}.
-% \item[\Parameter{code}:] will be executed on single-side pages; used to
-% define the contents of layer \texttt{\meta{page style
-% name}.foot.oneside}.
-% \item[\MParameter{dimensional expression}{dimensional expression}:] length
-% and thickness of a line (ruler) below the page footer. May be omitted
-% and if so the values from option \Option{footbotline} will be used.
-% \end{description}
+% \changes{v0.9}{2014/08/18}{fixed names of layers \texttt{\dots foot.odd} and
+% \texttt{\dots foot.even}}
+% \begin{description}
+% \item[\pparg{dimensional expression}{dimensional expression}:] length and
+% thickness of a line (ruler) above the page footer. May be omitted and if
+% so the values from option \opt{footsepline} will be used.
+% \item[\marg{code}:] will be executed on even pages; used to define the
+% contents of layer \texttt{\meta{page style name}.foot.even}.
+% \item[\marg{code}:] will be executed on odd pages within two-side layout;
+% used to define the contents of layer \texttt{\meta{page style
+% name}.foot.odd}.
+% \item[\marg{code}:] will be executed on single-side pages; used to define
+% the contents of layer \texttt{\meta{page style name}.foot.oneside}.
+% \item[\pparg{dimensional expression}{dimensional expression}:] length and
+% thickness of a line (ruler) below the page footer. May be omitted and if
+% so the values from option \opt{footbotline} will be used.
+% \end{description}
% Helper to define the foot layers.
% \begin{macrocode}
\newcommand*\sls@deffoot[1]{%
@@ -1509,10 +1370,10 @@
% \begin{macro}{\sls@secure@box}
% \changes{v3.34}{2021/05/16}{\LaTeX{} team requested for additional \cs{par}}
% \begin{description}
-% \item[\Parameter{length}:] a \LaTeX{} length, that gives the maximum
+% \item[\marg{length}:] a \LaTeX{} length, that gives the maximum
% height + depth of the \meta{content}. It has to be either
% \cs{headheight} or \cs{footheight}.
-% \item[\Parameter{content}:] what should be output (inside the box).
+% \item[\marg{content}:] what should be output (inside the box).
% \end{description}
% Note, that several length may be changed, to fit.
% \begin{macrocode}
@@ -1586,9 +1447,9 @@
\KOMA@ifkey{hmode}{sls@leavevmode}
%</options>
% \end{macrocode}
-% \end{option}%^^A hmode
+% \end{option}^^A hmode
% \begin{option}{autoenlargeheadfoot}
-% \changes{v3.25}{2018/01/14}{new option}%^^A
+% \changes{v3.25}{2018/01/14}{added}
% Automaticly enlarge vertical size of head or foot if the contents is to
% large. This is the default.
% \begin{macrocode}
@@ -1597,22 +1458,19 @@
\KOMAExecuteOptions{autoenlargeheadfoot=true}
%</options>
% \end{macrocode}
-% \end{option}%^^A autoenlargeheadfoot
-% \end{macro}%^^A \sls@secure@box
-% \end{macro}%^^A \sls@@@deffoot
-% \end{macro}%^^A \sls@@deffoot
-% \end{macro}%^^A \sls@deffoot
-% \end{macro}%^^A \sls@@@defhead
-% \end{macro}%^^A \sls@@defhead
-% \end{macro}%^^A \sls@defhead
-% \begin{macro}{\headfont}
+% \end{option}^^A autoenlargeheadfoot
+% \end{macro}^^A \sls@secure@box
+% \end{macro}^^A \sls@@@deffoot
+% \end{macro}^^A \sls@deffoot,\sls@@deffoot
+% \end{macro}^^A \sls@@@defhead
+% \end{macro}^^A \sls@defhead,\sls@@defhead
+% \begin{command}{\headfont}
% The low level page head font command. It is deprecated to redefine or use
% this and it may already be defined.
% \begin{macro}{\scr@fnt@pagehead}
-% \changes{v3.25}{2018/02/05}{don't use \cs{newkomafont} to avoid
-% warning}%^^A
+% \changes{v3.25}{2018/02/05}{don't use \cs{newkomafont} to avoid warning}
% \begin{macro}{\scr@fnt@wrn@pagehead}
-% \changes{v0.9}{2014/01/13}{warning always deactivated}%^^A
+% \changes{v0.9}{2014/01/13}{warning always deactivated}
% \begin{macro}{\scr@fnt@pageheadfoot}
% \begin{macrocode}
%<*body>
@@ -1642,12 +1500,12 @@
\let\scr@fnt@wrn@pagehead\relax
}
% \end{macrocode}
-% \end{macro}%^^A \scr@fnt@pageheadfoot
-% \end{macro}%^^A \scr@fnt@wrn@pagehead
-% \end{macro}%^^A \scr@fnt@pagehead
-% \end{macro}%^^A \headfont
+% \end{macro}^^A \scr@fnt@pageheadfoot
+% \end{macro}^^A \scr@fnt@wrn@pagehead
+% \end{macro}^^A \scr@fnt@pagehead
+% \end{command}^^A \headfont
%
-% \begin{macro}{\footfont}
+% \begin{command}{\footfont}
% The low level page footer font command. It is deprecated to redefine or use
% this and it may already be defined.
% \begin{macro}{\scr@fnt@pagefoot}
@@ -1667,17 +1525,17 @@
\let\scr@fnt@wrn@pagefoot\relax
}
% \end{macrocode}
-% \end{macro}%^^A \scr@fnt@wrn@pagefoot
-% \end{macro}%^^A \scr@fnt@pagefoot
-% \end{macro}%^^A \footfont
+% \end{macro}^^A \scr@fnt@wrn@pagefoot
+% \end{macro}^^A \scr@fnt@pagefoot
+% \end{command}^^A \footfont
%
% \begin{macro}{\sls@hf@rule}
% \changes{v3.34}{2021/05/16}{\LaTeX{} team requested for additional \cs{par}}
% \begin{description}
-% \item[\Parameter{rule name}:] one of \texttt{headtop}, \texttt{headsep},
+% \item[\marg{rule name}:] one of \texttt{headtop}, \texttt{headsep},
% \texttt{footsep}, or \texttt{footbot}
-% \item[\Parameter{dimensional expression}:] the line length (width)
-% \item[\Parameter{dimensional expression}:] the line thickness (height)
+% \item[\marg{dimensional expression}:] the line length (width)
+% \item[\marg{dimensional expression}:] the line thickness (height)
% \end{description}
% Helper to draw the line.
% \begin{macrocode}
@@ -1707,9 +1565,8 @@
\endgroup
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@hf@rule
-% \begin{macro}{\sls@topmargin}
-% \begin{macro}{\sls@leftmargin}
+% \end{macro}^^A \sls@hf@rule
+% \begin{macro}{\sls@topmargin,\sls@leftmargin}
% Two simple helper macros:
% \begin{macrocode}
\newcommand*{\sls@topmargin}{\dimexpr\topmargin+1in\relax}%
@@ -1728,17 +1585,15 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \sls@leftmargin
-% \end{macro}%^^A \sls@topmargin
-% \end{macro}%^^A \defpagestyle
+% \end{macro}^^A \sls@topmargin … \sls@leftmargin
+% \end{command}^^A \defpagestyle
%
-% \begin{macro}{\newpagestyle}
-% \changes{v3.32}{2020/09/11}{test for \textsf{titlesec}}
-% For the parameters see \Macro{defpagestyle}.
-% Define the pagestyle only, if not already defined. Unfortunately
-% \textsf{titlesec} also defines this command. So new definition will
-% fail. \textsf{titlesec} uses \cs{providecommand} so if the order would be
-% changed, everything would be OK.
+% \begin{command}{\newpagestyle}
+% \changes{v3.32}{2020/09/11}{test for \pkg{titlesec}}
+% For the parameters see \cs{defpagestyle}. Define the pagestyle only, if not
+% already defined. Unfortunately \pkg{titlesec} also defines this command. So
+% new definition will fail. \textsf{titlesec} uses \cs{providecommand} so if
+% the order would be changed, everything would be OK.
% \begin{macrocode}
%<*body>
\@ifpackageloaded{titlesec}{%
@@ -1773,15 +1628,14 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \newpagestyle
+% \end{command}^^A \newpagestyle
%
-% \begin{macro}{\renewpagestyle}
+% \begin{command}{\renewpagestyle}
% \changes{v3.32}{2020/09/11}{test for \textsf{titlesec}}
-% For the parameters see \Macro{defpagestyle}.
-% Define the pagestyle only, if not already defined. Unfortunately
-% \textsf{titlesec} also defines this command. So new definition will
-% fail. \textsf{titlesec} uses \cs{providecommand} so if the order would be
-% changed, everything would be OK.
+% For the parameters see \cs{defpagestyle}. Define the pagestyle only, if not
+% already defined. Unfortunately \textsf{titlesec} also defines this
+% command. So new definition will fail. \textsf{titlesec} uses
+% \cs{providecommand} so if the order would be changed, everything would be OK.
% \begin{macrocode}
%<*body>
\@ifpackageloaded{titlesec}{%
@@ -1818,11 +1672,10 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \renewpagestyle
+% \end{command}^^A \renewpagestyle
%
-% \begin{macro}{\providepagestyle}
-% For the parameters see \Macro{defpagestyle}.
-% Define only, if not already defined:
+% \begin{command}{\providepagestyle}
+% For the parameters see \cs{defpagestyle}. Define only, if not already defined:
% \begin{macrocode}
%<*body>
\newcommand*\providepagestyle[3]{%
@@ -1839,50 +1692,42 @@
}
%</body>
% \end{macrocode}
-% \end{macro}%^^A \providepagestyle
-%
-%
-% \section{User Page Style Definition Interface}
-%
-% This is the mid-level interface of \Package{scrpage2} with
-% \Macro{deftripstyle}. As in \Package{scrpage2} we simply use the expert page
-% style definition interface to define the new user interface commands. But
-% here the useless starred versions will not longer be supported. So users of
-% them have to remove the star (nothing else).
-%
-% \begin{macro}{\deftriplepagestyle}
-% \begin{macro}{\newtriplepagestyle}
-% \begin{macro}{\renewtriplepagestyle}
-% \begin{macro}{\providetriplepagestyle}
-% \begin{macro}{\deftripstyle}
-% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be defined (must
-% be fully expandable and expand to a string only).
-% \item[\OParameter{dimensional expression}:] thickness of a horizontal line
-% above the page head and below the page foot (default: 0\,pt).
-% \item[\OParameter{dimensional expression}:] thickness of a horizontal line
-% below the page head and above the page foot (default: 0\,pt).
-% \item[\Parameter{code}:] will be expanded left aligned at head of odd
-% pages (with one-side layout all pages are odd) and right aligned at head
-% of even pages.
-% \item[\Parameter{code}:] will be expanded centered at head of odd
-% and even pages.
-% \item[\Parameter{code}:] will be expanded right aligned at head of odd
-% pages (with one-side layout all pages are odd) and left aligned at head
-% of even pages.
-% \item[\Parameter{code}:] will be expanded left aligned at footer of odd
-% pages (with one-side layout all pages are odd) and right aligned at
-% footer of even pages.
-% \item[\Parameter{code}:] will be expanded centered at footer of odd
-% and even pages.
-% \item[\Parameter{code}:] will be expanded right aligned at footer of odd
-% pages (with one-side layout all pages are odd) and left aligned at
-% footer of even pages.
-% \end{description}
-% See \Package{scrpage2}, but:
-% While the starred version of \Macro{deftripstyle} is deprecated for several
-% years and hasn't been described at the manual, it will not longer be
-% defined. Additional commands have been added.
+% \end{command}^^A \providepagestyle
+%
+%
+% \subsection{User page style definition interface}
+%
+% This is the mid-level interface of \pkg{scrpage2} with \cs{deftripstyle}. As
+% in \pkg{scrpage2} we simply use the expert page style definition interface
+% to define the new user interface commands. But here the useless starred
+% versions will not longer be supported. So users of them have to remove the
+% star (nothing else).
+%
+% \begin{command}{\deftriplepagestyle,\newtriplepagestyle,
+% \renewtriplepagestyle,\providetriplepagestyle}
+% \begin{description}
+% \item[\marg{string}:] the name of the page style to be defined (must be
+% fully expandable and expand to a string only).
+% \item[\oarg{dimensional expression}:] thickness of a horizontal line above
+% the page head and below the page foot (default: 0\,pt).
+% \item[\oarg{dimensional expression}:] thickness of a horizontal line below
+% the page head and above the page foot (default: 0\,pt).
+% \item[\marg{code}:] will be expanded left aligned at head of odd pages (with
+% one-side layout all pages are odd) and right aligned at head of even
+% pages.
+% \item[\marg{code}:] will be expanded centered at head of odd and even pages.
+% \item[\marg{code}:] will be expanded right aligned at head of odd pages
+% (with one-side layout all pages are odd) and left aligned at head of even
+% pages.
+% \item[\marg{code}:] will be expanded left aligned at footer of odd pages
+% (with one-side layout all pages are odd) and right aligned at footer of
+% even pages.
+% \item[\marg{code}:] will be expanded centered at footer of odd and even
+% pages.
+% \item[\marg{code}:] will be expanded right aligned at footer of odd pages
+% (with one-side layout all pages are odd) and left aligned at footer of
+% even pages.
+% \end{description}
% \begin{macrocode}
%<*body>
\newcommand*{\deftriplepagestyle}[1]{%
@@ -1902,16 +1747,13 @@
\scrlayer@triplestyle{#1}%
}%
% \end{macrocode}
-% \begin{macro}{\scrlayer@triplestyle}
-% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\scrlayer@@triplestyle}
+% \begin{macro}{\scrlayer@triplestyle,\scrlayer@@triplestyle}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
% \begin{macro}{\scrlayer@@@triplestyle}
% Helpers, that do the real work. Parameters are same, but \cs{reserved@a} has
-% to be one of \Macro{defpagestyle}, \Macro{newpagestyle},
-% \Macro{renewpagestyle}, or \Macro{providepagestyle}.
+% to be one of \cs{defpagestyle}, \cs{newpagestyle},
+% \cs{renewpagestyle}, or \cs{providepagestyle}.
% \begin{macrocode}
\newcommand*{\scrlayer@triplestyle}[1]{%
\kernel@ifnextchar[%]
@@ -1961,9 +1803,14 @@
}%
}%
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@@@triplestyle
-% \end{macro}%^^A \scrlayer@@triplestyle
-% \end{macro}%^^A \scrlayer@triplestyle
+% \end{macro}^^A \scrlayer@@@triplestyle
+% \end{macro}^^A \scrlayer@triplestyle,\scrlayer@@triplestyle
+% \begin{command}{deftripstyle}
+% Command \cs{deftripstyle} has been defined for compatibility with
+% \pkg{scrpage2} only. It is deprecated now.
+% The starred version \cs{deftripstyle*} is deprecated for several
+% years and hasn't been described at the manual, it will not longer be
+% defined.
% \begin{macrocode}
\newcommand*{\deftripstyle}{%
\PackageWarning{scrlayer-scrpage}{%
@@ -1976,46 +1823,40 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \deftripstyle
-% \end{macro}%^^A \providetriplepagestyle
-% \end{macro}%^^A \renewtriplepagestyle
-% \end{macro}%^^A \newtriplepagestyle
-% \end{macro}%^^A \deftriplepagestyle
-%
-%
-% \section{Pre-defined Page Styles Interface}
-%
-% This is the high-level interface of \Package{scrpage2} with the page style
-% \Pagestyle{scrheadings}, \Pagestyle{scrplain}, and
-% \Pagestyle{useheadings}. Those will work as expected but will also be
-% extended to support definition of additional styles using the same
-% interface.
-%
-% \begin{macro}{\defpairofpagestyles}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{description}
-% \item[\OParameter{string}:] name of a parent page style, that will be used
-% to initialise the new page style (must be fully expandable and expand to
-% the name of a page style).
-% \item[\Parameter{string}:] name the page style to be defined (must be
-% fully expandable and expand to the name of a page style).
-% \item[\Parameter{code}:] several commands of \Macro{ihead}, \Macro{chead},
-% \Macro{ohead}, \Macro{lehead}, \Macro{lohead}, \Macro{cohead},
-% \Macro{rehead}, \Macro{cehead}, \Macro{rohead}, \Macro{ifoot},
-% \Macro{cfoot}, \Macro{ofoot}, \Macro{lefoot}, \Macro{cefoot},
-% \Macro{lofoot}, \Macro{refoot}, \Macro{cofoot}, \Macro{rofoot},
-% \Macro{clearscrheadfoot}, \Macro{clearscrheadings},
-% \Macro{clearscrplain}.
-% \end{description}
-% Two page styles will be defined using \Macro{defpagestyle}, page style named
+% \end{command}^^A \deftripstyle
+% \end{command}^^A \deftriplepagestyle … \providetriplepagestyle
+%
+%
+% \subsection{Pre-defined page styles interface}
+%
+% This is the high-level interface of \pkg{scrpage2} with the page style
+% \pstyle{scrheadings}, \pstyle{scrplain}, and \pstyle{useheadings}. Those
+% will work as expected but will also be extended to support definition of
+% additional styles using the same interface.
+%
+% \begin{command}{\defpairofpagestyles}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{description}
+% \item[\oarg{string}:] name of a parent page style, that will be used to
+% initialise the new page style (must be fully expandable and expand to the
+% name of a page style).
+% \item[\marg{string}:] name the page style to be defined (must be fully
+% expandable and expand to the name of a page style).
+% \item[\marg{code}:] several commands of \cs{ihead}, \cs{chead}, \cs{ohead},
+% \cs{lehead}, \cs{lohead}, \cs{cohead}, \cs{rehead}, \cs{cehead},
+% \cs{rohead}, \cs{ifoot}, \cs{cfoot}, \cs{ofoot}, \cs{lefoot}, \cs{cefoot},
+% \cs{lofoot}, \cs{refoot}, \cs{cofoot}, \cs{rofoot}, \cs{clearscrheadfoot},
+% \cs{clearscrheadings}, \cs{clearscrplain}.
+% \end{description}
+% Two page styles will be defined using \cs{defpagestyle}, page style named
% with the second argument and page style with the same name but an additional
-% prefix ``\texttt{plain.}''. This will be activated automatically to be the
+% prefix ``\pstyle{plain.}''. This will be activated automatically to be the
% plain page style when the first page style will be used. If first argument
% is used this pair of page styles will be used to initialise the head and
% footer of the new. All the other commands are used to define the initial
% fields. Note, if one of those page styles is active, all further commands
% (see 3rd argument) depend on the active page style. If no one is active,
-% they depend on page style \texttt{scrheadings}.
+% they depend on page style \pstyle{scrheadings}.
% \begin{macrocode}
%<*body>
\newcommand*{\defpairofpagestyles}[3][]{%
@@ -2058,7 +1899,7 @@
onselect={%
% \end{macrocode}
% \changes{v3.15}{2015/01/08}{usage of \cs{DeclarePageStyleAlias} instead of
-% \cs{let}}%^^A fixme: Is this correct?
+% \cs{let}}
% \begin{macrocode}
\DeclarePageStyleAlias{plain}{plain.#2}%
\DeclarePageStyleAlias{headings}{#2}%
@@ -2072,7 +1913,7 @@
onselect={%
% \end{macrocode}
% \changes{v3.15}{2015/01/08}{usage of \cs{DeclarePageStyleAlias} instead of
-% \cs{let}}%^^A fixme: Is this correct?
+% \cs{let}}
% \begin{macrocode}
\DeclarePageStyleAlias{plain}{plain.#2}%
\DeclarePageStyleAlias{headings}{#2}%
@@ -2110,31 +1951,28 @@
}%
}%
% \end{macrocode}
-% \begin{macro}{\sls@currentheadings}
-% \begin{macro}{\sls@currentplain}
+% \begin{macro}{\sls@currentheadings,\sls@currentplain}
% These little helpers will be set up at selection of each pair page style and
% stores the last activated page style pair of the scope.
% \begin{macrocode}
\newcommand*\sls@currentheadings{scrheadings}%
\newcommand*\sls@currentplain{plain.scrheadings}%
% \end{macrocode}
-% \end{macro}%^^A \sls@currentplain
-% \end{macro}%^^A \sls@currentheadings
+% \end{macro}^^A \sls@currentheadings,\sls@currentplain
% \begin{macro}{\sls@init@pair@page@style}
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
+% \changes{v3.20}{2016/04/12}{\cs{ifstar} replaced by \cs{kernel@ifstar}}
% \begin{macro}{\sls@init@@pair@page@style}
-% \begin{description}
-% \item[\Parameter{string}:] the name of the page style, that should be
-% initialised to be one member of a page style pair.
-% \item[\Parameter{string}:] the name of a member of a page style pair, that
-% should be used to initialise one the member of a page style pair from
-% first argument.
-% \end{description}
-% These are two little helpers for \Macro{defpairofpagestyles}.
-% The first command has two starred versions. With one star the commands for
-% the page style will be initialised to \Macro{@empty}, with two stars they
-% will become \LaTeX-undefined (\Macro{relax}).
+% \begin{description}
+% \item[\marg{string}:] the name of the page style, that should be initialised
+% to be one member of a page style pair.
+% \item[\marg{string}:] the name of a member of a page style pair, that should
+% be used to initialise one the member of a page style pair from first
+% argument.
+% \end{description}
+% These are two little helpers for \cs{defpairofpagestyles}. The first command
+% has two starred versions. With one star the commands for the page style will
+% be initialised to \cs{@empty}, with two stars they will become
+% \LaTeX-undefined (\cs{relax}).
%
% Note also, that the second argument may either be the plain or the non-plain
% member of the page style pair.
@@ -2177,16 +2015,16 @@
\csname sls@ps@#2@odd@right@foot\endcsname
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@init@@pair@page@style
+% \end{macro}^^A \sls@init@@pair@page@style
% \begin{macro}{\sls@let@pair@page@style}
-% \begin{description}
-% \item[\Parameter{command}:] a single command used to initialise the
-% commands of the page style commands.
-% \item[\Parameter{string}:] the name of a member of a page style pair, that
-% should be used to initialise one the member of a page style pair from
-% first argument.
-% \end{description}
-% A little helper for \Macro{sls@init@pair@page@style}.
+% \begin{description}
+% \item[\marg{command}:] a single command used to initialise the commands of
+% the page style commands.
+% \item[\marg{string}:] the name of a member of a page style pair, that should
+% be used to initialise one the member of a page style pair from first
+% argument.
+% \end{description}
+% A little helper for \cs{sls@init@pair@page@style}.
% \begin{macrocode}
\newcommand*{\sls@let@pair@page@style}[2]{%
\expandafter\let\csname sls@ps@#2@even@left@head\endcsname #1%
@@ -2203,20 +2041,20 @@
\expandafter\let\csname sls@ps@#2@odd@right@foot\endcsname #1%
}%
% \end{macrocode}
-% \end{macro}%^^A \sls@let@pair@page@style
-% \end{macro}%^^A \sls@init@pair@page@style
+% \end{macro}^^A \sls@let@pair@page@style
+% \end{macro}^^A \sls@init@pair@page@style
% \begin{macro}{\sls@def@pair@page@style@member}
-% \changes{v3.24}{2017/05/04}{improved \textsf{bidi} compatibility}%^^A
+% \changes{v3.24}{2017/05/04}{improved \textsf{bidi} compatibility}
% \changes{v3.27}{2019/04/05}{\cs{centering} replaced by
-% \cs{LaTeXcentering}}%^^A
+% \cs{LaTeXcentering}}
% \changes{v3.27}{2019/04/05}{\cs{raggedright} replaced by
-% \cs{LaTeXraggedright}}%^^A
+% \cs{LaTeXraggedright}}
% \changes{v3.27}{2019/04/05}{\cs{raggedleft} replaced by
-% \cs{LaTeXraggedleft}}%^^A
-% \begin{description}
-% \item[\Parameter{string}:] name of the page style to be defined.
-% \end{description}
-% A little helper for \Macro{defpairofpagestyles}.
+% \cs{LaTeXraggedleft}}
+% \begin{description}
+% \item[\marg{string}:] name of the page style to be defined.
+% \end{description}
+% A little helper for \cs{defpairofpagestyles}.
% \begin{macrocode}
\newcommand*{\sls@def@pair@page@style@member}[1]{%
\defpagestyle{#1}{%
@@ -2269,13 +2107,12 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \sls@def@pair@page@style@member
-% \end{macro}%^^A \defpairofpagestyles
+% \end{macro}^^A \sls@def@pair@page@style@member
+% \end{command}^^A \defpairofpagestyles
%
-% \begin{macro}{\newpairofpagestyles}
-% \begin{macro}{\renewpairofpagestyles}
-% \begin{macro}{\providepairofpagestyles}
-% See \Macro{defpairofpagestyles} for the arguments.
+% \begin{command}{\newpairofpagestyles,\renewpairofpagestyles,
+% \providepairofpagestyles}
+% See \cs{defpairofpagestyles} for the arguments.
% \begin{macrocode}
%<*body>
\newcommand*{\newpairofpagestyles}[3][]{%
@@ -2351,164 +2188,86 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \providepairofpagestyles
-% \end{macro}%^^A \renewpairofpagestyles
-% \end{macro}%^^A \newpairofpagestyles
+% \end{command}^^A \newpairofpagestyles … \providepairofpagestyles
+%
%
-% \begin{macro}{\ps@scrheadings}
-% \begin{macro}{\ps@plain.scrheadings}
+% \begin{pgstyle}{scrheading,plain.scrheadings}
% We have one predefined pair: \texttt{scrheadings} with plain page style
% \texttt{plain.scrheadings}.
% \begin{macrocode}
%<*body>
\newpairofpagestyles{scrheadings}{}%
% \end{macrocode}
-% \begin{macro}{\ps@scrplain}
-% But with package \Package{scrpage2} the plain page style was
-% \texttt{scrplain}. So we make a kind of alias:
+% \begin{pgstyle}{scrplain}
+% But with package \pkg{scrpage2}
+% the plain page style was \texttt{scrplain}. So we make a kind of alias:
% \begin{macrocode}
\DeclarePageStyleAlias{scrplain}{plain.scrheadings}
%</body>
% \end{macrocode}
-% \end{macro}%^^A \ps@scrplain
-% \end{macro}%^^A \ps@plain.scrheadings
-% \end{macro}%^^A \ps@scrheadings
-%
-%
-% \begin{macro}{\ihead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\ohead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\chead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\lehead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\lohead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\rehead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\rohead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\cehead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\cohead}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\ifoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\ofoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\cfoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\lefoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\lofoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\refoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\rofoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\cefoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\cofoot}
-% \changes{v3.14}{2014/09/19}{new star version double the argument}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% We also need macros to define the contents of the three part head
-% and foot. Each macro defines one of the part of head or foot of the
-% headings page style member and optional of the plain page style
-% member.
+% \end{pgstyle}^^A scrplain
+% \end{pgstyle}^^A scrheadings,plain.scrheadings
+%
+%
+% \begin{command}{\ihead,\ohead,\chead,
+% \lehead,\lohead,\rehead,\rohead,\cehead,\cohead,
+% \ifoot,\ofoot,\cfoot,
+% \lefoot,\lofoot,\refoot,\rofoot,\cefoot,\cofoot}
+% \changes{v3.14}{2014/09/19}{new star version double the argument}
+% \changes{v3.20}{2016/04/12}{\cs{ifstar} replaced by \cs{kernel@ifstar}}
+% We also need macros to define the contents of the three part head and
+% foot. Each macro defines one of the part of head or foot of the
+% \emph{headings} page style member and optional of the \emph{plain} page
+% style member.
% \begin{macrocode}
%<*body>
\newcommand*{\ihead}{\kernel@ifstar {\@dblarg\@@@ihead}{\@ihead}}%
% \end{macrocode}
% \begin{macro}{\@ihead}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@ihead}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\@@@ihead}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@ihead,\@@@ihead}
+% \changes{v3.27}{2019/04/05}{long}
% Two helpers for the previous one to double the command and it's arguments.
% \begin{macrocode}
\newcommand*{\@ihead}{\kernel@ifnextchar[{\@@@ihead}{\@@ihead}}%
\newcommand{\@@ihead}[1]{\rehead{#1}\lohead{#1}}%
\newcommand{\@@@ihead}[2][]{\rehead[{#1}]{#2}\lohead[{#1}]{#2}}%
% \end{macrocode}
-% \end{macro}%^^A \@@@ihead
-% \end{macro}%^^A \@@ihead
-% \end{macro}%^^A \@ihead
+% \end{macro}^^A \@@ihead,\@@@ihead
+% \end{macro}^^A \@ihead
% \begin{macrocode}
\newcommand*{\ohead}{\kernel@ifstar {\@dblarg\@@@ohead}{\@ohead}}%
% \end{macrocode}
% \begin{macro}{\@ohead}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@ohead}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\@@@ohead}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@ohead,\@@@ohead}
+% \changes{v3.27}{2019/04/05}{long}
% Two helpers for the previous one to double the command and it's arguments.
% \begin{macrocode}
\newcommand*{\@ohead}{\kernel@ifnextchar[{\@@@ohead}{\@@ohead}}%
\newcommand{\@@ohead}[1]{\lehead{#1}\rohead{#1}}%
\newcommand{\@@@ohead}[2][]{\lehead[{#1}]{#2}\rohead[{#1}]{#2}}%
% \end{macrocode}
-% \end{macro}%^^A \@@@ohead
-% \end{macro}%^^A \@@ohead
-% \end{macro}%^^A \@ohead
+% \end{macro}^^A \@@ohead,\@@@ohead
+% \end{macro}^^A \@ohead
% \begin{macrocode}
\newcommand*{\chead}{\kernel@ifstar {\@dblarg\@@@chead}{\@chead}}%
% \end{macrocode}
% \begin{macro}{\@chead}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@chead}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\@@@chead}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@chead,\@@@chead}
+% \changes{v3.27}{2019/04/05}{long}
% Two helpers for the previous one to double the command and it's arguments.
% \begin{macrocode}
\newcommand*{\@chead}{\kernel@ifnextchar[{\@@@chead}{\@@chead}}%
\newcommand{\@@chead}[1]{\cehead{#1}\cohead{#1}}%
\newcommand{\@@@chead}[2][]{\cehead[{#1}]{#2}\cohead[{#1}]{#2}}%
% \end{macrocode}
-% \end{macro}%^^A \@@@chead
-% \end{macro}%^^A \@@chead
-% \end{macro}%^^A \@chead
+% \end{macro}^^A \@@chead,\@@@chead
+% \end{macro}^^A \@chead
% \begin{macrocode}
\newcommand*{\lehead}{\sls@renewelement{even}{left}{head}}%
\newcommand*{\lohead}{\sls@renewelement{odd}{left}{head}}%
@@ -2522,58 +2281,49 @@
% \end{macrocode}
% \begin{macro}{\@ifoot}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@ifoot}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\@@@ifoot}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@ifoot,\@@@ifoot}
+% \changes{v3.27}{2019/04/05}{long}
% Two helpers for the previous one to double the command and it's arguments.
% \begin{macrocode}
\newcommand*{\@ifoot}{\kernel@ifnextchar[{\@@@ifoot}{\@@ifoot}}%
\newcommand{\@@ifoot}[1]{\refoot{#1}\lofoot{#1}}%
\newcommand{\@@@ifoot}[2][]{\refoot[{#1}]{#2}\lofoot[{#1}]{#2}}%
% \end{macrocode}
-% \end{macro}%^^A \@@@ifoot
-% \end{macro}%^^A \@@ifoot
-% \end{macro}%^^A \@ifoot
+% \end{macro}^^A \@@ifoot,\@@@ifoot
+% \end{macro}^^A \@ifoot
% \begin{macrocode}
\newcommand*{\ofoot}{\kernel@ifstar {\@dblarg\@@@ofoot}{\@ofoot}}%
% \end{macrocode}
% \begin{macro}{\@ofoot}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@ofoot}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\@@@ofoot}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@ofoot,\@@@ofoot}
+% \changes{v3.27}{2019/04/05}{long}
% Two helpers for the previous one to double the command and it's arguments.
% \begin{macrocode}
\newcommand*{\@ofoot}{\kernel@ifnextchar[{\@@@ofoot}{\@@ofoot}}%
\newcommand{\@@ofoot}[1]{\lefoot{#1}\rofoot{#1}}%
\newcommand{\@@@ofoot}[2][]{\lefoot[{#1}]{#2}\rofoot[{#1}]{#2}}%
% \end{macrocode}
-% \end{macro}%^^A \@@@ofoot
-% \end{macro}%^^A \@@ofoot
-% \end{macro}%^^A \@ofoot
+% \end{macro}^^A \@@ofoot,\@@@ofoot
+% \end{macro}^^A \@ofoot
% \begin{macrocode}
\newcommand*{\cfoot}{\kernel@ifstar {\@dblarg\@@@cfoot}{\@cfoot}}%
% \end{macrocode}
% \begin{macro}{\@cfoot}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \begin{macro}{\@@cfoot}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\@@@cfoot}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \begin{macro}{\@@cfoot,\@@@cfoot}
+% \changes{v3.27}{2019/04/05}{long}
% Two helpers for the previous one to double the command and it's arguments.
% \begin{macrocode}
\newcommand*{\@cfoot}{\kernel@ifnextchar[{\@@@cfoot}{\@@cfoot}}%
\newcommand{\@@cfoot}[1]{\cefoot{#1}\cofoot{#1}}%
\newcommand{\@@@cfoot}[2][]{\cefoot[{#1}]{#2}\cofoot[{#1}]{#2}}%
% \end{macrocode}
-% \end{macro}%^^A \@@@cfoot
-% \end{macro}%^^A \@@cfoot
-% \end{macro}%^^A \@cfoot
+% \end{macro}^^A \@@cfoot,\@@@cfoot
+% \end{macro}^^A \@cfoot
% \begin{macrocode}
\newcommand*{\lefoot}{\sls@renewelement{even}{left}{foot}}%
\newcommand*{\lofoot}{\sls@renewelement{odd}{left}{foot}}%
@@ -2585,15 +2335,11 @@
% \begin{macro}{\sls@renewelement}
% \begin{macro}{\sls@@renewelement}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
-% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
-% \begin{macro}{\sls@@@renewelement}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\sls@@@@renewelement}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
-% \begin{macro}{\sls@@renewplainelement}
-% \changes{v3.27}{2019/04/05}{made long}%^^A
+% \cs{kernel@ifnextchar}}
+% \changes{v3.20}{2016/04/12}{\cs{ifstar} replaced by \cs{kernel@ifstar}}
+% \begin{macro}{\sls@@@renewelement,\sls@@@@renewelement,
+% \sls@@renewplainelement}
+% \changes{v3.27}{2019/04/05}{long}
% Little helper for several of the above commands.
% \begin{macrocode}
\newcommand*{\sls@renewelement}[3]{%
@@ -2626,32 +2372,14 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \sls@@renewplainelement
-% \end{macro}%^^A \sls@@@@renewelement
-% \end{macro}%^^A \sls@@@renewelement
-% \end{macro}%^^A \sls@@renewelement
-% \end{macro}%^^A \sls@renewelement
-% \end{macro}%^^A \cofoot
-% \end{macro}%^^A \cefoot
-% \end{macro}%^^A \rofoot
-% \end{macro}%^^A \refoot
-% \end{macro}%^^A \lofoot
-% \end{macro}%^^A \lefoot
-% \end{macro}%^^A \cfoot
-% \end{macro}%^^A \ofoot
-% \end{macro}%^^A \ifoot
-% \end{macro}%^^A \cohead
-% \end{macro}%^^A \cehead
-% \end{macro}%^^A \rohead
-% \end{macro}%^^A \rehead
-% \end{macro}%^^A \lohead
-% \end{macro}%^^A \lehead
-% \end{macro}%^^A \chead
-% \end{macro}%^^A \ohead
-% \end{macro}%^^A \ihead
-%
-% \begin{macro}{\clearmainofpairofpagestyles}
-% \begin{macro}{\clearscrheadings}
+% \end{macro}^^A \sls@@@renewelement … \sls@@renewplainelement
+% \end{macro}^^A \sls@@renewelement
+% \end{macro}^^A \sls@renewelement
+% \end{command}^^A \ihead … \cofoot
+%
+%
+% \begin{command}{\clearmainofpairofpagestyles}
+% \begin{command}{\clearscrheadings}
% \changes{v3.32}{2020/09/11}{deprecation warning added}
% Maybe you want to clear the currently defined head and foot. First
% let's clear only scrheadings pagestyle but not scrplain pagestyle.
@@ -2670,10 +2398,10 @@
}
%</body>
% \end{macrocode}
-% \end{macro}%^^A \clearscrheadings
-% \end{macro}%^^A \clearmainofpairofpagestyles
-% \begin{macro}{\clearplainofpairofpagestyles}
-% \begin{macro}{\clearscrplain}
+% \end{command}^^A \clearscrheadings
+% \end{command}^^A \clearmainofpairofpagestyles
+% \begin{command}{\clearplainofpairofpagestyles}
+% \begin{command}{\clearscrplain}
% \changes{v3.32}{2020/09/11}{deprecation warning added}
% Now, we use the not recommended feature to set up a plain style:
% \begin{macrocode}
@@ -2701,10 +2429,10 @@
}
%</body>
% \end{macrocode}
-% \end{macro}%^^A \clearscrplain
-% \end{macro}%^^A \clearplainofpairofpagestyles
-% \begin{macro}{\clearpairofpagestyles}
-% \begin{macro}{\clearscrheadfoot}
+% \end{command}^^A \clearscrplain
+% \end{command}^^A \clearplainofpairofpagestyles
+% \begin{command}{\clearpairofpagestyles}
+% \begin{command}{\clearscrheadfoot}
% \changes{v3.32}{2020/09/11}{deprecation warning added}
% Last but not least we clean up both, the main and the plain:
% \begin{macrocode}
@@ -2721,10 +2449,11 @@
}
%</body>
% \end{macrocode}
-% \end{macro}%^^A \clearscrheadfoot
-% \end{macro}%^^A \clearpairofpagestyles
+% \end{command}^^A \clearscrheadfoot
+% \end{command}^^A \clearpairofpagestyles
+%
%
-% \begin{macro}{\ps@useheadings}
+% \begin{pgstyle}{useheadings,plain.useheadings}
% Not longer supported:
% \begin{macrocode}
%<*body>
@@ -2746,24 +2475,21 @@
}%
%</body>
% \end{macrocode}
-% \end{macro}%^^A \ps@useheadings
+% \end{pgstyle}^^A useheadings,plain.useheadings
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%</interface>
-% \fi^^A meta-comment
-%
+% \end{macrocode}
+%
% \Finale
-% \let\subsection\section
-% \let\section\chapter
-% \let\chapter\restorechapter
+% \PrintChanges
%
\endinput
-%
-% end of file `scrlayer.dtx'
-
-%%% Local Variables:
-%%% mode: doctex
-%%% mode: flyspell
-%%% ispell-local-dictionary: "en_GB"
-%%% TeX-master: t
-%%% End:
+% Local Variables:
+% mode: doctex
+% ispell-local-dictionary: "en_US"
+% eval: (flyspell-mode 1)
+% TeX-master: t
+% TeX-engine: luatex-dev
+% eval: (setcar (or (cl-member "Index" (setq-local TeX-command-list (copy-alist TeX-command-list)) :key #'car :test #'string-equal) (setq-local TeX-command-list (cons nil TeX-command-list))) '("Index" "mkindex %s" TeX-run-index nil t :help "makeindex for dtx"))
+% End: