diff options
Diffstat (limited to 'macros/latex/contrib/koma-script/source/scrkernel-typearea.dtx')
-rw-r--r-- | macros/latex/contrib/koma-script/source/scrkernel-typearea.dtx | 1310 |
1 files changed, 563 insertions, 747 deletions
diff --git a/macros/latex/contrib/koma-script/source/scrkernel-typearea.dtx b/macros/latex/contrib/koma-script/source/scrkernel-typearea.dtx index ec6e89babf..50691df27b 100644 --- a/macros/latex/contrib/koma-script/source/scrkernel-typearea.dtx +++ b/macros/latex/contrib/koma-script/source/scrkernel-typearea.dtx @@ -1,7 +1,7 @@ % \iffalse meta-comment % ====================================================================== % scrkernel-typearea.dtx -% Copyright (c) Markus Kohm, 2002-2020 +% Copyright (c) Markus Kohm, 2002-2022 % % This file is part of the LaTeX2e KOMA-Script bundle. % @@ -17,44 +17,8 @@ % The Current Maintainer and author of this work is Markus Kohm. % % This work consists of all files listed in manifest.txt. -% ---------------------------------------------------------------------- -% scrkernel-typearea.dtx -% Copyright (c) Markus Kohm, 2002-2020 -% -% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, -% Version 1.3c, verteilt und/oder veraendert werden. -% 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 oder spaeter 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. % ====================================================================== -% \fi^^A meta-comment -% -% \CharacterTable -% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -% Digits \0\1\2\3\4\5\6\7\8\9 -% Exclamation \! Double quote \" Hash (number) \# -% Dollar \$ Percent \% Ampersand \& -% Acute accent \' Left paren \( Right paren \) -% Asterisk \* Plus \+ Comma \, -% Minus \- Point \. Solidus \/ -% Colon \: Semicolon \; Less than \< -% Equals \= Greater than \> Question mark \? -% Commercial at \@ Left bracket \[ Backslash \\ -% Right bracket \] Circumflex \^ Underscore \_ -% Grave accent \` Left brace \{ Vertical bar \| -% Right brace \} Tilde \~} -% -% \iffalse meta-comment -%%% From File: $Id: scrkernel-typearea.dtx 3488 2020-04-27 13:04:43Z kohm $ +%%% From File: $Id: scrkernel-typearea.dtx 3699 2022-02-11 15:53:36Z kohm $ %<identify>%%% (run: identify) %<init>%%% (run: init) %<options>%%% (run: options) @@ -65,9 +29,9 @@ \ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi \begingroup \def\filedate$#1: #2-#3-#4 #5${\gdef\filedate{#2/#3/#4}} - \filedate$Date: 2020-04-27 15:04:43 +0200 (Mon, 27 Apr 2020) $ + \filedate$Date: 2022-02-11 16:53:36 +0100 (Fr, 11. Feb 2022) $ \def\filerevision$#1: #2 ${\gdef\filerevision{r#2}} - \filerevision$Revision: 3488 $ + \filerevision$Revision: 3699 $ \edef\reserved@a{% \noexpand\endgroup \noexpand\ProvidesFile{scrkernel-typearea.dtx}[% @@ -86,7 +50,6 @@ (type area)] %</dtx|(package&typearea&identify)> %<*dtx> -%^^A The ins file: \ifx\documentclass\undefined \input scrdocstrip.tex \@@input scrkernel-version.dtx @@ -111,49 +74,56 @@ \let\endbatchfile\relax \fi \endbatchfile -%^^A The documentation driver (needed only for checksum calculation): -\documentclass{scrdoc} -\usepackage[main=english,ngerman]{babel} -\CodelineIndex -\RecordChanges -\GetFileInfo{scrkernel-typearea.dtx} -\title{\KOMAScript{} \partname\ \texttt{\filename}% - \footnote{This is \fileversion\ of file \texttt{\filename}.}} -\date{\filedate} -\author{Markus Kohm} - +\documentclass[USenglish]{koma-script-source-doc} +\usepackage{babel} +\setcounter{StandardModuleDepth}{2} \begin{document} - \maketitle - \tableofcontents - \DocInput{\filename} +\DocInput{scrkernel-typearea.dtx} \end{document} %</dtx> % \fi^^A meta-comment -%^^A The documentation part: % -% \changes{v2.95}{2002/06/20}{first version after splitting -% \texttt{scrclass.dtx}}%^^A -% \changes{v3.24}{2017/07/23}{reorganization of code into semantic -% portions}%^^A -% \changes{v3.24}{2017/07/23}{start of English translation}%^^A +% \changes{v2.95}{2002/06/20}{first version after splitting \file{scrclass.dtx}} +% \changes{v3.24}{2017/07/23}{reorganization of code into semantic portions} +% \changes{v3.24}{2017/07/23}{start of English translation} +% \changes{v3.36}{2022/02/11}{switch over from \cls*{scrdoc} to +% \cls*{koma-script-source-doc}} +% \changes{v3.36}{2022/02/11}{whole implementation documentation in English} +% +% \GetFileInfo{scrkernel-typearea.dtx} +% \title{Calculation of the Typeing Area with +% \href{https://komascript.de}{\KOMAScript} Package \pkg*{typearea} +% and Additional Commands for the \href{https://komascript.de}{\KOMAScript} +% Classes} +% \author{\href{mailto:komascript@gmx.info}{Markus Kohm}} +% \date{Revision \fileversion{} of \filedate} +% \maketitle +% \begin{abstract} +% \filename{} contains macros for the typing area. These result not only in +% the package \pkg*{typearea} but also provide features for the +% \KOMAScript{} classes. +% \end{abstract} +% \tableofcontents +% +% \section{User Manual} % -% \section{Typing Area Macros} +% You can find the user documentation of package \pkg*{typearea} and the +% commands implemented here in the \KOMAScript{} manual, either the German +% \file{scrguide} or the English \file{scrguien}. % -% This section contains macros for the typing area. These result not only in -% the package \Package{typearea} but also provide features for the -% \KOMAScript{} classes. +% \MaybeStop{\PrintIndex} % -% \StopEventually{\PrintIndex\PrintChanges} +% \section{Implementation of Package \pkg*{typearea} and Additional Class +% Features} % -%^^A The source part: % % \subsection{Loading packages} % -% Package \Package{typearea} needs package \Package{scrkbase}. But this will -% be loaded by \File{scrkernel-basics.dtx} just after the identify run of this +% Package \pkg*{typearea} needs package \pkg*{scrkbase}. But this will +% be loaded by \file{scrkernel-basics.dtx} just after the identify run of this % file. It does not need other packages. % -% The \KOMAScript{} classes need package \Package{typearea}. This will be +% The \KOMAScript{} classes need package \pkg*{typearea}. This will be % loaded here as an early body action. Nevertheless, at this state the typing % area option code for the classes has already been loaded. So before loading % the almost identical option code of the package, some macros have to be @@ -170,11 +140,11 @@ \let\x@@paper =\relax \let\scr@pti@nerr@r =\relax % \end{macrocode} -% Now we can load \Package{typearea}: +% Now we can load \pkg*{typearea}: % \changes{v2.95}{2002/06/22}{Use \cs{KOMAScriptVersion} while loading -% \Package{typearea}}%^^A +% \pkg*{typearea}} % We use \cs{KOMAScriptVersion} to verify the identical versions of -% \KOMAScript{} and the package. See \File{scrkernel-version.dtx} for more +% \KOMAScript{} and the package. See \file{scrkernel-version.dtx} for more % information about this verification. % \begin{macrocode} \RequirePackage{typearea}[\KOMAScriptVersion] @@ -184,19 +154,19 @@ % \subsection{Selection of paper size} % % Before we can define page margins and a typing area, we have to define the -% paper size. Beside \Package{typearea} also \Package{scrletter} uses some of +% paper size. Beside \pkg*{typearea} also \pkg*{scrletter} uses some of % this code, because it needs the paper size, too. % -% \begin{macro}{\PaperNameToSize} -% \changes{v3.23}{2017/02/22}{new}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A +% \begin{command}{\PaperNameToSize} +% \changes{v3.23}{2017/02/22}{added} +% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}} % This command sets \cs{paperheight} and \cs{paperwidth} depending on % the name of a paper size. It currently supports the ISO formats of the % series A, B, C and D and the American formats letter, legal and -% executive. The command is defined using \Macro{providecommand} so a class -% can define it different before loading \Package{typearea}. The first +% executive. The command is defined using \cs{providecommand} so a class +% can define it different before loading \pkg*{typearea}. The first % optional argument is the error class. Error classes will be defined using -% \Macro{ProvideUnknownPaperSizeError} later. The second argument is the name +% \cs{ProvideUnknownPaperSizeError} later. The second argument is the name % of the paper size. % \begin{macrocode} %<*package&options> @@ -225,8 +195,8 @@ } % \end{macrocode} % \begin{macro}{\ISO@PaperNameToSize} -% \changes{v3.23}{2017/02/22}{new (internal)}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifnumber} umbenannt in \cs{Ifnumber}}%^^A +% \changes{v3.23}{2017/02/22}{new (internal)} +% \changes{v3.28}{2019/11/18}{\cs{ifnumber} umbenannt in \cs{Ifnumber}} % For ISO paper sizes a sub-macro is used. It has to split the series and the % root. % \begin{macrocode} @@ -278,8 +248,8 @@ \else % \end{macrocode} % The paper size is not a supported ISO format. If -% \Macro{scr@UnknownPaperSize@}\meta{errorclass} is defined, use it to show -% the error. If not, use \Macro{scr@UnknownPaperSize@error}. This means, +% \cs{scr@UnknownPaperSize@}\meta{errorclass} is defined, use it to show +% the error. If not, use \cs{scr@UnknownPaperSize@error}. This means, % \meta{errorclass} \texttt{error} has to be defined. % \begin{macrocode} \scr@ifundefinedorrelax{scr@UnknownPaperSize@#1}{% @@ -291,11 +261,11 @@ }% }{} % \end{macrocode} -% \begin{macro}{\ProvideUnknownPaperSizeError} -% \changes{v3.23}{2017/02/22}{new}%^^A +% \begin{command}{\ProvideUnknownPaperSizeError} +% \changes{v3.23}{2017/02/22}{added} % Define a new error class for unknown paper formats. The argument is the new % error class. Each error class is represented by a command -% \Macro{scr@UnknownPaperSize@}\meta{errorclass}. That command also has +% \cs{scr@UnknownPaperSize@}\meta{errorclass}. That command also has % exactly one argument, the unknown paper size. % \begin{macrocode} \providecommand*{\ProvideUnknownPaperSizeError}[1]{% @@ -303,15 +273,10 @@ \csname scr@UnknownPaperSize@#1\endcsname[1]% } % \end{macrocode} -% \begin{macro}{\scr@UnkownPaperSize@error} -% \changes{v3.23}{2017/02/22}{new (internal)} -% \begin{macro}{\scr@UnkownPaperSize@warning} -% \changes{v3.23}{2017/02/22}{new (internal)} -% \begin{macro}{\scr@UnkownPaperSize@info} +% \begin{macro}{\scr@UnkownPaperSize@error,\scr@UnkownPaperSize@warning, +% \scr@UnkownPaperSize@info,\scr@UnkownPaperSize@ignore} % \changes{v3.23}{2017/02/22}{new (internal)} -% \begin{macro}{\scr@UnkownPaperSize@ignore} -% \changes{v3.23}{2017/02/22}{new (internal)} -% Error handling (error classes) for \Macro{PaperNameToSize}. +% Error handling (error classes) for \cs{PaperNameToSize}. % \begin{macrocode} \ProvideUnknownPaperSizeError{error}{% \PackageError{% @@ -345,46 +310,15 @@ %</typearea> %</package&options> % \end{macrocode} -% \end{macro}%^^A \scr@UnknownPaperSize@error -% \end{macro}%^^A \scr@UnknownPaperSize@warning -% \end{macro}%^^A \scr@UnknownPaperSize@info -% \end{macro}%^^A \scr@UnknownPaperSize@ignore -% \end{macro}%^^A \ProvideUnknownPaperSizeError -% \end{macro}%^^A \ISO@PaperNameToSize -% \end{macro}%^^A \PaperNameToSize -% -% \begin{option}{a4paper} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{a5paper} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{b5paper} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{letterpaper} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{legalpaper} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{executivepaper} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{landscape} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A -% \begin{option}{portrait} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated}%^^A +% \end{macro}^^A \scr@UnknownPaperSize@error … \scr@UnknownPaperSize@ignore +% \end{command}^^A \ProvideUnknownPaperSizeError +% \end{macro}^^A \ISO@PaperNameToSize +% \end{command}^^A \PaperNameToSize +% +% \begin{option}{a4paper,a5paper,b5paper,letterpaper,legalpaper,executivepaper, +% landscape,portrait} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v3.01a}{2008/11/21}{the option is standard but not deprecated} % The paper sizes of the standard classes are a special case. For % compatibility they are declared explicitly. Note: There is still a pattern % matching implementation for other paper size options, but the usage of those @@ -401,26 +335,19 @@ \KOMA@DeclareStandardOption[typearea]{portrait}{paper=portrait} %</package&typearea&options> % \end{macrocode} -% \end{option} -% \end{option} -% \end{option} -% \end{option} -% \end{option} -% \end{option} -% \end{option} -% \end{option} +% \end{option}^^A a4paper … portrait % % \begin{option}{paper} -% \changes{v2.95}{2002/12/03}{new implementation}%^^A -% \changes{v3.01b}{2008/12/09}{height and width swapped}%^^A -% \changes{v3.02c}{2009/02/12}{new \Option{paper!=seascape}}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A -% \changes{v3.22}{2016/07/29}{paper orientation depends on format name}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A +% \changes{v2.95}{2002/12/03}{added} +% \changes{v3.01b}{2008/12/09}{height and width swapped} +% \changes{v3.02c}{2009/02/12}{new \opt{paper\quotechar=seascape}} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} +% \changes{v3.22}{2016/07/29}{paper orientation depends on format name} +% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}} % Normally, the paper size should be set using this option. It provides the % ISO series A, B, C, D, value pairs -% \Option{(\meta{width},\meta{height})} and the orientations -% \Option{portrait}, \Option{landscape} and \Option{seascape}. +% \opt{(\meta{width},\meta{height})} and the orientations +% \opt{portrait}, \opt{landscape} and \opt{seascape}. % \begin{macrocode} %<*package&typearea&options> \KOMA@key{paper}{% @@ -572,33 +499,23 @@ }% } % \end{macrocode} -% \begin{macro}{\if@seascape} -% \changes{v3.02c}{2009/02/12}{new}%^^A -% \begin{macro}{\@seascapetrue} -% \changes{v3.02c}{2009/02/12}{new}%^^A -% \begin{macro}{\@seascapefalse} -% \changes{v3.02c}{2009/02/12}{new}%^^A +% \begin{macro}{\if@seascape,\@seascapetrue,\@seascapefalse} +% \changes{v3.02c}{2009/02/12}{added} % This switch stores only whether or not the landscape orientation should be -% up-side-down. Currently this makes sense only using \File{dvips}. +% up-side-down. Currently this makes sense only using \file{dvips}. % \begin{macrocode} \newif\if@seascape % \end{macrocode} % \end{macro} -% \end{macro} -% \end{macro} -% \begin{macro}{\if@landscape} -% \begin{macro}{\@landscapetrue} -% \begin{macro}{\@landscapefalse} +% \begin{macro}{\if@landscape,\@landscapetrue,\@landscapefalse} % This switch stores whether using portrait or landscape orientation. % \begin{macrocode} \newif\if@landscape % \end{macrocode} % \end{macro} -% \end{macro} -% \end{macro} % \begin{macro}{\maybe@pair} -% \changes{v2.95}{2002/12/03}{new (internal)}%^^A -% \changes{v2.97e}{2007/11/26}{works really}%^^A +% \changes{v2.95}{2002/12/03}{added} +% \changes{v2.97e}{2007/11/26}{works really} % Test whether the following parameter is of kind \texttt{\meta{first % argument}:\meta{second argument}}. If so \cs{@tempa} will become \meta{first % argument} and \cs{@tempb} will become \meta{second argument} and @@ -614,15 +531,15 @@ } %</package&typearea&options> % \end{macrocode} -% \end{macro} -% \end{option} +% \end{macro}^^A \maybe@pair +% \end{option}^^A paper % -% \subsection{Special handling of \Package{geometry}} +% \subsection{Special handling of \pkg*{geometry}} % % \begin{option}{usegeometry} -% \changes{v3.17}{2015/02/07}{new}%^^A -% \Package{typearea} optionally can pass several settings to package -% \Package{geometry}. The user decides whether or not to use this. +% \changes{v3.17}{2015/02/07}{added} +% \pkg*{typearea} optionally can pass several settings to package +% \pkg{geometry}. The user decides whether or not to use this. % \begin{macrocode} %<*package&typearea&options> \KOMA@ifkey{usegeometry}{@ta@usegeometry} @@ -633,37 +550,36 @@ % % \subsection{Setting the output paper size} % -% The document paper format of option \Option{paper} is one thing. It is used +% The document paper format of option \opt{paper} is one thing. It is used % only for calculation of the dimensions used by \TeX{}. Originally % \textsc{dvi} does not know something like a paper size. It just contained % relative movements from the current position starting with the % origin. Setting up a page size depends on the output driver or back-end. % % \begin{option}{pagesize} -% \changes{v2.7g}{2001/04/17}{new}%^^A -% \changes{v2.95}{2002/08/27}{new implementation}%^^A -% \changes{v3.02c}{2009/02/14}{new \Option{pagesize!=false}}%^^A -% \changes{v3.05a}{2010/03/18}{new \Option{pagesize!=dvipdfmx}}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A -% \changes{v3.17a}{2015/05/03}{logic redesigned}%^^A -% \changes{v3.20}{2015/07/10}{\File{luatex} as a synonym of -% \File{pdftex}}%^^A -% This option is the main element for telling pdf\TeX, \File{dvips} or V\TeX{} +% \changes{v2.7g}{2001/04/17}{added} +% \changes{v2.95}{2002/08/27}{new implementation} +% \changes{v3.02c}{2009/02/14}{new \opt{pagesize\quotechar=false}} +% \changes{v3.05a}{2010/03/18}{new \opt{pagesize\quotechar=dvipdfmx}} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} +% \changes{v3.17a}{2015/05/03}{logic redesigned} +% \changes{v3.20}{2015/07/10}{\file{luatex} as a synonym of \file{pdftex}} +% This option is the main element for telling pdf\TeX, \file{dvips} or V\TeX{} % which paper size to use. It is also used by some deprecated options. Here % are the values and their meanings: -% \begin{labeling}[~--]{\Option{automedia}} -% \item[\Option{auto}] combination of options \Option{pdftex} and -% \Option{dvips}. -% \item[\Option{automedia}] like \Option{auto} with additional setting of +% \begin{labeling}[~--]{\opt{automedia}} +% \item[\opt{auto}] combination of options \opt{pdftex} and +% \opt{dvips}. +% \item[\opt{automedia}] like \opt{auto} with additional setting of % \cs{mediawidth} and \cs{mediaheight} if available. -% \item[\Option{dvips}] adds a \File{dvips} \cs{special} to set the paper +% \item[\opt{dvips}] adds a \file{dvips} \cs{special} to set the paper % size. This should be done only once in the document preamble. Usage inside % the document body is not fully supported and will raise a warning. -% \item[\Option{dvipdfmx}] adds a \File{dvipdfmx} \cs{special} to set the +% \item[\opt{dvipdfmx}] adds a \file{dvipdfmx} \cs{special} to set the % paper size. -% \item[\Option{false}] switch of the automatic driver page size setting, +% \item[\opt{false}] switch of the automatic driver page size setting, % i.e., if there are changes inside the document. -% \item[\Option{pdftex}] set \cs{pdfpagewidth} and \cs{pdfpageheight} if +% \item[\opt{pdftex}] set \cs{pdfpagewidth} and \cs{pdfpageheight} if % available. % \end{labeling} % \begin{macrocode} @@ -711,41 +627,41 @@ } % \end{macrocode} % \begin{macro}{\@pagesizelast} -% This internal macro stores the current value of option \Option{pagesize} and -% is needed to use the correct signalling if option \Option{paper} is used +% This internal macro stores the current value of option \opt{pagesize} and +% is needed to use the correct signalling if option \opt{paper} is used % inside the document and the initial setup in |\begin{document}|. % \begin{macrocode} \newcommand\@pagesizelast{auto} \AtBeginDocument{% \KOMAExecuteOptions[.typearea.\scr@pkgextension]{pagesize=\@pagesizelast}% % \end{macrocode} -% \end{macro}%^^A \@pagesizelast +% \end{macro}^^A \@pagesizelast % % \begin{macro}{\set@pdftexpagesize} -% \changes{v2.95}{2002/08/27}{new (internal)}%^^A +% \changes{v2.95}{2002/08/27}{added} % \changes{v3.20}{2015/07/10}{if \cs{pdfpage\dots} does not exist -% \cs{page\dots} will be tried (needed for lua\TeX{}~0.80.1)}%^^A +% \cs{page\dots} will be tried (needed for lua\TeX{}~0.80.1)} % \begin{macro}{\set@dvipspagesize} -% \changes{v2.95}{2002/08/27}{new (internal)}%^^A -% \changes{v3.02c}{2009/02/13}{respecting \Option{seascape}}%^^A -% \changes{v3.02c}{2009/02/14}{can be used inside the document}%^^A +% \changes{v2.95}{2002/08/27}{added} +% \changes{v3.02c}{2009/02/13}{respecting \opt{seascape}} +% \changes{v3.02c}{2009/02/14}{can be used inside the document} % \changes{v3.12}{2012/02/06}{not expanded % \cs{let}\cs{if@tempswa}\cs{if@dvips} does even work is the later is not -% yet defined}%^^A +% yet defined} % \changes{v3.28}{2019/11/18}{\cs{ifnotundefined} renamed into -% \cs{Ifnotundefined}}%^^A +% \cs{Ifnotundefined}} % \begin{macro}{\setnot@dvipspagesize} -% \changes{v2.95}{2002/08/27}{new (internal)}%^^A +% \changes{v2.95}{2002/08/27}{added} % \begin{macro}{\set@dvipdfmxpagesize} -% \changes{v3.05a}{2010/03/18}{new (internal)}%^^A +% \changes{v3.05a}{2010/03/18}{added} % \begin{macro}{\set@vtexpagesize} -% \changes{v2.95}{2002/08/27}{new (internal)}%^^A +% \changes{v2.95}{2002/08/27}{added} % \changes{v3.28}{2019/11/18}{\cs{ifnotundefined} renamed into -% \cs{Ifnotundefined}}%^^A +% \cs{Ifnotundefined}} % \begin{macro}{\scr@updatedvipspagesize} -% \changes{v3.02c}{2009/02/14}{new (internal)}%^^A -% \changes{v3.12}{2013/05/10}{deactivated, if \cs{XeTeXversion} exists}%^^A -% Option \Option{pagesize} needs some internal macros. +% \changes{v3.02c}{2009/02/14}{added} +% \changes{v3.12}{2013/05/10}{deactivated, if \cs{XeTeXversion} exists} +% Option \opt{pagesize} needs some internal macros. % \begin{description} % \item{Attention:} The definition of these macros may change at usage of % themselves or at |\begin{document}|. @@ -755,12 +671,12 @@ \expandafter\ifnum\scr@ta@v@is@gt{3.02b}\relax \renewcommand*{\set@dvipspagesize}{% % \end{macrocode} -% \changes{v3.12}{2012/11/23}{use paper size update only for DVI and PS}%^^A +% \changes{v3.12}{2012/11/23}{use paper size update only for DVI and PS} % \changes{v3.12}{2012/02/06}{not expanded -% \cs{let}\cs{if@tempswa}\cs{if@dvips} does even work is the later is not -% yet defined}%^^A -% Test whether unspecified \textsc{DVI} output or specified \textsc{PS} output -% is used. Only in that cases the \textsc{PS} code for paper size updates will +% \cs{let}\cs{if@tempswa}\cs{if@dvips} does even work if the later is not +% yet defined} +% Test whether unspecified \textsc{dvi} output or specified \textsc{ps} output +% is used. Only in that cases the \textsc{ps} code for paper size updates will % be used. % \begin{macrocode} \begingroup @@ -782,7 +698,7 @@ }{% % \end{macrocode} % If \cs{AtBeginShipoutNext} is available (mostly because of loading package -% \Package{atbegshi}) use it so execute the code at least before other code +% \pkg{atbegshi}) use it so execute the code at least before other code % that has been added to \cs{shipout}. Unfortunately this is not reliable. If % \cs{AtBeginShipout} is used after \cs{set@dvipspagesize} (this means the % recalculation of the typing area and the margins) but before the current @@ -804,7 +720,7 @@ }{% % \end{macrocode} % If \cs{AtNextShipout} is available (mostly because of loading package -% \Package{everyshi} use it to execute the code at least before other code +% \pkg{everyshi} use it to execute the code at least before other code % that has been added to \cs{shipout}. Unfortunately this is not reliable. If % \cs{AtNextShipout} or \cs{EveryShipout} is used after \cs{set@dvipspagesize} % (this means the recalculation of the typing area and the margins) but before @@ -844,7 +760,7 @@ % \end{macrocode} % And now the definition that is used before |\begin{document}| but executed % the first time inside |\begin{document}|. -% \changes{3.21}{2016/05/27}{two missing backslashs added} +% \changes{v3.21}{2016/05/27}{two missing backslashs added} % \begin{macrocode} \newcommand*{\set@pdftexpagesize}{% \scr@ifundefinedorrelax{pdfpagewidth}{% @@ -864,10 +780,10 @@ }{}% }{}% % \end{macrocode} -% \changes{v3.22}{2016/08/04}{\textsf{preview} workaround}%^^A -% If package \Package{preview} has been loaded with option \Option{tightpage}, +% \changes{v3.22}{2016/08/04}{\pkg{preview} workaround} +% If package \pkg{preview} has been loaded with option \opt{tightpage}, % which can be recognized by a defined macro \cs{pr@nextbb}, and if the -% package is active, we do not add \textsc{DVI} specials, because it would +% package is active, we do not add \textsc{dvi} specials, because it would % disturb Xe\LaTeX. % \begin{macrocode} \scr@ifundefinedorrelax{pr@nextbb}{}{% @@ -942,15 +858,15 @@ % \end{option} % % \begin{option}{dvips} -% \changes{v2.7g}{2001/04/17}{new}%^^A -% \changes{v2.95}{2002/08/27}{new implementation}%^^A -% \changes{v2.98c}{2008/04/09}{replacement changed}%^^A -% \changes{v2.98c}{2008/04/09}{info instead of warning}%^^A -% \changes{v3.01a}{2008/11/21}{it's a standard option not deprecated}%^^A +% \changes{v2.7g}{2001/04/17}{added} +% \changes{v2.95}{2002/08/27}{new implementation} +% \changes{v2.98c}{2008/04/09}{replacement changed} +% \changes{v2.98c}{2008/04/09}{info instead of warning} +% \changes{v3.01a}{2008/11/21}{it's a standard option not deprecated} % This option is a kind of obsolete. It is now implemented using -% \Option{pagesize}. But because this is a standard option using several other +% \opt{pagesize}. But because this is a standard option using several other % packages we only show a standard option information instead of a deprecated -% option warning. Note: Usage of \Option{pagesize=automedia} can still result +% option warning. Note: Usage of \opt{pagesize=automedia} can still result % in a warning message! % \begin{macrocode} %<*package&typearea&options> @@ -962,13 +878,12 @@ % \end{option} % % \begin{option}{pdftex} -% \changes{v2.7g}{2001/04/17}{new}%^^A -% \changes{v2.95}{2002/08/27}{new implementation}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{it's a standard option not deprecated}%^^A +% \changes{v2.7g}{2001/04/17}{added} +% \changes{v2.95}{2002/08/27}{new implementation} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v3.01a}{2008/11/21}{it's a standard option not deprecated} % This option is a kind of obsolete. It is now implemented using -% \Option{pagesize}. But because this is a standard option using several other +% \opt{pagesize}. But because this is a standard option using several other % packages we only show a standard option information instead of a deprecated % option warning. % \begin{macrocode} @@ -982,32 +897,29 @@ % % \subsection{Influencing left and right margin proportions} % -% Options like \Option{twoside} or \Option{twocolumn} influence the +% Options like \opt{twoside} or \opt{twocolumn} influence the % proportions of the left and right margin and indirectly also the top and the % bottom margin. They are also very important for the document classes. % % \begin{option}{oneside} -% \changes{v2.97e}{2007/11/23}{pass option from class to -% \Package{typearea}}%^^A -% \changes{v3.01a}{2008/11/21}{it's a standard option not deprecated}%^^A +% \changes{v2.97e}{2007/11/23}{pass option from class to \pkg*{typearea}} +% \changes{v3.01a}{2008/11/21}{it's a standard option not deprecated} % \begin{option}{twoside} -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v2.97e}{2007/11/23}{pass option from class to -% \Package{typearea}}%^^A -% \changes{v3.00}{2008/07/09}{new option \Option{twoside!=semi}}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v2.97e}{2007/11/23}{pass option from class to \pkg*{typearea}} +% \changes{v3.00}{2008/07/09}{new option \opt{twoside\quotechar=semi}} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} % \changes{v3.13a}{2014/04/09}{the class also uses status signaling with -% \cs{FamilyKeyStateProcessed}}%^^A +% \cs{FamilyKeyStateProcessed}} % \changes{v3.17}{2015/03/17}{automatic usage of \cs{flushbottom} and -% \cs{raggedbottom}}%^^A -% \changes{v3.17}{2015/03/17}{early setting of default}%^^A -% \changes{v3.17}{2015/03/18}{use \cs{cleardoubleoddpage} if available}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A -% \begin{macro}{\if@semitwoside} -% \changes{v3.00}{2008/07/09}{new boolean switch (intern)}%^^A -% \begin{macro}{\if@twoside} -% \changes{v3.00}{2008/07/09}{switch also sets \cs{if@semitwoside}}%^^A +% \cs{raggedbottom}} +% \changes{v3.17}{2015/03/17}{early setting of default} +% \changes{v3.17}{2015/03/18}{use \cs{cleardoubleoddpage} if available} +% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}} +% \begin{macro}{\if@semitwoside,\@semitwosidetrue,\@semitwosidefalse} +% \changes{v3.00}{2008/07/09}{new boolean switch (intern)} +% \begin{macro}{\if@twoside,\@twosidetrue,\@twosidefalse} +% \changes{v3.00}{2008/07/09}{switch also sets \cs{if@semitwoside}} % Do we have a single sided or double sided layout? % \begin{macrocode} %<*package&typearea&options> @@ -1040,16 +952,16 @@ \KOMA@set@ifkey{twoside}{% % \end{macrocode} % \changes{v3.20}{2015/11/02}{not existing order dependency of -% \Option{twocolumn} and \Option{twoside} fixed}%^^A -% \changes{v3.27}{2019/03/05}{no \emph{Extrawurst} for letters}%^^A -% \changes{v3.27}{2019/03/05}{mising \cs{sloppy} in twocolumn mode added}%^^A +% \opt{twocolumn} and \opt{twoside} fixed} +% \changes{v3.27}{2019/03/05}{no special treatment for letters} +% \changes{v3.27}{2019/03/05}{missing \cs{sloppy} in twocolumn mode added} % From v3.17 until 3.19a the classes used a local switch -% \Macro{if@tempswa}. As a result of this option \Option{twocolumn} was not +% \cs{if@tempswa}. As a result of this option \opt{twocolumn} was not % able to recognize double sided layout. Because of this it was essential to -% handle option \Option{twocolumn} before option \Option{twoside}. This has -% been solved using \Macro{if@twoside} in the classes too. Another solution +% handle option \opt{twocolumn} before option \opt{twoside}. This has +% been solved using \cs{if@twoside} in the classes too. Another solution % could have been to move the implementation and execution of -% \Option{twocolumn} before \Option{twoside}. But I don't know whether or not +% \opt{twocolumn} before \opt{twoside}. But I don't know whether or not % this would have been reliable and the solution here is more simple. % \begin{macrocode} @twoside% @@ -1096,27 +1008,24 @@ {oneside}{twoside=false} %</(class|(package&typearea))&options> % \end{macrocode} -% \end{option}%^^A twoside -% \end{option}%^^A oneside +% \end{option}^^A twoside +% \end{option}^^A oneside % % \begin{option}{onecolumn} -% \changes{v2.95}{2002/12/04}{option moved to package \Package{typearea}}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v2.97e}{2007/11/23}{the classes pass the option to -% \Package{typearea}}%^^A -% \changes{v3.01a}{2008/11/21}{standard option but not deprecated}%^^A +% \changes{v2.95}{2002/12/04}{option moved to package \pkg*{typearea}} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v2.97e}{2007/11/23}{the classes pass the option to \pkg*{typearea}} +% \changes{v3.01a}{2008/11/21}{standard option but not deprecated} % \begin{option}{twocolumn} -% \changes{v2.95}{2002/12/04}{option moved to package \Package{typearea}}%^^A -% \changes{v2.97e}{2007/11/23}{the classes pass the option to -% \Package{typearea}}%^^A -% \changes{v2.98a}{2007/01/08}{passing the correct option}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A +% \changes{v2.95}{2002/12/04}{option moved to package \pkg*{typearea}} +% \changes{v2.97e}{2007/11/23}{the classes pass the option to \pkg*{typearea}} +% \changes{v2.98a}{2007/01/08}{passing the correct option} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} % \changes{v3.13a}{2014/04/09}{the class also uses status signaling with -% \cs{FamilyKeyStateProcessed}}%^^A +% \cs{FamilyKeyStateProcessed}} % \changes{v3.20}{2016/02/16}{\cs{sloppy}, \cs{raggedbottom} and -% \cs{flushbottom} delayed}%^^A -% \changes{v3.27}{2019/03/05}{no \emph{Extrawurst} for letters}%^^A +% \cs{flushbottom} delayed} +% \changes{v3.27}{2019/03/05}{no extra treatment for letters} % Do we have a single column or two columns layout? % \begin{macrocode} %<*(class|(package&typearea))&options> @@ -1170,8 +1079,8 @@ {onecolumn}{twocolumn=false} %</(class|(package&typearea))&options> % \end{macrocode} -% \end{option}%^^A twocolumn -% \end{option}%^^A onecolumn +% \end{option}^^A twocolumn +% \end{option}^^A onecolumn % % % \subsection{Influencing size of head and foot and margins} @@ -1182,10 +1091,10 @@ % area or not. % % \begin{option}{headlines} -% \changes{v2.95}{2002/12/06}{new implementation using \textsf{keyval}}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A +% \changes{v2.95}{2002/12/06}{new implementation using \pkg{keyval}} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} % \begin{option}{footlines} -% \changes{v3.12}{2013/03/26}{new}%^^A +% \changes{v3.12}{2013/03/26}{added} % These are two of the recommended options to set the height of the page head % and footer. Here we set the height by the number of base lines. The number % is a factor to \cs{baselineskip} and therefore a real number. @@ -1215,13 +1124,13 @@ % \end{option} % % \begin{option}{headheight} -% \changes{v2.98c}{2008/04/06}{new}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A +% \changes{v2.98c}{2008/04/06}{added} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} % \begin{option}{footheight} -% \changes{v3.12}{2013/03/26}{new}%^^A +% \changes{v3.12}{2013/03/26}{added} % Instead of setting the height of the page head or footer by the number of % base lines, we can set it also using a length or length value. Note, via -% \Macro{documenclass} or \Macro{usepackage} only length values are supported +% \cs{documenclass} or \cs{usepackage} only length values are supported % (due to an expansion problem by the \LaTeX{} kernel with both commands). % \begin{macrocode} %<*package&typearea&options> @@ -1249,20 +1158,17 @@ % \end{option} % % \begin{option}{headinclude} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} % This options determines whether or not the head is part of the typing % area. % \begin{option}{headexclude} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{deprecated}%^^A -% \begin{macro}{\if@hincl} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v3.01a}{2008/11/21}{deprecated} +% \begin{macro}{\if@hincl,\@hincltrue,\@hinclfalse} +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} % \changes{v2.97c}{2007/04/19}{direct initialization via \cs{if@hsl}, -% if already defined}%^^A -% \begin{macro}{\@hincltrue} -% \begin{macro}{\@hinclfalse} +% if already defined} % We use a boolean switch to store the decision. % \begin{macrocode} %<*package&typearea&options> @@ -1272,30 +1178,27 @@ %</package&typearea&options> % \end{macrocode} % \end{macro} -% \end{macro} -% \end{macro} % \end{option} % \end{option} % % \begin{option}{headsepline} -% \changes{v3.20}{2015/12/12}{\Package{typearea} itself reacts on -% \Option{headsepline}}%^^A -% Until \KOMAScript{} v3.20 \Package{typearea} was not able to handle -% sequences of options \Option{headsepline} and \Option{headinclude} to get -% always a correct result. Until v3.18a \Option{headinclude} was prioritized -% against \Option{headsepline} if used as global options but not if used via -% \Macro{KOMAoptions}. In v3.18a a bug has been fixed with the result that -% \Option{headsepline} was prioritized against \Option{headinclude} if used +% \changes{v3.20}{2015/12/12}{\pkg*{typearea} itself reacts on \opt{headsepline}} +% Until \KOMAScript{} v3.20 \pkg*{typearea} was not able to handle +% sequences of options \opt{headsepline} and \opt{headinclude} to get +% always a correct result. Until v3.18a \opt{headinclude} was prioritized +% against \opt{headsepline} if used as global options but not if used via +% \cs{KOMAoptions}. In v3.18a a bug has been fixed with the result that +% \opt{headsepline} was prioritized against \opt{headinclude} if used % as global options. But intentionally -% \Option{headinclude=false,}\Option{headsepline} or -% \Option{headinclude=true,}\Option{headsepline=false} always should use the -% setting of option \Option{headsepline} independent of setting this as -% global options or using \Macro{KOMAoptions}. Similar with -% \Option{headsepline,}\Option{headinclude=false} or -% \Option{headsepline=false,},\Option{headinclude} the setting of -% \Option{headinclude} should be used. To achieve this \Package{typearea} -% itself has to interpret not only \Option{headinclude} but also -% \Option{headsepline} (as an alias of \Option{headinclude}). +% \opt{headinclude=false,}\opt{headsepline} or +% \opt{headinclude=true,}\opt{headsepline=false} always should use the +% setting of option \opt{headsepline} independent of setting this as +% global options or using \cs{KOMAoptions}. Similar with +% \opt{headsepline,}\opt{headinclude=false} or +% \opt{headsepline=false,},\opt{headinclude} the setting of +% \opt{headinclude} should be used. To achieve this \pkg*{typearea} +% itself has to interpret not only \opt{headinclude} but also +% \opt{headsepline} (as an alias of \opt{headinclude}). % \begin{macrocode} %<*package&typearea&options> \KOMA@key{headsepline}[true]{% @@ -1306,23 +1209,20 @@ } %</package&typearea&options> % \end{macrocode} -% \end{option}%^^A headsepline +% \end{option}^^A headsepline % % \begin{option}{footinclude} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} % \begin{option}{footexclude} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{deprecated}%^^A +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v3.01a}{2008/11/21}{deprecated} % This options determines whether or not the page footer is part of the typing % area. -% \begin{macro}{\if@fincl} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A +% \begin{macro}{\if@fincl,\@fincltrue,\@finclfalse} +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} % \changes{v2.97c}{2007/04/19}{direct initialization via \cs{if@fsl}, -% if already defined}%^^A -% \begin{macro}{\@fincltrue} -% \begin{macro}{\@finclfalse} +% if already defined} % We use a boolean switch to store the decision. % \begin{macrocode} %<*package&typearea&options> @@ -1332,32 +1232,28 @@ %</package&typearea&options> % \end{macrocode} % \end{macro} -% \end{macro} -% \end{macro} % \end{option} % \end{option} % % \begin{option}{footsepline} -% \changes{v3.23}{2017/03/03}{has to set \cs{if@fincl} instead of -% \cs{if@hincl}}%^^A -% \changes{v3.20}{2015/12/12}{\Package{typearea} itself reacts on -% \Option{footsepline}}%^^A -% Until \KOMAScript{} v3.20 \Package{typearea} was not able to handle -% sequences of options \Option{footsepline} and \Option{footinclude} to get -% always a correct result. Until v3.18a \Option{footinclude} was prioritized -% against \Option{footsepline} if used as global options but not if used via -% \Macro{KOMAoptions}. In v3.18a a bug has been fixed with the result that -% \Option{footsepline} was prioritized against \Option{footinclude} if used +% \changes{v3.23}{2017/03/03}{has to set \cs{if@fincl} instead of \cs{if@hincl}} +% \changes{v3.20}{2015/12/12}{\pkg*{typearea} itself reacts on \opt{footsepline}} +% Until \KOMAScript{} v3.20 \pkg*{typearea} was not able to handle +% sequences of options \opt{footsepline} and \opt{footinclude} to get +% always a correct result. Until v3.18a \opt{footinclude} was prioritized +% against \opt{footsepline} if used as global options but not if used via +% \cs{KOMAoptions}. In v3.18a a bug has been fixed with the result that +% \opt{footsepline} was prioritized against \opt{footinclude} if used % as global options. But intentionally -% \Option{footinclude=false,}\Option{footsepline} or -% \Option{footinclude=true,}\Option{footsepline=false} always should use the -% setting of option \Option{footsepline} independent of setting this as -% global options or using \Macro{KOMAoptions}. Similar with -% \Option{footsepline,}\Option{footinclude=false} or -% \Option{footsepline=false,},\Option{footinclude} the setting of -% \Option{footinclude} should be used. To achieve this \Package{typearea} -% itself has to interpret not only \Option{footinclude} but also -% \Option{footsepline} (as an alias of \Option{footinclude}). +% \opt{footinclude=false,}\opt{footsepline} or +% \opt{footinclude=true,}\opt{footsepline=false} always should use the +% setting of option \opt{footsepline} independent of setting this as +% global options or using \cs{KOMAoptions}. Similar with +% \opt{footsepline,}\opt{footinclude=false} or +% \opt{footsepline=false,},\opt{footinclude} the setting of +% \opt{footinclude} should be used. To achieve this \pkg*{typearea} +% itself has to interpret not only \opt{footinclude} but also +% \opt{footsepline} (as an alias of \opt{footinclude}). % \begin{macrocode} %<*package&typearea&options> \KOMA@key{footsepline}[true]{% @@ -1368,24 +1264,21 @@ } %</package&typearea&options> % \end{macrocode} -% \end{option}%^^A footsepline +% \end{option}^^A footsepline % % \begin{option}{mpinclude} -% \changes{v2.8q}{2002/03/28}{new}%^^A -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A +% \changes{v2.8q}{2002/03/28}{added} +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} % \begin{option}{mpexclude} -% \changes{v2.8q}{2002/03/28}{new}%^^A -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{deprecated}%^^A +% \changes{v2.8q}{2002/03/28}{added} +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v3.01a}{2008/11/21}{deprecated} % Some documents have a lot of large margin notes. Optical these margin notes % are more part of the typing area than the margin. This options determines % whether or not margin notes should be part of the typing area. -% \begin{macro}{\if@mincl} -% \changes{v2.95}{2002/07/08}{new implementation using \textsf{keyval}}%^^A -% \begin{macro}{\@mincltrue} -% \begin{macro}{\@minclfalse} +% \begin{macro}{\if@mincl,\@mincltrue,\@minclfalse} +% \changes{v2.95}{2002/07/08}{new implementation using \pkg{keyval}} % We use a boolean switch to store the decision. Note, if the margin notes are % part of the typing area, you should increase the divisor. % \begin{macrocode} @@ -1395,8 +1288,6 @@ %</package&typearea&options> % \end{macrocode} % \end{macro} -% \end{macro} -% \end{macro} % \end{option} % \end{option} % @@ -1404,11 +1295,11 @@ % \subsection{Typing area for the emulation of the standard classes} % % For the emulation of the standard classes we need a dedicated size of the -% typing area, if and only if no explicit \Option{DIV} has been given by +% typing area, if and only if no explicit \opt{DIV} has been given by % option. The emulation of the standard classes is a class feature. We could -% do it before \Package{typearea} and then deactivate initial setting of +% do it before \pkg*{typearea} and then deactivate initial setting of % margins and typing area. But it is more easy to use \cs{areaset} after -% loading \Package{typearea}. The standard letter class cannot be emulated. +% loading \pkg*{typearea}. The standard letter class cannot be emulated. % \begin{macrocode} %<*class&body&!letter> \if@scr@emulatestandardclasses @@ -1451,21 +1342,20 @@ % % \subsection{Using a predefined divisor depending on the font size} % -% Some years ago \Package{typearea} provides the feature to use a hard coded +% Some years ago \pkg*{typearea} provides the feature to use a hard coded % or user defined divisor depending on the document font size. The feature to % define such predefined divisors is deprecated, because it can be used only % for integer font sizes in pt. Nevertheless, for compatibility reasons it is % still implemented. % % \begin{macro}{\ta@divlist} -% \changes{v2.0e}{1994/10/28}{new (internal)}%^^A -% \changes{v2.6}{2000/01/04}{the list provides values from font size -% 1\,pt}%^^A +% \changes{v2.0e}{1994/10/28}{added} +% \changes{v2.6}{2000/01/04}{the list provides values from font size 1\,pt} % \begin{macro}{\ta@divlistelse} -% \changes{v2.6}{2000/01/04}{neu (internal)}%^^A +% \changes{v2.6}{2000/01/04}{added} % We need a default settings for 10\,pt, 11\,pt and 12\,pt. But we define it % only if they has not been defined before. So classes could define other -% defaults before loading \Package{typearea}. +% defaults before loading \pkg*{typearea}. % \begin{macrocode} %<*package&typearea&init> \providecommand\ta@divlist{{}{}{}{}{}{}{}{}{}{8}{10}{12}} @@ -1484,10 +1374,10 @@ % depending on the font size given by the real number argument. The real % number will be rounded to the nearest integer. % \changes{v2.4g}{1996/11/04}{usage of the default value list} -% \changes{v2.6}{2000/01/04}{usage of the extended list}%^^A -% \changes{v2.8q}{2002/03/28}{respect option \Option{mpinclude}}%^^A -% \changes{v2.96}{2006/08/11}{font size does not need to be an integer}%^^A -% \changes{v3.25}{2018/03/05}{paper size test added}%^^A +% \changes{v2.6}{2000/01/04}{usage of the extended list} +% \changes{v2.8q}{2002/03/28}{respect option \opt{mpinclude}} +% \changes{v2.96}{2006/08/11}{font size does not need to be an integer} +% \changes{v3.25}{2018/03/05}{paper size test added} % \begin{macrocode} %<*package&typearea&body> \newcommand*{\ta@divfor}[1]{% @@ -1563,18 +1453,12 @@ % \end{macrocode} % \end{macro} % -% The documentation of the deprecated part of the feature is still in German. -% \selectlanguage{ngerman} % -% \begin{macro}{\SetDIVList} -% \changes{v2.1a}{1994/10/28}{neu}%^^A -% \changes{v2.6}{2000/01/04}{\cs{ta@divlist} enthält Werte für -% Schriftgrößen ab 1pt}%^^A -% \changes{v3.24}{2017/07/23}{deprecated command}%^^A -% Der Befehl \cs{SetDIVList} tut nichts weiter als die innere Variable -% für die schriftgrößenabhängige \emph{DIV}-Liste \cs{ta@divlist} neu -% zu definieren. Dabei können \emph{DIV}-Werte für Größen ab 10\,pt -% gesetzt werden. +% \begin{command}{\SetDIVList} +% \changes{v2.1a}{1994/10/28}{new} +% \changes{v2.6}{2000/01/04}{\cs{ta@divlist} holds values for font sizes from 1\,pt} +% \changes{v3.24}{2017/07/23}{deprecated} +% The command is deprecated. Don't use it any longer. % \begin{macrocode} %<*package&typearea&body> \newcommand*\SetDIVList[1]{% @@ -1587,14 +1471,12 @@ any longer}% \def\ta@divlist{{}{}{}{}{}{}{}{}{}#1}} % \end{macrocode} -% \end{macro} +% \end{command}^^A \SetDIVList % -% \begin{macro}{\SetXDIVList} -% \changes{v2.6}{2000/01/04}{neu}%^^A -% \changes{v3.24}{2017/07/23}{deprecated command}%^^A -% Da mit \cs{SetDIVList} aus Kompatibilitätsgründen nur Werte für -% Größen ab 10\,pt gesetzt werden können, wird für Werte ab 1\,pt -% ein neuer Befehl benötigt. +% \begin{command}{\SetXDIVList} +% \changes{v2.6}{2000/01/04}{neu} +% \changes{v3.24}{2017/07/23}{deprecated} +% The command is deprecated. Don't use it any longer. % \begin{macrocode} \newcommand*\SetXDIVList[1]{% \PackageWarning{typearea}{\string\SetXDIVList\space is @@ -1607,9 +1489,8 @@ \def\ta@divlist{#1}} %</package&typearea&body> % \end{macrocode} -% \end{macro} +% \end{command}^^A \SetXDIVList % -% \selectlanguage{english} % % \subsection{Calculation of typing area and margins} % @@ -1620,32 +1501,32 @@ % The parameters and the calculation is needed before the options can be % processed. % -% \begin{Length}{\ta@bcor} +% \begin{ilength}{\ta@bcor} % \changes{v2.2a}{1995/01/25}{definition of the dimension before option -% \Option{BCOR}}%^^A +% \opt{BCOR}} % \changes{v2.7g}{2001/04/17}{definition using \cs{newlength} instead of -% \cs{newdimen}}%^^A +% \cs{newdimen}} % We need a length to store the binding correction. It is initializes to 0\,pt -% implicitly by \Macro{newlength}. +% implicitly by \cs{newlength}. % \begin{macrocode} %<*package&typearea&options> \newlength{\ta@bcor} % \end{macrocode} -% \end{Length} +% \end{ilength} % % \begin{macro}{\ta@div} % \changes{v2.2a}{1995/01/25}{definition of the dimension before option -% \Option{BCOR}}%^^A +% \opt{BCOR}} % We need a counter for the divisor (aka \emph{DIV}). It is initializes to -% 0\,pt implicitly by \Macro{newcount}. +% 0\,pt implicitly by \cs{newcount}. So it is not a \LaTeX{} counter but a +% \TeX{} counter. % \begin{macrocode} \newcount\ta@div %</package&typearea&options> % \end{macrocode} % \end{macro} % -% \begin{Length}{\ta@hblk} -% \begin{Length}{\ta@vblk} +% \begin{ilength}{\ta@hblk,\ta@vblk} % Width of one horizontal resp. height of one vertical block. % \begin{macrocode} %<*package&typearea&body> @@ -1653,10 +1534,9 @@ \newlength{\ta@vblk} %</package&typearea&body> % \end{macrocode} -% \end{Length} -% \end{Length} +% \end{ilength} % -% \begin{Length}{\ta@temp} +% \begin{ilength}{\ta@temp} % Used several times instead of \cs{@tempdima}, \cs{@tempdimb} or another % temporary dimension or glue of the LaTeX{} kernel. Nevertheless I should % think about not using this temporary length any longer. @@ -1665,13 +1545,13 @@ \newlength{\ta@temp} %</package&typearea&body> % \end{macrocode} -% \end{Length} +% \end{ilength} % % \begin{option}{BCOR} -% \changes{v2.2a}{1995/01/25}{new}%^^A -% \changes{v2.95}{2002/12/04}{new implementation using \textsf{keyval}}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A +% \changes{v2.2a}{1995/01/25}{added} +% \changes{v2.95}{2002/12/04}{new implementation using \pkg{keyval}} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} +% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}} % The value is written into the length \cs{ta@bcor}. Several symbolic values % are supported that have to be converted into a length. Note, while loading % the package symbolic values are nonsense. @@ -1687,8 +1567,8 @@ % \end{macrocode} % After loading the package we have to do a little bit more, because we need % to recalculate the areas. -% \changes{v3.13}{2014/06/30}{\cs{FamilyKeyStateProcessed} added}%^^A -% \changes{v3.24}{2017/07/23}{\cs{KOMA@kav@xreplacevalue} added}%^^A +% \changes{v3.13}{2014/06/30}{\cs{FamilyKeyStateProcessed} added} +% \changes{v3.24}{2017/07/23}{\cs{KOMA@kav@xreplacevalue} added} % \begin{macrocode} \AtEndOfPackage{% \KOMA@key{BCOR}{% @@ -1702,20 +1582,20 @@ % \end{option} % % \begin{option}{DIV} -% \changes{v2.2a}{1995/01/25}{new option}%^^A -% \changes{v2.95}{2002/12/04}{new implementation using \textsf{keyval}}%^^A -% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}}%^^A +% \changes{v2.2a}{1995/01/25}{new option} +% \changes{v2.95}{2002/12/04}{new implementation using \pkg{keyval}} +% \changes{v3.12}{2013/03/05}{status signaling using \cs{FamilyKeyState}} % The value is written into the counter \cs{ta@div}. Several symbolic values % are supported and have to be converted into a counter. Note, while loading % the package symbolic values are nonsense. % \begin{macro}{\@lastdiv} -% \changes{v3.30}{2020/03/24}{init the internal macro}%^^A -% This internal macro stores the last value to option \texttt{DIV}. It is +% \changes{v3.30}{2020/03/24}{init the internal macro} +% This internal macro stores the last value to option \opt{DIV}. It is % initialized with \cs{relax}. % \begin{macrocode} %<package&typearea&init>\newcommand*{\@lastdiv}{\z@}\let\@lastdiv\relax % \end{macrocode} -% \end{macro}%^^A \@lastdiv +% \end{macro}^^A \@lastdiv % \begin{macrocode} %<*package&typearea&options> \def\movet@reserved@a@to@nnil#1\@nnil{\def\reserved@a{#1}}% @@ -1751,8 +1631,8 @@ % \end{macrocode} % After loading the package we have to do a little bit more, because we need % to recalculate the areas. -% \changes{v3.13}{2014/06/30}{\cs{FamilyKeyStateProcessed} added}%^^A -% \changes{v3.24}{2017/07/23}{\cs{KOMA@kav@xreplacevalue} added}%^^A +% \changes{v3.13}{2014/06/30}{\cs{FamilyKeyStateProcessed} added} +% \changes{v3.24}{2017/07/23}{\cs{KOMA@kav@xreplacevalue} added} % \begin{macrocode} \AtEndOfPackage{% \KOMA@key{DIV}{% @@ -1765,13 +1645,13 @@ % \end{macrocode} % \end{option} % -% \begin{macro}{\typearea} +% \begin{command}{\typearea} % This is the real reason for the package: calculation of typing area and % margins providing an optional binding correction and depending on a % divisor. % \begin{macro}{\@typearea} -% \changes{v2.4n}{1997/05/28}{moved main calculation into \cs{@typearea}}%^^A -% \changes{v2.95}{2002/08/20}{\cs{selectfont} added}%^^A +% \changes{v2.4n}{1997/05/28}{moved main calculation into \cs{@typearea}} +% \changes{v2.95}{2002/08/20}{\cs{selectfont} added} % The calculation itself is done in \cs{@typearea}. This command does not need % any parameters because it uses \cs{ta@div} and \cs{ta@bcor}. % \begin{macrocode} @@ -1793,7 +1673,7 @@ % whether or not is should be part of the typing area and whether of not we % have a double sided document. % \changes{v2.8q}{2002/03/28}{\cs{marginparwidth} depends on -% \Option{mpinclude}}%^^A +% \opt{mpinclude}} % \begin{macrocode} \if@mincl \marginparwidth=\ta@hblk @@ -1821,11 +1701,11 @@ \advance\oddsidemargin by1.5\ta@hblk \advance\oddsidemargin by\ta@bcor % \end{macrocode} -% \changes{v3.12}{2013/10/15}{use alternating \texttt{BCOR} with -% \texttt{twoside!=semi}} +% \changes{v3.12}{2013/10/15}{use alternating \opt{BCOR} with +% \opt{twoside\quotechar=semi}} % From v3.12 the binding correction is part of the inner margin also for -% \Option{twoside=semi}. If compatibility to earlier release is selected the -% binding correction with \Option{twoside=semi} is always added to the left +% \opt{twoside=semi}. If compatibility to earlier release is selected the +% binding correction with \opt{twoside=semi} is always added to the left % margin. % \begin{macrocode} \expandafter\ifnum\scr@ta@v@is@lt{3.12}\relax @@ -1861,7 +1741,7 @@ % for the margin note column, the width of margin note column will be % reduced. This can be done easily be swapping the two lengths. % \changes{v3.30}{2020/02/25}{orphan line break at end of warning message -% removed}%^^A +% removed} % \begin{macrocode} \if@mincl \advance\textwidth by-\marginparwidth @@ -1930,7 +1810,7 @@ \do{\advance\textheight by\baselineskip}% } % \end{macrocode} -% \end{macro}%^^A \@typearea +% \end{macro}^^A \@typearea % % \begin{macro}{\ta@modiv} % Needed by \cs{typearea}. The first parameter will be divided by the second @@ -1960,7 +1840,7 @@ \fi } % \end{macrocode} -% \end{macro} +% \end{macro}^^A \ta@modiv % % \begin{macro}{\ta@temp@goodwidth} % Sets \cs{ta@temp} to the heuristic optimal line width depending on the @@ -1969,10 +1849,9 @@ % case letters (minors) and three upper case letters (majors). Normally the % weight of a letter depends on the language but we use same weight for each % letter. -% \changes{v2.7i}{2001/05/17}{avoid overflows if a very large font is -% used}%^^A -% \changes{v2.8q}{2002/03/06}{\cs{normalfont} \cs{normalsize} added}%^^A -% \changes{v2.95a}{2006/07/20}{fix of large font calculation}%^^A +% \changes{v2.7i}{2001/05/17}{avoid overflows if a very large font is used} +% \changes{v2.8q}{2002/03/06}{\cs{normalfont} \cs{normalsize} added} +% \changes{v2.95a}{2006/07/20}{fix of large font calculation} % \begin{macrocode} \newcommand*\ta@temp@goodwidth{% \settowidth{\ta@temp}{\normalfont\normalsize @@ -1993,12 +1872,12 @@ \fi } % \end{macrocode} -% \end{macro} +% \end{macro}^^A \ta@temp@goodwidth % -% \begin{macro}{\AfterCalculatingTypearea} -% \changes{v2.96a}{2006/11/29}{new}%^^A +% \begin{command}{\AfterCalculatingTypearea} +% \changes{v2.96a}{2006/11/29}{added} % \changes{v3.20}{2016/04/12}{\cs{@ifstar} replaced by -% \cs{kernel@ifstar}}%^^A +% \cs{kernel@ifstar}} % Users can influence the behaviour of \cs{typearea} by a hook. The star % variation adds the code locally the non-star variation globally. % \begin{macrocode} @@ -2007,19 +1886,19 @@ } % \end{macrocode} % \begin{macro}{\@typearea@end} -% \changes{v2.96a}{2006/11/29}{defined again but completely different}%^^A +% \changes{v2.96a}{2006/11/29}{defined again but completely different} % Macro \cs{@typearea@end} is a hook that is executed at the end of % \cs{typearea} but before the activation of the new settings. So you can % change the result of \cs{typearea}. % \begin{macrocode} \newcommand*{\@typearea@end}{} % \end{macrocode} -% \end{macro} -% \end{macro} +% \end{macro}^^A \@typearea@end +% \end{command}^^A \AfterCalculatingTypearea % -% \begin{macro}{\activateareas} -% \changes{v2.96a}{2006/11/29}{new name for old macro}%^^A -% \changes{v3.17}{2015/02/07}{respect option \texttt{usegeometry}}%^^A +% \begin{command}{\activateareas} +% \changes{v2.96a}{2006/11/29}{new name for old macro} +% \changes{v3.17}{2015/02/07}{respect option \opt{usegeometry}} % This macro is used to activate the new typing area and margin settings % inside the document body. It is a hack, because is uses internal \LaTeX{} % kernel code. @@ -2032,7 +1911,7 @@ \if@atdocument % \end{macrocode} % \changes{v3.23}{2017/04/03}{info instead of warning if used inside the -% document body}%^^A +% document body} % But if, we show an info, because it is a hack. It depends in the \LaTeX{} % release. Nevertheless, it seems to be stable from the very first \LaTeXe{} % release. So we use an info only. Before v3.23 we have used a warning. @@ -2061,9 +1940,9 @@ \KOMAoptions{pagesize=\@pagesizelast}% }% % \end{macrocode} -% \changes{v3.17}{2015/03/18}{adapt the \Option{parskip} settings}%^^A +% \changes{v3.17}{2015/03/18}{adapt the \opt{parskip} settings} % From v3.17 changes of the typing area can immediately change some of the -% \Option{parskip} settings. Before |\begin{document}| the change will be done +% \opt{parskip} settings. Before |\begin{document}| the change will be done % automatically at |\begin{document}| and therefore adding it here is correct. % \begin{macrocode} \expandafter\ifnum\scr@ta@v@is@ge{3.17}% @@ -2071,12 +1950,12 @@ \fi \fi % \end{macrocode} -% \changes{v3.17}{2015/02/07}{new code for option \Option{usegeometry}} -% If option \Option{usegeometry} is active we need to setup several options of -% package \Package{geometry}. We use \cs{scr@geometryargs} to store them. And -% we either have to pass these options to \Package{geometry} or define a new +% \changes{v3.17}{2015/02/07}{new code for option \opt{usegeometry}} +% If option \opt{usegeometry} is active we need to setup several options of +% package \pkg{geometry}. We use \cs{scr@geometryargs} to store them. And +% we either have to pass these options to \pkg{geometry} or define a new % geometry. In the second case we also need some hacks to make the new paper -% size available for \Package{geometry}. +% size available for \pkg{geometry}. % \begin{macrocode} \edef\scr@geometryargs{% bindingoffset=\the\ta@bcor, @@ -2131,40 +2010,38 @@ } % \end{macrocode} % \begin{macro}{\scr@geometryargs} -% \changes{v3.16}{2015/02/07}{neu (intern)}%^^A -% The initialization of the \Package{geometry} options is empty. It will be +% \changes{v3.16}{2015/02/07}{neu (intern)} +% The initialization of the \pkg{geometry} options is empty. It will be % filled automatically by \cs{activateareas}. % \begin{macrocode} \newcommand*{\scr@geometryargs}{} % \end{macrocode} -% \end{macro} -% \end{macro} -% -% \changes{v2.4g}{1996/11/04}{waste comments removed}%^^A -% \changes{v2.7g}{2001/04/17}{new symbolic values \texttt{current}, -% \texttt{default}, \texttt{calc}, \texttt{classic}}%^^A -% \changes{v2.8q}{2001/11/06}{new symbolic value \texttt{last}}%^^A -% \changes{v2.96}{2006/08/21}{warn if \cs{typearea} is used inside a -% group}%^^A -% \changes{v3.10}{2011/09/13}{using \cs{scr@grouplevel@test}}%^^A -% \changes{v3.12}{2013/03/26}{page footer height configurable}%^^A -% \changes{v3.30}{2020/03/24}{\texttt{current} after \cs{areaset} is -% \texttt{areaset}}%^^A +% \end{macro}^^A \scr@geometryargs +% \end{command}^^A \activateareas +% +% \changes{v2.4g}{1996/11/04}{waste comments removed} +% \changes{v2.7g}{2001/04/17}{new symbolic values \opt{current}, +% \opt{default}, \opt{calc}, \opt{classic}} +% \changes{v2.8q}{2001/11/06}{new symbolic value \opt{last}} +% \changes{v2.96}{2006/08/21}{warn if \cs{typearea} is used inside a group} +% \changes{v3.10}{2011/09/13}{using \cs{scr@grouplevel@test}} +% \changes{v3.12}{2013/03/26}{page footer height configurable} +% \changes{v3.30}{2020/03/24}{\opt{current} after \cs{areaset} is \opt{areaset}} % % The symbolic values of the obligatory argument of \cs{typearea}: % \begin{center}\begin{tabular}{lll} % Symbol & Value & Meaning \\\hline\\[-2ex] -% \texttt{calc} & 2 & calculate a good value \\ -% \texttt{classic} & 3 & \emph{mittelalterlicher Buchseitenkanon} \\ -% \texttt{current} & --- & use the current value \\ -% \texttt{default} & 0 & use a value from the list \\ -% \texttt{last} & --- & use the value from the last usage of +% \opt{calc} & 2 & calculate a good value \\ +% \opt{classic} & 3 & \emph{mittelalterlicher Buchseitenkanon} \\ +% \opt{current} & --- & use the current value \\ +% \opt{default} & 0 & use a value from the list \\ +% \opt{last} & --- & use the value from the last usage of % \cs{typearea} \\ -% \texttt{areaset} & --- & replace the current typing area \\ +% \opt{areaset} & --- & replace the current typing area \\ % \end{tabular}\end{center} % % There is only one symbolic value that can be used as the optional argument: -% \texttt{current}. +% \opt{current}. % \begin{macrocode} \newcommand*\typearea[2][\z@]{% \scr@grouplevel@test\typearea @@ -2195,7 +2072,7 @@ % \end{macrocode} % Before we do the calculation we need to start a new page if we are inside % the document's body. And we need to select the document font size. -% \changes{v2.95a}{2006/07/20}{select document font size}%^^A +% \changes{v2.95a}{2006/07/20}{select document font size} % \begin{macrocode} \if@atdocument\newpage\fi \normalsize @@ -2203,9 +2080,9 @@ % Is the height of the page head already given or do we need to calculate % it. If we need to calculate it we use 1.25 of the base lines distance. This % gives enough room for optional separation lines (which are set outside if -% use \Package{scrlayer-scrpage}). +% use \pkg*{scrlayer-scrpage}). % \changes{v2.4n}{1997/05/28}{page head height depends on base line -% distance}%^^A +% distance} % \begin{macrocode} \@ifundefined{ta@hh}{% \headheight=1.25\baselineskip @@ -2222,8 +2099,8 @@ % \begin{macrocode} \headsep=1.5\baselineskip % \end{macrocode} -% The foot is a similar problem. But we have to setup also \cs{footskip} not -% only \cs{footheight}. +% The foot is a similar problem. But we have to setup also \len{footskip} not +% only \len{footheight}. % \begin{macrocode} \@ifundefined{footheight}{% \newlength\footheight @@ -2240,13 +2117,13 @@ \marginparsep=1cc \marginparpush=0.45\baselineskip % \end{macrocode} -% \changes{v2.4g}{1996/11/04}{\textit{DIV}=0 tries to use a value from the -% default list} +% \changes{v2.4g}{1996/11/04}{\opt{DIV\quotechar=0} tries to use a value from the +% default list} % Before we do the calculation we test, whether the resulting divisor is % 0. Values from 0 up to 3 are not possible because we use three parts for the % margins. So we can use 0 to get a value from the default value list if % available. -% \changes{v2.5h}{1999/12/29}{warning message changed}%^^A +% \changes{v2.5h}{1999/12/29}{warning message changed} % \begin{macrocode} \ifnum\ta@div=\z@ \@ifundefined{@ptsize}{% @@ -2265,8 +2142,7 @@ \ta@divfor{\@ptsize}% \fi % \end{macrocode} -% \changes{v2.4n}{1997/05/28}{optional \emph{klassischer -% Buchseitenkanon}}%^^A +% \changes{v2.4n}{1997/05/28}{optional \emph{klassischer Buchseitenkanon}} % Another special case is if the divisor is 3. In this case we calculate a % divisor near to the \emph{klassischer Buchseitenkanon}. This means we try to % have the height of the typing area is as near as possible the width of the @@ -2316,14 +2192,14 @@ \ta@modiv{\paperheight}{\ta@temp}% \fi % \end{macrocode} -% Here we do not need to respect \Option{mpinclude} because we do not use the +% Here we do not need to respect \opt{mpinclude} because we do not use the % width of the typing area but the height of the paper. % \begin{macrocode} \fi % \end{macrocode} % If we did not found a good value until this point, we try to calculate the % optimal divisor. -% \changes{v2.4n}{1997/05/28}{improved optimal divisor calculation}%^^A +% \changes{v2.4n}{1997/05/28}{improved optimal divisor calculation} % \begin{macrocode} \ifnum\ta@div <4 \typeout{DIV calculation for typearea with good linewidth.}% @@ -2340,8 +2216,8 @@ % \end{macrocode} % In two column mode each text line has two such columns plus the column % separation width. -% \changes{v2.8q}{2001/12/13}{\texttt{DIVcalc} uses wider columns in two -% column mode}%^^A +% \changes{v2.8q}{2001/12/13}{\opt{DIVcalc} uses wider columns in two +% column mode} % \begin{macrocode} \if@twocolumn \addtolength{\ta@temp}{\ta@temp}% @@ -2369,9 +2245,9 @@ % \end{macrocode} % The width of block and the width of the paper can be used to calculate the % divisor. -% \changes{v2.8q}{2002/03/28}{respect \Option{mpinclude} at the calculation -% of the best divisor}%^^A -% If option \Option{mpinclude} is active, we have to multiply the divisor with +% \changes{v2.8q}{2002/03/28}{respect \opt{mpinclude} at the calculation +% of the best divisor} +% If option \opt{mpinclude} is active, we have to multiply the divisor with % $\frac{3}{3+m}$. $m$ is the number of blocks used for the margin notes. If % $m=1$ we have an factor of $\frac{3}{4}=0.75$. More difficult would be not % to use a number of blocks for the margin note column but a dedicated value @@ -2401,9 +2277,9 @@ % This would be the minimum top margin. If the margin is less, we need another % divisor. In this case we also have to recognize whether the page head and % footer are part of the margins or the typing area. -% \changes{v2.5b}{1997/06/29}{take care for \Option{headinclude} and -% \Option{footinclude} while calculating the divisor for minimum top -% margin}%^^A +% \changes{v2.5b}{1997/06/29}{take care for \opt{headinclude} and +% \opt{footinclude} while calculating the divisor for minimum top +% margin} % \begin{macrocode} \setlength{\ta@temp}{15mm}% \if@hincl\else @@ -2425,22 +2301,20 @@ % \begin{macrocode} \@typearea % \end{macrocode} -% \changes{v2.0e}{1994/10/28}{write layout values to the \File{log} file}%^^A -% \changes{v2.4i}{1996/11/11}{write to the \File{log} file later}%^^A -% \changes{v2.4i}{1996/11/11}{execute \cs{@typearea@end} at the end of -% \cs{typearea}}%^^A -% \changes{v2.4j}{1996/12/04}{\File{log} output with only one -% \cs{textheight} but additional \cs{baselineskip}}%^^A -% \changes{v2.5}{1997/06/17}{"`arithmetic overflow"' with \Option{landscape} -% fixed}%^^A -% \changes{v2.95}{2004/01/30}{warning in two column mode fixed}%^^A +% \changes{v2.0e}{1994/10/28}{write layout values to the \file{log} file} +% \changes{v2.4i}{1996/11/11}{write to the \file{log} file later} +% \changes{v2.4i}{1996/11/11}{execute \cs{@typearea@end} at the end of \cs{typearea}} +% \changes{v2.4j}{1996/12/04}{\file{log} output with only one +% \cs{textheight} but additional \cs{baselineskip}} +% \changes{v2.5}{1997/06/17}{"`arithmetic overflow"' with \opt{landscape} fixed} +% \changes{v2.95}{2004/01/30}{warning in two column mode fixed} % \changes{v3.00}{2008/10/08}{use \cs{ta@layoutinfo} to write the layout -% values into the \File{log} file}%^^A -% \changes{v3.01b}{2008/12/09}{warning for sub-optimal settings changed}%^^A -% \changes{v3.26}{2018/07/16}{warning about long lines changed}%^^A +% values into the \file{log} file} +% \changes{v3.01b}{2008/12/09}{warning for sub-optimal settings changed} +% \changes{v3.26}{2018/07/16}{warning about long lines changed} % \changes{v3.26}{2018/07/16}{warning about small lines changed and -% replaced by an info}%^^A -% Last but not least we write some layout values into the \File{log} file. For +% replaced by an info} +% Last but not least we write some layout values into the \file{log} file. For % some of the information we need additional calculations, e.g., of a good % line width. % \begin{macrocode} @@ -2524,8 +2398,8 @@ % \end{macrocode} % % \begin{macro}{\ta@layoutinfo} -% \changes{v3.00}{2008/10/08}{new (internal)}%^^A -% Write several layout information into the \File{log} file. The first +% \changes{v3.00}{2008/10/08}{added} +% Write several layout information into the \file{log} file. The first % argument is the current divisor and the second the discrepancy from the % optimal divisor or empty or \cs{relax}. % \begin{macrocode} @@ -2565,11 +2439,11 @@ }% } % \end{macrocode} -% \end{macro} -% \end{macro} +% \end{macro}^^A \ta@layoutinfo +% \end{command}^^A \typearea % -% \begin{macro}{\recalctypearea} -% \changes{v2.95}{2002/12/04}{new}%^^A +% \begin{command}{\recalctypearea} +% \changes{v2.95}{2002/12/04}{added} % This command can be used to recalculate the typing area and the margins with % the divisor and the binding correction that has been used last. The command % is available only after loading the package. So it is an indicator if we @@ -2578,14 +2452,13 @@ \AtEndOfPackage{\newcommand*{\recalctypearea}{\typearea[current]{last}}} %</package&typearea&body> % \end{macrocode} -% \end{macro} +% \end{command} % % Initially \cs{ta@bcor} and \cs{ta@div} are zero if is has not been set using % one of the options. The 0 divisor stands for using a value from the default % list. So the final initialization of the typing area and margins is very % easy. -% \changes{v2.8q}{2001/11/06}{initialization using symbolic values -% \texttt{current}}%^^A +% \changes{v2.8q}{2001/11/06}{initialization using symbolic values \opt{current}} % \begin{macrocode} %<*package&typearea&final> \typearea[current]{current} @@ -2594,14 +2467,13 @@ % % \subsection{Storage and reactivation of typing area and margin settings} % -% \begin{macro}{\storeareas} -% \changes{v3.10}{2011/09/13}{new}%^^A -% \changes{v3.18}{2015/05/20}{Hooks at the beginning and end of the defined -% macro}%^^A +% \begin{command}{\storeareas} +% \changes{v3.10}{2011/09/13}{added} +% \changes{v3.18}{2015/05/20}{Hooks at the beginning and end of the defined macro} % You can store the current settings of the typing area and the margins in a % macro. If you use the macro later the stored settings will be restored. % \begin{macro}{\scr@grouplevel@test} -% \changes{v3.10}{2011/09/13}{new (internal)}%^^A +% \changes{v3.10}{2011/09/13}{added} % Warn if restoring the settings is used inside a group. % \begin{macrocode} %<*package&typearea&body> @@ -2666,24 +2538,13 @@ \reserved@a } % \end{macrocode} -% \begin{macro}{\BeforeRestoreareas} -% \changes{v3.18}{2015/05/20}{new}%^^A -% \changes{v3.20}{2016/04/12}{\cs{@ifstar} replaced by -% \cs{kernel@ifstar}}%^^A -% \begin{macro}{\AfterRestoreareas} -% \changes{v3.18}{2015/05/20}{new}%^^A -% \changes{v3.20}{2016/04/12}{\cs{@ifstar} replaced by -% \cs{kernel@ifstar}}%^^A -% \begin{macro}{\scr@storeareashook} -% \changes{v3.18}{2015/05/20}{new (internal)}%^^A -% \begin{macro}{\scr@storeareas@before@hook} -% \changes{v3.18}{2015/05/20}{new (internal)}%^^A -% \begin{macro}{\scr@storeareas@before@current@hook} -% \changes{v3.18}{2015/05/20}{new (internal)}%^^A -% \begin{macro}{\scr@storeareas@after@hook} -% \changes{v3.18}{2015/05/20}{new (internal)}%^^A -% \begin{macro}{\scr@storeareas@after@current@hook} -% \changes{v3.18}{2015/05/20}{new (internal)}%^^A +% \begin{command}{\BeforeRestoreareas,\AfterRestoreareas} +% \changes{v3.18}{2015/05/20}{added} +% \changes{v3.20}{2016/04/12}{\cs{@ifstar} replaced by \cs{kernel@ifstar}} +% \begin{macro}{\scr@storeareashook,\scr@storeareas@before@hook, +% \scr@storeareas@before@current@hook,\scr@storeareas@after@hook, +% \scr@storeareas@after@current@hook} +% \changes{v3.18}{2015/05/20}{added} % Adds code to one of the hooks of the macros defined by \cs{storeareas}. % The star variants adds code only to not yet defined macros. The non-star % variant also changes already defined macros. @@ -2705,24 +2566,19 @@ \newcommand*{\scr@storeareas@after@current@hook}{} %</package&typearea&body> % \end{macrocode} -% \end{macro}%^^A \scr@storeareas@after@current@hook -% \end{macro}%^^A \scr@storeareas@after@hook -% \end{macro}%^^A \scr@storeareas@before@current@hook -% \end{macro}%^^A \scr@storeareas@before@hook -% \end{macro}%^^A \scr@storeareashook -% \end{macro}%^^A \AfterRestoreareas -% \end{macro}%^^A \BeforeRestoreareas -% \end{macro}%^^A \scr@grouplevel@test -% \end{macro}%^^A \storeareas +% \end{macro}^^A \scr@storeareashook … \scr@storeareas@after@current@hook +% \end{command}^^A \BeforeRestoreareas,\AfterRestoreareas +% \end{macro}^^A \scr@grouplevel@test +% \end{command}^^A \storeareas % % \subsection{Calculation of margins for a given typing area} % % Beside the calculation of the typing area and the margins by a divisor -% \Package{typearea} also provides the calculation of margins for a given +% \pkg*{typearea} also provides the calculation of margins for a given % typing area. % % \begin{option}{areasetadvanced} -% \changes{v3.11}{2012/04/17}{new}%^^A +% \changes{v3.11}{2012/04/17}{added} % Switch to advanced version of \cs{areaset}. This does calculate margins % more like \cs{typearea}. Nevertheless, there's still a difference at the top % margin, because \cs{typerea} doesn't balance differences in calculated @@ -2735,14 +2591,14 @@ % \end{macrocode} % \end{option} % -% \begin{macro}{\areaset} -% \changes{v2.1b}{1994/12/31}{\cs{headheight} depends on \cs{@ptsize}}%^^A +% \begin{command}{\areaset} +% \changes{v2.1b}{1994/12/31}{\cs{headheight} depends on \cs{@ptsize}} % \changes{v2.6}{2000/01/04}{\cs{headheight} depends on \cs{f@size} instead -% of \cs{@ptsize}}%^^A -% \changes{v2.7g}{2001/04/17}{symbolic value \texttt{current} for the -% optional argument}%^^A +% of \cs{@ptsize}} +% \changes{v2.7g}{2001/04/17}{symbolic value \opt{current} for the +% optional argument} % \changes{v2.95}{2002/12/05}{execute \cs{@typearea@end} at the end of -% \cs{areaset}}%^^A +% \cs{areaset}} % If we have given width and height of the typing area we still can calculate % the margins. Again we want to use this not only in the document preamble but % also in the document body. @@ -2760,7 +2616,7 @@ % Then we do the calculation. % \changes{v2.96}{2006/09/12}{set \cs{topskip}} % \changes{v3.00}{2008/10/08}{use \cs{ta@layoutinfo} to write layout -% information into the \File{log} file}%^^A +% information into the \file{log} file} % \begin{macrocode} \setlength{\textwidth}{#2}% \setlength{\textheight}{#3}% @@ -2775,7 +2631,7 @@ % \end{macrocode} % \changes{v3.11}{2012/04/17}{advanced version with different margin widths}% % With v3.11 we will have an advanced version of \cs{areaset}. This -% version takes care to option \texttt{mpinclude}. +% version takes care to option \opt{mpinclude}. % \begin{macrocode} \if@areasetadvanced \if@mincl @@ -2793,9 +2649,9 @@ \advance\oddsidemargin by1.5\ta@hblk \advance\oddsidemargin by\ta@bcor % \end{macrocode} -% \changes{v3.12}{2013/10/15}{use alternating \texttt{BCOR} with -% \texttt{twoside!=semi}} -% If \Option{twoside=semi} is used, form v3.12 we add the binding correction +% \changes{v3.12}{2013/10/15}{use alternating \opt{BCOR} with +% \opt{twoside\quotechar=semi}} +% If \opt{twoside=semi} is used, form v3.12 we add the binding correction % to the inner margin. If compatibility to version less than 3.12 has been % selected the binding correction will be added to the left margin. % \begin{macrocode} @@ -2839,7 +2695,7 @@ \fi \headsep=1.5\baselineskip % \end{macrocode} -% \changes{v3.12}{2013/03/26}{changes for height of foot}%^^A +% \changes{v3.12}{2013/03/26}{changes for height of foot} % \begin{macrocode} \@ifundefined{footheight}{\newlength\footheight}{} \if@areasetadvanced @@ -2884,7 +2740,7 @@ % \changes{v3.11}{2012/04/17}{advanced version with different % \cs{marginparwidth} and unchanged \cs{marginparsep}}% % With version 3.11 we will have an advanced version of \cs{areaset}. This -% version supports \texttt{mpinclude} option like \cs{typearea}. +% version supports \opt{mpinclude} option like \cs{typearea}. % \begin{macrocode} \if@areasetadvanced \if@mincl @@ -2898,9 +2754,9 @@ \marginparpush=0.45\baselineskip \ta@layoutinfo{areaset}{}% % \end{macrocode} -% \changes{v3.11}{2012/04/17}{using \cs{@areaset@end}}%^^A +% \changes{v3.11}{2012/04/17}{using \cs{@areaset@end}} % \changes{v3.16a}{2015/02/11}{using \cs{footheight} for calculation of -% page usage}%^^A +% page usage} % Since v3.11 we also support \cs{AfterSettingArea} analogous to % \cs{AfterCalculatingTypearea}: % \begin{macrocode} @@ -2920,12 +2776,11 @@ \fi } % \end{macrocode} -% \end{macro} +% \end{command} % -% \begin{macro}{\AfterSettingArea} -% \changes{v3.11}{2012/04/17}{new}%^^A -% \changes{v3.20}{2016/04/12}{\cs{@ifstar} durch \cs{kernel@ifstar} -% ersetzt}%^^A +% \begin{command}{\AfterSettingArea} +% \changes{v3.11}{2012/04/17}{added} +% \changes{v3.20}{2016/04/12}{\cs{@ifstar} replaced by \cs{kernel@ifstar}} % The user may influence the result of \cs{areaset}. The star version works % local while the non-star version is global. % \begin{macrocode} @@ -2934,7 +2789,7 @@ } % \end{macrocode} % \begin{macro}{\@areaset@end} -% \changes{v3.11}{2012/04/17}{new}%^^A +% \changes{v3.11}{2012/04/17}{added} % Macro \cs{@areaset@end} is a hook to make it possible to add some % instructions to the end of the \cs{areaset} command. This will be executed % before the activation of the settings inside a document. @@ -2943,7 +2798,7 @@ %</package&typearea&body> % \end{macrocode} % \end{macro} -% \end{macro} +% \end{command} % % \subsection{Deprecated options} % @@ -2951,81 +2806,62 @@ % deprecated since \KOMAScript{} 3.00. Most of them but not all are pattern % matching options. % -% \begin{option}{DIVcalc} -% \changes{v2.4g}{1996/11/04}{new}%^^A -% \changes{v2.95}{2002/12/04}{implemented using option \Option{DIV}}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{deprecated}%^^A -% \begin{option}{DIVclassic} -% \changes{v2.4n}{1997/05/28}{new}%^^A -% \changes{v2.95}{2002/12/04}{implemented using option \Option{DIV}}%^^A -% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by -% \cs{PackageInfoNoLine}}%^^A -% \changes{v3.01a}{2008/11/21}{deprecated}%^^A -% The former form of \Option{DIV=}\Option{calc} and -% \Option{DIV=}\Option{classic}. +% \begin{option}{DIVcalc,DIVclassic} +% \changes{v2.4g}{1996/11/04}{added} +% \changes{v2.95}{2002/12/04}{implemented using option \opt{DIV}} +% \changes{v2.97d}{2007/10/03}{\cs{PackageInfo} replaced by \cs{PackageInfoNoLine}} +% \changes{v3.01a}{2008/11/21}{deprecated} +% The former form of \opt{DIV=}\opt{calc} and \opt{DIV=}\opt{classic}. % \begin{macrocode} %<*package&typearea&options> \KOMA@DeclareDeprecatedOption[typearea]{DIVcalc}{DIV=calc} \KOMA@DeclareDeprecatedOption[typearea]{DIVclassic}{DIV=classic} %</package&typearea&options> % \end{macrocode} -% \end{option}%^^A DIVclassic -% \end{option}%^^A DIVcalc -% -% \begin{option}{a\meta{integer}paper} -% \begin{option}{b\meta{integer}paper} -% \begin{option}{c\meta{integer}paper} -% \begin{option}{d\meta{integer}paper} -% Formerly \Option{a}\meta{integer}\Option{paper}, -% \Option{b}\meta{integer}\Option{paper}, -% \Option{c}\meta{integer}\Option{paper}, -% \Option{d}\meta{integer}\Option{paper} has been documented. Since +% \end{option}^^A DIVcalc,DIVclassic +% +% \begin{option}{a...paper,b...paper,c...paper,d...paper} +% Formerly \opt{a}\meta{integer}\opt{paper}, +% \opt{b}\meta{integer}\opt{paper}, +% \opt{c}\meta{integer}\opt{paper}, +% \opt{d}\meta{integer}\opt{paper} has been documented. Since % \KOMAScript{} v3.00 most of them are deprecated and has been replaced by -% option \Option{paper}. Nevertheless, for compatibility these options and the +% option \opt{paper}. Nevertheless, for compatibility these options and the % commands needed to recognize and handle them are still implemented. % -% The documentation of the deprecated part of the feature is still in German. -% \selectlanguage{ngerman} % % \begin{macro}{\x@paper} % \begin{macro}{\x@@paper} -% \changes{v2.5}{1997/06/17}{neue Mustererkennung für die -% Papiergröße}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifnumber} umbenannt in \cs{Ifnumber}}%^^A -% Diese Makros werden ebenfalls später benötigt, wenn die Papiergröße -% festgelegt wird. -% \begin{macro}{\isopaper} -% \changes{v2.5}{1997/06/17}{neu}%^^A -% \changes{v2.95}{2002/12/03}{es sind auch Großbuchstaben erlaubt}%^^A -% \changes{v3.23}{2017/02/22}{verwendet \cs{ISO@PaperNameToSize}}%^^A -% Da das Makro \cs{isopaper} zur Berechnung unterschiedlicher -% ISO/DIN-Papierformate in der Mustererkennung für die Papiergröße -% benötigt wird, wurde dieses Makro ebenfalls vorgezogen. +% \changes{v2.5}{1997/06/17}{pattern matching of paper sizes} +% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}} +% \changes{v3.28}{2019/11/18}{\cs{ifnumber} renamed to \cs{Ifnumber}} +% This macros will be needed when the paper size will be generated. +% \begin{command}{\isopaper} +% \changes{v2.5}{1997/06/17}{new} +% \changes{v2.95}{2002/12/03}{upper case letters are also allowed} +% \changes{v3.23}{2017/02/22}{using \cs{ISO@PaperNameToSize}} +% Because \cs{isopaper} is used inside the paper size detection by pattern +% matching to select a specific ISO/DIN paper size, it has to be defined +% before the pattern matching will be done. % \begin{macrocode} %<*package&typearea&options> \newcommand\isopaper[2][a]{% % \end{macrocode} -% Das Makro kennt zwei Parameter, von denen der erste und optionale -% die Grundgröße angibt. Die Angabe erfolgt über einen -% Buchstaben. Möglich sind +% The command has to parameters. The first one is optional and the basic size +% given by one of the letters: % \begin{description} -% \item[a] -- ISO/DIN-A-Format -% \item[b] -- ISO/DIN-B-Format -% \item[c] -- ISO/DIN-C-Format -% \item[d] -- ISO/DIN-D-Format +% \item[a] -- ISO/DIN A sizes +% \item[b] -- ISO/DIN B sizes +% \item[c] -- ISO/DIN C sizes +% \item[d] -- ISO/DIN D sizes % \end{description} -% Der zweite Paremeter gibt dann die Skalierung an. +% The second and mandatory argument is the scale number % \begin{macrocode} \ISO@PaperNameToSize[typearea]#1#2\@nil % \end{macrocode} -% Jetzt noch die gewünschte Ausrichtung beachten. -% \changes{v2.97e}{2007/10/23}{gewünschte Papierausrichtung wird -% beachtet}%^^A -% \changes{v3.22}{2016/07/29}{Papierausrichtung entsprechend dem -% tatsächlichen Format}%^^A +% Select either landscape or portrait: +% \changes{v2.97e}{2007/10/23}{landscape or portrait} +% \changes{v3.22}{2016/07/29}{adapting paper orientation} % \begin{macrocode} \expandafter\ifnum\scr@ta@v@is@ge{3.22}\relax \scr@setpaperorientation @@ -3034,9 +2870,9 @@ \fi } % \end{macrocode} -% \textsf{typearea} verwendet eine eigene Fehlerausgabe. +% \pkg*{typearea} uses its own error message. % \begin{macro}{\scr@UnknownPaperSize@typearea} -% \changes{v3.23}{2017/02/22}{neu (intern)} +% \changes{v3.23}{2017/02/22}{new} % \begin{macrocode} \ProvideUnknownPaperSizeError{typearea}{% \PackageError{typearea}{% @@ -3051,11 +2887,11 @@ \setlength{\paperheight}{1189sp}% } % \end{macrocode} -% \end{macro}%^^A \scr@UnknownPaperSize@typearea -% \end{macro}%^^A \isopaper +% \end{macro}^^A \scr@UnknownPaperSize@typearea +% \end{command}^^A \isopaper % \begin{macro}{\scr@setpaperorientation} -% \changes{v3.22}{2016/07/29}{neu (intern)} -% Stellt die Papierausrichtung entsprechend \cs{if@landscape} ein. +% \changes{v3.22}{2016/07/29}{new} +% Setup the paper orientation depending on \cs{if@landscape}. % \begin{macrocode} \newcommand*\scr@setpaperorientation{% \ifdim\paperheight>\paperwidth @@ -3066,24 +2902,24 @@ } % \end{macrocode} % \begin{macro}{\scr@switchpapersizes} -% \changes{v3.22}{2016/07/29}{neu (intern)} -% Vertauscht zwei Längen. +% \changes{v3.22}{2016/07/29}{new} +% Switches the two lengths \len{paperwidth} and \len{paperheight}. % \begin{macrocode} \newcommand*\scr@switchpapersizes{% \@tempdima\paperwidth\paperwidth\paperheight\paperheight\@tempdima } % \end{macrocode} -% \end{macro}%^^A \scr@switchlength -% \end{macro}%^^A \scr@setpaperorientation +% \end{macro}^^A \scr@switchlength +% \end{macro}^^A \scr@setpaperorientation % \begin{macro}{\iso@paper} -% \changes{v2.95}{2002/12/03}{neu (intern)}%^^A -% Ein ganz ähnlicher interner Befehl erhält den gesamten Namen des -% ISO-Papierformats als einziges Argument. +% \changes{v2.95}{2002/12/03}{new} +% Similar to \cs{isopaper} but with only one argument for the base size and +% the scale number. % \begin{macro}{\iso@@paper} -% \changes{v2.95}{2002/12/03}{neu (intern)}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifnumber} umbenannt in \cs{Ifnumber}}%^^A -% Dieses Argument wird dann über einen weiteren internen Befehl per -% Mustererkennung in den Kennbuchstaben und eine Zahl zerlegt. +% \changes{v2.95}{2002/12/03}{new} +% \changes{v3.28}{2019/11/18}{\cs{ifnumber} renamed to \cs{Ifnumber}} +% The single argument is split into base size letter and scale number by +% pattern matching. % \begin{macrocode} \newcommand*{\iso@paper}[1]{\expandafter\iso@@paper#1\@nil} \newcommand*{\iso@@paper}{} @@ -3104,54 +2940,47 @@ } %</package&typearea&options> % \end{macrocode} -% \end{macro}%^^A \iso@@paper -% \end{macro}%^^A \iso@paper -% \selectlanguage{english} -% -% \begin{option}{DIV\meta{integer}} -% \begin{option}{BCOR\meta{length}} -% Formerly \Option{DIV}\meta{integer}, \Option{BCOR}\meta{length}, -% \Option{headlines}\meta{real} has been documented as options. Since -% \KOMAScript{} 3.00 these have been replaced by \Option{DIV=}\meta{integer}, -% \Option{BCOR=}\meta{length} and -% \Option{headlines=}\meta{real}. Nevertheless, for compatibility the -% deprecated options are still handled by \Macro{DeclareOption*} and so we +% \end{macro}^^A \iso@@paper +% \end{macro}^^A \iso@paper +% +% \begin{option}{DIV...} +% \begin{option}{BCOR...} +% Formerly \opt{DIV}\meta{integer}, \opt{BCOR}\meta{length}, +% \opt{headlines}\meta{real} has been documented as options. Since +% \KOMAScript{} 3.00 these have been replaced by \opt{DIV=}\meta{integer}, +% \opt{BCOR=}\meta{length} and +% \opt{headlines=}\meta{real}. Nevertheless, for compatibility the +% deprecated options are still handled by \cs{DeclareOption*} and so we % need several helper macros to recognize them. % -% The documentation of the deprecated part of the feature is still in German. -% \selectlanguage{ngerman} % % \begin{macro}{\@BCOR} % \begin{macro}{\@@BCOR} -% \changes{v2.5}{1997/06/17}{Einzelzeichenscanner durch -% Mustererkennung ersetzt}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifstr} umbenannt in \cs{Ifstr}}%^^A -% Das Makro \cs{@BCOR} wird später benötigt, um die Option -% \texttt{BCOR\emph{BCOR}} zu erkennen. Die Option wird über ihr -% Muster erkannt. +% \changes{v2.5}{1997/06/17}{Single letter scanner replaced by pattern matching} +% \changes{v3.28}{2019/11/18}{\cs{ifstr} renamed to \cs{Ifstr}} +% Macro \cs{@BCOR} it needed to handle option \opt{BCOR\emph{BCOR}}. The +% option is recognized by pattern matching. % \begin{macrocode} %<*(class|(package&typearea))&options> \newcommand*{\@BCOR}{\expandafter\@@BCOR\CurrentOption BCORBCOR\@@BCOR} \newcommand*{\@@BCOR}{} \def\@@BCOR #1BCOR#2BCOR#3\@@BCOR{% % \end{macrocode} -% Handelt es sich um die Option \texttt{BCOR}, so ist der erste -% Parameter leer. +% If it is option \opt{BCOR} the first argument is empty. % \begin{macrocode} \Ifstr{#1}{}{% % \end{macrocode} -% Außerdem ist der dritte Parameter dann \texttt{BCOR}. +% Additionally the third argument is |BCOR|. % \begin{macrocode} \Ifstr{#3}{BCOR}{% % \end{macrocode} -% Der zweite Parameter sollte dann die Größe enthalten. Ist dies -% nicht der Fall, wird ein Fehler gemeldet (Fehlerzeile ist dann -% \cs{ProcessOptions}). -% \changes{v3.22}{2016/07/29}{missing deprecated option warning added}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifdimen} renamed to \cs{Ifdimen}}%^^A -% \changes{v3.30}{2020/03/24}{avoid error message for unknown \texttt{BCOR} -% value to \cs{documentclass}}%^^A -% \changes{v3.31}{2020/04/27}{improved valid value recognization}%^^A +% Now, the second argument should be the size. If this is not the case, an +% error has to be reported. +% \changes{v3.22}{2016/07/29}{missing deprecated option warning added} +% \changes{v3.28}{2019/11/18}{\cs{ifdimen} renamed to \cs{Ifdimen}} +% \changes{v3.30}{2020/03/24}{avoid error message for unknown \opt{BCOR} +% value to \cs{documentclass}} +% \changes{v3.31}{2020/04/27}{improved valid value recognization} % \begin{macrocode} %<*class> \Ifstrstart{#2}{=}{% @@ -3168,9 +2997,8 @@ }{\scr@pti@nerr@r}% %</package> % \end{macrocode} -% In allen anderen Fällen ist es nicht diese Option, dann wird ein -% Fehler ausgegeben. Stattdessen könnte hier auch auf weitere Optionen -% getestet werden. +% In all other cases it is not this option. So we report an error. Instead of +% the error another option could be tested. % \begin{macrocode} }{\scr@pti@nerr@r}% }{\scr@pti@nerr@r}% @@ -3181,15 +3009,13 @@ % % \begin{macro}{\@DIV} % \begin{macro}{\@@DIV} -% \changes{v2.5}{1997/06/17}{Einzelzeichenscanner durch -% Mustererkennung ersetzt}%^^A -% \changes{v3.22}{2016/07/29}{missing deprecated option warning added}%^^A -% \changes{v3.28}{2019/11/18}{\cs{ifnumber} umbenannt in \cs{Ifnumber}}%^^A -% \changes{v3.30}{2020/03/24}{avoid error message for unknown \texttt{DIV} -% value to \cs{documentclass}}%^^A -% \changes{v3.31}{2020/04/27}{improved valid value recognization}%^^A -% Die grundsätzliche Funktion ist die gleiche wie bei \cs{@BCOR}, -% \cs{@@BCOR}. +% \changes{v2.5}{1997/06/17}{Single letter scanner replaced by pattern matching} +% \changes{v3.22}{2016/07/29}{missing deprecated option warning added} +% \changes{v3.28}{2019/11/18}{\cs{ifnumber} renamed to \cs{Ifnumber}} +% \changes{v3.30}{2020/03/24}{avoid error message for unknown \opt{DIV} +% value to \cs{documentclass}} +% \changes{v3.31}{2020/04/27}{improved valid value recognization} +% Here we use more or less the same functionality as with \cs{@BCOR} and \cs{@@BCOR}. % \begin{macrocode} \newcommand*{\@DIV}{\expandafter\@@DIV\CurrentOption DIVDIV\@@DIV} \newcommand*{\@@DIV}{} @@ -3212,23 +3038,21 @@ %</package> \else\scr@pti@nerr@r\fi % \end{macrocode} -% Der Unterschied liegt darin, dass bei einem Fehlschlag der -% Mustererkennung kein Fehler vorliegt, sondern u.\,U. noch auf -% \texttt{BCOR} getestet werden muss. +% The only difference is, that we do not report an error but also test for +% \opt{BCOR}. % \begin{macrocode} \else\@BCOR\fi } % \end{macrocode} -% \end{macro}%^^A \@@DIV -% \end{macro}%^^A \@DIV +% \end{macro}^^A \@@DIV +% \end{macro}^^A \@DIV % -% \begin{option}{headlines\meta{integer}} +% \begin{option}{headlines...} % \begin{macro}{\@headlines} % \begin{macro}{\@@headlines} -% \changes{v2.7g}{2001/04/17}{neue Mustererkennung für die Anzahl -% der Kopfzeilen}%^^A -% Das Macro \cs{@headlines} wird benötigt, um die Option -% \texttt{headlines} zu erkennen. +% \changes{v2.7g}{2001/04/17}{neW pattern matching for the number of headlines} +% The macros are needed to recognize the deprecated option +% \opt{headlines\meta{integer}}. % \begin{macrocode} \newcommand{\@headlines}{% \expandafter\@@headlines\CurrentOption headlines\@@headlines% @@ -3243,21 +3067,16 @@ } %</(class|(package&typearea))&options> % \end{macrocode} -% \end{macro}%^^A \@headlines -% \end{macro}%^^A \@@headlines +% \end{macro}^^A \@headlines +% \end{macro}^^A \@@headlines % -% \selectlanguage{english} % Starting point for all the deprecated pattern matching options is -% \Macro{DeclareOption*} for command \Macro{x@paper} that uses pattern -% matching with \Macro{x@@paper} to recognize the deprecated options. These -% are needed not only for package \Package{typearea} but also for the classes. +% \cs{DeclareOption*} for command \cs{x@paper} that uses pattern +% matching with \cs{x@@paper} to recognize the deprecated options. These +% are needed not only for package \pkg*{typearea} but also for the classes. % -% The documentation of the deprecated part of the feature is still in German. -% \selectlanguage{ngerman} -% Zurück zur Mustererkennung. Diese ist tatsächlich etwas einfacher -% als die in den beiden Fällen zuvor. -% \changes{v2.97e}{2007/10/23}{Optionen werden nach der neuen Syntax an -% typearea weitergeleitet}%^^A +% Back to the pattern matching. This one is the most simple of all. +% \changes{v2.97e}{2007/10/23}{passing options \pkg*{typearea} using the new syntax} % \begin{macrocode} %<*(class|(package&typearea))&options> \newcommand*{\x@paper}{% @@ -3295,11 +3114,9 @@ % \end{macrocode} % % \begin{macro}{\scr@pti@nerr@r} -% \changes{v2.95}{2002/06/20}{\cs{OptionNotUsed} statt -% \cs{PackageError}} -% Falls die zuätzliche Option nicht \texttt{BCOR}, \texttt{DIV}, -% \texttt{headlines} oder eine bekannte Papiergröße ist, ist die -% Option nicht verwendet. +% \changes{v2.95}{2002/06/20}{\cs{OptionNotUsed} instead of \cs{PackageError}} +% If the addition option is neither \opt{BCOR\dots} nor \opt{DIV\dots} nor +% \opt{headlines} nor a known paper size, it is still unused. % \begin{macrocode} \newcommand*{\scr@pti@nerr@r}{ %<class> \OptionNotUsed @@ -3308,36 +3125,32 @@ % \end{macrocode} % \end{macro} % -% \changes{v2.97c}{2007/09/12}{\cs{lco@test} bei den geparsten Optionen -% eingefügt} +% \changes{v2.97c}{2007/09/12}{\cs{lco@test} added to before pattern matching +% of options} % \begin{macrocode} \DeclareOption*{% %<letter> \lco@test \x@paper} %</(class|(package&typearea))&options> % \end{macrocode} -% \end{option}%^^A headline... -% \end{option}%^^A DIV... -% \end{option}%^^A BCOR... -% \end{macro}%^^A \x@paper -% \end{macro}%^^A \x@@paper -% \end{option}%^^A d...paper -% \end{option}%^^A c...paper -% \end{option}%^^A b...paper -% \end{option}%^^A a...paper +% \end{option}^^A headline... +% \end{option}^^A DIV... +% \end{option}^^A BCOR... +% \end{macro}^^A \x@paper +% \end{macro}^^A \x@@paper +% \end{option}^^A a...paper … d...paper % -% \selectlanguage{english} % % ^^A This part should stay at the end of the source file! % \subsection{Configuration file} % % At the very ending of the option section just before executing and % processing the options you can add additional options the -% \Package{typearea}. This is a very seldom used feature and I recommend to +% \pkg*{typearea}. This is a very seldom used feature and I recommend to % not use it any longer. If you need additional options use % |\BeforeFamilyProcessOptions[.typearea.sty]{KOMA}{...}|. % -% \changes{v2.0e}{1994/10/28}{configuration file \File{typearea.cfg}}%^^A +% \changes{v2.0e}{1994/10/28}{configuration file \file{typearea.cfg}} % \begin{macrocode} %<*package&typearea&options> \InputIfFileExists{typearea.cfg}{% @@ -3353,29 +3166,29 @@ % \subsection{Option execution} % % The paper size and telling the back-end driver information about the paper -% size are default. The default for the default paper size will be \Option{A4} -% if nothing else was defined by a class. Execution of option \Option{twoside} +% size are default. The default for the default paper size will be \opt{A4} +% if nothing else was defined by a class. Execution of option \opt{twoside} % depends already on the setting of \cs{if@twoside} and % \cs{if@semitwoside}. This may be surprising but nevertheless is correct. -% \changes{v2.3h}{1995/01/19}{\cs{relax} after \cs{ProcessOptions} added}%^^A +% \changes{v2.3h}{1995/01/19}{\cs{relax} after \cs{ProcessOptions} added} % \changes{v2.96}{2006/08/18}{processing options in order of usage instead of -% order of declaration}%^^A +% order of declaration} % \changes{v2.97c}{2007/04/19}{Usage of \cs{KOMAExecuteOptions} instead of -% \cs{KOMAoptions}}%^^A +% \cs{KOMAoptions}} % \changes{v2.97c}{2007/04/19}{Usage of \cs{KOMAProcessOptions} instead of -% \cs{ProcessOptions}}%^^A +% \cs{ProcessOptions}} % \changes{v2.97c}{2007/04/19}{set only options that are not an implicit -% default}%^^A +% default} % \changes{v2.97c}{2007/07/18}{explicit setting of a valid value to -% \texttt{twoside}}%^^A +% \opt{twoside}} % \changes{v3.12}{2013/11/11}{the default paper size is given by -% \cs{defaultpagesize}}%^^A -% \changes{v3.17}{2015/03/02}{\Option{pagesize} is default}%^^A +% \cs{defaultpagesize}} +% \changes{v3.17}{2015/03/02}{\opt{pagesize} is default} % \begin{macro}{\defaultpapersize} -% \changes{v3.12}{2013/11/11}{new}%^^A +% \changes{v3.12}{2013/11/11}{added} % The default paper size. Defined using \cs{providecommand} so it can be -% changed by a class or wrapper package or \File{typearea.cfg} or somewhere -% else before loading \Package{typearea}. +% changed by a class or wrapper package or \file{typearea.cfg} or somewhere +% else before loading \pkg*{typearea}. % \begin{macrocode} %<*package&typearea&options> \providecommand*{\defaultpapersize}{A4} @@ -3399,11 +3212,14 @@ % \end{macrocode} % % \Finale -% +% \PrintChanges +% \endinput -% -% end of file `scrkernel-typearea.dtx' -%%% Local Variables: -%%% mode: doctex -%%% 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: |