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.tex3206
1 files changed, 1704 insertions, 1502 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 263b3c74128..f1115446cce 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
@@ -40,22 +40,22 @@
%
% ----------------------------------------------------------------------
%
-% Kapitel über scrbook, scrreprt und scrartcl in der KOMA-Script-Anleitung
+% Kapitel über scrbook, scrreprt und scrartcl in der KOMA-Script-Anleitung
% Verwaltet von Markus Kohm
%
% ============================================================================
-\ProvidesFile{scrbookreportarticle.tex}[2007/01/09 KOMA-Script guide (chapter:
+\ProvidesFile{scrbookreportarticle.tex}[2007/09/27 KOMA-Script guide (chapter:
scrbook, scrreprt, scrartcl)]
-% Date of translated german file: 2005-11-26
+\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm}
-% TODO: See further TODO comments
+% Date of translated german file: 2007-09-04
-\chapter{The Main Classes \Class{scrbook}, \Class{scrrprt} and
+\chapter{The Main Classes \Class{scrbook}, \Class{scrreprt} and
\Class{scrartcl}}
\labelbase{maincls}
-\AddSeeIndex{command}{gen}{\GuidecmdIndexShort}{cmd}
+%\AddSeeIndex{command}{gen}{\GuidecmdIndexShort}{cmd}% <-- set automaticly
\AddSeeIndex{macro}{gen}{\GuidecmdIndexShort}{cmd}%
\begin{Explain}
@@ -65,40 +65,40 @@ scrbook, scrreprt, scrartcl)]
classes \Class{book}\IndexClass{book},
\Class{report}\IndexClass{report} and
\Class{article}\IndexClass{article}. There is also a replacement for
- the standard class \Class{letter}\IndexClass{letter}. The
- document class for letters is described in a separate chapter,
- because it is fundamentally different from the three main classes
- (see \autoref{cha:scrlttr2}).The names of the {\KOMAScript}
- classes are composed of the prefix "\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 if necessary. The
- \autoref{tab:maincls.overview} shows an overview. The table also
- includes the names of the \LaTeX2.09 style files that were used in
- {\KOMAScript}.
+ the standard class \Class{letter}\IndexClass{letter}. The document
+ class for letters is described in a separate chapter, because it is
+ fundamentally different from the three main classes (see
+ \autoref{cha:scrlttr2}).The names of the {\KOMAScript} classes are
+ composed of the prefix ``\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 between the standard classes and
+ the {\KOMAScript} classes.
\end{Explain}
-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}. Normally the document
-should be processed without errors by \LaTeX{}, just like before the
-substitution. The look however should be different. Additionally, the
-\KOMAScript{} classes provide new possibilities and options that are
-described in the following sections.
+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}. Normally, the
+document should be processed without errors by {\LaTeX}, just like
+before the substitution. The look however should be
+different. Additionally, the {\KOMAScript} classes provide new
+possibilities and options that are described in the following
+sections.
\begin{table}[htbp]
\centering
\caption[Class correspondence]{Correspondence between
- standard classes, \KOMAScript{} classes and
+ standard classes, {\KOMAScript} classes and
\Script{} styles.}
\begin{tabular}{ll}
\toprule
- standard class & \KOMAScript{} class \\%& \Script-Stil (\LaTeX2.09)\\
+ standard class & {\KOMAScript} class \\%& \Script-Stil (\LaTeX2.09)\\
\midrule
\Class{article} & \Class{scrartcl} \\%& \File{script\textunderscore s} \\
\Class{report} & \Class{scrreprt} \\%& \File{script} \\
\Class{book} & \Class{scrbook} \\%& \File{script} \\
- \Class{letter} & \Class{scrlettr} \\%& \File{script\textunderscore l} \\
+ \Class{letter} & \Class{scrlttr2} \\%& \File{script\textunderscore l} \\
\bottomrule
\end{tabular}
\label{tab:maincls.overview}
@@ -124,7 +124,7 @@ set, either by default or by the user.
\begin{table}[htbp]
\centering
- \caption{Default options of the \KOMAScript{} classes}
+ \caption{Default options of the {\KOMAScript} classes}
\begin{tabular}{llll}
Option &
\Class{scrbook} & \Class{scrreprt} & \Class{scrartcl} \\
@@ -137,6 +137,8 @@ set, either by default or by the user.
\emph{undefined} & default & default \\
\Option{bigheadings} &
default & default & default \\
+ \Option{chapteratlists=} &
+ \PValue10{pt} & \PValue{10pt} & \emph{undefined} \\
\Option{final} &
default & default & default \\
\Option{footnosepline} &
@@ -169,6 +171,8 @@ set, either by default or by the user.
default & default & default \\
\Option{twoside} &
default & & \\
+ \Option{version=} &
+ \PValue{first} & \PValue{first} & \PValue{first} \\
\end{tabular}
\label{tab:maincls.stdOptions}
\end{table}
@@ -187,70 +191,68 @@ set, either by default or by the user.
that is done, you can concentrate on the fine points of
presentation. Besides the choice of options, this means correcting
things like hyphenation, page breaks, and the distribution of tables
- and figures. As an example consider the
- \autoref{tab:maincls.stdOptions} that I have moved repeatedly
- between the beginning and the end of this section. The choice of the
- actual position will only be made during the final production of the
+ and figures. As an example consider
+ \autoref{tab:maincls.stdOptions}, which I moved repeatedly between
+ the beginning and the end of this section. The choice of the actual
+ position will only be made during the final production of the
document.
\end{Explain}
\par
-\subsection{Optionen for Compatibility}
+\subsection{Options for Compatibility}
\label{sec:maincls.compatibilityOptions}
\BeginIndex{}{Compatibility}
-% TODO: Translate this
-\minisec{Sorry, Still waiting for translation:}
-Wer seine Dokumente im Quellcode archiviert, legt in der Regel allergroessten
-Wert darauf, dass bei zukuenftigen \LaTeX{}-Laeufen immer wieder exakt dasselbe
-Ergebnis erzielt wird. In einigen Faellen ist es aber so, dass Verbesserungen
-und Korrekturen an der Klasse zu aenderungen im Verhalten, inbesondere beim
-Umbruch, fuehren.
+% added translation 29 May 2007, 22:30 LT
+Users who archive their documents as source code generally place great value
+on obtaining exactly the same output in future {\LaTeX} runs. However, in some
+cases, improvements and corrections to a class can lead to changes in
+behaviour, particularly as regards line and page breaks.
\begin{Declaration}
\Option{version}\\
- \XOption{version}=\PName{Wert}
+ \XOption{version}=\PName{value}
\end{Declaration}
\BeginIndex{Option}{version}%
-Seit\ChangedAt{v2.96a}{\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}
-Version~2.96a besteht bei \KOMAScript\ die Wahl, ob eine Quelldatei so weit
-irgend moeglich auch zukuenftig bei einem \LaTeX{}-Lauf zu exakt demselben
-Ergebnis fuehren soll oder ob jeweils entsprechend der Anpassungen der neusten
-Version der Klasse zu setzen ist. Zu welcher Version Kompatibilitaet
-herzustellen ist, wird dabei ueber die Option \Option{version}
-festgelegt. Voreingestellt ist Version~2.9t. Dasselbe Ergebnis kann mit
+Since\ChangedAt{v2.96a}{\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}
+version~2.96a {\KOMAScript} offers the choice of whether a source file
+should output as far as possible identical results in future {\LaTeX}
+runs, or whether output should be determined according to the latest
+changes in the class. The option \Option{version} determines with
+which version compatibility is to be maintained. The default setting
+is version~2.9t. The same result can be achieved by setting
\begin{lstlisting}
version=first
\end{lstlisting}
-oder
+or
\begin{lstlisting}
version=2.9
\end{lstlisting}
-oder
+or
\begin{lstlisting}
- version=2.9t
+ version=2.9t.
\end{lstlisting}
-erreicht werden. Bei Angabe einer unbekannten Version als \PName{Wert} wird
-eine Warnung ausgegeben und sicherheitshalber \Option{version=}\PValue{first}
-angenommen. Mit
+If an unknown version number is given as \PName{value} a warning is
+output and for safety's sake the option is set to
+\Option{version=}\PValue{first}. With
\begin{lstlisting}
version=last
\end{lstlisting}
-kann die jeweils neuste Version ausgewaehlt werden. In diesem Fall wird also
-auf zukuenftige Kompatibilitaet verzichtet. Wird die Option ohne Wertangabe
-verwendet, so wird ebenfalls \PValue{last} angenommen.
-
-Die Frage der Kompatiblitaet betrifft in erster Linie Fragen des Umbruchs. Neue
-Moeglichkeiten, die sich nicht auf den Umbruch auswirken, sind auch dann
-verfuegbar, wenn man per Option die Kompatibilitaet zu einer aelteren Version
-ausgewaehlt hat. Die Option hat keine Auswirkungen auf Umbruchaenderungen, die
-bei Verwendung einer neueren Version durch Beseitigung eindeutiger Fehler
-entstehen. Wer auch im Fehlerfall unbedingte Umbruchkompatibitlitaet benoetigt,
-sollte stattdessen mit dem Dokument auch die verwendete \KOMAScript-Version
-archivieren.
-
-Es ist zu beachten, dass die Option \Option{version} nach dem Laden der Klasse
-nicht mehr veraendert werden kann.%
+the current latest version can be selected. In this case future
+compatibility is switched off. If the option is used without a value,
+then once again the value of \PValue{last} is assumed.
+
+The question of compatibility is first of all a question of line and page
+breaking. New capabilities, which do not affect page breaks, are also
+available if the option of compatibility to an older version is
+selected. The option has no effect on changes in the page breaking
+when using a newer version, which result purely through the correction
+of errors. If absolute compatibility including errors is required,
+then the requisite {\KOMAScript} version should be archived along with
+the document source.
+
+It should be noted that the option \Option{version} cannot be changed
+after the loading of the class.%
%
\EndIndex{Option}{version}%
%
@@ -259,17 +261,21 @@ nicht mehr veraendert werden kann.%
\subsection{Options for Page Layout}
\label{sec:maincls.typeareaOptions}
-With the standard classes the page layout\Index{page layout} is established by
-the option files \File{size10.clo}, \File{size11.clo}, \File{size12.clo} (or
-\File{bk10.clo}, \File{bk11.clo}, \File{bk12.clo} for the book class) and by
-fixed values in the class definitions. The \KOMAScript{} classes, however, do
-not use a fixed page layout, but one that depends on the paper
-format\Index{paper format} and font size. For this task all three main classes
-use the \Package{typearea} package\IndexPackage{typearea} (see
+With the standard classes the page layout\Index{page>layout} is
+established by the option files \File{size10.clo}, \File{size11.clo},
+\File{size12.clo} (or \File{bk10.clo}, \File{bk11.clo},
+\File{bk12.clo} for the book class) and by fixed values in the class
+definitions. The {\KOMAScript} classes, however, do not use a fixed
+page layout, but one that depends on the paper format\Index{paper
+ format} and font size. For this task all three main classes use the
+\Package{typearea} package\IndexPackage{typearea} (see
\autoref{cha:typearea}). The package is automatically loaded by the
-\KOMAScript{} main classes. Therefore it is not necessary to use the command
-\Macro{usepackage}\OParameter{package options}\PParameter{typearea}
-explicitly.
+{\KOMAScript} main classes. Therefore it is not necessary to load the
+package using \Macro{usepackage}\PParameter{typearea}. If a {\LaTeX}
+run results in an error ``\texttt{Option clash for package
+ typearea}'', then this is most likely owing to the use of an
+explicit command \Macro{usepackage}\OParameter{package
+ options}\PParameter{typearea}.
\begin{Declaration}
@@ -290,14 +296,16 @@ explicitly.
\BeginIndex{Option}{c0paper}%
\BeginIndex{Option}{d0paper}%
\BeginIndex{Option}{landscape}%
-The basic options for the choice of paper format are not processed directly by
-the classes. They are automatically processed by the \Package{typearea}
-package as global options (see \autoref{sec:typearea.options},
-\autopageref{desc:typearea.option.letterpaper}). The options \Option{a5paper},
-\Option{a4paper}, \Option{letterpaper}, \Option{legalpaper} and
-\Option{executivepaper} correspond to the options of the standard classes that
-have the same name and define the same paper format. The page layout
-calculated for each is different, however.
+The basic options for the choice of paper format are not processed
+directly by the classes. Instead, they are automatically processed by
+the \Package{typearea} package as global options (see
+\autoref{sec:typearea.options},
+\autopageref{desc:typearea.option.letterpaper}). The options
+\Option{a5paper}, \Option{a4paper}, \Option{letterpaper},
+\Option{legalpaper} and \Option{executivepaper} correspond to the
+likewise-named options of the standard classes and define the same
+paper format. The page layout calculated for each is different,
+however.
%
\EndIndex{Option}{letterpaper}%
\EndIndex{Option}{legalpaper}%
@@ -309,16 +317,16 @@ calculated for each is different, however.
\EndIndex{Option}{landscape}
\begin{Explain}
- The options for the A, B, C or D format are actually not processed
- by the \Package{typearea}, because they are global options, but
- because the \KOMAScript{} classes explicitly pass them to the
- \Package{typearea} package. This is caused by the way option
+ The reason that the options for the A, B, C or D format are not
+ processed by the \Package{typearea} is not because they are global
+ options, but because the {\KOMAScript} classes explicitly pass them
+ to the \Package{typearea} package. This is caused by the way option
processing is implemented in the \Package{typearea} package and by
the operation of the underlying option passing and processing
- mechanism of \LaTeX.
+ mechanism of {\LaTeX}.
This is also valid for the options, described subsequently, that set
- the binding correcting, the divisor and the number of header lines.
+ the binding correction, the divisor and the number of header lines.
\end{Explain}
@@ -351,10 +359,11 @@ for the option that sets the number of header lines.
\subsection{Options for Document Layout}
\label{sec:maincls.layoutOptions}
-This subsection collects all the options that affect the document
-layout, not only the page layout. Strictly speaking all page layout
-options (see \autoref{sec:maincls.typeareaOptions}) are also
-document layout options. The reverse is also partially true.
+This subsection deals with all the options that affect the document
+layout in general and not only the page layout. Strictly speaking, of
+course, all page layout options (see
+\autoref{sec:maincls.typeareaOptions}) are also document layout
+options. The reverse is also partially true.
\begin{Declaration}
\Option{oneside}\\
@@ -362,16 +371,16 @@ document layout options. The reverse is also partially true.
\end{Declaration}%
\BeginIndex{Option}{oneside}
\BeginIndex{Option}{twoside}%
-These two options have the same effect as with the standard classes.
+These two options have the same effect as in the standard classes.
The option \Option{oneside} defines a one-sided document layout with a
one-sided page layout. This means in particular that normally a ragged
page bottom is used.
The option \Option{twoside} defines a two-sided document layout with a
-two-sided page layout. This means that the \LaTeX{} command
+two-sided page layout. This means that the {\LaTeX} command
\Macro{flushbottom}\IndexCmd{flushbottom} is used to ensure that page
-breaks don't leave a variable empty space at the bottom of the page. A
-ragged page bottom can be obtained with the \LaTeX{} command
+breaks don't leave a variable empty space at the bottom of a page. A
+ragged page bottom can be obtained with the {\LaTeX} command
\Macro{raggedbottom}\IndexCmd{raggedbottom}.
%
\EndIndex{Option}{oneside}%
@@ -386,7 +395,7 @@ ragged page bottom can be obtained with the \LaTeX{} command
\BeginIndex{Option}{twocolumn}%
These options have the same effect as the corresponding standard
options. They are used to switch between a one-column and a two-column
-layout. The standard \LaTeX{} capabilities for multi-column layout are
+layout. The standard {\LaTeX} capabilities for multi-column layout are
only useful for very simple uses. The standard package
\Package{multicol} is much more versatile (see
\cite{package:multicol}).\Index{columns}\IndexPackage{multicol}
@@ -402,16 +411,16 @@ only useful for very simple uses. The standard package
\BeginIndex{Option}{openright}%
These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} options have the
same effect as the corresponding standard options. They affect the
-choice of the page where a chapter\Index[indexmain]{chapter} can begin,
-so they are not available with the \Class{scrartcl} class, since there
-the main unit below ``part'' is the ``section''. The chapter level is
-not available in \Class{scrartcl}.
+choice of the page where a chapter\Index[indexmain]{chapter} can
+begin, so they are not available with the \Class{scrartcl} class,
+since the next largest unit below ``part'' is ``section''. The chapter
+level is not available in \Class{scrartcl}.
-A chapter always begins with a new page. When the option
+A chapter always begins on a new page. When the option
\Option{openany} is active, any page can be used. The option
-\Option{openright} causes the chapter to begin with a new right page.
+\Option{openright} causes the chapter to begin on a new right page.
An empty left page may be inserted automatically in this case. The
-empty pages are created by the implicit execution of the \LaTeX{}
+empty pages are created by the implicit execution of the {\LaTeX}
command \Macro{cleardoublepage}\IndexCmd{cleardoublepage}.
The option \Option{openright} has no effect with a one-sided layout,
@@ -432,10 +441,11 @@ right pages. For this reason it should only be used together with the
\BeginIndex{Option}{cleardoubleplain}%
\BeginIndex{Option}{cleardoubleempty}%
If one wishes the empty pages created by the \Macro{cleardoublepage}
-command to have no headers or footers while using the standard
-classes, the only possibility is to redefine the command
-appropriately. {\KOMAScript} provides options that avoid this. The
-option \Option{cleardoublestandard} enables the default
+command to have no headers but only a page number, or neither headers
+nor page number while using the standard classes, the only possibility
+is to redefine the command appropriately. {\KOMAScript} provides
+options that avoid this necessity. The option
+\Option{cleardoublestandard} enables the default
\Macro{cleardoublepage} behaviour. If the option
\Option{cleardoubleplain} is used, then the
\PValue{plain}\IndexPagestyle{plain} page style is applied to the
@@ -458,7 +468,7 @@ Both options have the same effect as the corresponding standard ones.
The \Option{titlepage} option makes {\LaTeX} use separate pages for
the titles. These pages are set inside a \Environment{titlepage}
environment and normally have neither header nor footer. In comparison
-with standard \LaTeX, \KOMAScript{} expands the handling of the titles
+with standard {\LaTeX}, {\KOMAScript} expands the handling of the titles
significantly (see \autoref{sec:maincls.titles}).
The option \Option{notitlepage} specifies that an \emph{in-page} title
@@ -491,56 +501,58 @@ abstract or a section.
\BeginIndex{Option}{halfparskip+}%
\BeginIndex{Option}{halfparskip-}%
\BeginIndex{Option}{parindent}%
- The standard classes normally set
- paragraphs\Index[indexmain]{paragraph} indented and without any
- vertical inter-paragraph space. This is the best solution when
- using a regular page layout, like the ones produced with the
- \Package{typearea} package. If there where no indentation and no
- vertical space, only the length of last line would give the reader a
- reference point. In extreme cases, it is very difficult to detect if
- a line is full or not. Furthermore, it is found that a marker at the
- paragraph's end tends to be easily forgotten. A marker at the
- paragraph's beginning is easily remembered. Inter-paragraph spacing
- has the drawback of disappearing in some contexts. For instance,
- after a displayed formula it would be impossible to detect if the
- previous paragraph continues or if a new one begins. Also, when
- starting to read at a new page it might be necessary to look at the
- previous page in order determine if a new paragraph has been started
- or not. All these problems disappear when using indentation. A
- combination of indentation and vertical inter-paragraph spacing is
- redundant and should be rejected. The
- indentation\Index[indexmain]{indentation} is perfectly sufficient by
- itself. The only drawback of indentation is the reduction of the
- line length. The use of inter-paragraph spacing is therefore
- justified when using short lines, for instance in a newspaper.
+The standard classes normally set
+paragraphs\Index[indexmain]{paragraph} indented and without any
+vertical inter-paragraph space. This is the best solution when using
+a regular page layout, like the ones produced with the
+\Package{typearea} package. If neither indentation nor vertical space
+is used, only the length of the last line would give the reader a
+reference point. In extreme cases, it is very difficult to detect
+whether a line is full or not. Furthermore, it is found that a marker
+at the paragraph's end tends to be easily forgotten by the start of
+the next line. A marker at the paragraph's beginning is more easily
+remembered. Inter-paragraph spacing has the drawback of disappearing
+in some contexts. For instance, after a displayed formula it would be
+impossible to detect if the previous paragraph continues or if a new
+one begins. Also, when starting to read at the top of a new page it
+might be necessary to look at the previous page in order determine if
+a new paragraph has been started or not. All these problems disappear
+when using indentation. A combination of indentation and vertical
+inter-paragraph spacing is redundant and therefore should be
+avoided. The indentation\Index[indexmain]{indentation} is perfectly
+sufficient by itself. The only drawback of indentation is the
+reduction of the line length. The use of inter-paragraph spacing is
+therefore justified when using short lines, for instance in a
+newspaper.
\end{Explain}
Independently of the explanation above, there are often requests for a
document layout with vertical inter-paragraph spacing instead of
-indentation. \KOMAScript{} provides a large number of related
+indentation. {\KOMAScript} provides a large number of related
options: \Option{parskip}, \Option{parskip-}, \Option{parskip*},
\Option{parskip+} and \Option{halfparskip}, \Option{halfparskip-},
\Option{halfparskip*} and \Option{halfparskip+}.
-The four \Option{parskip} options define an inter-paragraph spacing of
-one line. The four \Option{halfparskip} options use just a spacing of
-half a line. In order to avoid a change of paragraph going unnoticed,
-for instance after a page break, three of the options of each set
-ensure that the last line of a paragraph is not full. The variants
-without plus or star sign ensure a free space of 1\Unit{em}. The plus
-variant ensures that at least a third of the line is free and the star
-variant ensures that at least a fourth of the line is free. The minus
-variants make no special provision for the last line of a paragraph.
-
-All eight options change the spacing before, after and inside list
-environments. This avoids the problem of having these environments or
-the paragraphs inside them with a larger separation than the
+The four \Option{parskip} options each define an inter-paragraph
+spacing of one line. The four \Option{halfparskip} options use just a
+spacing of half a line. In order to avoid a change of paragraph going
+unnoticed, for instance after a page break, three of the options of
+each set ensure that the last line of a paragraph is not completely
+filled. The variants without plus or star sign ensure a free space of
+1\Unit{em}. The plus variant ensures that at least a third of the line
+is free and the star variant ensures that at least a fourth of the
+line is free. The minus variants make no special provision for the
+last line of a paragraph.
+
+All eight options also change the spacing before, after and inside
+list environments. This avoids the problem of these environments or
+the paragraphs inside them having a larger separation than the
separation between the paragraphs of normal text. Additionally, these
options ensure that the table of contents and the lists of figures and
tables are set without any additional spacing.
-The default behaviour of \KOMAScript{} follows the \Option{parindent}
+The default behaviour of {\KOMAScript} follows the \Option{parindent}
option. In this case, there is no spacing between paragraphs, only an
indentation of the first line by 1\Unit{em}.
%
@@ -568,13 +580,14 @@ In order to have a line separating the header from the text body use
the option \Option{headsepline}. The option \Option{headnosepline} has
the reverse effect. These options have no effect with the page styles
\PValue{empty} and \PValue{plain}, because there is no header in this
-case. Such a line always has the effect of visually approximating
-header and text body. That doesn't mean that the header must be put
-farther apart from the text body. Instead, the header should be
-considered to belong 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.
+case. Such a line always has the effect of visually bringing header
+and text body closer together. That doesn't 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.
The presence of a line between text body and footer is controlled by
the options \Option{footsepline} and \Option{footnosepline}, that
@@ -599,11 +612,11 @@ when used together with the page style \PValue{plain}, because the
\BeginIndex{Option}{nochapterprefix}%
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
-"Chapter"\footnote{When using another language the word
- "Chapter" is naturally translated to the appropriate language.}%
+title\Index[indexmain]{chapter>title} consists of a line with the word
+``Chapter''\footnote{When using another language the word
+ ``Chapter'' is naturally translated to the appropriate language.}%
followed by the chapter number. The title itself is set left-justified
-on the following lines. The same effect is obtained in \KOMAScript{}
+on the following lines. The same effect is obtained in {\KOMAScript}
with the class option \Option{chapterprefix}. The default however is
\Option{nochapterprefix}. These options also affect the automatic
running titles in the headers (see
@@ -622,7 +635,7 @@ running titles in the headers (see
Sometimes\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} one wishes to
have the chapter titles in simplified form according to
\Option{nochapterprefix}. But at the same time, one wishes a title of
-an appendix\Index{appendix} to be preceded by a line with "Appendix"
+an appendix\Index{appendix} to be preceded by a line with ``Appendix''
followed by the appendix letter. This is achieved by using the
\Option{appendixprefix} option. Since this results in an inconsistent
document layout, I advise against using this option.
@@ -648,18 +661,22 @@ captions when the \Option{noonelinecaption} option is given.
\begin{Explain}
The avoidance of a special treatment for the caption has an
- additional effect that is sometimes greatly desired. Footnotes
- that appear inside a \Macro{caption} command often have a wrong
- number assigned to them. This happens because the footnote counter
- is incremented once when the line is measured. When the
- \Option{noonelinecaption} option is used no such measurement is
- made. The footnote numbers are therefore correct.
-
- But since \KOMAScript{} version~2.9 you don't need the option
+ additional effect that is sometimes highly desirable. Footnotes that
+ appear inside a \Macro{caption} command often have a wrong number
+ assigned to them. This happens because the footnote counter is
+ incremented once as soon as the text is measured to determine if it
+ will be one line or more. When the \Option{noonelinecaption} option
+ is used no such measurement is made. The footnote numbers are
+ therefore correct.
+
+ But since {\KOMAScript} version~2.9 you don't need the option
\Option{noonelinecaption} to avoid the above described
- effect. \KOMAScript{} classes contain a workaround, so if you have
- footnotes at captions you simply should put the contents of the
- figure or table into a minipage and everything will be nice.
+ effect. {\KOMAScript} classes contain a workaround, so you can have
+ footnotes inside captions. It should be mentioned though that when
+ using footnotes inside floating environments, the contents of the
+ floating environment should be encapsulated inside a minipage. That
+ way it is guaranteed that floating environment and footnote are
+ inseparable.
\end{Explain}
%
\EndIndex{Option}{onelinecaption}%
@@ -686,13 +703,15 @@ currently has no such options.
The options \Option{10pt}, \Option{11pt} and \Option{12pt} have the
same effect as the corresponding standard options. In contrast to the
standard classes, {\KOMAScript} can be used to choose other font
-sizes\Index[indexmain]{font size}. However {\LaTeX} provides the
+sizes\Index[indexmain]{font>size}. However, {\LaTeX} provides the
necessary class option files only for 10\Unit{pt}, 11\Unit{pt} und
-12\Unit{pt}, so that the user must provide any other class option
-files. The package \Package{extsizes} (see
-\cite{package:extsizes})\IndexPackage{extsizes} can be used for that
-task. Very big font sizes may lead to arithmetic overflow inside the
-page layout calculations of the \Package{typearea} package.
+12\Unit{pt}, and {\KOMAScript} does not provide any class option files,
+so the user must provide any other class option files. The package
+\Package{extsizes} (see
+\cite{package:extsizes})\IndexPackage{extsizes}, for example, can be
+used to provide a \File{size14.clo} class file. Very big font sizes
+may lead to arithmetic overflow inside the page layout calculations of
+the \Package{typearea} package.
%
\EndIndex{Option}{10pt}%
\EndIndex{Option}{11pt}%
@@ -708,22 +727,24 @@ page layout calculations of the \Package{typearea} package.
\BeginIndex{Option}{smallheadings}%
\BeginIndex{Option}{normalheadings}%
\BeginIndex{Option}{bigheadings}%
-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 specially problematic for small
-paper sizes. Consequently {\KOMAScript} provides, besides the large title font
-size defined by the \Option{bigheadings} option, the two options
-\Option{normalheadings} and \Option{smallheadings}, that allow for smaller
-title font sizes. The resulting font sizes for headings at \Class{scrbook} and
-\Class{scrreprt} shows\autoref{tab:maincls.structureElementsFont},
-\autopageref{tab:maincls.structureElementsFont}. At \Class{scrartcl} smaller
-font sizes are used.
+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
+specially problematic for small paper sizes. Consequently,
+{\KOMAScript} provides, besides the large title font size defined by
+the \Option{bigheadings} option, the two options
+\Option{normalheadings} and \Option{smallheadings}, 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}. For \Class{scrartcl}
+smaller font sizes are generally used.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}The spacing before and
after chapter titles is also influenced by these options. Chapter
titles are also influenced by the options \Option{chapterprefix} and
\Option{nochapterprefix}, and appendix titles by the options
-\Option{appendixprefix} and \Option{noappendixprefix}, all of them
+\Option{appendixprefix} and \Option{noappendixprefix}, all of which
are described in \autoref{sec:maincls.layoutOptions},
\autopageref{desc:maincls.option.chapterprefix}.
%
@@ -735,9 +756,10 @@ are described in \autoref{sec:maincls.layoutOptions},
\label{sec:maincls.tocOptions}
{\KOMAScript} has several options that affect the entries in the table
-of contents\Index[indexmain]{table of contents}. The form of the table
-of contents is fixed but several variations of the contents can be
-obtained with the options provided.
+of contents\Index[indexmain]{table>of
+ contents}\Index[indexmain]{contents>table of}. The form of the table
+of contents is fixed but several variations can be obtained with the
+options provided.
\begin{Explain}%
\begin{Declaration}
@@ -752,24 +774,30 @@ obtained with the options provided.
\BeginIndex{Option}{bibtotoc}%
\BeginIndex{Option}{bibtotocnumbered}%
\BeginIndex{Option}{liststotocnumbered}%
- Lists of tables and figures, index and bibliography are not normally
- included in the table of contents. These entries are omitted in
- classical typography because it is silently assumed that, if at all,
- lists of figures and tables come after the table of contents, the
- index comes at the end and the bibliography comes before the index.
- Books with all these parts often include ribbons that can be used to
- mark the location of these parts in the book, so that the reader
- only has to look for them once.
+Normally, lists of tables and figures, index and bibliography are not
+included in the table of contents. These entries are purposely omitted
+in classical typography because, among other things, a very particular
+placement of these items is silently assumed, if they are present at
+all:
+\begin{itemize}
+\item table of contents after the title pages,
+\item lists of tables and figures after the table of contents,
+\item index right at the end,
+\item bibliography before the index.
+\end{itemize}
+Books, in which all these items are present, often include ribbons
+that can be used to mark the location of these items in the book, so
+that the reader only has to look for them once.
\end{Explain}
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 certainly related to the
+and, sometimes, even for the index. This is surely also related to the
recent trend of putting lists of figures and tables at the end of the
document. Both lists are similiar to the table of contents in
structure and intention. I'm therefore sceptical of this evolution.
-Since it makes no sense to include only one of the aforementioned lists
-in the table of contents, there exists only one option
+Since it makes no sense to include only one of the lists of tables and
+figures in the table of contents, there exists only one option
\Option{liststotoc} that causes entries for both types of lists to be
included. This also includes any lists produced with version~1.2e or
later of the \Package{float}\IndexPackage{float} package (see
@@ -777,27 +805,34 @@ later of the \Package{float}\IndexPackage{float} package (see
contain entries that reference other sections of the document.
The option \Option{idxtotoc} causes an entry for the index to be
-included in the table of contents. The index is also unnumbered since
-it only includes references to the contents of the other sectional
+included in the table of contents. The index is unnumbered since it
+too only includes references to the contents of the other sectional
units.
The bibliography is a different kind of listing. It does not list the
contents of the present document but refers instead to external
-documents. On these reasons it could be argued that it is a different
+documents. For that reason, it could be argued that it qualifies as a
chapter (or section) and, as such, should be numbered. The option
\Option{bibtotocnumbered} has this effect, including the generation of
-the corresponding entry in the table of contents. I think that a
-similar reasoning would lead us to consider a classical list of
-sources to be a separate chapter. Also, the bibliography is not
-something that was written by the document's author. In view of this,
-the bibliography merits nothing more than an unnumbered entry in the
-table of contents, and that can be achieved with the \Option{bibtotoc}
-option.
-
-The author of \KOMAScript{} doesn't like option
-\Option{bibtotocnumbered}. He almost detests option
-\Option{liststotocnumbered}. Because of this you won't find a detailed
-description of this option. Nevertheless it exists.
+the corresponding entry in the table of contents. I personally think
+that this reasoning would lead us to consider a classical list of
+sources also to be a separate chapter. On the other hand, the
+bibliography is finally not something that was written by the
+document's author. In view of this, the bibliography merits nothing
+more than an unnumbered entry in the table of contents, and that can
+be achieved with the \Option{bibtotoc} option.
+
+As\ChangedAt{v2.8q}{%
+ \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} the author
+of {\KOMAScript} already views the option \Option{liststotoc} with
+open skepticism, and frankly detests option \Option{bibtotocnumbered},
+it should come as no surprise that he implemented option
+\Option{liststotocnumbered} only under extreme duress. He fears that
+as a next step someone will want the table of contents numbered and
+entered in the table of contents. Therefore, those looking in this
+documentation for a detailed description of option \Option{liststotoc}
+will search in vain. A similar option for the index would be just
+as silly, so its implementation has been determinedly refused so far.
%
\EndIndex{Option}{liststotoc}%
\EndIndex{Option}{idxtotoc}%
@@ -813,20 +848,21 @@ description of this option. Nevertheless it exists.
\BeginIndex{Option}{tocindent}%
\BeginIndex{Option}{tocleft}%
The table of contents is normally\ChangedAt{v2.8q}{%
- \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} setup so
+ \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} set up so
that different sectional units have different indentations. The
section number is set left-justified in a fixed-width field. This
setup is selected with the option \Option{tocindent}.
When there are many sections, the corresponding numbering tends to
become very wide, so that the reserved field overflows. The FAQ
-\cite{DANTE:FAQ} suggests that the table of contents should be redefined
-in such a case. \KOMAScript{} offers an alternative format that avoids
-the problem completely. If the option \Option{tocleft} is selected,
-then no variable indentation is applied to the titles of the sectional
-units. Instead, a table-like organisation is used, where all unit
-numbers and titles, respectively, are set in a left-justified column.
-The space necessary for the unit numbers is determined automatically.
+\cite{DANTE:FAQ} suggests that the table of contents should be
+redefined in such a case. {\KOMAScript} offers an alternative format
+that avoids the problem completely. If the option \Option{tocleft} is
+selected, then no variable indentation is applied to the titles of the
+sectional units. Instead, a table-like organisation is 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.
\begin{Explain}
In order to calculate automatically the space taken by the unit
@@ -837,13 +873,14 @@ The space necessary for the unit numbers is determined automatically.
\Option{tocindent}, since it does not make any redefinitions. When
using packages that affect the format of the table of contents, it
is possible that the use of options \Option{tocleft} and
- \Option{tocindent} may lead to problems. In that case, one should
- use neither of these global (class) option.
+ \Option{tocindent} too may lead to problems. When using such
+ packages then, for safety's sake, one should refrain from using
+ either of these options as global (class) options.
If the \Option{tocleft} option is active, the width of the field for
unit numbering is determined when outputting the table of contents.
After a change that affects the table of contents, at most three
- \LaTeX{} runs are necessary to obtain a correctly set table of
+ {\LaTeX} runs are necessary to obtain a correctly set table of
contents.
\end{Explain}
%
@@ -853,12 +890,13 @@ The space necessary for the unit numbers is determined automatically.
\subsection{Options for Lists of Floats}
\label{sec:maincls.listsOptions}
-The best known lists of floats are the list of figures and the list of tables.
-With help from the \Package{float}\IndexPackage{float} package, for instance,
-it is possible to produce new float environments with the corresponding lists.
+The best known lists of floats are the list of figures and the list of
+tables. Additionally, with help from the
+\Package{float}\IndexPackage{float} package, for instance, it is
+possible to produce new float environments with corresponding lists.
\begin{Explain}
- Whether \KOMAScript{} options have any effect on lists of floats
+ Whether {\KOMAScript} options have any effect on lists of floats
produced by other packages depends mainly on those packages. This is
generally the case with the lists of floats produced by the
\Package{float}\IndexPackage{float} package.
@@ -878,31 +916,59 @@ it is possible to produce new float environments with the corresponding lists.
\BeginIndex{Option}{listsleft}%
Lists of figures and tables\ChangedAt{v2.8q}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} are
-generally setup so that their numbering uses a fixed space. This
+generally set up so that their numbering uses a fixed space. This
corresponds to the use of option \Option{listsindent}.
-If the numbers get too large, for instance because many tables are used, it
-may happen that the available space is exceeded. Therefore \KOMAScript{}
-supplies an option called \Option{listsleft} that is similar to the
-\Option{tocleft} option. The width of the numbers is automatically determined
-and the space for them correspondingly adjusted. Concerning the mode of
-operation and the side effects, the observations made in
-\autoref{sec:maincls.tocOptions}, \autopageref{desc:maincls.option.tocleft}
-for the \Option{tocleft} option are equally valid in this case. Please note
-that when using the \Option{listsleft} option several \LaTeX{} runs are
-necessary before the lists of floats achieve their final form.
+If the numbers become too large, for instance because many tables are
+used, it may happen that the available space is exceeded. Therefore
+{\KOMAScript} supplies an option called \Option{listsleft} that is
+similar to the \Option{tocleft} option. The width of the numbers is
+automatically determined and the space for them correspondingly
+adjusted. Concerning the mode of operation and the side effects, the
+observations made in \autoref{sec:maincls.tocOptions},
+\autopageref{desc:maincls.option.tocleft} for the \Option{tocleft}
+option are equally valid in this case. Please note that when using the
+\Option{listsleft} option several {\LaTeX} runs are necessary before
+the lists of floats achieve their final form.
%
\EndIndex{Option}{listsindent}%
\EndIndex{Option}{listsleft}%
+\begin{Declaration}
+ \Option{chapteratlists}\\
+ \XOption{chapteratlists}=\PName{value}
+\end{Declaration}%
+\BeginIndex{Option}{chapteratlists}%
+\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
+Normally,\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}}
+every chapter entry generated with \Macro{chapter} introduces vertical
+spacing into the lists of floats. Since version~2.96a 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}).
+
+Furthermore, now the option \Option{chapteratlists} can be used to
+change the spacing, by passing the desired distance as
+\PName{value}. The default setting is 10\,pt. If the value is set to
+\PValue{entry} or no value is specified, then instead of a vertical
+distance the chapter entry itself will be entered into the lists.
+
+This option can be changed with
+\Macro{KOMAoptions}\Parameter{chapteratlists} or
+\Macro{KOMAoptions}\Parameter{chapteratlists=\PName{value}} even
+inside the document. It takes effect from the next heading
+onwards. However, changes to the option will only become effective in
+the lists following two more {\LaTeX} runs.
+\EndIndex{Option}{chapteratlists}%
\subsection{Options Affecting the Formatting}
\label{sec:maincls.formattingOptions}
Formatting options are all those options that affect the form or
-formatting of the document and are not assigned to other sections.
-They are the \emph{remaining options}.
+formatting of the document and cannot be assigned to other sections.
+They are therefore the \emph{remaining options}.
\begin{Declaration}
\Option{abstracton}\\
@@ -911,21 +977,21 @@ They are the \emph{remaining options}.
\BeginIndex{Option}{abstracton}%
\BeginIndex{Option}{abstractoff}%
In\OnlyAt{\Class{scrreprt}\and\Class{scrartcl}} the standard classes
-the \Environment{abstract} environment sets the text "\abstractname"
-centered before the summary text\Index[indexmain]{summary}. This was the
-normal procedure in the past. In the meantime, newspaper reading has
-trained the readers to recognize a displayed text at the beginning of
-an article or report as the abstract. This is even more so when the
-abstract comes before the table of contents. It is also surprising
-that precisely this title appears small and centered. {\KOMAScript}
+the \Environment{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 abstract. This is even more true when the
+text comes before the table of contents. It is also surprising when
+precisely this title appears small and centered. {\KOMAScript}
provides the possibility of including or excluding the abstract's
title with the options \Option{abstracton} and \Option{abstractoff}.
\begin{Explain}
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 with a
- description of further aspects. Therefore, the class \Class{scrbook}
+ book. This chapter is often combined with the introduction or a
+ description of wider prospects. Therefore, the class \Class{scrbook}
has no \Environment{abstract} environment. A summary chapter is also
recommended for reports in a wider sense, like a Master's or Ph.D.
thesis.
@@ -942,27 +1008,28 @@ title with the options \Option{abstracton} and \Option{abstractoff}.
\BeginIndex{Option}{pointednumbers}%
\BeginIndex{Option}{pointlessnumbers}%
\begin{Explain}%
- According to {\small DUDEN}, the numbering of sectional units should
- have no point at the end if only arabic numbers are used (see
- \cite[R\,3]{DUDEN}). On the other hand, if roman numerals or letters
- are used, then a point should appear at the end of the numbering (see
- \cite[R\,4]{DUDEN}). {\KOMAScript} has an internal mechanisms that
- tries to implement these rules. The resulting effect is that,
- normally, after the sectional commands \Macro{part} and
- \Macro{appendix} a switch is made to numbering with a point at the
- end. The information is saved in the \File{aux} file and takes
- effect on the next \LaTeX{} run.
+ In German, according to {\small DUDEN}, the numbering of sectional
+ units should have no dot at the end if only arabic numbers are used
+ (see \cite[R\,3]{DUDEN}). On the other hand, if roman numerals or
+ letters are appear in the numbering, then a dot should appear at the
+ end of the numbering (see \cite[R\,4]{DUDEN}). {\KOMAScript} has an
+ internal mechanisms 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
+ numbering with an ending dot. The information is saved in the
+ \File{aux} file and takes effect on the next {\LaTeX} run.
\end{Explain}
-In some cases the mechanism that switches the end point may fail or
-other languagues may have different rules. Therefore it is possible to
-activate the use of the end point with the option
-\Option{pointednumbers} or to deactivate it with
+In some cases the mechanism for placing or leaving off the ending dot
+may fail, or other languagues may have different rules. Therefore it
+is possible to activate the use of the ending dot manually with the
+option \Option{pointednumbers} or to deactivate it with
\Option{pointlessnumbers}.
-Please note that the mechanism only takes effect on the next \LaTeX{}
-run. When trying to use these options to control the numbering
-format, a run without changing any options should be made.
+Please note that the mechanism only takes effect on the next {\LaTeX}
+run. Therefore, before trying to use these options to forcibly
+control the numbering format, a further run without changing any
+options should be made.
Calling these options \Option{dottednumbers}\IndexOption{dottednumbers} and
\Option{dotlessnumbers}\IndexOption{dotlessnumbers} or similar would be more
@@ -1004,23 +1071,29 @@ loaded. Displayed equations are then left-justified.
As described in \autoref{sec:maincls.floats},
\autopageref{desc:maincls.macro.caption}, the
\Macro{caption}\IndexCmd{caption} command acts with figures like the
-\Macro{captionbelow}\IndexCmd{captionbelow} command. The behaviour with tables
-depends on two options. With the default \Option{tablecaptionbelow} options,
-the \Macro{caption} macro acts like the \Macro{captionbelow} command. With the
+\Macro{captionbelow}\IndexCmd{captionbelow} command. The behaviour
+with tables, however, depends on these two options. In the default
+setting, \Option{tablecaptionbelow}, the \Macro{caption} macro acts
+also with tables like the \Macro{captionbelow} command. With the
\Option{tablecaptionabove} option, \Macro{caption} acts like the
\Macro{captionabove}\IndexCmd{captionabove} command.
-Note that using any of these options does not changes the possition of the
-caption from above the top of the table to the bottom of the table or vica
-versa. It only changes the spacing between caption and e.g. tabular.
+Note that using any of these options does not change the position of
+the caption from above the top of the table to below the bottom of the
+table or vica 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.
Note\OnlyAt{\Package{float}}\IndexPackage{float} that when using the
\Package{float} package, the options \Option{tablecaptionbelow} and
-\Option{tablecaptionabove} cease to act correctly when the
-\Macro{restylefloat} is applied to tables. More details of the \Package{float}
-package's \Macro{restylefloat} can be obtained from
-\cite{package:float}. Additional support for \Package{float} may be found at
-\autoref{sec:maincls.floats}, \autopageref{desc:maincls.floatstyle.komaabove}.
+\Option{tablecaptionabove} cease to act correctly when
+\Macro{restylefloat} is applied to tables. More details of the
+\Package{float} 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} in \autoref{sec:maincls.floats},
+\autopageref{desc:maincls.floatstyle.komaabove}.
%
\EndIndex{Option}{tablecaptionbelow}%
\EndIndex{Option}{tablecaptionabove}%
@@ -1032,20 +1105,22 @@ package's \Macro{restylefloat} can be obtained from
\end{Declaration}%
\BeginIndex{Option}{origlongtable}%
The package\OnlyAt{\Package{longtable}}
-\Package{longtable}\IndexPackage{longtable} (see \cite{package:longtable})
-sets table captions internally by calling the command \Macro{LT@makecaption}.
-In order to ensure that these table captions match the ones used with normal
-tables, the \KOMAScript{} classes normally redefine that command. See
+\Package{longtable}\IndexPackage{longtable} (see
+\cite{package:longtable}) sets table captions internally by calling
+the command \Macro{LT@makecaption}. In order to ensure that these
+table captions match the ones used with normal tables, the
+{\KOMAScript} classes normally redefine that command. See
\autoref{sec:maincls.floats},
-\autopageref{desc:maincls.macro.caption.longtable} for more details. The
-redefinition is performed with help of the command \Macro{AfterPackage}
-immediately after the loading of package \Package{longtable}. If the package
-\Package{caption2}\IndexPackage{caption2} (see \cite{package:caption}) has
-been previously loaded, the redefinition is not made in order not to interfere
-with the \Package{caption2} package.
+\autopageref{desc:maincls.macro.caption.longtable} for more
+details. The redefinition is performed with help of the command
+\Macro{AfterPackage} immediately after the loading of package
+\Package{longtable}. If the package
+\Package{caption2}\IndexPackage{caption2} (see \cite{package:caption})
+has been previously loaded, the redefinition is not made in order not
+to interfere with the \Package{caption2} package.
\end{Explain}
If the table captions produced by the \Package{longtable} package
-should not be redefined by the \KOMAScript{}, activate the
+should not be redefined by the {\KOMAScript} classes, activate the
\Option{origlongtable} option.
%
\EndIndex{Option}{origlongtable}%
@@ -1057,7 +1132,7 @@ should not be redefined by the \KOMAScript{}, activate the
\BeginIndex{Option}{openbib}%
The standard option \Option{openbib} switches to an alternative
bibliography format. The effects are twofold: The first line of a
-bibliography entry, normally containing the author's name, gets a
+bibliography entry, normally containing the author's name, receives a
smaller indentation; and the command \Macro{newblock} is redefined to
produce a paragraph. Without this option, \Macro{newblock} introduces
only a stretchable horizontal space.
@@ -1073,13 +1148,13 @@ only a stretchable horizontal space.
\BeginIndex{Option}{final}%
The two standard options \Option{draft} and \Option{final} are
normally used to distinguish between the draft and final versions of a
-document. The option \Option{draft} activates small black boxes that
-are set at the end of overly long lines. The boxes help the untrained
-eye to find paragraphs that have to be treated manually. With the
-\Option{final} option no such boxes are shown.
+document. In particular, the option \Option{draft} activates small
+black boxes that are set at the end of overly long lines. The boxes
+help the untrained eye to find paragraphs that have to be treated
+manually. With the \Option{final} option no such boxes are shown.
The two options are also processed by other packages and affect their
-workings. For instance, the \Package{graphics}\IndexPackage{graphics}
+operation. For instance, the \Package{graphics}\IndexPackage{graphics}
and the \Package{graphicx}\IndexPackage{graphicx} packages don't
actually output the graphics when the option \Option{draft} is
specified. Instead they output a framed box of the appropriate size
@@ -1094,32 +1169,32 @@ containing only the graphic's filename (see \cite{package:graphics}).
Some document characteristics do not apply to a particular section of
the document like the titling, the text body or the bibliography, but
-they affect the entire document. Some of these characteristics were
+do affect the entire document. Some of these characteristics were
already described in \autoref{sec:maincls.options}.
\subsection{Changing Fonts}
\label{sec:maincls.font}
-\BeginIndex{}{font}\BeginIndex{}{font size}%
+\BeginIndex{}{font}\BeginIndex{}{font>size}%
\begin{Explain}
- \KOMAScript{} does not use fixed fonts and attributes to emphasize
- different elements of the text. Instead there are variables
- that contain the commands used for changing fonts and other text
- attributes. In previous versions of \KOMAScript{} the user had to
+ {\KOMAScript} does not use fixed fonts and attributes to emphasize
+ different elements of the text. Instead there are variables that
+ contain the commands used for changing fonts and other text
+ attributes. In previous versions of {\KOMAScript} the user had to
use \Macro{renewcommand} to redefine those variables. It was also
not easy to determine the name of the variable affecting an element
- given the element's name. It was also often necessary to determine
- the original definition before proceeding to redefine it.
-
- These difficulties were actually intended, since the interface was not
- for users, but only for package authors building their
- packages on top of \KOMAScript{}. The years have shown that the
- interface was mainly used by document authors. So a new, simpler
- interface was created. However, the author advises explicitly the
- typographically inexperienced user against changing font sizes and
- other graphical characteristics according to his taste. Knowledge
- and feeling are basic conditions for the selection and mixture of
- different font sizes, attributes and families.
+ given the element's name. Besides, it was also often necessary to
+ determine the original definition before proceeding to redefine it.
+
+ These difficulties were actually intended, since the interface was
+ not for users, but only for package authors building their packages
+ on top of {\KOMAScript}. The years have shown, however, that the
+ interface was in fact mainly used by document authors. So a new,
+ simpler interface was created. However, the author explicitly
+ advises the typographically inexperienced user against changing font
+ sizes and other graphical characteristics according to his
+ taste. Knowledge and feeling are basic conditions for the selection
+ and mixture of different font sizes, attributes and families.
\end{Explain}
\begin{Declaration}
@@ -1137,31 +1212,31 @@ and \Macro{addtokomafont} it is possible to define the
\PName{element}. Theoretically all possible statements including
literal text could be used as \PName{commands}. You should however
absolutely limit yourself to those statements that really switch only
-one font attribute. This are usually the commands \Macro{normalfont},
-\Macro{rmfamily}, \Macro{sffamily}, \Macro{ttfamily},
-\Macro{mdseries}, \Macro{bfseries}, \Macro{upshape}, \Macro{itshape},
-\Macro{slshape}, \Macro{scshape} and the font size commands
-\Macro{Huge}, \Macro{huge}, \Macro{LARGE} etc. The description of
-these commands can be found in \cite{lshort}, \cite{latex:usrguide} or
-\cite{latex:fntguide}. Color switching commands like
-\Macro{normalcolor} (see \cite{package:graphics}) are also acceptable.
-The behavior when using other commands, specially those that make
-redefinitions or generate output, is not defined. Strange behavior is
-possible and does not represent a bug.
+one font attribute. This will usually be the commands
+\Macro{normalfont}, \Macro{rmfamily}, \Macro{sffamily},
+\Macro{ttfamily}, \Macro{mdseries}, \Macro{bfseries}, \Macro{upshape},
+\Macro{itshape}, \Macro{slshape}, \Macro{scshape} and the font size
+commands \Macro{Huge}, \Macro{huge}, \Macro{LARGE}, etc. The
+description of these commands can be found in \cite{lshort},
+\cite{latex:usrguide} or \cite{latex:fntguide}. Color switching
+commands like \Macro{normalcolor} (see \cite{package:graphics}) are
+also acceptable. The behavior when using other commands, specially
+those that make redefinitions or generate output, is not
+defined. Strange behavior is possible and does not represent a bug.
The command \Macro{setkomafont } provides a font switching command
with a completely new definition. In contrast to this the
-\Macro{addtokomafont} commands extends the existing definition.
-
-It is not recommended to use both statements in the same
+\Macro{addtokomafont} command merely extends an existing
+definition. It is recommended to not use both commands in the same
document. Usage examples can be found in the paragraphs on the
corresponding element. Names and meanings of the individual items are
listed in \autoref{tab:maincls.elementsWithoutText}. The default
values are shown in the corresponding paragraphs.
The command \Macro{usekomafont} can change the current font
-specification to the one used with the specified \PName{element}.
+specification to the one currently used with the specified
+\PName{element}.
\begin{Example}
Assume that you want to use for the element
\FontElement{captionlabel} the same font specification that is used
@@ -1178,20 +1253,20 @@ specification to the one used with the specified \PName{element}.
\Macro{addtokomafont}\label{tab:maincls.elementsWithoutText}}\\
\Endfirsthead
\caption[]{Elements, whose type style can be
- changed (\emph{pursuit})}\\
+ changed (\emph{continuation})}\\
\Endhead
\standardfoot%
\feentry{caption}{Text of a table or figure caption}%
\feentry{captionlabel}{Label of a table or figure caption; used according to
the element \FontElement{caption}}%
\feentry{chapter}{Title of the sectional unit \Macro{chapter}}%
- \feentry{descriptionlabel}{Labels, i.e. the optional argument of
- \Macro{item}, in the \Environment{description} environment}%
- \feentry{dictum}{smart saing (see command \Macro{dictum})}%
- \feentry{dictumauthor}{Author of a smart saying; used according to the
+ \feentry{descriptionlabel}{Labels, i.\,e., the optional argument of
+ \Macro{item} in the \Environment{description} environment}%
+ \feentry{dictum}{wise saying (see command \Macro{dictum})}%
+ \feentry{dictumauthor}{Author of a wise saying; used according to the
element \FontElement{dictumtext}}%
\feentry{dictumtext}{Another name for \FontElement{dictum}}%
- \feentry{disposition}{All sectional unit titles, i.e. the arguments of
+ \feentry{disposition}{All sectional unit titles, i.\,e., the arguments of
\Macro{part} down to \Macro{subparagraph} and \Macro{minisec}, including
the title of the abstract; used before the element of the corresponding
unit}%
@@ -1199,34 +1274,38 @@ specification to the one used with the specified \PName{element}.
\feentry{footnotelabel}{Mark of a footnote; used according to the element
\FontElement{footnote}}%
\feentry{footnotereference}{Footnote reference in the text}%
- \feentry{minisec}{Title of \Macro{minisec}}
+ \feentry{minisec}{Title of \Macro{minisec}}%
\feentry{pagefoot}{The foot of a page, but also the head of a page}%
\feentry{pagehead}{The head of a page, but also the foot of a page}%
\feentry{pagenumber}{Page number in the header or footer}%
\feentry{pagination}{Another name for \FontElement{pagenumber}}%
\feentry{paragraph}{Title of the sectional unit \Macro{paragraph}}%
\feentry{part}{Title of the \Macro{part} sectional unit, without the line
- with the part number}%
- \feentry{partnumber}{Line with the part number in a title of the sectional
- unit \Macro{part}}%
+ containing the part number}%
+ \feentry{partnumber}{Line containing the part number in a title of the
+ sectional unit \Macro{part}}%
\feentry{section}{Title of the sectional unit \Macro{section}}%
\feentry{sectioning}{Another name for \FontElement{disposition}}%
\feentry{subparagraph}{Title of the sectional unit \Macro{subparagraph}}%
\feentry{subsection}{Title of the sectional unit \Macro{subsection}}%
\feentry{subsubsection}{Title of the sectional unit \Macro{subsubsection}}%
- \feentry{title}{Main title of the document, i.e. the argument of
- \Macro{title} (for details about the size see the additional note at the
- text on \autopageref{desc:maincls.macro.title})}%
+ \feentry{title}{Main title of the document, i.\,e., the argument of
+ \Macro{title} (for details about the title size see the additional note in
+ the text from \autopageref{desc:maincls.macro.title})}%
\end{desctable}
%
\EndIndex{Cmd}{setkomafont}%
\EndIndex{Cmd}{addtokomafont}%
\EndIndex{Cmd}{usekomafont}%
-\EndIndex{}{font}\EndIndex{}{font size}%
+\EndIndex{}{font}\EndIndex{}{font>size}%
\subsection{Page Style}
\label{sec:maincls.pageStyle}
+One of the general characteristics of a document is the page
+style\Index[indexmain]{page>style}. In {\LaTeX} this means mostly the
+contents of headers and footers.
+
\begin{Declaration}
\Macro{pagestyle}\PParameter{empty}\\
\XMacro{pagestyle}\PParameter{plain}\\
@@ -1240,30 +1319,31 @@ specification to the one used with the specified \PName{element}.
\BeginIndex{Pagestyle}{plain}%
\BeginIndex{Pagestyle}{headings}%
\BeginIndex{Pagestyle}{myheadings}%
-One of the general characteristics of a document is the page
-style\Index[indexmain]{page style}. In {\LaTeX} this means mostly the
-contents of headers and footers. Usually one distinguishes four
-different page styles.
+Usually one distinguishes four different page styles.
\begin{description}
\item[\phantomsection\label{desc:maincls.pagestyle.empty}empty] is the page
style with entirely empty headers and footers. In {\KOMAScript} this is
completely identical to the standard classes.
-\item [plain] is the page style with empty head and only a page number
- in the foot. With the standard classes this page number is
- always centered in the foot. With {\KOMAScript} the page number
+\item [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 foot. The one-sided page style behaves like the
+ side of the footer. The one-sided page style behaves like the
standard setup.
-\item[headings] is the page style with running titles in the head.
- With the classes \Class{scrbook}\IndexClass{scrbook} and
+\item[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 are repeated in the head\,---\,with {\KOMAScript} on the outer
- side, with the standard classes on the inner side. The page number
- comes with {\KOMAScript} on the outer side of the foot, with the
- standard classes it comes on the inner side of the head. In
- one-sided layouts only the headings of the chapters are used and
- are, with {\KOMAScript}, centered in the head. The page numbers are
- set with {\KOMAScript} centered in the foot.
+ sections are repeated in the header for double-sided
+ layout\,---\,with {\KOMAScript} on the outer side, with the standard
+ classes on the inner side. The page number is set on the outer side
+ of the footer with {\KOMAScript}, with the standard classes it is
+ set on the inner side of the header. In one-sided layouts only the
+ titles of the chapters are used and are, with {\KOMAScript},
+ centered in the header. The page numbers are set centered in the
+ footer with {\KOMAScript}.
\OnlyAt{\Class{scrartcl}}\Class{scrartcl}\IndexClass{scrartcl}
behaves similarly, but starting a level deeper in the section
hierarchy with sections and subsections, because the chapter level
@@ -1272,11 +1352,11 @@ different page styles.
While the standard classes automatically set running headings always
in capitals, {\KOMAScript} applies the style of the title. This has
several typographic reasons. Capitals as a decoration are actually
- too strong. If one applies them nevertheless, they should be set
- with a smaller type size and tighter spacing. The standard classes
- don't take these points in consideration.
+ far too strong. If one applies them nevertheless, they should be set
+ in a one point smaller type size and with tighter spacing. The
+ standard classes do not take these points in consideration.
\item [myheadings] corresponds mostly to the page style
- \PValue{headings}, but the running headings s are not automatically
+ \PValue{headings}, but the running headings are not automatically
produced, but have to be defined by the user. The commands \Macro
{markboth}\IndexCmd{markboth} and
\Macro{markright}\IndexCmd{markright} can be used for that purpose.
@@ -1292,19 +1372,18 @@ changes only the style of the current page.
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. Usually one sets the page style only once at the beginning of the
-document or in the preamble. To change the page style of the current
-page one uses the \Macro{thispagestyle} command. This also happens at
-some places in the document automatically. For example, the
-instruction \Macro{thispagestyle}\PParameter{plain} is issued
-implicitly on the first page of a chapter.
+output. Usually one sets the page style only once at the beginning of
+the document or in the preamble. To 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{plain} is
+issued implicitly on the first page of a chapter.
Please note that the change between automatic and manual running
-headings is not performed by page style changes when using the
-\Package{scrpage2} package, but instead special instructions must be
-used. The page styles \PValue{headings} and \PValue{myheadings} should
-not be used together with this package (see
-\autoref{cha:scrpage},
+headings is no longer performed by page style changes when using the
+\Package{scrpage2} package, but instead via special instructions. The
+page styles \PValue{headings} and \PValue{myheadings} should not be
+used together with this package (see \autoref{cha:scrpage},
\autopageref{desc:scrpage.pagestyle.useheadings}).
%
\EndIndex{Cmd}{pagestyle}%
@@ -1315,15 +1394,15 @@ not be used together with this package (see
\EndIndex{Pagestyle}{myheadings}%
\BeginIndex[indexother]{}{type style}%
-In order to change the type style used in the head, foot or for the
-page number\ChangedAt{v2.8p}{%
+In order to change the type 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.font}. The same element is used for head and
-foot, which you can designate equivalently with
+\autoref{sec:maincls.font}. The same element is used for header and
+footer, which you can designate equivalently with
\FontElement{pagehead}\IndexFontElement{pagehead} or
\FontElement{pagefoot}\IndexFontElement{pagefoot}. The element for
-the page number within the head or foot is called
+the page number within the header or footer is called
\FontElement{pagenumber}\IndexFontElement{pagenumber}. The default
settings can be found in \autoref{tab:maincls.defaultFontsHeadFoot}.
%
@@ -1348,10 +1427,10 @@ settings can be found in \autoref{tab:maincls.defaultFontsHeadFoot}.
%
\begin{Example}
\phantomsection\label{sec:maincls.pageStyle.example}%
- Assume that you want to set head and foot 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 horribly,
- you can reach this as follows:
+ 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
+ horrible, you can obtain this as follows:
\begin{lstlisting}
\setkomafont{pagehead}{%
\normalfont\normalcolor\itshape\small
@@ -1376,15 +1455,15 @@ automatically for the running headings. For that, please use the
If you define your own page styles, the commands
\Macro{usekomafont}\PParameter{pagehead} and
-\Macro{usekomafont}\PParameter {pagenumber} can find a meaningful use.
-If you use for that not the \KOMAScript{} package \Package{scrpage2}
-(see \autoref{cha:scrpage}), but, for example, the package
+\Macro{usekomafont}\PParameter {pagenumber} can be useful. If you do
+not use the {\KOMAScript} package \Package{scrpage2} (see
+\autoref{cha:scrpage}) for that, but, for example, the package
\Package{fancyhdr}\IndexPackage{fancyhdr} (see
\cite{package:fancyhdr}), you can use these commands in your
-definitions. Thereby you can remain compatible with \KOMAScript. If
-you do not use these commands in your own definitions, changes like
-those shown in the previous examples have no effect. The packages
-\Package{scrpage}\IndexPackage{scrpage} and
+definitions. Thereby you can remain compatible with {\KOMAScript} as
+much as possible. If you do not use these commands in your own
+definitions, changes like those shown in the previous examples have no
+effect. The packages \Package{scrpage}\IndexPackage{scrpage} and
\Package{scrpage2}\IndexPackage {scrpage2} take care to keep the
maximum possible compatibility with other packages.
%
@@ -1403,7 +1482,10 @@ maximum possible compatibility with other packages.
\BeginIndex{Cmd}{indexpagestyle}%
For some pages a different page style is chosen with the help of the
command \Macro{thispagestyle}. Which page style this actually is, is
-defined by these four macros. The default values for all four cases 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}.
%
@@ -1429,9 +1511,9 @@ The page styles can be redefined with the \Macro{renewcommand} macro.
\begin{lstlisting}
\renewcommand*{\partpagestyle}{empty}
\end{lstlisting}
- As mentioned previously, the page style \PValue{empty} is exactly
- what is required in this example. Naturally you can also use a
- user-defined page style.
+As mentioned previously on \autopageref{desc:maincls.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.
Assume you have defined your own page style for initial chapter pages
with the package \Package{scrpage2} (see
@@ -1485,7 +1567,7 @@ The page styles can be redefined with the \Macro{renewcommand} macro.
For sure, the page style \PValue{headings} is thereby applied to the
initial page of a chapter. But nevertheless no running headings appear
when using the \Option{openright} option.
- The reason for this behaviour can be found in the \LaTeX{}
+ The reason for this behaviour can be found in the {\LaTeX}
core. There, the command \Macro{rightmark}, that generates the marks
for right-hand pages, is defined with;
\begin{lstlisting}
@@ -1537,21 +1619,22 @@ The page styles can be redefined with the \Macro{renewcommand} macro.
\BeginIndex{Cmd}{cleardoublestandardpage}%
\BeginIndex{Cmd}{cleardoubleplainpage}%
\BeginIndex{Cmd}{cleardoubleemptypage}%
-The \LaTeX{} core contains the \Macro{clearpage} command, which takes
-care of the fact that all floats that have not yet been output and
-starts a new page. There exists the instruction
-\Macro{cleardoublepage} which works like \Macro{clearpage} but that,
-in the double-sided layouts (see layout option \Option{twoside} in
+The {\LaTeX} core contains the \Macro{clearpage} command, which takes
+care that all not yet output floats are output, and then starts a new
+page. There exists the instruction \Macro{cleardoublepage} which
+works like \Macro{clearpage} but which, in the double-sided layouts
+(see layout option \Option{twoside} in
\autoref{sec:maincls.layoutOptions},
-\autopageref{desc:maincls.option.twoside}) starts a new right-hand page.
-An empty left page in the current page style is output if necessary.
+\autopageref{desc:maincls.option.twoside}) starts a new right-hand
+page. An empty left page in the current page style is output if
+necessary.
-With \Macro{cleardoublestandardpage} \KOMAScript{} works as described
+With \Macro{cleardoublestandardpage} {\KOMAScript} works as described
above. The \Macro{cleardoubleplainpage} command changes the page
style of the empty left page to \PValue{plain} in order to suppress
the running heading. Analogously, the page style \PValue{empty} is
applied to the empty page with \Macro{cleardoubleemptypage},
-suppressing the page number as well as the runnning title. The page is
+suppressing the page number as well as the runnning heading. The page is
thus entirely empty. However, the approach used by
\Macro{cleardoublepage} is dependent on the layout options
\Option{cleardoublestandard}, \Option{cleardoubleplain} and
@@ -1574,23 +1657,24 @@ active option.
\BeginIndex{Cmd}{ifthispageodd}%
\BeginIndex{Cmd}{ifthispagewasodd}%
\begin{Explain}%
- A peculiarity of \LaTeX{} consists in the fact that it is not
+ A peculiarity of {\LaTeX} consists of the fact that it is not
possible to determine on which page the current text will fall. It
is also difficult to say whether the current page has an odd or an
even page number. Now some will argue that there is, nevertheless,
- the \TeX test macro \Macro{ifodd} which one needs only to apply to
+ the {\TeX} test macro \Macro{ifodd} which one needs only to apply to
the current page counter. However, this is an error. At the time of
- the evaluation of such a test \LaTeX{} does not know at all whether
+ the evaluation of such a test {\LaTeX} does not know at all whether
the text just processed will be typeset on the current page or only
- on the next. The page breaks take place not while reading the paragraph,
- but only in the \emph{output} routine of \LaTeX{}. However, at that
- moment a command of the form \verb|\ifodd\value{page}| would already
- have been completely evaluated.
+ on the next. The page breaks take place not while reading the
+ paragraph, but only in the \emph{output} routine of
+ {\LaTeX}. However, at that moment a command of the form
+ \verb|\ifodd\value{page}| would already have been completely
+ evaluated.
To find out reliably whether a text falls on an even or odd
page, one must usually work with a label and a page reference to
this label. One must also take special precautionary measures during
- the first \LaTeX{} run, when the label is not yet known.
+ the first {\LaTeX} run, when the label is not yet known.
\end{Explain}
If one wants to find out with {\KOMAScript} whether a text falls on an
even or odd page, one can use the \Macro {ifthispageodd} command. The
@@ -1617,7 +1701,7 @@ page. Otherwise the \PName{false} argument is executed.
\end{Example}
Because the \Macro{ifthispageodd} command uses a mechanism that is
-very similar to a label and a reference to it, at least two \LaTeX{}
+very similar to a label and a reference to it, at least two {\LaTeX}
runs are required after every text modification. Only then the
decision is correct. In the first run a heuristic is used to make the
first choice.
@@ -1626,12 +1710,12 @@ first choice.
\begin{Explain}
There are situations where the \Macro{ifthispageodd} command never
leads to the correct result. Suppose that the command is used within
- a box. A box is set by \LaTeX{} always as a whole. No page breaks
+ a box. A box is set by {\LaTeX} always as a whole. No page breaks
take place inside. Assume further that the \PName{true} part is very
big, but the \PName{false} part is empty. If we suppose further that
the box with the \PName {false} part still fits on the current, even
page, but that with the \PName{true} part it does not. Further
- assume that \KOMAScript{} heuristically decides for the first run
+ assume that {\KOMAScript} heuristically decides for the first run
that the \PName{true} part applies. The decision is wrong and is
revised in the next run. The \PName{false} part is thereby
processed, instead of the \PName{true} part. The decision must again
@@ -1652,14 +1736,14 @@ first choice.
\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 command from the \LaTeX{} kernel. You
+This command works the same way in {\KOMAScript} as in the standard
+classes. More precisely it is a command from the {\LaTeX} kernel. You
can specify with this command the \PName{numbering style} of page
numbers. The changes take effect immediately, hence starting with the
page that contains the command. The possible settings can be found in
\autoref{tab:numberKind}. Using the command \Macro{pagenumbering}
-also resets the page counter\Index{page counter}\Index{page number}.
-Thus the page number of the next page which \TeX{} outputs will have
+also resets the page counter\Index{page>counter}\Index{page>number}.
+Thus the page number of the next page which {\TeX} outputs will have
the number 1 in the style \PName{numbering style}.
%
\begin{table}
@@ -1711,17 +1795,17 @@ With the standard classes and with {\KOMAScript} all title pages are
defined in a special environment, the \Environment{titlepage}
environment. This environment always starts a new page\,---\,in the
two-sided layout a new right page. For this page, the style is changed
-as by \Macro{thispagestyle}\PParameter{empty}, so that neither page
-number nor running title are output. At the end of the environment the
-page is automatically shipped out. Should you not be able to use the
-automatic layout of the title page, it is advisable to design a new
-one with the help of this environment.
+by \Macro{thispagestyle}\PParameter{empty}, so that neither page
+number nor running heading are output. At the end of the environment
+the page is automatically shipped out. Should you not be able to use
+the automatic layout of the title page, it is advisable to design a
+new one with the help of this environment.
\begin{Example}
- Assume you want a title page on which only the word " ` Me " '
- stands at the top on the left, as large as possible and in bold --
- no author, no date, nothing else. The following document makes just
+ Assume you want a title page on which only the word ``Me'' stands at
+ the top on the left, as large as possible and in bold\,---\,no
+ author, no date, nothing else. The following document creates just
that:
\begin{lstlisting}
\documentclass{scrbook}
@@ -1745,18 +1829,20 @@ items title, author and date, with {\KOMAScript} the \Macro{maketitle} command
can produce up to six pages.
In contrast to the standard classes, the \Macro{maketitle} macro in
-{\KOMAScript} accepts an optional numeric argument. If it is used, the number
-is made the page number of the first title page. However, this page number is
-not output, but affects only the numbering. You should choose an odd number,
-because otherwise the whole counting gets mixed up. In my opinion there are
-only two meaningful applications for the optional argument. On the one hand,
-one could give to the half-title\Index[indexmain]{half-title} the logical page
-number \(-1\) in order to give the full title page the number 1. On the other
-hand it could be used to start at a higher page number, for instance, 3, 5, or
-7 to accommodate other title pages added by the publishing house. The
-optional argument is ignored for \emph{in-page} titles. However the page style
-of such a title page can be changed by redefining the \Macro{titlepagestyle}
-macro. For that see \autoref{sec:maincls.pageStyle},
+{\KOMAScript} accepts an optional numeric argument. If it is used,
+this number is made the page number of the first title page. However,
+this page number is not output, but affects only the numbering. You
+should choose an odd number, because otherwise the whole counting gets
+mixed up. In my opinion there are only two meaningful applications for
+the optional argument. On the one hand, one could give to the
+half-title\Index[indexmain]{half-title} the logical page number \(-\)1
+in order to give the full title page the number 1. On the other hand,
+it could be used to start at a higher page number, for instance, 3, 5,
+or 7 to accommodate other title pages added by the publishing house.
+The optional argument is ignored for \emph{in-page} titles. However,
+the page style of such a title page can be changed by redefining the
+\Macro{titlepagestyle} macro. For that see
+\autoref{sec:maincls.pageStyle},
\autopageref{desc:maincls.macro.titlepagestyle}.
The following commands do not lead necessarily to the production of the
@@ -1774,9 +1860,9 @@ the preamble before \Macro{begin}\PParameter{document} (see
\BeginIndex{Cmd}{extratitle}%
In earlier times the inner book was often not protected from dirt by a cover.
This task was then taken over by the first page of the book which
- carried mostly a shortened title, precisely the \emph{half-title}.
+ carried mostly a shortened title called the \emph{half-title}.
Nowadays the extra page is often applied before the real full title
- and contains information on the publisher, series number and similar
+ and contains information about the publisher, series number and similar
information.
\end{Explain}
@@ -1792,7 +1878,7 @@ takes place as part of the titles produced by \Macro{maketitle}.
\begin{Example}
Let's go back to the previous example and assume
- that the spartan "Me" is the half-title. The full title should
+ that the spartan ``Me'' is the half-title. The full title should
still follow the half-title. One can proceed as follows:
\begin{lstlisting}
\documentclass{scrbook}
@@ -1838,7 +1924,7 @@ takes place as part of the titles produced by \Macro{maketitle}.
\BeginIndex{Cmd}{and}%
\BeginIndex{Cmd}{thanks}%
The contents of the full title page are defined by six elements. The
-\PName{title head}\Index[indexmain]{title head} is defined with the
+\PName{title head}\Index[indexmain]{title>head} is defined with the
command \Macro {titlehead}. It is typeset in regular paragraph style
and full width at the top of the page. It can be freely designed by
the user.
@@ -1913,21 +1999,21 @@ the items are centered horizontally. The information is summarised in
the university's name and address at the top, flush left, and the
semester flush right. As usual a title is to be used, including
author and delivery date.
- The advisor must also be indicated, together with the fact that the
+ The adviser must also be indicated, together with the fact that the
document is a dissertation. This can be obtained as follows:
\begin{lstlisting}
\documentclass{scrbook}
\begin{document}
\titlehead{{\Large Unseen University
\hfill SS~2002\\}
- Higher Analytical Institut\\
+ Higher Analytical Institute\\
Mythological Rd\\
34567 Etherworld}
\subject{Dissertation}
\title{Digital space simulation with the DSP\,56004}
\author{Fuzzy George}
\date{30. February 2002}
- \publishers{Advisor Prof. John Excentric Doe}
+ \publishers{Adviser Prof. John Eccentric Doe}
\maketitle
\end{document}
\end{lstlisting}
@@ -1935,15 +2021,15 @@ the items are centered horizontally. The information is summarised in
\begin{Explain}
-A frequent misunderstanding concerns the role of the full title side.
-It is often erroneous assumed that the cover (or dust cover) is meant.
+A frequent misunderstanding concerns the role of the full title page.
+It is often erroneously assumed that the cover (or dust cover) is meant.
Therefore, it is frequently expected that the title page does not follow
-the normal page layout, but have equally large left and right margins.
+the normal page layout, but has equally large left and right margins.
-However if one takes a book and opens it, one hits very quickly on at
+However if one takes a book and opens it, one notices very quickly at
least one title page under the cover within the so-called inner book.
-Precisely these title pages are produced by \Macro{maketitle}. Like it
-happens with the half-title, the full title page belongs to the inner
+Precisely these title pages are produced by \Macro{maketitle}. As is
+the case with the half-title, the full title page belongs to the inner
book, and therefore should have the same page layout as the rest of
the document. A cover is actually something that should be created in
a separate document. The cover often has a very individual format. It
@@ -2049,10 +2135,10 @@ whether one should not proceed likewise.
\section{The Table of Contents}
\label{sec:maincls.toc}
-The titles are normally followed by the table of contents\Index{table
-of contents}.
-Often the table of contents is followed by lists of floats, e.g. lists
-of tables and figures, see \autoref{sec:maincls.floats}).
+The titles are normally followed by the table of contents\Index{table>of
+ contents}\Index{contents>table of}. Often the table of contents is followed
+by lists of floats, e.\,g., lists of tables and figures (see
+\autoref{sec:maincls.floats}).
\begin{Declaration}
\Macro{tableofcontents}\\
@@ -2060,69 +2146,75 @@ of tables and figures, see \autoref{sec:maincls.floats}).
\end{Declaration}%
\BeginIndex{Cmd}{tableofcontents}%
\BeginIndex{Cmd}{contentsname}%
- 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 option \Option{liststotoc} causes
-the lists of figures and tables to be included in the table of
-contents. \Option{idxtotoc} is the corresponding option for the index.
-This is rather uncommon in classical typography. One finds the
-bibliography included in the table of contents a little bit more
-frequently. This can be obtained with the options \Option{bibtotoc}
-and \Option{bibtotocnumbered}. These options are explained in
-\autoref{sec:maincls.tocOptions},
+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
+option \Option{liststotoc} causes the lists of figures and tables to
+be included in the table of contents. \Option{idxtotoc} is the
+corresponding option for the index. This is rather uncommon in
+classical typography. One does find the bibliography included in the
+table of contents slightly more frequently. This can be obtained with
+the options \Option{bibtotoc} and \Option{bibtotocnumbered}. These
+options are explained in \autoref{sec:maincls.tocOptions},
\autopageref{desc:maincls.option.liststotoc}.
\begin{Explain}
- The table of contents is set as a not numbered chapter and is therefore
- subjected to the side effects of the standard \Macro{chapter*} command,
+ The table of contents is set as an unnumbered chapter and is therefore
+ subject to the side effects of the standard \Macro{chapter*} command,
which are described in \autoref{sec:maincls.structure},
\autopageref{desc:maincls.macro.chapter*}. However, the running
- titles\Index{running title} for left and right pages are correctly filled
- with the heading of the table of contents. The text of the heading is given
- by the macro \Macro{contentsname}.
+ headings\Index{running heading} for left and right pages are correctly filled
+ with the heading of the table of contents.
+
+ The text of the heading is given by the macro
+ \Macro{contentsname}. If you make use of a language package such as
+ \Package{babel}, please read the documentation of that package
+ before redefining this macro.
\end{Explain}%
\EndIndex{Cmd}{tableofcontents}%
\EndIndex{Cmd}{contentsname}%
-
-There is only one variant for the construction of the table of
-contents. The titles of the sectional units are indented so that the
-unit number is flush left to the edge of the title of the next upper
-unit. However, the place for the numbers is thereby limited and is
-only sufficient for a little bit more than 1.5 places per level.
-Should this become a problem, help can be found in \cite{DANTE:FAQ}.
+There are two variants for the construction of the table of
+contents. With the standard variant, the titles of the sectional units
+are indented so that the unit number is flush left to the edge of the
+text of the next upper sectional unit. However, the space for the
+numbers is thereby limited and is only sufficient for a little more
+than 1.5 places per unit level. Should this become a problem, the
+option \Option{tocleft} can be used to set the behaviour such that all
+entries in the table of contents are set flush left under one
+another. As explained in \autoref{sec:maincls.tocOptions},
+\autopageref{desc:maincls.option.tocleft}, several {\LaTeX} runs are
+needed.
\begin{Explain}
-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. It is however
-affected by the settings of the element
-\FontElement{disposition}\IndexFontElement{disposition} (see
-\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). There is no point
-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 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. The font
+ style is however affected by the settings of the element
+ \FontElement{disposition}\IndexFontElement{disposition} (see
+ \autoref{tab:maincls.elementsWithoutText},
+ \autopageref{tab:maincls.elementsWithoutText}). 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.%
\end{Explain}
\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 \Class{scrartcl}). The inclusion
-of a sectional unit in the table of contents is controlled by the
-counter \Counter{tocdepth}. It has the value \(-1\) for \Macro{part},
-\(0\) for \Macro{chapter} and so on. Since the class \Class{scrartcl} has
-no \Macro{chapter}, the counter starts with 0 for the \Macro{part}. By
-setting, 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.
+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
+\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 setting, 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.
The user of the \Package{scrpage2}\IndexPackage{scrpage2} package (see
\autoref{cha:scrpage}) does not need to remember the numerical
@@ -2138,49 +2230,50 @@ macros \Macro{chapterlevel}, \Macro{sectionlevel} and so on down to
\documentclass{scrartcl}
\setcounter{tocdepth}{2}
\end{lstlisting}
-You set the counter \Counter{tocdepth} to 2, because you know that
+You set the counter \Counter{tocdepth} to 2 because you know that
this is the value for \Macro{subsection}. If you know that
-\Class{scrartcl} normally includes all levels up to
+\Class{scrartcl} normally includes all levels down to
\Macro{subsubsection} in the table of contents, you can simply
decrement the counter \Counter{tocdepth} by one:
\begin{lstlisting}
\documentclass{scrartcl}
\addtocounter{tocdepth}{-1}
\end{lstlisting}
-How much you should add to or take from the \Counter{tocdepth} counter
+How much you should add to or subtract from the \Counter{tocdepth} counter
can also be found by looking at the table of contents after the first
-\LaTeX{} run.
+{\LaTeX} run.
\end{Example}
+A small hint in order that you do not need to remember which sectional
+unit has which number: in the table of contents count the number of
+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}.%
+
+{\KOMAScript} has always attempted to avoid page breaking directly
+between a sectional unit and the adjacent next lower unit, for
+example, between a chapter title and its first section title. However,
+the mechanism worked poorly or not at all until version~2.96. In
+version~2.96a\ChangedAt{v2.96a}{%
+ \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}} the
+mechanism was much improved and should now always work
+correctly. There can be changes in the page breaking in the table of
+contents as a result though. Thus, the new mechanism is only active,
+if the compatibility option is not set to version~2.96 or less (see
+option \Option{version}, \autoref{sec:maincls.compatibilityOptions},
+\autopageref{desc:maincls.option.version}). The mechanism also does
+not work if the commands to generate the table of contents are
+redefined, for example, by the use of the package \Package{tocloft}.
%
\EndIndex{Counter}{tocdepth}%
-% TODO: Translate this:
-\minisec{Sorry, Still waiting for translation:}
-\KOMAScript{} hat schon immer versucht, im Inhaltsverzeichnis Umbrueche
-unmittelbar zwischen einer Gliederungsebene und der zugehoerigen Unterebene,
-also beispielsweise zwischen einer Kapitel- und der zugehoeriger erster
-Abschnittsueberschrift, zu vermeiden. Leider funktionierte dieser Mechanismus
-bis Version~2.96 sehr schlecht bis gar nicht. In
-Version~2.96a\ChangedAt{v2.96a}{%
- \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}} wurde er
-erheblich verbessert und sollte nun immer funktionieren. Allerdings kann dies
-zu Umbruchaenderungen im Inhaltsverzeichnis fuehren. Daher ist der neue
-Mechanismus nur aktiv, wenn die Kompatibilitaet nicht auf Version~2.96 oder
-kleiner eingestellt ist (siehe Option \Option{version},
-\autoref{sec:maincls.compatibilityOption},
-\autopageref{desc:maincls.option.version}). Der Mechanismus funktioniert auch
-nicht mehr, wenn die Befehle zur Erzeugung der Inhaltsverzeichniseintraege
-umdefiniert werden, etwa bei Verwendung des Pakets \Package{tocloft}.
-
\section{Lists of Floats}
-As a rule, the lists of floats\index{float environments},
-e.g. list of tables\index{list of tables} and
-list of figures\index{list of figures}, can be found directly
-after the table of contents.
-In some documents, they even can be found in the appendix.
-However, the author of this manual prefers the location
-after the table of contents, therefore it is discussed here.
+As a rule, the lists of floats\Index{floating environments}, e.\,g., list of
+tables\Index[indexmain]{list>of tables} and list of
+figures\Index[indexmain]{list>of figures}, can be found directly after the
+table of contents. In some documents, they can even be found in the appendix.
+However, the author of this manual prefers their location after the table of
+contents, therefore the explanation is given here.
\begin{Declaration}
\Macro{listoftables}\\
@@ -2192,21 +2285,21 @@ after the table of contents, therefore it is discussed here.
\BeginIndex{Cmd}{listoffigures}%
\BeginIndex{Cmd}{listtablename}%
\BeginIndex{Cmd}{listfigurename}%
-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 options
-\Option{listsindent} and \Option{listsleft}, see
+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 options \Option{listsindent} and \Option{listsleft} (see
\autoref{sec:maincls.listsOptions},
-\autopageref{desc:maincls.option.listsleft}. Moreover, the options
-\Option{liststotoc} and \Option{liststotocnumbered} have indirect influence,
-see \autoref{sec:maincls.tocOptions},
+\autopageref{desc:maincls.option.listsleft}). Moreover, the options
+\Option{liststotoc} and \Option{liststotocnumbered} have indirect
+influence (see \autoref{sec:maincls.tocOptions},
\autopageref{desc:maincls.option.liststotoc}).
\begin{Explain}
-The terms of the titles of this tables are stored at the macros
-\Macro{listtablename} and \Macro{listfigurename}. If you're using a language
-package like \Package{babel} and want to change these terms, you should read
-the documentation of the language package.
+ The text of the titles of this tables are stored in the macros
+ \Macro{listtablename} and \Macro{listfigurename}. If you use a
+ language package like \Package{babel} and want to redefine these
+ macros, you should read the documentation of the language package.
\end{Explain}
%
\EndIndex{Cmd}{listoftables}%
@@ -2218,21 +2311,21 @@ the documentation of the language package.
\section{Main Text}
\label{sec:maincls.mainText}
-This section explains everything provided by \KOMAScript{}
+This section explains everything provided by {\KOMAScript}
in order to write the main text. The main text is the
part that the author should focus on first.
Of course this includes tables, figures and comparable
information as well.
-\subsection{Separation}{Separation\protect\OnlyAt{\Class{scrbook}}}
+\subsection[{Separation}]{Separation\protect\OnlyAt{\Class{scrbook}}}
\label{sec:maincls.separation}
-Before\OnlyAt{\Class{scrbook}} getting to the main text eventually we will
-have a short look at three commands which exist both in the standard class
-\Class{book} and the {\KOMAScript} class \Class{scrbook}. They are used for
-separation of the \emph{font matter}\Index{front matter}, the \emph{main
- matter}\Index{main matter} and the \emph{back matter}\Index{back matter} of
-a book.
+Before\OnlyAt{\Class{scrbook}} getting to the main text we will have a
+short look at three commands which exist both in the standard class
+\Class{book} and the {\KOMAScript} class \Class{scrbook}. They are
+used for separation of the \emph{front matter}\Index{front matter}, the
+\emph{main matter}\Index{main matter} and the \emph{back
+ matter}\Index{back matter} of a book.
\begin{Declaration}
\Macro{frontmatter}\\
@@ -2242,24 +2335,31 @@ a book.
\BeginIndex{Cmd}{frontmatter}%
\BeginIndex{Cmd}{mainmatter}%
\BeginIndex{Cmd}{backmatter}%
-The macro \Macro{frontmatter} introduces the font matter in which roman
-numbers are used for the page numbers. Chapter headings in a front matter
-don't have any numbers. The foreword can be set as a normal chapter.
-A foreword should never be divided into sections but kept short.
-Therefore there is no need for a deeper structuring than chapter.
-
-\Macro{mainmatter} introduces the main matter with the main text. If there is
-no fton matter this command can be omitted. The default in the main matter is
-arabic page numbering (re)starting with 1.
-
-The back matter is introduced with \Macro{backmatter}. Opinions differ in
-what should be part of the back matter. So in some cases you will only find
-the bibliography\Index{bibliography}, in some cases only the
-index\Index{index} and in other cases both of it and the appendix.
-Besides, the chapters at the back matter are similar to the chapters at the
-front matter, but page numbering doesn't change. Nevertheless you may use
-command \Macro{pagenumbering} from \autoref{sec:maincls.pageStyle},
-\autopageref{desc:maincls.macro.pagenumbering} of you want to change this.
+The macro \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 would be numbered,
+start at chapter 0, and would be consecutively numbered across chapter
+boundaries. However, this is of no import, as the front matter is used
+only for the title pages, table of contents, lists of figures and
+tables, and a foreword. The foreword can thus be set as a normal
+chapter. A foreword should never be divided into sections but kept as
+short as possible. Therefore in the foreword there is no need for a
+deeper structuring than the chapter level.
+
+\Macro{mainmatter} introduces the main matter with the main text. If
+there is no front matter then this command can be omitted. The default
+page numbering in the main matter uses Arabic numerals (re)starting in
+the main matter at 1.
+
+The back matter is introduced with \Macro{backmatter}. Opinions differ
+in what should be part of the back matter. So in some cases you will
+find only the 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.macro.pagenumbering}.
%
\EndIndex{Cmd}{frontmatter}%
\EndIndex{Cmd}{mainmatter}%
@@ -2288,50 +2388,68 @@ sections and so on.
\BeginIndex{Cmd}{subsubsection}%
\BeginIndex{Cmd}{paragraph}%
\BeginIndex{Cmd}{subparagraph}%
-The standard disposition commands in {\KOMAScript} work quite similar
-to the standard classes. Normally the section headings show up in the
-table of contents exactly as they are entered in the text. The entry
-for the table of contents can be specified as an optional argument in
-front of the actual heading.
-\OnlyAt{\Class{scrartcl}}\Macro{chapter} only exists in book or
-report classes but not in article classes. In addition to this, the
-command \Macro{chapter} in {\KOMAScript} differs substantially from
-the version in the standard class. While in the standard classes every
-chapter number is used together with the prefix ``Chapter'' on a
-separate line above the heading, {\KOMAScript} only places the chapter
-number in front of the heading.
-
-Please note that \Macro{part} and \Macro{chapter} change the page
-style for one page. The applied page style in \KOMAScript{} is defined
-in \Macro{partpagestyle} and \Macro{chapterpagestyle} (see
+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
+optional argument to the sectioning commands.
+
+The title of the level part (\Macro{part}) is distinguished from other
+sectioning levels by being numbered independently from the other
+parts. This means that the chapter level (in \Class{scrbook} or
+\Class{scrreprt}), or the section level (in \Class{scrartcl}) is
+numbered consecutively over all parts. Furthermore, for classes
+\Class{scrbook} and \Class{scrreprt} the title of the part level
+together with the corresponding preamble (see \Macro{setpartpreamble},
+\autopageref{desc:maincls.macro.setpartpreamble}) is set on a separate
+page.
+
+\Macro{chapter} \OnlyAt{\Class{scrartcl}} only exists in book or
+report classes, that is, in classes \Class{book}, \Class{scrbook},
+\Class{report} and \Class{scrreport}, but not in the article classes
+\Class{article} and \Class{scrartcl}. In addition to 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 test. This overpowering style is
+replaced in {\KOMAScript} by a simple chapter number before the
+chapter heading text, can however be reverted by the option
+\Option{chapterprefix} (see \autoref{sec:maincls.layoutOptions},
+\autopageref{desc:maincls.option.chapterprefix}).
+
+Please 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.macro.titlepagestyle}).
\BeginIndex[indexother]{}{font}%
-\BeginIndex[indexother]{}{font size}%
+\BeginIndex[indexother]{}{font>size}%
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} described in
-\autoref{sec:maincls.font}. First of all the element
-\FontElement{disposition}\IndexFontElement{disposition} is used, which
-is followed by a specific element for every section level (see
+\autoref{sec:maincls.font}. In doing this, generally the element
+\FontElement{disposition}\IndexFontElement{disposition} is used,
+followed by a specific element 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
-\Macro{normalfont}\Macro{normalcolor}\Macro{sffamily}%
-\Macro{bfseries}. The default font size for the specific elements depends
-on the options \Option{bigheadings}, \Option{normalheadings} and
-\Option{smallheadings} (see \autoref{sec:maincls.fontOptions},
-\autopageref{desc:maincls.option.smallheadings}). The
-defaults are listed in \autoref{tab:maincls.structureElementsFont}
+\autopageref{tab:maincls.elementsWithoutText}). The font for the
+element \FontElement{disposition}\IndexFontElement{disposition} is
+predefined as \Macro{normalfont}\Macro{normalcolor}\Macro{sffamily}%
+\Macro{bfseries}. The default font size for the specific elements
+depends on the options \Option{bigheadings}, \Option{normalheadings}
+and \Option{smallheadings} (see \autoref{sec:maincls.fontOptions},
+\autopageref{desc:maincls.option.smallheadings}). The defaults are
+listed in \autoref{tab:maincls.structureElementsFont}
%
\begin{table}
\centering%
\caption[{Default font sizes for different levels of document
structuring}]{Default font sizes for different levels of document
- structuring at \Class{scrbook} and \Class{scrreprt}}
+ structuring in \Class{scrbook} and \Class{scrreprt}}
\begin{tabular}{lll}
\toprule
class option & element & default\\
@@ -2378,69 +2496,74 @@ defaults are listed in \autoref{tab:maincls.structureElementsFont}
\end{table}
\begin{Example}
- Suppose you are using the class option \Option{bigheadings} and notice
- that the very big headings of document parts are to bold. You could change
- this as follows:
+ Suppose you are using the class option \Option{bigheadings} and
+ notice that the very big headings of document parts are too
+ bold. You could change this as follows:
\begin{lstlisting}
\setkomafont{disposition}{\normalcolor\sffamily}
\part{Appendices}
\addtokomafont{disposition}{\bfseries}
\end{lstlisting}
- Using the command above you only switch off the font attribute
- \textbf{bold} for the heading ``Appendices''. A much more comfortable
- and elegant solution is to change all \Macro{part} headings in one go.
- This is done either by:
+Using the command above you only switch off the font attribute
+\textbf{bold} for a heading ``Appendices''. A much more comfortable
+and elegant solution is to change all \Macro{part} headings at once.
+This is done either by:
\begin{lstlisting}
\addtokomafont{part}{\normalfont\sffamily}
\addtokomafont{partnumber}{\normalfont\sffamily}
\end{lstlisting}
- or using:
+ or simply using:
\begin{lstlisting}
\addtokomafont{part}{\mdseries}
\addtokomafont{partnumber}{\mdseries}
\end{lstlisting}
- The last version is to be preferred because it gives you the correct
- result even when you change the \FontElement{disposition}
- element\IndexFontElement{disposition} as follows:
+The last version is to be preferred because it gives you the correct
+result even when you make changes to the \FontElement{disposition}
+element\IndexFontElement{disposition}, for instance:
\begin{lstlisting}
\setkomafont{disposition}{\normalcolor\bfseries}
\end{lstlisting}
- With this change it is possible to set all section levels at once to not
+ With this change it is possible to set all section levels at once to no
longer use sans serif fonts.
\end{Example}
-Please be warned of using the possibilities of font switching to mix fonts,
-font sizes and font attributes excessively. Picking the most suitable font for
-a given task is a hard thing even for professionals and has nothing to do with
-personal taste of beginners. Please refer to the citation at the end of
-\autoref{sec:typearea.tips}, \autopageref{sec:typearea.tips.cite} and the
-following explanation.
+Please be warned of misusing the possibilities of font switching to
+mix fonts, font sizes and font attributes excessively. Picking the
+most suitable font for a given task is a hard task even for
+professionals and has almost nothing to do with the personal tastes of
+non-experts. Please refer to the citation at the end of
+\autoref{sec:typearea.tips}, \autopageref{sec:typearea.tips.cite} and
+to the following explanation.
\begin{Explain}
- It is possible to use different font types for different section levels
- in {\KOMAScript}. As a typographical beginner you should refrain from
- using these possibilities for typographical reasons.
-
- There is a rule which states that you should mix fonts only as few as
- possible. Using sans serif for headings seems already a breach of this
- rule. However, you should know that bold, huge and serif letters are much to
- heavy for headings. In general you would have to use a normal instead of a
- bold or semi bold font. However, in deeper levels of the structuring a
- normal font appears rather leight weighted. On the other hand sans serif
- fonts in headings have a very pleasant appearance and are to be used only in
- headings. That's why sans serif is the default in {\KOMAScript}.
-
- More variety should be avoided. Font mixing is only for professionals. In
- case you want to use other fonts than the standard \TeX-Fonts\,---\,no matter
- whether using CM \Index{CM fonts} or EC fonts\Index{EC fonts}\,---\,you should
- consult an expert or redefine the font for the element
- \FontElement{disposition}\IndexFontElement{disposition} as seen in the example
- above. You often find the combinations Times and Helvetica or Palatino with
- Helvetica. The author of this documentation does not favour these
- combinations.
+ It is possible to use different font types for different section
+ levels in {\KOMAScript}. Non-experts in typography should for very
+ good typographical reasons refrain absolutely from using these
+ possibilities.
+
+ There is a rule in typography which states that one should mix as
+ few fonts as possible. Using sans serif for headings already seems
+ to be a breach of this rule. However, one should know that bold,
+ large serif letters are much to heavy for headings. Strictly
+ speaking, one would then have to at least use a normal instead of a
+ bold or semi bold font. However, in deeper levels of the structuring
+ a normal font may then appear too lightly weighted. On the other
+ hand, sans serif fonts in headings have a very pleasant appearance
+ and in fact find acceptance almost solely for headings. That is why
+ 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.
\end{Explain}
\EndIndex[indexother]{}{font}%
-\EndIndex[indexother]{}{font size}%
+\EndIndex[indexother]{}{font>size}%
%
\EndIndex{Cmd}{part}%
\EndIndex{Cmd}{chapter}%
@@ -2467,30 +2590,31 @@ following explanation.
\BeginIndex{Cmd}{subsubsection*}%
\BeginIndex{Cmd}{paragraph*}%
\BeginIndex{Cmd}{subparagraph*}%
-All disposition commands exist as ``starred'' versions. They produce
-section headings which do not show up in the table of
-contents\Index{table of contents}, in the page header\Index{header}
-and which are not numbered\Index{numbering}. Not using a headline
-often has an unwanted side effect. For example, if a chapter which is
-set using \Macro{chapter*} spans over several pages the headline of
-the chapter before comes up again. {\KOMAScript} offers a solution
-which is described below.
-\OnlyAt{\Class{scrartcl}}\Macro{chapter*} only exists in book and
-report classes which includes \Class{book}, \Class{scrbook},
-\Class{report} and \Class{scrreport}, but not the article classes
-\Class{article} and \Class{scrartcl}.
+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
+ of} or in in the
+running heading\Index{header}. The absence of a running heading often
+has an unwanted side effect. For example, if a chapter which is set
+using \Macro{chapter*} spans several pages, then the running heading
+of the previous chapter suddenly reappears. {\KOMAScript} offers a
+solution for this which is described
+below. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}\Macro{chapter*}
+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 note that \Macro{part} and \Macro{chapter} change the page
-style for one page. The applied style is defined in
-\Macro{partpagestyle} and \Macro{chapterpagestyle} in \KOMAScript{}
+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.macro.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
- \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} %
-the same explanations apply which were given above with the normal
-disposition commands. The elements of structuring are named in the same
-way as the ``unstarred'' versions.
+ \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
+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*}%
@@ -2500,9 +2624,10 @@ way as the ``unstarred'' versions.
\EndIndex{Cmd}{paragraph*}%
\EndIndex{Cmd}{subparagraph*}%
-\iffalse In the standard classes there are no further disposition commands. In
-particular, there are no commands which produce unnumbered chapters or
-sections which show up in the table of contents or in the page header. \fi
+\iffalse In the standard classes there are no further structuring
+commands. In particular, there are no commands which can produce
+unnumbered chapters or sections which show up in the table of contents
+and in the running heading. \fi
\begin{Declaration}
\Macro{addpart}\OParameter{Short version}\Parameter{Heading}\\
@@ -2518,38 +2643,39 @@ sections which show up in the table of contents or in the page header. \fi
\BeginIndex{Cmd}{addchap*}%
\BeginIndex{Cmd}{addsec}%
\BeginIndex{Cmd}{addsec*}%
-In addition to the standard classes {\KOMAScript} offers the new
-commands \Macro{addsec} and \Macro{addchap}. They are similar to the
-standard commands \Macro{chapter} und \Macro{section} except the
-missing numbering. The produce both a running headline and an entry in
-the table of contents. The starred versions \Macro{addchap*} and
-\Macro{addsec*} are similar to the standard commands \Macro{chapter*}
-and \Macro{section*} apart from a tiny but important difference: The
-headlines are deleted. This eliminates the side effect of obsolete
-headers mentioned above. \OnlyAt{\Class{scrartcl}}\Macro{addchap}
-and \Macro{addchap*} of course only exist in book and report classes,
-namely \Class{book}, \Class{scrbook}, \Class{report} and
-\Class{scrreport}, but not in the article classes \Class{article} and
-\Class{scrartcl}.
-
-Similar to this, the command \Macro{addpart} produces an unnumbered
-document part with an entry in the table of contents. Since the
-headers are already deleted by \Macro{part} and \Macro{part*} the
-problem of obsolete headers doesn't exist. The starred version
-\Macro{addpart*} is identical to \Macro{part*} and is only defined for
-consistency reasons.
-
-Please note that \Macro{addpart} and \Macro{addchap} including their
-starred versions change the page style for one page. The particular
-page style is defined in the macros \Macro{partpagestyle} and
+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
+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 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{scrartcl}}\Macro{addchap} and \Macro{addchap*}
+of course only exist in book and report classes, namely \Class{book},
+\Class{scrbook}, \Class{report} and \Class{scrreport}, but not in the
+article classes \Class{article} and \Class{scrartcl}.
+
+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
+problem of obsolete headers does not exist. The starred version
+\Macro{addpart*} is thus identical to \Macro{part*} and is only
+defined for consistency reasons.
+
+Please note 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.macro.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
- \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} %
-the same explanations apply which were given above with the normal
-disposition commands. The elements of structuring are named in the same
-way as the ``unstarred'' versions.
+ \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
+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*}%
@@ -2564,17 +2690,17 @@ way as the ``unstarred'' versions.
\end{Declaration}%
\BeginIndex{Cmd}{minisec}%
Sometimes a heading\Index{heading} is wanted which is highlighted but
-closely linked to the following text. Such a heading shouldn't be
-separated by a vertical skip.
+also closely linked to the following text. Such a heading should not
+be separated by a large vertical skip.
-The command \Macro{minisec} is designed for this situation. This heading
-isn't linked to a level of structuring. Such a \emph{Mini-section}
-does not produce an entry in the table of contents nor does it receive
-any numbering.
+The command \Macro{minisec} is designed for this situation. This
+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.
\begin{Example}
You have developed a kit for building a mouse trap and want the
- documentation separated into the things needed and an assembly
- description. Using \Macro{minisec} you could write the following:
+ documentation separated into a list of necessary items and an
+ assembly description. You could write the following:
\begin{lstlisting}
\minisec{Items needed}
@@ -2589,18 +2715,16 @@ any numbering.
\end{flushleft}
\minisec{Assembly}
- At first one searches the mouse-hole and puts the
- drawing pin directly behind the hole.
- Thus the mouse cannot escape meanwhile the following
- actions.
-
- Afterwards one knocks in the spring-plug with the hammer
- in the mouse-hole.
- If the spring-plug's size is not big enough in order to
- shut the mouse-hole entirely, then one can utilize
- the plank instead and fasten it with the two screws
- employing the knife on the mouse-hole.
- Instead of the knife one can use a screw-driver as well.
+ At first one searches the mouse-hole and puts the drawing pin
+ directly behind the hole. Thus the mouse cannot escape during the
+ following actions.
+
+ Then one knocks the spring-plug with the hammer into the mouse-hole.
+ If the spring-plug's size is not big enough in order to shut the
+ mouse-hole entirely, then one can utilize the plank instead and
+ fasten it against the front of the mouse-hole utilizing the two
+ screws and the knife. Instead of the knife one can use a
+ screw-driver instead.
\end{lstlisting}
Which gives:
\begin{ShowOutput}[\baselineskip]\setlength{\parindent}{1em}
@@ -2617,28 +2741,28 @@ any numbering.
\end{flushleft}
\minisec{Assembly}
- At first one searches the mouse-hole and puts the drawing pin
- directly behind the hole. Thus the mouse cannot escape
- meanwhile the following actions.
-
- Afterwards one knocks in the spring-plug with the hammer
- in the mouse-hole.
- If the spring-plug's size is not big enough in order to
- shut the mouse-hole entirely, then one can utilize
- the plank instead and fasten it with the two screws
- employing the knife on the mouse-hole.
- Instead of the knife one can use a screw-driver as well.
+ At first one searches the mouse-hole and puts the drawing pin
+ directly behind the hole. Thus the mouse cannot escape during the
+ following actions.
+
+ Then one knocks the spring-plug with the hammer into the
+ mouse-hole. If the spring-plug's size is not big enough in order
+ to shut the mouse-hole entirely, then one can utilize the plank
+ instead and fasten it against the front of the mouse-hole
+ utilizing the two screws and the knife. Instead of the knife one
+ can use a screw-driver instead.
\end{ShowOutput}
\end{Example}
-The font type of the disposition command \Macro{minisec} be
-changed using the element
+The font type of the structuring command \Macro{minisec} be changed
+using the element
\FontElement{disposition}\IndexFontElement{disposition} (see
\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}) or
+\autopageref{tab:maincls.elementsWithoutText}) and
\FontElement{minisec}\ChangedAt{2.96a}{%
- \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}}. Default setting
-of element \FontElement{minisec} is empty.
+ \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{Cmd}{minisec}%
@@ -2650,27 +2774,27 @@ of element \FontElement{minisec} is empty.
In the 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} formats the headings left
-aligned with hanging indentation using \Macro{raggedsection} with the
-definition:
+approach in typography. {\KOMAScript} therefore formats the headings
+left aligned with hanging indentation using \Macro{raggedsection} with
+the definition:
\begin{lstlisting}
\newcommand*{\raggedsection}{\raggedright}
\end{lstlisting}
This command can be redefined with \Macro{renewcommand}.
\begin{Example}
- You prefer justified headings. You write in the preamble of your document:
+ You prefer justified headings, so you write in the preamble of your document:
\begin{lstlisting}
\renewcommand*{\raggedsection}{}
\end{lstlisting}
- or short:
+ or more compactly:
\begin{lstlisting}
\let\raggedsection\relax
\end{lstlisting}
- You will get a formatting of the headings which is very close to the
- standard classes. Even closer it will get when you combine this change
- with the change of the element
- \FontElement{disposition}\IndexFontElement{disposition} mentioned
- above.
+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.
\end{Example}
%
\EndIndex{Cmd}{raggedsection}%
@@ -2687,39 +2811,42 @@ This command can be redefined with \Macro{renewcommand}.
\BeginIndex{Cmd}{chapterformat}%
\BeginIndex{Cmd}{othersectionlevelsformat}%
\BeginIndex{Cmd}{autodot}%
- As you might know, for every counter in {\LaTeX} there is a command
- \Macro{the}\PName{counter name}, which gives you the value of the
- counter. Depending on the class the counter for a particular level
- starting from \Macro{section} (\Class{book}, \Class{scrbook},
- \Class{report}, \Class{scrreprt}) or \Macro{subsection}
- (\Class{article}, \Class{scrartcl}) is composed of the counter for the
- higher level followed by a dot and the arabic number of the
- \PName{counter name} of the respective level.\par
+As you might know, for every counter in {\LaTeX} there is a command
+\Macro{the}\PName{countername}, which outputs the value of the
+counter. Depending on the class the counter for a particular level
+starting from \Macro{section} (\Class{book}, \Class{scrbook},
+\Class{report}, \Class{scrreprt}) or \Macro{subsection}
+(\Class{article}, \Class{scrartcl}) is composed of the counter for the
+next higher level followed by a dot and the Arabic number of the
+\PName{countername} of the respective level.\par
\end{Explain}
-\KOMAScript{} has added to the output of the section number a further
-logical level. The counter for the respective heading are formatted
-using \Macro{partformat}, \Macro{chapterformat} and
-\Macro{othersectionlevelsformat}.
+{\KOMAScript} has added a further logical level to the output of the
+section number. The counters for the respective heading are not merely
+output. They are formatted using the commands \Macro{partformat},
+\Macro{chapterformat} and \Macro{othersectionlevelsformat}.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course the command
-\Macro{chapterformat} doesn't exist in the class \Class{scrartcl}.
+\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 in \autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.pointlessnumbers}
-{\KOMAScript} handles dots in section numbers according to
-\cite{DUDEN}. The command \Macro{autodot} makes sure that these rules
-are being followed. Except from \Macro{part} in all levels a dot is
-followed by a \Macro{enskip}. This is similar to a horizontal skip of
-\(0.5\Unit{em}\).
-
-The command \Macro{othersectionlevelsformat} takes the name of the
-section level, such as ``\PName{section}'', ``\PName{subsection}''
-\dots{}, as parameter. As default, only the levels \Macro{part} and
-\Macro{chapter} have formatting commands on their own, while all other
-section levels are covered by one formatting command only. This has
-historical reasons. At the time Werner Lemberg suggested a suitable
-extension of {\KOMAScript} for his \Package{CJK} package, only this
-differentiation was needed.
+\autopageref{desc:maincls.option.pointlessnumbers}, dots 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 being followed. In all
+levels except for \Macro{part} a dot is followed by a further
+\Macro{enskip}. This corresponds to a horizontal skip of
+0.5\Unit{em}.
+
+The command \Macro{othersectionlevelsformat} takes as a parameter the
+name of the section level, such as ``\PName{section}'',
+``\PName{subsection}'' \dots{} Per default therefore, only the levels
+\Macro{part} and \Macro{chapter} have formatting commands of their
+own, while all other section levels are covered by one general
+formatting command. This has historical reasons. At the time that
+Werner Lemberg suggested a suitable extension of {\KOMAScript} for his
+\Package{CJK} package, only this differentiation was needed.
The formatting commands can be redefined using \Macro{renewcommand} to
fit them to your personal needs. The following original definitions
@@ -2733,31 +2860,31 @@ are used by the {\KOMAScript} classes:
\end{lstlisting}
\begin{Example}
- Assume you don't want the word ``Part'' written in front of the part number.
- You could use the following command in the preamble of your document:
+ Assume that when using \Macro{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{lstlisting}
\renewcommand*{\partformat}{\thepart\autodot}
\end{lstlisting}
- In fact, you could do without \Macro{autodot} at this point and insert
- a fixed point instead. As \Macro{part} is numbered with roman numbers,
- according to \cite{DUDEN} a dot has to be applied. However, you would
- give up the possibility to use one of the options
- \Option{pointednumbers} und \Option{pointlessnumbers} then. More
- details concerning class options you can find in
- \autoref{sec:maincls.formattingOptions},
- \autopageref{desc:maincls.option.pointlessnumbers}).
+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, according to \cite{DUDEN} a dot has to be applied. However,
+you thereby give up the possibility to use one of the options
+\Option{pointednumbers} and \Option{pointlessnumbers} and optionally
+depart from the rules. More details concerning class options can be
+found in \autoref{sec:maincls.formattingOptions},
+\autopageref{desc:maincls.option.pointlessnumbers}.
- An additional possibility could be to place the section numbers
- in the left margin. That can be done in a way that the heading
- text is left aligned with the surrounding text.
- This can be accomplished with:
+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
+the surrounding text. This can be accomplished with:
\begin{lstlisting}
\renewcommand*{\othersectionlevelsformat}[1]{%
\llap{\csname the#1\endcsname\autodot\enskip}}
\end{lstlisting}
- The almost unknown command \Macro{llap} in the definition above,
- puts its argument left to the current possition without changing the
- position. A much better \LaTeX{} solution would be:
+The little known {\TeX} command \Macro{llap} in the definition above
+puts its argument left of the current position without changing the
+position thereby. A much better {\LaTeX} solution would be:
\begin{lstlisting}
\renewcommand*{\othersectionlevelsformat}[1]{%
\makebox[0pt][r]{%
@@ -2781,18 +2908,19 @@ are used by the {\KOMAScript} classes:
\BeginIndex{Cmd}{chapapp}%
These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
\ChangedAt{v2.8o}{\Class{scrbook}\and\Class{scrreprt}} two commands
-are used internally by {\KOMAScript} and are also provided at the user
-interface. Using the layout option \Option{chapterprefix} (see
-\autoref{sec:maincls.layoutOptions},
+are not only used internally by {\KOMAScript} but are also provided to
+the user. Later it will be shown how they can be used for example to
+redefine other commands. Using the layout option
+\Option{chapterprefix} (see \autoref{sec:maincls.layoutOptions},
\autopageref{desc:maincls.option.chapterprefix})
-\Macro{chapappifchapterprefix} issues the word
-``Chapter''\Index{chapter} in the main part of your document in the
-current language followed by \PName{additional text}. In the
-appendix\Index{appendix} instead, the word ``Appendix'' in the current
-language followed by \PName{additional text} is issued. Having set the
-option \Option{nochapterprefix} there is no additional output.
-
-The command \Macro{chapapp} always issues the word ``Chapter'' or
+\Macro{chapappifchapterprefix} outputs the word
+``Chapter''\Index{chapter} 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 \Option{nochapterprefix} is set, then nothing is output.
+
+The command \Macro{chapapp} always outputs the word ``Chapter'' or
``Appendix''. In this case the options \Option{chapterprefix} and
\Option{nochapterprefix} have no effect.
@@ -2804,9 +2932,9 @@ Since chapters only exist in the classes \Class{scrbook} and
\begin{Declaration}
- \Macro{chaptermark}\Parameter{Running head}\\
- \Macro{sectionmark}\Parameter{Running head}\\
- \Macro{subsectionmark}\Parameter{Running head}\\
+ \Macro{chaptermark}\Parameter{Running heading}\\
+ \Macro{sectionmark}\Parameter{Running heading}\\
+ \Macro{subsectionmark}\Parameter{Running heading}\\
\Macro{chaptermarkformat}\\
\Macro{sectionmarkformat}\\
\Macro{subsectionmarkformat}
@@ -2819,32 +2947,32 @@ Since chapters only exist in the classes \Class{scrbook} and
\BeginIndex{Cmd}{subsectionmarkformat}%
\begin{Explain}%
As mentioned in \autoref{sec:maincls.pageStyle} the page style
- \PValue{headings} works with running heads\Index{running
- head}. For this, the commands \Macro{chaptermark} and
- \Macro{sectionmark} as well as \Macro{sectionmark} and
- \Macro{subsectionmark} respectively are defined. Every disposition
- command (\Macro{chapter}, \Macro{section}, \Macro{subsection} \dots)
+ \PValue{headings} works with automatic running
+ headings\Index{running heading}. 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} \dots)
automatically carries out the respective \Macro{\dots mark} command.
- The parameter handed over takes the text of the section
+ The parameter passed contains the text of the section
heading\Index{heading}. The respective section number is added
- automatically to the \Macro{\dots mark} command. The formatting is done
- according to the section level with the command
+ 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}.
\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no
command \Macro{chaptermark} or \Macro{chaptermarkformat} in
- \Class{scrartcl}. \OnlyAt{\Class{scrartcl}}Accordingly
- \Macro{subsectionmark} and the command \Macro{subsectionmarkformat}
- only exist in \Class{scrartcl}. This changes when you use the
+ \Class{scrartcl}. \OnlyAt{\Class{scrartcl}}Accordingly,
+ \Macro{subsectionmark} and \Macro{subsectionmarkformat} exist only
+ in \Class{scrartcl}. This changes when you use the
\Package{scrpage2} package (see \autoref{cha:scrpage}).\par
\end{Explain}
-Similar to \Macro{chapterformat} and \Macro{othersectionlevelsformat} the
-commands \Macro{chaptermarkformat} (not at \Class{scrartcl}),
-\Macro{sectionmarkformat} and the command \Macro{subsectionmarkformat}
-(only at \Class{scrartcl}) define the formatting of the section numbers
-in running heads. They can be adapted to your personal needs with
-\Macro{renewcommand}. The original definitions from the {\KOMAScript}
-classes are:
+Similar to \Macro{chapterformat} and \Macro{othersectionlevelsformat},
+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 headings. They can be adapted to your personal
+needs with \Macro{renewcommand}. The original definitions for the
+{\KOMAScript} classes are:
\begin{lstlisting}
\newcommand*{\chaptermarkformat}{%
\chapappifchapterprefix{\ }\thechapter\autodot\enskip}
@@ -2853,16 +2981,16 @@ classes are:
\thesubsection\autodot\enskip}
\end{lstlisting}
\begin{Example}
- Suppose you want to combine the chapter number in the header with the word
- ``Chapter''. For example you could insert in the preamble of your
- document the following definition:
+ Suppose you want to prepend the word ``Chapter'' to the chapter
+ number in the running heading. For example you could insert the
+ following definition in the preamble of your document :
\begin{lstlisting}
\renewcommand*{\chaptermarkformat}{%
\chapapp~\thechapter\autodot\enskip}
\end{lstlisting}
\end{Example}
-As you can see both the commands \Macro{chapappifchapterprefix} and
-\Macro{chapapp} explained above are used.
+As you can see, both the commands \Macro{chapappifchapterprefix} and
+\Macro{chapapp} explained above are used here.
%
\EndIndex{Cmd}{chaptermark}%
\EndIndex{Cmd}{sectionmark}%
@@ -2876,21 +3004,20 @@ As you can see both the commands \Macro{chapappifchapterprefix} and
\Counter{secnumdepth}
\end{Declaration}%
\BeginIndex{Counter}{secnumdepth}\BeginIndex{}{numbering}%
-As default in the classes \Class{scrbook}\IndexClass{scrbook} and
+Per default, in the classes \Class{scrbook}\IndexClass{scrbook} and
\Class{scrreprt}\IndexClass{scrreprt} the section levels from
\Macro{part}\IndexCmd{part}\IndexCmd{chapter}\IndexCmd{section} down
to \Macro{subsection}\IndexCmd{subsection} and in the class
\Class{scrartcl}\IndexClass{scrartcl} the levels from \Macro{part}
down to \Macro{subsubsection}\IndexCmd{subsubsection} are numbered.
-This is controlled by the \LaTeX\ counter \Counter{secnumdepth}. The
-value \(-1\) represents \Macro{part}, \(0\) the level \Macro{chapter}
-and so on. Since in \Class{scrartcl} there is no \Macro{chapter} the
-counting in this class starts with \(0\) at the level \Macro{part}. By
-way of defining, decrementing or incrementing this counter you can
-determine down to which level the headings are numbered. The same
-applies in the standard classes. Please refer also to the explanations
+This is controlled by the {\LaTeX} counter \Counter{secnumdepth}. The
+value \(-\)1 represents \Macro{part}, 0 the level \Macro{chapter},
+and so on. By defining, incrementing or decrementing this counter you
+can determine down to which level the headings are numbered. The same
+applies in the standard classes. Please refer also to the explanation
concerning the counter \Counter{tocdepth} in
-\autoref{sec:maincls.toc}, \autopageref{desc:maincls.counter.tocdepth}.
+\autoref{sec:maincls.toc},
+\autopageref{desc:maincls.counter.tocdepth}.
%
\EndIndex{Counter}{secnumdepth}\EndIndex{}{numbering}
@@ -2905,35 +3032,36 @@ concerning the counter \Counter{tocdepth} in
\BeginIndex{Cmd}{setchapterpreamble}%
Parts\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} and chapters in
{\KOMAScript} can be started with a \PName{preamble}. This is
-particularily useful when you are using a two column layout with the
-class option \Option{twocolumn}\IndexOption{twocolumn}. Together with
-the heading the \PName{preamble} is always set in a one column layout.
-The \PName{preamble} can comprise more than one paragraph. The command
-for issuing the \PName{preamble} has to be put in front of the
-respective \Macro{part}, \Macro{addpart}, \Macro{chapter} or
-\Macro{addchap} command.
+particularly 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.
\begin{Example}
- You are writing a report on the situation of a company. You organize
- the report in such a way that every department gets its own partial report.
- Every one of these parts should be introduced by a short abstract on the
- title page. You could write the following:
+ 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
+ partial report. Every one of these parts should be introduced by an
+ abstract on the corresponding title page. You could write the
+ following:
\begin{lstlisting}
\setpartpreamble{%
\begin{abstract}
- This is a blind text. This text should show, how a
- printed text will look like at this place. If you
- read this text, you will get no information.
+ This is a filler text. It serves merely to demonstrate the
+ capabilities of {\KOMAScript}. If you read this text, you will
+ get no information.
\end{abstract}
}
\part{Department for Word Processing}
\end{lstlisting}
- Depending on the settings for the heading\Index{heading} (see
- \autoref{sec:maincls.fontOptions},
- \autopageref{desc:maincls.option.smallheadings}) size and the
- \Environment{abstract} environment\IndexEnv{abstract} (see
- \autoref{sec:maincls.formattingOptions},
- \autopageref{desc:maincls.option.abstracton}), the result would look similar
- to:
+Depending on the settings for the heading font size\Index{heading}
+(see \autoref{sec:maincls.fontOptions},
+\autopageref{desc:maincls.option.smallheadings}) and the options for
+the \Environment{abstract} environment\IndexEnv{abstract} (see
+\autoref{sec:maincls.formattingOptions},
+\autopageref{desc:maincls.option.abstracton}), the result would look
+similar to:
\begin{ShowOutput}\centering
{\LARGE\usekomafont{disposition} Part III.\par\vspace{20pt}}
{\LARGE\usekomafont{disposition} Department for Word Processing\strut\par}
@@ -2942,9 +3070,10 @@ respective \Macro{part}, \Macro{addpart}, \Macro{chapter} or
\begin{center}
\usekomafont{disposition}\abstractname
\end{center}
- \vspace{2ex} This is a blind text. This text should show, how a
- printed text will look like at this place. If you read this text,
- you will get no information.
+ \vspace{2ex}
+ This is a filler text. It serves merely to demonstrate the
+ capabilities of {\KOMAScript}. If you read this text, you will
+ get no information.
\end{quote}
\end{ShowOutput}
\end{Example}
@@ -2962,19 +3091,19 @@ vertical placement there are two possibilities at present:
\item [\quad\texttt{o}:] above the heading
\item [\quad\texttt{u}:] below the heading
\end{description}
-You can insert a preamble both above and below a heading. For the
+You can insert one preamble above and another below a heading. For the
horizontal placement you have the choice between three alignments:
\begin{description}
\item [\quad\texttt{l}:] left-aligned
\item [\quad\texttt{r}:] right-aligned
\item [\quad\texttt{c}:] centered
\end{description}
-However, this does not issue the text of the \PName{preamble} but
-inserts a box whose width is determined by the second optional
-argument \PName{width}. If you leave out this second argument the
-whole text width is used. In this case the option for horizontal
-positioning will have no effect. You can combine one letter from the
-vertical with one letter from the horizontal positioning.
+However, this does not output the text of the \PName{preamble} in such
+a manner, but inserts a box whose width is determined by the second
+optional argument \PName{width}. If you leave out this second argument
+the whole text width is used. In that case the option for horizontal
+positioning will have no effect. You can combine exactly one letter
+from the vertical with one letter from the horizontal positioning.
%
\EndIndex{Cmd}{setpartpreamble}%
\EndIndex{Cmd}{setchapterpreamble}%
@@ -2996,7 +3125,7 @@ vertical with one letter from the horizontal positioning.
\BeginIndex{Cmd}{raggeddictumauthor}%
Apart\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}%
\ChangedAt{v2.8q}{\Class{scrbook}\and\Class{scrreprt}} from an
-introducing paragraph you can use \Macro{setpartpreamble} or
+introductory paragraph you can use \Macro{setpartpreamble} or
\Macro{setchapterpreamble} for a kind of
\PName{aphorism}\Index{aphorism} (also known as ``dictum'') at the
beginning of a chapter or section. The command \Macro{dictum} inserts
@@ -3005,39 +3134,40 @@ either the command \Macro{setchapterpreamble} or
\Macro{setpartpreamble}. However, this is not obligatory.
The dictum together with an optional \PName{author} is inserted in a
-\Macro{parbox}\IndexCmd{parbox} (see \cite{latex:usrguide}) of the
-width \Macro{dictumwidth}. Yet \Macro{dictumwidth} is not a length
-which is set with \Macro{setlength}. It is a macro that can be
-redefined using \Macro{renewcommand}. Default setting is
+\Macro{parbox}\IndexCmd{parbox} (see \cite{latex:usrguide}) of width
+\Macro{dictumwidth}. Yet \Macro{dictumwidth} is not a length which can
+be set with \Macro{setlength}. It is a macro that can be redefined
+using \Macro{renewcommand}. Default setting is
\verb;0.3333\textwidth;, which is a third of the textwidth. The box
itself is positioned with the command \Macro{raggeddictum}. Default
-here is \Macro{raggedleft}\IndexCmd{raggedleft}. The command
-\Macro{raggeddictum} can be redefined using \Macro{renewcommand}.
+here is \Macro{raggedleft}\IndexCmd{raggedleft}, that is, right
+justified. The command \Macro{raggeddictum} can be redefined using
+\Macro{renewcommand}.
Within the box the \PName{dictum} is set using
\Macro{raggeddictumtext}. Default setting is
-\Macro{raggedright}\IndexCmd{raggedright}. Similar to
-\Macro{raggeddictum} it can be redefined with \Macro{renewcommand}.
-The output uses the default font which is set for the element
-\FontElement{dictumtext}. It can be changed with the commands from
-\autoref{sec:maincls.font}. Default settings are listed in
-\autoref{tab:maincls.dictumfont}.
-
-If there is an \PName{author} it is separated from the \PName{dictum}
-by a line with the width of the \Macro{parbox}. This is defined by the
-macro \Macro{raggeddictumauthor}. Default is \Macro{raggedleft}. This
-command can also be redefined using \Macro{renewcommand}. The format
-of the output is defined with \Macro{dictumauthorformat}. This macro
-expects the \Macro{author} as argument. As default
-\Macro{dictumauthorformat} is defined as:
+\Macro{raggedright}\IndexCmd{raggedright}, that is, left
+justified. Similarly to \Macro{raggeddictum} this can be redefined
+with \Macro{renewcommand}. The output uses the default font setting
+for the element \FontElement{dictumtext}, which can be changed with
+the commands from \autoref{sec:maincls.font}. Default settings are
+listed in \autoref{tab:maincls.dictumfont}.
+
+If there is an \PName{author} name, it is separated from the
+\PName{dictum} by a line the full width of the \Macro{parbox}. This is
+defined by the macro \Macro{raggeddictumauthor}. Default is
+\Macro{raggedleft}. This command can also be redefined using
+\Macro{renewcommand}. The format of the output is defined with
+\Macro{dictumauthorformat}. This macro expects the \Macro{author} as
+argument. As default \Macro{dictumauthorformat} is defined as:
\begin{lstlisting}
\newcommand*{\dictumauthorformat}[1]{(#1)}
\end{lstlisting}
-Thus the \PName{author} is set in in round parenthesis. For the
-element \FontElement{dictumauthor} a different font as for the element
-\FontElement{dictumtext} can be defined. Default settings are listed
-in \autoref{tab:maincls.dictumfont}. Changes can be made using the
-commands from \autoref{sec:maincls.font}.
+Thus the \PName{author} is set enclosed in rounded parenthesis. For
+the element \FontElement{dictumauthor} a different font than for the
+element \FontElement{dictumtext} can be defined. Default settings are
+listed in \autoref{tab:maincls.dictumfont}. Changes can be made using
+the commands from \autoref{sec:maincls.font}.
%
\begin{table}
\centering%
@@ -3056,21 +3186,21 @@ commands from \autoref{sec:maincls.font}.
\end{table}
%
If \Macro{dictum} is used within the macro \Macro{setchapterpreamble}
-or \Macro{setpartpreamble} you have to take care of the following: The
+or \Macro{setpartpreamble} you have to take care of the following: the
horizontal positioning is always done with \Macro{raggeddictum}.
-Therefore, the optional argument for horizontal positioning, which is
-implemented for these two commands, has no effect. \Macro{textwidth}
-is not the width of the whole text corpus but the actually used text
+Therefore, the optional argument for horizontal positioning which is
+implemented for these two commands has no effect. \Macro{textwidth} is
+not the width of the whole text corpus but the actually used text
width. If \Macro{dictumwidth} is set to \verb;.5\textwidth; and
\Macro{setchapterpreamble} has an optional width of
-\verb;.5\textwidth; too, you will get a box with a width of a quarter
+\verb;.5\textwidth; too, you will get a box with a width one quarter
of the text width. Therefore, if you use \Macro{dictum} it is
recommended to refrain from setting the optional width for
\Macro{setchapterpreamble} or \Macro{setpartpreamble}.
-If you have more than one dictum you should separate them by an
-additional vertical space. You could easely use the command
-\Macro{bigskip}\IndexCmd{bigskip} for that.
+If you have more than one dictum one under another, you should
+separate them by an additional vertical space, easily accomplished
+using the command \Macro{bigskip}\IndexCmd{bigskip}.
\begin{Example}
You are writing a chapter on an aspect of weather forecasting. You
@@ -3091,8 +3221,8 @@ additional vertical space. You could easely use the command
happen and then to explain why it didn't.}
\end{ShowOutput}
- If you would rather prefer the dictum to span over only a quarter of
- the text width you can redefine \Macro{dictumwidth}:
+ If you would rather the dictum span only a quarter of the text width
+ rather than one third you can redefine \Macro{dictumwidth}:
\begin{lstlisting}
\renewcommand*{\dictumwidth}{.25\textwidth}
\end{lstlisting}
@@ -3112,9 +3242,9 @@ package~\Package{ragged2e}~\cite{package:ragged2e}.
\subsection{Footnotes}
\label{sec:maincls.footnotes}
-Footnotes are not limited to the main part of the document. Since
-footnotes\Index{footnotes} are mainly used in the main text they are
-being covered in this section.
+Footnotes are not limited to the main part of the document. However,
+since footnotes\Index{footnotes} are mainly used in the main text they
+are covered in this section.
\begin{Declaration}
\Macro{footnote}\OParameter{number}\Parameter{text}\\
@@ -3124,14 +3254,13 @@ being covered in this section.
\BeginIndex{Cmd}{footnote}%
\BeginIndex{Cmd}{footnotemark}%
\BeginIndex{Cmd}{footnotetext}%
-Similar to the standard classes footnotes in {\KOMAScript} are
-produced with the \Macro{footnote} command.
-An alternative is the usage in pairs of the commands
-\Macro{footnotemark} and \Macro{footnotetext}.
-As in the standard classes it is possible that a page break occurs
-within a footnote. Normally this happens if the footnote mark is
-placed near the bottom of a page thus leaving \LaTeX\ no choice as to
-break the page at this point.
+Similarly to the standard classes, footnotes in {\KOMAScript} are
+produced with the \Macro{footnote} command, or alternatively the
+pairwise usage of the commands \Macro{footnotemark} and
+\Macro{footnotetext}. As in the standard classes it is possible that
+a page break occurs within a footnote. Normally this happens if the
+footnote mark is placed so near the bottom of a page as to leave
+{\LaTeX} no choice but to break the footnote onto the next page.
%
\EndIndex{Cmd}{footnote}%
\EndIndex{Cmd}{footnotemark}%
@@ -3149,21 +3278,19 @@ break the page at this point.
\BeginIndex{Cmd}{deffootnotemark}%
\BeginIndex{Cmd}{thefootnotemark}%
\BeginIndex{Cmd}{textsuperscript}%
-Formatting footnotes in {\KOMAScript} is slightly different to the
-standard classes. As in the standard classes the footnote mark in the
-text is formed as a small number in superscript. The same formatting
-is used in the footnote itself.
-
-The mark in the footnote is type-set right-aligned in a box
-with width \PName{mark width}. The first line of the footnote
-follows directly.
+Footnotes are formatted slightly differently in {\KOMAScript} to in
+the standard classes. As in the standard classes the footnote mark in
+the text is depicted using a small superscripted number. The same
+formatting is used in the footnote itself. The mark in the footnote is
+type-set right-aligned in a box with width \PName{mark width}. The
+first line of the footnote follows directly.
All following lines will be indented by the length of
-\PName{indent}. If the optional parameter \PName{mark width}
-was not specified, then it defaults to \PName{indent}.
-If the footnote consists of more than one paragraph, then the
-first line of a paragraph is indented in addition to \PName{indent}
-by the value of \PName{parindent}.
+\PName{indent}. If the optional parameter \PName{mark width} is not
+specified, it defaults to \PName{indent}. If the footnote consists of
+more than one paragraph, then the first line of a paragraph is
+indented, in addition to \PName{indent}, by the value of
+\PName{parindent}.
\begin{figure}
\centering\setlength{\unitlength}{1mm}
\begin{picture}(100,22)
@@ -3210,69 +3337,71 @@ by the value of \PName{parindent}.
\end{figure}
Figure \ref{fig:maincls.deffootnote} illustrates the layout parameters
-ones more. The default configuration of \KOMAScript{} is:
+once more. The default configuration of {\KOMAScript} is:
\begin{lstlisting}
\deffootnote[1em]{1.5em}{1em}
{\textsuperscript{\thefootnotemark}}
\end{lstlisting}
-\Macro{textsuperscript} causes both the superscript and the smaller
+\Macro{textsuperscript} controls both the superscript and the smaller
font size. \Macro{thefootnotemark} is the current footnote mark
without any formatting.
The\ChangedAt{v2.8q}{%
- \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} font element
-\FontElement{footnote}\IndexFontElement{footnote} determines the font
-of the footnote including the footnote mark. Using the element
-\FontElement{footnotelabel}\IndexFontElement{footnotelabel} the font
-of the footnote mark can be changed separately with the commands
-mentioned in \autoref{sec:maincls.font} Please refer also to the
+ \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} font
+element \FontElement{footnote}\IndexFontElement{footnote} determines
+the font of the footnote including the footnote mark. Using the
+element \FontElement{footnotelabel}\IndexFontElement{footnotelabel}
+the font of the footnote mark can be changed separately with the
+commands mentioned in \autoref{sec:maincls.font} Please refer also to
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}. Default setting is no
-changing of the font.
+change in the font.
-The footnote mark in the text is defined separately with
+The footnote mark in the text is defined separately from the mark in
+front of the actual footnote. This is done with
\Macro{deffootnotemark}. Default setting is:
\begin{lstlisting}
\deffootnotemark{%
\textsuperscript{\thefootnotemark}}
\end{lstlisting}
-Above\ChangedAt{v2.8q}{%
+In the above\ChangedAt{v2.8q}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} the font
for the element
\FontElement{footnotereference}\IndexFontElement{footnotereference} is
applied (see \autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). Thus the
-footnote marks in the text and the footnote itself are identical. The
-font can be changed with the commands described in
+\autopageref{tab:maincls.elementsWithoutText}). Thus the footnote
+marks in the text and in the footnote itself are identical. The font
+can be changed with the commands described in
\autoref{sec:maincls.font}.
\begin{Example}
- A feature often asked for are footnote marks which are neither in
+ A feature often asked for is footnote marks which are neither in
superscript nor in a smaller font size. They should not touch the
- footnote text but have a small space in between. This can be
+ footnote text but be separated by a small space. This can be
accomplished as follows:
\begin{lstlisting}
\deffootnote{1em}{1em}{\thefootnotemark\ }
\end{lstlisting}
- The footnote mark and the space is set right-aligned into a
- box of the width 1\Unit{em}. The following lines of the footnote
- text is also indented by 1\Unit{em} from the left margin.
+The footnote mark and the following space are therefore set
+right-aligned into a box of width 1\Unit{em}. The following lines of
+the footnote text are also indented by 1\Unit{em} from the left
+margin.
- Another often requested footnote layout are left-aligned
- footnote marks. These can be reached with:
+Another often requested footnote layout is left-aligned footnote
+marks. These can be obtained with:
\begin{lstlisting}
\deffootnote{1.5em}{1em}{%
\makebox[1.5em][l]{\thefootnotemark}}
\end{lstlisting}
- If you want however change the font for all footnotes, for example
- to sans serif, you can simply solve this problem using the commands
- from \autoref{sec:maincls.fontOptions}:
+If you want however only to change the font for all footnotes, for
+example to sans serif, you can solve this problem simply by using the
+commands from \autoref{sec:maincls.fontOptions}:
\begin{lstlisting}
\setkomafont{footnote}{\sffamily}
\end{lstlisting}
\end{Example}
-As demonstrated with the examples above the simple user interface of
+As demonstrated with the examples above, the simple user interface of
{\KOMAScript} provides a great variety of different footnote
formattings.
%
@@ -3287,11 +3416,12 @@ formattings.
Both {\LaTeX} and the standard classes offer different environments
for lists. Though slightly changed or extended all these list are of
-course offered in {\KOMAScript} as well. In general all lists\,---\,even
-of different kind\,---\,can be nested up to four levels. From a
-typographical view, anything more would make no sense. Even more than
-three levels are hard to perceive. Recommendation in these cases is to
-split your huge list in several small ones.
+course offered in {\KOMAScript} as well. In general all
+lists\,---\,even of different kind\,---\,can be nested up to four
+levels. From a typographical view, anything more would make no sense,
+as more than three levels can no longer be easily perceived. The
+recommended procedure in such a case is to split the large list into
+several smaller ones.
\begin{Declaration}
\Environment{itemize}\\
@@ -3307,13 +3437,17 @@ split your huge list in several small ones.
\BeginIndex{Cmd}{labelitemii}%
\BeginIndex{Cmd}{labelitemiii}%
\BeginIndex{Cmd}{labelitemiv}%
-The most simple form of a list is an \Environment{itemize} list.
-Depending on the level {\KOMAScript} uses the following marks:
-"`{\labelitemi}"', "`{\labelitemii}"', "`{\labelitemiii}"' and
-"`{\labelitemiv}"'. The definition of these symbols is specified in
+The simplest form of a list is an \Environment{itemize} list. The
+users of a certain disliked word processing package often refer to
+this form of a list as \emph{bulletpoints}. Presumably, these users
+are unable to envisage that, depending on the level, a different
+symbol from a large dot could be used to introduce each
+point. Depending on the level, {\KOMAScript} uses the following marks:
+``{\labelitemi}'', ``{\labelitemii}'', ``{\labelitemiii}'' and
+``{\labelitemiv}''. The definition of these symbols is specified in
the macros \Macro{labelitemi}, \Macro{labelitemii},
-\Macro{labelitemiii} and \Macro{labelitemiv}. All of this macros can
-be redefined using \Macro{renewcommand}. Every item is introduced with
+\Macro{labelitemiii} and \Macro{labelitemiv}, all of which can be
+redefined using \Macro{renewcommand}. Every item is introduced with
\Macro{item}.
\begin{Example}
You have a simple list which is nested in several levels. You write
@@ -3321,7 +3455,7 @@ be redefined using \Macro{renewcommand}. Every item is introduced with
\begin{lstlisting}
\minisec{Vehicles}
\begin{itemize}
- \item aeroplans
+ \item aeroplanes
\begin{itemize}
\item biplane
\item jets
@@ -3329,18 +3463,24 @@ be redefined using \Macro{renewcommand}. Every item is introduced with
\begin{itemize}
\item single-engined
\begin{itemize}
- \item{jet-driven}
- \item{propeller-driven}
+ \item jet-driven
+ \item propeller-driven
\end{itemize}
\item multi-engined
\end{itemize}
- \item helicopter
+ \item helicopters
\end{itemize}
+%% wahrsheinlich Platzfiller in Deutscher Ausgabe?
+% \item motorcycles
+% \begin{itemize}
+% \item historically accurate
+% \item futuristic, not real
+% \end{itemize}
\item automobiles
\begin{itemize}
- \item racing car
- \item private car
- \item lorry
+ \item racing cars
+ \item private cars
+ \item lorries
\end{itemize}
\item bicycles
\end{itemize}
@@ -3349,26 +3489,32 @@ be redefined using \Macro{renewcommand}. Every item is introduced with
\begin{ShowOutput}[\baselineskip]
\minisec{Vehicles}
\begin{itemize}
- \item aeroplans
+ \item aeroplanes
\begin{itemize}
- \item biplane
+ \item biplanes
\item jets
\item transport planes
\begin{itemize}
\item single-engined
\begin{itemize}
- \item{jet-driven}
- \item{propeller-driven}
+ \item jet-driven
+ \item propeller-driven
\end{itemize}
\item multi-engined
\end{itemize}
- \item helicopter
+ \item helicopters
\end{itemize}
+%% wahrsheinlich Platzfiller in Deutscher Ausgabe?
+% \item motorcycles
+% \begin{itemize}
+% \item historically accurate
+% \item futuristic, not real
+% \end{itemize}
\item automobiles
\begin{itemize}
- \item racing car
- \item private car
- \item lorry
+ \item racing cars
+ \item private cars
+ \item lorries
\end{itemize}
\item bicycles
\end{itemize}
@@ -3406,8 +3552,8 @@ be redefined using \Macro{renewcommand}. Every item is introduced with
\BeginIndex{Cmd}{labelenumiii}%
\BeginIndex{Cmd}{labelenumiv}%
Another form of a list often used is a numbered list which is already
-implemented by the {\LaTeX} kernel. Depending on the level the
-numbering\Index{numbering} uses the following characters: arabic
+implemented by the {\LaTeX} kernel. Depending on the level, the
+numbering\Index{numbering} uses the following characters: Arabic
numbers, small letters, small roman numerals and capital letters. The
kind of numbering is defined with the macros \Macro{theenumi} down to
\Macro{theenumiv}. The output format is determined by the macros
@@ -3416,39 +3562,45 @@ the second level is followed by a round parenthesis, the values of all
other levels are followed by a dot. Every item is introduced with
\Macro{item}.
\begin{Example}
- Replacing every occurence of an \Environment{itemize} environment
+ Replacing every occurrence of an \Environment{itemize} environment
with an \Environment{enumerate} environment in the example above we
get the following result:
\begin{ShowOutput}[\baselineskip]
\minisec{Vehicles}
\begin{enumerate}
- \item aeroplans
+ \item aeroplanes
\begin{enumerate}
- \item biplane
+ \item biplanes
\item jets
\item transport planes
\begin{enumerate}
\item single-engined
\begin{enumerate}
- \item{jet-driven}\label{xmp:maincls.jets}
- \item{propeller-driven}
+ \item jet-driven\label{xmp:maincls.jets}
+ \item propeller-driven
\end{enumerate}
\item multi-engined
\end{enumerate}
- \item helicopter
+ \item helicopters
\end{enumerate}
+%% wahrsheinlich Platzfiller in Deutscher Ausgabe?
+% \item motorcycles
+% \begin{enumerate}
+% \item historically accurate
+% \item futuristic, not real
+% \end{enumerate}
\item automobiles
\begin{enumerate}
- \item racing car
- \item private car
- \item lorry
+ \item racing cars
+ \item private cars
+ \item lorries
\end{enumerate}
\item bicycles
\end{enumerate}
\end{ShowOutput}
Using \Macro{label} within a list you can set labels which are
- referenced with \Macro{ref}. In the example above a label
- was set after the jet-driven, single-engined transport plane with
+ referenced with \Macro{ref}. In the example above, a label was set
+ after the jet-driven, single-engined transport planes with
\Macro{label}\PParameter{xmp:jets}. The \Macro{ref} value is then
\ref{xmp:maincls.jets}.
\end{Example}
@@ -3471,12 +3623,12 @@ other levels are followed by a dot. Every item is introduced with
\end{Declaration}%
\BeginIndex{Env}{description}%
\BeginIndex{Cmd}{item}%
-Another list form is the description list. Its main use is the
+A further list form is the description list. Its main use is the
description of several items. The item itself is an optional parameter
in \Macro{item}. The font\Index{font}\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}%
-, which is responsible for emphasizing the item can be changed with
-the commands for the element
+which is responsible for emphasizing the item can be changed with the
+commands for the element
\FontElement{descriptionlabel}\IndexFontElement{descriptionlabel} (see
\autoref{tab:maincls.elementsWithoutText},
\autopageref{tab:maincls.elementsWithoutText}) described in
@@ -3495,20 +3647,19 @@ the commands for the element
abbreviated source code is:
\begin{lstlisting}
\begin{description}
- \item[empty] is the page style without
- any header or footer
- \item[plain] is the page style without running headline.
- \item[headings] is the page style with running headline.
- \item[myheadings] is the page style for manual headline.
+ \item[empty] is the page style without any header or footer.
+ \item[plain] is the page style without headings.
+ \item[headings] is the page style with running headings.
+ \item[myheadings] is the page style for manual headings.
\end{description}
\end{lstlisting}
This abbreviated version gives:
\begin{ShowOutput}
\begin{description}
- \item[empty] is the page style without any header or footer
- \item[plain] is the page style without running headline.
- \item[headings] is the page style with running headline.
- \item[myheadings] is the page style for manual headline.
+ \item[empty] is the page style without any header or footer.
+ \item[plain] is the page style without headings.
+ \item[headings] is the page style with running headings.
+ \item[myheadings] is the page style for manual headings.
\end{description}
\end{ShowOutput}
\end{Example}
@@ -3519,29 +3670,30 @@ the commands for the element
\begin{Declaration}
\Environment{labeling}\OParameter{delimiter}\Parameter{widest pattern}\\
- \XMacro{item}\OParameter{key word}
+ \XMacro{item}\OParameter{keyword}
\end{Declaration}%
\BeginIndex{Env}{labeling}%
\BeginIndex{Cmd}{item}%
-An additional form of a description list in {\KOMAScript} is the
-\Environment{labeling} environment. In difference to the
-\Environment{description} environment you can provide a pattern, which
-determines the indentation of all items. Furthermore you can put an
-optional \PName{delimiter} between item and description.
+An additional form of a description list is only available in the
+{\KOMAScript} classes: the \Environment{labeling} environment. Unlike
+the \Environment{description} environment, you can provide a pattern
+whose length determines the indentation of all items. Furthermore, you
+can put an optional \PName{delimiter} between the item and its
+description.
\begin{Example}
Slightly changing the example from the \Environment{description}
- environment we could write:
+ environment, we could write:
\begin{lstlisting}
\begin{labeling}[~--]{%
\usekomafont{descriptionlabel}myheadings}
\item[\usekomafont{descriptionlabel}empty]
Page style without header and footer
\item[\usekomafont{descriptionlabel}plain]
- Page style for chapter beginnings without headline
+ Page style for chapter beginnings without headings
\item[\usekomafont{descriptionlabel}headings]
- Page style for running headline
+ Page style for running headings
\item[\usekomafont{descriptionlabel}myheadings]
- Page style for manual headline
+ Page style for manual headings
\end{labeling}
\end{lstlisting}
As result we get:
@@ -3550,22 +3702,23 @@ optional \PName{delimiter} between item and description.
\item[\usekomafont{descriptionlabel}empty]
Page style without header and footer
\item[\usekomafont{descriptionlabel}plain]
- Page style for chapter beginnings without headline
+ Page style for chapter beginnings without headings
\item[\usekomafont{descriptionlabel}headings]
- Page style for running headline
+ Page style for running headings
\item[\usekomafont{descriptionlabel}myheadings]
- Page style for manual headline
+ Page style for manual headings
\end{labeling}
\end{ShowOutput}
- As can be seen in this example a font changing command has to be
- repeated both in the pattern and in the optional parameter in every
+ As can be seen in this example, a font changing command has to be
+ repeated both in the pattern and in the optional parameter of every
\Macro{item} command in this environment.
\end{Example}
-Originally this environment was implemented for things like ``Given
-is\dots, Asked is\dots, Solution'' that are often used in hand-outs.
-By now this environment has found many different applications. For
-example the environment for examples in this guide was defined with
-the \Environment{labeling} environment.
+Originally this environment was implemented for things like
+``Precondition, Assertion, Proof'', or ``Given, Required, Solution''
+that are often used in lecture hand-outs. By now this environment has
+found many different applications. For example, the environment for
+examples in this guide was defined with the \Environment{labeling}
+environment.
%
\EndIndex{Env}{labeling}%
\EndIndex{Cmd}{item}%
@@ -3575,22 +3728,24 @@ the \Environment{labeling} environment.
\Environment{verse}
\end{Declaration}%
\BeginIndex{Env}{verse}%
-Normally the \Environment{verse} environment isn't perceived as a list
-environment because you don't work with \Macro{item} commands. Instead
-fixed line breaks are used like within the \Environment{flushleft}
-environment. Yet internally in both the standard classes as well
-as {\KOMAScript} it is a list environment.
+Usually the \Environment{verse} environment is not perceived as a list
+environment because you do not work with \Macro{item}
+commands. Instead, fixed line breaks are used within the
+\Environment{flushleft} environment. Yet internally in both the
+standard classes as well as {\KOMAScript} it is indeed a list
+environment.
In general the \Environment{verse} environment is used for
-poems\Index{poems}. Lines are indented both left and right. Single
-verses are ended by a fixed line break \verb|\\|. Verses are set as a
-paragraph, thus separated by an empty line. Often also
-\Macro{medskip}\IndexCmd{medskip} or \Macro{bigskip}\IndexCmd{bigskip}
-is used instead. To avoid a page break at the end of a line you insert
-\verb|\\*| instead of \verb|\\|.
+poems\Index{poems}. Lines are indented both left and
+right. Individual lines of verse are ended by a fixed line break
+\verb|\\|. Verses are set as paragraphs, separated by an empty
+line. Often also \Macro{medskip}\IndexCmd{medskip} or
+\Macro{bigskip}\IndexCmd{bigskip} is used instead. To avoid a page
+break at the end of a line of verse you as usual insert \verb|\\*|
+instead of \verb|\\|.
\begin{Example}
- As example the first lines of ``Little Red Riding Hood and the
- Wolf'' by Roald Dahl:
+ As an example, the first lines of ``Little Red Riding Hood and the
+ Wolf'' by Roald Dahl:
\begin{lstlisting}
\begin{verse}
As soon as Wolf began to feel\\*
@@ -3601,7 +3756,7 @@ is used instead. To avoid a page break at the end of a line you insert
And Wolfie said, 'May I come in?'
\end{verse}
\end{lstlisting}
- The result would like as follows:
+ The result is as follows:
\begin{ShowOutput}
\begin{verse}
As soon as Wolf began to feel\\*
@@ -3612,19 +3767,42 @@ is used instead. To avoid a page break at the end of a line you insert
And Wolfie said, 'May I come in?'
\end{verse}
\end{ShowOutput}
- Yet if you have very long lines \verb|\\*| can not prevent a page
- break within a verse. That would be possible here for example:
- \begin{ShowOutput}
+ However, if you have very long lines of verse, for instance:
+\begin{lstlisting}
\begin{verse}
- Both the philosoph and the house-owner\nopagebreak
- have always something to repair\\
+ Both the philosopher and the house-owner
+ have always something to repair.\\
\bigskip
- Don't trust a men, my son, who tells you\nopagebreak
- that he has never lain.
+ Don't trust a man, my son, who tells you
+ that he has never lied.
\end{verse}
- \end{ShowOutput}
+\end{lstlisting}
+where a line break occurs within a line of verse:
+\begin{ShowOutput}
+ \begin{verse}
+ Both the philosopher and the house-owner
+ have always something to repair.\\
+ \bigskip
+ Don't trust a man, my son, who tells you
+ that he has never lied.
+ \end{verse}
+\end{ShowOutput}
+there \verb|\\*| can not prevent a page break occurring within a verse
+at such a line break. To prevent such a page break, a
+\Macro{nopagebreak}\IndexCmd{nopagebreak} would have to be inserted
+somewhere in the first line:
+\begin{lstlisting}
+ \begin{verse}
+ Both the philosopher and the house-owner\nopagebreak
+ have always something to repair.\\
+ \bigskip
+ Don't trust a man, my son, who tells you\nopagebreak
+ that he has never lied.
+ \end{verse}
+\end{lstlisting}
- These two verses were separated by a \Macro{bigskip}.
+In the above example, \Macro{bigskip} was used to separate the lines
+of verse.
\end{Example}
%
\EndIndex{Env}{verse}%
@@ -3640,12 +3818,13 @@ These two environments are also list environments and can be found
both in the standard and the {\KOMAScript} classes. Both environments
use justified text which is indented both on the left and right side.
Usually they are used to separate long citations\Index{citations} from
-the main text. The difference between these two lies in the matter how
-paragraphs are typeset. While \Environment{quote} paragraphs are
+the main text. The difference between these two lies in the manner in
+which paragraphs are typeset. While \Environment{quote} paragraphs are
highlighted by vertical space, in \Environment{quotation} paragraphs
the first line is indented. This is also true for the first line of a
-\Environment{quotation} environment. To get around this behaviour you
-have to insert a \Macro{noindent} command\IndexCmd{noindent} in front.
+\Environment{quotation} environment. To prevent indentation you have
+to insert a \Macro{noindent} command\IndexCmd{noindent} before the
+text.
\begin{Example}
You want to highlight a short anecdote. You write the following
\Environment{quotation} environment for this:
@@ -3718,22 +3897,26 @@ have to insert a \Macro{noindent} command\IndexCmd{noindent} in front.
\Environment{addmargin*}\OParameter{inner indentation}\Parameter{indentation}
\end{Declaration}
\BeginIndex{Env}{addmargin}%
-Similar to \Environment{quote} and \Environment{quotation} the
+Similar to \Environment{quote} and \Environment{quotation}, the
\Environment{addmargin} environment changes the margin\Index{margin}.
-Different to the first two environments using \Environment{addmargin}
-the user can influence the width of the indentation. Furthermore this
-environment doesn't change the indentation of the first line and the
-vertical spacing between paragraphs.
+In contrast to the first two environments, with
+\Environment{addmargin} the user can set the width of the
+indentation. Besides this, this environment does not change the
+indentation of the first line nor the vertical spacing between
+paragraphs.
If only the obligatory argument \PName{indentation} is given, both the
left and right margin are expanded by this value. If the optional
-argument \PName{indentation} is given the value \PName{left
- indentation} is added to \PName{indentation} at the left margin.
+argument \PName{left indentation} is given as well, then at the left
+margin the value \PName{left indentation} is used instead of
+\PName{indentation}.
The starred \Environment{addmargin*} only differs from the normal
-version in a twoside layout. In addition the difference only occurs if
-the optional argument \PName{inner indentation} is used. In this case
-this value is added to the normal inner indentation. Then the value of
+version in a two-sided layout. Furthermore, the difference only occurs
+if the optional argument \PName{inner indentation} is used. In this
+case this value \PName{inner indentation} is added to the normal inner
+indentation. For right-hand pages this is the left margin, for
+left-hand pages the right margin. Then the value of
\PName{indentation} determines the width of the opposite margin.
Both versions of this environment take also negative values for all
@@ -3742,7 +3925,7 @@ margin.
\begin{Example}
Suppose you write a documentation which includes short source code
examples. To highlight these you want them separated from the text
- by a horizontal line and slightly spanning into the outer
+ by a horizontal line and shifted slightly into the outer
margin. First you define the environment:
\begin{lstlisting}
\newenvironment{SourceCodeFrame}{%
@@ -3781,48 +3964,52 @@ margin.
}
\end{lstlisting}
\end{SourceCodeFrame}
- This may be feasible or not. In any way it shows the usage of this
+ This may be feasible or not. In any case it shows the usage of this
environment.
\end{ShowOutput}
The optional argument of the \Environment{addmargin*} environment
makes sure that the inner margin is extended by 1\Unit{em}. In turn
the outer margin is decreased by 1\Unit{em}. The result is a shift
- by 1\Unit{em} to the outside. Instead of \PValue{1em} you can use a
- length of, for example, \PValue{2\Macro{parindent}} of course.
+ by 1\Unit{em} to the outside. Instead of \PValue{1em} you can of
+ course use a length, for example, \PValue{2\Macro{parindent}}.
\end{Example}
There is one problem with the \Environment{addmargin*} which you
should be aware of. If a page break occurs within an
-\Environment{addmargin*} environment the indentation on the following
-page is on the wrong side. This means that suddenly the \PName{inner
- indentation} is applied on the outside of the page. Therefore it is
-recommended to prevent page breaks within this environment. This can
-be achieved by using an additional \Macro{parbox} or, as in the
-example above, a \Environment{minipage}. This makes use of the fact
-that neither the argument of a \Macro{parbox} nor the content of a
-\Environment{minipage} is broken at the end of a page. Unfortunately
-this is not without disadvantages: In some cases pages can't be filled
-correctly which has the effect of several warnings.
-
-By the way, whether a page is going to be on the left or right side of the
-book can't be determined in the first \LaTeX\ compiling for sure. For details
-please refer to the explanation for the command \Macro{ifthispageodd} and
-\Macro{ifthispagewasodd} at \autoref{sec:maincls.pageStyle},
+\Environment{addmargin*} environment, the indentation on the following
+page will be on the wrong side. This means that suddenly the
+\PName{inner indentation} is applied on the outside of the
+page. Therefore it is recommended to prevent page breaks within this
+environment. This can be achieved by using an additional
+\Macro{parbox} or, as in the example above, a
+\Environment{minipage}. This makes use of the fact that neither the
+argument of a \Macro{parbox} nor the content of a
+\Environment{minipage} breaks at the end of a page. Unfortunately
+this is not without another disadvantage: in some cases pages can no
+longer be filled correctly, which has the effect of generating several
+warnings.
+
+Incidentally, whether a page is going to be on the left or right side
+of the book can not be determined for certain in the first {\LaTeX}
+run. For details please refer to the explanation of the commands
+\Macro{ifthispageodd} and \Macro{ifthispagewasodd} in
+\autoref{sec:maincls.pageStyle},
\autopageref{desc:maincls.macro.ifthispageodd}.
%
\EndIndex{Env}{addmargin}%
\begin{Explain}
- One concluding note to the list environments: In the internet and
- support it is often asked why such an environment is followed by a
- indented\Index{indentation} paragraph. In fact this is the result of
- demanding a new paragraph. In \LaTeX\ empty lines are interpreted as
- a new paragraph. This is also the case before and after list
- environments. Thus, if you want a list environment to be set within
- a paragraph you have to omit empty lines before and after. To
- separate this environment from the rest of your text nevertheless,
- you can insert a comment line which only consists of a percent
- character in the {\LaTeX} source.
+ One concluding remark on list environments: on the internet and
+ during support it is often asked why such an environment is followed
+ by a indented\Index{indentation} paragraph. In fact, this is not the
+ case but is the result of the user demanding a new paragraph. In
+ {\LaTeX} empty lines are interpreted as a new paragraph. This is
+ also the case before and after list environments. Thus, if you want
+ a list environment to be set within a paragraph you have to omit
+ empty lines before and after. To nevertheless separate the
+ environment from the rest of your text in the {\LaTeX} source file,
+ you can insert a comment line before and after, that is, lines which
+ begin with a percent character and contain nothing more.
\end{Explain}
\EndIndex[indexother]{}{lists}
@@ -3835,48 +4022,52 @@ please refer to the explanation for the command \Macro{ifthispageodd} and
\end{Declaration}%
\BeginIndex{Cmd}{marginpar}%
\BeginIndex{Cmd}{marginline}%
-Usually margin notes\Index[indexmain]{margin notes} in {\LaTeX} are
+Usually margin notes\Index[indexmain]{margin>notes} in {\LaTeX} are
inserted with the command \Macro{marginpar}. They are placed in the
-outer margin. In documents with oneside layout the right border is
-used. Though \Macro{marginpar} optionally can take a different margin
-note in case the output is on the left margin, margin notes are always
-in justified layout. But many users prefer left- or right-aligned
-margin notes instead. {\KOMAScript} offers the command
-\Macro{marginline} for that.
+outer margin. In documents with one-sided layout the right border is
+used. Though \Macro{marginpar} can take an optional different margin
+note argument in case the output is in the left margin, margin notes
+are always set in justified layout. However, experience has shown
+that many users prefer left- or right-aligned margin notes instead.
+To facilitate this, {\KOMAScript} offers the command
+\Macro{marginline}.
\begin{Example}
- At several places in this documentation you find the classes mentioned
- written in the margin. This can be produced\footnote{In fact, instead
- of \Macro{texttt}, a semantic highlighting was used. To avoid confusion
- this was replaced in the example.} with:
+ In the introduction, the class name \Class{scrartcl} can be found in
+ the margin. This can be produced\footnote{In fact, instead of
+ \Macro{texttt}, a semantic highlighting was used. To avoid
+ confusion this was replaced in the example.} with:
\begin{lstlisting}
\marginline{\texttt{scrartcl}}
\end{lstlisting}
- Instead of \Macro{marginline} you could have used \Macro{marginpar}
- too. In fact the first command is implemented internally as:
+Instead of \Macro{marginline} you could have used
+\Macro{marginpar}. In fact the first command is implemented internally
+as:
\begin{lstlisting}
\marginpar[\raggedleft\texttt{scrartcl}]
{\raggedright\texttt{scrartcl}}
\end{lstlisting}
- Eventually \Macro{marginline} is only an abbreviating writing of the
- code above.
+Thus \Macro{marginline} is really only an abbreviated writing of the
+code above.
\end{Example}
%
\begin{Explain}
- Unfortunately \Macro{marginpar} doesn't always work correctly in the
- twoside\Index{twoside} layout. Whether a margin note is going to show
- up on the left or right is already decided while evaluating the command
- \Macro{marginpar}. If the output routine now shifts the margin note
- onto the next page the alignment isn't correct anymore. This behaviour
- is deeply founded within {\LaTeX} and was therefore declared a feature
- by the \LaTeX3 team. \Macro{marginline} suffers from this ``feature''
- too. The package \Package{mparhack}\IndexPackage{mparhack} (see
- \cite{package:mparhack}) would be a solution for this problem with both
- \Macro{marginpar} and \Macro{marginline}.
-
- Note that you may not use \Macro{marginpar} or \Macro{marginnote} within
- float environemnts like tables or figures. And you may not use these
- commands at displayed math.
+ Unfortunately \Macro{marginpar} does not always work correctly in
+ two-sided\Index{twoside} layout. Whether a margin note will end up
+ in the left or right margin is already decided while evaluating the
+ command \Macro{marginpar}. If the output routine now shifts the
+ margin note onto the next page the formatting is no longer
+ correct. This behaviour is deeply rooted within {\LaTeX} and was
+ therefore declared a feature by the {\LaTeX}3 team. \Macro{marginline}
+ suffers from this ``feature'' too. The package
+ \Package{mparhack}\IndexPackage{mparhack} (see
+ \cite{package:mparhack}) offers a standard solution for this problem
+ which naturally benefits also \Macro{marginpar} and
+ \Macro{marginline}.
+
+ Note that you may not use \Macro{marginpar} or \Macro{marginline}
+ within float environments such as tables or figures. Also, these
+ commands will not function in displayed math formulas.
\end{Explain}
%
\EndIndex{Cmd}{marginpar}%
@@ -3889,40 +4080,28 @@ margin notes instead. {\KOMAScript} offers the command
\begin{Explain}
With the floating environments {\LaTeX} offers a very capable and
comfortable mechanism for automatic placement of
- figures\Index{figures} and tables\Index{tables}. But often these
+ figures\Index{figure} and tables\Index{table}. But often these
floating environments\Index[indexmain] {floating environments} are
slightly misunderstood by beginners. They often ask for a fixed
- position of a table or figure within the text. As these floating
- environments are being referenced in the text this is not necessary
- in most cases. It is not sensible too because such an object can
- only be set on the page if there is enough space left. If this is
- not the case the object would have to be shifted onto the next page
- leaving a huge space on the page before.
+ position of a table or figure within the text. However, since these
+ floating environments are being referenced in the text this is not
+ necessary in most cases. It is also not sensible because such an
+ object can only be set on the page if there is enough space left for
+ it. If this is not the case the object would have to be shifted onto
+ the next page, thereby possibly leaving a huge blank space on the
+ page before.
- % TODO: Translate this:
-% Haeufig werden die Fliessumgebungen\Index[indexmain]%
-% {Fliessumgebung=Fliessumgebung} von Anfaengern nicht richtig
-% verstanden. So wird oft die Forderung aufgestellt, eine Tabelle oder
-% Abbildung genau an einer bestimmten Position im Text zu setzen. Dies
-% ist jedoch nicht erforderlich, da auf Fliessumgebungen im Text ueber
-% eine Referenz verwiesen wird. Es ist auch nicht sinnvoll, da ein
-% solches Objekt an einer Stelle nur dann gesetzt werden kann, wenn
-% auf der Seite noch genuegend Platz fuer das Objekt vorhanden ist. Ist
-% dies nicht der Fall, muesste das Objekt auf die naechste Seite
-% umbrochen werden und auf der aktuellen Seite wuerde ein
-% moeglicherweise sehr grosser leerer Raum bleiben.
-
- Often in many documents the same optional argument for positioning
- an object is found with every floating object. This also makes no
- sense. In such cases you should change the standard parameters
+ Often one finds in a document for every floating object the same
+ optional argument for positioning the object. This also makes no
+ sense. In such cases one should rather change the standard parameter
globally. For more details refer to \cite{DANTE:FAQ}.\par
\end{Explain}
-One last important note before starting this section: The most
-mechanisms described here which extend the capabilities of the
-standard classes do not work correctly when used together with
-packages which interfere with the typesetting of captions of figures
-and tables. This should be without saying but is often neglected.
+One last important note before starting this section: most mechanisms
+described here which extend the capabilities of the standard classes
+no longer work correctly when used together with packages which modify
+the typesetting of captions of figures and tables. This should be self
+evident, but it is often not understood.
\begin{Declaration}
\Macro{caption}\OParameter{entry}\Parameter{title}\\
@@ -3932,29 +4111,29 @@ and tables. This should be without saying but is often neglected.
\BeginIndex{Cmd}{caption}%
\BeginIndex{Cmd}{captionabove}%
\BeginIndex{Cmd}{captionbelow}%
-In the standard classes captions of tables and figures are inserted
-with the \Macro{caption} command below the table or figure. In general
-this is correct with figures. Opinions differ as to whether captions
-of tables are to be placed above or together with captions of
-figures\Index{captions of figures} below the table\Index{captions of
- tables}. That's the reason why \KOMAScript{}, unlike the standard
-classes, offers \Macro{captionbelow} for captions below and
-\Macro{captionabove} for captions above tables or figures. Using
-\Macro{caption} together with figures always produces captions below
-the figure whereas the behaviour of \Macro{captionbelow} can be
-modified using the options
+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
+to whether captions of tables are to be placed above or, consistent
+with captions of figures\Index{caption>of figure}, below the
+table\Index{caption>of table}. That is the reason why {\KOMAScript},
+unlike the standard classes, offers \Macro{captionbelow} for captions
+below and \Macro{captionabove} for captions above tables or
+figures. Using \Macro{caption} for figures always produces captions
+below the figure, whereas with tables the behaviour of \Macro{caption}
+can be modified using the options
\Option{tablecaptionabove}\IndexOption{tablecaptionabove} and
\Option{tablecaptionbelow}\IndexOption{tablecaptionbelow} (see
\autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.tablecaptionabove}). For compatibility
-reasons the default behaviour of \Macro{caption} together with tables
-is similar to \Macro{captionbelow}.
+\autopageref{desc:maincls.option.tablecaptionabove}). For
+compatibility reasons the default behaviour of \Macro{caption} used
+with tables is similar to \Macro{captionbelow}.
%
\begin{Example}
- Instead of using captions below the table you want to place your
- captions above it\Index{table caption}, because you have tables
- which span over more then one page. In the standard classes you
- could only write:
+ Instead of using captions below a table you want to place your
+ captions above it\Index{table>caption}, because you have tables
+ which span more then one page. In the standard classes you could
+ only write:
\begin{lstlisting}
\begin{table}
\caption{This is an example table}
@@ -3975,7 +4154,7 @@ is similar to \Macro{captionbelow}.
This & is & an & example.
\end{tabular}
\end{ShowOutput}
- Using \KOMAScript{} you write instead:
+ Using {\KOMAScript} you write instead:
\begin{lstlisting}
\begin{table}
\captionabove{This is just an example table}
@@ -3996,7 +4175,7 @@ is similar to \Macro{captionbelow}.
This & is & an & example.
\end{tabular}
\end{ShowOutput}
- Since you want all your tables typeset with captions above you could
+ Since you want all your tables typeset with captions above, you could
of course use the option \Option{tablecaptionabove} instead (see
\autoref{sec:maincls.formattingOptions},
\autopageref{desc:maincls.option.tablecaptionabove}). Then you can use
@@ -4006,35 +4185,39 @@ is similar to \Macro{captionbelow}.
\begin{Explain}
Some would argue that you could achieve the same result using the
- \Macro{topcaption} from the \Package{topcapt}
- package\IndexPackage{topcapt} (see \cite{package:topcapt}). But that
- is not the case. The command \Macro{topcaption} is neglected by
+ \Macro{topcaption} command from the \Package{topcapt}
+ package\IndexPackage{topcapt} (see \cite{package:topcapt}). However,
+ that is not the case. The command \Macro{topcaption} is ignored by
packages which directly redefine the \Macro{caption} macro. The
- \Package{hyperref} package (see \cite{package:hyperref}) is one example
- for this. In \KOMAScript{} \Macro{captionabove} and
- \Macro{captionbelow} are implemented so, that the changes have an
- effect on both of these commands.
+ \Package{hyperref} package (see \cite{package:hyperref}) is one such
+ example. In {\KOMAScript}, \Macro{captionabove} and
+ \Macro{captionbelow} are so implemented that changes have an effect
+ on both of these commands as well.
- If the \Package{longtable} package\IndexPackage{longtable} is used
- \KOMAScript{} makes sure that captions above tables which are placed within
- a \Environment{longtable} environment have the same appearance as in a
- normal \Environment{table} environment. This also means that you can apply
- the same settings as in a \Environment{table} environment. Please note that
- in the \Package{longtable} package the maximum width of a table caption can
+ If the \Package{longtable} package\IndexPackage{longtable} is used,
+ {\KOMAScript} ensures that captions above tables which are placed
+ within a \Environment{longtable} environment have the same
+ appearance as those in a normal \Environment{table}
+ environment. This also means that you can apply the same settings as
+ in a \Environment{table} environment. Please note that in the
+ \Package{longtable} package the maximum width of a table caption can
be limited and the default is set to 4\Unit{in} (see
- \cite{package:longtable}). Using \KOMAScript{} this mechanism in
- \Package{longtable} only works when the class option \Option{origlongtable}
- is set (see \autoref{sec:maincls.formattingOptions},
- \autopageref{desc:maincls.option.origlongtable}). If
- \Package{caption2}\IndexPackage{caption2} (see \cite{package:caption}) is
- loaded, table captions are handled by this package.
+ \cite{package:longtable}). Used together with {\KOMAScript} this
+ mechanism in \Package{longtable} works only if the class option
+ \Option{origlongtable} is set (see
+ \autoref{sec:maincls.formattingOptions},
+ \autopageref{desc:maincls.caption.origlongtable}). If the
+ \Package{caption2}\IndexPackage{caption2} or
+ \Package{caption}\IndexPackage{caption} package (see
+ \cite{package:caption}) is loaded, table captions are handled by
+ this package.
- Please note that \Macro{captionabove} and \Macro{captionbelow} if placed
- within a \Environment{float} environment which was defined using the
- \Package{float}\IndexPackage{float} package have the same behaviour as
- described in \cite{package:float} for the \Macro{caption} command. In this
- case, only the float style determines whether it is a caption below or above
- the figure or table.
+ Please note that \Macro{captionabove} and \Macro{captionbelow}, if
+ placed within a \Environment{float} environment which was defined
+ using the \Package{float}\IndexPackage{float} package, have the
+ exact same behaviour described in \cite{package:float} for the
+ \Macro{caption} command. In this case, the float style determines
+ whether the caption will be set below or above the figure or table.
\end{Explain}
@@ -4049,51 +4232,51 @@ is similar to \Macro{captionbelow}.
\BeginIndex{Env}{captionbeside}%
Apart\ChangedAt{v2.8q}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} from
-captions above and below the figure you often find captions, in
+captions above and below the figure, one often finds captions, in
particular with small figures, which are placed beside the figure. In
-general in this case both the baseline of the figure and the caption
-are aligned at the bottom. With some fiddling and the use of two
-\Macro{parbox} commands this could be achieved in the standard
-classes. But \KOMAScript{} offers a special environment for this
-problem. This environment can be used within the floating environment.
-The first optional parameter \PName{entry} and the obligatory
-parameter \PName{title} are similar to the parameters of
+general in this case both the baseline of the figure and of the
+caption are aligned at the bottom. With some fiddling and the use of
+two \Macro{parbox} commands this could also be achieved in the
+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
-\PName{title} is placed beside the content of the environment in this
-case.
+caption text \PName{title} is placed beside the content of the
+environment in this case.
-Whether the \PName{title} is placed left or right can be determined by
-the parameter \PName{placement}. One of the following letters is
-accepted:
+Whether the caption text \PName{title} is placed on the left or the
+right can be determined by the parameter \PName{placement}. Exactly
+one of the following letters is allowed:
\begin{labeling}[--~]{\PValue[o]}
\item[\PValue{l}] left
\item[\PValue{r}] right
-\item[\PValue{i}] inner margin in twoside layout
-\item[\PValue{o}] outer margin in twoside layout
+\item[\PValue{i}] inner margin in two-sided layout
+\item[\PValue{o}] outer margin in two-sided layout
\end{labeling}
-Default setting is at the right side of the content of the
-environment. If either \PValue{o} or \PValue{i} are used you have to
-run {\LaTeX} twice to get the correct placement.
-
-As default the content of the environment and the \PName{title} fill
-the whole available text width. However, using the optional parameter
-\PName{width} it is possible to adjust the used width. This width
-could even be more than the current text width.
-
-When supplying a \PName{width} the used width is centered with respect
-to the text width. Using the optional parameter \PName{offset} you can
-shift the environment relative to the left margin. A positive value
-corresponds to a shift to the right whereas a negative value
-corresponds to a shift to the left. An \PName{offset} of 0\Unit{pt}
-gives you a left-aligned output.
-
-Adding a star to the optional parameter \PName{offset} the value means
-a shift relative to the right margin on left pages in double sided
-layout. A positive value corresponds to a shift towards the outer
-margin whereas a negative value corresponds to a shift towards the
-inner margin. An \PName{offset} of 0\Unit{pt} means alignment with the
-inner margin. As mentioned before, in some cases it takes two \LaTeX{}
-runs for this to work correctly.
+Default setting is to the right of the content of the environment. If
+either \PValue{o} or \PValue{i} are used you may need to run {\LaTeX}
+twice to obtain the correct placement.
+
+Per default the content of the environment and the caption text
+\PName{title} fill the entire available text width. However, using the
+optional parameter \PName{width}, it is possible to adjust the width
+used. This width could even be larger than the current text width.
+
+When supplying a \PName{width} the used width is usually centered with
+respect to the text width. Using the optional parameter
+\PName{offset}, you can shift the environment relative to the left
+margin. A positive value corresponds to a shift to the right, whereas
+a negative value corresponds to a shift to the left. An \PName{offset}
+of 0\Unit{pt} gives you a left-aligned output.
+
+Adding a star to the optional parameter \PName{offset} makes the the
+value mean a shift relative to the right margin on left hand pages in
+two-sided layout. A positive value corresponds to a shift towards the
+outer margin, whereas a negative value corresponds to a shift towards
+the inner margin. An \PName{offset} of 0\Unit{pt} means alignment with
+the inner margin. As mentioned before, in some cases it takes two
+{\LaTeX} runs for this to work correctly.
\begin{Example}
An example for the usage of the \Environment{captionbeside} environment
@@ -4121,30 +4304,30 @@ runs for this to work correctly.
\end{captionbeside}
\label{fig:maincls.captionbeside}
\end{figure}
- Thus, the width is the current available width
+ The total width is thus the currently available width
\PValue{\Macro{linewidth}}. However, this width is shifted
- \PValue{2em} to the outside. The title or the description is placed
- inside beside the figure. Therefore, the figure itself is shifted
- 2\Unit{em} into the margin.
+ \PValue{2em} to the outside. The caption text or description is
+ placed on the inner side beside the figure. The figure itself is
+ shifted 2\Unit{em} into the outer margin.
\end{Example}
%
\EndIndex{Env}{captionbeside}
-\BeginIndex[indexother]{}{font style}
+\BeginIndex[indexother]{}{font>style}
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 mentioned in
-\autoref{sec:maincls.font}. The respective elements for this are
-\FontElement{caption}\IndexFontElement{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
+described in \autoref{sec:maincls.font}. The respective elements for
+this are \FontElement{caption}\IndexFontElement{caption} and
\FontElement{captionlabel}\IndexFontElement{captionlabel} (see
\autoref{tab:maincls.elementsWithoutText},
-\autopageref{tab:maincls.elementsWithoutText}). First the font style for the
-element \FontElement{caption} is applied on the element
+\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}.
+\FontElement{captionlabel} is applied on the respective element. The
+default settings are listed in \autoref{tab:maincls.captionFont}.
%
\begin{table}
\centering%
@@ -4175,7 +4358,7 @@ settings are listed in \autoref{tab:maincls.captionFont}.
As you can see, simple extensions of the default definitions are
possible.
\end{Example}
-\EndIndex[indexother]{}{font style}
+\EndIndex[indexother]{}{font>style}
%
\EndIndex{Cmd}{caption}%
\EndIndex{Cmd}{captionabove}%
@@ -4189,19 +4372,22 @@ settings are listed in \autoref{tab:maincls.captionFont}.
\end{Declaration}%
\BeginIndex{Floatstyle}{komaabove}%
\BeginIndex{Floatstyle}{komabelow}%
-Using\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 the fact whether captions above or below are used. In the
-\Package{float} package there is no predefined style which gives you the same
-output and offers the same setting options (see below) as \KOMAScript{}.
-Therefore \KOMAScript{} defines the two additional styles \PValue{komaabove}
-and \PValue{komabelow}. When using the \Package{float} package both these
-styles can be activated as the styles \PValue{plain}\IndexFloatstyle{plain},
-\PValue{boxed}\IndexFloatstyle{boxed} or \PValue{ruled}\IndexFloatstyle{ruled}
-in \Package{float} are defined. 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
-float content.
+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 the
+\Package{float} package there is no predefined style which gives you
+the same output and offers the same setting options (see below) as
+{\KOMAScript}. Therefore {\KOMAScript} defines the two additional
+styles \PValue{komaabove} 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 float
+content.
%
\EndIndex{Floatstyle}{komaabove}%
\EndIndex{Floatstyle}{komabelow}%
@@ -4213,11 +4399,11 @@ float content.
\end{Declaration}%
\BeginIndex{Cmd}{captionformat}%
In {\KOMAScript} there are different ways to change the formatting of
-the description. The definition of different font styles was already
+the caption text. The definition of different font styles was already
explained above. This or the caption delimiter between the label and
the label text itself is specified in the macro \Macro{captionformat}.
-In difference to all other \Macro{\dots}format commands in this case
-it doesn't contain the counter but the items which follow it. The
+In contrast to all other \Macro{\dots}format commands, in this case it
+does not contain the counter but only the items which follow it. The
original definition is:
\begin{lstlisting}
\newcommand*{\captionformat}{:\ }
@@ -4230,7 +4416,7 @@ This too can be changed with \Macro{renewcommand}.
\begin{lstlisting}
\renewcommand*{\captionformat}{~--~}
\end{lstlisting}
- This definition you should put in the preamble of your document.
+This definition should be put in the preamble of your document.
\end{Example}
%
\EndIndex{Cmd}{captionformat}%
@@ -4242,13 +4428,14 @@ This too can be changed with \Macro{renewcommand}.
\end{Declaration}%
\BeginIndex{Cmd}{figureformat}%
\BeginIndex{Cmd}{tableformat}%
-It was already mentioned that \Macro{captionformat} doesn't contain a
-formatting for the label itself. But this label shouldn't in any case
-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, for
-example, of the list of figures. For this case {\KOMAScript} offers
-two \Macro{\dots format} commands instead. These are predefined as
+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:
\begin{lstlisting}
\newcommand*{\figureformat}{\figurename~\thefigure\autodot}
@@ -4257,14 +4444,18 @@ follows:
They also can be adapted to your personal preferences with
\Macro{renewcommand}.
\begin{Example}
- From time to time label texts without any label and delimiter are
- wanted. In {\KOMAScript} it takes only the following definitions to
- achieve this:
+ From time to time captions without any label and of course without
+ delimiter are desired. In {\KOMAScript} it takes only the following
+ definitions to achieve this:
\begin{lstlisting}
\renewcommand*{\figureformat}{}
\renewcommand*{\tableformat}{}
\renewcommand*{\captionformat}{}
\end{lstlisting}
+It should be noted, however, that although no numbering is output, the
+internal counters are nevertheless incremented. This becomes important
+especially if this redefinition is applied only to selected
+\Environment{figure} or \Environment{table} environments.
\end{Example}
%
\EndIndex{Cmd}{figureformat}%
@@ -4279,48 +4470,56 @@ They also can be adapted to your personal preferences with
\BeginIndex{Cmd}{setcapindent*}%
\BeginIndex{Cmd}{setcaphanging}%
As mentioned previously, in the standard classes the captions are set
-in a not-hanging style. That means that in descriptions with more than
-one line the second and subsequent lines start directly beneath the
-label. There is no straight way in the standard classes to change
-this behaviour. In {\KOMAScript}, on the contrary, beginning at the
-second line all lines are indented by the width of the label.
-
-This behaviour which corresponds to the usage of \Macro{setcaphanging}
-can easily be changed by using the command \Macro{setcapindent} or
-\Macro{setcapindent*}. Here the parameter \PName{Einzug} determines
-the indentation of the second and subsequent lines.
-
-If you want a line break before the label and the description you
-define the indentation \PName{xindent} of the description with the
-starred version of the command instead: \Macro{setcapindent*}.
-
-Using a negative value of \PName{indent} instead, a page break is
-inserted and only the first line but not the subsequent lines are
-indented by \(-\PName{indent}\).
+in a non-hanging style, that is, in multi-line captions the second and
+subsequent lines start directly beneath the label. The standard
+classes provide no direct mechanism to change this behaviour. In
+{\KOMAScript}, on the contrary, beginning at the second line all lines
+are indented by the width of the label so that the caption text is
+aligned.
+
+This behaviour, which corresponds to the usage of
+\Macro{setcaphanging}, can easily be changed by using the command
+\Macro{setcapindent} or \Macro{setcapindent*}. Here the parameter
+\PName{indent} determines the indentation of the second and subsequent
+lines.
+
+If you want a line break after the label and before the caption text,
+then you can define the indentation \PName{xindent} of the caption
+text with the starred version of the command instead:
+\Macro{setcapindent*}.
+
+Using a negative value of \PName{indent} instead, a line break is also
+inserted before the caption text and only the first line of the
+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 class options
\Option{onelinecaption} and \Option{noonelinecaption}. For details
-please refer to the explanations of this options in
+please refer to the explanations of these options in
\autoref{sec:maincls.layoutOptions},
\autopageref{desc:maincls.option.noonelinecaption}.
\begin{Example}
- As examples please refer to the
+ 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
- complete hanging indentation is not preferable together with a small
- column width:
+ \ref{fig:maincls.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:
\begin{lstlisting}
\begin{figure}
\setcapindent{1em}
\fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}}
- \caption{Examples with slightly indented caption
+ \caption{Example with slightly indented caption
starting at the second line}
\end{figure}
\end{lstlisting}
- As can be seen the formatting can also be changed locally within the
- \Environment{figure} environment\IndexEnv{figure}.
+As can be seen the formatting can also be changed locally within the
+\Environment{figure} environment\IndexEnv{figure}. The change then
+affects only the current figure. Following figures once again use the
+default settings or global settings set, for example, in the preamble
+of the document. This also of course applies to tables.
\begin{figure}
\typeout{^^J--- Ignore underfull and overfull \string\hbox:}
\addtokomafont{caption}{\small}
@@ -4385,101 +4584,103 @@ please refer to the explanations of this options in
\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 label
-text. In general the whole text or column width is available for the
-description.
+commands you can specify the width and justification of the caption
+text. In general the whole text width or column width is available
+for the caption.
With the command \Macro{setcapwidth} you can decrease this
-\PName{width}. The obligatory argument determines the \PName{with} of
-the description. As an optional argument you can supply one letter
-which specifies the horizontal justification. The possible
-justifications are given in the following list.
+\PName{width}. The obligatory argument determines the maximum
+\PName{width} of the caption. As an optional argument you can supply
+exactly one letter which specifies the horizontal justification. The
+possible justifications are given in the following list.
\begin{labeling}[--~]{\PValue[o]}
\item[\PValue{l}] left-aligned
\item[\PValue{c}] centered
\item[\PValue{r}] right-aligned
-\item[\PValue{i}] alignment at the inner margin in a double sided output
-\item[\PValue{o}] alignment at the outer margin in a double sided output
+\item[\PValue{i}] alignment at the inner margin in double-sided output
+\item[\PValue{o}] alignment at the outer margin in double-sided output
\end{labeling}
The justification inside and outside corresponds to left-aligned and
-right-aligned respectively in single sided output. Within
+right-aligned, respectively, in single-sided output. Within
\Package{longtable}\IndexPackage{longtable} tables the justification
-inside or outside doesn't work correctly. In particular the captions
-of tables of subsequent pages are aligned corresponding to the first
-part of the table. This is a problem which has its roots in the
-implementation of \Package{longtable}.
+inside or outside does not work correctly. In particular, the captions
+on subsequent pages of such tables are aligned according to the format
+of the caption on the first page of the table. This is a conceptual
+problem in the implementation of \Package{longtable}.
With the command \Macro{setcapmargin} you can specify a \PName{margin}
which is to be left free next to the description in addition to the
normal text margin. If you want margins with different widths at the
left and right side you can specify these using the optional argument
\PName{margin left}. The starred version \Macro{setcapmargin*} defines
-instead of a \PName{margin left} a \PName{margin inside} in a double
-sided layout. In case of \Package{longtable}\IndexPackage{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 the option \Option{noonelinecaption} (see
+instead of a \PName{margin left} a \PName{margin inside} in a
+double-sided layout. In case of
+\Package{longtable}\IndexPackage{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 \Option{noonelinecaption} (see
\autoref{sec:maincls.layoutOptions},
-\autopageref{desc:maincls.option.noonelinecaption}) for the descriptions which
-are typeset with this margin setting.
+\autopageref{desc:maincls.option.noonelinecaption}) for the captions
+which are typeset with this margin setting.
\begin{Explain}
- \Package{longtable} places the description in a box, which is issued
- again at the subsequent pages if needed. While treating a box the
- macros needed for the creation of it aren't run through
- again. That's why it is not possible for \KOMAScript{} to swop
- margin settings in double sided layout on even pages. This would be
- necessary to produce a justification which is shifted towards the
- outside or inside.
+ \Package{longtable} places the caption in a box, which is issued
+ again on subsequent pages as needed. When outputting a box, the
+ macros needed for its creation are not reevaluated. That is the
+ reason why it is not possible for {\KOMAScript} to swap margin
+ settings for even pages in double-sided layout . This is what would
+ be necessary in order to produce a justification which is shifted
+ towards the outside or inside.
You can also submit negative values for \PName{margin} and
- \PName{margin right} or \PName{margin outside}. This has the effect
- of the description spanning into the margin.
+ \PName{margin left} or \PName{margin inside}. This has the effect
+ of the caption expanding into the margin.
\end{Explain}
\begin{Example}
- A rather odd problem is a figure caption which is both centered and
- of the same width as the figure itself. If the width of the figure
- is known the solution with \KOMAScript{} is quite easy. Suppose the
- figure has a width of 8\Unit{cm}, it only takes:
+ A rather odd problem is that of a figure caption which is required
+ to be both centered and of the same width as the figure itself. If
+ the width of the figure is known in advance, the solution with
+ {\KOMAScript} is quite easy. Supposing the figure has a width of
+ 8\Unit{cm}, it only takes:
\begin{lstlisting}
\setcapwidth[c]{8cm}
\end{lstlisting}
- directly in front of \Macro{caption} or \Macro{captionbelow}. If it
- is unknown first you have to define a length in the preamble of your
- document:
+directly in front of \Macro{caption} or \Macro{captionbelow}. If the
+width is unknown then you first have to define a length in the
+preamble of your document:
\begin{lstlisting}
- \newlength{\Figurewidth}
+ \newlength{\FigureWidth}
\end{lstlisting}
Having done this you can calculate the width directly with the
- \LaTeX{} command \Macro{settowidth} (see \cite{latex:usrguide})
+ {\LaTeX} command \Macro{settowidth} (see \cite{latex:usrguide})
in many cases. A possible solution would look as follows:
\begin{lstlisting}
\begin{figure}
\centering%
- \settowidth{\Figurewidth}{%
- \fbox{\quad\KOMAScript\qaud}%
+ \settowidth{\FigureWidth}{%
+ \fbox{\quad\KOMAScript\quad}%
}%
\fbox{\quad\KOMAScript\quad}%
- \setcapwidth[c]{\Figurewidth}
+ \setcapwidth[c]{\FigureWidth}
\caption{Example of a centered caption below the figure}
\end{figure}
\end{lstlisting}
- However, it is awkward to write the content twice and to use
- \Macro{setcapwidth} with every figure. But nothing is easier than
- defining a new command in the preamble of your document which
- hides the three steps:
+However, it is awkward to write the content twice and to call
+\Macro{setcapwidth} for every figure. Yet nothing is easier than
+defining a new command in the preamble of your document which hides
+the three steps of:
\begin{enumerate}
- \item Defining the width of the argument
- \item Specifying the width of the caption
- \item Output of the argument
+ \item defining the width of the argument
+ \item specifying the width of the caption
+ \item outputting the argument
\end{enumerate}
in:
\begin{lstlisting}
\newcommand{\Figure}[1]{%
- \settowidth{\Figurewidth}{#1}%
- \setcapwidth[c]{\Figurewidth}%
+ \settowidth{\FigureWidth}{#1}%
+ \setcapwidth[c]{\FigureWidth}%
#1}
\end{lstlisting}
Using this command the example abbreviates to:
@@ -4491,24 +4692,24 @@ are typeset with this margin setting.
\end{figure}
\end{lstlisting}
- But a command has the disadvantage that errors in the macros of the
- argument in case of arguments with more than one line aren't
- reported with the very correct line number by \LaTeX{}. In these
- cases the usage of an environment has advantages. But then the
- question is raised how the width of the content of the environment
- can be determined. The solution offers the \Environment{lrbox}
- environment, which is described in \cite{latex:usrguide}:
+However, commands have the disadvantage that errors in the macros of
+the argument in case of arguments with more than one line are not
+reported with the very accurate line numbers by {\LaTeX}. Thus in some
+cases the use of an environment has advantages. Then, however, the
+question arises of how the width of the content of the environment can
+be determined. The solution involves the \Environment{lrbox}
+environment, described in \cite{latex:usrguide}:
\begin{lstlisting}
- \newsavebox{\Figurebox}
+ \newsavebox{\FigureBox}
\newenvironment{FigureDefinesCaptionWidth}{%
- \begin{lrbox}{\Figurebox}%
+ \begin{lrbox}{\FigureBox}%
}{%
\end{lrbox}%
- \global\setbox\Figurebox=\box\Figurebox%
- \aftergroup\Setfigurebox%
+ \global\setbox\FigureBox=\box\FigureBox%
+ \aftergroup\SetFigureBox%
}
- \newcommand{\Setfigurebox}{%
- \Figure{\usebox{\Figurebox}}}
+ \newcommand{\SetFigureBox}{%
+ \Figure{\usebox{\FigureBox}}}
\end{lstlisting}
This definition uses the macro \Macro{Figure} defined above. In
the main text you write:
@@ -4521,19 +4722,20 @@ are typeset with this margin setting.
\caption{Example of a centered caption below the figure}
\end{figure}
\end{lstlisting}
- Admittingly, the environment in this example is not necessary. But
- its definition using \Macro{global} is quite clever. Most users
- wouldn't be able to define such an environment without help. But as
- this can be very useful, it was introduced in the example above.
+Admittedly, the environment in this example is not necessary. However,
+its definition using \Macro{global} is quite tricky. Most users would
+probably not be able to define such an environment without help. Thus,
+as this definition can be very useful, it was introduced in the above
+example.
- If the \Environment{captionbeside} environment wouldn't exist you
- could nevertheless place the figure caption beside the figure in a
- quite simple way. For this \Macro{Setfigurebox} from the example
- above would have to be redefined first:
+Even if the \Environment{captionbeside} environment did not exist you
+could nevertheless place the figure caption beside the figure in a
+quite simple way. For this \Macro{SetFigureBox} from the example above
+would have to be redefined first:
\begin{lstlisting}
- \renewcommand{\Setfigurebox}{%
- \settowidth{\captionwidth}{\usebox{\Figurebox}}%
- \parbox[b]{\captionwidth}{\usebox{\Figurebox}}%
+ \renewcommand{\SetFigureBox}{%
+ \settowidth{\captionwidth}{\usebox{\FigureBox}}%
+ \parbox[b]{\captionwidth}{\usebox{\FigureBox}}%
\hfill%
\addtolength{\captionwidth}{1em}%
\addtolength{\captionwidth}{-\hsize}%
@@ -4541,8 +4743,8 @@ are typeset with this margin setting.
\setcapwidth[c]{\captionwidth}%
}
\end{lstlisting}
- As the next step you only have to put the \Macro{caption} command in
- a \Macro{parbox} too:
+Finally you only have to put the \Macro{caption} command in a
+\Macro{parbox} too:
\begin{lstlisting}
\begin{figure}
\centering%
@@ -4550,14 +4752,14 @@ are typeset with this margin setting.
\fbox{\rule{0pt}{5\baselineskip}%
\hspace{1em}\KOMAScript\hspace{1em}}
\end{FigureSetsCaptionWidth}
- \parbox[b]{\Figurewidth}{%
+ \parbox[b]{\FigureWidth}{%
\caption{Example of a centered caption
below the figure}
}
\end{figure}
\end{lstlisting}
- The \Macro{rule} command in this example only serves as an unvisible
- support to produce an example figure with a greater vertical height.
+The \Macro{rule} command in this example only serves as an invisible
+support to produce an example figure with a greater vertical height.
\end{Example}
%
\EndIndex{Cmd}{setcapwidth}%
@@ -4569,14 +4771,14 @@ are typeset with this margin setting.
\label{sec:maincls.emphasis}
\begin{Explain}
- \LaTeX{} offers different possibilities for logical
- markup\Index{logical markup}\Index{markup} of text. In a sense, a
- heading is a kind of markup too. However, in this section we are
- only concerned with direct markup, i.e. markup which doesn't have an
- additional meaning and which can be used for different
- purposes. More details to the normally defined possibilities you can
- find in \cite{lshort}, \cite{latex:usrguide} and
- \cite{latex:fntguide}.
+ {\LaTeX} offers different possibilities for logical
+ markup\Index{logical markup}\Index{markup} of text. Strictly
+ speaking, a heading is a kind of markup too. However, in this
+ section we are only concerned with direct markup, i.\,e., markup which
+ does not have an additional semantic meaning and which can be used
+ for different purposes. More details on the normally defined
+ possibilities can be found in \cite{lshort}, \cite{latex:usrguide}
+ and \cite{latex:fntguide}.
\end{Explain}
\begin{Declaration}
@@ -4584,59 +4786,58 @@ are typeset with this margin setting.
\end{Declaration}
\BeginIndex{Cmd}{textsubscript}%
In \autoref{sec:maincls.footnotes},
-\autopageref{desc:maincls.macro.textsuperscript} the command
+\autopageref{desc:maincls.macro.textsuperscript}, the command
\Macro{textsuperscript}\IndexCmd{textsuperscript} was already
-introduced which is a part of the \LaTeX{} kernel. Unfortunately
-\LaTeX{} itself doesn't offer a command to produce a text in
-subscript\Index{text, subscript}\Index{subscript} instead of
-superscript\Index{text, superscript}\Index{superscript}. \KOMAScript{}
-defines \Macro{textsubscript} for this.
+introduced as an integral part of the {\LaTeX} kernel. Unfortunately,
+{\LaTeX} itself does not offer a command to produce text in
+subscript\Index{text>subscript}\Index{subscript} instead of
+superscript\Index{text>superscript}\Index{superscript}. {\KOMAScript}
+defines \Macro{textsubscript} for this purpose.
%
\begin{Example}
- You are writing a text on the human metabolism. From time to time
- you have to mention some simple sum formulas in which the
- numbers are in subscript. Being convinced from logical markup you
- first define in the document preamble or in a separate package:
+ You are writing a text on human metabolism. From time to time you
+ have to give some simple chemical formulas in which the numbers are
+ in subscript. For enabling logical markup you first define in the
+ document preamble or in a separate package:
\begin{lstlisting}
- \newcommand*{\Molek}[2]{#1\textsubscript{#2}}
+ \newcommand*{\molec}[2]{#1\textsubscript{#2}}
\end{lstlisting}
- \newcommand*{\Molek}[2]{#1\textsubscript{#2}}
+ \newcommand*{\molec}[2]{#1\textsubscript{#2}}
Using this you then write:
\begin{lstlisting}
- The cell produces its energy from reaction of
- \Molek C6\Molek H{12}\Molek O6 and \Molek O2 to
- \Molek H2\Molek O{} and \Molek C{}\Molek O2.
- However, Arsenic (\Molek{As}{}) has a detrimental
- effect on the metabolism.
+ The cell produces its energy partly from reaction of \molec C6\molec
+ H{12}\molec O6 and \molec O2 to produce \molec H2\Molec O{} and
+ \molec C{}\molec O2. However, arsenic (\molec{As}{}) has a quite
+ detrimental effect on the metabolism.
\end{lstlisting}
The output looks as follows:
\begin{ShowOutput}
- The cell produces its energy from reaction of \Molek C6\Molek
- H{12}\Molek O6 and \Molek O2 to \Molek H2\Molek O{} and \Molek
- C{}\Molek O2. However, Arsenic (\Molek{As}{}) has a detrimental
- effect on the metabolism.
+ The cell produces its energy from reaction of \molec C6\molec
+ H{12}\molec O6 and \molec O2 to produce \molec H2\molec O{} and
+ \molec C{}\molec O2. However, arsenic (\molec{As}{}) has a quite
+ detrimental effect on the metabolism.
\end{ShowOutput}
- Some time later you decide that the sum formulas should be
- typeset in sans serif. Now you can see the advantages of a
- consequent logical markup. You only have the redefine the
- \Macro{Molek} command:
+ Some time later you decide that the chemical formulas should be
+ typeset in sans serif. Now you can see the advantages of using
+ logical markup. You only have the redefine the \Macro{molec}
+ command:
\begin{lstlisting}
- \newcommand*{\Molek}[2]{\textsf{#1\textsubscript{#2}}}
+ \newcommand*{\molec}[2]{\textsf{#1\textsubscript{#2}}}
\end{lstlisting}
- \renewcommand*{\Molek}[2]{\textsf{#1\textsubscript{#2}}}
+ \renewcommand*{\molec}[2]{\textsf{#1\textsubscript{#2}}}
Now the output in the whole document changes to:
\begin{ShowOutput}
- The cell produces its energy from reaction of \Molek C6\Molek
- H{12}\Molek O6 and \Molek O2 to \Molek H2\Molek O{} and \Molek
- C{}\Molek O2. However, Arsenic (\Molek{As}{}) has a detrimental
- effect on the metabolism.
+ The cell produces its energy partly from reaction of \molec
+ C6\molec H{12}\molec O6 and \molec O2 to produce \molec H2\molec
+ O{} and \molec C{}\molec O2. However, arsenic (\molec{As}{}) has
+ a quite detrimental effect on the metabolism.
\end{ShowOutput}
\end{Example}
\begin{Explain}
- In the example above the writing ``\verb|\Molek C6|'' is used. This
- makes use of the fact that arguments which consist of only one
- character doesn't have to be enclosed in parenthesis. That's why
- ``\verb|\Molek C6|'' is similar to ``\verb|\Molek{C}{6}|''. You
+ In the example above, the notation ``\verb|\molec C6|'' is used. This
+ makes use of the fact that arguments consisting of only one
+ character do not have to be enclosed in parentheses. That is why
+ ``\verb|\molec C6|'' is similar to ``\verb|\molec{C}{6}|''. You
might already know this from indices or powers in mathematical
environments, such as ``\verb|$x^2$|'' instead of ``\verb|$x^{2}$|''
for ``$x^2$''.
@@ -4660,16 +4861,17 @@ necessary, the index\Index{index}.
\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 thus making sure
-that the rules according to \cite{DUDEN} are being followed. These
-rules are explained in more detail in the description of the class
-options \Option{pointednumbers} and \Option{pointlessnumbers} in
-\autoref{sec:maincls.formattingOptions},
+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 class options \Option{pointednumbers} and
+\Option{pointlessnumbers} in \autoref{sec:maincls.formattingOptions},
\autopageref{desc:maincls.option.pointlessnumbers}.
Please note that \Macro{appendix} is a command, \emph{not} an
-environment! This command does not need an argument. The disposition
-commands in the appendix are used in the same way as in the main part.
+environment! This command does not expect any argument. Sectioning in
+the appendix uses \Macro{chapter} and \Macro{section} just as does the
+main text.
%
\EndIndex{Cmd}{appendix}
@@ -4680,30 +4882,31 @@ commands in the appendix are used in the same way as in the main part.
\end{Declaration}%
\BeginIndex{Cmd}{appendixmore}%
There is a peculiarity within the \Macro{appendix} command in the
-{\KOMAScript} classes. In case the command \Macro{appendixmore} is
-defined, \Macro{appendix} is executed too. Internally the
-{\KOMAScript} classes \Class{scrbook} and \Class{scrreprt} take
-advantage of this behaviour for implementing the options
-\Option{appendixprefix} and \Option{noappendixprefix} (see
+{\KOMAScript} classes. If the command \Macro{appendixmore} is defined,
+this command is executed also by the \Macro{appendix}
+command. Internally the {\KOMAScript} classes \Class{scrbook} and
+\Class{scrreprt} take advantage of this behaviour to implement the
+options \Option{appendixprefix} and \Option{noappendixprefix} (see
\autoref{sec:maincls.layoutOptions},
-\autopageref{desc:maincls.option.appendixprefix}). You should take care of this
-in case you are going to define or redefine the \Macro{appendixmore}
-by yourself. In case one of these options is set, you will receive an
-error message when using
-\verb|\newcommand{\appendixmore}{|\dots\verb|}|. This is thought to
-prevent you from changing options without noticing.
+\autopageref{desc:maincls.option.appendixprefix}). You should take
+note of this in case you decide to define or redefine the
+\Macro{appendixmore}. In case one of these options is set, you will
+receive an error message when using
+\verb|\newcommand{\appendixmore}{|\dots\verb|}|. This behaviour is
+intended to prevent you from disabling options without noticing it.
\begin{Example}
You do not want the chapters in the main part of the classes
- \Class{scrbook} or \Class{scrreprt} to be introduced by a prefix line
- (see layout options \Option{chapterprefix} and \Option{nochapterprefix}
- in \autoref{sec:maincls.layoutOptions},
- \autopageref{desc:maincls.option.chapterprefix}). For being consistent you
- do not want such a line in the appendix either. Instead you would like
- to see the word "`Chapter"' in the language of your choice written in
- front of the chapter letter and, simultaneously, in the page headings.
- Instead of using the layout options \Option{appendixprefix} or
- \Option{noappendixprefix}, you would define in the document preamble:
+ \Class{scrbook} or \Class{scrreprt} to be introduced by a prefix
+ line (see layout options \Option{chapterprefix} and
+ \Option{nochapterprefix} in \autoref{sec:maincls.layoutOptions},
+ \autopageref{desc:maincls.option.chapterprefix}). For consistency
+ you also do not want such a line in the appendix either. Instead,
+ you would like to see the word ``Chapter'' in the language of your
+ choice written in front of the chapter letter and, simultaneously,
+ in the page headings. Instead of using the either layout option
+ \Option{appendixprefix} or \Option{noappendixprefix}, you would
+ define in the document preamble:
%
\begin{lstlisting}
\newcommand*{\appendixmore}{%
@@ -4714,12 +4917,11 @@ prevent you from changing options without noticing.
}
\end{lstlisting}
%
- In case you are going to change your mind and want to use the option
- \Option{appendixprefix} at a later state, you will get an error
- message because of the already defined \Macro{appendixmore} command.
- This prevents the definition mentioned above from changing the
- settings already set using \Option{chapterprefix} and
- \Option{nochapterprefix}.
+ In case you subsequently change your mind and decide to use the option
+ \Option{appendixprefix} at a later stage, you will get an error message
+ because of the already defined \Macro{appendixmore} command. This behaviour
+ prevents the definition made above from invisibly changing the settings
+ intended with the option.
It is also possible to get a similar behaviour of the appendix for
the class \Class{scrartcl}. You would write in the preamble of your
@@ -4733,12 +4935,13 @@ prevent you from changing options without noticing.
\appendixname~\thesection\autodot\enskip}
}
\end{lstlisting}
- In addition the package \Package{ifthen}\IndexPackage{ifthen} (see
+ In addition, the package \Package{ifthen}\IndexPackage{ifthen} (see
\cite{package:ifthen}) is required.
Redefined commands are explained in more detail in
- \autoref{sec:maincls.structure}, \autopageref{desc:maincls.macro.partformat}
- and \autopageref{desc:maincls.macro.chaptermark}.
+ \autoref{sec:maincls.structure},
+ \autopageref{desc:maincls.macro.chapterformat} and
+ \autopageref{desc:maincls.macro.chaptermarkformat}.
\end{Example}
%
\EndIndex{Cmd}{appendixmore}%
@@ -4748,37 +4951,32 @@ prevent you from changing options without noticing.
\Macro{setbibpreamble}\Parameter{preamble}
\end{Declaration}%
\BeginIndex{Cmd}{setbibpreamble}%
-The command \Macro{setbibpreamble} can be used for setting a preamble
-for the bibliography\Index{bibliography}. This can be achieved by
-placing the preamble before the command for issuing the bibliography.
-However, it doesn't have to be directly in front of it. For example it
-could be placed at the beginning of the document. Similar to the class
-options \Option{bibtotoc} and \Option{bibtotocnumbered} this command
-can only be successful if you haven't loaded a package which prevents
-this by redefining the \Environment{thebibliography} environment.
-Though the \Package{natbib} package \IndexPackage{natbib} unauthorized
-uses internal macros of {\KOMAScript} it could be made sure that
-\Macro{setbibpreamble} works with the current version of
-\Package{natbib} (see \cite{package:natbib}).
+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 does not have to be directly in front of it. For example,
+it could be placed at the beginning of the document. Similar to the
+class options \Option{bibtotoc} and \Option{bibtotocnumbered}, 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 occuring in the text but in
- alphabetical order. You use the following command:
+ bibliography is not according to their occurrence in the text, but
+ in alphabetical order. You use the following command:
\begin{lstlisting}
\setbibpreamble{References are in alphabetical order.
References with more than one author are sorted
- according to the first author.}
+ according to the first author.\par\bigskip}
\end{lstlisting}
The \Macro{bigskip}\IndexCmd{bigskip} command makes sure that the
- preamble and the first reference are separated by a big skip.
-
- Another usage of the preamble in the bibliography would be setting
- the references ragged right. Just put the preamble as follows:
-\begin{lstlisting}
- \setbibpreamble{\raggedright}
-\end{lstlisting}
- You can have a look at the result in the bibliography of this guide.
+ preamble and the first reference are separated by a large vertical
+ space.
\end{Example}
%
\EndIndex{Cmd}{setbibpreamble}
@@ -4788,29 +4986,30 @@ uses internal macros of {\KOMAScript} it could be made sure that
\Macro{setindexpreamble}\Parameter{preamble}
\end{Declaration}%
\BeginIndex{Cmd}{setindexpreamble}%
-Similar to the bibliography you can use a preamble in 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 numbers in
-different ways.
+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
+numbers in different ways.
\begin{Example}
- You have a document in which terms are both defined an used. The
+ You have a document in which terms are both defined and used. The
page numbers of definitions are in bold. Of course you want to make
- your reader aware of this fact. Thus you insert a preamble in the
+ your reader aware of this fact. Thus you insert a preamble for the
index:
\begin{lstlisting}
- \setindexpreamble{In \textbf{bold} printed page numbers
- are references to the definition of terms.\par\bigskip}
+ \setindexpreamble{In \textbf{bold} printed page numbers are
+ references to the definition of terms. Other page numbers indicate
+ the use of a term.\par\bigskip}
\end{lstlisting}
\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},
+\Macro{indexpagestyle} (see \autoref{sec:maincls.pageStyle},
\autopageref{desc:maincls.macro.titlepagestyle}).
The production, sorting and output of the index is done by the
-standard \LaTeX{} packages and additional programs. Similar to the
+standard {\LaTeX} packages and additional programs. Similar to the
standard classes {\KOMAScript} only provides the basic macros and
environments.
%
@@ -4821,22 +5020,24 @@ environments.
\label{sec:maincls.obsolete}
\begin{Explain}
- In this section you will find commands, which should not be used any
- more. They are part of older \KOMAScript{} versions. For compatibility
- reasons they can still be used in the new \KOMAScript{} release. There
- are new mechanisms and user interfaces however, which you should use
- instead. The reason for listing the obsolete macros in this
- documentation is to aid users with understanding old documents.
- Furthermore, package authors are free to use these macros in the future.
+ In this section you will find commands which should not be used any
+ longer. They are part of older {\KOMAScript} versions and their use
+ was documented. For compatibility reasons they can still be used in
+ the current {\KOMAScript} release. There are however new mechanisms
+ and user interfaces which you should use instead. The reason for
+ listing the obsolete macros in this documentation is only to aid
+ users in understanding old documents. Furthermore, package authors
+ are free to use these macros in the future.
\begin{Declaration}
\Macro{sectfont}
\end{Declaration}
\BeginIndex{Cmd}{sectfont}%
- This macro sets the font which is used for all section headings, the
- main title an the highest level below \Macro{part} in the table of
- contents. Use element \FontElement{disposition} instead, which is
- described in more detail in \autoref{sec:maincls.font}.%
+ This macro sets the font which is used for all section headings and
+ the abstract, the main title and the highest level below
+ \Macro{part} in the table of contents. Instead, use the commands for
+ the element \FontElement{disposition}, described in
+ \autoref{sec:maincls.font}.%
\EndIndex{Cmd}{sectfont}%
\begin{Declaration}
@@ -4848,9 +5049,9 @@ environments.
The macro \Macro{capfont} sets the font which is used for captions
in tables and figures. The macro \Macro{caplabelfont} sets the font
which is used for the label and numbering of tables and pictures.
- Please use element \FontElement{caption} and
- \FontElement{captionlabel} of the current \KOMAScript{} instead
- which are described in \autoref{sec:maincls.font}.%
+ Instead, use the commands for the elements \FontElement{caption} and
+ \FontElement{captionlabel}, described in
+ \autoref{sec:maincls.font}.%
\EndIndex{Cmd}{capfont}%
\EndIndex{Cmd}{caplabelfont}%
@@ -4858,15 +5059,16 @@ environments.
\Macro{descfont}
\end{Declaration}
\BeginIndex{Cmd}{descfont}%
- This macro sets the font for the optional item arguments of an
- \Environment{description} environment. Please use element
- \FontElement{descriptionlabel} instead, which are described in
- section ~\ref{sec:maincls.font}.%
+ This macro sets the font for the optional item arguments of a
+ \Environment{description} environment. Instead, use the commands for
+ the element \FontElement{descriptionlabel}, described in section
+ ~\ref{sec:maincls.font}.%
\EndIndex{Cmd}{descfont}%
\end{Explain}
%%% Local Variables:
%%% mode: latex
+%%% coding: iso-latin-1
%%% TeX-master: "../guide"
%%% End: