summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex2126
1 files changed, 1008 insertions, 1118 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
index 3ba49ba03e6..29897377100 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrbookreportarticle.tex
-% Copyright (c) Markus Kohm, 2001-2016
+% Copyright (c) Markus Kohm, 2001-2017
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrbookreportarticle.tex
-% Copyright (c) Markus Kohm, 2001-2016
+% Copyright (c) Markus Kohm, 2001-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,17 +46,18 @@
% ============================================================================
\KOMAProvidesFile{scrbookreportarticle.tex}
- [$Date: 2016-04-07 10:29:28 +0200 (Thu, 07 Apr 2016) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm\and
Krickette Murabayashi\and Jana Schubert\and Jens H\"uhne}
-% Date of translated german file: 2016-04-07
+% Date of the translated German file: 2017-01-02
\chapter{The Main Classes: \Class{scrbook}, \Class{scrreprt}, and
\Class{scrartcl}}
\labelbase{maincls}
+\BeginIndexGroup
\BeginIndex{Class}{scrbook}%
\BeginIndex{Class}{scrreprt}%
\BeginIndex{Class}{scrartcl}%
@@ -79,13 +80,13 @@ different from the three main classes (see \autoref{cha:scrlttr2}).
``\texttt{scr}'' and the abbreviated name of the corresponding standard
class. In order to restrict the length of the names to eight letters, the
vowels, starting with the last one, are left off as necessary. The
- \autoref{tab:maincls.overview} shows an overview of the correspondence
+ \autoref{tab:\LabelBase.overview} shows an overview of the correspondence
between the standard classes and the {\KOMAScript} classes.
\fi
The simplest way to use a {\KOMAScript} class instead of a standard one is to
substitute the class name in the \verb|\documentclass| command according to
-\autoref{tab:maincls.overview}. For example, you may replace
+\autoref{tab:\LabelBase.overview}. For example, you may replace
\Macro{documentclass}\PParameter{book} by
\Macro{documentclass}\PParameter{scrbook}. Normally, the document should be
processed without errors by {\LaTeX}, just like before the substitution. The
@@ -99,7 +100,7 @@ sections.
\setcapindent{0pt}
% \caption
\begin{captionbeside}
- [Class correspondence]{\label{tab:maincls.overview}Correspondence between
+ [Class correspondence]{\label{tab:\LabelBase.overview}Correspondence between
standard classes and {\KOMAScript} classes}% and \Script{} styles.}
[l]
\begin{tabular}[t]{ll}
@@ -128,20 +129,18 @@ on this work. When that is done, you can concentrate on the fine points of
presentation. Besides the choice of options, this means correcting
hyphenation, optimizing page breaks, and the placement of tables and figures.
-\LoadCommon{0}% \section{Early or Late Selection of Options}
+\LoadCommonFile{options}% \section{Early or Late Selection of Options}
-\LoadCommon{1}% \section{Compatibility with Earlier Versions of KOMA-Script}
+\LoadCommonFile{compatibility}% \section{Compatibility with Earlier Versions of KOMA-Script}
-\LoadCommon{2}% \section{Draft Mode}
+\LoadCommonFile{draftmode}% \section{Draft Mode}
-\LoadCommon{3}% \section{Page Layout}
+\LoadCommonFile{typearea}% \section{Page Layout}
\begin{Declaration}
- \Macro{flushbottom}\\
+ \Macro{flushbottom}%
\Macro{raggedbottom}
\end{Declaration}
-\BeginIndex{Cmd}{raggedbottom}%
-\BeginIndex{Cmd}{flushbottom}%
\begin{Explain}
In double-sided documents, it's preferred to have the same visual baseline
in not only the first lines of the text areas in a double-side spread, but
@@ -157,16 +156,16 @@ hyphenation, optimizing page breaks, and the placement of tables and figures.
Using double-sided typesetting with option
\Option{twoside}\IndexOption{twoside}\important{\Option{twoside}} (see
-\autoref{sec:typearea.options}, \autopageref{desc:typearea.option.twoside}) or
+\autoref{sec:typearea.options}, \DescPageRef{typearea.option.twoside}) or
two-column typesetting with option
\Option{twocolumn}\IndexOption{twocolumn}\important{\Option{twocolumn}} (see
-\autopageref{desc:typearea.option.twocolumn}) switches on vertical adjustment
+\DescPageRef{typearea.option.twocolumn}) switches on vertical adjustment
also. But\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} with compatibility selection to a \KOMAScript{} version
-prior to 3.17 (see \autoref{sec:maincls.compatibilityOptions},
-\autopageref{desc:maincls.option.version}, option
-\Option{version}\IndexOption{version}\important{\OptionValue{version}{3.17}})
-this is not the case, if you use \Macro{KOMAoption} or \Macro{KOMAoptions} to
+prior to 3.17 (see \autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}, option
+\DescRef{\LabelBase.option.version}\IndexOption{version}\important{\OptionValueRef{\LabelBase}{version}{3.17}})
+this is not the case, if you use \DescRef{\LabelBase.cmd.KOMAoption} or \DescRef{\LabelBase.cmd.KOMAoptions} to
change the setting of these options.
Alternatively, vertical adjustment may be switched on
@@ -180,32 +179,23 @@ vertical adjustment. This has been done to move footnotes to the bottom of the
text area instead of having them close to the last used text line.\iffree{}{
More information about this may be found at
\autoref{sec:maincls-experts.addInfos},
- \autopageref{desc:maincls-experts.cmd.footnoterule}.}%
+ \DescPageRef{maincls-experts.cmd.footnoterule}.}%
%
-\EndIndex{Cmd}{flushbottom}%
-\EndIndex{Cmd}{raggedbottom}%
+\EndIndexGroup
%
-\EndIndex{}{page>layout}
+\EndIndexGroup
-\section{Selection of the Document Font Size}
-\LoadCommon{4}
-The default at \Class{scrbook}, \Class{scrreprt}, and \Class{scrartcl} is
-\OptionValue{fontsize}{11pt}.\textnote{\KOMAScript{} vs. standard classes} In
-contrast, the default of the standard classes would be \Option{10pt}. You
-may attend to this if you switch from a standard class to a \KOMAScript{}
-class.%
-%
-\EndIndex{Option}{fontsize~=\PName{size}}%
-%
-\EndIndex{}{font>size}
+\LoadCommonFile{fontsize}
+
-\LoadCommon{5}% \section{Text Markup}
+\LoadCommonFile{textmarkup}% \section{Text Markup}
-\LoadCommon{14} %\section{Document Titles}
+\LoadCommonFile{titles}% \section{Document Titles}
\section{Abstract}
\seclabel{abstract}
+\BeginIndexGroup
\BeginIndex{}{summary}%
\BeginIndex{}{abstract}%
@@ -216,12 +206,11 @@ title, this summary is normally a kind of left- and right-indented block. In
contrast to this, a kind of chapter or section is printed using title pages.
\begin{Declaration}
- \KOption{abstract}\PName{simple switch}
+ \OptionVName{abstract}{simple switch}
\end{Declaration}%
-\BeginIndex{Option}{abstract~=\PName{simple switch}}%
-\ChangedAt{v3.00}{\Class{scrreprt}\and \Class{scrartcl}}%
-In\OnlyAt{\Class{scrreprt}\and\Class{scrartcl}} the standard classes the
-\Environment{abstract} environment sets the text ``\abstractname'' centered
+In\ChangedAt{v3.00}{\Class{scrreprt}\and \Class{scrartcl}}%
+\OnlyAt{\Class{scrreprt}\and\Class{scrartcl}} the standard classes the
+\DescRef{\LabelBase.env.abstract} environment sets the text ``\abstractname'' centered
before the summary text\Index[indexmain]{summary}. This was normal practice in
the past. In the meantime, newspaper reading has trained readers to recognize
a displayed text at the beginning of an article or report as the
@@ -235,69 +224,66 @@ abstract's title with the options \Option{abstract}. For \PName{simple
Books typically use another type of summary. In that case there is usually a
dedicated summary chapter at the beginning or end of the book. This chapter is
often combined with the introduction or a description of wider
-prospects. Therefore, the class \Class{scrbook} has no \Environment{abstract}
+prospects. Therefore, the class \Class{scrbook} has no \DescRef{\LabelBase.env.abstract}
environment. A\textnote{Hint!} summary chapter is also recommended for reports in a wider
sense, like a Master's or Ph.D. thesis.%
%
-\EndIndex{Option}{abstract~=\PName{simple switch}}%
+\EndIndexGroup
\begin{Declaration}
- \XMacro{begin}\PParameter{\Environment{abstract}}\\
- \quad\dots\\
- \XMacro{end}\PParameter{abstract}
+ \begin{Environment}{abstract}\end{Environment}
\end{Declaration}%
-\BeginIndex{Env}{abstract}%
\OnlyAt{\Class{scrartcl}\and \Class{scrreprt}}%
Some {\LaTeX} classes offer a special environment for this summary, the
\Environment{abstract} environment. This is output directly, as it is not a
-component of the titles set by \Macro{maketitle}. Please\textnote{Attention!}
-note that \Environment{abstract} is an environment, not a command. Whether the
-summary has a heading or not is determined by the option \Option{abstract}
-(see above).
+component of the titles set by \DescRef{\LabelBase.cmd.maketitle}.
+Please\textnote{Attention!} note that \Environment{abstract} is an
+environment, not a command. Whether the summary has a heading or not is
+determined by the option \DescRef{\LabelBase.option.abstract} (see above).
With books (\Class{scrbook}) the summary is frequently a component of the
introduction or a separate chapter at the end of the document. Therefore no
\Environment{abstract} environment is provided. When using the class
\Class{scrreprt} it is surely worth considering whether one should not proceed
-likewise. See commands \Macro{chapter*}\IndexCmd{chapter*} and
-\Macro{addchap}\IndexCmd{addchap} or \Macro{addchap*} at
-\autoref{sec:maincls.structure} from \autopageref{desc:maincls.cmd.chapter*}
+likewise. See commands \DescRef{\LabelBase.cmd.chapter*}\IndexCmd{chapter*} and
+\DescRef{\LabelBase.cmd.addchap}\IndexCmd{addchap} or \DescRef{\LabelBase.cmd.addchap*} at
+\autoref{sec:\LabelBase.structure} from \DescPageRef{\LabelBase.cmd.chapter*}
onwards.
-When using an in-page title\Index{title>in-page} (see option \Option{titlepage},
-\autoref{sec:maincls.titlepage}, \autopageref{desc:maincls.option.titlepage}),
-the abstract is set using the environment
-\Environment{quotation}\IndexEnv{quotation} (see \autoref{sec:maincls.lists},
-\autopageref{desc:maincls.env.quotation}) internally. Thereby paragraphs will
-be set with indentation of the first line. If that first paragraph of the
-abstract should not be indented, this indent may be disabled using
+When using an in-page title\Index{title>in-page} (see option
+\DescRef{\LabelBase.option.titlepage}, \autoref{sec:\LabelBase.titlepage},
+\DescPageRef{\LabelBase.option.titlepage}), the abstract is set using the
+environment \Environment{quotation}\IndexEnv{quotation} (see
+\autoref{sec:\LabelBase.lists}, \DescPageRef{\LabelBase.env.quotation})
+internally. Thereby paragraphs will be set with indentation of the first
+line. If that first paragraph of the abstract should not be indented, this
+indent may be disabled using
\Macro{noindent}\IndexCmd{noindent}\important{\Macro{noindent}} \iffree{just
after \Macro{begin}\PParameter{abstract}}{at the begin of the environment}.%
%
-\EndIndex{Env}{abstract}%
+\EndIndexGroup
%
-\EndIndex{}{summary}%
-\EndIndex{}{abstract}
+\EndIndexGroup
\section{Table of Contents}
\seclabel{toc}
+\BeginIndexGroup
\BeginIndex{}{table of contents}
The table of contents is normally set after the document title and an
optional existing abstract. Often one may find additional lists of
floating environments, e.\,g., the list of tables and the list of
figures, after the table of contents (see
-\autoref{sec:maincls.floats}).
+\autoref{sec:\LabelBase.floats}).
\begin{Declaration}
- \KOption{toc}\PName{selection}
+ \OptionVName{toc}{selection}
\end{Declaration}
-\BeginIndex{Option}{toc~=\PName{selection}}%
-\label{desc:maincls.option.toc.listof}%
-\label{desc:maincls.option.toc.nolistof}%
-\label{desc:maincls.option.toc.listofnumbered}\nobreak
+\label{desc:\LabelBase.option.toc.listof}%
+\label{desc:\LabelBase.option.toc.nolistof}%
+\label{desc:\LabelBase.option.toc.listofnumbered}\nobreak
It is becoming increasingly common to find entries in the table of contents
for the lists of tables and figures, for the bibliography, and, sometimes,
even for the index. This is surely also related to the recent trend of putting
@@ -319,7 +305,7 @@ one wants to ignore this general agreement, one may use \PName{selection}
\IndexOption{toc~=\PValue{listofnumbered}}.
\leavevmode\phantomsection\nobreak
-\label{desc:maincls.option.toc.index}\nobreak
+\label{desc:\LabelBase.option.toc.index}\nobreak
The\important{\OptionValue{toc}{index}} option \OptionValue{index}{totoc}
causes an entry for the index to be included in the table of contents. The
index is unnumbered since it too only includes references to the contents of
@@ -327,10 +313,10 @@ the other sectional units. Despite\ChangedAt{v3.18}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}
\important{\OptionValue{toc}{indexnumbered}}objection of the author,
\KOMAScript{} does also support to ignore this general agreement using
-\OptionValue{toc}{indexnumbered}.
+\OptionValue{toc}{indexnumbered}\IndexOption{toc~=\PValue{indexnumbered}}.
\leavevmode\phantomsection\nobreak
-\label{desc:maincls.option.toc.bibliography}\nobreak
+\label{desc:\LabelBase.option.toc.bibliography}\nobreak
The bibliography is a different kind of listing. It does not list the contents
of the present document but refers instead to external
documents. For\important{\begin{tabular}{@{}r@{}}
@@ -349,7 +335,7 @@ an unnumbered entry in the table of contents, and that can be achieved with
\OptionValue{toc}{bibliography}\IndexOption{toc~=\PValue{bibliography}}.
\leavevmode\phantomsection\nobreak
-\label{desc:maincls.option.toc.graduated}\nobreak
+\label{desc:\LabelBase.option.toc.graduated}\nobreak
The table of contents is normally\ChangedAt{v2.8q}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
\important{\OptionValue{toc}{graduated}} set up so that different sectional
@@ -359,7 +345,7 @@ a fixed-width field. This default setup is selected with the option
\OptionValue{toc}{graduated}\IndexOption{toc~=\PValue{graduated}}.
\leavevmode\phantomsection\nobreak
-\label{desc:maincls.option.toc.flat}\nobreak
+\label{desc:\LabelBase.option.toc.flat}\nobreak
When there are many sections, the corresponding numbering tends to become very
wide, so that the reserved field overflows. The German FAQ \cite{DANTE:FAQ}
suggests that the table of contents should be redefined in such a
@@ -371,13 +357,13 @@ used, where all unit numbers and titles, respectively, are set in a
left-justified column. The space necessary for the unit numbers is thus
determined automatically.%
-The \autoref{tab:maincls.toc} shows an overview of possible values for
+The \autoref{tab:\LabelBase.toc} shows an overview of possible values for
\PName{selection} of \Option{toc}.
\begin{desclist}
\desccaption[{Possible values of option \Option{toc}}]{%
Possible values of option \Option{toc} to set form and contents of the
- table of contents\label{tab:maincls.toc}%
+ table of contents\label{tab:\LabelBase.toc}%
}{%
Possible values of option \Option{toc} (\emph{continuation})%
}%
@@ -456,15 +442,13 @@ The \autoref{tab:maincls.toc} shows an overview of possible values for
\IndexOption{toc~=\PValue{sectionentrywithoutdots}}}%
\end{desclist}
%
-\EndIndex{Option}{toc~=\PName{selection}}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{chapterentrydots}\PName{simple switch}\\
- \KOption{sectionentrydots}\PName{simple switch}
+ \OptionVName{chapterentrydots}{simple switch}%
+ \OptionVName{sectionentrydots}{simple switch}
\end{Declaration}
-\BeginIndex{Option}{chapterentrydots~=\PName{simple switch}}%
-\BeginIndex{Option}{sectionentrydots~=\PName{simple switch}}%
These\ChangedAt[2014/12]{v3.15}{\Class{scrbook}\and \Class{scrreprt}} options
configure a dotted separation line between the text and the page number of the
chapter entries of classes \Class{scrbook} and
@@ -475,72 +459,78 @@ table of contents. For \PName{simple switch}, any value from
used. The default is \PValue{false}. It selects an empty gap instead of
dots.
+\BeginIndex{FontElement}{chapterentrydots}\LabelFontElement{chapterentrydots}%
+\BeginIndex{FontElement}{sectionentrydots}\LabelFontElement{sectionentrydots}%
If a dotted line is selected, you can change their font using element
-\FontElement{chapterentrydots}\IndexFontElement{chapterentrydots}%
+\FontElement{chapterentrydots}%
\important[i]{\FontElement{chapterentrydots}\\
- \FontElement{sectionentrydots}} or
-\FontElement{sectionentrydots}\IndexFontElement{sectionentrydots}. The font
+ \FontElement{sectionentrydots}} or \FontElement{sectionentrydots}. The font
also depends on the element of the page number of the entry (see also
-\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}
-and \autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). The defaults of the elements
-are shown in \autoref{tab:maincls.tocelements}. Please
-note\textnote{Attention!} that the dots of all entries are equally aligned
-only if all dots use the same font.%
-\EndIndex{Option}{sectionentrydots~=\PName{simple switch}}%
-\EndIndex{Option}{chapterentrydots~=\PName{simple switch}}%
+\autoref{sec:\LabelBase.textmarkup}, \DescPageRef{\LabelBase.cmd.setkomafont}
+and \autoref{tab:\LabelBase.fontelements},
+\autopageref{tab:\LabelBase.fontelements}). The defaults of the elements are
+shown in \autoref{tab:\LabelBase.tocelements}. Please note\textnote{Attention!}
+that the dots of all entries are equally aligned only if all dots use the same
+font.%
+\EndIndexGroup
\begin{Declaration}
\Macro{tableofcontents}
\end{Declaration}%
-\BeginIndex{Cmd}{tableofcontents}%
The production of the table of contents is done by the \Macro{tableofcontents}
command. To get a correct table of contents, at least two {\LaTeX} runs are
necessary after every change. The contents and the form of the table of
-contents may be influenced with the above described option \Option{toc}. After
+contents may be influenced with the above described option \DescRef{\LabelBase.option.toc}. After
changing the settings of this option, at least two \LaTeX{} runs are needed
again.
-The entry for the highest sectional unit below \Macro{part}, i.\,e.,
-\Macro{chapter} with \Class{scrbook}\IndexClass{scrbook} and
-\Class{scrreprt}\IndexClass{scrreprt} or \Macro{section} with
-\Class{scrartcl}\IndexClass {scrartcl} is not indented. There are no dots
-between the text of the sectional unit heading and the page number. The
-typographic reasons for this are that the font is usually different, and the
-desire for appropriate emphasis. The table of contents of this manual is a
-good example of these considerations. The font
-style\ChangedAt{v2.97c}{\Class{scrbook}\and \Class{scrreprt}\and
+The entry for the highest sectional unit below \DescRef{\LabelBase.cmd.part},
+i.\,e., \DescRef{\LabelBase.cmd.chapter} with
+\Class{scrbook}\IndexClass{scrbook} and \Class{scrreprt}\IndexClass{scrreprt}
+or \DescRef{\LabelBase.cmd.section} with \Class{scrartcl}\IndexClass
+{scrartcl} is not indented. There are no dots between the text of the
+sectional unit heading and the page number. The typographic reasons for this
+are that the font is usually different, and the desire for appropriate
+emphasis. The table of contents of this manual is a good example of these
+considerations.
+\BeginIndex{FontElement}{partentry}\LabelFontElement{partentry}%
+\BeginIndex{FontElement}{chapterentry}\LabelFontElement{chapterentry}%
+\BeginIndex{FontElement}{sectionentry}\LabelFontElement{sectionentry}%
+The font style\ChangedAt{v2.97c}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}}\important[i]{\FontElement{partentry}\\
\FontElement{chapterentry}\\
\FontElement{sectionentry}} is, however, affected by the settings of the
-element \FontElement{partentry}\IndexFontElement{partentry}, and for classes
-\Class{scrbook} and \Class{scrreprt} by
-\FontElement{chapterentry}\IndexFontElement{chapterentry}, and for class
-\Class{scrartcl} by
-\FontElement{sectionentry}\IndexFontElement{sectionentry}. The font style of
-the page numbers may be set dissenting from these elements using
-\FontElement{partentrypagenumber}\IndexFontElement{partentrypagenumber} and
-\FontElement{chapterentrypagenumber}\IndexFontElement{chapterentrypagenumber}
-respectively
-\FontElement{sectionentrypagenumber}\IndexFontElement{sectionentrypagenumber}
-(see \autoref{sec:maincls.textmarkup},
-\autopageref{desc:maincls.cmd.setkomafont}, and
-\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). If the optional dots of the
-entries of \Macro{chapter} or \Macro{section} are used, you can change their
-font using element
-\FontElement{chapterentrydots}\IndexFontElement{chapterentrydots}%
+element \FontElement{partentry}, and for classes \Class{scrbook} and
+\Class{scrreprt} by \FontElement{chapterentry}, and for class \Class{scrartcl}
+by \FontElement{sectionentry}. %
+\BeginIndex{FontElement}{partentrypagenumber}%
+\LabelFontElement{partentrypagenumber}%
+\BeginIndex{FontElement}{chapterentrypagenumber}%
+\LabelFontElement{chapterentrypagenumber}%
+\BeginIndex{FontElement}{sectionentrypagenumber}%
+\LabelFontElement{sectionentrypagenumber}%
+The font style of the page numbers may be set dissenting from these elements
+using \FontElement{partentrypagenumber} and
+\FontElement{chapterentrypagenumber} respectively
+\FontElement{sectionentrypagenumber} (see \autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}, and
+\autoref{tab:\LabelBase.fontelements},
+\autopageref{tab:\LabelBase.fontelements}). %
+\BeginIndex{FontElement}{chapterentrydots}%
+\BeginIndex{FontElement}{sectionentrydots}%
+If the optional dots of the entries of \DescRef{\LabelBase.cmd.chapter} or
+\DescRef{\LabelBase.cmd.section} are used, you can change their font using
+element \FontElement{chapterentrydots}%
\important[i]{\FontElement{chapterentrydots}\\
- \FontElement{sectionentrydots}} or
-\FontElement{sectionentrydots}\IndexFontElement{sectionentrydots}. The font
+ \FontElement{sectionentrydots}} or \FontElement{sectionentrydots}. The font
also depends on the element of the page number of the entry (see also
-\autoref{sec:maincls.textmarkup}, \autopageref{desc:maincls.cmd.setkomafont}
-and \autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). The defaults of the elements
-are shown in \autoref{tab:maincls.tocelements}. Please
-note\textnote{Attention!} that the dots of all entries are aligned same only
-if all dots use the same font.%
+\autoref{sec:\LabelBase.textmarkup}, \DescPageRef{\LabelBase.cmd.setkomafont}
+and \autoref{tab:\LabelBase.fontelements},
+\autopageref{tab:\LabelBase.fontelements}). The defaults of the elements are
+shown in \autoref{tab:\LabelBase.tocelements}. Please note\textnote{Attention!}
+that the dots of all entries are aligned same only if all dots use the same
+font.%
\begin{table}
% \centering
% \caption
@@ -548,7 +538,7 @@ if all dots use the same font.%
\setcapindent{0pt}%
\begin{captionbeside}
[Font style defaults of the elements of the table of contents]
- {\label{tab:maincls.tocelements}%
+ {\label{tab:\LabelBase.tocelements}%
Font style defaults of the elements of the table of contents}%
[l]
\setlength{\tabcolsep}{.9\tabcolsep}% Umbruchoptimierung!
@@ -556,46 +546,47 @@ if all dots use the same font.%
\toprule
Element & Default font style \\
\midrule
- \FontElement{partentry} &
- \Macro{usekomafont}\PParameter{disposition}\Macro{large} \\
- \FontElement{partentrypagenumber} & \\
- \FontElement{chapterentry} & \Macro{usekomafont}\PParameter{disposition}\\
- \FontElement{chapterentrydots} & \Macro{normalfont} \\
- \FontElement{chapterentrypagenumber} & \\
- \FontElement{sectionentry} & \Macro{usekomafont}\PParameter{disposition}\\
- \FontElement{sectionentrydots} & \Macro{normalfont} \\
- \FontElement{sectionentrypagenumber} & \\
+ \DescRef{\LabelBase.fontelement.partentry} &
+ \DescRef{\LabelBase.cmd.usekomafont}\PParameter{disposition}\Macro{large} \\
+ \DescRef{\LabelBase.fontelement.partentrypagenumber} & \\
+ \DescRef{\LabelBase.fontelement.chapterentry} & \DescRef{\LabelBase.cmd.usekomafont}\PParameter{disposition}\\
+ \DescRef{\LabelBase.fontelement.chapterentrydots} & \Macro{normalfont} \\
+ \DescRef{\LabelBase.fontelement.chapterentrypagenumber} & \\
+ \DescRef{\LabelBase.fontelement.sectionentry} & \DescRef{\LabelBase.cmd.usekomafont}\PParameter{disposition}\\
+ \DescRef{\LabelBase.fontelement.sectionentrydots} & \Macro{normalfont} \\
+ \DescRef{\LabelBase.fontelement.sectionentrypagenumber} & \\
\bottomrule
\end{tabular}
\end{captionbeside}
\end{table}
%
-\EndIndex{Cmd}{tableofcontents}%
+\EndIndexGroup
+
\begin{Declaration}
\Counter{tocdepth}
\end{Declaration}%
-\BeginIndex{Counter}{tocdepth}%
Normally, the units included in the table of contents are all the units from
-\Macro{part} to \Macro{subsection} for the classes \Class{scrbook} and
-\Class{scrreprt} or from \Macro{part} to \Macro{subsubsection} for the class
+\DescRef{\LabelBase.cmd.part} to \DescRef{\LabelBase.cmd.subsection} for the classes \Class{scrbook} and
+\Class{scrreprt} or from \DescRef{\LabelBase.cmd.part} to \DescRef{\LabelBase.cmd.subsubsection} for the class
\Class{scrartcl}. The inclusion of a sectional unit in the table of contents
is controlled by the counter \Counter{tocdepth}. This has the value \(-\)1 for
-\Macro{part}, 0 for \Macro{chapter}, and so on. By incrementing
+\DescRef{\LabelBase.cmd.part}, 0 for \DescRef{\LabelBase.cmd.chapter}, and so on. By incrementing
or decrementing the counter, one can choose the lowest sectional unit level to
be included in the table of contents. The same happens with the standard
classes.
-Please note\textnote{Attention!} that for \Macro{part} the values of
-\Counter{tocdepth} and \Counter{secnumdepth}\IndexCounter{secnumdepth} (see
-\autoref{sec:maincls.structure},
-\autopageref{desc:maincls.counter.secnumdepth}) are not the same in
+Please note\textnote{Attention!} that for \DescRef{\LabelBase.cmd.part} the
+values of \Counter{tocdepth} and
+\DescRef{\LabelBase.counter.secnumdepth}\IndexCounter{secnumdepth} (see
+\autoref{sec:\LabelBase.structure},
+\DescPageRef{\LabelBase.counter.secnumdepth}) are not the same in
\Class{scrartcl}\OnlyAt{\Class{scrartcl}}. Therefore, you should not use
-\Macro{partnumdepth}\IndexCmd{partnumdepth} to set the value of
-\Counter{tocdepth}.%
+\DescRef{\LabelBase.cmd.partnumdepth}\IndexCmd{partnumdepth} to set the value
+of \Counter{tocdepth}.%
\begin{Example}
Assume that you are preparing an article that uses the sectional
- unit \Macro{subsubsection}. However, you do not want this sectional
+ unit \DescRef{\LabelBase.cmd.subsubsection}. However, you do not want this sectional
unit to appear in the table of contents. The preamble of your
document might contain the following:
\begin{lstcode}
@@ -603,9 +594,9 @@ Please note\textnote{Attention!} that for \Macro{part} the values of
\setcounter{tocdepth}{2}
\end{lstcode}
You set the counter \Counter{tocdepth} to 2 because you know that
- this is the value for \Macro{subsection}. If you know that
+ this is the value for \DescRef{\LabelBase.cmd.subsection}. If you know that
\Class{scrartcl} normally includes all levels down to
- \Macro{subsubsection} in the table of contents, you can simply
+ \DescRef{\LabelBase.cmd.subsubsection} in the table of contents, you can simply
decrement the counter \Counter{tocdepth} by one:
\begin{lstcode}
\documentclass{scrartcl}
@@ -621,29 +612,28 @@ units required extra or less and then, as in the above example, use
\Macro{addtocounter} to add or subtract that number to or from
\Counter{tocdepth}.%
%
-\EndIndex{Counter}{tocdepth}%
+\EndIndexGroup
%
-\EndIndex{}{table of contents}
+\EndIndexGroup
-\LoadCommon{6}% \section{Paragraph Markup}
+\LoadCommonFile{parmarkup}% \section{Paragraph Markup}
-\LoadCommon{7}% \section{Detection of Odd and Even Pages}
+\LoadCommonFile{oddorevenpage}% \section{Detection of Odd and Even Pages}
\section{Head and Foot Using Predefined Page Styles}
\seclabel{pagestyle}
+\BeginIndexGroup
\BeginIndex{}{page>style}
One of the general characteristics of a document is the page style. In
{\LaTeX} this means mostly the contents of headers and footers.
\begin{Declaration}
- \KOption{headsepline}\PName{simple switch}\\
- \KOption{footsepline}\PName{simple switch}
+ \OptionVName{headsepline}{simple switch}%
+ \OptionVName{footsepline}{simple switch}
\end{Declaration}%
-\BeginIndex{Option}{headsepline~=\PName{simple switch}}%
-\BeginIndex{Option}{footsepline~=\PName{simple switch}}%
In\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}
order to have or not to have a rule separating the header from the text body,
use the option \Option{headsepline} with any value shown in
@@ -659,29 +649,28 @@ has the effect of visually bringing header and text body closer together. That
does not mean that the header must now be moved farther from the text
body. Instead, the header should be considered as belonging to the text body
for the purpose of page layout calculations. {\KOMAScript} takes this into
-account by automatically passing the option \Option{headinclude} to the
-\Package{typearea} package whenever the \Option{headsepline} option is
-used. \KOMAScript{} behaves similar to \Option{footinclude} using
+account by automatically passing the option
+\DescRef{typearea.option.headinclude} to the \Package{typearea} package
+whenever the \Option{headsepline} option is used. \KOMAScript{} behaves
+similar to \DescRef{typearea.option.footinclude} using
\Option{footsepline}. Package \Package{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage}) adds additional features to this.%
%
-\EndIndex{Option}{headsepline~=\PName{simple switch}}%
-\EndIndex{Option}{footsepline~=\PName{simple switch}}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{pagestyle}\PParameter{page style}\\
+ \Macro{pagestyle}\PParameter{page style}%
\Macro{thispagestyle}\Parameter{local page style}
\end{Declaration}%
-\BeginIndex{Cmd}{pagestyle}%
-\BeginIndex{Cmd}{thispagestyle}%
Usually one distinguishes four different page styles:
\begin{description}
-\item[empty\BeginIndex{Pagestyle}{empty}] is the page
+\item[empty\BeginIndex{Pagestyle}{empty}\LabelPageStyle{empty}] is the page
style with entirely empty headers and footers. In {\KOMAScript} this is
completely identical to the standard classes.
-\item[headings\BeginIndex{Pagestyle}{headings}] is the page style with running
- headings in the header. These are headings for which titles are
- automatically inserted into the header.
+\item[headings\BeginIndex{Pagestyle}{headings}\LabelPageStyle{headings}] is
+ the page style with running headings in the header. These are headings for
+ which titles are automatically inserted into the header.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}With the classes
\Class{scrbook}\IndexClass{scrbook} and
\Class{scrreprt}\IndexClass{scrreprt} the titles of chapters and sections
@@ -705,32 +694,34 @@ Usually one distinguishes four different page styles:
standard classes do not take these points into consideration.
Beyond this {\KOMAScript} classes support rules below the head and above the
- foot using options \Option{headsepline} and \Option{footsepline} which are
- described above.
-\item[myheadings\BeginIndex{Pagestyle}{myheadings}] corresponds mostly to the
- page style \PValue{headings}, but the running headings are not automatically
- produced\,---\,they have to be defined by the user. The commands \Macro
- {markboth}\IndexCmd{markboth} and \Macro{markright}\IndexCmd{markright} can
- be used for that purpose (see below).
-\item[plain\BeginIndex{Pagestyle}{plain}] is the page style with empty header
- and only a page number in the footer. With the standard classes this page
- number is always centered in the footer. With {\KOMAScript} the page number
- appears on double-sided\Index {double-sided} layout on the outer side of the
- footer. The one-sided page style behaves like the standard setup.
+ foot using options \DescRef{\LabelBase.option.headsepline} and
+ \DescRef{\LabelBase.option.footsepline} which are described above.
+\item[myheadings\BeginIndex{Pagestyle}{myheadings}\LabelPageStyle{myheadings}]
+ corresponds mostly to the page style \PValue{headings}, but the running
+ headings are not automatically produced\,---\,they have to be defined by the
+ user. The commands \Macro {markboth}\IndexCmd{markboth} and
+ \DescRef{\LabelBase.cmd.markright}\IndexCmd{markright} can be used for that
+ purpose (see below).
+\item[plain\BeginIndex{Pagestyle}{plain}\LabelPageStyle{plain}] is the page
+ style with empty header and only a page number in the footer. With the
+ standard classes this page number is always centered in the footer. With
+ {\KOMAScript} the page number appears on double-sided\Index {double-sided}
+ layout on the outer side of the footer. The one-sided page style behaves
+ like the standard setup.
\end{description}
The page style can be set at any time with the help of the \Macro{pagestyle}
command and takes effect with the next page that is output. If\textnote{Hint!}
-one uses \Macro{pagestyle} just before a command, that results in an
-implicit page break and if the new page style should be used at the resulting
-new page first, a \Macro{cleardoublepage} just before \Macro{pagestyle} will
-be useful. But usually one sets the page style only once at the beginning of
-the document or in the preamble.
+one uses \Macro{pagestyle} just before a command, that results in an implicit
+page break and if the new page style should be used at the resulting new page
+first, a \DescRef{\LabelBase.cmd.cleardoublepage} just before
+\Macro{pagestyle} will be useful. But usually one sets the page style only
+once at the beginning of the document or in the preamble.
To\important{\Macro{thispagestyle}} change the page style of the current page
only, one uses the \Macro{thispagestyle} command. This also happens
automatically at some places in the document. For example, the instruction
-\Macro{thispagestyle}\PParameter{\Macro{chapterpagestyle}} is issued
+\Macro{thispagestyle}\PParameter{\DescRef{\LabelBase.cmd.chapterpagestyle}} is issued
implicitly on the first page of a chapter.
Please\textnote{Attention!} note that the change between automatic and manual
@@ -739,32 +730,30 @@ running headings is no longer performed by page style changes when using the
page styles \PValue{headings} and \PValue{myheadings} should not be used
together with this package.%
%
-\EndIndex{Pagestyle}{empty}% Darueber erfahren wir nun nichts mehr
+\BeginIndexGroup
\BeginIndex[indexother]{}{font>style}%
-\BeginIndex{FontElement}{pageheadfoot}%
-\BeginIndex{FontElement}{pagefoot}%
-\BeginIndex{FontElement}{pagenumber}%
+\BeginIndex{FontElement}{pageheadfoot}\LabelFontElement{pageheadfoot}%
+\BeginIndex{FontElement}{pagefoot}\LabelFontElement{pagefoot}%
+\BeginIndex{FontElement}{pagenumber}\LabelFontElement{pagenumber}%
In order to change the font style used in the header, footer, or for the page
number\ChangedAt{v2.8p}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
-, please use the interface described in \autoref{sec:maincls.textmarkup},
-\autopageref{desc:maincls.cmd.setkomafont}. The same element is used for
-header and footer, which you can designate with
-\FontElement{pageheadfoot}\IndexFontElement{pageheadfoot}%
-\important{\FontElement{pageheadfoot}}. The element for the page number within
-the header or footer is called
-\FontElement{pagenumber}\IndexFontElement{pagenumber}%
-\important{\FontElement{pagenumber}}. The element
-\FontElement{pagefoot}\IndexFontElement{pagefoot}, that is additionally
-supported by the \KOMAScript{} classes, will be used only if a page style has
-been defined that has text at the foot line, using package
+, please use the interface described in \autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}. The same element is used for header
+and footer, which you can designate with
+\FontElement{pageheadfoot}\important{\FontElement{pageheadfoot}}. The element
+for the page number within the header or footer is called
+\FontElement{pagenumber}\important{\FontElement{pagenumber}}. The element
+\FontElement{pagefoot}, that is additionally supported by the \KOMAScript{}
+classes, will be used only if a page style has been defined that has text at
+the foot line, using package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage},
-\autopageref{desc:scrlayer-scrpage.fontelement.pagefoot}).
+\DescPageRef{scrlayer-scrpage.fontelement.pagefoot}).
The default settings can be found in
-\autoref{tab:maincls.defaultFontsHeadFoot}.%
+\autoref{tab:\LabelBase.defaultFontsHeadFoot}.%
%
\begin{table}
% \centering%
@@ -773,18 +762,18 @@ The default settings can be found in
% \caption
\begin{captionbeside}
[{Default values for the elements of a page style}]
- {\label{tab:maincls.defaultFontsHeadFoot}%
+ {\label{tab:\LabelBase.defaultFontsHeadFoot}%
Default values for the elements of a page style}
[l]
\begin{tabular}[t]{ll}
\toprule
Element & Default value \\
\midrule
- \FontElement{pagefoot}\IndexFontElement{pagefoot} &
+ \DescRef{\LabelBase.fontelement.pagefoot}\IndexFontElement{pagefoot} &
\\
- \FontElement{pageheadfoot}\IndexFontElement{pagefoothead} &
+ \DescRef{\LabelBase.fontelement.pageheadfoot}\IndexFontElement{pagefoothead} &
\Macro{normalfont}\Macro{normalcolor}\Macro{slshape} \\
- \FontElement{pagenumber}\IndexFontElement{pagenumber} &
+ \DescRef{\LabelBase.fontelement.pagenumber}\IndexFontElement{pagenumber} &
\Macro{normalfont}\Macro{normalcolor}\\
\bottomrule
\end{tabular}
@@ -792,7 +781,7 @@ The default settings can be found in
\end{table}
%
\begin{Example}
- \leavevmode\phantomsection\exlabel{pagestyle}%
+ \leavevmode\phantomsection\xmpllabel{cmd.pagestyle}%
Assume that you want to set header and footer in a smaller type size
and in italics. However, the page number should not be set in
italics but bold. Apart from the fact that the result will look
@@ -811,17 +800,18 @@ The default settings can be found in
As you can see, the last example uses the element
\FontElement{pagehead}\important{\FontElement{pagehead}}. You can achieve
the same result using \PValue{pageheadfoot} instead (see
- \autoref{tab:maincls.elementsWithoutText} on
- \autopageref{tab:maincls.elementsWithoutText}).
+ \autoref{tab:\LabelBase.fontelements} on
+ \autopageref{tab:\LabelBase.fontelements}).
\end{Example}
It is not possible to use these methods to force capitals to be used
automatically for the running headings. For that, please use the
\Package{scrlayer-scrpage} package (see \autoref{cha:scrlayer-scrpage},
-\autopageref{desc:scrlayer-scrpage.option.markcase}).
+\DescPageRef{scrlayer-scrpage.option.markcase}).
If you define your own page styles, the commands
-\Macro{usekomafont}\PParameter{pageheadfoot}, \Macro{usekomafont}\PParameter
-{pagenumber}, and \Macro{usekomafont}\PParameter{pagefoot} can be useful. If
+\DescRef{\LabelBase.cmd.usekomafont}\PParameter{pageheadfoot},
+\DescRef{\LabelBase.cmd.usekomafont}\PParameter {pagenumber}, and
+\DescRef{\LabelBase.cmd.usekomafont}\PParameter{pagefoot} can be useful. If
you do not use the {\KOMAScript} package \Package{scrlayer-scrpage} (see
\autoref{cha:scrlayer-scrpage}) for that, but, for example, the package
\Package{fancyhdr}\IndexPackage{fancyhdr} (see \cite{package:fancyhdr}), you
@@ -832,59 +822,52 @@ no effect. The package
\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage} takes care to keep
the maximum possible compatibility with other packages itself.
%
-\EndIndex{FontElement}{pagenumber}%
-\EndIndex{FontElement}{pagefoot}%
-\EndIndex{FontElement}{pageheadfoot}%
-\EndIndex{Pagestyle}{plain}%
-\EndIndex{Cmd}{pagestyle}%
-\EndIndex{Cmd}{thispagestyle}%
+\EndIndexGroup
%
-\EndIndex[indexother]{}{font>style}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{markboth}\Parameter{left mark}\Parameter{right mark}\\
+ \Macro{markboth}\Parameter{left mark}\Parameter{right mark}%
\Macro{markright}\Parameter{right mark}
\end{Declaration}
-\BeginIndex{Cmd}{markboth}%
-\BeginIndex{Cmd}{markright}%
-With page style \Pagestyle{myheadings}\important{\Pagestyle{myheadings}}%
+\BeginIndex{Pagestyle}{headings}%
+\BeginIndex{Pagestyle}{myheadings}%
+With page style \PageStyle{myheadings}\important{\PageStyle{myheadings}}%
\IndexPagestyle{myheadings}, there's no automatic setting of the running head.
Instead of this one would set it with the help of commands \Macro{markboth}
and \Macro{markright}. Thereby \PName{left mark} normally will be used at the
head of even pages and \PName{right mark} at the heads of odd pages. With
one-sided printing, only the \PName{right mark} exists. Using package
-\Package{scrlayer-scrpage}\IndexPackage{scrlayer-scrpage}\important{\Package{scrlayer-scrpage}},
-the additional command
-\Macro{markleft}\IndexCmd{markleft}\important{\Macro{markleft}} exists.
+\Package{scrlayer-scrpage}%
+\IndexPackage{scrlayer-scrpage}\important{\Package{scrlayer-scrpage}}, the
+additional command \DescRef{scrlayer-scrpage.cmd.markleft}%
+\IndexCmd{markleft}\important{\DescRef{scrlayer-scrpage.cmd.markleft}} exists.
The commands may be used with other page styles too. Combination with automatic
-running head, e.\,g., with page style \Pagestyle{headings}, limits the effect
+running head, e.\,g., with page style \PageStyle{headings}, limits the effect
of the commands until the next automatic setting of the corresponding marks.%
%
-\EndIndex{Cmd}{markright}%
-\EndIndex{Cmd}{markboth}%
-%
-\EndIndex{Pagestyle}{myheadings}%
-\EndIndex{Pagestyle}{headings}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{titlepagestyle}\\
- \Macro{partpagestyle}\\
- \Macro{chapterpagestyle}\\
+ \Macro{titlepagestyle}%
+ \Macro{partpagestyle}%
+ \Macro{chapterpagestyle}%
\Macro{indexpagestyle}
\end{Declaration}%
-\BeginIndex{Cmd}{titlepagestyle}\Index{title>page style}%
-\BeginIndex{Cmd}{partpagestyle}\Index{part>page style}%
-\BeginIndex{Cmd}{chapterpagestyle}\Index{chapter>page style}%
-\BeginIndex{Cmd}{indexpagestyle}\Index{index>page style}%
-For some pages, a different page style is chosen with the help of the
-command \Macro{thispagestyle}. Which page style this actually is, is
+\Index{title>page style}%
+\Index{part>page style}%
+\Index{chapter>page style}%
+\Index{index>page style}%
+For some pages, a different page style is chosen with the help of the command
+\DescRef{\LabelBase.cmd.thispagestyle}. Which page style this actually is, is
defined by these four macros, of which \Macro{partpagestyle} and
-\Macro{chapterpagestyle}\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}
-are found only with classes \Class{scrbook} and \Class{scrreprt}, but
-not in \Class{scrartcl}. The default value for all four cases is
-\PValue{plain}. The meaning of these macros can be taken from
-\autoref{tab:specialpagestyles}.
+\Macro{chapterpagestyle}\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} are found
+only with classes \Class{scrbook} and \Class{scrreprt}, but not in
+\Class{scrartcl}. The default value for all four cases is \PValue{plain}. The
+meaning of these macros can be taken from \autoref{tab:specialpagestyles}.
%
\begin{table}
\centering
@@ -893,7 +876,7 @@ not in \Class{scrartcl}. The default value for all four cases is
\begin{desctabular}
\mentry{titlepagestyle}{Page style for a title page when using
\emph{in-page} titles.}%
- \mentry{partpagestyle}{Page style for the pages with \Macro{part}
+ \mentry{partpagestyle}{Page style for the pages with \DescRef{\LabelBase.cmd.part}
titles.}%
\mentry{chapterpagestyle}{Page style for the first page of a chapter.}%
\mentry{indexpagestyle}{Page style for the first page of the index.}%
@@ -902,13 +885,13 @@ not in \Class{scrartcl}. The default value for all four cases is
%
The page styles can be redefined with the \Macro{renewcommand} macro.
\begin{Example}
- Assume that you want the pages with a \Macro{part} heading to have
+ Assume that you want the pages with a \DescRef{\LabelBase.cmd.part} heading to have
no number. Then you can use the following command, for example in
the preamble of your document:
\begin{lstcode}
\renewcommand*{\partpagestyle}{empty}
\end{lstcode}
- As mentioned previously on \autopageref{desc:maincls.pagestyle.empty},
+ As mentioned previously on \DescPageRef{\LabelBase.pagestyle.empty},
the page style \PValue{empty} is exactly what is required in this
example. Naturally you can also use a user-defined page style.
@@ -961,18 +944,15 @@ The page styles can be redefined with the \Macro{renewcommand} macro.
\end{lstcode}
should read more about the background of \Macro{rightmark} at
\autoref{sec:maincls-experts.addInfos},
- \autopageref{desc:maincls-experts.cmd.rightmark}.
+ \DescPageRef{maincls-experts.cmd.rightmark}.
\end{Explain}
%
-\EndIndex{Cmd}{titlepagestyle}%
-\EndIndex{Cmd}{partpagestyle}%
-\EndIndex{Cmd}{chapterpagestyle}%
-\EndIndex{Cmd}{indexpagestyle}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{pagenumbering}\Parameter{numbering style}
\end{Declaration}
-\BeginIndex{Cmd}{pagenumbering}%
This command works the same way in {\KOMAScript} as in the standard
classes. More precisely it is a feature neither of the standard classes nor of
the \KOMAScript{} classes but of the {\LaTeX} kernel. You can specify with
@@ -980,7 +960,7 @@ this command the \PName{numbering style} of page numbers.
The changes take effect immediately, hence starting with the
page that contains the command. It is recommended to use
-\Macro{cleardoubleoddpage} to close the last page and start a new odd page
+\DescRef{\LabelBase.cmd.cleardoubleoddpage} to close the last page and start a new odd page
before. The possible settings can be found in
\autoref{tab:numberKind}.
@@ -1011,18 +991,19 @@ the next page which {\TeX} outputs will have the number 1 in the style
\end{captionbeside}
\end{table}
%
-\EndIndex{Cmd}{pagenumbering}%
+\EndIndexGroup
%
-\EndIndex{}{page>style}
+\EndIndexGroup
-\LoadCommon{8}% \section{Interleaf Pages}
+\LoadCommonFile{interleafpage}% \section{Interleaf Pages}
+
+\LoadCommonFile{footnotes}% \section{Footnotes}
-\LoadCommon{9}% \section{Footnotes}
\section[Demarcation]{Demarcation\protect\OnlyAt{\Class{scrbook}}}
\seclabel{separation}
-
+\BeginIndexGroup
\BeginIndex{}{front matter}%
\BeginIndex{}{main matter}%
\BeginIndex{}{back matter}%
@@ -1034,13 +1015,10 @@ Sometimes books are roughly separated into front matter, main matter, and
back matter. \KOMAScript{} provides this for \Class{scrbook} also.
\begin{Declaration}
- \Macro{frontmatter}\\
- \Macro{mainmatter}\\
+ \Macro{frontmatter}%
+ \Macro{mainmatter}%
\Macro{backmatter}
\end{Declaration}%
-\BeginIndex{Cmd}{frontmatter}%
-\BeginIndex{Cmd}{mainmatter}%
-\BeginIndex{Cmd}{backmatter}%
The macro \Macro{frontmatter}\important{\Macro{frontmatter}} introduces the
front matter in which roman numerals are used for the page numbers. Chapter
headings in a front matter are not numbered. The section titles which would be
@@ -1056,25 +1034,25 @@ need for a deeper structuring than the chapter level.
In case the user sees things differently and wishes to use numbered
sections\Index{section>number} in the chapters of the front matter, as of
version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}}%
-\important{\OptionValue{version}{2.97e}} the section numbering no longer
-contains the chapter number. This change only takes effect when the
+\important{\OptionValueRef{\LabelBase}{version}{2.97e}} the section numbering
+no longer contains the chapter number. This change only takes effect when the
compatibility option is set to at least version~2.97e (see option
-\Option{version}, \autoref{sec:maincls.compatibilityOptions},
-\autopageref{desc:maincls.option.version}). It is explicity noted that this
-creates a confusion with chapter numbers! The use of \Macro{addsec} and
-\Macro{section*} (see \autoref{sec:maincls.structure},
-\autopageref{desc:maincls.cmd.section*} and
-\autopageref{desc:maincls.cmd.addsec}) are thus, in the author's opinion, far
-more preferable.
-
-As of version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}} the numbering
-of float environments, such as tables\Index{table>number} and
-figures\Index{figure>number}, and equation
-numbers\Index{equation>number} in the front matter also contain no
-chapter number part. To take effect this too requires the
-corresponding compatibility setting (see option \Option{version},
-\autoref{sec:maincls.compatibilityOptions},
-\autopageref{desc:maincls.option.version}).
+\DescRef{\LabelBase.option.version},
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}). It is explicity noted that this
+creates a confusion with chapter numbers! The use of \DescRef{\LabelBase.cmd.addsec} and
+\DescRef{\LabelBase.cmd.section*} (see \autoref{sec:\LabelBase.structure},
+\DescPageRef{\LabelBase.cmd.section*} and \DescPageRef{\LabelBase.cmd.addsec})
+are thus, in the author's opinion, far more preferable.
+
+As of version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}} the numbering of float
+environments, such as tables\Index{table>number} and
+figures\Index{figure>number}, and equation numbers\Index{equation>number} in
+the front matter also contain no chapter number part. To take effect this too
+requires the corresponding compatibility setting (see option
+\DescRef{\LabelBase.option.version},
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}).
\Macro{mainmatter}\important{\Macro{mainmatter}} introduces the main matter
with the main text. If there is no front matter, then this command can be
@@ -1088,19 +1066,13 @@ bibliography\Index{bibliography}, in some cases only the index\Index{index},
and in other cases both of these as well as the appendices. The chapters in
the back matter are similar to the chapters in the front matter, but page
numbering is not reset. If you do require separate page numbering you may use
-the command \Macro{pagenumbering} from \autoref{sec:maincls.pagestyle},
-\autopageref{desc:maincls.cmd.pagenumbering}.
+the command \DescRef{\LabelBase.cmd.pagenumbering} from
+\autoref{sec:\LabelBase.pagestyle},
+\DescPageRef{\LabelBase.cmd.pagenumbering}.
%
-\EndIndex{Cmd}{frontmatter}%
-\EndIndex{Cmd}{mainmatter}%
-\EndIndex{Cmd}{backmatter}%
+\EndIndexGroup
%
-\EndIndex{}{front matter}%
-\EndIndex{}{main matter}%
-\EndIndex{}{back matter}%
-\EndIndex{}{matter>front}%
-\EndIndex{}{matter>main}%
-\EndIndex{}{matter>back}%
+\EndIndexGroup
\section{Structuring of Documents}
@@ -1110,9 +1082,8 @@ Structuring of documents means to divide them into parts, chapters, sections,
and several other structural elements.
\begin{Declaration}
- \KOption{open}\PName{method}
+ \OptionVName{open}{method}
\end{Declaration}%
-\BeginIndex{Option}{open~=\PName{method}}%
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
\KOMAScript{} classes \Class{scrbook} and \Class{scrreprt} give you the choice
of where to start\Index{chapter>start} a new chapter with double-sided
@@ -1124,11 +1095,11 @@ start at the left-hand page of a double-page spread. This would be
accomplished with \PName{method}
\PValue{left}\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}}. An
overview of the supported methods may be found at
-\autoref{tab:maincls.open}. The table also describes the effect on
-\Macro{cleardoublepage}, \Macro{cleardoublepageusingstyle},
-\Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage}, and
-\Macro{cleardoubleemptypage} (see \autoref{sec:maincls.emptypage},
-\autopageref{desc:maincls.cmd.cleardoublepage}).
+\autoref{tab:\LabelBase.open}. The table also describes the effect on
+\DescRef{\LabelBase.cmd.cleardoublepage}, \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+\DescRef{\LabelBase.cmd.cleardoublestandardpage}, \DescRef{\LabelBase.cmd.cleardoubleplainpage}, and
+\DescRef{\LabelBase.cmd.cleardoubleemptypage} (see \autoref{sec:\LabelBase.emptypage},
+\DescPageRef{\LabelBase.cmd.cleardoublepage}).
\begin{table}
\caption[{Available values for option \Option{open}}]{Available values for
@@ -1136,29 +1107,40 @@ overview of the supported methods may be found at
\Class{scrbook} or \Class{scrreprt}}
\begin{desctabular}
\pventry{any}{%
- Parts, chapter, index, and back matter use \Macro{clearpage} instead of
- \Macro{cleardoublepage};%
- \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage},
- \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and
- \Macro{cleardoublepage} behaves same like using
+ Parts, chapter, index, and back matter use
+ \DescRef{\LabelBase.cmd.clearpage} instead of
+ \DescRef{\LabelBase.cmd.cleardoublepage};%
+ \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+ \DescRef{\LabelBase.cmd.cleardoublestandardpage},
+ \DescRef{\LabelBase.cmd.cleardoubleplainpage},
+ \DescRef{\LabelBase.cmd.cleardoubleemptypage}, and
+ \DescRef{\LabelBase.cmd.cleardoublepage} behaves same like using
\OptionValue{open}{right}.%
\IndexOption{open~=\PValue{any}}}%
\pventry{left}{%
- Part, chapter, index and back matter use \Macro{cleardoublepage};%
- \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage},
- \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and
- \Macro{cleardoublepage} result in a page break and add an interleaf
- page\Index{page>interleaf} if needed to reach the next left-hand page.%
+ Part, chapter, index and back matter use
+ \DescRef{\LabelBase.cmd.cleardoublepage};%
+ \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+ \DescRef{\LabelBase.cmd.cleardoublestandardpage},
+ \DescRef{\LabelBase.cmd.cleardoubleplainpage},
+ \DescRef{\LabelBase.cmd.cleardoubleemptypage}, and
+ \DescRef{\LabelBase.cmd.cleardoublepage} result in a page break and add
+ an interleaf page\Index{page>interleaf} if needed to reach the next
+ left-hand page.%
\IndexOption{open~=\PValue{left}}}%
\pventry{right}{%
- Part, chapter, index and back matter use \Macro{cleardoublepage};%
- \Macro{cleardoublepageusingstyle}, \Macro{cleardoublestandardpage},
- \Macro{cleardoubleplainpage}, \Macro{cleardoubleemptypage}, and
- \Macro{cleardoublepage} result in a page break and add an interleaf
- page\Index{page>interleaf} if needed to reach the next right-hand page.%
+ Part, chapter, index and back matter use
+ \DescRef{\LabelBase.cmd.cleardoublepage};%
+ \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+ \DescRef{\LabelBase.cmd.cleardoublestandardpage},
+ \DescRef{\LabelBase.cmd.cleardoubleplainpage},
+ \DescRef{\LabelBase.cmd.cleardoubleemptypage}, and
+ \DescRef{\LabelBase.cmd.cleardoublepage} result in a page break and add
+ an interleaf page\Index{page>interleaf} if needed to reach the next
+ right-hand page.%
\IndexOption{open~=\PValue{right}}}%
\end{desctabular}
- \label{tab:maincls.open}
+ \label{tab:\LabelBase.open}
\end{table}
Since \LaTeX{} does not differentiate between left-hand and right-hand pages
@@ -1167,16 +1149,14 @@ in single-sided printing, the option does not have any influence in that case.
In class \Class{scrartcl} the section is the first structural element below
the part. Because of this, \Class{scrartcl} does not support this option.
%
-\EndIndex{Option}{open~=\PName{method}}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{chapterprefix}\PName{simple switch}\\
- \KOption{appendixprefix}\PName{simple switch}\\
+ \OptionVName{chapterprefix}{simple switch}%
+ \OptionVName{appendixprefix}{simple switch}%
\Macro{IfChapterUsesPrefixLine}\Parameter{then code}\Parameter{else code}
\end{Declaration}%
-\BeginIndex{Option}{chapterprefix~=\PName{simple switch}}%
-\BeginIndex{Option}{appendixprefix~=\PName{simple switch}}%
-\BeginIndex{Cmd}{IfChapterUsesPrefixLine}%
With\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} the standard classes
\Class{book} and \Class{report}, a chapter
title\Index[indexmain]{chapter>title} consists of a line with the word
@@ -1191,8 +1171,8 @@ be used as \PName{simple switch}. The default, however, is
of the standard classes, which would correspond to
\OptionValue{chapterprefix}{true}.
These options also affect the automatic
-running titles in the headers (see \autoref{sec:maincls.pagestyle},
-\autopageref{desc:maincls.pagestyle.headings}).
+running titles in the headers (see \autoref{sec:\LabelBase.pagestyle},
+\DescPageRef{\LabelBase.pagestyle.headings}).
Sometimes one wishes to have the
chapter titles in simplified form according to
@@ -1202,7 +1182,7 @@ followed by the appendix letter. This is achieved by using the
\Option{appendixprefix} option (see \autoref{tab:truefalseswitch},
\autopageref{tab:truefalseswitch}). Since this results in an inconsistent
document layout, I advise against using this option. Final consequence of
-using the option is, that \Macro{appendix} changes setting of option
+using the option is, that \DescRef{\LabelBase.cmd.appendix} changes setting of option
\Option{chapterprefix}.
You\ChangedAt{v3.18}{\Class{scrbook}\and \Class{scrreprt}} can execute code
@@ -1211,27 +1191,25 @@ depending on the current setting for the chapter preceding line using
active, the \PName{then code} will be executed, otherwise the \PName{else
code}.
+\BeginIndex{FontElement}{chapterprefix}\LabelFontElement{chapterprefix}%
The font style of the chapter number line using
\OptionValue{chapterprefix}{true} or \OptionValue{appendixprefix}{true} may be
changed with element
-\FontElement{chapterprefix}\IndexFontElement{chapterprefix}%
-\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}} using commands
-\Macro{setkomafont} and \Macro{addtokomafont} (see
-\autoref{sec:maincls.textmarkup},
-\autopageref{desc:maincls.cmd.setkomafont}). Default is the usage of element
-\FontElement{chapter}\IndexFontElement{chapter} (see
-\autopageref{desc:maincls.cmd.chapter}, as well as
-\autoref{tab:maincls.structureElementsFont},
-\autopageref{tab:maincls.structureElementsFont}).%
-%
-\EndIndex{Cmd}{IfChapterUsesPrefixLine}%
-\EndIndex{Option}{appendixprefix~=\PName{simple switch}}%
-\EndIndex{Option}{chapterprefix~=\PName{simple switch}}%
+\FontElement{chapterprefix}\ChangedAt{v2.96a}{\Class{scrbook}\and
+ \Class{scrreprt}} using commands \DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). Default is the usage of element
+\DescRef{\LabelBase.fontelement.chapter}\IndexFontElement{chapter} (see
+\DescPageRef{\LabelBase.cmd.chapter}, as well as
+\autoref{tab:\LabelBase.structureElementsFont},
+\autopageref{tab:\LabelBase.structureElementsFont}).%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{headings}\PName{selection}
+ \OptionVName{headings}{selection}
\end{Declaration}%
-\BeginIndex{Option}{headings~=\PName{selection}}%
The font size used for the titles\index{title}\index{document structure} is
relatively big, both with the standard classes and with {\KOMAScript}. Not
everyone likes this choice; moreover it is especially problematic for small
@@ -1246,15 +1224,17 @@ font size defined by the
\OptionValue{headings}{small}\IndexOption{headings~=\PValue{small}}, that
allow for smaller title font sizes. The font sizes for headings resulting from
these options for \Class{scrbook} and \Class{scrreprt} are shown in
-\autoref{tab:maincls.structureElementsFont},
-\autopageref{tab:maincls.structureElementsFont}. Respectively, the fonts of
-the elements \FontElement{chapter}\IndexFontElement{chapter},
-\FontElement{section}\IndexFontElement{section},
-\FontElement{subsection}\IndexFontElement{subsection},
-\FontElement{subsubsection}\IndexFontElement{subsubsection},
-\FontElement{paragraph}\IndexFontElement{paragraph}, and
-\FontElement{subparagraph}\IndexFontElement{subparagraph} will be reset to
-these default.
+\autoref{tab:\LabelBase.structureElementsFont},
+\autopageref{tab:\LabelBase.structureElementsFont}. Respectively, the fonts of
+the elements \DescRef{\LabelBase.fontelement.chapter}%
+\IndexFontElement{chapter},
+\DescRef{\LabelBase.fontelement.section}\IndexFontElement{section},
+\DescRef{\LabelBase.fontelement.subsection}\IndexFontElement{subsection},
+\DescRef{\LabelBase.fontelement.subsubsection}%
+\IndexFontElement{subsubsection},
+\DescRef{\LabelBase.fontelement.paragraph}\IndexFontElement{paragraph}, and
+\DescRef{\LabelBase.fontelement.subparagraph}\IndexFontElement{subparagraph}
+will be reset to these default.
For \Class{scrartcl}, smaller
font sizes are generally used. \OnlyAt{\Class{scrbook}\and
@@ -1269,40 +1249,46 @@ Chapter\important[i]{\begin{tabular}[t]{@{}l@{}}
\Option{headings=}\\ \quad\PValue{twolineappendix}\end{tabular}}
titles are also influenced by the options
\OptionValue{headings}{twolinechapter} and
-\OptionValue{headings}{onelinechapter}, that are same as \OptionValue{chapterprefix}{true} and
-\OptionValue{chapterprefix}{false} (see above). The appendix titles are
-influenced by \OptionValue{headings}{twolineappendix} and
+\OptionValue{headings}{onelinechapter}, that are same as
+\OptionValueRef{\LabelBase}{chapterprefix}{true} and
+\OptionValueRef{\LabelBase}{chapterprefix}{false} (see above). The appendix
+titles are influenced by \OptionValue{headings}{twolineappendix} and
\OptionValue{headings}{onelineappendix}\important[i]{%
\begin{tabular}[b]{@{}l@{}}
\Option{headings=}\\ \quad\PValue{onelineappendix}
\end{tabular}}, that are the same as the options
-\OptionValue{appendixprefix}{true} and \OptionValue{appendixprefix}{false}
-(see also above).
+\OptionValueRef{\LabelBase}{appendixprefix}{true} and
+\OptionValueRef{\LabelBase}{appendixprefix}{false} (see also above).
The\OnlyAt{\Class{scrbook}\and \Class{scrreprt}} method of beginning new
chapters may be switched by \OptionValue{headings}{openany}\important[i]{%
\OptionValue{headings}{openany}\\
\OptionValue{headings}{openright}\\
\OptionValue{headings}{openleft}}, \OptionValue{headings}{openright}, and
-\OptionValue{headings}{openleft} alternatively to option \Option{open} with
-the values \PValue{any},
+\OptionValue{headings}{openleft} alternatively to option
+\DescRef{\LabelBase.option.open} with the values \PValue{any},
\PValue{right}, and \PValue{left} (see above).
Another\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} special feature of \KOMAScript{} is the handling of the
-optional argument of the structural commands \Macro{part}, \Macro{chapter},
-etc., down to \Macro{subparagraph}. Function and meaning\important[i]{\begin{tabular}[t]{@{}l@{}}
- \Option{headings=}\\\quad\PValue{optiontohead}\end{tabular}\\
+optional argument of the structural commands \DescRef{\LabelBase.cmd.part}, \DescRef{\LabelBase.cmd.chapter},
+etc., down to \DescRef{\LabelBase.cmd.subparagraph}. Function and
+meaning\important[i]{%
+ \begin{tabular}[t]{@{}l@{}}
+ \Option{headings=}\\\quad\PValue{optiontohead}
+ \end{tabular}\\
\OptionValue{headings}{optiontotoc}\\
\begin{tabular}[t]{@{}l@{}}
- \Option{headings=}\\\quad\PValue{optiontoheadandtoc}\end{tabular}} may be
-influenced by the options \OptionValue{headings}{optiontohead}%
+ \Option{headings=}\\\quad\PValue{optiontoheadandtoc}
+ \end{tabular}%
+} may be influenced by the options \OptionValue{headings}{optiontohead}%
\IndexOption{headings~=\PValue{optiontohead}},
\OptionValue{headings}{optiontotoc}\IndexOption{headings~=\PValue{optiontotoc}},
and \OptionValue{headings}{optiontoheadandtoc}%
\IndexOption{headings~=\PValue{optiontoheadandtoc}}.
-A summary of all the available selections of option \Option{headings} may be found in \autoref{tab:maincls.headings}. Examples are at the following
+A summary of all the available selections of option \Option{headings} may be
+found in \autoref{tab:\LabelBase.headings}. Examples are at the following
description of the structural commands.
\begin{desclist}
@@ -1310,7 +1296,7 @@ description of the structural commands.
\desccaption[{Available values for option \Option{headings}}]{%
Available values for option \Option{headings} to select different kinds of
structural headings%
- \label{tab:maincls.headings}%
+ \label{tab:\LabelBase.headings}%
}{%
Available values for option \Option{headings} (\emph{continuation})%
}%
@@ -1331,33 +1317,42 @@ description of the structural commands.
Chapter headings will be set like other headings too.%
}%
\pventry{openany}{%
- The commands \Macro{cleardoublepageusingstyle},
- \Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage},
- \Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} behave same like
- using \OptionValue{headings}{openright}.%
- Parts, chapter, index, and back matter use \Macro{clearpage} instead of
- \Macro{cleardoublepage}.%
+ The commands \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+ \DescRef{\LabelBase.cmd.cleardoublestandardpage},
+ \DescRef{\LabelBase.cmd.cleardoubleplainpage},
+ \DescRef{\LabelBase.cmd.cleardoubleemptypage}, and
+ \DescRef{\LabelBase.cmd.cleardoublepage} behave same like using
+ \OptionValue{headings}{openright}.%
+ Parts, chapter, index, and back matter use
+ \DescRef{\LabelBase.cmd.clearpage} instead of
+ \DescRef{\LabelBase.cmd.cleardoublepage}.%
\IndexOption{headings~=\PValue{openany}}}%
\pventry{openleft}{%
- The commands \Macro{cleardoublepageusingstyle},
- \Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage},
- \Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} generate a page
- break and if needed insert an interleaf page to reach the next left-hand
- page at double-page printing.%
- Part, chapter, index and back matter use \Macro{cleardoublepage}.%
+ The commands \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+ \DescRef{\LabelBase.cmd.cleardoublestandardpage},
+ \DescRef{\LabelBase.cmd.cleardoubleplainpage},
+ \DescRef{\LabelBase.cmd.cleardoubleemptypage}, and
+ \DescRef{\LabelBase.cmd.cleardoublepage} generate a page break and if
+ needed insert an interleaf page to reach the next left-hand page at
+ double-page printing.%
+ Part, chapter, index and back matter use
+ \DescRef{\LabelBase.cmd.cleardoublepage}.%
\IndexOption{headings~=\PValue{openleft}}}%
\pventry{openright}{%
- The commands \Macro{cleardoublepageusingstyle},
- \Macro{cleardoublestandardpage}, \Macro{cleardoubleplainpage},
- \Macro{cleardoubleemptypage}, and \Macro{cleardoublepage} generate a page
- break and if needed insert an interleaf page to reach the next right-hand
- page at double-page printing.%
- Part, chapter, index and back matter use \Macro{cleardoublepage}.%
+ The commands \DescRef{\LabelBase.cmd.cleardoublepageusingstyle},
+ \DescRef{\LabelBase.cmd.cleardoublestandardpage},
+ \DescRef{\LabelBase.cmd.cleardoubleplainpage},
+ \DescRef{\LabelBase.cmd.cleardoubleemptypage}, and
+ \DescRef{\LabelBase.cmd.cleardoublepage} generate a page break and if
+ needed insert an interleaf page to reach the next right-hand page at
+ double-page printing.%
+ Part, chapter, index and back matter use
+ \DescRef{\LabelBase.cmd.cleardoublepage}.%
\IndexOption{headings~=\PValue{openright}}}%
\pventry{optiontohead}{%
The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} advanced functionality of the optional argument of the
- structural commands \Macro{part} down to \Macro{subparagraph} will be
+ structural commands \DescRef{\LabelBase.cmd.part} down to \DescRef{\LabelBase.cmd.subparagraph} will be
activated. By default the optional argument will be used for the running
head only.%
\IndexOption{headings~=\PValue{optiontohead}}%
@@ -1366,14 +1361,14 @@ description of the structural commands.
\IndexOption{headings~=\PValue{optiontoheadandtoc}}}{%
The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} advanced functionality of the optional argument of the
- structural commands \Macro{part} down to \Macro{subparagraph} will be
+ structural commands \DescRef{\LabelBase.cmd.part} down to \DescRef{\LabelBase.cmd.subparagraph} will be
activated. By default the optional argument will be used for the running
head and the table of contents.%
}%
\pventry{optiontotoc}{%
The\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} advanced functionality of the optional argument of the
- structural commands \Macro{part} down to \Macro{subparagraph} will be
+ structural commands \DescRef{\LabelBase.cmd.part} down to \DescRef{\LabelBase.cmd.subparagraph} will be
activated. By default the optional argument will be used for the table of
contents only.%
\IndexOption{headings~=\PValue{optiontohead}}%
@@ -1385,22 +1380,22 @@ description of the structural commands.
\PValue{appendixwithprefix}, \PValue{appendixwithprefixline}%
\IndexOption{headings~=\PValue{twolineappendix}}}{%
Chapters at the appendix will be set with a number line with the contents
- of \Macro{chapterformat}\IndexCmd{chapterformat}.%
+ of \DescRef{\LabelBase.cmd.chapterformat}\IndexCmd{chapterformat}.%
}%
\entry{\PValue{twolinechapter}, \PValue{chapterprefix},
\PValue{chapterwithprefix}, \PValue{chapterwithprefixline}%
\IndexOption{headings~=\PValue{twolinechapter}}}{%
Chapters will be set with a number line with the contents of
- \Macro{chapterformat}\IndexCmd{chapterformat}.%
+ \DescRef{\LabelBase.cmd.chapterformat}\IndexCmd{chapterformat}.%
}%
\end{desclist}
%
-\EndIndex{Option}{headings~=\PName{selection}}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{numbers}{selection}
+ \OptionVName{numbers}{selection}
\end{Declaration}%
-\BeginIndex{Option}{numbers~=\PName{selection}}%
\begin{Explain}%
In German, according to {\small DUDEN}, the numbering of sectional
units should have no period at the end if only arabic numbers are used
@@ -1409,7 +1404,7 @@ description of the structural commands.
end of the numbering (see \cite[R\,4]{DUDEN}). {\KOMAScript} has an
internal mechanism that tries to implement this somewhat complex
rule. The resulting effect is that, normally, after the sectional
- commands \Macro{part} and \Macro{appendix} a switch is made to
+ commands \DescRef{\LabelBase.cmd.part} and \DescRef{\LabelBase.cmd.appendix} a switch is made to
numbering with an ending period. The information is saved in the
\File{aux} file and takes effect on the next {\LaTeX} run.
\end{Explain}
@@ -1432,7 +1427,7 @@ control the numbering format, a further run without changing any options
should be made.
The\textnote{Attention!} available values are summarized in
-\autoref{tab:maincls.numbers}. Unlike most other selections, this
+\autoref{tab:\LabelBase.numbers}. Unlike most other selections, this
option may be changed at the document preamble, before
\Macro{begin}\PParameter{document}, only.
@@ -1440,7 +1435,7 @@ option may be changed at the document preamble, before
\caption[{Available values of option \Option{numbers}}]{Available values of
option \Option{numbers} for selection of the period at the end of numbers
of structural headings}
- \label{tab:maincls.numbers}
+ \label{tab:\LabelBase.numbers}
\begin{desctabular}
\entry{\PValue{autoendperiod}, \PValue{autoenddot}, \PValue{auto}}{%
\KOMAScript{} decides, whether or not to set the period at the end of
@@ -1462,27 +1457,26 @@ option may be changed at the document preamble, before
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{numbers~=\PName{selection}}%
+\EndIndexGroup
+
\begin{Declaration}
- \Option{chapteratlists}\\
- \XOption{chapteratlists}=\PName{value}
+ \Option{chapteratlists}%
+ \OptionVName{chapteratlists}{value}
\end{Declaration}%
-\BeginIndex{Option}{chapteratlists}%
-\BeginIndex{Option}{chapteratlists~=\PName{value}}%
-As mentioned in \autoref{sec:maincls.floats},
-\autopageref{desc:maincls.option.listof}\OnlyAt{\Class{scrbook}\and
+As mentioned in \autoref{sec:\LabelBase.floats},
+\DescPageRef{\LabelBase.option.listof}\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}}, normally, every chapter entry generated with
-\Macro{chapter} introduces vertical spacing into the lists of floats. Since
+\DescRef{\LabelBase.cmd.chapter} introduces vertical spacing into the lists of floats. Since
version~2.96a\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}} this
-applies also for the command \Macro{addchap}, if no compatibility option to an
-earlier version was chosen (see option \Option{version} in
-\autoref{sec:maincls.compatibilityOptions},
-\autopageref{desc:maincls.option.version}).
+applies also for the command \DescRef{\LabelBase.cmd.addchap}, if no compatibility option to an
+earlier version was chosen (see option \DescRef{\LabelBase.option.version} in
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}).
Furthermore, now the option \Option{chapteratlists} can be used to change the
spacing, by passing the desired distance as \PName{value}. The default setting
-with \OptionValue{listof}{chaptergapsmall}%
+with \OptionValueRef{\LabelBase}{listof}{chaptergapsmall}%
\IndexOption{listof~=\PValue{chaptergapsmall}} %
is 10\,pt. If \OptionValue{chapteratlists}{entry}%
\IndexOption{chapteratlists~=\PValue{entry}}%
@@ -1494,26 +1488,21 @@ there's no floating environment inside of the chapter.
Please\textnote{Attention!} note that changes to the option will only become
effective in the lists following two more {\LaTeX} runs.%
%
-\EndIndex{Option}{chapteratlists~=\PName{value}}%
-\EndIndex{Option}{chapteratlists}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{part}\OParameter{short version}\Parameter{heading}\\
- \Macro{chapter}\OParameter{short version}\Parameter{heading}\\
- \Macro{section}\OParameter{short version}\Parameter{heading}\\
- \Macro{subsection}\OParameter{short version}\Parameter{heading}\\
- \Macro{subsubsection}\OParameter{short version}\Parameter{heading}\\
- \Macro{paragraph}\OParameter{short version}\Parameter{heading}\\
+ \Macro{part}\OParameter{short version}\Parameter{heading}%
+ \Macro{chapter}\OParameter{short version}\Parameter{heading}%
+ \Macro{section}\OParameter{short version}\Parameter{heading}%
+ \Macro{subsection}\OParameter{short version}\Parameter{heading}%
+ \Macro{subsubsection}\OParameter{short version}\Parameter{heading}%
+ \Macro{paragraph}\OParameter{short version}\Parameter{heading}%
\Macro{subparagraph}\OParameter{short version}\Parameter{heading}
\end{Declaration}%
-\BeginIndex{Cmd}{part}\Index[indexmain]{part}%
-\BeginIndex{Cmd}{chapter}\Index[indexmain]{chapter}%
-\BeginIndex{Cmd}{section}\Index[indexmain]{section}%
-\BeginIndex{Cmd}{subsection}%
-\BeginIndex{Cmd}{subsubsection}%
-\BeginIndex{Cmd}{paragraph}%
-\BeginIndex{Cmd}{subparagraph}%
+\Index[indexmain]{part}%
+\Index[indexmain]{chapter}%
+\Index[indexmain]{section}%
The standard sectioning commands in {\KOMAScript} work in a similar
fashion to those of the standard classes. Thus, an alternative entry
for the table of contents and running headings can be specified as an
@@ -1521,22 +1510,22 @@ optional argument to the sectioning commands.
In addition to this, with\ChangedAt{v3.10}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}\textnote{\KOMAScript{} vs. standard
- classes} option \important{\Option{headings}}
-\OptionValue{headings}{optiontohead}%
+ classes} option \important{\DescRef{\LabelBase.option.headings}}
+\OptionValueRef{\LabelBase}{headings}{optiontohead}%
\IndexOption[indexmain]{headings~=\PValue{optiontohead}}, \KOMAScript{}
does not use
the optional argument \PName{short version} at the table of
contents, but for the running head only. Nevertheless, such a running head
-needs an appropriate page style. See \autoref{sec:maincls.pagestyle} and
+needs an appropriate page style. See \autoref{sec:\LabelBase.pagestyle} and
\autoref{cha:scrlayer-scrpage} about this. With option
-\OptionValue{headings}{optiontotoc}%
+\OptionValueRef{\LabelBase}{headings}{optiontotoc}%
\IndexOption[indexmain]{headings~=\PValue{optiontotoc}}, \KOMAScript{} does not
use the
optional argument \PName{short version} for the running head, but
at the table of contents. Nevertheless, the entry will be shown only if
-counter \Counter{tocdepth} (see \autoref{sec:maincls.toc},
-\autopageref{desc:maincls.counter.tocdepth}) is great enough. With option
-\OptionValue{headings}{optiontoheadandtoc}%
+counter \DescRef{\LabelBase.counter.tocdepth} (see \autoref{sec:\LabelBase.toc},
+\DescPageRef{\LabelBase.counter.tocdepth}) is great enough. With option
+\OptionValueRef{\LabelBase}{headings}{optiontoheadandtoc}%
\IndexOption[indexmain]{headings~=\PValue{optiontoheadandtoc}}, \KOMAScript{}
uses the optional argument \PName{short version} in both the table of contents
and running head. All these three selections will also activate the extended
@@ -1548,8 +1537,8 @@ The \ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
determines whether there's an equality sign in
\PName{short version}. If so, the optional argument will be interpreted as
\PName{option list} instead of simple \PName{short version}. Thereby the two
-options \KOption{head}\PName{running head}\important{\Option{head}} and
-\KOption{tocentry}\PName{table of contents entry} are supported. Commas or
+options \OptionVName{head}{running head}\important{\Option{head}} and
+\OptionVName{tocentry}{table of contents entry} are supported. Commas or
equality signs inside of the values of those options will be accepted only if
they are enclosed by braces.
@@ -1604,7 +1593,7 @@ you may use an invisible entry like \lstinline|\mbox{}| instead.
The recommendation of the braces in the example above will make more sense
with one more example. Assume you're using option
- \OptionValue{headings}{optiontotoc} and now have a heading:
+ \OptionValueRef{\LabelBase}{headings}{optiontotoc} and now have a heading:
\begin{lstcode}
\section[head=\emph{value}]
{Option head=\emph{value}}
@@ -1618,8 +1607,8 @@ you may use an invisible entry like \lstinline|\mbox{}| instead.
{Option head=\emph{value}}
\end{lstcode}
- A similar case would be a comma. With the same \Option{headings} option like
- before:
+ A similar case would be a comma. With the same
+ \DescRef{\LabelBase.option.headings} option like before:
\begin{lstcode}
\section[head=0, 1, 2, 3, \dots]
{Natural Numbers Including the Zero}
@@ -1643,7 +1632,7 @@ consecutively over all parts. Furthermore, for classes
\Class{scrbook}\OnlyAt{\Class{scrbook}\and \Class{scrreprt}} and
\Class{scrreprt}, the title of the part level together with the corresponding
preamble (see \Macro{setpartpreamble},
-\autopageref{desc:maincls.cmd.setpartpreamble}) is set on a separate page.
+\DescPageRef{\LabelBase.cmd.setpartpreamble}) is set on a separate page.
\Macro{chapter}\important{\Macro{chapter}}\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}} only exists in book or report classes, that is, in classes
@@ -1653,47 +1642,57 @@ this, the command \Macro{chapter} in {\KOMAScript} differs substantially from
the version in the standard class. In the standard classes the chapter number
is used together with the prefix ``Chapter'', or the corresponding word in the
appropriate language, on a separate line above the actual chapter title
-text. This overpowering\important[i]{\Option{chapterprefix}\\
- \Option{appendixprefix}} style is replaced in {\KOMAScript} by a simple
+text. This overpowering\important[i]{\DescRef{\LabelBase.option.chapterprefix}\\
+ \DescRef{\LabelBase.option.appendixprefix}} style is replaced in {\KOMAScript} by a simple
chapter number before the chapter heading text, but can be reverted by the
-option \Option{chapterprefix} (see
-\autopageref{desc:maincls.option.chapterprefix}).
+option \DescRef{\LabelBase.option.chapterprefix} (see
+\DescPageRef{\LabelBase.option.chapterprefix}).
Please\textnote{Attention!} note that \Macro{part} and \Macro{chapter} in
classes \Class{scrbook} and \Class{scrreprt}
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} change the page style for one
page. The applied page style in {\KOMAScript} is defined in the macros
-\Macro{partpagestyle} and \Macro{chapterpagestyle} (see
-\autoref{sec:maincls.pagestyle},
-\autopageref{desc:maincls.cmd.titlepagestyle}).
+\DescRef{\LabelBase.cmd.partpagestyle} and \DescRef{\LabelBase.cmd.chapterpagestyle} (see
+\autoref{sec:\LabelBase.pagestyle},
+\DescPageRef{\LabelBase.cmd.titlepagestyle}).
\BeginIndex[indexother]{}{font}%
\BeginIndex[indexother]{}{font>style}%
\BeginIndex[indexother]{}{font>size}%
+\BeginIndex{FontElement}{part}\LabelFontElement{part}%
+\BeginIndex{FontElement}{partnumber}\LabelFontElement{partnumber}%
+\BeginIndex{FontElement}{chapter}\LabelFontElement{chapter}%
+\BeginIndex{FontElement}{section}\LabelFontElement{section}%
+\BeginIndex{FontElement}{subsection}\LabelFontElement{subsection}%
+\BeginIndex{FontElement}{subsubsection}\LabelFontElement{subsubsection}%
+\BeginIndex{FontElement}{paragraph}\LabelFontElement{paragraph}%
+\BeginIndex{FontElement}{subparagraph}\LabelFontElement{subparagraph}%
+\BeginIndex{FontElement}{disposition}\LabelFontElement{disposition}%
The font of all headings\ChangedAt{v2.8p}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} can be changed with the commands
-\Macro{setkomafont}\IndexCmd{setkomafont} and
-\Macro{addtokomafont}\IndexCmd{addtokomafont} (see
-\autoref{sec:maincls.textmarkup},
-\autopageref{desc:maincls.cmd.setkomafont}). In doing this, generally the
-element \FontElement{disposition}\IndexFontElement{disposition}%
-\important{\FontElement{disposition}} is used, followed by a specific
-element\important[s]{%
+\DescRef{\LabelBase.cmd.setkomafont}\IndexCmd{setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont}\IndexCmd{addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). In doing this, generally the
+element \FontElement{disposition}\important{\FontElement{disposition}} is
+used, followed by a specific element\important[s]{%
\FontElement{part}\\
\FontElement{chapter}\\
\FontElement{section}\\
\FontElement{subsection}\\
\FontElement{paragraph}\\
\FontElement{subparagraph}} for every section level (see
-\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). The font for the element
-\FontElement{disposition}\IndexFontElement{disposition} is predefined as
+\autoref{tab:\LabelBase.fontelements},
+\autopageref{tab:\LabelBase.fontelements}). There is a separate element
+\FontElement{partnumber} for the number part of parts. The font for the
+element \FontElement{disposition} is predefined as
\Macro{normalcolor}\linebreak[2]\Macro{sffamily}\linebreak[2]\Macro{bfseries}.
The default font size for the specific elements depends on the options
-\OptionValue{headings}{big}, \OptionValue{headings}{normal} and
-\OptionValue{headings}{small} (see
-\autopageref{desc:maincls.option.headings}). The defaults are listed in
-\autoref{tab:maincls.structureElementsFont}.
+\OptionValueRef{\LabelBase}{headings}{big},
+\OptionValueRef{\LabelBase}{headings}{normal} and
+\OptionValueRef{\LabelBase}{headings}{small} (see
+\DescPageRef{\LabelBase.option.headings}). The defaults are listed in
+\autoref{tab:\LabelBase.structureElementsFont}.
%
\begin{table}
% \centering%
@@ -1707,52 +1706,55 @@ The default font size for the specific elements depends on the options
\toprule
Class Option & Element & Default\\
\midrule
- \OptionValue{headings}{big}
- & \FontElement{part}\IndexFontElement{part}
+ \OptionValueRef{\LabelBase}{headings}{big}
+ & \DescRef{\LabelBase.fontelement.part}\IndexFontElement{part}
& \Macro{Huge} \\
- & \FontElement{partnumber}\IndexFontElement{partnumber}
+ & \DescRef{\LabelBase.fontelement.partnumber}%
+ \IndexFontElement{partnumber}
& \Macro{huge} \\
- & \FontElement{chapter}\IndexFontElement{chapter}
+ & \DescRef{\LabelBase.fontelement.chapter}\IndexFontElement{chapter}
& \Macro{huge} \\
- & \FontElement{section}\IndexFontElement{section}
+ & \DescRef{\LabelBase.fontelement.section}\IndexFontElement{section}
& \Macro{Large} \\
- & \FontElement{subsection}\IndexFontElement{subsection}
+ & \DescRef{\LabelBase.fontelement.subsection}%
+ \IndexFontElement{subsection}
& \Macro{large} \\
- & \FontElement{subsubsection}%
+ & \DescRef{\LabelBase.fontelement.subsubsection}%
\IndexFontElement{subsubsection}
& \Macro{normalsize} \\
- & \FontElement{paragraph}\IndexFontElement{paragraph}
+ & \DescRef{\LabelBase.fontelement.paragraph}\IndexFontElement{paragraph}
& \Macro{normalsize} \\
- & \FontElement{subparagraph}\IndexFontElement{subparagraph}
+ & \DescRef{\LabelBase.fontelement.subparagraph}%
+ \IndexFontElement{subparagraph}
& \Macro{normalsize} \\[1ex]
- \OptionValue{headings}{normal}
- & \FontElement{part} & \Macro{huge} \\
- & \FontElement{partnumber} & \Macro{huge} \\
- & \FontElement{chapter} & \Macro{LARGE} \\
- & \FontElement{section} & \Macro{Large} \\
- & \FontElement{subsection} & \Macro{large} \\
- & \FontElement{subsubsection} & \Macro{normalsize} \\
- & \FontElement{paragraph} & \Macro{normalsize} \\
- & \FontElement{subparagraph} & \Macro{normalsize} \\[1ex]
- \OptionValue{headings}{small}
- & \FontElement{part} & \Macro{LARGE} \\
- & \FontElement{partnumber} & \Macro{LARGE} \\
- & \FontElement{chapter} & \Macro{Large} \\
- & \FontElement{section} & \Macro{large} \\
- & \FontElement{subsection} & \Macro{normalsize} \\
- & \FontElement{subsubsection} & \Macro{normalsize} \\
- & \FontElement{paragraph} & \Macro{normalsize} \\
- & \FontElement{subparagraph} & \Macro{normalsize}\\
+ \OptionValueRef{\LabelBase}{headings}{normal}
+ & \DescRef{\LabelBase.fontelement.part} & \Macro{huge} \\
+ & \DescRef{\LabelBase.fontelement.partnumber} & \Macro{huge} \\
+ & \DescRef{\LabelBase.fontelement.chapter} & \Macro{LARGE} \\
+ & \DescRef{\LabelBase.fontelement.section} & \Macro{Large} \\
+ & \DescRef{\LabelBase.fontelement.subsection} & \Macro{large} \\
+ & \DescRef{\LabelBase.fontelement.subsubsection} & \Macro{normalsize} \\
+ & \DescRef{\LabelBase.fontelement.paragraph} & \Macro{normalsize} \\
+ & \DescRef{\LabelBase.fontelement.subparagraph} & \Macro{normalsize} \\[1ex]
+ \OptionValueRef{\LabelBase}{headings}{small}
+ & \DescRef{\LabelBase.fontelement.part} & \Macro{LARGE} \\
+ & \DescRef{\LabelBase.fontelement.partnumber} & \Macro{LARGE} \\
+ & \DescRef{\LabelBase.fontelement.chapter} & \Macro{Large} \\
+ & \DescRef{\LabelBase.fontelement.section} & \Macro{large} \\
+ & \DescRef{\LabelBase.fontelement.subsection} & \Macro{normalsize} \\
+ & \DescRef{\LabelBase.fontelement.subsubsection} & \Macro{normalsize} \\
+ & \DescRef{\LabelBase.fontelement.paragraph} & \Macro{normalsize} \\
+ & \DescRef{\LabelBase.fontelement.subparagraph} & \Macro{normalsize}\\
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:maincls.structureElementsFont}
+ \label{tab:\LabelBase.structureElementsFont}
\end{table}
\begin{Example}
- Suppose you are using the class option \OptionValue{headings}{big} and
- notice that the very big headings of document parts are too
- bold. You could change this as follows:
+ Suppose you are using the class option
+ \OptionValueRef{\LabelBase}{headings}{big} and notice that the very big
+ headings of document parts are too bold. You could change this as follows:
\begin{lstcode}
\setkomafont{disposition}{\normalcolor\sffamily}
\part{Appendices}
@@ -1771,8 +1773,8 @@ This is done either by:
\addtokomafont{part}{\mdseries}
\addtokomafont{partnumber}{\mdseries}
\end{lstcode}
-The last version is to be preferred because it gives you the correct
-result even when you make changes to the \FontElement{disposition}
+The last version is to be preferred because it gives you the correct result
+even when you make changes to the \DescRef{\LabelBase.fontelement.disposition}
element\IndexFontElement{disposition}, for instance:
\begin{lstcode}
\setkomafont{disposition}{\normalcolor\bfseries}
@@ -1807,43 +1809,28 @@ to the following explanation.
sans serif is the carefully chosen default in {\KOMAScript}.
More variety should, however, be avoided. Font mixing is only for
- professionals. In case you want to use other fonts than the standard
- {\TeX} fonts\,---\,regardless of whether these are CM\Index{CM
- fonts}, EC\Index{EC fonts}, or LM fonts\Index{LM fonts}\,---\,you
- should consult an expert, or for safety's sake redefine the font for
- the element \FontElement{disposition}\IndexFontElement{disposition}
- as seen in the example above. The author of this documentation
- considers the commonly encountered combinations Times and Helvetica
- or Palatino with Helvetica as unfavourable.
+ professionals. In case you want to use other fonts than the standard {\TeX}
+ fonts\,---\,regardless of whether these are CM\Index{CM fonts}, EC\Index{EC
+ fonts}, or LM fonts\Index{LM fonts}\,---\,you should consult an expert, or
+ for safety's sake redefine the font for the element
+ \DescRef{\LabelBase.fontelement.disposition}\IndexFontElement{disposition}
+ as seen in the example above. The author of this documentation considers the
+ commonly encountered combinations Times and Helvetica or Palatino with
+ Helvetica as unfavourable.
\end{Explain}
-\EndIndex[indexother]{}{font>style}%
-\EndIndex[indexother]{}{font}%
-\EndIndex[indexother]{}{font>size}%
%
-\EndIndex{Cmd}{part}%
-\EndIndex{Cmd}{chapter}%
-\EndIndex{Cmd}{section}%
-\EndIndex{Cmd}{subsection}%
-\EndIndex{Cmd}{subsubsection}%
-\EndIndex{Cmd}{paragraph}%
-\EndIndex{Cmd}{subparagraph}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{part*}\Parameter{Heading}\\
- \Macro{chapter*}\Parameter{Heading}\\
- \Macro{section*}\Parameter{Heading}\\
- \Macro{subsection*}\Parameter{Heading}\\
- \Macro{subsubsection*}\Parameter{Heading}\\
- \Macro{paragraph*}\Parameter{Heading}\\
+ \Macro{part*}\Parameter{Heading}%
+ \Macro{chapter*}\Parameter{Heading}%
+ \Macro{section*}\Parameter{Heading}%
+ \Macro{subsection*}\Parameter{Heading}%
+ \Macro{subsubsection*}\Parameter{Heading}%
+ \Macro{paragraph*}\Parameter{Heading}%
\Macro{subparagraph*}\Parameter{Heading}
\end{Declaration}%
-\BeginIndex{Cmd}{part*}%
-\BeginIndex{Cmd}{chapter*}%
-\BeginIndex{Cmd}{section*}%
-\BeginIndex{Cmd}{subsection*}%
-\BeginIndex{Cmd}{subsubsection*}%
-\BeginIndex{Cmd}{paragraph*}%
-\BeginIndex{Cmd}{subparagraph*}%
All disposition commands have starred versions, which are
unnumbered\Index{numbering}, and produce section headings which do not
show up in the table of contents\Index{table>of contents}\Index{contents>table
@@ -1858,11 +1845,11 @@ only exists in book and report classes, that is, \Class{book},
\Class{scrbook}, \Class{report} and \Class{scrreport}, but not the
article classes \Class{article} and \Class{scrartcl}.
-Please\textnote{Attention!} note that \Macro{part} and \Macro{chapter} change
+Please\textnote{Attention!} note that \DescRef{\LabelBase.cmd.part} and \DescRef{\LabelBase.cmd.chapter} change
the page style for one page. The applied style is defined in the macros
-\Macro{partpagestyle} and \Macro{chapterpagestyle} in {\KOMAScript} (see
-\autoref{sec:maincls.pagestyle},
-\autopageref{desc:maincls.cmd.titlepagestyle}).
+\DescRef{\LabelBase.cmd.partpagestyle} and
+\DescRef{\LabelBase.cmd.chapterpagestyle} in {\KOMAScript} (see
+\autoref{sec:\LabelBase.pagestyle}, \DescPageRef{\LabelBase.cmd.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
@@ -1870,13 +1857,8 @@ the same explanations apply as were given above for the unstarred
variants. The structuring elements are named the same since they do
not indicate variants but structuring levels.%
%
-\EndIndex{Cmd}{part*}%
-\EndIndex{Cmd}{chapter*}%
-\EndIndex{Cmd}{section*}%
-\EndIndex{Cmd}{subsection*}%
-\EndIndex{Cmd}{subsubsection*}%
-\EndIndex{Cmd}{paragraph*}%
-\EndIndex{Cmd}{subparagraph*}%
+\EndIndexGroup
+
\iftrue% Umbruchkorrekturtext
In the standard classes\textnote{\KOMAScript{} vs. standard classes} there are
@@ -1886,27 +1868,21 @@ contents and in the running heading.%
\fi
\begin{Declaration}
- \Macro{addpart}\OParameter{Short version}\Parameter{Heading}\\
- \Macro{addpart*}\Parameter{Heading}\\
- \Macro{addchap}\OParameter{Short version}\Parameter{Heading}\\
- \Macro{addchap*}\Parameter{Heading}\\
- \Macro{addsec}\OParameter{Short version}\Parameter{Heading}\\
+ \Macro{addpart}\OParameter{Short version}\Parameter{Heading}%
+ \Macro{addpart*}\Parameter{Heading}%
+ \Macro{addchap}\OParameter{Short version}\Parameter{Heading}%
+ \Macro{addchap*}\Parameter{Heading}%
+ \Macro{addsec}\OParameter{Short version}\Parameter{Heading}%
\Macro{addsec*}\Parameter{Heading}\textnote[n]{\KOMAScript{} vs. standard classes}
\end{Declaration}%
-\BeginIndex{Cmd}{addpart}%
-\BeginIndex{Cmd}{addpart*}%
-\BeginIndex{Cmd}{addchap}%
-\BeginIndex{Cmd}{addchap*}%
-\BeginIndex{Cmd}{addsec}%
-\BeginIndex{Cmd}{addsec*}%
In addition to the commands of the standard classes, {\KOMAScript}
offers the new commands \Macro{addsec} and \Macro{addchap}. They are
-similar to the standard commands \Macro{chapter} and
-\Macro{section}, except that they are unnumbered. They thus produce
+similar to the standard commands \DescRef{\LabelBase.cmd.chapter} and
+\DescRef{\LabelBase.cmd.section}, except that they are unnumbered. They thus produce
both a running heading and an entry in the table of contents.
The starred variants \Macro{addchap*} and \Macro{addsec*} are similar to the
-standard commands \Macro{chapter*} and \Macro{section*} except for a tiny but
+standard commands \DescRef{\LabelBase.cmd.chapter*} and \DescRef{\LabelBase.cmd.section*} except for a tiny but
important difference: The running headings are deleted. This eliminates the
side effect of obsolete headers mentioned above. Instead, the running headings
on following pages remain empty. \OnlyAt{\Class{book}\and
@@ -1917,16 +1893,16 @@ in book and report classes, namely \Class{book}, \Class{scrbook},
Similarly, the command \Macro{addpart} produces an unnumbered document
part with an entry in the table of contents. Since the running
-headings are already deleted by \Macro{part} and \Macro{part*} the
+headings are already deleted by \DescRef{\LabelBase.cmd.part} and \DescRef{\LabelBase.cmd.part*} the
problem of obsolete headers does not exist. The starred version
-\Macro{addpart*} is thus identical to \Macro{part*} and is only
+\Macro{addpart*} is thus identical to \DescRef{\LabelBase.cmd.part*} and is only
defined for consistency reasons.
Please note\textnote{Attention!} that \Macro{addpart} and \Macro{addchap} and
their starred versions change the page style for one page. The particular page
-style is defined in the macros \Macro{partpagestyle} and
-\Macro{chapterpagestyle} (see \autoref{sec:maincls.pagestyle},
-\autopageref{desc:maincls.cmd.titlepagestyle}).
+style is defined in the macros \DescRef{\LabelBase.cmd.partpagestyle} and
+\DescRef{\LabelBase.cmd.chapterpagestyle} (see
+\autoref{sec:\LabelBase.pagestyle}, \DescPageRef{\LabelBase.cmd.chapterpagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
@@ -1934,18 +1910,12 @@ the same explanations apply as given above for the normal structuring
commands. The elements are named the same since they describe not
variants but structuring levels.%
%
-\EndIndex{Cmd}{addpart}%
-\EndIndex{Cmd}{addpart*}%
-\EndIndex{Cmd}{addchap}%
-\EndIndex{Cmd}{addchap*}%
-\EndIndex{Cmd}{addsec}%
-\EndIndex{Cmd}{addsec*}%
+\EndIndexGroup
\begin{Declaration}
\Macro{minisec}\Parameter{Heading}
\end{Declaration}%
-\BeginIndex{Cmd}{minisec}%
Sometimes a heading\Index{heading} is wanted which is highlighted but
also closely linked to the following text. Such a heading should not
be separated by a large vertical skip.
@@ -1955,18 +1925,17 @@ heading is not associated with any structuring level. Such a
\emph{mini section} does not produce an entry in the table of contents
nor does it receive any numbering.
-\BeginIndex{FontElement}{minisec}%
-\BeginIndex{FontElement}{disposition}%
+\BeginIndex{FontElement}{minisec}\LabelFontElement{minisec}%
The font type of the structuring command \Macro{minisec} can be changed using
-the element \FontElement{disposition}\IndexFontElement{disposition} (see
-\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}) and
+the element
+\DescRef{\LabelBase.fontelement.disposition}\IndexFontElement{disposition}
+(see \autoref{tab:\LabelBase.fontelements},
+\autopageref{tab:\LabelBase.fontelements}) and
\FontElement{minisec}\ChangedAt{v2.96a}{%
\Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}}. Default setting
of element \FontElement{minisec} is empty, so the default of the element
-\FontElement{disposition} is active.
-%
-\EndIndex{FontElement}{disposition}%
+\DescRef{\LabelBase.fontelement.disposition}\IndexFontElement{disposition} is
+active.%
\EndIndex{FontElement}{minisec}%
\begin{Example}
@@ -2026,23 +1995,21 @@ of element \FontElement{minisec} is empty, so the default of the element
\end{ShowOutput}
\end{Example}
%
-\EndIndex{Cmd}{minisec}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{raggedsection}\\
- \Macro{raggedchapter}\\
+ \Macro{raggedsection}%
+ \Macro{raggedchapter}%
\Macro{raggedpart}
\end{Declaration}%
-\BeginIndex{Cmd}{raggedsection}%
-\BeginIndex{Cmd}{raggedchapter}%
-\BeginIndex{Cmd}{raggedpart}%
In the standard classes\textnote{\KOMAScript{} vs. standard classes}, headings
are set as justified text. That means that hyphenated words can occur and
headings with more than one line are stretched up to the text border. This is
a rather uncommon approach in typography. {\KOMAScript} therefore formats the
headings left aligned with hanging indentation using \Macro{raggedsection}
with the definition:
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\newcommand*{\raggedsection}{\raggedright}
\end{lstcode}
This command can be redefined with \Macro{renewcommand}.
@@ -2058,26 +2025,27 @@ This command can be redefined with \Macro{renewcommand}.
You will get a formatting of the headings which is very close to that
of the standard classes. It will become even closer when you combine
this change with the change of the element
- \FontElement{disposition}\IndexFontElement{disposition} mentioned
- above.
+ \DescRef{\LabelBase.fontelement.disposition}\IndexFontElement{disposition}
+ mentioned above.
\end{Example}
Because\ChangedAt{v3.15}{\Class{scrbook}\and \Class{scrreprt}} some users want
-for \Macro{chapter} another alignment than for all other sections, you can
-change only \Macro{chapter} redefining \Macro{raggedchapter}. The default of
-this command is usage of \Macro{raggedsection}. So every change of
-\Macro{raggedsection} will also change the alignment of chapter headings.
-
-Unlike all others, the headings of parts (\Macro{part}) will be
-horizontally centered instead of set ragged right. This is because command
+for \DescRef{\LabelBase.cmd.chapter} another alignment than for all other
+sections, you can change only \DescRef{\LabelBase.cmd.chapter} redefining
+\Macro{raggedchapter}. The default of this command is usage of
+\Macro{raggedsection}. So every change of \Macro{raggedsection} will also
+change the alignment of chapter headings.
+
+Unlike all others, the headings of parts (\DescRef{\LabelBase.cmd.part}) will
+be horizontally centered instead of set ragged right. This is because command
\Macro{raggedpart} is defined as
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\let\raggedpart\centering
\end{lstcode}
You may also redefine this using \Macro{renewcommand} too.
\begin{Example}
- You do not want different alignment at headings of \Macro{part}. So you
- put
+ You do not want different alignment at headings of
+ \DescRef{\LabelBase.cmd.part}. So you put
\begin{lstcode}
\renewcommand*{\raggedpart}{\raggedsection}
\end{lstcode}
@@ -2091,34 +2059,25 @@ You may also redefine this using \Macro{renewcommand} too.
\Macro{raggedpart} will be used.
\end{Example}%
%
-\EndIndex{Cmd}{raggedpart}%
-\BeginIndex{Cmd}{raggedchapter}%
-\EndIndex{Cmd}{raggedsection}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{partformat}\\
- \Macro{chapterformat}\\
- \Macro{sectionformat}\\
- \Macro{subsectionformat}\\
- \Macro{subsubsectionformat}\\
- \Macro{paragraphformat}\\
- \Macro{subparagraphformat}\\
+ \Macro{partformat}%
+ \Macro{chapterformat}%
+ \Macro{sectionformat}%
+ \Macro{subsectionformat}%
+ \Macro{subsubsectionformat}%
+ \Macro{paragraphformat}%
+ \Macro{subparagraphformat}%
\Macro{othersectionlevelsformat}\Parameter{sectioning
- name}\Parameter{}\Parameter{counter output}\\
- \Macro{IfUsePrefixLine}\Parameter{then code}\Parameter{else code}\\
+ name}\Parameter{}\Parameter{counter output}%
+ \Macro{IfUsePrefixLine}\Parameter{then code}\Parameter{else code}%
\Macro{autodot}
\end{Declaration}%
-\BeginIndex{Cmd}{partformat}\Index{part>number}%
-\BeginIndex{Cmd}{chapterformat}\Index{chapter>number}%
-\BeginIndex{Cmd}{sectionformat}%
-\BeginIndex{Cmd}{subsectionformat}%
-\BeginIndex{Cmd}{subsubsectionformat}%
-\BeginIndex{Cmd}{paragraphformat}%
-\BeginIndex{Cmd}{subparagraphformat}%
-\BeginIndex{Cmd}{othersectionlevelsformat}\Index{section>number}%
-\BeginIndex{Cmd}{IfUsePrefixLine}%
-\BeginIndex{Cmd}{autodot}%
+\Index{part>number}%
+\Index{chapter>number}%
+\Index{section>number}%
{\KOMAScript} has added a further logical level on top of
\Macro{the\PName{sectioning name}} to the output of the sectioning
numbers. The counters for the respective heading are not merely output. They
@@ -2129,12 +2088,12 @@ down to \Macro{subparagraphformat}\ChangedAt{v3.17}{\Class{scrbook}\and
\Macro{chapterformat} like \Macro{thechapter} does not exist in the class
\Class{scrartcl} but only in the classes \Class{scrbook} and \Class{scrreprt}.
-As described for option \Option{numbers}\important{\Option{numbers}} at the
-beginning of this section (see \autopageref{desc:maincls.option.numbers}),
+As described for option \DescRef{\LabelBase.option.numbers}\important{\DescRef{\LabelBase.option.numbers}} at the
+beginning of this section (see \DescPageRef{\LabelBase.option.numbers}),
periods in section numbers should be handled for the German-speaking region
according to the rules given in \cite{DUDEN}. The command \Macro{autodot} in
{\KOMAScript} ensures that these rules are followed. In all levels
-except for \Macro{part}, a dot is followed by a further \Macro{enskip}. This
+except for \DescRef{\LabelBase.cmd.part}, a dot is followed by a further \Macro{enskip}. This
corresponds to a horizontal skip of 0.5\Unit{em}.
Since \KOMAScript~3.17\ChangedAt{v3.17}{\Class{scrbook}\and
@@ -2144,8 +2103,9 @@ if the corresponding format command to a section command does not exist or is
\Macro{relax}. This should not happen for all section commands defined by
\KOMAScript{} itself. Therefore the command is not officially documented any
longer. Nevertheless, if a compatibility level prior to 3.17 (see option
-\Option{version}, \autoref{sec:maincls.compatibilityOptions},
-\autopageref{desc:maincls.option.version}) has been selected, commands
+\DescRef{\LabelBase.option.version},
+\autoref{sec:\LabelBase.compatibilityOptions},
+\DescPageRef{\LabelBase.option.version}) has been selected, commands
\Macro{sectionformat} down to \Macro{subparagraphformat} are ignored by
\KOMAScript{}. In this case \Macro{othersectionlevelsformat} indeed will be
used.
@@ -2167,7 +2127,7 @@ The definitions of the lower levels correspond to
Because\ChangedAt{v3.17}{\Class{scrbook}\and \Class{scrreprt}} of
\Macro{IfUsePrefixLine} command \Macro{chapterformat} should not be used
-outside of \Macro{chapter}. \Macro{IfUsePrefixLine} is only valid inside
+outside of \DescRef{\LabelBase.cmd.chapter}. \Macro{IfUsePrefixLine} is only valid inside
section commands of \KOMAScript{}. In this case, it executes the \PName{then
code} if a prefix line for the number is used, but \PName{else code}
otherwise.
@@ -2176,19 +2136,20 @@ Do\textnote{Attention!} not forget to change \Macro{newcommand} into
\Macro{renewcommand} if you like to re-define one of the commands.
\begin{Example}
- Assume that when using \Macro{part} you do not want the word
+ Assume that when using \DescRef{\LabelBase.cmd.part} you do not want the word
``Part'' written in front of the part number. You could use the
following command in the preamble of your document:
\begin{lstcode}
\renewcommand*{\partformat}{\thepart\autodot}
\end{lstcode}
Strictly speaking, you could do without \Macro{autodot} at this point and
- insert a fixed dot instead. As \Macro{part} is numbered with roman numerals,
+ insert a fixed dot instead. As \DescRef{\LabelBase.cmd.part} is numbered with roman numerals,
according to \cite{DUDEN} a period has to be applied. However, you thereby
give up the possibility to use one of the options
- \OptionValue{numbers}{endperiod} and \OptionValue{numbers}{noendperiod} and
- optionally depart from the rules. More details concerning class options can
- be found at \autopageref{desc:maincls.option.numbers}.
+ \OptionValueRef{\LabelBase}{numbers}{endperiod} and
+ \OptionValueRef{\LabelBase}{numbers}{noendperiod} and optionally depart from
+ the rules. More details concerning class options can be found at
+ \DescPageRef{\LabelBase.option.numbers}.
An additional possibility could be to place the section numbers in the
left margin in such a way that the heading text is left aligned with
@@ -2210,28 +2171,20 @@ Do\textnote{Attention!} not forget to change \Macro{newcommand} into
\end{Example}
If you would like to change more than only the printing of the counter of a
-heading, please have a look at \Macro{chapterlineswithprefixformat},
-\Macro{chapterlinesformat}, \Macro{sectionlinesformat}, and
-\Macro{sectioncatchphraseformat} in \autoref{sec:maincls-experts.experts} from
-\autopageref{desc:maincls-experts.cmd.chapterlineswithprefixformat}.%
-\EndIndex{Cmd}{autodot}%
-\EndIndex{Cmd}{IfUsePrefixLine}%
-\EndIndex{Cmd}{othersectionlevelsformat}%
-\EndIndex{Cmd}{paragraphformat}%
-\EndIndex{Cmd}{subparagraphformat}%
-\EndIndex{Cmd}{subsubsectionformat}%
-\EndIndex{Cmd}{subsectionformat}%
-\EndIndex{Cmd}{sectionformat}%
-\EndIndex{Cmd}{chapterformat}%
-\EndIndex{Cmd}{partformat}%
+heading, please have a look at
+\DescRef{maincls-experts.cmd.chapterlineswithprefixformat},
+\DescRef{maincls-experts.cmd.chapterlinesformat},
+\DescRef{maincls-experts.cmd.sectionlinesformat}, and
+\DescRef{maincls-experts.cmd.sectioncatchphraseformat} in
+\autoref{sec:maincls-experts.experts} from
+\DescPageRef{maincls-experts.cmd.chapterlineswithprefixformat}.%
+\EndIndexGroup
\begin{Declaration}
- \Macro{chapappifchapterprefix}\Parameter{additional text}\\
+ \Macro{chapappifchapterprefix}\Parameter{additional text}%
\Macro{chapapp}
\end{Declaration}%
-\BeginIndex{Cmd}{chapappifchapterprefix}%
-\BeginIndex{Cmd}{chapapp}%
These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
\ChangedAt{v2.8o}{\Class{scrbook}\and\Class{scrreprt}} two commands
are not only used internally by {\KOMAScript} but are also provided to
@@ -2239,70 +2192,62 @@ the user. Later it will be shown how they can be used, for example, to
redefine other commands.
Using the layout option
-\OptionValue{chapterprefix}{true}\important{\Option{chapterprefix}} (see
-\autopageref{desc:maincls.option.chapterprefix})
+\OptionValueRef{\LabelBase}{chapterprefix}{true}\important{\DescRef{\LabelBase.option.chapterprefix}}
+(see \DescPageRef{\LabelBase.option.chapterprefix})
\Macro{chapappifchapterprefix} outputs the word
``Chapter''\Index{chapter>heading} in the main part of the document in the
current language, followed by \PName{additional text}. In the
-appendix\Index{appendix}, the word ``Appendix'' in the current
-language is output instead, followed by \PName{additional text}. If the
-option \OptionValue{chapterprefix}{false} is set, then nothing is output.
+appendix\Index{appendix}, the word ``Appendix'' in the current language is
+output instead, followed by \PName{additional text}. If the option
+\OptionValue{\LabelBase}{chapterprefix}{false} is set, then nothing is output.
The command \Macro{chapapp} always outputs the word ``Chapter'' or
-``Appendix''. In this case the selection of option \Option{chapterprefix} has
-no effect.
+``Appendix''. In this case the selection of option
+\DescRef{\LabelBase.option.chapterprefix} has no effect.
Since chapters only exist in the classes \Class{scrbook} and
\Class{scrreprt}, these commands only exist in these classes.%
%
-\EndIndex{Cmd}{chapappifchapterprefix}%
-\EndIndex{Cmd}{chapapp}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{chaptermark}\Parameter{running head}\\
- \Macro{addchapmark}\Parameter{running head}\\
- \Macro{sectionmark}\Parameter{running head}\\
- \Macro{addsecmark}\Parameter{running head}\\
- \Macro{subsectionmark}\Parameter{running head}\\
- \Macro{chaptermarkformat}\\
- \Macro{sectionmarkformat}\\
+ \Macro{chaptermark}\Parameter{running head}%
+ \Macro{addchapmark}\Parameter{running head}%
+ \Macro{sectionmark}\Parameter{running head}%
+ \Macro{addsecmark}\Parameter{running head}%
+ \Macro{subsectionmark}\Parameter{running head}%
+ \Macro{chaptermarkformat}%
+ \Macro{sectionmarkformat}%
\Macro{subsectionmarkformat}
\end{Declaration}%
-\BeginIndex{Cmd}{addchapmark}%
-\BeginIndex{Cmd}{addsecmark}%
-\BeginIndex{Cmd}{chaptermark}%
-\BeginIndex{Cmd}{sectionmark}%
-\BeginIndex{Cmd}{subsectionmark}%
-\BeginIndex{Cmd}{chaptermarkformat}%
-\BeginIndex{Cmd}{sectionmarkformat}%
-\BeginIndex{Cmd}{subsectionmarkformat}%
\begin{Explain}%
- As mentioned in \autoref{sec:maincls.pagestyle} the page style
- \PValue{headings} works with automatic running
- heads\Index{running head}. For this, the commands
- \Macro{chaptermark} and \Macro{sectionmark}, or \Macro{sectionmark}
- and \Macro{subsectionmark}, respectively, are defined. Every
- structuring command (\Macro{chapter}, \Macro{section}, etc.)
- automatically carries out the respective \Macro{\dots mark} command.
- The parameter passed contains the text of the section
- heading\Index{heading}. The respective section number is added
- automatically in the \Macro{\dots mark} command. The formatting is
+ As mentioned in \autoref{sec:\LabelBase.pagestyle} the page style
+ \PValue{headings} works with automatic running heads\Index{running
+ head}. For this, the commands \Macro{chaptermark} and \Macro{sectionmark},
+ or \Macro{sectionmark} and \Macro{subsectionmark}, respectively, are
+ defined. Every structuring command (\DescRef{\LabelBase.cmd.chapter},
+ \DescRef{\LabelBase.cmd.section}, etc.) automatically carries out the
+ respective \Macro{\dots mark} command. The parameter passed contains the
+ text of the section heading\Index{heading}. The respective section number is
+ added automatically in the \Macro{\dots mark} command. The formatting is
done according to the section level with one of the three commands
\Macro{chaptermarkformat}, \Macro{sectionmarkformat}, or
\Macro{subsectionmarkformat}.
Please note\textnote{Attention!}, the running heads of
- \Macro{addchap}\IndexCmd{addchap} and \Macro{addsec}\IndexCmd{addsec} are
- also based on \Macro{chaptermark} and \Macro{addsecmark} but locally set
- counter \Counter{secnumdepth} to a value that makes chapters respectively
- sections not numbered. You should pay attention for this especially if you
- redefine \Macro{chaptermark} or \Macro{sectionmark} (see \Macro{ifnumbered}
- on \autopageref{desc:maincls.cmd.ifnumbered}). The star variants
- \Macro{addchap*} and \Macro{addsec*} use additional commands
- \Macro{addchapmark} and \Macro{addsecmark} that are defined also basing on
- \Macro{chaptermark} and \Macro{sectionmark} with local changes of
- \Counter{secnumdepth}.
+ \DescRef{\LabelBase.cmd.addchap}\IndexCmd{addchap} and
+ \DescRef{\LabelBase.cmd.addsec}\IndexCmd{addsec} are also based on
+ \Macro{chaptermark} and \Macro{addsecmark} but locally set counter
+ \DescRef{\LabelBase.counter.secnumdepth} to a value that makes chapters
+ respectively sections not numbered. You should pay attention for this
+ especially if you redefine \Macro{chaptermark} or \Macro{sectionmark} (see
+ \Macro{ifnumbered} on \DescPageRef{\LabelBase.cmd.ifnumbered}). The star
+ variants \DescRef{\LabelBase.cmd.addchap*} and
+ \DescRef{\LabelBase.cmd.addsec*} use additional commands \Macro{addchapmark}
+ and \Macro{addsecmark} that are defined also basing on \Macro{chaptermark}
+ and \Macro{sectionmark} with local changes of
+ \DescRef{\LabelBase.counter.secnumdepth}.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no command
\Macro{chaptermark} or \Macro{chaptermarkformat} in
@@ -2311,13 +2256,14 @@ Since chapters only exist in the classes \Class{scrbook} and
\Class{scrartcl}. This changes when you use the \Package{scrlayer-scrpage}
package (see \autoref{cha:scrlayer-scrpage}).\par
\end{Explain}
-Similar to \Macro{partformat} down to \Macro{subparagraphformat} for
-formatting the numbers in the headings, the commands \Macro{chaptermarkformat}
-(not in \Class{scrartcl}), \Macro{sectionmarkformat}, and
-\Macro{subsectionmarkformat} (only in \Class{scrartcl}) define the formatting
-of the sectioning numbers in the automatic running heads. They can be adapted
-to your personal needs with \Macro{renewcommand}. The original definitions for
-the {\KOMAScript} classes are:
+Similar to \DescRef{\LabelBase.cmd.partformat} down to
+\DescRef{\LabelBase.cmd.subparagraphformat} for formatting the numbers in the
+headings, the commands \Macro{chaptermarkformat} (not in \Class{scrartcl}),
+\Macro{sectionmarkformat}, and \Macro{subsectionmarkformat} (only in
+\Class{scrartcl}) define the formatting of the sectioning numbers in the
+automatic running heads. They can be adapted to your personal needs with
+\Macro{renewcommand}. The original definitions for the {\KOMAScript} classes
+are:
\begin{lstcode}
\newcommand*{\chaptermarkformat}{%
\chapappifchapterprefix{\ }\thechapter\autodot\enskip}
@@ -2334,49 +2280,37 @@ the {\KOMAScript} classes are:
\chapapp~\thechapter\autodot\enskip}
\end{lstcode}
\end{Example}
-As you can see, both the commands \Macro{chapappifchapterprefix} and
-\Macro{chapapp} explained above are used here.%
+As you can see, both the commands
+\DescRef{\LabelBase.cmd.chapappifchapterprefix} and
+\DescRef{\LabelBase.cmd.chapapp} explained above are used here.%
%
-\EndIndex{Cmd}{chaptermark}%
-\EndIndex{Cmd}{sectionmark}%
-\EndIndex{Cmd}{subsectionmark}%
-\EndIndex{Cmd}{chaptermarkformat}%
-\EndIndex{Cmd}{sectionmarkformat}%
-\EndIndex{Cmd}{subsectionmarkformat}%
-\EndIndex{Cmd}{addsecmark}%
-\EndIndex{Cmd}{addchapmark}%
+\EndIndexGroup
\begin{Declaration}
- \Counter{secnumdepth}\\
- \Macro{partnumdepth}\\
- \Macro{chapternumdepth}\\
- \Macro{sectionnumdepth}\\
- \Macro{subsectionnumdepth}\\
- \Macro{subsubsectionnumdepth}\\
- \Macro{paragraphnumdepth}\\
+ \Counter{secnumdepth}%
+ \Macro{partnumdepth}%
+ \Macro{chapternumdepth}%
+ \Macro{sectionnumdepth}%
+ \Macro{subsectionnumdepth}%
+ \Macro{subsubsectionnumdepth}%
+ \Macro{paragraphnumdepth}%
\Macro{subparagraphnumdepth}
\end{Declaration}%
-\BeginIndex{Counter}{secnumdepth}\BeginIndex{}{numbering}%
-\BeginIndex{Cmd}{partnumdepth}%
-\BeginIndex{Cmd}{chapternumdepth}%
-\BeginIndex{Cmd}{sectionnumdepth}%
-\BeginIndex{Cmd}{subsectionnumdepth}%
-\BeginIndex{Cmd}{subsubsectionnumdepth}%
-\BeginIndex{Cmd}{paragraphnumdepth}%
-\BeginIndex{Cmd}{subparagraphnumdepth}%
+\BeginIndex{}{numbering}%
Section levels in the classes \Class{scrbook}\IndexClass{scrbook} and
\Class{scrreport}\IndexClass{scrreprt} are, by default, numbered from
-\Macro{part}\IndexCmd{part}\IndexCmd{chapter}\IndexCmd{section} down to
-\Macro{subsection}\IndexCmd{subsection}. In class
+\DescRef{\LabelBase.cmd.part}\IndexCmd{part}\IndexCmd{chapter}\IndexCmd{section}
+down to \DescRef{\LabelBase.cmd.subsection}\IndexCmd{subsection}. In class
\Class{scrartcl}\IndexClass{scrartcl} the default numbering is from
-\Macro{part} down to \Macro{subsubsection}\IndexCmd{subsubsection}. The
-actual depth to which headings will be numbered is controlled by the \LaTeX{}
-counter \Counter{secnumdepth}. Since version~3.12 \KOMAScript{} provides the
-commands \Macro{partnumdepth} to \Macro{subparagraphnumdepth} which return the
-number that corresponds to the level they bear in their name. This saves users
-the trouble of having to remember abstract numbers and allows them to define
-the depth to which headings should be numbered with relative ease.
+\DescRef{\LabelBase.cmd.part} down to
+\DescRef{\LabelBase.cmd.subsubsection}\IndexCmd{subsubsection}. The actual
+depth to which headings will be numbered is controlled by the \LaTeX{} counter
+\Counter{secnumdepth}. Since version~3.12 \KOMAScript{} provides the commands
+\Macro{partnumdepth} to \Macro{subparagraphnumdepth} which return the number
+that corresponds to the level they bear in their name. This saves users the
+trouble of having to remember abstract numbers and allows them to define the
+depth to which headings should be numbered with relative ease.
\KOMAScript{} provides the commands \Macro{partnumdepth} to
\Macro{subparagraphnumdepth} so\ChangedAt{v3.12}{\Class{scrbook}\and
@@ -2397,64 +2331,55 @@ Redefining these commands is not allowed. Doing so could lead to unexpected
results not only with \KOMAScript{} but also with third party packages. Thus,
it is recommended to never redefine any of them.
-Do not confuse the counters \Counter{secnumdepth} and \Counter{tocdepth},
-please refer to the explanation concerning the counter \Counter{tocdepth} in
-\autoref{sec:maincls.toc},
-\autopageref{desc:maincls.counter.tocdepth}. Actually, depending on the class
+Do not confuse the counters \Counter{secnumdepth} and
+\DescRef{\LabelBase.counter.tocdepth}, please refer to the explanation
+concerning the counter \DescRef{\LabelBase.counter.tocdepth} in
+\autoref{sec:\LabelBase.toc},
+\DescPageRef{\LabelBase.counter.tocdepth}. Actually, depending on the class
you are using, the meaning of the values of the counters \Counter{secnumdepth}
-and \Counter{tocdepth} may deviate from one another for the same section
-level.%
-\EndIndex{Cmd}{subparagraphnumdepth}%
-\EndIndex{Cmd}{paragraphnumdepth}%
-\EndIndex{Cmd}{subsubsectionnumdepth}%
-\EndIndex{Cmd}{subsectionnumdepth}%
-\EndIndex{Cmd}{sectionnumdepth}%
-\EndIndex{Cmd}{chapternumdepth}%
-\EndIndex{Cmd}{partnumdepth}%
-\EndIndex{Counter}{secnumdepth}\EndIndex{}{numbering}%
+and \DescRef{\LabelBase.counter.tocdepth} may deviate from one another for the
+same section level.%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{ifnumbered}\Parameter{section level}%
- \Parameter{then code}\Parameter{else code}\\
+ \Parameter{then code}\Parameter{else code}%
\Macro{ifunnumbered}\Parameter{section level}%
\Parameter{then code}\Parameter{else code}
\end{Declaration}
-\BeginIndex{Cmd}{ifnumbered}%
-\BeginIndex{Cmd}{ifunnumbered}%
After\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} describing above how to define down to which section level
headings are numbered, the commands \Macro{ifnumbered} and
\Macro{ifunnumbered} can be used to execute code depending on whether a
\PName{section level} is numbered or not. If the current setting of
-\Counter{secnumdepth} stipulates that a \PName{section level} will be
-numbered, the \PName{then code} after \Macro{ifnumbered} gets executed. If it
-is not numbered, the \PName{else code} gets executed. The \Macro{ifunnumbered}
-command behaves in exactly the opposite manner, executing the \PName{then
- code} if the current level is not numbered and the \PName{else code} if it
-is. The \PName{section level} parameter is simply the \LaTeX{} name of a
-section like \PValue{part}, \PValue{chapter}, \PValue{section},
+\DescRef{\LabelBase.counter.secnumdepth} stipulates that a \PName{section
+ level} will be numbered, the \PName{then code} after \Macro{ifnumbered} gets
+executed. If it is not numbered, the \PName{else code} gets executed. The
+\Macro{ifunnumbered} command behaves in exactly the opposite manner, executing
+the \PName{then code} if the current level is not numbered and the \PName{else
+ code} if it is. The \PName{section level} parameter is simply the \LaTeX{}
+name of a section like \PValue{part}, \PValue{chapter}, \PValue{section},
\PValue{subsection}, \PValue{subsubsection}, \PValue{paragraph} oder
\PValue{subparagraph}.\PValue{part}, \PValue{chapter}, \PValue{section},
\PValue{subsection}, \PValue{subsubsection}, \PValue{paragraph}, or
\PValue{subparagraph}.
\KOMAScript{} itself uses these tests, for example, in the definition of
-\Macro{chaptermark}\IndexCmd{chaptermark} within page style
-\Pagestyle{headings}\IndexPagestyle{headings}. This indirectly guarantees that
-headings inserted by \Macro{addchap} do not set a number inside the running
-head (see also \Macro{addchapmark},
-\autopageref{desc:maincls.cmd.addchapmark}).%
-\EndIndex{Cmd}{ifnumbered}%
-\EndIndex{Cmd}{ifunnumbered}%
+\DescRef{\LabelBase.cmd.chaptermark}\IndexCmd{chaptermark} within page style
+\PageStyle{headings}\IndexPagestyle{headings}. This indirectly guarantees that
+headings inserted by \DescRef{\LabelBase.cmd.addchap} do not set a number
+inside the running head (see also \DescRef{\LabelBase.cmd.addchapmark},
+\DescPageRef{\LabelBase.cmd.addchapmark}).%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{setpartpreamble}%
- \OParameter{position}\OParameter{width}\Parameter{preamble}\\
+ \OParameter{position}\OParameter{width}\Parameter{preamble}%
\Macro{setchapterpreamble}%
\OParameter{position}\OParameter{width}\Parameter{preamble}
\end{Declaration}%
-\BeginIndex{Cmd}{setpartpreamble}%
-\BeginIndex{Cmd}{setchapterpreamble}%
Parts\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}}\Index{part>preamble}\Index{chapter>preamble} and chapters
in {\KOMAScript} can be started with a \PName{preamble}. This is particularly
@@ -2462,8 +2387,9 @@ useful when you are using a two column layout with the class option
\Option{twocolumn}\IndexOption{twocolumn}, since the heading together with the
\PName{preamble} is always set in a one column layout. The \PName{preamble}
can comprise more than one paragraph. The command to output the
-\PName{preamble} has to be placed before the respective \Macro{part},
-\Macro{addpart}, \Macro{chapter}, or \Macro{addchap} command.
+\PName{preamble} has to be placed before the respective \DescRef{\LabelBase.cmd.part},
+\DescRef{\LabelBase.cmd.addpart}, \DescRef{\LabelBase.cmd.chapter}, or
+\DescRef{\LabelBase.cmd.addchap} command.
\begin{Example}
You are writing a report about the condition of a company. You
organize the report in such a way that every department gets its own
@@ -2481,10 +2407,10 @@ can comprise more than one paragraph. The command to output the
\part{Department for Word Processing}
\end{lstcode}
Depending on the settings for the heading font size\Index{heading}
- (see \autopageref{desc:maincls.option.headings}) and the options for
- the \Environment{abstract} environment\IndexEnv{abstract} (see
- \autoref{sec:maincls.abstract},
- \autopageref{desc:maincls.option.abstract}), the result would look
+ (see \DescPageRef{\LabelBase.option.headings}) and the options for
+ the \DescRef{\LabelBase.env.abstract} environment\IndexEnv{abstract} (see
+ \autoref{sec:\LabelBase.abstract},
+ \DescPageRef{\LabelBase.option.abstract}), the result would look
similar to:
\begin{ShowOutput}\centering
{\LARGE\usekomafont{disposition} Part III.\par\vspace{20pt}}
@@ -2503,9 +2429,9 @@ can comprise more than one paragraph. The command to output the
\end{Example}
Please\textnote{Attention!} note that it is \emph{you} who is responsible for
the spaces between the heading, preamble and the following text. Please note
-also that there is no \Environment{abstract} environment in the class
-\Class{scrbook} (see \autoref{sec:maincls.abstract},
-\autopageref{desc:maincls.env.abstract}).
+also that there is no \DescRef{\LabelBase.env.abstract} environment in the
+class \Class{scrbook} (see \autoref{sec:\LabelBase.abstract},
+\DescPageRef{\LabelBase.env.abstract}).
The\ChangedAt{v2.8p}{\Class{scrbook}\and\Class{scrreprt}} first
optional argument \PName{position} determines the position at which
@@ -2531,37 +2457,36 @@ from the vertical with one letter from the horizontal positioning.
A more often usage of \Macro{setchapterpreamble} would be something like a
smart slogan or dictum to a heading. The command
-\Macro{dictum}\IndexCmd{dictum}, that may be used for this, will be described
-at the next section. You will also find an example there.
-
-Please note\textnote{Attention!} that a \PName{preamble} placed above
-the chapter headings will be set into the already existing vertical
-space above the heading. The heading will not be moved down. It is
-you who is responsible for ensuring that the preamble is small enough and the
-space is sufficient. See also \Macro{chapterheadstartvskip} in
+\DescRef{\LabelBase.cmd.dictum}\IndexCmd{dictum}, that may be used for this,
+will be described at the next section. You will also find an example there.
+
+Please note\textnote{Attention!} that a \PName{preamble} placed above the
+chapter headings will be set into the already existing vertical space above
+the heading. The heading will not be moved down. It is you who is responsible
+for ensuring that the preamble is small enough and the space is
+sufficient. See also \DescRef{maincls-experts.cmd.chapterheadstartvskip} in
\autoref{sec:maincls-experts.experts},
-\autopageref{desc:maincls-experts.cmd.chapterheadstartvskip} for
-this.%
+\DescPageRef{maincls-experts.cmd.chapterheadstartvskip} for this.%
%
-\EndIndex{Cmd}{setpartpreamble}%
-\EndIndex{Cmd}{setchapterpreamble}%
+\EndIndexGroup
-\LoadCommon{15}% \section{Dicta}
+\LoadCommonFile{dictum}% \section{Dicta}
-\LoadCommon{12}% \section{Lists}
+\LoadCommonFile{lists}% \section{Lists}
\section{Math}
\seclabel{math}%
+\BeginIndexGroup
\BeginIndex{}{equations}%
\BeginIndex{}{formulas}%
\BeginIndex{}{mathematics}%
There are no math environments implemented in the \KOMAScript{}
classes. Instead of this, the math features of the \LaTeX{} kernel have been
-supported. With this also, the options \Option{leqno} and \Option{fleqn} are
-available.
+supported. With this also, the options \DescRef{\LabelBase.option.leqno} and
+\DescRef{\LabelBase.option.fleqn} are available.
You will not find a description of the math environments of the \LaTeX{} kernel
here. If you want to use \Environment{displaymath}\IndexEnv{displaymath},
@@ -2574,40 +2499,40 @@ recommended (see \cite{package:amsmath}).
\begin{Declaration}
\Option{leqno}
\end{Declaration}%
-\BeginIndex{Option}{leqno}%
Equations are normally numbered\Index{equation>number} on the right. The
standard option \Option{leqno} causes the standard option file
\File{leqno.clo} to be loaded. The equations are then numbered on the
left. This\textnote{Attention!} option has to be used as an optional argument
-of \Macro{documentclass}. Usage as an argument of \Macro{KOMAoptions} or
-\Macro{KOMAoption} is not supported. This would not make sense, because the
-recommended math package \Package{amsmath} supports the option at loading
-time only too and would not react on run-time changes of the option.
+of \DescRef{\LabelBase.cmd.documentclass}. Usage as an argument of
+\DescRef{\LabelBase.cmd.KOMAoptions} or \DescRef{\LabelBase.cmd.KOMAoption} is
+not supported. This would not make sense, because the recommended math package
+\Package{amsmath} supports the option at loading time only too and would not
+react on run-time changes of the option.
%
-\EndIndex{Option}{leqno}%
+\EndIndexGroup
+
\begin{Declaration}
\Option{fleqn}
\end{Declaration}%
-\BeginIndex{Option}{fleqn}%
Displayed equations\Index{equation>alignment} are normally centered. The
standard option \Option{fleqn} causes the standard option file
\File{fleqn.clo} to be loaded. Displayed equations are then
left-justified. This option may be used as an optional argument of
-\Macro{documentclass} but not as an argument of \Macro{KOMAoptions} or
-\Macro{KOMAoption}. The latter would not make sense, because the recommended
-math package \Package{amsmath} supports the option at loading time only too
-and would not react on run-time changes of the option.
+\DescRef{\LabelBase.cmd.documentclass} but not as an argument of
+\DescRef{\LabelBase.cmd.KOMAoptions} or \DescRef{\LabelBase.cmd.KOMAoption}.
+The latter would not make sense, because the recommended math package
+\Package{amsmath} supports the option at loading time only too and would not
+react on run-time changes of the option.
%
-\EndIndex{Option}{fleqn}%
+\EndIndexGroup
%
-\EndIndex{}{mathematics}%
-\EndIndex{}{formulas}%
-\EndIndex{}{equations}%
+\EndIndexGroup
\section{Floating Environments of Tables and Figures}
\seclabel{floats}
+\BeginIndexGroup
\BeginIndex{}{floats}%
\BeginIndex{}{tables}%
\BeginIndex{}{figures}%
@@ -2637,17 +2562,16 @@ the typesetting of captions of figures and tables. This should be self
evident, but it is often not understood.
\begin{Declaration}
- \KOption{captions}\PName{selection}
+ \OptionVName{captions}{selection}
\end{Declaration}
-\BeginIndex{Option}{captions~=\PName{selection}}%
The standard classes format titles of floating environments, which are placed
-with \Macro{caption}\IndexCmd{caption} (see below), like signatures. They
+with \DescRef{\LabelBase.cmd.caption}\IndexCmd{caption} (see below), like signatures. They
differentiate between one-line and multi-line table or figure
captions. One-line captions are centered while multi-line captions are
left-justified.
\leavevmode\phantomsection\nobreak
-\label{desc:maincls.option.captions.tableheading}\nobreak
+\label{desc:\LabelBase.option.captions.tableheading}\nobreak
For tables, however, headings are often used. That's because there may
be tables that span several pages. Surely the reader wants to know the
purpose of the table at the first page already. Furthermore tables
@@ -2675,7 +2599,7 @@ the caption from above the top of the table to below the bottom of the
table or vice versa. It only affects whether the text is formatted as
a caption for use above or below a table. Whether the text is in fact
placed above or below a table is set through the position of the
-\Macro{caption} command inside the \Environment{table} environment. This may
+\DescRef{\LabelBase.cmd.caption} command inside the \Environment{table} environment. This may
change using package \Package{float}\IndexPackage{float} and command
\Macro{restylefloats} (see \cite{package:float}).
@@ -2698,7 +2622,7 @@ options\important[i]{\OptionValue{captions}{heading}\\
\OptionValue{captions}{heading}\IndexOption{captions~=\PValue{heading}} and
\OptionValue{captions}{signature}\IndexOption{captions~=\PValue{signature}} to
switch the format of every floating environment. These options may be used
-also inside a floating environment but before using \Macro{caption}.
+also inside a floating environment but before using \DescRef{\LabelBase.cmd.caption}.
Note\textnote{Attention!}\OnlyAt{\Package{float}}\IndexPackage{float} that
when using the \Package{float} package, the options
@@ -2708,11 +2632,11 @@ when using the \Package{float} package, the options
package and \Macro{restylefloat} can be found in
\cite{package:float}. Additional support in {\KOMAScript} for the
\Package{float} package may be found at the explanation of \PValue{komaabove}
-(see \autopageref{desc:maincls.floatstyle.komaabove}).
+(see \DescPageRef{\LabelBase.floatstyle.komaabove}).
\leavevmode\phantomsection\nobreak
-\label{desc:maincls.option.captions.nooneline}\nobreak
-\label{desc:maincls.option.captions.oneline}\nobreak
+\label{desc:\LabelBase.option.captions.nooneline}\nobreak
+\label{desc:\LabelBase.option.captions.oneline}\nobreak
Furthermore, \KOMAScript{} supports to switch off the distinguish of captions
with only one line or more than one line using option
\OptionValue{captions}{nooneline}\IndexOption{captions~=\PValue{nooneline}}%
@@ -2722,31 +2646,33 @@ corresponds to \OptionValue{captions}{oneline}.
Another special feature of \KOMAScript{} is to alternatively put the caption
neither above nor below the floating object but beside
-it. For this you need Environment\important{\Environment{captionbeside}}
-\Environment{captionsbeside}\IndexEnv{captionbeside}, that will be described
-from \autopageref{desc:maincls.env.captionbeside}. Several settings
+it. For this you need Environment\important{\DescRef{\LabelBase.env.captionbeside}}
+\DescRef{\LabelBase.env.captionbeside}\IndexEnv{captionbeside}, that will be described
+from \DescPageRef{\LabelBase.env.captionbeside}. Several settings
for this environment may be done also using \Option{caption}. You may find all
-the available \PName{settings} at \autoref{tab:maincls.captions}.
+the available \PName{settings} at \autoref{tab:\LabelBase.captions}.
%
\begin{desclist}
\desccaption[{Available values for option \Option{captions}}]{%
Available values for option \Option{captions} to select formation of
captions as headings or signatures at floating environments%
- \label{tab:maincls.captions}%
+ \label{tab:\LabelBase.captions}%
}{%
Available values for option \Option{captions} (\emph{continuation})%
}%
\entry{\PValue{bottombeside}, \PValue{besidebottom}}{%
- Captions and contents of environment \Environment{captionsbeside} (see
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside}) will be vertically align
+ Captions and contents of environment
+ \DescRef{\LabelBase.env.captionbeside} (see
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be vertically align
depending on the bottommost base lines.%
\IndexOption{captions~=\PValue{bottombeside}}}%
\entry{\PValue{centeredbeside}, \PValue{besidecentered},
\PValue{middlebeside}, \PValue{besidemiddle}}{%
- Captions and contents of environment \Environment{captionsbeside} (see
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside}) will be vertically centered%
+ Captions and contents of environment
+ \DescRef{\LabelBase.env.captionbeside} (see
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be vertically centered%
\IndexOption{captions~=\PValue{centeredbeside}}}%
\entry{\PValue{figureheading}, \PValue{figureabove}, \PValue{abovefigure},
\PValue{topatfigure}%
@@ -2775,19 +2701,18 @@ the available \PName{settings} at \autoref{tab:maincls.captions}.
}%
\entry{\PValue{innerbeside},
\PValue{besideinner}\IndexOption{captions~=\PValue{innerbeside}}}{%
- Captions of environment \Environment{captionsbeside} (siehe
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside})
- will be placed innermost beside the contents of the environment at
- double-side printing. At single-side printing
- \OptionValue{captions}{leftbeside} will be used.%
+ Captions of environment \DescRef{\LabelBase.env.captionbeside} (siehe
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be placed innermost
+ beside the contents of the environment at double-side printing. At
+ single-side printing \OptionValue{captions}{leftbeside} will be used.%
}%
\entry{\PValue{leftbeside},
\PValue{besideleft}\IndexOption{captions~=\PValue{leftbeside}}}{%
- Captions of environment \Environment{captionsbeside} (siehe
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside}) will be placed left beside
- the contents of the environment.%
+ Captions of environment \DescRef{\LabelBase.env.captionbeside} (siehe
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be placed left beside the
+ contents of the environment.%
}%
\pventry{nooneline}{%
Captions with only one line will not be handled different from captions
@@ -2798,18 +2723,17 @@ the available \PName{settings} at \autoref{tab:maincls.captions}.
\IndexOption{captions~=\PValue{oneline}}}%
\entry{\PValue{outerbeside}, \PValue{besideouter}%
\IndexOption{captions~=\PValue{outerbeside}}}{%
- Captions of environment \Environment{captionsbeside} (siehe
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside})
- will be placed outermost beside the contents of the environment at
- double-side printing. At single-side printing
- \OptionValue{captions}{rightbeside} will be used.%
+ Captions of environment \DescRef{\LabelBase.env.captionbeside} (siehe
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be placed outermost
+ beside the contents of the environment at double-side printing. At
+ single-side printing \OptionValue{captions}{rightbeside} will be used.%
}%
\entry{\PValue{rightbeside}, \PValue{besideright}%
\IndexOption{captions~=\PValue{rightbeside}}}{%
- Captions of environment \Environment{captionsbeside} (siehe
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside}) will be placed right beside
+ Captions of environment \DescRef{\LabelBase.env.captionbeside} (siehe
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be placed right beside
the contents of the environment.%
}%
\entry{\PValue{signature}, \PValue{below}, \PValue{bot}, \PValue{bottom}%
@@ -2831,28 +2755,26 @@ the available \PName{settings} at \autoref{tab:maincls.captions}.
\entry{\PValue{tablesignature}, \PValue{belowtable}, \PValue{belowtabular},
\PValue{bottomattable}%
\IndexOption{captions~=\PValue{tablesignature}}}{%
- Captions of tables will use signature formation\,---\,maybe in discrepancy
+ Captions of tables will use signature formation\,---\,maybe in discrepancy
to \OptionValue{captions}{heading}.%
}%
\entry{\PValue{topbeside}, \PValue{besidetop}}{%
- Captions and contents of environment \Environment{captionsbeside} (see
- \autoref{sec:maincls.floats},
- \autopageref{desc:maincls.env.captionbeside}) will be vertically align
+ Captions and contents of environment
+ \DescRef{\LabelBase.env.captionbeside} (see
+ \autoref{sec:\LabelBase.floats},
+ \DescPageRef{\LabelBase.env.captionbeside}) will be vertically align
depending on the topmost base lines.%
\IndexOption{captions~=\PValue{topbeside}}}%
\end{desclist}%
%
-\EndIndex{Option}{captions~=\PName{selection}}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{caption}\OParameter{entry}\Parameter{title}\\
- \Macro{captionbelow}\OParameter{entry}\Parameter{title}\\
+ \Macro{caption}\OParameter{entry}\Parameter{title}%
+ \Macro{captionbelow}\OParameter{entry}\Parameter{title}%
\Macro{captionabove}\OParameter{entry}\Parameter{title}
\end{Declaration}%
-\BeginIndex{Cmd}{caption}%
-\BeginIndex{Cmd}{captionabove}%
-\BeginIndex{Cmd}{captionbelow}%
In the standard classes caption text \PName{title} of tables and
figures is inserted with the \Macro{caption} command below the table
or figure. In general this is correct for figures. Opinions differ as
@@ -2866,7 +2788,7 @@ figures.
Not only for tables but also for figures or all kind of floating environments
the behaviour of \Macro{caption} may be modified using option
-\Option{captions}\IndexOption{captions} described at the beginning of this
+\DescRef{\LabelBase.option.captions}\IndexOption{captions} described at the beginning of this
section. For
compatibility reasons the default behaviour of \Macro{caption} used
with all kinds of floating environments is similar to
@@ -2874,7 +2796,7 @@ with all kinds of floating environments is similar to
is recommended\textnote{Hint!} to use table headings and therefor switch
behaviour of \Macro{caption} inside table environments into
\Macro{captionabove} using option
-\OptionValue{captions}{tableheading}. Alternatively you may use
+\OptionValueRef{\LabelBase}{captions}{tableheading}. Alternatively you may use
\Macro{captionabove} instead of \Macro{caption} inside of every
\Environment{table} environment.
%
@@ -2925,30 +2847,30 @@ behaviour of \Macro{caption} inside table environments into
\end{tabular}
\end{ShowOutput}
Since you want all your tables typeset with captions above, you could
- of course use the option \OptionValue{captions}{tableheading} instead (see
- \autopageref{desc:maincls.option.captions.tableheading}). Then you can use
+ of course use the option \OptionValueRef{\LabelBase}{captions}{tableheading} instead (see
+ \DescPageRef{\LabelBase.option.captions.tableheading}). Then you can use
\Macro{caption} as you would in the standard classes. You will get
the same result as with \Macro{captionabove}.
\end{Example}
+\BeginIndexGroup
\BeginIndex[indexother]{}{font>style}%
-\BeginIndex{FontElement}{caption}%
-\BeginIndex{FontElement}{captionlabel}%
+\BeginIndex{FontElement}{caption}\LabelFontElement{caption}%
+\BeginIndex{FontElement}{captionlabel}\LabelFontElement{captionlabel}%
The font style\ChangedAt{v2.8p}{%
- \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} for the
-description and the label\,---\,``Figure'' or ``Table'', followed by
-the number and the delimiter\,---\,can be changed with the commands
-\Macro{setkomafont}
-and \Macro{addtokomafont} (see \autoref{sec:maincls.textmarkup},
-\autopageref{desc:maincls.cmd.setkomafont}). The respective elements for
-this are \FontElement{caption}\important{\FontElement{caption}} and
+ \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} for the description
+and the label\,---\,``Figure'' or ``Table'', followed by the number and the
+delimiter\,---\,can be changed with the commands
+\DescRef{\LabelBase.cmd.setkomafont} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see \autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). The respective elements for this
+are \FontElement{caption}\important{\FontElement{caption}} and
\FontElement{captionlabel}\important{\FontElement{captionlabel}} (see
-\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). First the font style
-for the element \FontElement{caption} is applied to the element
-\FontElement{captionlabel} too. After this the font style of
-\FontElement{captionlabel} is applied on the respective element. The
-default settings are listed in \autoref{tab:maincls.captionFont}.
+\autoref{tab:\LabelBase.fontelements}, \autopageref{tab:\LabelBase.fontelements}).
+First the font style for the element \FontElement{caption} is applied to the
+element \FontElement{captionlabel} too. After this the font style of
+\FontElement{captionlabel} is applied on the respective element. The default
+settings are listed in \autoref{tab:\LabelBase.captionFont}.
%
\begin{table}
% \centering%
@@ -2962,12 +2884,12 @@ default settings are listed in \autoref{tab:maincls.captionFont}.
\toprule
element & default \\
\midrule
- \FontElement{caption} & \Macro{normalfont} \\
- \FontElement{captionlabel} & \Macro{normalfont}\\
+ \DescRef{\LabelBase.fontelement.caption} & \Macro{normalfont} \\
+ \DescRef{\LabelBase.fontelement.captionlabel} & \Macro{normalfont}\\
\bottomrule
\end{tabular}
\end{captionbeside}
- \label{tab:maincls.captionFont}
+ \label{tab:\LabelBase.captionFont}
\end{table}
%
\begin{Example}
@@ -2986,25 +2908,19 @@ default settings are listed in \autoref{tab:maincls.captionFont}.
possible.
\end{Example}
%
-\EndIndex{FontElement}{captionlabel}%
-\EndIndex{FontElement}{caption}%
-\EndIndex[indexother]{}{font>style}%
+\EndIndexGroup
%
-\EndIndex{Cmd}{caption}%
-\EndIndex{Cmd}{captionabove}%
-\EndIndex{Cmd}{captionbelow}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{captionof}\Parameter{float type}\OParameter{entry}%
- \Parameter{title}\\
+ \Parameter{title}%
\Macro{captionbelowof}\Parameter{float type}\OParameter{entry}%
- \Parameter{title}\\
+ \Parameter{title}%
\Macro{captionaboveof}\Parameter{float type}\OParameter{entry}%
\Parameter{title}
\end{Declaration}%
-\BeginIndex{Cmd}{captionof}%
-\BeginIndex{Cmd}{captionaboveof}%
-\BeginIndex{Cmd}{captionbelowof}%
\KOMAScript{} supports a command
\Macro{captionof}\ChangedAt{v3.05}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} similar to packages
@@ -3012,7 +2928,7 @@ default settings are listed in \autoref{tab:maincls.captionFont}.
\Package{capt-of}\IndexPackage{capt-of}. You may use this command to place a
floating environment caption with corresponding entry into the list of that
kind of floating environment but even inside a another floating environment or
-outside any floating environment. In difference to \Macro{caption} the kind of
+outside any floating environment. In difference to \DescRef{\LabelBase.cmd.caption} the kind of
floating environment has to be set as first parameter.
Furthermore, \KOMAScript{} provides the additional commands
@@ -3024,7 +2940,7 @@ features and parameter of \Macro{captionof}.
Of course \KOMAScript\ChangedAt{v3.09a}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} takes care of the \PValue{heading}
and \PValue{signature} setting of option
-\Option{captions}. But this feature may be lost, loading package
+\DescRef{\LabelBase.option.captions}. But this feature may be lost, loading package
\Package{capt-of} or \Package{caption}. Please note the manual of package
\Package{caption} for this!
%
@@ -3059,7 +2975,7 @@ and \PValue{signature} setting of option
inter-word distance would be made between the \Environment{minipage}
environments.
- The figure signature has been done using \Macro{caption}. The table heading
+ The figure signature has been done using \DescRef{\LabelBase.cmd.caption}. The table heading
has been done using \Macro{captionaboveof} with first argument
\PValue{table}. Because of this \KOMAScript{} knows, that despite the
\Environment{figure} environment a table caption should be made.
@@ -3070,7 +2986,7 @@ and \PValue{signature} setting of option
is sufficient for the environment itself, it would be very useful at the
list of tables. Therefor a somehow more detailed description has been used
for the list of tables using the optional argument. The
- \autoref{fig:maincls.captionaboveof} shows the result of the example code.%
+ \autoref{fig:\LabelBase.captionaboveof} shows the result of the example code.%
\begin{figure}
% \centering
% \caption
@@ -3080,20 +2996,20 @@ and \PValue{signature} setting of option
[{Example: Usage of \Macro{captionaboveof} inside another floating
environment}]
{Example: Usage of \Macro{captionaboveof} inside another floating
- environment\label{fig:maincls.captionaboveof}}
+ environment\label{fig:\LabelBase.captionaboveof}}
[l]
\begin{minipage}[b]{.66\linewidth}%
\raisebox{\depth}{\fbox{\KOMAoptions{captions=oneline}%
\begin{minipage}{.5\dimexpr\linewidth-2\fboxsep-2\fboxrule\relax}
\centering
\rule{4cm}{3cm}
- \caption[Example: A rectangle]{A rectangle}\label{fig:maincls.rechteck}
+ \caption[Example: A rectangle]{A rectangle}\label{fig:\LabelBase.rechteck}
\end{minipage}%
\begin{minipage}{.5\dimexpr\linewidth-2\fboxsep-2\fboxrule\relax}
\centering
\captionaboveof{table}[Example: Measure of the rectangle in
- figure~\ref{fig:maincls.rechteck}]{Rectangle size}
- \label{tab:maincls.rechteck}
+ figure~\ref{fig:\LabelBase.rechteck}]{Rectangle size}
+ \label{tab:\LabelBase.rechteck}
\begin{tabular}{ll}
Width: & 4\,cm\\
Height: & 3\,cm
@@ -3111,27 +3027,22 @@ environment around the \Environment{minipage} environment may be used, to have
a pleasing distance above and below is and to avoid the paragraph indentation
of the \Environment{minipage} environment.%
%
-\EndIndex{Cmd}{captionof}%
-\EndIndex{Cmd}{captionaboveof}%
-\EndIndex{Cmd}{captionbelowof}%
+\EndIndexGroup
+
\begin{Declaration}
- \XMacro{begin}\PParameter{\Environment{captionbeside}}%
- \OParameter{entry}\Parameter{title}\texttt{\%}\\
- \hphantom{\XMacro{begin}\PParameter{captionbeside}}%
- \OParameter{placement}\OParameter{width}%
- \OParameter{offset}\\%
- \quad\dots\\
- \XMacro{end}\PParameter{captionbeside}\\
- \XMacro{begin}\PParameter{captionbeside}\OParameter{entry}%
- \Parameter{title}\texttt{\%}\\
- \hphantom{\XMacro{begin}\PParameter{captionbeside}}%
- \OParameter{placement}\OParameter{width}%
- \OParameter{offset}\PValue{*}\\
- \quad\dots\\
- \XMacro{end}\PParameter{captionbeside}
+ \begin{Environment}{captionbeside}%
+ \OParameter{entry}\Parameter{title}%
+ \OParameter{placement}\OParameter{width}%
+ \OParameter{offset}
+ \end{Environment}
+ \labelsuffix[*]%
+ \begin{Environment}{captionbeside}%
+ \OParameter{entry}\Parameter{title}%
+ \OParameter{placement}\OParameter{width}%
+ \OParameter{offset}\PValue{*}%
+ \end{Environment}
\end{Declaration}
-\BeginIndex{Env}{captionbeside}%
Apart\ChangedAt{v2.8q}{%
\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} from
captions above and below the figure, one often finds captions, in
@@ -3143,7 +3054,7 @@ standard classes. However, {\KOMAScript} offers a special environment
for this which can be used within the floating environment. The first
optional parameter \PName{entry} and the obligatory parameter
\PName{title} mean the same as the corresponding parameters of
-\Macro{caption}, \Macro{captionabove} or \Macro{captionbelow}. The
+\DescRef{\LabelBase.cmd.caption}, \DescRef{\LabelBase.cmd.captionabove} or \DescRef{\LabelBase.cmd.captionbelow}. The
caption text \PName{title} is placed beside the content of the
environment in this case.
@@ -3159,8 +3070,8 @@ one of the following letters is allowed:
Default setting is to the right of the content of the environment. This
default\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} my be changed using option
-\Option{captions}\IndexOption{captions}\important{\Option{captions}} (see
-\autopageref{desc:maincls.option.captions}) with values like
+\DescRef{\LabelBase.option.captions}\IndexOption{captions}\important{\DescRef{\LabelBase.option.captions}} (see
+\DescPageRef{\LabelBase.option.captions}) with values like
\PValue{innerbeside}\IndexOption[indexmain]{captions~=\PValue{innerbeside}},
\PValue{leftbeside}\IndexOption[indexmain]{captions~=\PValue{leftbeside}},
\PValue{outerbeside}\IndexOption[indexmain]{captions~=\PValue{outerbeside}},
@@ -3193,8 +3104,8 @@ The default vertical alignment is bottom. This means that the bottommost base
lines of the contents of the environment and of the caption are aligned. This
setting\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} may be changed using option
-\Option{captions}\IndexOption{captions} (see
-\autopageref{desc:maincls.option.captions}) with value
+\DescRef{\LabelBase.option.captions}\IndexOption{captions} (see
+\DescPageRef{\LabelBase.option.captions}) with value
\PValue{topbeside}\IndexOption[indexmain]{captions~=\PValue{topbeside}},
\PValue{centeredbeside}%
\IndexOption[indexmain]{captions~=\PValue{centeredbeside}}, or
@@ -3207,7 +3118,7 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
\begin{Example}
An example for the usage of the \Environment{captionbeside} environment
- can be found in \autoref{fig:maincls.captionbeside}.
+ can be found in \autoref{fig:\LabelBase.captionbeside}.
This figure was typeset with:
\begin{lstcode}
\begin{figure}
@@ -3224,7 +3135,7 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
}%
}
\end{captionbeside}
- \label{fig:maincls.captionbeside}
+ \label{fig:\LabelBase.captionbeside}
\end{figure}
\end{lstcode}
\begin{figure}
@@ -3235,7 +3146,7 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
\parbox[b][5\baselineskip][c]{.25\textwidth}{%
\hspace*{\fill}\KOMAScript\hspace*{\fill}\par}}
\end{captionbeside}
- \label{fig:maincls.captionbeside}
+ \label{fig:\LabelBase.captionbeside}
\end{figure}
The total width is thus the currently available width
\PValue{\Macro{linewidth}}. However, this width is shifted
@@ -3248,8 +3159,8 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
problem at all, because \KOMAScript{} itself needs \eTeX{} and every almost
up-to-date \LaTeX{} distribution uses \eTeX already.
- \hyperref[fig:maincls.captionbesidecentered]%
- {Figure~\ref*{fig:maincls.captionbesidecentered}}
+ \hyperref[fig:\LabelBase.captionbesidecentered]%
+ {Figure~\ref*{fig:\LabelBase.captionbesidecentered}}
shows a centered caption with:
\begin{lstcode}
\KOMAoption{captions}{centeredbeside}
@@ -3265,11 +3176,11 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
\parbox[b][5\baselineskip][c]{.25\textwidth}{%
\hspace*{\fill}\KOMAScript\hspace*{\fill}\par}}
\end{captionbeside}
- \label{fig:maincls.captionbesidecentered}
+ \label{fig:\LabelBase.captionbesidecentered}
\end{figure}
In opposite to the centered example, the top aligned from
- \autoref{fig:maincls.captionbesidetop} may be used. To show how to change
+ \autoref{fig:\LabelBase.captionbesidetop} may be used. To show how to change
the baseline using \Macro{raisebox}, the complete example code follows:
\begin{lstcode}
\documentclass[captions=topbeside]{scrbook}
@@ -3291,7 +3202,7 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
\includegraphics{examplepicture}%
}%
\end{captionbeside}
- \label{fig:maincls.captionbesidetop}
+ \label{fig:\LabelBase.captionbesidetop}
\end{figure}
\end{document}
\end{lstcode}
@@ -3307,48 +3218,44 @@ e.\,g., using \Macro{raisebox}\IndexCmd{raisebox}.
\hspace*{\fill}\KOMAScript\hspace*{\fill}\par}}%
}%
\end{captionbeside}
- \label{fig:maincls.captionbesidetop}
+ \label{fig:\LabelBase.captionbesidetop}
\end{figure}
You may use such a movement not only at graphics replacements like show, but
also using \Macro{includegraphics} (see \cite{package:graphics}).
\end{Example}
%
-\EndIndex{Env}{captionbeside}
+\EndIndexGroup
+
\begin{Declaration}
- \XMacro{begin}\PParameter{\Environment{captionofbeside}}%
- \Parameter{float type}%
- \OParameter{entry}\Parameter{title}\texttt{\%}\\
- \hphantom{\XMacro{begin}\PParameter{captionofbeside}}%
- \OParameter{placement}\OParameter{width}%
- \OParameter{offset}\\%
- \quad\dots\\
- \XMacro{end}\PParameter{captionofbeside}\\
- \XMacro{begin}\PParameter{captionofbeside}\Parameter{float type}%
- \OParameter{entry}%
- \Parameter{title}\texttt{\%}\\
- \hphantom{\XMacro{begin}\PParameter{captionofbeside}}%
- \OParameter{placement}\OParameter{width}%
- \OParameter{offset}\PValue{*}\\
- \quad\dots\\
- \XMacro{end}\PParameter{captionofbeside}
+ \begin{Environment}{captionofbeside}%
+ \Parameter{float type}%
+ \OParameter{entry}\Parameter{title}%
+ \OParameter{placement}\OParameter{width}%
+ \OParameter{offset}
+ \end{Environment}
+ \labelsuffix[*]%
+ \begin{Environment}{captionofbeside}%
+ \Parameter{float type}%
+ \OParameter{entry}\Parameter{title}%
+ \OParameter{placement}\OParameter{width}%
+ \OParameter{offset}\PValue{*}%
+ \end{Environment}
\end{Declaration}
-\BeginIndex{Env}{captionofbeside}%
This\ChangedAt{v3.10}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} environment corresponds to \Environment{captionbeside}
-in the same manner like \Macro{captionof} corresponds to
-\Macro{caption}. The float type is not defined by a floating environment but
-by the first mandatory argument.%
+ \Class{scrartcl}} environment corresponds to
+\DescRef{\LabelBase.env.captionbeside} in the same manner like
+\Macro{captionof} corresponds to \DescRef{\LabelBase.cmd.caption}. The float
+type is not defined by a floating environment but by the first mandatory
+argument.%
%
-\EndIndex{Env}{captionofbeside}%
+\EndIndexGroup
\begin{Declaration}
- \FloatStyle{komaabove}\\
+ \FloatStyle{komaabove}%
\FloatStyle{komabelow}
\end{Declaration}%
-\BeginIndex{Floatstyle}{komaabove}%
-\BeginIndex{Floatstyle}{komabelow}%
If you use\OnlyAt{\Package{float}} the \Package{float}\IndexPackage{float}
package the appearance of the float environments is solely defined by the
\emph{float} style. This includes whether captions above or below are used. In
@@ -3359,18 +3266,16 @@ and \PValue{komabelow}. When using the \Package{float} package these styles
can be activated just like the styles \PValue{plain}\IndexFloatstyle{plain},
\PValue{boxed}\IndexFloatstyle{boxed} or \PValue{ruled}\IndexFloatstyle{ruled}
defined in \Package{float}. For details refer to \cite{package:float}. The
-style \PValue{komaabove} inserts \Macro{caption}, \Macro{captionabove} and
-\Macro{captionbelow} above, whereas \PValue{komabelow} inserts them below the
+style \PValue{komaabove} inserts \DescRef{\LabelBase.cmd.caption}, \DescRef{\LabelBase.cmd.captionabove} and
+\DescRef{\LabelBase.cmd.captionbelow} above, whereas \PValue{komabelow} inserts them below the
float content.
%
-\EndIndex{Floatstyle}{komaabove}%
-\EndIndex{Floatstyle}{komabelow}%
+\EndIndexGroup
\begin{Declaration}
\Macro{captionformat}
\end{Declaration}%
-\BeginIndex{Cmd}{captionformat}%
In {\KOMAScript} there are different ways to change the formatting of
the caption text. The definition of different font styles was already
explained above. This or the caption delimiter between the label and
@@ -3392,26 +3297,23 @@ This too can be changed with \Macro{renewcommand}.
This definition should be put in the preamble of your document.
\end{Example}
%
-\EndIndex{Cmd}{captionformat}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{figureformat}\\
+ \Macro{figureformat}%
\Macro{tableformat}
\end{Declaration}%
-\BeginIndex{Cmd}{figureformat}%
-\BeginIndex{Cmd}{tableformat}%
-It was already mentioned that \Macro{captionformat} does not contain
-formatting for the label itself. This situation should under no
-circumstances be changed using redefinitions of the commands for the
-output of counters, \Macro{thefigure} or \Macro{thetable}. Such a
-redefinition would have unwanted side effects on the output of
-\Macro{ref} or the table of contents, list of figures and list of
-tables. To deal with the situation, {\KOMAScript} offers two
-\Macro{\dots format} commands instead. These are predefined as
-follows:
+It was already mentioned that \DescRef{\LabelBase.cmd.captionformat} does not
+contain formatting for the label itself. This situation should under no
+circumstances be changed using redefinitions of the commands for the output of
+counters, \Macro{thefigure} or \Macro{thetable}. Such a redefinition would
+have unwanted side effects on the output of \Macro{ref} or the table of
+contents, list of figures and list of tables. To deal with the situation,
+{\KOMAScript} offers two \Macro{\dots format} commands instead. These are
+predefined as follows:
% Umbruchkorrektur: listings
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\newcommand*{\figureformat}{\figurename~\thefigure\autodot}
\newcommand*{\tableformat}{\tablename~\thetable\autodot}
\end{lstcode}
@@ -3432,18 +3334,14 @@ They also can be adapted to your personal preferences with
\Environment{figure} or \Environment{table} environments.
\end{Example}
%
-\EndIndex{Cmd}{figureformat}%
-\EndIndex{Cmd}{tableformat}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{setcapindent}\Parameter{indent}\\
- \Macro{setcapindent*}\Parameter{xindent}\\
+ \Macro{setcapindent}\Parameter{indent}%
+ \Macro{setcapindent*}\Parameter{xindent}%
\Macro{setcaphanging}
\end{Declaration}%
-\BeginIndex{Cmd}{setcapindent}%
-\BeginIndex{Cmd}{setcapindent*}%
-\BeginIndex{Cmd}{setcaphanging}%
As mentioned previously, in the standard classes the captions are set
in a non-hanging style, that is, in multi-line captions the second and
subsequent lines start directly beneath the label. The standard
@@ -3465,14 +3363,15 @@ caption text but not subsequent lines are indented by
the absolute value of \PName{indent}.
Whether one-line captions are set as captions with more than one line or are
-treated separately is specified with the option \Option{captions}. For details
-please refer to the explanations of these option at
-\autopageref{desc:maincls.option.captions.oneline}.
+treated separately is specified with the option
+\DescRef{\LabelBase.option.captions}. For details please refer to the
+explanations of these option at
+\DescPageRef{\LabelBase.option.captions.oneline}.
\begin{Example}
For the examples please refer to
- figures~\ref{fig:maincls.caption.first} to
- \ref{fig:maincls.caption.last}. As you can see the usage of a fully
+ figures~\ref{fig:\LabelBase.caption.first} to
+ \ref{fig:\LabelBase.caption.last}. As you can see the usage of a fully
hanging indentation is not advantageous when combined with narrow
column width. To illustrate, the source code for the second figure
is given here with a modified caption text:
@@ -3500,7 +3399,7 @@ of the document. This also of course applies to tables.
\caption[Example: Default figure caption]%
{\sloppy Equivalent to the standard setting, similar to the
usage of \Macro{setcaphanging}}
- \label{fig:maincls.caption.first}
+ \label{fig:\LabelBase.caption.first}
\end{minipage}
\hspace{.02\linewidth}
\begin{minipage}[t]{.48\linewidth}\sloppy
@@ -3532,7 +3431,7 @@ of the document. This also of course applies to tables.
{With indentation in the second line only and line break
before the description using
\Macro{setcapindent}\PParameter{-1em}}
- \label{fig:maincls.caption.last}
+ \label{fig:\LabelBase.caption.last}
\end{minipage}
\end{minipage}
\typeout{^^J--- Don't ignore underfull and overfull
@@ -3540,21 +3439,15 @@ of the document. This also of course applies to tables.
\end{figure}
\end{Example}
%
-\EndIndex{Cmd}{setcapindent}%
-\EndIndex{Cmd}{setcapindent*}%
-\EndIndex{Cmd}{setcaphanging}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{setcapwidth}\OParameter{justification}\Parameter{width}\\
- \Macro{setcapdynwidth}\OParameter{justification}\Parameter{width}\\
- \Macro{setcapmargin}\OParameter{margin left}\Parameter{margin}\\
+ \Macro{setcapwidth}\OParameter{justification}\Parameter{width}%
+ \Macro{setcapdynwidth}\OParameter{justification}\Parameter{width}%
+ \Macro{setcapmargin}\OParameter{margin left}\Parameter{margin}%
\Macro{setcapmargin*}\OParameter{margin inside}\Parameter{margin}
\end{Declaration}
-\BeginIndex{Cmd}{setcapdynwidth}%
-\BeginIndex{Cmd}{setcapwidth}%
-\BeginIndex{Cmd}{setcapmargin}%
-\BeginIndex{Cmd}{setcapmargin*}%
Using\ChangedAt{v2.8q}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} these three
commands you can specify the width and justification of the caption
@@ -3601,9 +3494,10 @@ case of \Package{longtable}\IndexPackage{longtable}%
\important{\Package{longtable}} tables you have to deal with the same problem
with justification inside or outside as mentioned with the macro
\Macro{setcapwidth}. Furthermore, the usage of \Macro{setcapmargin} or
-\Macro{setcapmargin*} switches on the option \OptionValue{captions}{nooneline}
-(see \autopageref{desc:maincls.option.captions.nooneline}) for the captions
-which are typeset with this margin setting.
+\Macro{setcapmargin*} switches on the option
+\OptionValueRef{\LabelBase}{captions}{nooneline} (see
+\DescPageRef{\LabelBase.option.captions.nooneline}) for the captions which are
+typeset with this margin setting.
You\textnote{Hint!} can also submit negative values for \PName{margin} and
\PName{margin left} or \PName{margin inside}. This has the effect of the
@@ -3614,51 +3508,48 @@ Experts\textnote{Hint!} and advanced users may find a tricky usage of
\iffree{\cite{book:komascript}}{\autoref{cha:floattricks},
\autopageref{cha:floattricks}}.%
%
-\EndIndex{Cmd}{setcapwidth}%
-\EndIndex{Cmd}{setcapmargin}%
-\EndIndex{Cmd}{setcapmargin*}%
+\EndIndexGroup
+
\begin{Declaration}
\Option{origlongtable}
\end{Declaration}%
-\BeginIndex{Option}{origlongtable}%
\BeginIndex{Package}{longtable}%
If the table captions produced by the \Package{longtable} package (see
\cite{package:longtable}) should not be redefined by the {\KOMAScript}
classes, activate the \Option{origlongtable} option. This\textnote{Attention!}
-option has to be used at the optional argument of \Macro{documentclass}. It
-may not be used as a setting of \Macro{KOMAoptions} or \Macro{KOMAoptions}.
+option has to be used at the optional argument of
+\DescRef{\LabelBase.cmd.documentclass}. It may not be used as a setting of
+\DescRef{\LabelBase.cmd.KOMAoptions} or \DescRef{\LabelBase.cmd.KOMAoptions}.
%
-\EndIndex{Package}{longtable}%
-\EndIndex{Option}{origlongtable}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{listof}\PName{setting}
+ \OptionVName{listof}{setting}
\end{Declaration}
\BeginIndex{}{tables>list of}\BeginIndex{}{list of>tables}%
\BeginIndex{}{figures>list of}\BeginIndex{}{list of>figures}%
-\BeginIndex{Option}{listof~=\PName{setting}}%
Normally\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and
- \Class{scrartcl}} lists of floating environments\,---\,like list of
-tables or list of
-figures will neither get an
-entry at the table of contents nor have a number at the heading. More
-information about that may be found in \autoref{sec:maincls.toc}. Alternative
-to the view from the table of contents to the lists of floating environments,
-you may reconsider a view from the lists of floating environments into the
-table of contents. Because of this, there are not only the options
-\OptionValue{toc}{nolistof}\IndexOption{toc~=\PValue{nolistof}},
-\OptionValue{toc}{listof}\IndexOption{toc~=\PValue{listof}}, and
-\OptionValue{toc}{listofnumbered}\IndexOption{toc~=\PValue{listofnumbered}}
-described in \autoref{sec:maincls.toc},
-\autopageref{desc:maincls.option.toc.listof}, but also
-\OptionValue{listof}{notoc}, \OptionValue{listof}{totoc}, and
+ \Class{scrartcl}} lists of floating environments\,---\,like list of tables
+or list of figures will neither get an entry at the table of contents nor have
+a number at the heading. More information about that may be found in
+\autoref{sec:\LabelBase.toc}. Alternative to the view from the table of
+contents to the lists of floating environments, you may reconsider a view from
+the lists of floating environments into the table of contents. Because of
+this, there are not only the options
+\OptionValueRef{\LabelBase}{toc}{nolistof}%
+\IndexOption{toc~=\PValue{nolistof}},
+\OptionValueRef{\LabelBase}{toc}{listof}\IndexOption{toc~=\PValue{listof}},
+and \OptionValueRef{\LabelBase}{toc}{listofnumbered}%
+\IndexOption{toc~=\PValue{listofnumbered}} described in
+\autoref{sec:\LabelBase.toc}, \DescPageRef{\LabelBase.option.toc.listof}, but
+also \OptionValue{listof}{notoc}, \OptionValue{listof}{totoc}, and
\OptionValue{listof}{numbered} with the same meaning.
By default the headings of the lists of floating environments use the topmost
-level below \Macro{part}. This is the chapter level at \Class{scrbook} and
-\Class{scrreprt} and the section level at
+level below \DescRef{\LabelBase.cmd.part}. This is the chapter level at
+\Class{scrbook} and \Class{scrreprt} and the section level at
\Class{scrartcl}. With\ChangedAt{v3.06}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}}
\OptionValue{listof}{leveldown}\important{\OptionValue{listof}{leveldown}} a
@@ -3677,8 +3568,9 @@ one step lower level will be used instead.
\listoftables
\end{lstcode}
for the new list, that contains the list of figures and the list of
- tables. More information about the command \Macro{addchap*} may be found in
- \autoref{sec:maincls.structure} at \autopageref{desc:maincls.cmd.addchap*}.
+ tables. More information about the command \DescRef{\LabelBase.cmd.addchap*}
+ may be found in \autoref{sec:\LabelBase.structure} at
+ \DescPageRef{\LabelBase.cmd.addchap*}.
\end{Example}
Normally\ChangedAt{v2.8q}{%
@@ -3693,13 +3585,14 @@ have a lot of tables or figures\,---\, their may be not enough width
predefined. There's\important{\OptionValue{listof}{flat}} a setting
\OptionValue{listof}{flat}\IndexOption{listof~=\PValue{flat}} for the lists of
floating environment similar to
-\OptionValue{toc}{flat}\IndexOption{toc~=\PValue{flat}} for the table of
-contents. Thereby the needed with for printing the number will be determined
-at each \LaTeX{} run. See option \OptionValue{toc}{flat},
-\autoref{sec:maincls.toc}, \autopageref{desc:maincls.option.toc.flat} for
-information about how it works. Please\textnote{Attention!} note again, that
-you need more than one \LaTeX{} runs until the lists of floating environments
-will become their final result.
+\OptionValueRef{\LabelBase}{toc}{flat}\IndexOption{toc~=\PValue{flat}} for the
+table of contents. Thereby the needed with for printing the number will be
+determined at each \LaTeX{} run. See option
+\OptionValueRef{\LabelBase}{toc}{flat}, \autoref{sec:\LabelBase.toc},
+\DescPageRef{\LabelBase.option.toc.flat} for information about how it
+works. Please\textnote{Attention!} note again, that you need more than one
+\LaTeX{} runs until the lists of floating environments will become their final
+result.
Setting \OptionValue{listof}{entryprefix}\ChangedAt{v3.06}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} will automatically activate
@@ -3740,18 +3633,19 @@ gap it adds the table of contents entry for the chapter additionally to the
lists of floating environments. Please\textnote{Attention!} note, that this
would also happen, if the chapter does not have any floating
environment. Additional influence of chapters to the lists of floating
-environments is available with option \Option{chapteratlists}. See
-\autoref{sec:maincls.structure},
-\autopageref{desc:maincls.option.chapteratlists} for more information about
+environments is available with option
+\DescRef{\LabelBase.option.chapteratlists}. See
+\autoref{sec:\LabelBase.structure},
+\DescPageRef{\LabelBase.option.chapteratlists} for more information about
that.
An overview about all settings to option \Option{listof} may be found at
-\autoref{tab:maincls.listof}.
+\autoref{tab:\LabelBase.listof}.
\begin{desclist}
\desccaption[{Available values for option \Option{listof}}]{%
Available values for option \Option{listof} to modify contents and
- formation of the lists of floating environments\label{tab:maincls.listof}%
+ formation of the lists of floating environments\label{tab:\LabelBase.listof}%
}{%
Available values for option \Option{listof} (\emph{continuation})%
}%
@@ -3810,45 +3704,43 @@ An overview about all settings to option \Option{listof} may be found at
\IndexOption{listof~=\PValue{totoc}}}%
\end{desclist}
%
-\EndIndex{Option}{listof~=\PName{setting}}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{listoftables}\\
+ \Macro{listoftables}%
\Macro{listoffigures}
\end{Declaration}
-\BeginIndex{Cmd}{listoftables}%
-\BeginIndex{Cmd}{listoffigures}%
+\BeginIndex{}{tables>list of}\BeginIndex{}{list of>tables}%
+\BeginIndex{}{figures>list of}\BeginIndex{}{list of>figures}%
These commands generate a list of tables or figures. Changes in the document
that modify these lists will require two {\LaTeX} runs in order to take
effect. The layout of the lists can be influenced by the option
-\Option{listof}\important{\Option{listof}} with values \PValue{graduated} or
-\PValue{flat} (see \autopageref{desc:maincls.option.listof}). Moreover, the
-values \PValue{listof} and \PValue{listofnumbered} of option
-\Option{toc}\important{\Option{toc}} (see \autoref{sec:maincls.toc}) as well
-as the values \PValue{totoc} and \PValue{numbered} of the previous described
-option \Option{listof} have influence to the lists of floating environments.
+\DescRef{\LabelBase.option.listof}\important{\DescRef{\LabelBase.option.listof}}
+with values \PValue{graduated} or \PValue{flat} (see
+\DescPageRef{\LabelBase.option.listof}). Moreover, the values \PValue{listof}
+and \PValue{listofnumbered} of option
+\DescRef{\LabelBase.option.toc}\important{\DescRef{\LabelBase.option.toc}}
+(see \autoref{sec:\LabelBase.toc}) as well as the values \PValue{totoc} and
+\PValue{numbered} of the previous described option
+\DescRef{\LabelBase.option.listof} have influence to the lists of floating
+environments.
Mostly\textnote{Hint!} the lists of floating environment may be found after
the table of contents. But some publishers like to have these lists at the
appendix. Nevertheless the author of this guide prefers to find them
immediately after the table of contents.%
-\EndIndex{Cmd}{listoftables}%
-\EndIndex{Cmd}{listoffigures}%
+\EndIndexGroup
%
-\EndIndex{}{figures>list of}\EndIndex{}{list of>figures}%
-\EndIndex{}{tables>list of}\EndIndex{}{list of>tables}%
-%
-\EndIndex{}{figures}%
-\EndIndex{}{tables}%
-\EndIndex{}{floats}
+\EndIndexGroup
-\LoadCommon{13}% \section{Margin Notes}
+\LoadCommonFile{marginpar}% \section{Margin Notes}
\section{Appendix}
\seclabel{appendix}
+\BeginIndexGroup
\BeginIndex{}{appendix}
The appendix of a document contains mainly the enclosures to the
@@ -3862,33 +3754,35 @@ should also be part of the appendix.
\begin{Declaration}
\Macro{appendix}
\end{Declaration}%
-\BeginIndex{Cmd}{appendix}%
The appendix in the standard as well as the {\KOMAScript} classes is
introduced with \Macro{appendix}. This command switches, among other things,
the chapter numbering to upper case letters, also ensuring that the rules
according to \cite{DUDEN} are followed (for German-speaking regions). These
rules are explained in more detail in the description of the option
-\Option{numbers} in \autoref{sec:maincls.structure},
-\autopageref{desc:maincls.option.numbers}.
+\DescRef{\LabelBase.option.numbers} in \autoref{sec:\LabelBase.structure},
+\DescPageRef{\LabelBase.option.numbers}.
Die output of the chapter headings\OnlyAt{\Class{scrbook}\and
\Class{scrreprt}} in the appendix are influenced by the options
-\Option{chapterprefix} and \Option{appendixprefix}. See
-\autoref{sec:maincls.structure},
-\autopageref{desc:maincls.option.appendixprefix} for more information.
+\DescRef{\LabelBase.option.chapterprefix} and
+\DescRef{\LabelBase.option.appendixprefix}. See
+\autoref{sec:\LabelBase.structure},
+\DescPageRef{\LabelBase.option.appendixprefix} for more information.
Please\textnote{Attention!} note that \Macro{appendix} is a command,
\emph{not} an environment! This command does not expect any
-argument. Chapters and sections in the appendix uses \Macro{chapter} and
-\Macro{section} just as does the main text.%
+argument. Chapters and sections in the appendix uses
+\DescRef{\LabelBase.cmd.chapter} and \DescRef{\LabelBase.cmd.section} just as
+does the main text.%
%
-\EndIndex{Cmd}{appendix}%
+\EndIndexGroup
%
-\EndIndex{}{appendix}
+\EndIndexGroup
\section{Bibliography}
\seclabel{bibliography}
+\BeginIndexGroup
\BeginIndex{}{bibliography}
The bibliography opens up external resources. Mainly bibliographies will be
@@ -3904,9 +3798,8 @@ may be found in \cite{lshort}.
\begin{Declaration}
- \KOption{bibliography}\PName{selection}
+ \OptionVName{bibliography}{selection}
\end{Declaration}
-\BeginIndex{Option}{bibliography~=\PName{selection}}%
For a start, \PName{selection}\ChangedAt{v3.00}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} may be any already defined
bibliography formation style. There are two predefined formation styles at
@@ -3921,7 +3814,7 @@ Option\important{\OptionValue{bibliography}{oldstyle}}
\OptionValue{bibliography}{oldstyle}%
\IndexOption{bibliography~=\PValue{oldstyle}} selects a compact formation of
the bibliography entries. In this case command
-\Macro{newblock}\IndexCmd{newblock} inside of the entries will only result in
+\DescRef{maincls-experts.cmd.newblock}\IndexCmd{newblock} inside of the entries will only result in
a small horizontal distance. The name is a result of the fact, that this is
the mostly used classic kind of bibliography. In opposite to
this\important[i]{\begin{tabular}[t]{@{}l@{}}
@@ -3930,12 +3823,12 @@ this\important[i]{\begin{tabular}[t]{@{}l@{}}
\OptionValue{bibliography}{openstyle}%
\IndexOption{bibliography~=\PValue{openstyle}}. selects a more modern and open
kind of bibliography. The name is a result of the fact, that command
-\Macro{newblock} inserts a paragraph break. The entries will be more
+\DescRef{maincls-experts.cmd.newblock} inserts a paragraph break. The entries will be more
structured by this. They are less compact and seem more relaxed or
open. Information about definition of new formation styles may be found in
-description of command \Macro{newbibstyle} in
+description of command \DescRef{maincls-experts.cmd.newbibstyle} in
\autoref{sec:maincls-experts.experts} at
-\autopageref{desc:maincls-experts.cmd.newbibstyle}.
+\DescPageRef{maincls-experts.cmd.newbibstyle}.
Beside the formation style one more feature may be selected using
\PName{selection}. The bibliography is a kind of contents list. But instead of
@@ -3956,10 +3849,10 @@ the table of contents. A entry without number may be set with option
neither a number nor an entry to the table of contents and corresponds to
\OptionValue{bibliography}{nottotoc}%
\IndexOption{bibliography~=\PValue{nottotoc}}. For more information see option
-\Option{toc} in \autoref{sec:maincls.toc}, especially values
+\DescRef{\LabelBase.option.toc} in \autoref{sec:\LabelBase.toc}, especially values
\PValue{bibliographynumbered}, \PValue{bibliography}, and
\PValue{nobibliography} to this option at
-\autopageref{desc:maincls.option.toc.bibliography}.
+\DescPageRef{\LabelBase.option.toc.bibliography}.
Sometimes\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} it is not usefull to have one bibliography for the whole
@@ -3973,15 +3866,15 @@ combine several lists and the bibliography together below one heading. So this
option is also available with \Class{scrartcl}.
A summary of all available values for option \Option{bibliography} may be
-found in \autoref{tab:maincls.bibliography}. Nevertheless you should note,
+found in \autoref{tab:\LabelBase.bibliography}. Nevertheless you should note,
that additional values may be generated using
-\Macro{newbibstyle}\IndexCmd{newbibstyle}.
+\DescRef{maincls-experts.cmd.newbibstyle}\IndexCmd{newbibstyle}.
\begin{table}
\caption[{Available values of option \Option{bibliography}}]{%
Predefined values of option \Option{bibliography} to select the formation
of the bibliography}
- \label{tab:maincls.bibliography}
+ \label{tab:\LabelBase.bibliography}
\begin{desctabular}
\pventry{leveldown}{%
\ChangedAt{v3.12}{\Class{scrbook}\and \Class{scrreprt}\and
@@ -3995,12 +3888,13 @@ that additional values may be generated using
\IndexOption{bibliography~=\PValue{nottotoc}}}%
\pventry{oldstyle}{%
The bibliography will use the classic, compact formation, where
- \Macro{newblock}\IndexCmd{newblock} generates an expandable
- horizontal distance only.%
+ \DescRef{maincls-experts.cmd.newblock}\IndexCmd{newblock} generates an
+ expandable horizontal distance only.%
\IndexOption{bibliography~=\PValue{oldstyle}}}%
\pventry{openstyle}{%
The bibliography will use the structured, open formation, where
- \Macro{newblock}\IndexCmd{newblock} generates a paragraph break.%
+ \DescRef{maincls-experts.cmd.newblock}\IndexCmd{newblock} generates a
+ paragraph break.%
\IndexOption{bibliography~=\PValue{openstyle}}}%
\pventry{totoc}{%
The bibliography will have an entry at the table of contents but no
@@ -4013,25 +3907,25 @@ that additional values may be generated using
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{bibliography~=\PName{selection}}%
+\EndIndexGroup
\begin{Declaration}
\Macro{setbibpreamble}\Parameter{preamble}
\end{Declaration}%
-\BeginIndex{Cmd}{setbibpreamble}%
The command \Macro{setbibpreamble} can be used to set a preamble for the
bibliography\Index{bibliography}. This can be achieved by placing the preamble
before the command for issuing the bibliography. However, it need not be
directly in front of it. For example, it could be placed at the beginning of
the document. Similar\textnote{Attention!} to the options
-\OptionValue{bibliography}{totoc} and
-\OptionValue{bibliography}{totocnumbered}, this command can only be successful
-if you have not loaded a package which prevents this by redefining the
-\Environment{thebibliography} environment. Even though the \Package{natbib}
-package\IndexPackage{natbib} makes unauthorized use of internal macros of
-{\KOMAScript} it could be achieved that \Macro{setbibpreamble} works with the
-current version of \Package{natbib} (see \cite{package:natbib}).
+\OptionValueRef{\LabelBase}{bibliography}{totoc} and
+\OptionValueRef{\LabelBase}{bibliography}{totocnumbered}, this command can
+only be successful if you have not loaded a package which prevents this by
+redefining the \Environment{thebibliography} environment. Even though the
+\Package{natbib} package\IndexPackage{natbib} makes unauthorized use of
+internal macros of {\KOMAScript} it could be achieved that
+\Macro{setbibpreamble} works with the current version of \Package{natbib} (see
+\cite{package:natbib}).
\begin{Example}
You want to point out that the sorting of the references in the
bibliography is not according to their occurrence in the text, but
@@ -4046,32 +3940,30 @@ current version of \Package{natbib} (see \cite{package:natbib}).
space.%
\end{Example}%
%
-\EndIndex{Cmd}{setbibpreamble}
+\EndIndexGroup
\begin{Declaration}
\Macro{BreakBibliography}\Parameter{interruption code}
\end{Declaration}
-\BeginIndex{Cmd}{BreakBibliography}%
This\textnote{Attention!}\ChangedAt{v3.00}{\Class{scrbook}\and
\Class{scrreprt}\and \Class{scrartcl}} command exists only if the
environment \Environment{thebibliography} has not been redefined by another
package. It provides a break at the bibliography. The \PName{interruption
code} will be expanded inside a group. Such a break may be, e.\,g., a
-heading using \Macro{minisec}. Unfortunately it is not possible to add this
-command to the \BibTeX{} database using, e.\,g., a special kind of \BibTeX{}
-entry. Because of this, users may use is currently only if they make the
-bibliography on their own. Because of this usage is very limited.%
+heading using \DescRef{\LabelBase.cmd.minisec}. Unfortunately it is not
+possible to add this command to the \BibTeX{} database using, e.\,g., a
+special kind of \BibTeX{} entry. Because of this, users may use is currently
+only if they make the bibliography on their own. Because of this usage is very
+limited.%
%
-\EndIndex{Cmd}{BreakBibliography}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{AfterBibliographyPreamble}\Parameter{code}\\
+ \Macro{AfterBibliographyPreamble}\Parameter{code}%
\Macro{AtEndBibliography}\Parameter{code}
\end{Declaration}
-\BeginIndex{Cmd}{AfterBibliographyPreamble}%
-\BeginIndex{Cmd}{AtEndBibliography}%
In\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}
some cases it may be useful to add some \PName{code} after the bibliography
preamble or just before the end of the bibliography. This may be achieved
@@ -4089,16 +3981,16 @@ using one of this instructions.
The\textnote{Attention!} functionality of this instruction depends on
cooperation with packages modifying the bibliography, if such a package should
be used (see \autoref{sec:maincls-experts.coexistence},
-\autopageref{desc:maincls-experts.cmd.AfterBibliographyPreamble}).%
+\DescPageRef{maincls-experts.cmd.AfterBibliographyPreamble}).%
%
-\EndIndex{Cmd}{AtEndBibliography}%
-\EndIndex{Cmd}{AfterBibliographyPreamble}%
+\EndIndexGroup
%
-\EndIndex{}{bibliography}
+\EndIndexGroup
\section{Index}
\seclabel{index}
+\BeginIndexGroup
\BeginIndex{}{index}
For general information about making an index see \cite{lshort},
@@ -4109,9 +4001,8 @@ index hardly. This would be valid, e.\,g., for usage of package
\Package{splitidx}\IndexPackage{splitidx} (see \cite{package:splitindex}).
\begin{Declaration}
- \KOption{index}\PName{selection}%
+ \OptionVName{index}{selection}%
\end{Declaration}
-\BeginIndex{Option}{index~=\PName{selection}}%
\ChangedAt{v3.00}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}}%
The index is chapter (\Class{scrbook} or \Class{scrreprt}) or section
(\Class{scrartcl}) without heading number or entry at the table of contents by
@@ -4124,16 +4015,16 @@ document. Nevertheless, such an entry may be achieved using option
You\ChangedAt{v3.18}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} can even number the index using option
\OptionValue{index}{numbered}\IndexOption{index~=\PValue{numbered}}. See also
-option \Option{toc} with value \PValue{index} or \PValue{indexnumbered} in
-\autoref{sec:maincls.toc} from \autopageref{desc:maincls.option.toc.index}
-onward.
+option \DescRef{\LabelBase.option.toc} with value \PValue{index} or
+\PValue{indexnumbered} in \autoref{sec:\LabelBase.toc} from
+\DescPageRef{\LabelBase.option.toc.index} onward.
A summary of all available values for option \Option{index} may be found in
-\autoref{tab:maincls.index}.
+\autoref{tab:\LabelBase.index}.
\begin{table}
\caption{Available values of option \Option{index}}%
- \label{tab:maincls.index}
+ \label{tab:\LabelBase.index}
\begin{desctabular}
\entry{\PValue{default}, \PValue{nottotoc}, \PValue{plainheading}}{%
The index will not have an entry at the table of contents.%
@@ -4151,13 +4042,12 @@ A summary of all available values for option \Option{index} may be found in
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{index~=\PName{selection}}%
+\EndIndexGroup
\begin{Declaration}
\Macro{setindexpreamble}\Parameter{preamble}
\end{Declaration}%
-\BeginIndex{Cmd}{setindexpreamble}%
Similarly to the bibliography you can use a preamble to the
index. This is often the case if you have more than one index or if
you use different kinds of referencing by highlighting the page
@@ -4174,24 +4064,24 @@ numbers in different ways.
\end{lstcode}
\end{Example}
-Please note that the page style of the first page of the index is
-changed. The applied page style is defined in the macro
-\Macro{indexpagestyle} (see \autoref{sec:maincls.pagestyle},
-\autopageref{desc:maincls.cmd.titlepagestyle}).
+Please note that the page style of the first page of the index is changed. The
+applied page style is defined in the macro
+\DescRef{\LabelBase.cmd.indexpagestyle} (see
+\autoref{sec:\LabelBase.pagestyle},
+\DescPageRef{\LabelBase.cmd.indexpagestyle}).
The production, sorting and output of the index is done by the
standard {\LaTeX} packages and additional programs. Similar to the
standard classes {\KOMAScript} only provides the basic macros and
environments.%
%
-\EndIndex{Cmd}{setindexpreamble}%
+\EndIndexGroup
%
-\EndIndex{}{index}
+\EndIndexGroup
%
%
-\EndIndex{Class}{scrbook}%
-\EndIndex{Class}{scrreprt}%
-\EndIndex{Class}{scrartcl}%
+\EndIndexGroup
+
\endinput