summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/koma-script/source/scrlayer.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/koma-script/source/scrlayer.dtx')
-rw-r--r--macros/latex/contrib/koma-script/source/scrlayer.dtx1202
1 files changed, 534 insertions, 668 deletions
diff --git a/macros/latex/contrib/koma-script/source/scrlayer.dtx b/macros/latex/contrib/koma-script/source/scrlayer.dtx
index ac98a934d1..1a150b1cab 100644
--- a/macros/latex/contrib/koma-script/source/scrlayer.dtx
+++ b/macros/latex/contrib/koma-script/source/scrlayer.dtx
@@ -1,7 +1,7 @@
% \iffalse^^A meta-comment
% ======================================================================
% scrlayer.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.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.dtx 3560 2021-02-15 13:20:12Z kohm $
+%%% From File: $Id: scrlayer.dtx 3773 2022-03-29 06:27:55Z kohm $
%<identify>%%% (run: identify)
%<init>%%% (run: init)
%<options>%%% (run: options)
@@ -48,9 +28,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-02-15 14:20:12 +0100 (Mon, 15 Feb 2021) $
+ \filedate$Date: 2022-03-29 08:27:55 +0200 (Tue, 29 Mar 2022) $
\def\filerevision$#1: #2 ${\gdef\filerevision{r#2}}
- \filerevision$Revision: 3560 $
+ \filerevision$Revision: 3773 $
\edef\reserved@a{%
\noexpand\endgroup
\noexpand\ProvidesFile{scrlayer.dtx}%
@@ -77,11 +57,11 @@
\KOMAdefVariable{COPYRIGHTFROM}{2012}
\generate{\usepreamble\defaultpreamble
\file{scrlayer.sty}{%
- \from{scrlayer.dtx}{package,trace,scrlayer,identify}%
- \from{scrlayer.dtx}{package,trace,scrlayer,init}%
- \from{scrlayer.dtx}{package,trace,scrlayer,options}%
- \from{scrlayer.dtx}{package,trace,scrlayer,body}%
- \from{scrlayer.dtx}{package,trace,scrlayer,final}%
+ \from{scrlayer.dtx}{package,scrlayer,identify}%
+ \from{scrlayer.dtx}{package,scrlayer,init}%
+ \from{scrlayer.dtx}{package,scrlayer,options}%
+ \from{scrlayer.dtx}{package,scrlayer,body}%
+ \from{scrlayer.dtx}{package,scrlayer,final}%
\from{scrlogo.dtx}{logo}%
}%
}
@@ -93,121 +73,63 @@
\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.dtx}
- \title{The \KOMAScript{} package \texttt{scrlayer}%
- \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
- \DocInput{\filename}
- \DocInput{scrlayer-scrpage.dtx}
- \DocInput{scrlayer-notecolumn.dtx}
- \bibliography{guide}
- \PrintChanges
- \PrintIndex
- \end{document}
+\documentclass[USenglish]{koma-script-source-doc}
+\usepackage{babel}
+\setcounter{StandardModuleDepth}{2}
+\begin{document}
+ \DocInput{scrlayer.dtx}
+\end{document}
%</dtx>
% \fi^^A meta-comment
%
-% \selectlanguage{english}
-%
-% \changes{v0.0}{2012/01/01}{Start of new package}%^^A
-% \changes{v0.9}{2014/07/25}{User documentation removed}%^^A
+% \changes{v0.0}{2012/01/01}{Start of new package}
+% \changes{v0.9}{2014/07/25}{User documentation removed}
+% \changes{v3.36}{2022/02/08}{switch over from \cls*{scrdoc} to
+% \cls*{koma-script-source-doc}}
+% \changes{v3.36}{2022/02/08}{require package \pkg*{scrlogo} instead of
+% defining \cs{KOMAScript}}
+% \changes{v3.36}{2022/02/08}{whole implementation documentation in English}
%
-% \StopEventually{}
+% \GetFileInfo{scrlayer.dtx}
+% \title{Layers and Page Styles with \href{https://komascript.de}{\KOMAScript}
+% Package \pkg*{scrlayer}}
+% \author{\href{mailto:komascript@gmx.info}{Markus Kohm}}
+% \date{Revision \fileversion{} of \filedate}
+% \maketitle
+% \begin{abstract}
+% Usually page styles only define the page header and page footer. But with
+% \pkg*{scrlayer} page styles consist of multiple layers, that can be placed
+% everywhere in the page background or foreground.
+% \end{abstract}
+% \tableofcontents
%
+% \section{User Manual}
%
-% \section{Implementation of \Package{scrlayer}}
+% You can find the user manuals of \pkg*{scrlayer} in the \KOMAScript{} manual,
+% either the German \file{scrguide} or the English \file{scrguien}.
%
-% This section if for developers only.
+% \MaybeStop{\PrintIndex}
%
-% \iffalse
-%<*package>
-%<*identify>
-% \fi
+% \section{Implementation of \pkg*{scrlayer}}
%
-%\iffalse^^A meta-comment
-%</identify>
-%</package>
+% \begin{macrocode}
%<*package|interface|class>
-%\fi^^A meta-comment
+% \end{macrocode}
%
-% \subsection{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.
%
-% \begin{macro}{\scrlayer@@inherited@options@cslist}
-% \changes{v3.33}{2021/02/15}{new (internal)}
-% \begin{macro}{\scrlayer@@add@inherited@option}
-% \changes{v3.33}{2021/02/15}{new (internal)}
-% \begin{macro}{\scrlayer@do@inherited@options}
-% \changes{v3.33}{2021/02/15}{new (interface command)}
-% \begin{macro}{\scrlayer@inherit@option}
-% \changes{v3.33}{2021/02/15}{new (interface command)}
+% \begin{macro}{\scrlayer@@inherited@options@cslist,
+% \scrlayer@@add@inherited@option}
+% \changes{v3.33}{2021/02/15}{added}
+% \begin{macro}{\scrlayer@do@inherited@options,
+% \scrlayer@inherit@option}
+% \changes{v3.33}{2021/02/15}{added (interface command)}
% The options of \textsf{scrlayer} should be passed to \textsf{scrlayer} while
% loading an interface package. We use the comma-separated-list
% \cs{scrlayer@@inherited@options@cslist} to store all of them, so the
@@ -261,12 +183,10 @@
% \end{macrocode}
% \end{macro}
% \end{macro}
-% \end{macro}
-% \end{macro}
%
-% While there are \KOMAScript{} options, we need \Package{scrkbase} to declare
-% them, but the interfaces also needs \Package{scrlayer} which already
-% includes \Package{scrkbase}.
+% While there are \KOMAScript{} options, we need \pkg*{scrkbase} to declare
+% them, but the interfaces also needs \pkg*{scrlayer} which already
+% includes \pkg*{scrkbase}.
% \begin{macrocode}
%<package>\RequirePackage{scrkbase}[2013/03/05]
%<interface>\RequirePackage{scrlayer}
@@ -274,8 +194,8 @@
%
%
% \begin{macro}{\scrlayer@AtEndOfPackage}
-% Initial \Macro{AtEndOfPackage}, but after end of package
-% \Macro{@firstofone}.
+% Initial \cs{AtEndOfPackage}, but after end of package
+% \cs{@firstofone}.
% \begin{macrocode}
\scr@ifundefinedorrelax{scrlayer@AtEndOfPackage}{%
\AtEndOfPackage{\let\scrlayer@AtEndOfPackage\@firstofone}%
@@ -286,12 +206,12 @@
}
\let\scrlayer@AtEndOfPackage\AtEndOfPackage
% \end{macrocode}
-% \end{macro}%^^A \sls@AtEndOfPackage
+% \end{macro}^^A \sls@AtEndOfPackage
%
% \begin{macro}{\scrlayer@testunexpectedarg}
% We'll have several \KOMAScript{} options, that didn't expect an
% value. So we use this general helper to test the value and report an error
-% if it is not empty (or \Macro{relax}).
+% if it is not empty (or \cs{relax}).
% \begin{macrocode}
%<*package>
\newcommand*{\scrlayer@testunexpectedarg}[2]{%
@@ -304,9 +224,9 @@
}
%</package>
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@testunexpectedarg
+% \end{macro}^^A \scrlayer@testunexpectedarg
%
-% \begin{macro}{\if@chapter}
+% \begin{macro}{\if@chapter,\@chaptertrue,\@chapterfalse}
% We need this later. But it is something general. So we initialise it as
% early as possible.
% \begin{macrocode}
@@ -316,11 +236,11 @@
\scr@ifundefinedorrelax{chapter}{\@chapterfalse}{\@chaptertrue}%
}{}
% \end{macrocode}
-% \end{macro}%^^A \if@chapter
+% \end{macro}^^A \if@chapter
%
% \begin{macro}{\if@mainmatter}
-% Some classes define \Macro{frontmatter} or \Macro{mainmatter}, but do not
-% define \Macro{if@mainmatter}. But we nee some information about the matter,
+% Some classes define \cs{frontmatter} or \cs{mainmatter}, but do not
+% define \cs{if@mainmatter}. But we nee some information about the matter,
% so in that case, we add it.
% \begin{macrocode}
\scr@ifundefinedorrelax{if@mainmatter}{%
@@ -351,19 +271,19 @@
}{}
%</package>
% \end{macrocode}
-% \end{macro}%^^A \if@mainmatter
+% \end{macro}^^A \if@mainmatter
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%</init>
-% \fi^^A meta-comment
-%
+% \end{macrocode}
+%
%
% \subsection{Process Options}
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%<*body>
-% \fi^^A meta-comment
-%
+% \end{macrocode}
+%
% The very first thing at the body is processing the options:
% \begin{macrocode}
%<*package|interface>
@@ -375,26 +295,26 @@
%
% Currently not needed.
%
-% \iffalse
+% \begin{macrocode}
%</body>
-% \fi
-%
+% \end{macrocode}
+%
%
% \subsection{Extended Running Heads}
%
-% Package \Package{scrpage2} changes and extends the running head mechanisms
+% Package \pkg{scrpage2} changes and extends the running head mechanisms
% of \LaTeX{} and the classes. Most of this are basic features an therefore
-% done already by \Package{scrlayer}. But not the deprecated options.
+% done already by \pkg*{scrlayer}. But not the deprecated options.
%
% \begin{option}{markcase}
% \begin{description}
% \item[\texttt{=\meta{setting}}] one of: \texttt{upper}, \texttt{lower},
% \texttt{used}, or \texttt{ignoreuppercase}.
% \end{description}\noindent
-% The two options \Option{markuppercase} and \Option{markusedcase} become
-% deprecated and are replace be the single option \Option{markcase}. Note,
-% that interface \Package{scrlayer-scrpage} has to delay this option to
-% overload case setting of option \Option{pagestyleset}.
+% The two options \opt{markuppercase} and \opt{markusedcase} become
+% deprecated and are replace be the single option \opt{markcase}. Note,
+% that interface \pkg*{scrlayer-scrpage} has to delay this option to
+% overload case setting of option \opt{pagestyleset}.
% \begin{macrocode}
%<*options>
\KOMA@key{markcase}{%
@@ -440,8 +360,8 @@
\csname KV@KOMA.\@currname.\@currext @markcase\endcsname\relax
%</interface&body>
% \end{macrocode}
-% \begin{macro}{\MakeMarkcase}
-% We use this instead of, e.g., \Macro{MakeUppercase} for every layer! So the
+% \begin{command}{\MakeMarkcase}
+% We use this instead of, e.g., \cs{MakeUppercase} for every layer! So the
% name seams to be wrong, but it is common, so we use it here.
% \begin{macrocode}
%<*package&options>
@@ -457,8 +377,8 @@
\fi\fi\fi\fi
% \end{macrocode}
% \begin{macro}{\scrlayer@ignoreuppercase}
-% We span a group and set \Macro{uppercase} and \Macro{MakeUppercase} to
-% \Macro{@firstofone}.
+% We span a group and set \cs{uppercase} and \cs{MakeUppercase} to
+% \cs{@firstofone}.
% \begin{macrocode}
\DeclareRobustCommand*{\scrlayer@ignoreuppercase}[1]{%
\begingroup
@@ -477,52 +397,40 @@
\newif\ifscrlayer@forceignoreuppercase
%</package&options>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@forceignoreuppercase
-% \end{macro}%^^A \scrlayer@ignoreuppercase
-% \end{macro}%^^A \MakeMarkcase
-% \end{option}%^^A markcase
+% \end{macro}^^A \ifscrlayer@forceignoreuppercase
+% \end{macro}^^A \scrlayer@ignoreuppercase
+% \end{command}^^A \MakeMarkcase
+% \end{option}^^A markcase
%
-% \begin{macro}{\rightfirstmark}
-% \changes{v3.16}{2015/01/14}{new}%^^A
-% \begin{macro}{\rightbotmark}
-% \changes{v3.16}{2015/01/14}{new}%^^A
-% \begin{macro}{\righttopmark}
-% \changes{v3.16}{2015/01/14}{new}%^^A
-% \Macro{rightfirstmark} is simply the same like the \Macro{rightmark} of the
-% \LaTeX{} kernel. \Macro{rightbotmark} uses \Macro{botmark} instead of
-% \Macro{firstmark} and \Macro{righttopmark} uses \Macro{topmark}.
+% \begin{command}{\rightfirstmark,\rightbotmark,\righttopmark}
+% \changes{v3.16}{2015/01/14}{added}
+% \cs{rightfirstmark} is simply the same like the \cs{rightmark} of the
+% \LaTeX{} kernel. \cs{rightbotmark} uses \cs{botmark} instead of
+% \cs{firstmark} and \cs{righttopmark} uses \cs{topmark}.
% \begin{macrocode}
%<*package&body>
\newcommand*{\rightfirstmark}{\expandafter\@rightmark\firstmark\@empty\@empty}
\newcommand*{\rightbotmark}{\expandafter\@rightmark\botmark\@empty\@empty}
\newcommand*{\righttopmark}{\expandafter\@rightmark\topmark\@empty\@empty}
% \end{macrocode}
-% \end{macro}%^^A \righttopmark
-% \end{macro}%^^A \rightbotmark
-% \end{macro}%^^A \rightfirstmark
+% \end{command}^^A \rightfirstmark …
%
-% \begin{macro}{\leftfirstmark}
-% \changes{v3.16}{2015/01/14}{new}%^^A
-% \begin{macro}{\leftbotmark}
-% \changes{v3.16}{2015/01/14}{new}%^^A
-% \begin{macro}{\lefttopmark}
-% \changes{v3.16}{2015/01/14}{new}%^^A
-% \Macro{leftbotmark} is simply the same like the \Macro{leftmark} of the
-% \LaTeX{} kernel. \Macro{leftfirstmark} uses \Macro{firstmark} instead of
-% \Macro{botmark} and \Macro{lefttopmark} uses \Macro{topmark}.
+% \begin{command}{\leftfirstmark,\leftbotmark,\lefttopmark}
+% \changes{v3.16}{2015/01/14}{added}
+% \cs{leftbotmark} is simply the same like the \cs{leftmark} of the
+% \LaTeX{} kernel. \cs{leftfirstmark} uses \cs{firstmark} instead of
+% \cs{botmark} and \cs{lefttopmark} uses \cs{topmark}.
% \begin{macrocode}
\newcommand*{\leftfirstmark}{\expandafter\@leftmark\firstmark\@empty\@empty}
\newcommand*{\leftbotmark}{\expandafter\@leftmark\botmark\@empty\@empty}
\newcommand*{\lefttopmark}{\expandafter\@leftmark\topmark\@empty\@empty}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \lefttopmark
-% \end{macro}%^^A \leftbotmark
-% \end{macro}%^^A \leftfirstmark
+% \end{command}^^A \leftfirstmark …
%
-% \begin{macro}{\headmark}
-% Inside a page style, this macro is either \Macro{rightmark} or
-% \Macro{leftmark}. Outside its \LaTeX-undefined and therefore it's not an
+% \begin{command}{\headmark}
+% Inside a page style, this macro is either \cs{rightmark} or
+% \cs{leftmark}. Outside its \LaTeX-undefined and therefore it's not an
% interface command, but has to be undefined:
% \begin{macrocode}
%<*package&body>
@@ -541,9 +449,9 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \headmark
+% \end{command}^^A \headmark
%
-% \begin{macro}{\pagemark}
+% \begin{command}{\pagemark}
% The page number together with its font setting. It's robust and will never
% be part of the interface.
% \begin{macrocode}
@@ -552,7 +460,7 @@
\DeclareRobustCommand\pagemark{{\pnumfont{\thepage}}}%
}{}%
% \end{macrocode}
-% \begin{macro}{\pnumfont}
+% \begin{command}{\pnumfont}
% \begin{macro}{\scr@fnt@pagenumber}
% The low-level page number font command. It is deprecated to redefine or use
% this and it may already be defined. These commands will not become part of
@@ -566,19 +474,17 @@
}{}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scr@fnt@pagenumber
-% \end{macro}%^^A \pnumfont
-% \end{macro}%^^A \pagemark
+% \end{macro}^^A \scr@fnt@pagenumber
+% \end{command}^^A \pnumfont
+% \end{command}^^A \pagemark
%
-% \begin{macro}{\partmarkformat}
-% \begin{macro}{\chaptermarkformat}
-% \begin{macro}{\sectionmarkformat}
-% \begin{macro}{\GenericMarkFormat}
-% All the \Macro{\dots markformat} macros of \KOMAScript{} are also
-% supported by \Package{scrlayer} and it uses them actively. The generic
-% definition has been moved from \Macro{@seccntmarkformat} to
-% \Macro{GenericMarkFormat}. This is one more difference to
-% \Package{scrpage2}. The defaults are compatible to the standard
+% \begin{command}{\partmarkformat,\chaptermarkformat,\sectionmarkformat,
+% \GenericMarkFormat}
+% All the \cs{\dots markformat} macros of \KOMAScript{} are also
+% supported by \pkg*{scrlayer} and it uses them actively. The generic
+% definition has been moved from \cs{@seccntmarkformat} to
+% \cs{GenericMarkFormat}. This is one more difference to
+% \pkg{scrpage2}. The defaults are compatible to the standard
% classes. These commands will not become part of the interface and other
% interfaces should redefine them only, if they are not already defined.
% \begin{macrocode}
@@ -598,22 +504,17 @@
}
%</package&body>
% \end{macrocode}
-% Note, that the other \Macro{\dots markformat} will be defined by
-% \Macro{scrlayer@level@init}.
-% \end{macro}%^^A \GenericMarkFormat
-% \end{macro}%^^A \sectionmarkformat
-% \end{macro}%^^A \chaptermarkformat
-% \end{macro}%^^A \partmarkformat
+% Note, that the other \cs{\dots markformat} will be defined by
+% \cs{scrlayer@level@init}.
+% \end{command}^^A \partmarkformat …
%
-% \begin{macro}{\@mkleft}
-% \changes{v3.25}{2017/10/13}{added to the \KOMAScript{} classes}%^^A
-% \begin{macro}{\@mkright}
-% \changes{v3.25}{2017/10/13}{added to the \KOMAScript{} classes}%^^A
+% \begin{macro}{\@mkleft,\@mkright}
+% \changes{v3.25}{2017/10/13}{added to the \KOMAScript{} classes}
% \begin{macro}{\@mkdouble}
-% \changes{v3.25}{2017/10/13}{added to the \KOMAScript{} classes}%^^A
-% \changes{v3.27a}{2019/10/17}{long definition}%^^A
-% These are new in \Package{scrlayer}. They may be updated, whenever
-% \Macro{@mkboth} will be updated. Otherwise they get a working default
+% \changes{v3.25}{2017/10/13}{added to the \KOMAScript{} classes}
+% \changes{v3.27a}{2019/10/17}{long definition}
+% These are new in \pkg*{scrlayer}. They may be updated, whenever
+% \cs{@mkboth} will be updated. Otherwise they get a working default
% definition. These commands will not become part of the interface and other
% interfaces should redefine them only, if they are not already defined.
% \begin{macrocode}
@@ -629,15 +530,14 @@
}
%</(package|class)&body>
% \end{macrocode}
-% \end{macro}%^^A \@mkdouble
-% \end{macro}%^^A \@mkright
-% \end{macro}%^^A \@mkleft
+% \end{macro}^^A \@mkdouble
+% \end{macro}^^A \@mkright,\@mkleft
%
-% \begin{macro}{\markleft}
-% \changes{v3.27a}{2019/10/17}{robust and long definition}%^^A
+% \begin{command}{\markleft}
+% \changes{v3.27a}{2019/10/17}{robust and long definition}
% \begin{macro}{\@markleft}
-% \LaTeX{} itself provides \Macro{markboth} and \Macro{markright} but not
-% \Macro{markleft}. So we add it.
+% \LaTeX{} itself provides \cs{markboth} and \cs{markright} but not
+% \cs{markleft}. So we add it.
% \begin{macrocode}
%<*package&body>
\@ifundefined{markleft}{%
@@ -657,11 +557,11 @@
}{}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@markleft
-% \end{macro}%^^A \markleft
+% \end{macro}^^A \@markleft
+% \end{command}^^A \markleft
%
-% \begin{macro}{\markdouble}
-% \changes{v3.28}{2019/10/17}{new}%^^A
+% \begin{command}{\markdouble}
+% \changes{v3.28}{2019/10/17}{added}
% This is easier, because it uses \cs{markboth}. So we do not need to declare
% it robust and we can use \cs{providecommand}.
% \begin{macrocode}
@@ -669,11 +569,11 @@
\providecommand{\markdouble}[1]{\markboth{#1}{#1}}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \markdouble
+% \end{command}^^A \markdouble
%
% \begin{option}{autooneside}
% \begin{macro}{\ifscrlayer@autooneside}
-% Decide whether or not use the optional argument of \Macro{automark} in
+% Decide whether or not use the optional argument of \cs{automark} in
% single-side layout.
% \begin{macrocode}
%<*options>
@@ -694,22 +594,24 @@
\csname KV@KOMA.\@currname.\@currext @autooneside\endcsname\relax
%</interface&body>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@autooneside
-% \end{option}%^^A autooneside
+% \end{macro}^^A \ifscrlayer@autooneside
+% \end{option}^^A autooneside
%
%
% \begin{option}{automark}
% \begin{option}{manualmark}
% Maybe we will extend these options later. Currently they do almost the
-% same they do at \Package{scrpage2}. The difference is, that single-side or
+% same they do at \pkg{scrpage2}. The difference is, that single-side or
% two-side doesn't matter here (but it does inside of the definitions of the
% marks itself).
%
-% ToDo: Maybe \Option{manualmark} should become deprecated and
-% \Option{automark} should have simple values or a new option, that also
-% handles \Option{autooneside}?
+% \begin{description}
+% \item[ToDo:] Maybe \opt{manualmark} should become deprecated and
+% \opt{automark} should have simple values or a new option, that also
+% handles \opt{autooneside}?
+% \end{description}
% \changes{v3.22}{2016/12/07}{prepared for classes without \cs{section} or
-% \cs{subsection}}%^^A
+% \cs{subsection}}
% \begin{macrocode}
%<*options>
\KOMA@key{automark}[]{%
@@ -762,12 +664,12 @@
\csname KV@KOMA.\@currname.\@currext @manualmark@default\endcsname\relax
%</interface&body>
% \end{macrocode}
-% \end{option}%^^A manualmark
-% \end{option}%^^A automark
+% \end{option}^^A manualmark
+% \end{option}^^A automark
%
-% \begin{macro}{\manualmark}
-% Switch to manual marks. This resets \Macro{@mkleft}, \Macro{@mkright},
-% \Macro{@mkdouble}, \Macro{@mkboth} and the \Macro{\dots mark} of all known
+% \begin{command}{\manualmark}
+% Switch to manual marks. This resets \cs{@mkleft}, \cs{@mkright},
+% \cs{@mkdouble}, \cs{@mkboth} and the \cs{\dots mark} of all known
% levels.
% \begin{macrocode}
%<*package&body>
@@ -786,15 +688,15 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\automark}
+% \begin{command}{\automark}
% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
+% ersetzt}
% \begin{macro}{\@automark}
-% \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}}
% This is the brain knot of the game! I'll try to explain, what I'm doing:
-% First of all the new starred version of \Macro{automark} doesn't reset the
+% First of all the new starred version of \cs{automark} doesn't reset the
% mark commands. So it works cumulatively. This may be useful e.g. to have
% chapter marks as long as no section marks have been made etc.
% \begin{macrocode}
@@ -806,14 +708,14 @@
\Ifstr{#2}{}{%
\Ifstr{#1}{}{%
% \end{macrocode}
-% \Macro{automark[]{}} or \Macro{automark{}} has been used. This will activate
+% \cs{automark[]{}} or \cs{automark{}} has been used. This will activate
% the low level mark commands, but doesn't change the high level commands. It
% may be useful or may not, the user should know what he does:
% \begin{macrocode}
\automark@basics
}{%
% \end{macrocode}
-% \Macro{automark[\dots]{}} has been used. This will activate the higher level
+% \cs{automark[\dots]{}} has been used. This will activate the higher level
% mark commands and also set up the right mark
% \begin{macrocode}
\automark@basics
@@ -822,7 +724,7 @@
}{%
\Ifstr{#1}{}{%
% \end{macrocode}
-% \Macro{automark[]{\dots}} or \Macro{automark{\dots}} has been used. This
+% \cs{automark[]{\dots}} or \cs{automark{\dots}} has been used. This
% will activate the low level mark commands and also set up either the left or
% both marks.
% \begin{macrocode}
@@ -830,7 +732,7 @@
\automark@leftlow{#2}%
}{%
% \end{macrocode}
-% \Macro{automark[\dots]{\dots}} has been used. This will activate the low
+% \cs{automark[\dots]{\dots}} has been used. This will activate the low
% level mark commands and also both high level marks.
% \begin{macrocode}
\automark@basics
@@ -840,7 +742,7 @@
}
% \end{macrocode}
% \begin{macro}{\automark@basics}
-% Activate all low level \Macro{@mk\dots} commands:
+% Activate all low level \cs{@mk\dots} commands:
% \begin{macrocode}
\newcommand*{\automark@basics}{%
\let\@mkleft\markleft
@@ -849,11 +751,11 @@
\def\@mkdouble##1{\@mkboth{##1}{##1}}%
}
% \end{macrocode}
-% \end{macro}%^^A \automark@basics
+% \end{macro}^^A \automark@basics
% \begin{macro}{\automark@righthigh}
% Set up the right mark of a higher level, but in single-side layout only if
-% \Option{autooneside} hasn't been used. Note, that with this definition no
-% special handling for \KOMAScript's \Macro{addchap} and \Macro{addsec} is
+% \opt{autooneside} hasn't been used. Note, that with this definition no
+% special handling for \KOMAScript's \cs{addchap} and \cs{addsec} is
% needed.
% \begin{macrocode}
\newcommand*{\automark@righthigh}[1]{%
@@ -877,7 +779,7 @@
}{}%
}
% \end{macrocode}
-% \end{macro}%^^A \automark@righthigh
+% \end{macro}^^A \automark@righthigh
% \begin{macro}{\automark@leftlow}
% Set up the left mark of a low level, but in single-side layout the right
% mark has to be used.
@@ -898,7 +800,7 @@
% In single-side mode there's no left high mark without a right low mark. So
% instead of only a left high mark, we set up both marks.
% \changes{v3.27}{2019/07/25}{replaced \cs{@empty} by \texttt{\{\}} to avoid
-% \textsf{babel} issue}%^^A
+% \textsf{babel} issue}
% \begin{macrocode}
\expandafter\@mkdouble
\fi
@@ -913,10 +815,10 @@
}{}%
}
% \end{macrocode}
-% \end{macro}%^^A \automark@leftlow
+% \end{macro}^^A \automark@leftlow
% \begin{macro}{\automark@both}
% Set up both marks, but in single-side layout depending on
-% \Option{autooneside}.
+% \opt{autooneside}.
% \begin{macrocode}
\newcommand*{\automark@both}[2]{%
\ifscrlayer@level@prepared{#1}{%
@@ -1006,25 +908,25 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@level@prepared
-% \end{macro}%^^A \automark@both
-% \end{macro}%^^A \@automark
-% \end{macro}%^^A \automark
+% \end{macro}^^A \ifscrlayer@level@prepared
+% \end{macro}^^A \automark@both
+% \end{macro}^^A \@automark
+% \end{command}^^A \automark
%
-% \begin{macro}{\DeclareSectionNumberDepth}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{command}{\DeclareSectionNumberDepth}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% \begin{description}
-% \item[\Parameter{string}:] the name of the section level, e.g.,
+% \item[\marg{string}:] the name of the section level, e.g.,
% part, chapter, section etc. (must be fully
% expandable and expand to a string).
-% \item[\Parameter{numeric expression}:] the section number depth of the
+% \item[\marg{numeric expression}:] the section number depth of the
% level, e.g., -1 for part, 0 for chapter etc.
% \end{description}
% Note that levels part, chapter, section, subsection, sub\dots subsection,
% paragraph, subparagraph, sub\dots subparagraph, minisec, subminisec,
% sub\dots subminisec will be recognised either at load time or at
-% \Macro{begin}\PParameter{document} automatically if they have the usual
-% levels.
+% \cs{begin}\texttt\{\env{document}\texttt\} automatically if they have the
+% usual levels.
% \begin{macrocode}
%<*package&body>
\newcommand*{\DeclareSectionNumberDepth}[2]{%
@@ -1050,16 +952,15 @@
}%
}
% \end{macrocode}
-% \begin{macro}{\scrlayer@level@list}
-% \begin{macro}{\scrlayer@level@init}
+% \begin{macro}{\scrlayer@level@list,\scrlayer@level@init}
% Stores all the existing levels.
% \begin{macrocode}
\newcommand*{\scrlayer@level@list}{}
% \end{macrocode}
% Usually all levels are known on loading this package, but if a package
% defines additional levels later we'll do an additional test at
-% \Macro{begin}\PParameter{document}. But we do not redo the part and the
-% chapter test.
+% \cs{begin}\texttt\{\env{document}\texttt\}. But we do not redo the part and
+% the chapter test.
% \begin{macrocode}
\scr@ifundefinedorrelax{part}{}{%
\DeclareSectionNumberDepth{part}{-1}%
@@ -1098,9 +999,8 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@level@init
-% \end{macro}%^^A \scrlayer@level@list
-% \end{macro}%^^A DeclareSectionNumberDepth
+% \end{macro}^^A \scrlayer@level@init,\scrlayer@level@list
+% \end{command}^^A DeclareSectionNumberDepth
%
%
% \subsection{Providing Layers}
@@ -1108,7 +1008,7 @@
% A layer is a virtual sheet of paper stacked behind or above the real sheet
% of paper. All the virtual and real sheets of one page may been seen
% simultanous, but material o one sheet may overlap material on sheets below.
-% Layers provided by \Package{scrlayer} will not be stacked below or above
+% Layers provided by \pkg*{scrlayer} will not be stacked below or above
% real sheets unless they are used by a page style.
%
% While we use \meta{key}\texttt{=}\meta{value} arguments for several of the
@@ -1120,11 +1020,11 @@
%</package&body>
% \end{macrocode}
%
-% \begin{macro}{\DeclareLayer}
+% \begin{command}{\DeclareLayer}
% \begin{description}
-% \item[\OParameter{option list}:] a comma separated list of
+% \item[\oarg{option list}:] a comma separated list of
% \texttt{\meta{key}=\meta{value}} pairs.
-% \item[\Parameter{string}:] the name of the layer (must be fully expandable
+% \item[\marg{string}:] the name of the layer (must be fully expandable
% and expand to a string only).
% \end{description}
% Layers are the basic elements of page styles. A layer has a name and several
@@ -1142,7 +1042,7 @@
\@namedef{scr@l@\scr@current@layer @h}{#4}%
}
% \end{macrocode}
-% \end{macro}%^^A \def@scr@l@pos
+% \end{macro}^^A \def@scr@l@pos
%
% There are basic, primitive attributes and compounding attributes. The basic
% attributes are:
@@ -1150,7 +1050,7 @@
% \item[\texttt{mode=\meta{command sequence}}:] the mode that should be used
% to output the \texttt{contents}. A command \cs{layer\meta{command
% sequence}mode} with one argument need to be defined.
-% \changes{v3.19}{2015/07/30}{new layer attribute \texttt{mode}}%^^A
+% \changes{v3.19}{2015/07/30}{new layer attribute \texttt{mode}}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{mode}{%
\scr@ifundefinedorrelax{layer#1mode}{\FamilyKeyStateUnknownValue}{%
@@ -1217,7 +1117,7 @@
% \end{macrocode}
% \item[\texttt{contents=\meta{output}}:] whatever should be printed by the
% layer.
-% \changes{v3.14}{2014/10/20}{\texttt{contents} is \cs{long}}%^^A
+% \changes{v3.14}{2014/10/20}{\texttt{contents} is \cs{long}}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{contents}{%
\long\@namedef{scr@l@\scr@current@layer @contents}{#1}%
@@ -1248,7 +1148,7 @@
% \end{macrocode}
% \item[\texttt{backandforeground}:] not really useful, but the counterpart of
% the restrictions above.
-% \changes{v3.18}{2015/05/14}{new layer feature \texttt{backandforeground}}%^^A
+% \changes{v3.18}{2015/05/14}{new layer feature \texttt{backandforeground}}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{backandforeground}[\relax]{%
\FamilyKeyStateProcessed
@@ -1316,7 +1216,7 @@
\ExecuteFamilyOptions[.definelayer]{KOMAarg}{oddorevenpage=#1}
}
% \end{macrocode}
-% \item[\Option{floatpage}:] restrict the layer to float pages.
+% \item[\opt{floatpage}:] restrict the layer to float pages.
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{floatpage}[\relax]{%
\FamilyKeyStateProcessed
@@ -1325,7 +1225,7 @@
\csname @scr@l@\scr@current@layer @floatpagetrue\endcsname
}
% \end{macrocode}
-% \item[\Option{nonfloatpage}:] restrict the layer to pages, which aren't
+% \item[\opt{nonfloatpage}:] restrict the layer to pages, which aren't
% float pages.
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{nonfloatpage}[\relax]{%
@@ -1335,7 +1235,7 @@
\csname @scr@l@\scr@current@layer @floatpagefalse\endcsname
}
% \end{macrocode}
-% \item[\Option{floatornonfloatpage}:] don't restrict the layer to float or
+% \item[\opt{floatornonfloatpage}:] don't restrict the layer to float or
% non-float pages.
% \changes{v3.18}{2015/05/14}{new layer feature \texttt{floatornonfloatpage}}
% \begin{macrocode}
@@ -1346,7 +1246,7 @@
\csname @scr@l@\scr@current@layer @floatpagetrue\endcsname
}
% \end{macrocode}
-% \item[\Option{nonfloatorfloatpage}:] same as \Option{floatornonfloatpage}
+% \item[\opt{nonfloatorfloatpage}:] same as \opt{floatornonfloatpage}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{nonfloatorfloatpage}[\relax]{%
\PackageWarning{scrlayer}{Option `nonfloatorfloatpage' unknown.\MessageBreak
@@ -1354,7 +1254,7 @@
\FamilyExecuteOptions[.definelayer]{KOMAarg}{floatornonfloatpage=#1}%
}
% \end{macrocode}
-% \item[\Option{floatandnonfloatpages}:] same as \Option{floatornonfloatpage}
+% \item[\opt{floatandnonfloatpages}:] same as \opt{floatornonfloatpage}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{floatandnonfloatpages}[\relax]{%
\PackageWarning{scrlayer}{Option `floatandnonfloatpages' unknown.\MessageBreak
@@ -1362,7 +1262,7 @@
\FamilyExecuteOptions[.definelayer]{KOMAarg}{floatornonfloatpage=#1}%
}
% \end{macrocode}
-% \item[\Option{nonfloatandfloatpages}:] same as \Option{floatornonfloatpage}
+% \item[\opt{nonfloatandfloatpages}:] same as \opt{floatornonfloatpage}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{nonfloatandfloatpages}[\relax]{%
\PackageWarning{scrlayer}{Option `nonfloatandfloatpages' unknown.\MessageBreak
@@ -1370,11 +1270,11 @@
\FamilyExecuteOptions[.definelayer]{KOMAarg}{floatornonfloatpage=#1}%
}
% \end{macrocode}
-% \item[\Option{everypage}:] remove all odd-, even-, float-, and
+% \item[\opt{everypage}:] remove all odd-, even-, float-, and
% nonfloat-restrictions.
-% \changes{v3.18}{2015/05/14}{new layer feature \texttt{everypage}}%^^A
+% \changes{v3.18}{2015/05/14}{new layer feature \texttt{everypage}}
% \changes{v3.22}{2016/09/24}{foreground and background condition
-% removed}%^^A
+% removed}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{everypage}[\relax]{%
\FamilyKeyStateProcessed
@@ -1385,7 +1285,7 @@
\csname @scr@l@\scr@current@layer @floatpagetrue\endcsname
}
% \end{macrocode}
-% \item[\Option{oneside}:] restrict the layer to pages on single-sided
+% \item[\opt{oneside}:] restrict the layer to pages on single-sided
% layouts.
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{oneside}[\relax]{%
@@ -1395,7 +1295,7 @@
\csname @scr@l@\scr@current@layer @onesidetrue\endcsname
}
% \end{macrocode}
-% \item[\Option{twoside}:] restrict the layer to pages on two-sided
+% \item[\opt{twoside}:] restrict the layer to pages on two-sided
% layouts.
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{twoside}[\relax]{%
@@ -1405,7 +1305,7 @@
\csname @scr@l@\scr@current@layer @onesidefalse\endcsname
}
% \end{macrocode}
-% \item[\Option{everyside}:] remove all one- or two-side restrictions.
+% \item[\opt{everyside}:] remove all one- or two-side restrictions.
% \changes{v3.18}{2015/05/14}{new layer feature \texttt{everyside}}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{everyside}[\relax]{%
@@ -1415,11 +1315,11 @@
\csname @scr@l@\scr@current@layer @onesidetrue\endcsname
}
% \end{macrocode}
-% \item[\Option{unrestricted}:] remove all restrictions
-% \changes{v3.18}{2015/05/14}{new layer feature \texttt{unrestricted}}%^^A
+% \item[\opt{unrestricted}:] remove all restrictions
+% \changes{v3.18}{2015/05/14}{new layer feature \texttt{unrestricted}}
% \changes{v3.22}{2016/09/24}{missing background and foreground
-% condition}%^^A
-% \changes{v3.22}{2016/09/24}{nonfloatpage condition fixed}%^^A
+% condition}
+% \changes{v3.22}{2016/09/24}{nonfloatpage condition fixed}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{unrestricted}[\relax]{%
\FamilyKeyStateProcessed
@@ -1434,24 +1334,24 @@
\csname @scr@l@\scr@current@layer @onesidetrue\endcsname
}
% \end{macrocode}
-% \changes{v3.26}{2018/07/14}{new attribute \texttt{beforecontents}}%^^A
-% \item[\Option{beforecontents}:] code to be executed immediately before
+% \changes{v3.26}{2018/07/14}{new attribute \texttt{beforecontents}}
+% \item[\opt{beforecontents}:] code to be executed immediately before
% setting the contents. See also modification attribute
% \texttt{addbeforecontents}.
% \begin{macrocode}
\FamilyCSKey[.definelayer]{KOMAarg}{beforecontents}
{scr@l@\scr@current@layer @precontents@hook}
% \end{macrocode}
-% \changes{v3.26}{2018/07/14}{new attribute \texttt{aftercontents}}%^^A
-% \item[\Option{aftercontents}:] code to be executed immediately before
+% \changes{v3.26}{2018/07/14}{new attribute \texttt{aftercontents}}
+% \item[\opt{aftercontents}:] code to be executed immediately before
% setting the contents. See also modification attribute
% \texttt{addaftercontents}.
% \begin{macrocode}
\FamilyCSKey[.definelayer]{KOMAarg}{aftercontents}
{scr@l@\scr@current@layer @postcontents@hook}
% \end{macrocode}
-% \changes{v3.26}{2018/07/14}{new attribute \texttt{artifact}}%^^A
-% \item[\Option{artifact}:] reserved for tagging packages. The artifact can
+% \changes{v3.26}{2018/07/14}{new attribute \texttt{artifact}}
+% \item[\opt{artifact}:] reserved for tagging packages. The artifact can
% either be a boolean or a general value. Boolean false will unset the
% attribute. Boolean true is the same like empty. All other values will be
% stored.
@@ -1477,7 +1377,7 @@
% Attribute modifications are attributes, that modify existing basic
% attributes:
% \begin{description}
-% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addhoffset}}%^^A
+% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addhoffset}}
% \item[\texttt{addhoffset=\meta{dimension expression}}:] add to offset from
% the left edge of the paper.
% \begin{macrocode}
@@ -1488,7 +1388,7 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addvoffset}}%^^A
+% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addvoffset}}
% \item[\texttt{addvoffset=\meta{dimension expression}}:] add to offset from
% the top edge of the paper.
% \begin{macrocode}
@@ -1499,7 +1399,7 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addwidth}}%^^A
+% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addwidth}}
% \item[\texttt{addwidth=\meta{dimension expression}}:] add to width of the
% layer.
% \begin{macrocode}
@@ -1510,7 +1410,7 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addheight}}%^^A
+% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addheight}}
% \item[\texttt{addheight=\meta{dimension expression}}:] add to height of the
% layer.
% \begin{macrocode}
@@ -1521,10 +1421,10 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addcontents}}%^^A
+% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{addcontents}}
% \item[\texttt{addcontents=\meta{output}}:] append to whatever should be
% printed by the layer.
-% \changes{v3.14}{2014/10/20}{\texttt{contents} is \cs{long}}%^^A
+% \changes{v3.14}{2014/10/20}{\texttt{contents} is \cs{long}}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{addcontents}{%
\expandafter\edef\csname scr@l@\scr@current@layer @contents\endcsname{%
@@ -1533,10 +1433,10 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{pretocontents}}%^^A
+% \changes{v3.16}{2015/01/26}{new layer attribute \texttt{pretocontents}}
% \item[\texttt{pretocontents=\meta{output}}:] prefix whatever should be
% printed by the layer.
-% \changes{v3.14}{2014/10/20}{\texttt{contents} is \cs{long}}%^^A
+% \changes{v3.14}{2014/10/20}{\texttt{contents} is \cs{long}}
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{pretocontents}{%
\expandafter\edef\csname scr@l@\scr@current@layer @contents\endcsname{%
@@ -1545,8 +1445,8 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.26}{2018/07/14}{new attribute \texttt{addbeforecontents}}%^^A
-% \item[\Option{addbeforecontents}:] code to be executed immediately before
+% \changes{v3.26}{2018/07/14}{new attribute \texttt{addbeforecontents}}
+% \item[\opt{addbeforecontents}:] code to be executed immediately before
% setting the contents. The new code will be added before the old code.
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{addbeforecontents}{%
@@ -1564,8 +1464,8 @@
\FamilyKeyStateProcessed
}
% \end{macrocode}
-% \changes{v3.26}{2018/07/14}{new attribute \texttt{addaftercontents}}%^^A
-% \item[\Option{addaftercontents}:] code to be executed immediately before
+% \changes{v3.26}{2018/07/14}{new attribute \texttt{addaftercontents}}
+% \item[\opt{addaftercontents}:] code to be executed immediately before
% setting the contents. The new code will be added after the old code.
% \begin{macrocode}
\DefineFamilyKey[.definelayer]{KOMAarg}{addaftercontents}{%
@@ -1818,7 +1718,7 @@
\@namedef{scr@l@\scr@current@layer @align}{tl}%
}
% \end{macrocode}
-% \item[\texttt{area=\{\meta{hoffset}\}\{\meta{voffset}\}%^^A
+% \item[\texttt{area=\{\meta{hoffset}\}\{\meta{voffset}\}
% \{\meta{width}\}\{\meta{height}\}}:] set up
% \texttt{hoffset}, \texttt{voffset}, \texttt{width}, and \texttt{height} to
% the given values.
@@ -1829,7 +1729,7 @@
}
% \end{macrocode}
% \changes{v3.26}{2018/07/14}{clone code for \texttt{precontents@hook},
-% \texttt{postcontents@hook} and \texttt{artifact} added}%^^A
+% \texttt{postcontents@hook} and \texttt{artifact} added}^^A
% \item[\texttt{clone=\meta{layer}}:] set up the new layer by the settings
% of the given \meta{layer}.
% \begin{macrocode}
@@ -1877,13 +1777,12 @@
\csname if@scr@l@#2@#3\expandafter\endcsname
}
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@clone@switch
-% \end{macro}%^^A \scrlayer@clone@attribute
+% \end{macro}^^A \scrlayer@clone@switch
+% \end{macro}^^A \scrlayer@clone@attribute
% \end{description}
%
-% \changes{v0.9}{2014/08/31}{missing reset of \cs{scr@current@layer}
-% added}%^^A
-% \changes{v3.14}{2014/10/20}{\cs{long}}%^^A
+% \changes{v0.9}{2014/08/31}{missing reset of \cs{scr@current@layer} added}
+% \changes{v3.14}{2014/10/20}{\cs{long}}
% \begin{macrocode}
\newcommand{\DeclareLayer}[2][]{%
\def\scr@current@layer{#2}%
@@ -1916,20 +1815,20 @@
% \end{macrocode}
% \begin{macro}{\scr@current@layer}
% Helper to hold the current layer and only valid in non recursive calls of
-% \Macro{DeclareLayer}.
+% \cs{DeclareLayer}.
% \begin{macrocode}
\newcommand*{\scr@current@layer}{}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scr@current@layer
-% \end{macro}%^^A \DeclareLayer
+% \end{macro}^^A \scr@current@layer
+% \end{command}^^A \DeclareLayer
%
-% \begin{macro}{\IfLayerExists}
+% \begin{command}{\IfLayerExists}
% \begin{description}
-% \item[\Parameter{string}:] the name of the layer (must be fully expandable
+% \item[\marg{string}:] the name of the layer (must be fully expandable
% and expand to a string only).
-% \item[\Parameter{then code}:] will be executed, if the layer exists.
-% \item[\Parameter{else code}:] will be executed, if the layer doesn't exist.
+% \item[\marg{then code}:] will be executed, if the layer exists.
+% \item[\marg{else code}:] will be executed, if the layer doesn't exist.
% \end{description}
% Note, that we don't known really whether or not a layer exists, but have a
% heuristic.
@@ -1944,19 +1843,15 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \IfLayerExists
+% \end{command}^^A \IfLayerExists
%
-% \begin{macro}{\DeclareNewLayer}
-% \changes{v3.14}{2014/10/20}{\cs{long}}%^^A
-% \begin{macro}{\ProvideLayer}
-% \changes{v3.14}{2014/10/20}{\cs{long}}%^^A
-% \begin{macro}{\RedeclareLayer}
-% \changes{v3.14}{2014/10/20}{\cs{long}}%^^A
-% \begin{macro}{\ModifyLayer}
-% \changes{v3.14}{2014/10/20}{\cs{long}}%^^A
+% \begin{command}{\DeclareNewLayer,\ProvideLayer,\RedeclareLayer}
+% \changes{v3.14}{2014/10/20}{\cs{long}}
+% \begin{command}{\ModifyLayer}
+% \changes{v3.14}{2014/10/20}{\cs{long}}
% \changes{v0.9}{2014/08/31}{missing definition and reset of
-% \cs{scr@current@layer} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \cs{scr@current@layer} added}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% There are also two commands for declaration of layers, that haven't been
% declared before, with or without error message for already declared layers,
% and two commands for changing already declared layers, first one beginning
@@ -2021,14 +1916,12 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \ModifyLayer
-% \end{macro}%^^A \RedeclareLayer
-% \end{macro}%^^A \ProvideLayer
-% \end{macro}%^^A \DeclareNewLayer
+% \end{command}^^A \ModifyLayer
+% \end{command}^^A \DeclareNewLayer,\ProvideLayer,\RedeclareLayer
%
-% \begin{macro}{\ModifyLayers}
-% \changes{v3.26}{2018/07/14}{new}%^^A
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
+% \begin{command}{\ModifyLayers}
+% \changes{v3.26}{2018/07/14}{added}
+% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}
% Like \cs{ModifyLayer} but allows a list of layers instead of only one layer.
% For the commands \cs{DeclareLayer}, \cs{ProvideLayer} and
% \cs{RedeclareLayer} this does not make any sense, so there are not similar
@@ -2050,12 +1943,12 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \ModifyLayers
+% \end{command}^^A \ModifyLayers
%
-% \begin{macro}{\GetLayerContents}
-% \changes{v3.16}{2015/01/26}{new}
+% \begin{command}{\GetLayerContents}
+% \changes{v3.16}{2015/01/26}{added}
% \begin{description}
-% \item[\Parameter{string}:] the name of the layer
+% \item[\marg{string}:] the name of the layer
% \end{description}
% Get the contents of the given layer.
% \begin{macrocode}
@@ -2068,22 +1961,22 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
%
-% \begin{macro}{\DestroyLayer}
+% \begin{command}{\DestroyLayer}
% \changes{v3.26}{2018/07/14}{destroy pre-contents hook, post-contents hook
-% and artifact}%^^A
+% and artifact}
% \begin{description}
-% \item[\Parameter{string}:] the name of the layer, that should be
+% \item[\marg{string}:] the name of the layer, that should be
% destroyed
% \end{description}
% Note: Nothing will be done to remove the layer from a page style, but this
% shouldn't matter, because layers with, e.g.,
-% \Macro{if@scr@l@\dots@nonfloatpage}=\Macro{relax} and
-% \Macro{if@scr@l@\dots@floatpage}=\Macro{relax} won't be output ever. This
+% \cs{if@scr@l@\dots@nonfloatpage}=\cs{relax} and
+% \cs{if@scr@l@\dots@floatpage}=\cs{relax} won't be output ever. This
% command could be used by interfaces via
-% \Macro{scrlayerOnAutoRemoveInterface} to remove the generated
+% \cs{scrlayerOnAutoRemoveInterface} to remove the generated
% layers, if the interface commands wouldn't be depreacted.
% However, it only destroys existing layers and doesn't care for not
% existing.
@@ -2136,11 +2029,11 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \DestroyLayer
+% \end{command}^^A \DestroyLayer
%
%
-% \begin{macro}{\layercontentsmeasure}
-% \changes{v3.19}{2015/07/27}{\cs{@gobble} eliminated}%^^A
+% \begin{command}{\layercontentsmeasure}
+% \changes{v3.19}{2015/07/27}{\cs{@gobble} eliminated}
% This may used by used as the only value of the layer option
% \texttt{contents} to show measure lines around the layer. The left and the
% top measure line will be in centimeter, the right and the bottom measure
@@ -2233,8 +2126,8 @@
\end{picture}}%
}
% \end{macrocode}
-% \begin{macro}{\LenToUnit}
-% \changes{v3.19}{2015/07/27}{new}
+% \begin{command}{\LenToUnit}
+% \changes{v3.19}{2015/07/27}{added}
% Due to an incompatibility of package \textsf{curve2e} I've eliminated
% \cs{@gobble} in the definition of \cs{layercontentsmeasure} and replaced it
% sometimes by \cs{LenToUnit} with the (not long) definition suggested by
@@ -2243,8 +2136,8 @@
\providecommand*{\LenToUnit}[1]{\strip@pt\dimexpr#1*\p@/\unitlength}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \LenToUnit
-% \end{macro}%^^A \layercontentsmeasure
+% \end{command}^^A \LenToUnit
+% \end{command}^^A \layercontentsmeasure
%
%
% \subsection{Providing Page Styles}
@@ -2261,7 +2154,7 @@
% will be used only at two-sided mode. At one-sided mode the header and footer
% for odd pages will be used for all pages.
%
-% With package \Package{scrlayer} layers will be linked to package styles and
+% With package \pkg*{scrlayer} layers will be linked to package styles and
% expanded at the four elements above. Background layers will expand only
% at the headers. Foreground layers will expand only at the
% footers. Layers, that haven't been restricted to background or foreground,
@@ -2284,14 +2177,14 @@
% floats.
%
% \begin{length}{\footheight}
-% For the header \LaTeX{} already defines a length \Length{headheight} to be
+% For the header \LaTeX{} already defines a length \len{headheight} to be
% the maximum height of the header. But for footer it only defines the
% distance of the baseline of the footer from the last baseline of the text
-% area. \Package{scrlayer} changes this and also defines a new length
-% \Length{footheight}. This length will be initialised with magic value
+% area. \pkg*{scrlayer} changes this and also defines a new length
+% \len{footheight}. This length will be initialised with magic value
% -12345\,sp. But if it is still that magic value at
-% \Macro{begin}\PParameter{document} it will be reset to the value of
-% \Length{baselineskip}.
+% \cs{begin}\texttt\{\env{document}\texttt\} it will be reset to the value of
+% \len{baselineskip}.
% \begin{macrocode}
%<*package&init>
\@ifundefined{footheight}{%
@@ -2316,7 +2209,7 @@
}
%</package&init>
% \end{macrocode}
-% \end{length}%^^A \footheight
+% \end{length}^^A \footheight
%
%
% Several of the following commands use \meta{key}=\meta{value} arguments. So
@@ -2328,13 +2221,13 @@
%</package&body>
% \end{macrocode}
%
-% \begin{macro}{\DeclarePageStyleByLayers}
+% \begin{command}{\DeclarePageStyleByLayers}
% \begin{description}
-% \item[\OParameter{option list}:] comma separated list of named page
+% \item[\oarg{option list}:] comma separated list of named page
% style options (see below).
-% \item[\Parameter{string}:] the name of the page style to be declared (must
+% \item[\marg{string}:] the name of the page style to be declared (must
% be expandable and result in a string).
-% \item[\Parameter{string list}:] comma separated list of layer names (must
+% \item[\marg{string list}:] comma separated list of layer names (must
% be expandable and result in strings); first in the list will be added
% first.
% \end{description}
@@ -2345,8 +2238,8 @@
% pages in \cs{@oddhead}, all background layers for even pages on
% \cs{@evenhead}, all foreground layers for odd pages in \cs{@oddfoot}, and
% all foreground layers for even pages in \cs{@evenfoot}. This may be
-% restricted by additional attributes, e.g., \Option{oneside} and
-% \Option{twoside}.
+% restricted by additional attributes, e.g., \opt{oneside} and
+% \opt{twoside}.
%
% The optional argument may be used to define hooks. There are six named
% optional arguments to set up six hooks. And there are also \KOMAScript{}
@@ -2355,13 +2248,13 @@
% argument are named similar, but without ``\texttt{ps}'' after
% ``\texttt{on}''.
% \begin{option}{onselect}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsselect}
% \begin{macro}{\@ps@initialhook}
% \begin{description}
% \item[\texttt{=\meta{code}}:] executes \meta{code} whenever the
-% page style will be selected, e.g. using \Macro{pagestyle} or
-% \Macro{thispagestyle} or the low level command defining the page
+% page style will be selected, e.g. using \cs{pagestyle} or
+% \cs{thispagestyle} or the low level command defining the page
% style itself.
% \end{description}
% \begin{macrocode}
@@ -2391,8 +2284,8 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@initialhook
-% \end{option}%^^A onpsselect
+% \end{macro}^^A \@ps@initialhook
+% \end{option}^^A onpsselect
% \begin{option}{onpsinit}
% \begin{macro}{\@ps@hook}
% \begin{description}
@@ -2428,16 +2321,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@hook
-% \end{option}%^^A onpsinit
-% \end{option}%^^A oninit
+% \end{macro}^^A \@ps@hook
+% \end{option}^^A onpsinit
+% \end{option}^^A oninit
% \begin{option}{ononeside}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsoneside}
% \begin{macro}{\@ps@onesidehook}
% \begin{description}
-% \item[\Option{=\meta{code}}:] executes \meta{code} after
-% \Option{oninit}'s \meta{code} whenever the output of a layer stack of a
+% \item[\opt{=\meta{code}}:] executes \meta{code} after
+% \opt{oninit}'s \meta{code} whenever the output of a layer stack of a
% page in single-side layout is initialised. Note, that \meta{code} must not
% result in any page output. Otherwise the output of the layer stack will be
% broken!
@@ -2469,16 +2362,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@onesidehook
-% \end{option}%^^A onpsoneside
-% \end{option}%^^A ononeside
+% \end{macro}^^A \@ps@onesidehook
+% \end{option}^^A onpsoneside
+% \end{option}^^A ononeside
% \begin{option}{ontwoside}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpstwoside}
% \begin{macro}{\@ps@twosidehook}
% \begin{description}
-% \item[\Option{=\meta{code}}:] executes \meta{code} after
-% \Option{oninit}'s \meta{code} whenever the output of a layer stack of a
+% \item[\opt{=\meta{code}}:] executes \meta{code} after
+% \opt{oninit}'s \meta{code} whenever the output of a layer stack of a
% page in two-side layout is initialised. Note, that \meta{code} must not
% result in any page output. Otherwise the output of the layer stack will be
% broken!
@@ -2510,16 +2403,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@twosidehook
-% \end{option}%^^A onpstwoside
-% \end{option}%^^A ontwoside
+% \end{macro}^^A \@ps@twosidehook
+% \end{option}^^A onpstwoside
+% \end{option}^^A ontwoside
% \begin{option}{onoddpage}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsoddpage}
% \begin{macro}{\@ps@oddpagehook}
% \begin{description}
% \item[\texttt{=\meta{code}}:] executes \meta{code} after
-% \Option{ononeside}'s or \Option{ontwoside}'s \meta{code} whenever the
+% \opt{ononeside}'s or \opt{ontwoside}'s \meta{code} whenever the
% output of a layer stack of an odd page is initialised. Note, that
% \meta{code} must not result in any page output. Otherwise the output of
% the layer stack will be broken!
@@ -2551,16 +2444,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@oddpagehook
-% \end{option}%^^A onpsoddpage
-% \end{option}%^^A onoddside
+% \end{macro}^^A \@ps@oddpagehook
+% \end{option}^^A onpsoddpage
+% \end{option}^^A onoddside
% \begin{option}{onevenpage}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsevenpage}
% \begin{macro}{\@ps@evenpagehook}
% \begin{description}
% \item[\texttt{=\meta{code}}:] executes \meta{code} after
-% \Option{ononeside}'s or \Option{ontwoside}'s \meta{code} whenever the
+% \opt{ononeside}'s or \opt{ontwoside}'s \meta{code} whenever the
% output of a layer stack of an even page is initialised. Note, that
% \meta{code} must not result in any page output. Otherwise the output of
% the layer stack will be broken!
@@ -2592,16 +2485,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@evenpagehook
-% \end{option}%^^A onpsevenpage
-% \end{option}%^^A onevenside
+% \end{macro}^^A \@ps@evenpagehook
+% \end{option}^^A onpsevenpage
+% \end{option}^^A onevenside
% \begin{option}{onfloatpage}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsfloatpage}
% \begin{macro}{\@ps@floatpagehook}
% \begin{description}
-% \item[\Option{=\meta{code}}:] executes \meta{code} after
-% \Option{onoddpage}'s or \Option{onevenpage}'s \meta{code} whenever a float
+% \item[\opt{=\meta{code}}:] executes \meta{code} after
+% \opt{onoddpage}'s or \opt{onevenpage}'s \meta{code} whenever a float
% column has been made (usually those pages are float pages).
% \end{description}
% \begin{macrocode}
@@ -2631,16 +2524,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@floatpagehook
-% \end{option}%^^A onpsfloatpage
-% \end{option}%^^A onfloatpage
+% \end{macro}^^A \@ps@floatpagehook
+% \end{option}^^A onpsfloatpage
+% \end{option}^^A onfloatpage
% \begin{option}{onnonfloatpage}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsnonfloatpage}
% \begin{macro}{\@ps@nonfloatpagehook}
% \begin{description}
-% \item[\Option{=\meta{code}}:] executes \meta{code} after
-% \Option{onoddpage}'s or \Option{onevenpage}'s \meta{code} whenever no
+% \item[\opt{=\meta{code}}:] executes \meta{code} after
+% \opt{onoddpage}'s or \opt{onevenpage}'s \meta{code} whenever no
% float column has been made (usually those pages aren't float pages).
% \end{description}
% \begin{macrocode}
@@ -2670,16 +2563,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@nonfloatpagehook
-% \end{option}%^^A onpsnonfloatpage
-% \end{option}%^^A onnonfloatpage
+% \end{macro}^^A \@ps@nonfloatpagehook
+% \end{option}^^A onpsnonfloatpage
+% \end{option}^^A onnonfloatpage
% \begin{option}{onbackground}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsbackground}
% \begin{macro}{\@ps@backgroundhook}
% \begin{description}
% \item[\texttt{=\meta{code}}:] executes \meta{code} after
-% \Option{onfloatpage}'s or \Option{onnonfloatpage}'s \meta{code} whenever
+% \opt{onfloatpage}'s or \opt{onnonfloatpage}'s \meta{code} whenever
% the output of a background layer stack is initialised. Note, that
% \meta{code} must not result in any page output. Otherwise the output of
% the layer stack will be broken!
@@ -2711,16 +2604,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@ps@backgroundhook
-% \end{option}%^^A onbackground
-% \end{option}%^^A onbackground
+% \end{macro}^^A \@ps@backgroundhook
+% \end{option}^^A onbackground
+% \end{option}^^A onbackground
% \begin{option}{onforeground}
-% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}%^^A
+% \changes{v3.28}{2019/11/28}{marker for \cs{ModifyLayerPageStyleOptions}}
% \begin{option}{onpsforeground}
% \begin{macro}{\@ps@foregroundhook}
% \begin{description}
% \item[\texttt{=\meta{code}}:] executes \meta{code} after
-% \Option{onfloatpage}'s or \Option{onnonfloatpage}'s \meta{code} whenever
+% \opt{onfloatpage}'s or \opt{onnonfloatpage}'s \meta{code} whenever
% the output of a foreground layer stack is initialised. Note, that
% \meta{code} must not result in any page output. Otherwise the output of
% the layer stack will be broken!
@@ -2752,16 +2645,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \@psforegroundhook
-% \end{option}%^^A onpsforeground
-% \end{option}%^^A onforeground
+% \end{macro}^^A \@psforegroundhook
+% \end{option}^^A onpsforeground
+% \end{option}^^A onforeground
% \begin{option}{singlespacing}
-% \changes{v3.24}{2017/05/22}{new option added}%^^A
+% \changes{v3.24}{2017/05/22}{added}
% \begin{description}
% \item[\texttt{=\meta{simple switch}}:] if activated, all page styles will be
% set with line spread 1. This switch is global. If you want it for some
-% styles only, add \Macro{linespread}\PParameter{1}\Macro{selectfont} to
-% option \Option{oninit} of only those styles.
+% styles only, add \cs{linespread}|{1}|\cs{selectfont} to
+% option \opt{oninit} of only those styles.
%\end{description}
% \begin{macrocode}
%<*options>
@@ -2781,13 +2674,13 @@
% \end{macrocode}
% \begin{macro}{\scrlayer@declare@ps@by@layers}
% \changes{v3.15}{2014/12/28}{fix: \cs{linewidth} replaced by
-% \cs{textwidth}}%^^A
+% \cs{textwidth}}
% \changes{v3.18}{2015/06/09}{usage of \cs{parbox[b]} instead of
% \cs{parbox[t]} because of strange effect with package
-% \textsf{multicol}}%^^A
-% \changes{v3.24}{2017/05/22}{test for \cs{if@ps@singlespacing} added}%^^A
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \textsf{multicol}}
+% \changes{v3.24}{2017/05/22}{test for \cs{if@ps@singlespacing} added}
+% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% Needed, because of page style aliases. Same arguments like
% \cs{DeclarePageStyleByLayers} but, \#1 is the name of the page style, \#2 is
% the list of options and \#3 is still the list of layers.
@@ -2952,17 +2845,17 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@declare@ps@by@layers
+% \end{macro}^^A \scrlayer@declare@ps@by@layers
%
-% \begin{macro}{\ForEachLayerOfPageStyle}
-% \changes{v3.18}{2015/05/14}{star version of the command}%^^A
+% \begin{command}{\ForEachLayerOfPageStyle}
+% \changes{v3.18}{2015/05/14}{star version of the command}
% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar}
-% ersetzt}%^^A
+% ersetzt}
% \begin{description}
-% \item[\Parameter{string}:] a valid page style (must be fully expandable
+% \item[\marg{string}:] a valid page style (must be fully expandable
% and expand to the name of a existing page style); note, that currently
% no exists test will be done.
-% \item[\Parameter{code}:] any macro definition body with usage of at most
+% \item[\marg{code}:] any macro definition body with usage of at most
% one argument (\texttt{\#1}), that will be replaced by the layer's name
% \end{description}
% Do the given \meta{code} for each layer of the page style
@@ -2998,12 +2891,12 @@
% \begin{option}{deactivatepagestylelayers}
% \begin{macro}{\ifscrlayer@deactivate@layers}
% \begin{description}
-% \item[\Parameter{simple switch}:] whether or not
-% \Macro{ForEachLayerOfPageStyle} should ignore the layers.
+% \item[\marg{simple switch}:] whether or not
+% \cs{ForEachLayerOfPageStyle} should ignore the layers.
% \end{description}
% This is a global \KOMAScript{} options. Several other definitions and at
% least the usage of the page style will ignore the layers if
-% \Macro{ForEachLayerOfPageStyle} ignores them. So this is something like:
+% \cs{ForEachLayerOfPageStyle} ignores them. So this is something like:
% hide the layers. It may also be useful inside the code for the hooks
% described above, because hooks may used to deactivate the layers with this
% option too.
@@ -3030,12 +2923,12 @@
\relax
%</interface&body>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@deactivate@layers
-% \end{option}%^^A deactivatepagestylelayers
-% \end{macro}%^^A \ForEachLayerOfPageStyle
+% \end{macro}^^A \ifscrlayer@deactivate@layers
+% \end{option}^^A deactivatepagestylelayers
+% \end{command}^^A \ForEachLayerOfPageStyle
%
% \begin{macro}{\scrlayer@do@page@style@element@layer}
-% \changes{v3.26}{2018/07/14}{added hooks and artifact code}%^^A
+% \changes{v3.26}{2018/07/14}{added hooks and artifact code}
% Helper macro to show one layer. First argument is either ``background'' or
% ``foreground'', second argument is either ``odd'' or ``even'', and third
% argument is the name of the layer. Note, that in draft mode for every layer
@@ -3102,13 +2995,13 @@
}
% \end{macrocode}
% \begin{macro}{\scrlayer@predraftmeasure@hook}
-% \changes{v3.26}{2018/07/14}{new (internal)}%^^A
+% \changes{v3.26}{2018/07/14}{added}
% The hooks that will be executed before setting the draft measuring.
% \begin{macrocode}
\newcommand*{\scrlayer@predraftmeasure@hook}{}
% \end{macrocode}
-% \begin{macro}{\BeforeDraftMeasuringLayer}
-% \changes{v3.26}{2018/07/14}{new}%^^A
+% \begin{command}{\BeforeDraftMeasuringLayer}
+% \changes{v3.26}{2018/07/14}{added}
% New code will be added in front of the hook.
% \begin{macrocode}
\newcommand*{\BeforeDraftMeasuringLayer}[1]{%
@@ -3117,16 +3010,16 @@
}%
}
% \end{macrocode}
-% \end{macro}%^^A \BeforeDraftMeasuringLayer
-% \end{macro}%^^A \scrlayer@predraftmeasure@hook
+% \end{command}^^A \BeforeDraftMeasuringLayer
+% \end{macro}^^A \scrlayer@predraftmeasure@hook
% \begin{macro}{\scrlayer@postdraftmeasure@hook}
-% \changes{v3.26}{2018/07/14}{new (internal)}%^^A
+% \changes{v3.26}{2018/07/14}{added}
% The hook that will be executed after setting the draft measuring.
% \begin{macrocode}
\newcommand*{\scrlayer@postdraftmeasure@hook}{}
% \end{macrocode}
-% \begin{macro}{\AfterDraftMeasuringLayer}
-% \changes{v3.26}{2018/07/14}{new}%^^A
+% \begin{command}{\AfterDraftMeasuringLayer}
+% \changes{v3.26}{2018/07/14}{added}
% New code will be added at the end of the hook.
% \begin{macrocode}
\newcommand*{\AfterDraftMeasuringLayer}[1]{%
@@ -3135,16 +3028,16 @@
}%
}
% \end{macrocode}
-% \end{macro}%^^A \AfterDraftMeasuringLayer
-% \end{macro}%^^A \scrlayer@postdraftmeasure@hook
+% \end{command}^^A \AfterDraftMeasuringLayer
+% \end{macro}^^A \scrlayer@postdraftmeasure@hook
% \begin{macro}{\scr@layerbox}
% \changes{v3.20}{2016/04/12}{\cs{@ifnextchar} replaced by
-% \cs{kernel@ifnextchar}}%^^A
+% \cs{kernel@ifnextchar}}
% \begin{macro}{\scr@@layerbox}
-% \changes{v3.24}{2017/05/08}{\cs{edef} replaced by \cs{protected@edef}}%^^A
-% \changes{v3.24}{2017/05/08}{\cs{dimexpr} added to \cs{layer\dots}}%^^A
+% \changes{v3.24}{2017/05/08}{\cs{edef} replaced by \cs{protected@edef}}
+% \changes{v3.24}{2017/05/08}{\cs{dimexpr} added to \cs{layer\dots}}
% \changes{v3.24}{2017/05/08}{\cs{dimexpr} removed from usage of
-% \cs{layer\dots}}%^^A
+% \cs{layer\dots}}
% The layer box is used to output a layer in \cs{@oddhead}, \cs{@evenhead},
% \cs{@oddfoot}, or \cs{@evenfoot}. Is has two pairs of arguments: ($x,y$)
% and ($w,h$), where $x$ is the distance from left paper edge, $y$ is the
@@ -3199,8 +3092,8 @@
\if b\layervalign\vskip-\layerheight\fi
\if c\layervalign\vskip-.5\layerheight\fi
% \end{macrocode}
-% \changes{3.23a}{2017/04/22}{\textsf{bidi} code added}%^^A
-% \changes{v3.24}{2017/05/04}{usage of \textsf{scrbase}'s \cs{IfRTL}}%^^A
+% \changes{3.23a}{2017/04/22}{\textsf{bidi} code added}
+% \changes{v3.24}{2017/05/04}{usage of \textsf{scrbase}'s \cs{IfRTL}}
% If we are in right-to-left mode of package \textsf{bidi} or
% \textsf{xepersian} the horizontal output is in the opposite direction. So we
% need the \cs{makebox} to the right instead of the left and to move the
@@ -3227,13 +3120,11 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scr@@layerbox
-% \end{macro}%^^A \scr@layerbox
+% \end{macro}^^A \scr@@layerbox
+% \end{macro}^^A \scr@layerbox
%
-% \begin{macro}{\layerrawmode}
-% \changes{v3.19}{2015/07/30}{new command}%^^A
-% \begin{macro}{\layertextmode}
-% \changes{v3.19}{2015/07/30}{new command}%^^A
+% \begin{command}{\layerrawmode,\layertextmode}
+% \changes{v3.19}{2015/07/30}{added}
% This is the command to output layers in raw mode. This is very simple:
% \begin{macrocode}
%<*package&body>
@@ -3241,12 +3132,11 @@
\newcommand{\layertextmode}[1]{#1}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \layertextmode
-% \end{macro}%^^A \layerrawmode
+% \end{command}^^A \layerrawmode,\layertextmode
%
-% \begin{macro}{\layerpicturemode}
-% \changes{v3.19}{2015/07/30}{new command}%^^A
-% \changes{v3.24}{2017/05/08}{redundant \cs{dimexpr} removed}%^^A
+% \begin{command}{\layerpicturemode}
+% \changes{v3.19}{2015/07/30}{added}
+% \changes{v3.24}{2017/05/08}{redundant \cs{dimexpr} removed}
% This is a bit more complicated. It is the layer output for \texttt{picture}
% layers. In this case we use a picture environment and internally define some
% additional commands.
@@ -3273,16 +3163,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \layerpicturemode
+% \end{command}^^A \layerpicturemode
%
% \begin{option}{draft}
-% \begin{macro}{\ifscrlayer@draft}
+% \begin{macro}{\ifscrlayer@draft,\scrlayer@drafttrue,\scrlayer@draftfalse}
% \begin{description}
-% \item[\Parameter{simple switch}:] whether or not to use the draft mode,
+% \item[\marg{simple switch}:] whether or not to use the draft mode,
% that, i.e., activates visualisation of the layers.
% \end{description}
% When option is set, every layer is shown twice: one time with it's own
-% contents and one time with contents \Macro{layercontentsmeasure}.
+% contents and one time with contents \cs{layercontentsmeasure}.
% \begin{macrocode}
%<*options>
%<*package>
@@ -3303,20 +3193,20 @@
\csname KV@KOMA.\@currname.\@currext @draft@default\endcsname\relax
%</interface&body>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@draft
-% \end{option}%^^A draft
-% \end{macro}%^^A \scrlayer@do@page@style@element@layer
-% \end{macro}%^^A \DeclarePageStyleByLayers
+% \end{macro}^^A \ifscrlayer@draft
+% \end{option}^^A draft
+% \end{macro}^^A \scrlayer@do@page@style@element@layer
+% \end{command}^^A \DeclarePageStyleByLayers
%
%
-% \begin{macro}{\DeclareNewPageStyleByLayers}
-% Arguments like \Macro{DeclarePageStyleByLayers}; results in error if the page
+% \begin{command}{\DeclareNewPageStyleByLayers}
+% Arguments like \cs{DeclarePageStyleByLayers}; results in error if the page
% style has been defined (or declared) already.
-% \begin{macro}{\ProvidePageStyleByLayers}
-% Arguments like \Macro{DeclarePageStyleByLayers}; doesn't define anything it
+% \begin{command}{\ProvidePageStyleByLayers}
+% Arguments like \cs{DeclarePageStyleByLayers}; doesn't define anything it
% the page style has been defined (or declared) already.
-% \begin{macro}{\RedeclarePageStyleByLayers}
-% Arguments like \Macro{DeclarePageStyleByLayers}; results in error if the page
+% \begin{command}{\RedeclarePageStyleByLayers}
+% Arguments like \cs{DeclarePageStyleByLayers}; results in error if the page
% style hasn't been defined (or declared) already.
% \begin{macrocode}
%<*package&body>
@@ -3379,47 +3269,48 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \RedeclarePageStyleByLayers
-% \end{macro}%^^A \ProvidePageStyleByLayers
-% \end{macro}%^^A \DeclareNewPageStyleByLayers
+% \end{command}^^A \RedeclarePageStyleByLayers
+% \end{command}^^A \ProvidePageStyleByLayers
+% \end{command}^^A \DeclareNewPageStyleByLayers
%
-% We also declare page style \Pagestyle{@everystyle@} by default. You should
+% \begin{pgstyle}{@everystyle@,empty}
+% We also declare page style \pstyle{@everystyle@} by default. You should
% not use this page style as an real page style (even not as the empty
% one). The layers of this page style will be used by every other layer page
-% style. An we re-declare \Pagestyle{empty} to be a layer page style.
+% style. An we re-declare \pstyle{empty} to be a layer page style.
% \begin{macrocode}
%<*package&final>
\DeclareNewPageStyleByLayers{@everystyle@}{}
\RedeclarePageStyleByLayers{empty}{}
%</package&final>
% \end{macrocode}
+% \end{pgstyle}
%
-% \begin{macro}{\AddLayersToPageStyle}
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{macro}{\AddLayersAtBeginOfPageStyle}
-% \begin{macro}{\AddLayersAtEndOfPageStyle}
-% \begin{macro}{\RemoveLayersFromPageStyle}
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{command}{\AddLayersToPageStyle}
+% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{command}{\AddLayersAtBeginOfPageStyle,\AddLayersAtEndOfPageStyle}
+% \begin{command}{\RemoveLayersFromPageStyle}
+% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be modified (must
+% \item[\marg{string}:] the name of the page style to be modified (must
% be expandable and result in a string).
-% \item[\Parameter{string list}:] comma separated list of layer names (must
+% \item[\marg{string list}:] comma separated list of layer names (must
% be expandable and result in strings); first in the list will be added
% first.
% \end{description}
% Change the layer list of a given page style. The differences between the
% commands are:
% \begin{description}
-% \item[\Macro{AddLayersToPageStyle}:] first in the \meta{string list} will
+% \item[\cs{AddLayersToPageStyle}:] first in the \meta{string list} will
% be added first at the end.
-% \item[\Macro{AddLayersAtBeginOfPageStyle}:] first in the \meta{string list}
+% \item[\cs{AddLayersAtBeginOfPageStyle}:] first in the \meta{string list}
% will be added first at the start. Note, that this will result in changing
% the order of the layers in \meta{string list}.
-% \item[\Macro{AddLayerAtEndOfPageStyle}:] same like
-% \Macro{AddLayerToPageStyle}.
-% \item[\Macro{RemoveLayersFromPageStyle}:] remove the layers from the page
+% \item[\cs{AddLayerAtEndOfPageStyle}:] same like
+% \cs{AddLayerToPageStyle}.
+% \item[\cs{RemoveLayersFromPageStyle}:] remove the layers from the page
% style's layer list.
% \end{description}
% \begin{macrocode}
@@ -3456,7 +3347,7 @@
\begingroup\let\@elt\relax\xdef#1{\@elt #2#1}\endgroup
}
% \end{macrocode}
-% \end{macro}%^^A \@snoc
+% \end{macro}^^A \@snoc
% \begin{macrocode}
\newcommand*{\RemoveLayersFromPageStyle}[2]{%
\edef\reserved@b{\GetRealPageStyle{#1}}%
@@ -3475,7 +3366,7 @@
% \end{macrocode}
% \begin{macro}{\remove@layer@from@page@style}
% \changes{v0.9}{2014/07/25}{cleaning of layer list must be global}
-% \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}}
% Helper macro to remove exactly one layer (arg 1) from a page style (arg 2).
% \begin{macrocode}
\newcommand*{\remove@layer@from@page@style}[2]{%
@@ -3490,12 +3381,12 @@
\endgroup
}
% \end{macrocode}
-% \end{macro}%^^A \remoce@layer@from@page@style
+% \end{macro}^^A \remoce@layer@from@page@style
% \begin{macro}{\scrlayer@lpm@error}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be modified (must
+% \item[\marg{string}:] the name of the page style to be modified (must
% be expandable and result in a string).
-% \item[\Parameter{string}:] the kind of modification, that isn't allowed
+% \item[\marg{string}:] the kind of modification, that isn't allowed
% (must be expandable and result in a string).
% \end{description}
% Show an error because of page style it either not a defined or not a layer
@@ -3518,27 +3409,24 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@lpm@error
-% \end{macro}%^^A \RemoveLayersFromPageStyle
-% \end{macro}%^^A \AddLayersAtEndOfPageStyle
-% \end{macro}%^^A \AddLayersAtBeginOfPageStyle
-% \end{macro}%^^A \AddLayersToPageStyle
+% \end{macro}^^A \scrlayer@lpm@error
+% \end{command}^^A \RemoveLayersFromPageStyle
+% \end{command}^^A \AddLayersAtBeginOfPageStyle,\AddLayersAtEndOfPageStyle
+% \end{command}^^A \AddLayersToPageStyle
%
-% \begin{macro}{\AddLayersToPageStyleBeforeLayer}
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{macro}{\AddLayersToPageStyleAfterLayer}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
+% \begin{command}{\AddLayersToPageStyleBeforeLayer,
+% \AddLayersToPageStyleAfterLayer}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be modified (must
+% \item[\marg{string}:] the name of the page style to be modified (must
% be expandable and result in a string).
-% \item[\Parameter{string list}:] comma separated list of layer names (must
+% \item[\marg{string list}:] comma separated list of layer names (must
% be expandable and result in strings); first in the list will be added
% first.
-% \item[\Parameter{string}:] the name of the layer before
-% (\Macro{AddLayersToPageStyleBeforeLayer}) or after
-% (\Macro{AddLayersToPageStyleAfterLayer}) that the layers of the list
+% \item[\marg{string}:] the name of the layer before
+% (\cs{AddLayersToPageStyleBeforeLayer}) or after
+% (\cs{AddLayersToPageStyleAfterLayer}) that the layers of the list
% should be added.
% \end{description}
% Note: If the layer from third argument is not part of the page style's layer
@@ -3601,14 +3489,14 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \AddLayersToPageStyleAfterLayer
-% \end{macro}%^^A \AddLayersToPageStyleBeforeLayer
+% \end{command}^^A \AddLayersToPageStyleBeforeLayer,
+% ^^A \AddLayersToPageStyleAfterLayer
%
%
-% \begin{macro}{\UnifyLayersAtPageStyle}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{command}{\UnifyLayersAtPageStyle}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be unified (must
+% \item[\marg{string}:] the name of the page style to be unified (must
% be expandable and result in a string).
% \end{description}
% Remove doublets of layers from a page style.
@@ -3635,20 +3523,19 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \UnifyLayersAtPageStyle
+% \end{command}^^A \UnifyLayersAtPageStyle
%
-% \begin{macro}{\ModifyLayerPageStyleOptions}
-% \begin{macro}{\AddToLayerPageStyleOptions}
+% \begin{command}{\ModifyLayerPageStyleOptions,\AddToLayerPageStyleOptions}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be modified (must
+% \item[\marg{string}:] the name of the page style to be modified (must
% be expandable and result in a string).
-% \item[\Parameter{option list}:] comma separated list of named page
+% \item[\marg{option list}:] comma separated list of named page
% style options. You may use any of the options provided for
-% \Macro{DeclarePageStyle}.
+% \cs{DeclarePageStyle}.
% \end{description}
-% \Macro{ModifyLayerPageStyleOptions} replaces the options and only the
+% \cs{ModifyLayerPageStyleOptions} replaces the options and only the
% options from the list by their new
-% values. \Macro{AddToLayerPageStyleOptions} adds the new values to the
+% values. \cs{AddToLayerPageStyleOptions} adds the new values to the
% already given.
% \begin{macrocode}
%<*package&body>
@@ -3664,7 +3551,7 @@
}
% \end{macrocode}
% \begin{macro}{\scrlayer@modify@layer@ps@options}
-% \changes{v3.28}{2019/11/28}{usage of marker makros}%^^A
+% \changes{v3.28}{2019/11/28}{usage of marker makros}
% Helper needed because of alias page styles. Same parameters like
% \cs{ModifyLayerPageStyleOptions}
% \begin{macrocode}
@@ -3717,7 +3604,7 @@
\reserved@a
}
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@modify@layer@ps@options
+% \end{macro}^^A \scrlayer@modify@layer@ps@options
% \begin{macrocode}
\newcommand*{\AddToLayerPageStyleOptions}[2]{%
\IfLayerPageStyleExists{#1}{%
@@ -3729,13 +3616,11 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \AddToLayerPageStyleOptions
-% \end{macro}%^^A \ModifyLayerPageStyleOptions
+% \end{command}^^A \ModifyLayerPageStyleOptions,\AddToLayerPageStyleOptions
%
-% \begin{macro}{\scrlayer@beginartifact}
-% \changes{v3.26}{2018/07/14}{new (semi internal)}%^^A
-% \begin{macro}{\scrlayer@endartifact}
-% \changes{v3.26}{2018/07/14}{new (semi internal)}%^^A
+%
+% \begin{macro}{\scrlayer@beginartifact,\scrlayer@endartifact}
+% \changes{v3.26}{2018/07/14}{new (semi internal)}
% These macros are reserved for tagging packages. The first one is executed
% after the initial contents hook, the last one is executed after the final
% contents hook. Both executions are done only, if the \texttt{artifact}
@@ -3778,17 +3663,14 @@
\providecommand*{\scrlayer@endartifact}[1]{}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@endartifact
-% \end{macro}%^^A \scrlayer@beginartifact
+% \end{macro}^^A \scrlayer@beginartifact,\scrlayer@endartifact
%
-% \begin{macro}{\DeclarePageStyleAlias}
-% \begin{macro}{\DeclareNewPageStyleAlias}
-% \begin{macro}{\ProvidePageStyleAlias}
-% \begin{macro}{\RedeclarePageStyleAlias}
+% \begin{command}{\DeclarePageStyleAlias,\DeclareNewPageStyleAlias,
+% \ProvidePageStyleAlias,\RedeclarePageStyleAlias}
% \begin{description}
-% \item[\Parameter{string}:] The name of the page style to be declared
+% \item[\marg{string}:] The name of the page style to be declared
% (must be expandable and result in a string).
-% \item[\Parameter{string}:] The name of the existing page style
+% \item[\marg{string}:] The name of the existing page style
% (must be expandable and result in a string).
% \end{description}
% \begin{macrocode}
@@ -3862,14 +3744,11 @@
\DeclarePageStyleAlias{#1}%
}
% \end{macrocode}
-% \end{macro}%^^A \RedeclarePageStyleAlias
-% \end{macro}%^^A \ProvidePageStyleAlias
-% \end{macro}%^^A \DeclareNewPageStyleAlias
-% \end{macro}%^^A \DeclarePageStyleAlias
+% \end{command}^^A \DeclarePageStyleAlias …
%
-% \begin{macro}{\DestroyPageStyleAlias}
+% \begin{command}{\DestroyPageStyleAlias}
% \begin{description}
-% \item[\Parameter{string}:] the name of a page style (must be
+% \item[\marg{string}:] the name of a page style (must be
% expandable and result in a string).
% \end{description}
% \begin{macrocode}
@@ -3880,11 +3759,11 @@
}%
}
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\GetRealPageStyle}
+% \begin{command}{\GetRealPageStyle}
% \begin{description}
-% \item[\Parameter{string}:] the name of a page style (must be
+% \item[\marg{string}:] the name of a page style (must be
% expandable and result in a string).
% \end{description}
% Get the real name of the page style.
@@ -3897,16 +3776,15 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}
+% \end{command}
%
-% \begin{macro}{\IfLayerPageStyleExists}
-% \begin{macro}{\IfRealLayerPageStyleExists}
+% \begin{command}{\IfLayerPageStyleExists,\IfRealLayerPageStyleExists}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be tested (must
+% \item[\marg{string}:] the name of the page style to be tested (must
% be expandable and result in a string).
-% \item[\Parameter{code}:] whatever code should be expanded, if the test
+% \item[\marg{code}:] whatever code should be expanded, if the test
% result is true.
-% \item[\Parameter{code}:] whatever code should be expanded, if the test
+% \item[\marg{code}:] whatever code should be expanded, if the test
% result is false.
% \end{description}
% Test, whether or not the page style is a declared layer page style.
@@ -3941,34 +3819,30 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \IfRealLayerPageStyleExists
-% \end{macro}%^^A \IfLayerPageStyleExists
+% \end{command}^^A \IfLayerPageStyleExists,\IfRealLayerPageStyleExists
%
-% \begin{macro}{\IfLayerAtPageStyle}
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{macro}{\IfSomeLayersAtPageStyle}
-% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}%^^A
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
-% \begin{macro}{\IfLayersAtPageStyle}
+% \begin{command}{\IfLayerAtPageStyle,\IfSomeLayersAtPageStyle}
+% \changes{v3.26}{2018/08/29}{\cs{scr@trim@spaces} added}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
+% \begin{command}{\IfLayersAtPageStyle}
% \begin{description}
-% \item[\Parameter{string}:] the name of the page style to be tested (must
+% \item[\marg{string}:] the name of the page style to be tested (must
% be expandable and result in a string).
-% \item[\Parameter{string}:] the name(s) of the layer(s) to be tested (must be
+% \item[\marg{string}:] the name(s) of the layer(s) to be tested (must be
% expandable and result in a string).
-% \item[\Parameter{code}:] whatever code should be expanded, if the test
+% \item[\marg{code}:] whatever code should be expanded, if the test
% result is true.
-% \item[\Parameter{code}:] whatever code should be expanded, if the test
+% \item[\marg{code}:] whatever code should be expanded, if the test
% result is false.
% \end{description}
% Tests:
% \begin{description}
-% \item[\Macro{IfLayerAtPageStyle}:] Test, whether or not the page style has a
+% \item[\cs{IfLayerAtPageStyle}:] Test, whether or not the page style has a
% layer. The second argument is the name of one layer only!
-% \item[\Macro{IfSomeLayersAtPageStyle}:] Test, whether or not the page style
+% \item[\cs{IfSomeLayersAtPageStyle}:] Test, whether or not the page style
% has at least one layer of a list of layers. The second argument is a comma
% separated list of layer names.
-% \item[\Macro{IfLayersAtPageStyle}:] Test, whether or not the page style has
+% \item[\cs{IfLayersAtPageStyle}:] Test, whether or not the page style has
% every layer of a list of layers. The second argument is a comma separated
% list of layer names.
% \end{description}
@@ -3977,7 +3851,7 @@
% Note, that layers with empty name are only part of a layer page style
% without any layers.
%
-% Note also, that with active \Option{deactivatepagestylelayers} layers are
+% Note also, that with active \opt{deactivatepagestylelayers} layers are
% logically not longer part of the page styles.
% \begin{macrocode}
%<*package&body>
@@ -4042,21 +3916,20 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \IfLayersAtPageStyle
-% \end{macro}%^^A \IfSomeLayersAtPageStyle
-% \end{macro}%^^A \IfLayerAtPageStyle
+% \end{command}^^A \IfLayersAtPageStyle
+% \end{command}^^A \IfLayerAtPageStyle,\IfSomeLayersAtPageStyle
%
%
-% \begin{macro}{\DestroyRealLayerPageStyle}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{command}{\DestroyRealLayerPageStyle}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% \begin{description}
-% \item[\Parameter{string}:] name of the layer page style to be destroyed.
+% \item[\marg{string}:] name of the layer page style to be destroyed.
% \end{description}
% Destroys the given layer page style but not the layers! If the page style is
% the current page style, the empty page style an empty page style will be
% activated. If the special page style is valid an the destroyed one, this
% will be removed. This command could be used, e.g., at
-% \Macro{scrlayerOnAutoRemoveInterface} after destroying the layers. However,
+% \cs{scrlayerOnAutoRemoveInterface} after destroying the layers. However,
% the interface commands are deprecated.
% \begin{macrocode}
%<*package&body>
@@ -4097,7 +3970,7 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \DestroyRealLayerPageStyle
+% \end{command}^^A \DestroyRealLayerPageStyle
%
%
% \subsection{Kernel Patches}
@@ -4105,13 +3978,13 @@
% This package as so many others need to patch the \LaTeX{} kernel. This will
% be done, because we need information about the current active package style.
%
-% \begin{macro}{\pagestyle}
-% \begin{macro}{\currentpagestyle}
-% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A
+% \begin{command}{\pagestyle}
+% \begin{command}{\currentpagestyle}
+% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}}
% We save the current page style. Note, that this doesn't work for special
% page styles\footnote{Special page styles are set by
-% \Macro{thispagestyle}.} that hasn't been defined using
-% \Package{scrlayer}. As long as \Macro{currentpagestyle} is empty, the
+% \cs{thispagestyle}.} that hasn't been defined using
+% \pkg*{scrlayer}. As long as \cs{currentpagestyle} is empty, the
% current page style is unknown. And we add two hooks into page style
% selection: one before an one after the selection.
% \begin{macrocode}
@@ -4159,17 +4032,16 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \currentpagestyle
+% \end{command}^^A \currentpagestyle
%
-% \begin{macro}{\BeforeSelectAnyPageStyle}
-% \begin{macro}{\scrlayer@exec@before@pagestyle@hook}
-% \begin{macro}{\AfterSelectAnyPageStyle}
-% \begin{macro}{\scrlayer@exec@after@pagestyle@hook}
+% \begin{command}{\BeforeSelectAnyPageStyle,\AfterSelectAnyPageStyle}
+% \begin{macro}{\scrlayer@exec@before@pagestyle@hook,
+% \scrlayer@exec@after@pagestyle@hook}
% We have two macros to locally add code to be executed whenever a page style
-% changes using \Macro{pagestyle}. The first one executes the code before the
+% changes using \cs{pagestyle}. The first one executes the code before the
% page style will be changed, the second one after the page style has been
% changed. Note, that you may use \#1 as a placeholder of the argument of
-% \Macro{pagestyle}.
+% \cs{pagestyle}.
% \begin{macrocode}
%<*package&body>
\newcommand*{\BeforeSelectAnyPageStyle}[1]{%
@@ -4188,28 +4060,24 @@
\newcommand*{\scrlayer@exec@after@pagestyle@hook}[1]{}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayer@exec@after@pagestyle@hook
-% \end{macro}%^^A \AfterSelectAnyPageStyle
-% \end{macro}%^^A \scrlayer@exec@before@pagestyle@hook
-% \end{macro}%^^A \BeforeSelectAnyPageStyle
-% \end{macro}%^^A \pagestyle
+% \end{macro}^^A \scrlayer@exec@after@pagestyle@hook …
+% \end{command}^^A \BeforeSelectAnyPageStyle,\AfterSelectAnyPageStyle
+% \end{command}^^A \pagestyle
%
%
-% \subsection{Declaration of End User Interfaces}
+% \subsection{Deprecated declaration of end user interfaces}
%
% \changes{v3.32}{2020/09/11}{the interface commands are deprecated}
%
-% The package also supports an interface for loading end user interfaces.
-% Maybe it would be a good idea to move this to \Package{scrbase}, but
-% currently it is not needed.
+% All commands of this subsection are deprecated. So they are declared as
+% internal independent from their name.
%
-% \begin{macro}{\scrlayerAddToInterface}
-% \begin{macro}{\scrlayerAddCsToInterface}
+% \begin{macro}{\scrlayerAddToInterface,\scrlayerAddCsToInterface}
% \begin{description}
% \item[\texttt{\{\meta{command}\textbar\meta{command sequence}\}}:] the
% command (with backslash) or the command sequence of the command (without
% backslash) of the command, that should be added to the interface.
-% \item[\Parameter{code}:] will be executed, only if the command could be
+% \item[\marg{code}:] will be executed, only if the command could be
% added to the interface.
% \end{description}
% Add either a command sequence or a command to the user interface.
@@ -4312,11 +4180,11 @@
}%
% \end{macrocode}
% \begin{macro}{\scrlayer@AddCsToInterface}
-% Little helper, to avoid repeating this \Macro{expandafter} orgy.
+% Little helper, to avoid repeating this \cs{expandafter} orgy.
% \begin{description}
-% \item[\OParameter{string}:] the interface name (must be expandable and
+% \item[\oarg{string}:] the interface name (must be expandable and
% expand to a string)
-% \item[\Parameter{command sequence}] the command sequence of the command to
+% \item[\marg{command sequence}] the command sequence of the command to
% be added.
% \end{description}
% \begin{macrocode}
@@ -4335,7 +4203,7 @@
% \begin{option}{forceoverwrite}
% \begin{macro}{\ifscrlayer@forceoverwrite}
% \begin{description}
-% \item[\Parameter{simple switch}:] whether or not to overwrite already
+% \item[\marg{simple switch}:] whether or not to overwrite already
% defined command. Note: If true, there will still be a warning.
% \end{description}
% \begin{macrocode}
@@ -4358,13 +4226,13 @@
\csname KV@KOMA.\@currname.\@currext @forceoverwrite@default\endcsname\relax
%</interface&body>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@forceoverwrite
-% \end{option}%^^A forceoverwrite
+% \end{macro}^^A \ifscrlayer@forceoverwrite
+% \end{option}^^A forceoverwrite
%
% \begin{option}{autoremoveinterfaces}
% \begin{macro}{\ifscrlayer@autoremoveinterfaces}
% \begin{description}
-% \item[\Parameter{simple switch}:] whether or not older interfaces may be
+% \item[\marg{simple switch}:] whether or not older interfaces may be
% automatically removed in conflict cases.
% \end{description}
% \begin{macrocode}
@@ -4390,17 +4258,16 @@
\relax
%</interface&body>
% \end{macrocode}
-% \end{macro}%^^A \ifscrlayer@autoremoveinterfaces
-% \end{option}%^^A autoremoveinterfaces
-% \end{macro}%^^A \scrlayer@AddCsToInterface
-% \end{macro}%^^A \scrlayerAddCsToInterface
-% \end{macro}%^^A \scrlayerAddToInterface
+% \end{macro}^^A \ifscrlayer@autoremoveinterfaces
+% \end{option}^^A autoremoveinterfaces
+% \end{macro}^^A \scrlayer@AddCsToInterface
+% \end{macro}^^A \scrlayerAddToInterface,\scrlayerAddCsToInterface
%
% \begin{macro}{\scrlayerInitInterface}
% \begin{description}
-% \item[\OParameter{string}:] the name of the interface. Generally this is
+% \item[\oarg{string}:] the name of the interface. Generally this is
% the file name of the package or class, that defines the interface
-% (default: \texttt{\Macro{@currname}.\Macro{@currext}}).
+% (default: \texttt{\cs{@currname}.\cs{@currext}}).
% \end{description}
% This registers a new user interface.
% \begin{macrocode}
@@ -4426,15 +4293,15 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayerInitInterface
+% \end{macro}^^A \scrlayerInitInterface
%
% \begin{macro}{\scrlayerOnAutoRemoveInterface}
% \begin{description}
-% \item[\OParameter{string}:] the name of the interface. Generally this is
+% \item[\oarg{string}:] the name of the interface. Generally this is
% the file name of the package or class, that defines the interface
-% (default: \texttt{\Macro{@currname}.\Macro{@currext}}).
-% \item[\Parameter{code}:] will be executed if the interface will be removed
-% automatically (see option \Option{autoremoveinterfaces}).
+% (default: \texttt{\cs{@currname}.\cs{@currext}}).
+% \item[\marg{code}:] will be executed if the interface will be removed
+% automatically (see option \opt{autoremoveinterfaces}).
% \end{description}
% \begin{macrocode}
%<*package&body>
@@ -4445,10 +4312,10 @@
}
%</package&body>
% \end{macrocode}
-% \end{macro}%^^A \scrlayerOnAutoRemoveInterface
+% \end{macro}^^A \scrlayerOnAutoRemoveInterface
%
% \begin{macro}{\scrlayer@report@deprecated}
-% \changes{v3.32}{2020/09/11}{new (internal)}
+% \changes{v3.32}{2020/09/11}{added}
% Report that the deprecated interface commands are used but should not. But
% report this only once per interface.
% \begin{macrocode}
@@ -4467,20 +4334,19 @@
% \end{macrocode}
% \end{macro}
%
-% \iffalse^^A meta-comment
+% \begin{macrocode}
%</package|interface|class>
-% \fi^^A meta-comment
-%
-%
+% \end{macrocode}
+%
% \Finale
+% \PrintChanges
%
\endinput
-%
-% end of file `scrlayer.dtx'
-
-%%% Local Variables:
-%%% mode: doctex
-%%% ispell-local-dictionary: "en_GB"
-%%% flyspell-mode: t
-%%% 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: