summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-11-12 00:44:32 +0000
committerKarl Berry <karl@freefriends.org>2008-11-12 00:44:32 +0000
commite0fa36719ae8b943d0c515ccc2a4f1e2670cc614 (patch)
treecfd7d451101897cf222cd885a36573ccacd922c4 /Master/texmf-dist/source/latex/koma-script/doc/english
parent6d06dddb5a2041f7c07b6502a3bfa973f0d86635 (diff)
koma-script update (11nov08)
git-svn-id: svn://tug.org/texlive/trunk@11262 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/Makefile4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex114
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup7
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex8
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex928
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex4
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex336
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex12
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex588
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex283
14 files changed, 1445 insertions, 855 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile b/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile
index 120a788930c..012e218e16b 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/Makefile
@@ -1,6 +1,6 @@
# ======================================================================
# Makefile
-# Copyright (c) Markus Kohm, 2002-2007
+# Copyright (c) Markus Kohm, 2002-2008
#
# This file is part of the LaTeX2e KOMA-Script bundle.
#
@@ -18,7 +18,7 @@
# This work consists of all files listed in manifest.txt.
# ----------------------------------------------------------------------
# Makefile
-# Copyright (c) Markus Kohm, 2002-2007
+# Copyright (c) Markus Kohm, 2002-2008
#
# Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
# Version 1.3b, verteilt und/oder veraendert werden.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex
index 07273965b18..346b45aeaf6 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex
@@ -1,6 +1,6 @@
% ======================================================================
% adrconvnote.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% adrconvnote.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex
index 24d329185a0..b7769154381 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex
@@ -1,6 +1,6 @@
% ======================================================================
% guide-english.tex
-% Copyright (c) Markus Kohm, 2002-2007
+% Copyright (c) Markus Kohm, 2002-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% guide-english.tex
-% Copyright (c) Markus Kohm, 2002-2007
+% Copyright (c) Markus Kohm, 2002-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
@@ -63,10 +63,20 @@
% \begin{macrocode}
\newcommand*{\GuideSubject}{The Guide}%
\newcommand*{\GuideTitle}{\KOMAScript}%
-\newcommand*{\GuideSubTitle}{a versatile {\LaTeXe} bundle}%
+\newcommand*{\GuideSubTitle}{a versatile {\LaTeXe} bundle%
+ % Ugly note
+ \vfill
+ \noindent Note: This document is part of \KOMAScript~3 but was written for
+ \KOMAScript~2.98. Several features of \KOMAScript~2 are obsolete (but may
+ still be used) with \KOMAScript~3. In this case this documentation
+ sometimes describes obsolete things. Several features of \KOMAScript~3 are
+ new but may not be found at this manual. This manual will be updated with
+ respect to the available ressources. Any request for help shall be sent to
+ komascript~at~gmx.info.%
+}%
\newcommand*{\GuideAuthorHeadline}{Authors of the {\KOMAScript} Bundle}%
-\newcommand*{\GuideTranslatorHeadline}{English translation of this manual by: }
-\newcommand*{\GuideWarrantyHeadline}{Legal Notes:}%
+\newcommand*{\GuideTranslatorHeadline}{English translation of this manual by:
+} \newcommand*{\GuideWarrantyHeadline}{Legal Notes:}%
\newcommand*{\GuideWarranty}{There is no warranty for any part of the
documented Software. The authors have taken care in the preparation of this
book, but make no expressed or implied warranty of any kind and assume no
@@ -80,8 +90,8 @@
\newcommand*{\GuideCopyright}{Free screen version without any optimization of
paragraph and page breaks\par\medskip%
This guide is part of {\KOMAScript}, which is free under the terms and
- conditions of {\LaTeX} Project Public License Version 1.3b. A version of this
- license, which is valid to {\KOMAScript}, is part of {\KOMAScript} (see
+ conditions of {\LaTeX} Project Public License Version 1.3b. A version of
+ this license, which is valid to {\KOMAScript}, is part of {\KOMAScript} (see
\File{lppl.txt}). Distribution of this manual\,---\,even if it is
printed\,---\,is allowed provided that all parts of {\KOMAScript} are
distributed. Distribution without the other parts of {\KOMAScript} needs a
@@ -113,25 +123,43 @@
% Some terms, e.g. used at index notes.
%
% \begin{macro}{\GuideClass}
+% \begin{macro}{\GuideClassIndexCategory}
+% \begin{macro}{\GuideClassIndexCategoryExpanded}
% The term »class«.
% \begin{macrocode}
\newcommand*{\GuideClass}{class}
+\newcommand*{\GuideClassIndexCategory}{classes}
+\let\GuideClassIndexCategoryExpanded\GuideClassIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideCounter}
-% The term »counter«.
+% \begin{macro}{\GuideCounterIndexCategory}
+% \begin{macro}{\GuideCounterIndexCategoryExpanded}
+%% The term »counter«.
% \begin{macrocode}
\newcommand*{\GuideCounter}{counter}
+\newcommand*{\GuideCounterExpanded}{counters}
+\let\GuideCounterIndexCategoryExpanded\GuideCounterIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideEnvironment}
+% \begin{macro}{\GuideEnvIndexCategory}
+% \begin{macro}{\GuideEnvIndexCategoryExpanded}
% The term »environment«.
% \begin{macrocode}
\newcommand*{\GuideEnvironment}{environment}
+\newcommand*{\GuideEnvIndexCategory}{environments}
+\let\GuideEnvIndexCategoryExpanded\GuideEnvIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideExample}
% The term »Example« used at a kind of heading, so it should be upper case.
@@ -141,80 +169,146 @@
% \end{macro}
%
% \begin{macro}{\GuideFile}
+% \begin{macro}{\GuideFileIndexCategory}
+% \begin{macro}{\GuideFileIndexCategoryExpanded}
% The term »file«.
% \begin{macrocode}
\newcommand*{\GuideFile}{file}
+\newcommand*{\GuideFileIndexCategory}{files}
+\let\GuideFileIndexCategoryExpanded\GuideFileIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideFloatstyle}
+% \begin{macro}{\GuideFloatstyleIndexCategory}
+% \begin{macro}{\GuideFloatstyleIndexCategoryExpanded}
% The term »\Package{float} style«.
% \begin{macrocode}
\newcommand*{\GuideFloatstyle}{\Package{float} style}
+\newcommand*{\GuideFloatstyleIndexCategory}{\Package{float} styles}
+\newcommand*{\GuideFloatstyleIndexCategoryExpanded}{float styles}
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideFontElement}
-% The term »element«.
+% \begin{macro}{\GuideFontElementIndexCategory}
+% \begin{macro}{\GuideFontElementIndexCategoryExpanded}
+%% The term »element«.
% \begin{macrocode}
\newcommand*{\GuideFontElement}{element}
+\newcommand*{\GuideFontElementIndexCategory}{elements}
+\let\GuideFontElementIndexCategoryExpanded\GuideFontElementIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideLength}
+% \begin{macro}{\GuideLengthIndexCategory}
+% \begin{macro}{\GuideLengthIndexCategoryExpanded}
% The term »length«.
% \begin{macrocode}
\newcommand*{\GuideLength}{length}
+\newcommand*{\GuideLengthIndexCategory}{lengths}
+\let\GuideLengthIndexCategoryExpanded\GuideLengthIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideMacro}
+% \begin{macro}{\GuideMacroIndexCategory}
+% \begin{macro}{\GuideMacroIndexCategoryExpanded}
% \begin{macro}{\GuideCommand}
+% \begin{macro}{\GuideCommandIndexCategory}
+% \begin{macro}{\GuideCommandIndexCategoryExpanded}
% The term »command«.
% \begin{macrocode}
\newcommand*{\GuideMacro}{command}
\let\GuideCommand\GuideMacro
+\newcommand*{\GuideMacroIndexCategory}{commands}
+\let\GuideCommandIndexCategory\GuideMacroIndexCategory
+\let\GuideMacroIndexCategoryExpanded\GuideMacroIndexCategory
+\let\GuideCommandIndexCategoryExpanded\GuideCommandIndexCategory
% \end{macrocode}
% \end{macro}
% \end{macro}
+% \end{macro}
+% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideOption}
+% \begin{macro}{\GuideOptionIndexCategory}
+% \begin{macro}{\GuideOptionIndexCategoryExpanded}
% The term »option«.
% \begin{macrocode}
\newcommand*{\GuideOption}{option}
+\newcommand*{\GuideOptionIndexCategory}{options}
+\let\GuideOptionIndexCategoryExpanded\GuideOptionIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuidePackage}
+% \begin{macro}{\GuidePackageIndexCategory}
+% \begin{macro}{\GuidePackageIndexCategoryExpanded}
% The term »package«.
% \begin{macrocode}
\newcommand*{\GuidePackage}{package}
+\newcommand*{\GuidePackageIndexCategory}{packages}
+\let\GuidePackageIndexCategoryExpanded\GuidePackageIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuidePagestyle}
+% \begin{macro}{\GuidePagestyleIndexCategory}
+% \begin{macro}{\GuidePagestyleIndexCategoryExpanded}
% The term »page style«.
% \begin{macrocode}
\newcommand*{\GuidePagestyle}{page style}
+\newcommand*{\GuidePagestyleIndexCategory}{page styles}
+\let\GuidePagestyleIndexCategoryExpanded\GuidePagestyleIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuidePLength}
+% \begin{macro}{\GuidePLengthIndexCategory}
+% \begin{macro}{\GuidePLengthIndexCategoryExpanded}
% \begin{macro}{\GuidePseudoPrefix}
% The prefix »pseudo« at the term »pseudo length« and the term itself.
% \begin{macrocode}
\newcommand*{\GuidePseudoPrefix}{pseudo-}
\newcommand*{\GuidePLength}{\GuidePseudoPrefix\GuideLength}
+\newcommand*{\GuidePLengthIndexCategory}{\GuidePseudoPrefix\GuideLengthIndexCategory}
+\let\GuidePLengthIndexCategoryExpanded\GuidePLengthIndexCategory
% \end{macrocode}
% \end{macro}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideVariable}
+% \begin{macro}{\GuideVariableIndexCategory}
+% \begin{macro}{\GuideVariableIndexCategoryExpanded}
% The termo »variable«.
% \begin{macrocode}
\newcommand*{\GuideVariable}{variable}
+\newcommand*{\GuideVariableIndexCategory}{variables}
+\let\GuideVariableIndexCategoryExpanded\GuideVariableIndexCategory
% \end{macrocode}
% \end{macro}
+% \end{macro}
+% \end{macro}
%
% \begin{macro}{\GuideAnd}
% The ``and'' at a list of two.
@@ -414,7 +508,7 @@
% \begin{macro}{\changelogname}
% The name of the change log index.
% \begin{macrocode}
- \def\changelogname{Change Log}
+ \def\changelogname{Change Log}%
% \end{macrocode}
% \end{macro}
% \begin{macrocode}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup b/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup
index a65b6680603..b99a790c804 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/htmlsetup
@@ -1,6 +1,6 @@
# ======================================================================
# htmlsetup
-# Copyright (c) Markus Kohm, 2002-2007
+# Copyright (c) Markus Kohm, 2002-2008
#
# This file is part of the LaTeX2e KOMA-Script bundle.
#
@@ -18,7 +18,7 @@
# This work consists of all files listed in manifest.txt.
# ----------------------------------------------------------------------
# htmlsetup
-# Copyright (c) Markus Kohm, 2002-2007
+# Copyright (c) Markus Kohm, 2002-2008
#
# Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
# Version 1.3b, verteilt und/oder veraendert werden.
@@ -58,6 +58,7 @@ alt=\"Valid HTML 4.0 Strict\" height=\"31\" width=\"88\"></a>
"variable" => "Variables",
"pagestyle" => "Page Styles",
"counter" => "Counter",
- "floatstyle" => "Styles for the float Package" );
+ "floatstyle" => "Styles for the float Package",
+ "fontelement" => "Elements (Font May Be Changed)" );
# end of file
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
index b865de9cb9f..a5f990667aa 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex
@@ -1,6 +1,6 @@
% ======================================================================
% introduction.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% introduction.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex
index 0f1769b4aae..bc1c9a9327e 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex
@@ -1,6 +1,6 @@
% ======================================================================
% japanlco.tex
-% Copyright (c) Gernot Hassenpflug and Markus Kohm, 2001-2007
+% Copyright (c) Gernot Hassenpflug and Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% japanlco.tex
-% Copyright (c) Gernot Hassenpflug und Markus Kohm, 2001-2007
+% Copyright (c) Gernot Hassenpflug und Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
index b1d03f6f975..12db589b78a 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scraddr.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scraddr.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
@@ -45,7 +45,7 @@
%
% ======================================================================
-\ProvidesFile{scraddr.tex}[2007/09/27 KOMA-Script guide (chapter: scraddr)]
+\ProvidesFile{scraddr.tex}[2008/07/10 KOMA-Script guide (chapter: scraddr)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm}
% Date of translated german file: 2005/08/10
@@ -95,7 +95,7 @@ a lot of {\TeX} memory.
The structure of the address entries in the address file was discussed
in detail in \autoref{sec:scrlttr2.addressFile} from
-\autopageref{desc:scrlttr2.macro.adrentry} onwards. The division of
+\autopageref{desc:scrlttr2.cmd.adrentry} onwards. The division of
the address file with the help of \Macro{adrchar} or \Macro{addrchar},
also discussed therein, has no meaning for \Package{scraddr} and is
simply ignored.
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 14653ea8f5c..74349845913 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrbookreportarticle.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrbookreportarticle.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
@@ -45,7 +45,7 @@
%
% ============================================================================
-\ProvidesFile{scrbookreportarticle.tex}[2007/12/15 KOMA-Script guide (chapter:
+\ProvidesFile{scrbookreportarticle.tex}[2008/07/10 KOMA-Script guide (chapter:
scrbook, scrreprt, scrartcl)]
\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm}
@@ -58,6 +58,9 @@ scrbook, scrreprt, scrartcl)]
%\AddSeeIndex{command}{gen}{\GuidecmdIndexShort}{cmd}% <-- set automaticly
\AddSeeIndex{macro}{gen}{\GuidecmdIndexShort}{cmd}%
+\textsc{Note:} Almost all commands of the chapter for experts are missing,
+because that chapter is still missing. Some are at this chapter instead.
+
\begin{Explain}
The main classes of the {\KOMAScript} bundle are designed as
counterparts to the standard {\LaTeX} classes. This means that the
@@ -108,6 +111,92 @@ sections.
\section{The Options}
\label{sec:maincls.options}
+\textsc{Note:} Since version~3.00 the main classes understand command
+\Macro{KOMAoptions} (see \autoref{sec:scrlttr2.options},
+\autopageref{desc:scrlttr2.cmd.KOMAoptions}). In the course of the
+development many new options were implemented and old became obsolete. Only
+the new options may be used with \Macro{KOMAoptions}. Unfortunately most of
+them are documented not yet. You may find the obsolete and corresponding new
+options at \autoref{tab:maincls-experts.deprecated}.
+
+\textsc{Note:} Following options are still missing in this chapter:
+\KOption{bibliography}\PName{setting}, \OptionValue{bibliography}{openstyle},
+\OptionValue{bibliography}{oldstyle}, \OptionValue{captions}{bottombeside},
+\OptionValue{captions}{centeredbeside}, \OptionValue{captions}{innerbeside},
+\OptionValue{captions}{leftbeside}, \OptionValue{captions}{outerbeside},
+\OptionValue{captions}{rightbeside}, \OptionValue{captins}{topbeside},
+\KOption{fontsize}\PName{size}, \OptionValue{footnotes}{multiple},
+\OptionValue{footnotes}{nomultiple}, \OptionValue{headings}{onelineappendix},
+\OptionValue{headings}{twolineappendix}, \OptionValue{headings}{onelinechapter},
+\OptionValue{headings}{twolinechapter}, \OptionValue{listof}{chapterentry},
+\OptionValue{listof}{chaptergapline}, \OptionValue{listof}{chaptergapsmall},
+\OptionValue{listof}{leveldown}, \OptionValue{listof}{nochaptergap},
+\OptionValue{numbers}{autoendperiod}, \OptionValue{toc}{bibliography},
+\OptionValue{toc}{bibliographynumbered}, \OptionValue{toc}{index},
+\OptionValue{toc}{listof}, \OptionValue{toc}{listofnumbered},
+\OptionValue{toc}{nobibliography}, \OptionValue{toc}{noindex},
+\OptionValue{toc}{nolistof}, \KOption{version}\PName{value} (see
+\autoref{sec:scrlttr2.compatibilityOptions},
+\autopageref{desc:scrlttr2.option.version}).
+
+\begingroup
+ \onelinecaptionsfalse
+ \newcommand*{\NewOld}[2]{%
+ \BeginIndex{Option}{#1}\PValue{#1} & \PValue{#2}\EndIndex{Option}{#1}\\
+ }%
+ \begin{longtable}{p{\dimexpr.5\textwidth-2\tabcolsep}p{\dimexpr.5\textwidth-2\tabcolsep}}
+ \caption{Obsolete vs. Recommended Options\label{tab:maincls-experts.deprecated}}\\
+ \toprule
+ obsolete option & recommended option \\
+ \midrule
+ \endfirsthead
+ \caption[]{Obsolete vs. Recommended Options
+ (\emph{continuation})}\\
+ \toprule
+ obsolete Option & recommended option \\
+ \midrule
+ \endhead
+ \midrule
+ \multicolumn{2}{r@{}}{\dots}\\
+ \endfoot
+ \bottomrule
+ \endlastfoot
+ \NewOld{abstracton}{abstract}%
+ \NewOld{abstractoff}{abstract=false}%
+ \NewOld{parskip-}{parskip=full-}%
+ \NewOld{parskip+}{parskip=full+}%
+ \NewOld{parskip*}{parskip=full*}%
+ \NewOld{halfparskip}{parskip=half}%
+ \NewOld{halfparskip-}{parskip=half-}%
+ \NewOld{halfparskip+}{parskip=half+}%
+ \NewOld{halfparskip*}{parskip=half*}%
+ \NewOld{tocleft}{toc=flat}%
+ \NewOld{tocindent}{toc=graduated}%
+ \NewOld{listsleft}{listof=flat}%
+ \NewOld{listsindent}{listof=graduated}%
+ \NewOld{cleardoubleempty}{cleardoublepage=empty}%
+ \NewOld{cleardoubleplain}{cleardoublepage=plain}%
+ \NewOld{cleardoublestandard}{cleardoublepage=current}%
+ \NewOld{pointednumber}{numbers=enddot}%
+ \NewOld{pointlessnumber}{numbers=noenddot}%
+ \NewOld{nochapterprefix}{chapterprefix=false}%
+ \NewOld{noappendixprefix}{appendixprefix=false}%
+ \NewOld{bigheadings}{headings=big}%
+ \NewOld{normalheadings}{headings=normal}%
+ \NewOld{smallheadings}{headings=small}%
+ \NewOld{headnosepline}{headsepline=false}%
+ \NewOld{footnosepline}{footsepline=false}%
+ \NewOld{liststotoc}{listof=totoc}%
+ \NewOld{liststotocnumbered}{listof=numbered}%
+ \NewOld{bibtotoc}{bibliography=totoc}%
+ \NewOld{bibtotocnumbered}{bibliography=totocnumbered}%
+ \NewOld{idxtotoc}{index=totoc}%
+ \NewOld{tablecaptionabove}{captions=tableheading}%
+ \NewOld{tablecaptionbelow}{captions=tablesignature}%
+ \NewOld{onelinecaption}{captions=oneline}%
+ \NewOld{noonelinecaption}{captions=nooneline}%
+ \end{longtable}
+\endgroup
This section describes the global options of the three main classes.
The majority of the options can also be found in the standard classes.
@@ -129,49 +218,41 @@ set, either by default or by the user.
Option &
\Class{scrbook} & \Class{scrreprt} & \Class{scrartcl} \\
\hline\rule{0pt}{2.7ex}%
- \Option{11pt} &
- default & default & default \\
- \Option{a4paper} &
- default & default & default \\
- \Option{abstractoff} &
- \emph{undefined} & default & default \\
- \Option{bigheadings} &
- default & default & default \\
- \Option{chapteratlists=} &
+ \KOption{abstract} &
+ \emph{undefined} & \PValue{false} & \PValue{false} \\
+ \KOption{captions} &
+ \PValue{tablesignature} & \PValue{tablesignature} & \PValue{tablesignature} \\
+ \KOption{chapteratlists} &
\PValue10{pt} & \PValue{10pt} & \emph{undefined} \\
- \Option{final} &
- default & default & default \\
- \Option{footnosepline} &
- default & default & default \\
- \Option{headnosepline} &
- default & default & default \\
- \Option{listsindent} &
- default & default & default \\
- \Option{nochapterprefix} &
- default & default & \emph{undefined} \\
- \Option{onelinecaption} &
- default & default & default \\
- \Option{notitlepage} &
- & & default \\
- \Option{onecolumn} &
- default & default & default \\
- \Option{oneside} &
- & default & default \\
- \Option{openany} &
- & default & default \\
- \Option{openright} &
- default & & \\
+ \KOption{chapterprefix} &
+ \PValue{false} & \PValue{false} & \emph{undefined} \\
+ \KOption{draft} &
+ \PValue{false} & \PValue{false} & \PValue{false} \\
+ \KOption{fontsize} &
+ \PValue{11pt} & \PValue{11pt} & \PValue{11pt} \\
+ \KOption{footsepline} &
+ \PValue{false} & \PValue{false} & \PValue{false} \\
+ \KOption{headings} &
+ \PValue{big} & \PValue{big} & \PValue{big} \\
+ \KOption{headsepline} &
+ \PValue{false} & \PValue{false} & \PValue{false} \\
+ \KOption{listof} &
+ \PValue{graduated} & \PValue{graduated} & \PValue{graduated} \\
+ \KOption{open} &
+ \PValue{right} & \PValue{any} & \emph{undefined} \\
+ \KOption{paper} &
+ \PValue{a4} & \PValue{a4} & \PValue{a4} \\
\Option{parindent} &
default & default & default \\
- \Option{tablecaptionbelow} &
- default & default & default \\
- \Option{titlepage} &
- default & default \\
- \Option{tocindent} &
- default & default & default \\
- \Option{twoside} &
- default & & \\
- \Option{version=} &
+ \KOption{titlepage} &
+ \PValue{true} & \PValue{true} & \PValue{false} \\
+ \KOption{toc} &
+ \PValue{graduated} & \PValue{graduated} & \PValue{graduated} \\
+ \KOption{twocolumn} &
+ \PName{false} & \PName{false} & \PName{false} \\
+ \KOption{twoside} &
+ \PValue{true} & \PValue{false} & \PValue{false} \\
+ \KOption{version} &
\PValue{first} & \PValue{first} & \PValue{first} \\
\end{tabular}
\label{tab:maincls.stdOptions}
@@ -330,32 +411,6 @@ however.
\end{Explain}
-\begin{Declaration}
- \Option{BCOR}\PName{correction}\\
- \Option{DIV}\PName{factor}\\
- \Option{DIVcalc}\\
- \Option{DIVclassic}\\
- \PName{Value}\Option{headlines}
-\end{Declaration}%
-\BeginIndex{Option}{BCOR}%
-\BeginIndex{Option}{DIV}%
-\BeginIndex{Option}{DIVcalc}%
-\BeginIndex{Option}{DIVclassic}%
-\BeginIndex{Option}{headlines}%
-The options for the divisor and the binding correction\Index{binding
- correction} are passed directly to the \Package{typearea} package
-(see \autoref{sec:typearea.options}, \autopageref{desc:typearea.option.BCOR}
-till \autopageref{desc:typearea.option.headlines}). This differs from the
-standard classes, where there is no such transfer. This is also valid
-for the option that sets the number of header lines.
-%
-\EndIndex{Option}{BCOR}%
-\EndIndex{Option}{DIV}%
-\EndIndex{Option}{DIVcalc}%
-\EndIndex{Option}{DIVclassic}%
-\EndIndex{Option}{headlines}
-
-
\subsection{Options for Document Layout}
\label{sec:maincls.layoutOptions}
@@ -366,140 +421,85 @@ course, all page layout options (see
options. The reverse is also partially true.
\begin{Declaration}
- \Option{oneside}\\
- \Option{twoside}
+ \KOption{open}\PName{value}
\end{Declaration}%
-\BeginIndex{Option}{oneside}
-\BeginIndex{Option}{twoside}%
-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
-\Macro{flushbottom}\IndexCmd{flushbottom} is used to ensure that page
-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}%
-\EndIndex{Option}{twoside}%
-
-
-\begin{Declaration}
- \Option{onecolumn}\\
- \Option{twocolumn}
-\end{Declaration}%
-\BeginIndex{Option}{onecolumn}
-\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
-only useful for very simple uses. The standard package
-\Package{multicol} is much more versatile (see
-\cite{package:multicol}).\Index{columns}\IndexPackage{multicol}
-%
-\EndIndex{Option}{onecolumn} \EndIndex{Option}{twocolumn}
-
-
-\begin{Declaration}
- \Option{openany}\\
- \Option{openright}
-\end{Declaration}%
-\BeginIndex{Option}{openany}%
-\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 the next largest unit below ``part'' is ``section''. The chapter
-level is not available in \Class{scrartcl}.
+\BeginIndex{Option}{open~=\PName{value}}%
+These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} option has the same effects
+like the standard options \Option{openany} and \Option{openright}. 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 the next largest
+unit below ``part'' is ``section''. The chapter level is not available in
+\Class{scrartcl}.
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 on a new right page.
+\OptionValue{open}{any} is active, any page can be used. The option
+\OptionValue{open}{right} 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}
command \Macro{cleardoublepage}\IndexCmd{cleardoublepage}.
-The option \Option{openright} has no effect with a one-sided layout,
+The option \OptionValue{open}{right} has no effect with a one-sided layout,
because only the two-sided layout differentiates between left and
right pages. For this reason it should only be used together with the
-\Option{twoside} option.
-%
-\EndIndex{Option}{openany}%
-\EndIndex{Option}{openright}
+\Option{twoside} option.%
+\EndIndex{Option}{open~=\PName{value}}%
\begin{Declaration}
- \Option{cleardoublestandard}\\
- \Option{cleardoubleplain}\\
- \Option{cleardoubleempty}
+ \KOption{cleardoublepage}\PName{page style}\\
+ \OptionValue{cleardoublepage}{current}
\end{Declaration}%
-\BeginIndex{Option}{cleardoublestandard}%
-\BeginIndex{Option}{cleardoubleplain}%
-\BeginIndex{Option}{cleardoubleempty}%
+\BeginIndex{Option}{cleardoublepage~=\PName{page style}}%
+\BeginIndex{Option}{cleardoublepage~=\PValue{current}}%
If one wishes the empty pages created by the \Macro{cleardoublepage}
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
+\OptionValue{cleardoublepage}{current} enables the default
\Macro{cleardoublepage} behaviour. If the option
-\Option{cleardoubleplain} is used, then the
+\OptionValue{cleardoublepage}{plain} is used, then the
\PValue{plain}\IndexPagestyle{plain} page style is applied to the
-empty left page. The option \Option{cleardoubleempty} causes the
+empty left page. The option \OptionValue{cleardoublepage}{empty} causes the
\PValue{empty}\IndexPagestyle{empty} page style to be used. The page
-styles are described in \autoref{sec:maincls.pageStyle}.
-%
-\EndIndex{Option}{cleardoublestandard}%
-\EndIndex{Option}{cleardoubleplain}%
-\EndIndex{Option}{cleardoubleempty}%
+styles are described in \autoref{sec:maincls.pageStyle}.%
+\EndIndex{Option}{cleardoublepage~=\PValue{current}}%
+\EndIndex{Option}{cleardoublepage~=\PName{page style}}%
\begin{Declaration}
- \Option{titlepage}\\
- \Option{notitlepage}
+ \KOption{titlepage}\PName{switch}
\end{Declaration}%
-\BeginIndex{Option}{titlepage}%
-\BeginIndex{Option}{notitlepage}%
-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
-significantly (see \autoref{sec:maincls.titles}).
-
-The option \Option{notitlepage} specifies that an \emph{in-page} title
-is used. This means that the title is specially emphasized, but it may
-be followed by more material on the same page, for instance by an
-abstract or a section.
-%
-\EndIndex{Option}{titlepage}%
-\EndIndex{Option}{notitlepage}%
+\BeginIndex{Option}{titlepage~=\PName{switch}}%
+The values of the option (see \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}) have the same effect as the standard
+options \Option{titlepage} and \Option{notitlepage}. The option
+\OptionValue{titlepage}{true} 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 significantly (see
+\autoref{sec:maincls.titles}).
+
+The option \OptionValue{titlepage}{false} specifies that an \emph{in-page}
+title is used. This means that the title is specially emphasized, but it may
+be followed by more material on the same page, for instance by an abstract or
+a section.%
+\EndIndex{Option}{titlepage~=\PName{switch}}%
\begin{Explain}%
\begin{Declaration}
- \Option{parskip}\\
- \Option{parskip*}\\
- \Option{parskip+}\\
- \Option{parskip-}\\
- \Option{halfparskip}\\
- \Option{halfparskip*}\\
- \Option{halfparskip+}\\
- \Option{halfparskip-}\\
+ \OptionValue{parskip}{full}\\
+ \OptionValue{parskip}{full*}\\
+ \OptionValue{parskip}{full+}\\
+ \OptionValue{parskip}{full-}\\
+ \OptionValue{parskip}{half}\\
+ \OptionValue{parskip}{half*}\\
+ \OptionValue{parskip}{half+}\\
+ \OptionValue{parskip}{half-}\\
\Option{parindent}
\end{Declaration}%
-\BeginIndex{Option}{parskip}%
-\BeginIndex{Option}{parskip*}%
-\BeginIndex{Option}{parskip+}%
-\BeginIndex{Option}{parskip-}%
-\BeginIndex{Option}{halfparskip}%
-\BeginIndex{Option}{halfparskip*}%
-\BeginIndex{Option}{halfparskip+}%
-\BeginIndex{Option}{halfparskip-}%
+\BeginIndex{Option}{parskip~=\PName{Value}}%
\BeginIndex{Option}{parindent}%
The standard classes normally set
paragraphs\Index[indexmain]{paragraph} indented and without any
@@ -528,14 +528,15 @@ newspaper.
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
-options: \Option{parskip}, \Option{parskip-}, \Option{parskip*},
-\Option{parskip+} and \Option{halfparskip}, \Option{halfparskip-},
-\Option{halfparskip*} and \Option{halfparskip+}.
-
-The four \Option{parskip} options each define an inter-paragraph
-spacing of one line. The four \Option{halfparskip} options use just a
+document layout with vertical inter-paragraph spacing instead of indentation.
+{\KOMAScript} provides a large number of related options:
+\OptionValue{parskip}{full}, \OptionValue{parskip}{full-},
+\OptionValue{parskip}{full*}, \OptionValue{parskip}{full+} and
+\OptionValue{parskip}{half}, \OptionValue{parskip}{half-},
+\OptionValue{parskip}{half*} and \OptionValue{parskip}{half+}.
+
+The four \PValue{full} option valuess each define an inter-paragraph
+spacing of one line. The four \PValue{half} option values 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
@@ -545,71 +546,58 @@ 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.
+All eight \PValue{full} and \PValue{half} option values 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}
option. In this case, there is no spacing between paragraphs, only an
indentation of the first line by 1\Unit{em}.
%
-\EndIndex{Option}{parskip}%
-\EndIndex{Option}{parskip*}%
-\EndIndex{Option}{parskip+}%
-\EndIndex{Option}{parskip-}%
-\EndIndex{Option}{halfparskip}%
-\EndIndex{Option}{halfparskip*}%
-\EndIndex{Option}{halfparskip+}%
-\EndIndex{Option}{halfparskip-}%
+\EndIndex{Option}{parskip~=\PName{Value}}%
\EndIndex{Option}{parindent}%
\begin{Declaration}
- \Option{headsepline}\\
- \Option{headnosepline}\\
- \Option{footsepline}\\
- \Option{footnosepline}
+ \KOption{headsepline}\PName{switch}\\
+ \KOption{footsepline}\PName{switch}
\end{Declaration}%
-\BeginIndex{Option}{headsepline}%
-\BeginIndex{Option}{headnosepline}%
-\BeginIndex{Option}{footsepline}%
-\BeginIndex{Option}{footnosepline}%
-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 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
-behave like the corresponding header functions. Whenever a line is
-requested by the \Option{footsepline} option, the \Option{footinclude}
-option is automatically passed to the \Package{typearea} package. In
-contrast to \Option{headsepline}, \Option{footsepline} takes effect
-when used together with the page style \PValue{plain}, because the
-\PValue{plain} style produces a page number in the footer.
+\BeginIndex{Option}{headsepline~=\PName{switch}}%
+\BeginIndex{Option}{footsepline~=\PName{switch}}%
+In order to have a line separating the header from the text body use the
+option \Option{headsepline} (see \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}). The option
+\OptionValue{headsepline}{false} 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
+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
+option \Option{footsepline}, that behaves like the corresponding header
+functions. Whenever a line is requested by the \Option{footsepline} option,
+the \Option{footinclude} option is automatically passed to the
+\Package{typearea} package. In contrast to \Option{headsepline},
+\Option{footsepline} takes effect when used together with the page style
+\PValue{plain}, because the \PValue{plain} style produces a page number in the
+footer.
%
-\EndIndex{Option}{headsepline}%
-\EndIndex{Option}{headnosepline}%
-\EndIndex{Option}{footsepline}%
-\EndIndex{Option}{footnosepline}%
+\EndIndex{Option}{headsepline~=\PName{switch}}%
+\EndIndex{Option}{footsepline~=\PName{switch}}%
\begin{Declaration}
\Option{chapterprefix}\\
- \Option{nochapterprefix}
+ \OptionValue{chapterprefix}{false}
\end{Declaration}%
\BeginIndex{Option}{chapterprefix}%
-\BeginIndex{Option}{nochapterprefix}%
+\BeginIndex{Option}{chapterprefix~=\PValue{false}}%
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
@@ -618,46 +606,44 @@ title\Index[indexmain]{chapter>title} consists of a line with the word
followed by the chapter number. The title itself is set left-justified
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
+\OptionValue{chapterprefix}{false}. These options also affect the automatic
running titles in the headers (see
\autoref{sec:maincls.pageStyle}).
%
\EndIndex{Option}{chapterprefix}%
-\EndIndex{Option}{nochapterprefix}%
+\EndIndex{Option}{chapterprefix~=\PValue{false}}%
\begin{Declaration}
- \Option{appendixprefix}\\
- \Option{noappendixprefix}
+ \KOption{appendixprefix}\PName{switch}
\end{Declaration}%
-\BeginIndex{Option}{appendixprefix}%
-\BeginIndex{Option}{noappendixprefix}%
-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''
+\BeginIndex{Option}{appendixprefix~=\PName{switch}}%
+Sometimes\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} one wishes to have the
+chapter titles in simplified form according to
+\OptionValue{chapterprefix}{false}. But at the same time, one wishes a title
+of 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
+\Option{appendixprefix} option (see \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}). Since this results in an inconsistent
document layout, I advise against using this option.
-The reverse option \Option{noappendixprefix} exists only for
-completeness' sake. I don't know of any sensible use for it.
-%
-\EndIndex{Option}{appendixprefix}%
-\EndIndex{Option}{noappendixprefix}%
+The reverse option \OptionValue{appendixprefix}{false} exists only for
+completeness' sake. I don't know of any sensible use for it.%
+\EndIndex{Option}{appendixprefix~=\PName{switch}}%
\begin{Declaration}
- \Option{onelinecaption}\\
- \Option{noonelinecaption}
+ \OptionValue{captions}{oneline}\\
+ \OptionValue{captions}{nooneline}
\end{Declaration}
-\BeginIndex{Option}{onelinecaption}%
+\BeginIndex{Option}{captions~=\PValue{oneline}}%
+\BeginIndex{Option}{captions~=\PValue{nooneline}}%
The standard classes differentiate between one-line and multi-line
table or figure captions. One-line captions are centered while
multi-line captions are left-justified. This behavior, which is also
the default with \KOMAScript, corresponds to the option
-\Option{onelinecaption}. There is no special handling of one-line
-captions when the \Option{noonelinecaption} option is given.
+\OptionValue{captions}{oneline}. There is no special handling of one-line
+captions when the \OptionValue{captions}{nooneline} option is given.
\begin{Explain}
The avoidance of a special treatment for the caption has an
@@ -665,12 +651,12 @@ captions when the \Option{noonelinecaption} option is given.
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
+ will be one line or more. When the \OptionValue{captions}{nooneline} 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
+ \OptionValue{captions}{nooneline} to avoid the above described
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
@@ -679,8 +665,8 @@ captions when the \Option{noonelinecaption} option is given.
inseparable.
\end{Explain}
%
-\EndIndex{Option}{onelinecaption}%
-\EndIndex{Option}{noonelinecaption}%
+\EndIndex{Option}{captions~=\PValue{oneline}}%
+\EndIndex{Option}{captions~=\PValue{nooneline}}%
\subsection{Options for Font Selection}
\label{sec:maincls.fontOptions}
@@ -720,20 +706,18 @@ the \Package{typearea} package.
\begin{Declaration}
- \Option{smallheadings}\\
- \Option{normalheadings}\\
- \Option{bigheadings}
+ \OptionValue{headings}{small}\\
+ \OptionValue{headings}{normal}\\
+ \OptionValue{headings}{big}
\end{Declaration}%
-\BeginIndex{Option}{smallheadings}%
-\BeginIndex{Option}{normalheadings}%
-\BeginIndex{Option}{bigheadings}%
+\BeginIndex{Option}{headings~=\PName{size}}%
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
+the \OptionValue{headings}{big} option, the two options
+\OptionValue{headings}{normal} and \OptionValue{headings}{small}, that allow for
smaller title font sizes. The font sizes for headings resulting from
these options for \Class{scrbook} and \Class{scrreprt} are shown in
\autoref{tab:maincls.structureElementsFont},
@@ -743,14 +727,12 @@ 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 which
+\OptionValue{chapterprefix}{false}, and appendix titles by the options
+\Option{appendixprefix} and \OptionValue{appendixprefix}{false}, all of which
are described in \autoref{sec:maincls.layoutOptions},
\autopageref{desc:maincls.option.chapterprefix}.
%
-\EndIndex{Option}{smallheadings}%
-\EndIndex{Option}{normalheadings}%
-\EndIndex{Option}{bigheadings}%
+\EndIndex{Option}{headings~=\PName{size}}%
\subsection{Options Affecting the Table of Contents}
\label{sec:maincls.tocOptions}
@@ -763,17 +745,17 @@ options provided.
\begin{Explain}%
\begin{Declaration}
- \Option{liststotoc}\\
- \Option{idxtotoc}\\
- \Option{bibtotoc}\\
- \Option{bibtotocnumbered}\\
- \Option{liststotocnumbered}
+ \OptionValue{listof}{totoc}\\
+ \OptionValue{index}{totoc}\\
+ \OptionValue{bibliography}{totoc}\\
+ \OptionValue{bibliography}{totocnumbered}\\
+ \OptionValue{listof}{numbered}
\end{Declaration}%
-\BeginIndex{Option}{liststotoc}%
-\BeginIndex{Option}{idxtotoc}%
-\BeginIndex{Option}{bibtotoc}%
-\BeginIndex{Option}{bibtotocnumbered}%
-\BeginIndex{Option}{liststotocnumbered}%
+\BeginIndex{Option}{listof~=\PValue{totoc}}%
+\BeginIndex{Option}{index~=\PValue{totoc}}%
+\BeginIndex{Option}{bibliography~=\PValue{totoc}}%
+\BeginIndex{Option}{bibliography~=\PValue{totocnumbered}}%
+\BeginIndex{Option}{listof~=\PValue{numbered}}%
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
@@ -798,13 +780,13 @@ 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 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
+\OptionValue{listof}{totoc} 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
\cite{package:float}). All these lists are unnumbered, since they
contain entries that reference other sections of the document.
-The option \Option{idxtotoc} causes an entry for the index to be
+The option \OptionValue{index}{totoc} causes an entry for the index to be
included in the table of contents. The index is unnumbered since it
too only includes references to the contents of the other sectional
units.
@@ -813,51 +795,50 @@ The bibliography is a different kind of listing. It does not list the
contents of the present document but refers instead to external
documents. For 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
+\OptionValue{bibliography}{totocnumbered} has this effect, including the generation of
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.
+be achieved with the \OptionValue{bibliography}{totoc} 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},
+of {\KOMAScript} already views the option \OptionValue{listof}{totoc} with
+open skepticism, and frankly detests option \OptionValue{bibliography}{totocnumbered},
it should come as no surprise that he implemented option
-\Option{liststotocnumbered} only under extreme duress. He fears that
+\OptionValue{listof}{numbered} 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}
+documentation for a detailed description of option \OptionValue{listof}{totoc}
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}%
-\EndIndex{Option}{bibtotoc}%
-\EndIndex{Option}{bibtotocnumbered}%
-\EndIndex{Option}{liststotocnumbered}%
+\EndIndex{Option}{listof~=\PValue{totoc}}%
+\EndIndex{Option}{index~=\PValue{totoc}}%
+\EndIndex{Option}{bibliography~=\PValue{totoc}}%
+\EndIndex{Option}{bibliography~=\PValue{totocnumbered}}%
+\EndIndex{Option}{listof~=\PValue{numbered}}%
\begin{Declaration}
- \Option{tocindent}\\
- \Option{tocleft}
+ \OptionValue{toc}{graduated}\\
+ \OptionValue{toc}{flat}
\end{Declaration}%
-\BeginIndex{Option}{tocindent}%
-\BeginIndex{Option}{tocleft}%
+\BeginIndex{Option}{toc~=\PName{value}}%
The table of contents is normally\ChangedAt{v2.8q}{%
\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}.
+setup is selected with the option \OptionValue{toc}{graduated}.
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
+that avoids the problem completely. If the option \OptionValue{toc}{flat} 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
@@ -866,26 +847,25 @@ automatically.
\begin{Explain}
In order to calculate automatically the space taken by the unit
- numbers when using the option \Option{tocleft} it is necessary to
+ numbers when using the option \OptionValue{toc}{flat} it is necessary to
redefine some macros. It is improbable but not impossible that this
leads to problems when using other packages. If you think this may
be causing problems, you should try the alternative option
- \Option{tocindent}, since it does not make any redefinitions. When
+ \OptionValue{toc}{graduated}, 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} too may lead to problems. When using such
+ is possible that the use of options \OptionValue{toc}{flat} and
+ \OptionValue{toc}{graduated} 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
+ If the \OptionValue{toc}{flat} 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
contents.
\end{Explain}
%
-\EndIndex{Option}{tocindent}%
-\EndIndex{Option}{tocleft}%
+\EndIndex{Option}{toc~=\PName{value}}%
\subsection{Options for Lists of Floats}
\label{sec:maincls.listsOptions}
@@ -909,30 +889,28 @@ possible to produce new float environments with corresponding lists.
\end{Explain}
\begin{Declaration}
- \Option{listsindent}\\
- \Option{listsleft}
+ \OptionValue{listof}{graduated}\\
+ \OptionValue{listof}{flat}
\end{Declaration}%
-\BeginIndex{Option}{listsindent}%
-\BeginIndex{Option}{listsleft}%
+\BeginIndex{Option}{listof~=\PName{value}}%
Lists of figures and tables\ChangedAt{v2.8q}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} are
generally set up so that their numbering uses a fixed space. This
-corresponds to the use of option \Option{listsindent}.
+corresponds to the use of option \OptionValue{listof}{graduated}.
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
+{\KOMAScript} supplies an option called \OptionValue{listof}{flat} that is
+similar to the \OptionValue{toc}{flat} 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}
+\autopageref{desc:maincls.option.toc} for the \OptionValue{toc}{flat}
option are equally valid in this case. Please note that when using the
-\Option{listsleft} option several {\LaTeX} runs are necessary before
+\OptionValue{listof}{flat} option several {\LaTeX} runs are necessary before
the lists of floats achieve their final form.
%
-\EndIndex{Option}{listsindent}%
-\EndIndex{Option}{listsleft}%
+\EndIndex{Option}{listof~=\PName{value}}%
\begin{Declaration}
\Option{chapteratlists}\\
@@ -971,21 +949,20 @@ formatting of the document and cannot be assigned to other sections.
They are therefore the \emph{remaining options}.
\begin{Declaration}
- \Option{abstracton}\\
- \Option{abstractoff}
+ \KOption{abstract}\PName{switch}
\end{Declaration}%
-\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
-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}.
+\BeginIndex{Option}{abstract~=\PName{switch}}%
+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 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 \OptionValue{abstract}{true} and
+\OptionValue{abstract}{false} (see
+\autoref{tab:truefalseswitch},\autopageref{tab:truefalseswitch}).
\begin{Explain}
Books typically use another type of summary. In that case there is
@@ -997,16 +974,14 @@ title with the options \Option{abstracton} and \Option{abstractoff}.
thesis.
\end{Explain}
%
-\EndIndex{Option}{abstracton}%
-\EndIndex{Option}{abstractoff}%
+\EndIndex{Option}{abstract~=\PName{switch}}%
\begin{Declaration}
- \Option{pointednumbers}\\
- \Option{pointlessnumbers}
+ \OptionValue{numbers}{enddot}\\
+ \OptionValue{numbers}{noenddot}
\end{Declaration}%
-\BeginIndex{Option}{pointednumbers}%
-\BeginIndex{Option}{pointlessnumbers}%
+\BeginIndex{Option}{numbers~=\PName{value}}%
\begin{Explain}%
In German, according to {\small DUDEN}, the numbering of sectional
units should have no dot at the end if only arabic numbers are used
@@ -1023,8 +998,8 @@ title with the options \Option{abstracton} and \Option{abstractoff}.
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}.
+option \OptionValue{numbers}{enddot} or to deactivate it with
+\OptionValue{numbers}{noenddot}.
Please note that the mechanism only takes effect on the next {\LaTeX}
run. Therefore, before trying to use these options to forcibly
@@ -1037,8 +1012,7 @@ correct. It so happened that the meaning of the chosen names was not clear to
me a few years ago when the options were implemented. Some people asked me not
to fix this ``funny little mistake'' so I didn't.
%
-\EndIndex{Option}{pointednumbers}%
-\EndIndex{Option}{pointlessnumbers}%
+\EndIndex{Option}{numbers~=\PName{value}}%
\begin{Declaration}
\Option{leqno}
@@ -1058,24 +1032,26 @@ left.
\BeginIndex{Option}{fleqn}%
Displayed equations are normally centered. The standard option
\Option{fleqn} causes the standard option file \File{fleqn.clo} to be
-loaded. Displayed equations are then left-justified.
+loaded. Displayed equations are then left-justified. This option may not be
+used at the argument of \Macro{KOMAoptions} but at the optional argument of
+\Macro{documentclass}.
%
\EndIndex{Option}{fleqn}%
\begin{Declaration}
- \Option{tablecaptionbelow}\\
- \Option{tablecaptionabove}
+ \OptionValue{captions}{tablesignature}\\
+ \OptionValue{captions}{tableheading}
\end{Declaration}%
-\BeginIndex{Option}{tablecaptionbelow}%
-\BeginIndex{Option}{tablecaptionabove}%
+\BeginIndex{Option}{captions~=\PValue{tablesignature}}%
+\BeginIndex{Option}{captions~=\PValue{tableheading}}%
As described in \autoref{sec:maincls.floats},
-\autopageref{desc:maincls.macro.caption}, the
+\autopageref{desc:maincls.cmd.caption}, the
\Macro{caption}\IndexCmd{caption} command acts with figures like 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
+setting, \OptionValue{captions}{tablesignature}, the \Macro{caption} macro acts
also with tables like the \Macro{captionbelow} command. With the
-\Option{tablecaptionabove} option, \Macro{caption} acts like the
+\OptionValue{captions}{tableheading} option, \Macro{caption} acts like the
\Macro{captionabove}\IndexCmd{captionabove} command.
Note that using any of these options does not change the position of
@@ -1086,8 +1062,8 @@ 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
+\Package{float} package, the options \OptionValue{captions}{tablesignature} and
+\OptionValue{captions}{tableheading} 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
@@ -1095,8 +1071,8 @@ Note\OnlyAt{\Package{float}}\IndexPackage{float} that when using the
\PValue{komaabove} in \autoref{sec:maincls.floats},
\autopageref{desc:maincls.floatstyle.komaabove}.
%
-\EndIndex{Option}{tablecaptionbelow}%
-\EndIndex{Option}{tablecaptionabove}%
+\EndIndex{Option}{captions~=\PValue{tablesignature}}%
+\EndIndex{Option}{captions~=\PValue{tableheafins}}%
\begin{Explain}%
@@ -1111,7 +1087,7 @@ 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
+\autopageref{desc:maincls.cmd.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
@@ -1127,7 +1103,9 @@ should not be redefined by the {\KOMAScript} classes, activate the
\begin{Declaration}
- \Option{openbib}
+ \Option{openbib}\\
+ \OptionValue{bibliography}{openstyle}\\
+ \OptionValue{bibliography}{oldstyle}
\end{Declaration}%
\BeginIndex{Option}{openbib}%
The standard option \Option{openbib} switches to an alternative
@@ -1141,27 +1119,25 @@ only a stretchable horizontal space.
\begin{Declaration}
- \Option{draft}\\
- \Option{final}
+ \KOption{draft}\PName{switch}
\end{Declaration}%
-\BeginIndex{Option}{draft}%
-\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. 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
-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
-containing only the graphic's filename (see \cite{package:graphics}).
-%
-\EndIndex{Option}{draft}%
-\EndIndex{Option}{final}%
+\BeginIndex{Option}{draft~=\PName{switch}}%
+The option \Option{draft} (see \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}) is normally used to distinguish between the
+draft and final versions of a document. In particular, the option
+\OptionValue{draft}{true} 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 \OptionValue{draft}{false} option no
+such boxes are shown.
+
+Option \Option{draft} without value is also processed by other packages and
+affect their 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 containing only the graphic's filename (see
+\cite{package:graphics}).%
+\EndIndex{Option}{draft~=\PName{switch}}%
\section{General Document Characteristics}
@@ -1318,7 +1294,7 @@ specification to the one currently used with the specified
the main title page}%
\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})}%
+ note in the text from \autopageref{desc:maincls.cmd.title})}%
\end{desctable}
%
\EndIndex{Cmd}{setkomafont}%
@@ -1390,8 +1366,8 @@ Usually one distinguishes four different page styles.
\end{description}
Besides, the form of the page styles \PValue{headings} and
\PValue{myheadings} is affected by each of the four class options
-\Option{headsepline}, \Option{headnosepline}, \Option{footsepline} and
-\Option {footnosepline} (see \autoref{sec:maincls.layoutOptions},
+\Option{headsepline}, \OptionValue{headsepline}{false}, \Option{footsepline} and
+\OptionValue{footsepline}{false} (see \autoref{sec:maincls.layoutOptions},
\autopageref{desc:maincls.option.headsepline}).
The page style starting with the current page is changed by the
command \Macro{pagestyle}. On the other hand \Macro{thispagestyle}
@@ -1651,24 +1627,23 @@ 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
+\autoref{sec:typearea.options},
+\autopageref{desc:typearea.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
-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 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
-\Option{cleardoubleempty} described in
+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 heading. The page is thus entirely empty. However, the approach used
+by \Macro{cleardoublepage} is dependent on the layout options
+\OptionValue{cleardoublepage}{current}, \OptionValue{cleardoublepage}{plain}
+and \OptionValue{cleardoublepage}{empty} described in
\autoref{sec:maincls.layoutOptions},
-\autopageref{desc:maincls.option.cleardoublestandard} and acts according to the
-active option.
+\autopageref{desc:maincls.option.cleardoublepage} and acts according to
+the active option.
%
\EndIndex{Cmd}{clearpage}%
\EndIndex{Cmd}{cleardoublepage}%
@@ -1809,8 +1784,8 @@ the number 1 in the style \PName{numbering style}.
\Class{article} or \Class{scrartcl} have by default \emph{in-page}
titles, while classes like \Class{report}, \Class{book},
\Class{scrreprt} and \Class{scrbook} have title pages as default.
- The defaults can be changed with the class options
- \Option{titlepage} and \Option{notitlepage}.
+ The defaults can be changed with the class option
+ \Option{titlepage}.
\end{Explain}
@@ -1870,7 +1845,7 @@ 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}.
+\autopageref{desc:maincls.cmd.titlepagestyle}.
The following commands do not lead necessarily to the production of the
titles. The typesetting of the title pages is always done by
@@ -2174,10 +2149,10 @@ offer a special environment for this summary, the
\Environment{abstract} environment. This is output directly, at it is
not a component of the titles set by \Macro{maketitle}. Please note
that \Environment{abstract} is an environment, not a command. Whether
-the summary has a heading or not is determined by the options
-\Option{abstracton} and \Option{abstractoff} (see
+the summary has a heading or not is determined by the option
+\Option{abstract} (see
\autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.abstracton})
+\autopageref{desc:maincls.option.abstract})
With books (\Class{scrbook}) the summary is frequently a component of
the introduction or a separate chapter at the end of the document.
@@ -2203,23 +2178,23 @@ by lists of floats, e.\,g., lists of tables and figures (see
\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 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}.
+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 \OptionValue{listof}{totoc} causes
+the lists of figures and tables to be included in the table of
+contents. \OptionValue{index}{totoc} 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 \OptionValue{bibliography}{totoc} and
+\OptionValue{bibliography}{totocnumbered}. These options are explained in
+\autoref{sec:maincls.tocOptions},
+\autopageref{desc:maincls.option.listof.totoc}.
\begin{Explain}
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
+ \autopageref{desc:maincls.cmd.chapter*}. However, the running
headings\Index{running heading} for left and right pages are correctly filled
with the heading of the table of contents.
@@ -2237,10 +2212,10 @@ 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
+option \OptionValue{toc}{flat} 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
+\autopageref{desc:maincls.option.toc}, several {\LaTeX} runs are
needed.
\begin{Explain}
@@ -2342,15 +2317,15 @@ contents, therefore the explanation is given 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
+\OptionValue{listof}{graduated} and \OptionValue{listof}{flat} (see
\autoref{sec:maincls.listsOptions},
-\autopageref{desc:maincls.option.listsleft}). Moreover, the options
-\Option{liststotoc} and \Option{liststotocnumbered} have indirect
+\autopageref{desc:maincls.option.listof}). Moreover, the options
+\OptionValue{listof}{totoc} and \OptionValue{listof}{numbered} have indirect
influence (see \autoref{sec:maincls.tocOptions},
-\autopageref{desc:maincls.option.liststotoc}).
+\autopageref{desc:maincls.option.listof.totoc}).
\begin{Explain}
The text of the titles of this tables are stored in the macros
@@ -2414,8 +2389,8 @@ version~2.97e (see option \Option{version},
this creates a confusion with chapter numbers! The use of
\Macro{addsec} and \Macro{section*} (see
\autoref{sec:maincls.structure},
-\autopageref{desc:maincls.macro.section*} and
-\autopageref{desc:maincls.macro.addsec}) are thus, in the author's
+\autopageref{desc:maincls.cmd.section*} and
+\autopageref{desc:maincls.cmd.addsec}) are thus, in the author's
opinion, far more preferable.
As of version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}} the numbering
@@ -2440,7 +2415,7 @@ 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}.
+\autopageref{desc:maincls.cmd.pagenumbering}.
%
\EndIndex{Cmd}{frontmatter}%
\EndIndex{Cmd}{mainmatter}%
@@ -2481,7 +2456,7 @@ parts. This means that the chapter level (in \Class{scrbook} or
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
+\autopageref{desc:maincls.cmd.setpartpreamble}) is set on a separate
page.
\Macro{chapter} \OnlyAt{\Class{scrartcl}} only exists in book or
@@ -2504,7 +2479,7 @@ Please note that \Macro{part} and \Macro{chapter} in classes
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}).
+\autopageref{desc:maincls.cmd.titlepagestyle}).
\BeginIndex[indexother]{}{font}%
\BeginIndex[indexother]{}{font>size}%
@@ -2521,9 +2496,9 @@ followed by a specific element for every section level (see
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
+depends on the options \OptionValue{headings}{big}, \OptionValue{headings}{normal}
+and \OptionValue{headings}{small} (see \autoref{sec:maincls.fontOptions},
+\autopageref{desc:maincls.option.headings}). The defaults are
listed in \autoref{tab:maincls.structureElementsFont}
%
\begin{table}
@@ -2535,7 +2510,7 @@ listed in \autoref{tab:maincls.structureElementsFont}
\toprule
class option & element & default\\
\midrule
- \Option{bigheadings}
+ \OptionValue{headings}{big}
& \FontElement{part}\IndexFontElement{part}
& \Macro{Huge} \\
& \FontElement{partnumber}\IndexFontElement{partnumber}
@@ -2553,7 +2528,7 @@ listed in \autoref{tab:maincls.structureElementsFont}
& \Macro{normalsize} \\
& \FontElement{subparagraph}\IndexFontElement{subparagraph}
& \Macro{normalsize} \\[1ex]
- \Option{normalheadings}
+ \OptionValue{headings}{normal}
& \FontElement{part} & \Macro{huge} \\
& \FontElement{partnumber} & \Macro{huge} \\
& \FontElement{chapter} & \Macro{LARGE} \\
@@ -2562,7 +2537,7 @@ listed in \autoref{tab:maincls.structureElementsFont}
& \FontElement{subsubsection} & \Macro{normalsize} \\
& \FontElement{paragraph} & \Macro{normalsize} \\
& \FontElement{subparagraph} & \Macro{normalsize} \\[1ex]
- \Option{smallheadings}
+ \OptionValue{headings}{small}
& \FontElement{part} & \Macro{LARGE} \\
& \FontElement{partnumber} & \Macro{LARGE} \\
& \FontElement{chapter} & \Macro{Large} \\
@@ -2577,7 +2552,7 @@ listed in \autoref{tab:maincls.structureElementsFont}
\end{table}
\begin{Example}
- Suppose you are using the class option \Option{bigheadings} and
+ Suppose you are using the class option \OptionValue{headings}{big} and
notice that the very big headings of document parts are too
bold. You could change this as follows:
\begin{lstlisting}
@@ -2689,7 +2664,7 @@ Please note that \Macro{part} and \Macro{chapter} change the page
style for one page. The applied style is defined in the macros
\Macro{partpagestyle} and \Macro{chapterpagestyle} in {\KOMAScript}
(see \autoref{sec:maincls.pageStyle},
-\autopageref{desc:maincls.macro.titlepagestyle}).
+\autopageref{desc:maincls.cmd.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
@@ -2750,7 +2725,7 @@ 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}).
+\autopageref{desc:maincls.cmd.titlepagestyle}).
As for the possibilities of font switching\ChangedAt{v2.8p}{%
\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, %
@@ -2912,7 +2887,7 @@ 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}, dots in section
+\autopageref{desc:maincls.option.numbers}, 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
@@ -2951,10 +2926,10 @@ 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
+\OptionValue{numbers}{enddot} and \OptionValue{numbers}{noenddot} and optionally
depart from the rules. More details concerning class options can be
found in \autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.pointlessnumbers}.
+\autopageref{desc:maincls.option.numbers}.
An additional possibility could be to place the section numbers in the
left margin in such a way that the heading text is left aligned with
@@ -2999,11 +2974,11 @@ redefine other commands. Using the layout option
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.
+option \OptionValue{chapterprefix}{false} 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.
+\OptionValue{chapterprefix}{false} have no effect.
Since chapters only exist in the classes \Class{scrbook} and
\Class{scrreprt} these commands only exist in these classes.
@@ -3138,10 +3113,10 @@ or \Macro{addchap} command.
\end{lstlisting}
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
+\autopageref{desc:maincls.option.headings}) and the options for
the \Environment{abstract} environment\IndexEnv{abstract} (see
\autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.abstracton}), the result would look
+\autopageref{desc:maincls.option.abstract}), the result would look
similar to:
\begin{ShowOutput}\centering
{\LARGE\usekomafont{disposition} Part III.\par\vspace{20pt}}
@@ -3162,7 +3137,7 @@ Please note that it is \emph{you} who is responsible for the spaces
between the heading, preamble and the following text. Please note also
that there is no \Environment{abstract} environment in the class
\Class{scrbook} (see \autoref{sec:maincls.titles},
-\autopageref{desc:maincls.environment.abstract}).
+\autopageref{desc:maincls.env.abstract}).
The\ChangedAt{v2.8p}{\Class{scrbook}\and\Class{scrreprt}} first
optional argument \PName{position} determines the position at which
@@ -3551,12 +3526,6 @@ redefined using \Macro{renewcommand}. Every item is introduced with
\end{itemize}
\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 cars
@@ -4074,7 +4043,7 @@ 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}.
+\autopageref{desc:maincls.cmd.ifthispageodd}.
%
\EndIndex{Env}{addmargin}%
@@ -4203,10 +4172,10 @@ 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
+\OptionValue{captions}{tableheading} and
+\OptionValue{captions}{tablesignature} (see
\autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.tablecaptionabove}). For
+\autopageref{desc:maincls.option.captions.tableheading}). For
compatibility reasons the default behaviour of \Macro{caption} used
with tables is similar to \Macro{captionbelow}.
%
@@ -4257,9 +4226,9 @@ with tables is similar to \Macro{captionbelow}.
\end{tabular}
\end{ShowOutput}
Since you want all your tables typeset with captions above, you could
- of course use the option \Option{tablecaptionabove} instead (see
+ of course use the option \OptionValue{captions}{tableheading} instead (see
\autoref{sec:maincls.formattingOptions},
- \autopageref{desc:maincls.option.tablecaptionabove}). Then you can use
+ \autopageref{desc:maincls.option.captions.tableheading}). Then you can use
\Macro{caption} as you would in the standard classes. You will get
the same result as with \Macro{captionabove}.
\end{Example}
@@ -4275,7 +4244,7 @@ with tables is similar to \Macro{captionbelow}.
\Macro{captionbelow} are so implemented that changes have an effect
on both of these commands as well.
- \phantomsection\label{desc:maincls.macro.caption.longtable}%
+ \phantomsection\label{desc:maincls.cmd.caption.longtable}%
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
@@ -4577,10 +4546,10 @@ 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
+\OptionValue{captions}{oneline} and \OptionValue{captions}{nooneline}. For details
please refer to the explanations of these options in
\autoref{sec:maincls.layoutOptions},
-\autopageref{desc:maincls.option.noonelinecaption}.
+\autopageref{desc:maincls.option.captions.nooneline}.
\begin{Example}
For the examples please refer to
@@ -4701,9 +4670,9 @@ double-sided layout. In case of
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
+option \OptionValue{captions}{nooneline} (see
\autoref{sec:maincls.layoutOptions},
-\autopageref{desc:maincls.option.noonelinecaption}) for the captions
+\autopageref{desc:maincls.option.captions.nooneline}) for the captions
which are typeset with this margin setting.
\begin{Explain}
@@ -4868,7 +4837,7 @@ support to produce an example figure with a greater vertical height.
\end{Declaration}
\BeginIndex{Cmd}{textsubscript}%
In \autoref{sec:maincls.footnotes},
-\autopageref{desc:maincls.macro.textsuperscript}, the command
+\autopageref{desc:maincls.cmd.textsuperscript}, the command
\Macro{textsuperscript}\IndexCmd{textsuperscript} was already
introduced as an integral part of the {\LaTeX} kernel. Unfortunately,
{\LaTeX} itself does not offer a command to produce text in
@@ -4946,9 +4915,9 @@ introduced with \Macro{appendix}. This command switches, among other
things, the chapter numbering to upper case letters, also ensuring
that the rules according to \cite{DUDEN} are followed (for
German-speaking regions). These rules are explained in more detail in
-the description of the class options \Option{pointednumbers} and
-\Option{pointlessnumbers} in \autoref{sec:maincls.formattingOptions},
-\autopageref{desc:maincls.option.pointlessnumbers}.
+the description of the class options \OptionValue{numbers}{enddot} and
+\OptionValue{numbers}{noenddot} in \autoref{sec:maincls.formattingOptions},
+\autopageref{desc:maincls.option.numbers}.
Please note that \Macro{appendix} is a command, \emph{not} an
environment! This command does not expect any argument. Sectioning in
@@ -4968,7 +4937,7 @@ There is a peculiarity within the \Macro{appendix} command in the
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
+options \Option{appendixprefix} and \OptionValue{appendixprefix}{false} (see
\autoref{sec:maincls.layoutOptions},
\autopageref{desc:maincls.option.appendixprefix}). You should take
note of this in case you decide to define or redefine the
@@ -4981,13 +4950,13 @@ intended to prevent you from disabling options without noticing it.
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},
+ \OptionValue{chapterprefix}{false} 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
+ \Option{appendixprefix} or \OptionValue{appendixprefix}{false}, you would
define in the document preamble:
%
\begin{lstlisting}
@@ -5022,8 +4991,8 @@ intended to prevent you from disabling options without noticing it.
Redefined commands are explained in more detail in
\autoref{sec:maincls.structure},
- \autopageref{desc:maincls.macro.chapterformat} and
- \autopageref{desc:maincls.macro.chaptermarkformat}.
+ \autopageref{desc:maincls.cmd.chapterformat} and
+ \autopageref{desc:maincls.cmd.chaptermarkformat}.
\end{Example}
%
\EndIndex{Cmd}{appendixmore}%
@@ -5033,19 +5002,18 @@ intended to prevent you from disabling options without noticing it.
\Macro{setbibpreamble}\Parameter{preamble}
\end{Declaration}%
\BeginIndex{Cmd}{setbibpreamble}%
-The command \Macro{setbibpreamble} can be used to set a preamble for
-the bibliography\Index{bibliography}. This can be achieved by placing
-the preamble before the command for issuing the bibliography.
-However, it 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}).
+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
+\OptionValue{bibliography}{totoc} and
+\OptionValue{bibliography}{totocnumbered}, this command can only be successful
+if you have not loaded a package which prevents this by redefining the
+\Environment{thebibliography} environment. Even though the \Package{natbib}
+package \IndexPackage{natbib} makes unauthorized use of internal macros of
+{\KOMAScript} it could be achieved that \Macro{setbibpreamble} works with the
+current version of \Package{natbib} (see \cite{package:natbib}).
\begin{Example}
You want to point out that the sorting of the references in the
@@ -5088,7 +5056,7 @@ numbers in different ways.
Please note that the page style of the first page of the index is
changed. The applied page style is defined in the macro
\Macro{indexpagestyle} (see \autoref{sec:maincls.pageStyle},
-\autopageref{desc:maincls.macro.titlepagestyle}).
+\autopageref{desc:maincls.cmd.titlepagestyle}).
The production, sorting and output of the index is done by the
standard {\LaTeX} packages and additional programs. Similar to the
@@ -5143,8 +5111,8 @@ environments.
\BeginIndex{Cmd}{descfont}%
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}.%
+ the element \FontElement{descriptionlabel}, described in
+ \autoref{sec:maincls.font}.%
\EndIndex{Cmd}{descfont}%
\end{Explain}
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
index 1f9bdedb1e7..4648eb7e766 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrdatetime.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrdatetime.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex
index d55e5f98219..339936d299f 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlfile.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlfile.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
index 07ae5818839..f70e995ec42 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-2007
+% Copyright (c) Markus Kohm, 2002-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlttr2.tex
-% Copyright (c) Markus Kohm, 2002-2007
+% Copyright (c) Markus Kohm, 2002-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
@@ -45,7 +45,7 @@
%
% ============================================================================
-\ProvidesFile{scrlttr2.tex}[2007/12/17 KOMA-Script guide (chapter: scrlttr2)]
+\ProvidesFile{scrlttr2.tex}[2008/07/10 KOMA-Script guide (chapter: scrlttr2)]
\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe
Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm}
@@ -116,7 +116,7 @@ you want to use \Class{scrlttr2}, you will have to install the
perhaps also fewer optional arguments. You will see that when
discussing the \Environment{letter} environment in
\autoref{sec:scrlttr2.addressee},
- \autopageref{desc:scrlttr2.environment.letter}. The class will
+ \autopageref{desc:scrlttr2.env.letter}. The class will
automatically load the \Package{keyval} package. If you need to
supply options to the \Package{keyval} package, you should use the
\Macro{PassOptionsToPackage} command before \Macro{documentclass}.
@@ -224,55 +224,6 @@ automatically, and the class then controls the package. The necessary
options will be explained in this section.
\begin{Declaration}
- \Option{paper}=\PName{format}
-\end{Declaration}
-\BeginIndex{Option}{paper}%
-\BeginIndex{}{paper format}%
-This option defines the paper format. Theoretically, all paper formats
-known by the \Package{typearea} are supported. However, you must leave
-out the suffix \PValue{paper} when entering a value. So, for letter
-format, you would use the value \PValue{letter}. The formats of the
-ISO A, B, C, and D series must be entered in lowercase letters, e.\,g.,
-\PValue{a4} for ISO A4. See also \autoref{sec:typearea.paperTypes}.
-
-\begin{Explain}
- Although every paper size supported by \Package{typearea} can be
- used, several formats may result in unexpected results on the first
- page of a letter. That is not a conceptual problem with the class,
- but a reflection that there currently exist only parameter sets for
- ISO A4. Unfortunately, there are no general rules to calculate the
- placement of the address field and so on for arbitrary paper
- sizes. However, it is possible to define additional parameter sets
- for different paper sizes. See \autoref{sec:scrlttr2.lcoFile} for more
- information.
-
-\end{Explain}
-%
-\EndIndex{Option}{paper}%
-\EndIndex{}{paper format}%
-
-\begin{Declaration}
- \Option{BCOR}=\PName{length}\\
- \Option{DIV}=\PName{value}\\
- \Option{headlines}=\PName{count}
-\end{Declaration}
-\BeginIndex{Option}{BCOR}%
-\BeginIndex{Option}{DIV}%
-\BeginIndex{Option}{header lines}%
-The options for the divisor, the binding correction\Index{binding
- correction}, and the number of headlines will be translated directly
-into the corresponding options of the \Package{typearea} package and
-passed to it. If the options are set using \Macro{KOMAoptions} and
-not as class options, the \Macro{typearea} command from the
-\Package{typearea} package will be used instead. See
-\autoref{sec:typearea.options},
-\autopageref{desc:typearea.macro.typearea}.
-%
-\EndIndex{Option}{BCOR}%
-\EndIndex{Option}{DIV}%
-\EndIndex{Option}{header lines}%
-
-\begin{Declaration}
\Option{enlargefirstpage}
\end{Declaration}
\BeginIndex{Option}{enlargefirstpage}%
@@ -290,25 +241,12 @@ description of the pseudo-length \PLength{firstfootvpos} in
\autoref{sec:scrlttr2.firstFoot},
\autopageref{desc:scrlttr2.plength.firstfootvpos}. This option can
take the standard values for simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{false}.
%
\EndIndex{Option}{enlargefirstpage}%
-
-\begin{table}
- \centering
- \caption{Standard values for simple switches in \Class{scrlttr2}}
- \begin{tabular}{ll}
- Value & Description \\\hline\\[-1.75ex]
- \PValue{true} & activates the option \\
- \PValue{on} & activates the option \\
- \PValue{false}& deactivates the option \\
- \PValue{off} & deactivates the option \\
- \end{tabular}
- \label{tab:scrlttr2.simpleSwitchValues}
-\end{table}
-
+%
\EndIndex{}{page>layout}%
\subsection{Other Layout Options}
@@ -321,46 +259,9 @@ general. Strictly speaking, all page layout options
vice versa for some of them.
\begin{Declaration}
- \Option{mpinclude}\\
- \Option{mpexclude}
-\end{Declaration}
-\BeginIndex{Option}{mpinclude}%
-\BeginIndex{Option}{mpexclude}%
-These two options of the \Package{typearea} package should not be used
-with the \Class{scrlttr2} class, because the first page in particular
-does not take this option into account. To anticipate any complaints, a
-warning will be issued when this option is used. If you feel adventurous
-you could try how these options, especially \Option{mpinclude}, interact
-with other class options.
-%
-\EndIndex{Option}{mpinclude}%
-\EndIndex{Option}{mpexclude}%
-
-\begin{Declaration}
- \Option{twoside}
-\end{Declaration}%
-\BeginIndex{Option}{oneside}%
-From the author's point of view, double-sided letters do not make much
-sense. Therefore, the option \Option{twoside} only partially switches
-to double-sided layout. You thus get the possibility to have different
-margins on left and right pages, but this possibility is not used. So
-this option really means \emph{activate the possibilities of a
- double-sided document, but stay with the one-sided layout as far and
- as long as possible.} This option can take the standard values for
-simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
-\PValue{false}.
-%
-\EndIndex{Option}{twoside}%
-
-By the way, double-sided letters are not supported, because they seem
-entirely unreasonable.
-
-\begin{Declaration}
\Option{cleardoublepage}=\PName{style}
\end{Declaration}
-\BeginIndex{Option}{cleardoublepage}%
+\BeginIndex{Option}{cleardoublepage~=\PName{style}}%
If you want pages inserted by the \Macro{cleardoublepage} command to
just contain a page number in the header and footer, or to be empty,
this can be accomplished with this option. There are three different
@@ -381,21 +282,21 @@ styles supported that are listed at
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{cleardoublepage}%
+\EndIndex{Option}{cleardoublepage~=\PName{style}}%
\begin{Declaration}
- \Option{headsepline}\\
- \Option{footsepline}
+ \KOption{headsepline}\PName{switch}\\
+ \KOption{footsepline}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{headsepline}%
-\BeginIndex{Option}{footsepline}%
+\BeginIndex{Option}{headsepline~=\PName{switch}}%
+\BeginIndex{Option}{footsepline~=\PName{switch}}%
These two options insert a separator line below the header or above
the footer, respectively, on consecutive pages. In the terminology of
this manual, all pages of a letter except the first one are
consecutive pages. This option can take the standard values for
simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{false}. If one of the options is used without a value, like in
the declaration above, this evaluates as \PValue{true}, so the
separator line will be activated. When used as a \Macro{documentclass}
@@ -404,8 +305,8 @@ respectively, will be passed on to the \Package{typearea} package (see
\autoref{sec:typearea.options},
\autopageref{desc:typearea.option.headinclude}).
%
-\EndIndex{Option}{headsepline}%
-\EndIndex{Option}{footsepline}%
+\EndIndex{Option}{headsepline~=\PName{switch}}%
+\EndIndex{Option}{footsepline~=\PName{switch}}%
\begin{Declaration}
\Option{pagenumber}=\PName{position}
@@ -462,7 +363,7 @@ value are shown in \autoref{tab:scrlttr2.pagenumber}. Default is
\begin{Declaration}
\Option{parskip}=\PName{value}
\end{Declaration}%
-\BeginIndex{Option}{parskip}%
+\BeginIndex{Option}{parskip~=\PName{value}}%
\begin{Explain}%
Especially in letters you often encounter paragraphs marked not with
indentation of the first line, but with a vertical skip between
@@ -516,7 +417,7 @@ in \autoref{tab:scrlttr2.parskip}. Default is \PValue{false}.
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{parskip}%
+\EndIndex{Option}{parskip~=\PName{value}}%
\subsection{Font Options}
\label{sec:scrlttr2.fontOptions}
@@ -527,9 +428,9 @@ options affecting the font type would also count as font options. At
present there is only one option for font size in \Class{scrlttr2}.
\begin{Declaration}
- \Option{fontsize}=\PName{size}
+ \KOption{fontsize}\PName{size}
\end{Declaration}
-\BeginIndex{Option}{fontsize}%
+\BeginIndex{Option}{fontsize~=\PName{size}}%
Whereas in the main classes you choose the font size\Index{font>size}
for the document using the \Option{10pt}, \Option{12pt}, etc.,
options, in the \Class{scrlttr2} class the desired \PName{size} is set
@@ -537,7 +438,7 @@ using the \Option{fontsize} option. The functionality is however the
same. This option can only be used with \Macro{documentclass}, not
with \Macro{KOMAoptions}. Default is \PValue{12pt}.
%
-\EndIndex{Option}{fontsize}%
+\EndIndex{Option}{fontsize~=\PName{size}}%
\subsection{Options for Letterhead and Address}
\label{sec:scrlttr2.headoptions}
@@ -550,21 +451,21 @@ these features could already be found in the now obsolete
\Class{scrlettr} class.
\begin{Declaration}
- \Option{firsthead}
+ \KOption{firsthead}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{firsthead}%
+\BeginIndex{Option}{firsthead~=\PName{switch}}%
This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the
letterhead will be typeset at all. The option undestands the standard
values for simple keys, given
-in \autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is for the
+in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is for the
letterhead to be set.
-\EndIndex{Option}{firsthead}%
+\EndIndex{Option}{firsthead~=\PName{switch}}%
\begin{Declaration}
- \Option{fromalign}
+ \KOption{fromalign}\PName{value}
\end{Declaration}
-\BeginIndex{Option}{fromalign}%
+\BeginIndex{Option}{fromalign~=\PName{value}}%
This option defines the placement of the return address in the
letterhead of the first page. Apart from the various options for
positioning the return address in the letterhead, there is also the
@@ -612,12 +513,12 @@ explanations of the respective options. Possible values for
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{fromalign}%
+\EndIndex{Option}{fromalign~=\PName{value}}%
\begin{Declaration}
- \Option{fromrule}
+ \KOption{fromrule}\PName{value}
\end{Declaration}
-\BeginIndex{Option}{fromrule}%
+\BeginIndex{Option}{fromrule~=\PName{value}}%
This option is part of the letterhead extensions (see option
\Option{fromalign} above). It allows you to place a horizontal line
within the return address. The possible values are shown in
@@ -643,108 +544,108 @@ line, see \autoref{sec:scrlttr2.other},
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{fromrule}%
+\EndIndex{Option}{fromrule~=\PName{value}}%
\begin{Declaration}
- \Option{fromphone}
+ \KOption{fromphone}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{fromphone}%
+\BeginIndex{Option}{fromphone~=\PName{switch}}%
This option is part of the letterhead extensions (see option
\Option{fromalign} above). It defines whether the phone number will be
part of the return address. This option can take the standard values
for simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{false}.
%
-\EndIndex{Option}{fromphone}%
+\EndIndex{Option}{fromphone~=\PName{switch}}%
\begin{Declaration}
- \Option{fromfax}
+ \KOption{fromfax}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{fromfax}%
+\BeginIndex{Option}{fromfax~=\PName{switch}}%
This option is part of the letterhead extensions (see option
\Option{fromalign} above). It defines whether the facsimile number
will be part of the return address. This option can take the standard
values for simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{false}.
%
-\EndIndex{Option}{fromfax}%
+\EndIndex{Option}{fromfax~=\PName{switch}}%
\begin{Declaration}
- \Option{fromemail}
+ \KOption{fromemail}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{fromemail}%
+\BeginIndex{Option}{fromemail~=\PName{switch}}%
This option is part of the letterhead extensions (see option
\Option{fromalign} above). It defines whether the
email address will be part of the return address. This option can take
the standard values for simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}.
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is \PValue{false}.
%
-\EndIndex{Option}{fromemail}%
+\EndIndex{Option}{fromemail~=\PName{switch}}%
\begin{Declaration}
- \Option{fromurl}
+ \KOption{fromurl}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{fromurl}%
+\BeginIndex{Option}{fromurl~=\PName{switch}}%
This option is part of the letterhead extensions (see option
\Option{fromalign} above). It defines whether the
URL will be part of the return address. This option can take
the standard values for simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}.
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is \PValue{false}.
%
-\EndIndex{Option}{fromurl}%
+\EndIndex{Option}{fromurl~=\PName{switch}}%
\begin{Declaration}
- \Option{fromlogo}
+ \KOption{fromlogo}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{fromlogo}%
+\BeginIndex{Option}{fromlogo~=\PName{switch}}%
This option is part of the letterhead extensions (see option
\Option{fromalign} above). It defines whether the logo will be part of
the return address. This option can take the standard values for
simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Regarding the placement
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Regarding the placement
of the logo, see also the explanation of the option \Option{fromalign}
above. Default is \PValue{false}.
%
-\EndIndex{Option}{fromlogo}%
+\EndIndex{Option}{fromlogo~=\PName{switch}}%
\begin{Declaration}
- \Option{addrfield}
+ \KOption{addrfield}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{addrfield}%
+\BeginIndex{Option}{addrfield~=\PName{switch}}%
This option defines whether an address field will be set. Default is
to use the address field. This option can take the standard values for
simple switches, as listed in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{true}.
%
-\EndIndex{Option}{addrfield}%
+\EndIndex{Option}{addrfield~=\PName{switch}}%
\begin{Declaration}
- \Option{backaddress}
+ \KOption{backaddress}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{backaddress}%
+\BeginIndex{Option}{backaddress~=\PName{switch}}%
This option defines whether a return address for window envelopes will
be set. Default is to use the return address. If the address field is
suppressed (see option \Option{addrfield}), there will be no return
address either. This option can take the standard values for simple
-switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}.
+switches, as listed in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}.
Default is \PValue{true}.
%
-\EndIndex{Option}{backaddress}%
+\EndIndex{Option}{backaddress~=\PName{switch}}%
\begin{Declaration}
- \Option{subject}
+ \KOption{subject}\PName{value}
\end{Declaration}
-\BeginIndex{Option}{subject}%
+\BeginIndex{Option}{subject~=\PName{value}}%
This option serves two purposes: first, you can choose if your
subject\Index{subject} should have a title, given by the
\PName{subject} variable (see \autoref{tab:scrlttr2.subjectTerm},
@@ -773,12 +674,12 @@ Defaults are \PValue{beforeopening} and \PValue{untitled}.
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{subject}%
+\EndIndex{Option}{subject~=\PName{value}}%
\begin{Declaration}
- \Option{locfield}
+ \KOption{locfield}\PName{value}
\end{Declaration}
-\BeginIndex{Option}{locfield}%
+\BeginIndex{Option}{locfield~=\PName{value}}%
\Class{scrlttr2} places a field with additional sender attributes next
to the address field. This can be used, for example, for bank account
or similar additional information. Depending on the
@@ -804,12 +705,12 @@ option are shown in \autoref{tab:scrlttr2.locfield}. Default is
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{locfield}%
+\EndIndex{Option}{locfield~=\PName{value}}%
\begin{Declaration}
- \Option{foldmarks}
+ \KOption{foldmarks}\PName{value}
\end{Declaration}
-\BeginIndex{Option}{foldmarks}%
+\BeginIndex{Option}{foldmarks~=\PName{value}}%
This option activates or deactivates foldmarks\Index{foldmark} for
vertical two-, three- or four-panel folding, and a single horizontal
folding, of the letter, whereby the folding need not result in
@@ -820,8 +721,8 @@ vertical marks are configurable via pseudo-lengths (see
The user has a choice: Either one may use the standard values for
simple switches, as described in
-\autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}, to activate or
+\autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}, to activate or
deactivate at once all configured foldmarks on the left and upper
edges of the paper; or\ChangedAt{v2.97e}{\Class{scrlttr2}} one may
specify by one or more letters, as listed in
@@ -837,8 +738,8 @@ The exact placement of the fold marks for three-panel letter folding
depends on user settings, that is, the \File{lco} files (see
\autoref{sec:scrlttr2.lcoFile}). The folding need not result in
equal-sized parts. This option can take the standard values for simple
-switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+switches, as listed in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{true}, which implies setting the fold marks.
\begin{table}
\centering
@@ -874,12 +775,12 @@ switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues},
\KOMAoption{foldmarks=true,foldmarks=blmtP}
\end{lstlisting}
\end{Example}%
-\EndIndex{Option}{foldmarks}%
+\EndIndex{Option}{foldmarks~=\PName{value}}%
\begin{Declaration}
- \Option{numericaldate}
+ \KOption{numericaldate}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{numericaldate}%
+\BeginIndex{Option}{numericaldate~=\PName{switch}}%
This option toggles between the standard, language-dependent date
presentation, and a short, numerical one. {\KOMAScript} does not
provide the standard presentation. It should be defined by packages
@@ -888,18 +789,18 @@ such as \Package{german}\IndexPackage{german},
\Package{isodate}\IndexPackage{isodate}. The short, numerical
presentation, on the other hand, is produced by \Class{scrlttr2}
itself. This option can take the standard values for simple switches,
-as listed in \autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+as listed in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{false}, which results in standard date presentation. In the
now obsolete \Class{scrlettr} class, the opposite effect was achieved
using the \Option{orgdate} option.
%
-\EndIndex{Option}{numericaldate}%
+\EndIndex{Option}{numericaldate~=\PName{switch}}%
\begin{Declaration}
- \Option{refline}
+ \Option{refline}\PName{value}
\end{Declaration}
-\BeginIndex{Option}{refline}%
+\BeginIndex{Option}{refline~=\PName{value}}%
With the \Class{scrlttr2} class, the header, footer, address, and
sender attributes may extend beyond the normal type area to the left
and to the right. This option defines whether that should also apply
@@ -921,7 +822,7 @@ values for this option are shown in
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{refline}%
+\EndIndex{Option}{refline~=\PName{value}}%
%
\EndIndex{}{letter>head}\EndIndex{}{address}%
@@ -941,9 +842,9 @@ pseudo-length \PLength{firstfootvpos}\IndexPLength{firstfootvpos}
\autopageref{desc:scrlttr2.plength.firstfootvpos}).
\begin{Declaration}
- \Option{firstfoot}
+ \Option{firstfoot}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{firstfoot}%
+\BeginIndex{Option}{firstfoot~=\PName{switch}}%
This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the
letterfoot is set or not. If the letterfoot is not set then the
pseudo-length \PLength{firstfootvpos} is also ignored, and instead
@@ -954,10 +855,10 @@ pseudo-length \PLength{firstfootvpos} is also ignored, and instead
concurrently.
The option understands the standard values for simple switches, as
-given in \autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is the setting
+given in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is the setting
of the letterfoot.
-\EndIndex{Option}{firstfoot}%
+\EndIndex{Option}{firstfoot~=\PName{switch}}%
\EndIndex{}{letter>footer}
@@ -969,9 +870,9 @@ output and do not belong to another section. You might also call them
the \emph{miscellaneous options}.
\begin{Declaration}
- \Option{draft}
+ \KOption{draft}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{draft}%
+\BeginIndex{Option}{draft~=\PName{switch}}%
This option toggles between the final\Index{final version} and the
draft\Index{draft version} version of a document. In particular,
enabling the \Option{draft} option activates little black boxes that
@@ -979,13 +880,13 @@ will be drawn at the end of overfull lines. These boxes allow the
unpracticed eye to more easily identify paragraphs that need manual
intervention. When the \Option{draft} option is disabled, there will
be no such boxes. This option can take the standard values for simple
-switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues},
-\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is
+switches, as listed in \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}. Default is
\PValue{false}, as usual. However, I strongly recommend enabling the
\Option{draft} option when designing a letter, as for every other
document.
%
-\EndIndex{Option}{draft}%
+\EndIndex{Option}{draft~=\PName{switch}}%
\subsection{The Letter Class Option Files}
\label{sec:scrlttr2.lcoFile}
@@ -1084,7 +985,7 @@ loading the \File{lco} file are local to the corresponding letter.
The command \Macro{setkomavar} used above, and the principle of
variables will be explained in detail
in\autoref{sec:scrlttr2.variables},
-\autopageref{desc:scrlttr2.macro.setkomavar}. In the example given
+\autopageref{desc:scrlttr2.cmd.setkomavar}. In the example given
here, knowledge of the exact function of the command is not
critical. It is only important to note what can be done with
\File{lco} files, less so exactly how this might be
@@ -1370,7 +1271,7 @@ page styles.
macro \Macro{opening}\IndexCmd{opening} (see
\autoref{sec:scrlttr2.firstHead}, \autoref{sec:scrlttr2.firstFoot},
as well as \autoref{sec:scrlttr2.opening},
- \autopageref{desc:scrlttr2.macro.opening}).
+ \autopageref{desc:scrlttr2.cmd.opening}).
\item[plain] is the page style with only page numbers in the header or
footer on subsequent pages. The placement of these page numbers is
@@ -1393,7 +1294,7 @@ page styles.
this end, the commands \Macro{markboth} and \Macro{markright} are
available as usual, and with the use of package \Package{scrpage2}
also \Macro{markleft} (see \autoref{sec:scrpage.basics.mark},
- \autopageref{desc:scrpage.macro.automark}) is available.
+ \autopageref{desc:scrpage.cmd.automark}) is available.
\item[myheadings] is the page style for manual page headings on
subsequent pages. This is very similar to \PValue{headings}, but
@@ -1452,7 +1353,7 @@ look at the example in \autoref{sec:maincls.pageStyle},
\BeginIndex{Cmd}{cleardoubleplainpage}%
\BeginIndex{Cmd}{cleardoubleemptypage}%
Please refer to \autoref{sec:maincls.pageStyle},
-\autopageref{desc:maincls.macro.clearpage}. The function
+\autopageref{desc:maincls.cmd.clearpage}. The function
of \Macro{cleardoublepage} in \Class{scrlttr2} depends on the
option \Option{cleardoublepage} which is described in more detail
in \autoref{sec:scrlttr2.layout},
@@ -2005,19 +1906,20 @@ letters. As illustrated in \autoref{fig:scrlttr2.document}, a letter
document consists of a preamble, the individual letters, and the
closing.
-The preamble comprises all settings that in general concern all
-letters. Most of them can also be overwritten in the settings of the
-individual letters. The only setting which can not be changed within a
-single letter is the font size (see option \Option{fontsize} in
-\autoref{sec:scrlttr2.fontOptions},
-\autopageref{desc:scrlttr2.option.fontsize}). It is recommended that
-only general settings such as the loading of packages and the setting
-of options be placed before \Macro{begin}\PParameter{document}. All
-settings that comprise the setting of variables or other text features
-should be done after \Macro{begin}\PParameter{document}. This is
-particularly recommended when the \Package{babel}
-package\IndexPackage{babel} (see \cite{package:babel}) is used, or
-language-dependent variables of \Class{scrlttr2} are to be changed.
+The preamble comprises all settings that in general concern all letters. Most
+of them can also be overwritten in the settings of the individual letters. The
+only setting which can not be changed within a single letter is compatibility
+to prior versions of \Class{scrlttr2} (see option \Option{version} in
+\autoref{sec:scrlttr2.compatibilityOptions},
+\autopageref{desc:scrlttr2.option.version}).
+
+It is recommended that only general settings such as the loading of packages
+and the setting of options be placed before
+\Macro{begin}\PParameter{document}. All settings that comprise the setting of
+variables or other text features should be done after
+\Macro{begin}\PParameter{document}. This is particularly recommended when the
+\Package{babel} package\IndexPackage{babel} (see \cite{package:babel}) is
+used, or language-dependent variables of \Class{scrlttr2} are to be changed.
The closing usually consists only of
\Macro{end}\PParameter{document}. Of course you can also insert
@@ -2407,7 +2309,7 @@ e.\,g., letterhead width or an optional logo. Users can adjust rule
length manually in their own \File{lco} files by setting this
pseudo-length to positive values using \Macro{\@setplength} (see
\autoref{sec:scrlttr2.pseudoLength},
-\autopageref{desc:scrlttr2.macro.@setplength}). The default
+\autopageref{desc:scrlttr2.cmd.@setplength}). The default
thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}},
\PLength{fromrulethickness}, is 0.4\Unit{pt}.
%
@@ -3373,7 +3275,7 @@ as \Macro{centering} (all besides \Option{KOMAold}) or
flush-right or flush-left alignment inside the box, the command can be
redefined in the same way as \Macro{raggedsection} (see
\autoref{sec:maincls.structure},
-\autopageref{desc:maincls.macro.raggedsection}).
+\autopageref{desc:maincls.cmd.raggedsection}).
Between closing phrase and signature a vertical space is inserted, the
height of which is defined in the pseudo-length
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex
index 2fc696e23e9..c4e50978f5e 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrpage2.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrpage2.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
@@ -45,7 +45,7 @@
%
% ============================================================================
-\ProvidesFile{scrpage2.tex}[2007/12/07 KOMA-Script guide (chapter:scrpage2)]
+\ProvidesFile{scrpage2.tex}[2008/07/10 KOMA-Script guide (chapter:scrpage2)]
\translator{Jens-Uwe Morawski\and Karl-Heinz Zimmer\and Christoph Bier\and
Gernot Hassenpflug\and Markus Kohm}
@@ -405,7 +405,7 @@ regard the proper assignment to left or right page.
This command returns the formatted page number. The formatting can be
controlled by \Macro{pnumfont}, introduced in
\autoref{sec:scrpage.basics.format},
-\autopageref{desc:scrpage.macro.pnumfont}, which \Macro{pagemark}
+\autopageref{desc:scrpage.cmd.pnumfont}, which \Macro{pagemark}
heeds automatically. Alternatively, \Macro{setkomafont} can be used if
a {\KOMAScript} class is used (see \autoref{sec:maincls.font}).
% the last describtion \setkomafont ... is only fill-text
@@ -941,7 +941,7 @@ This option ensures that the optional parameter of
\Macro{automark}\IndexCmd{automark} will be ignored automatically in
one-sided mode. See also the explanation of the command
\Macro{automark} in \autoref{sec:scrpage.basics.mark},
-\autopageref{desc:scrpage.macro.automark}.
+\autopageref{desc:scrpage.cmd.automark}.
\EndIndex{Option}{autooneside}
\BeginIndex{Option}{komastyle}\BeginIndex{Option}{standardstyle}
@@ -1181,7 +1181,7 @@ structure. The individual parameters have the following meanings:
If the optional line-parameters are omitted, then the line behaviour
remains configurable by the commands introduced in
\autoref{sec:scrpage.basics.format},
-\autopageref{desc:scrpage.macro.setheadtopline}.
+\autopageref{desc:scrpage.cmd.setheadtopline}.
The three elements \PName{EP}, \PName{OP} and \PName{OS} are boxes
with the width of page header or footer, as appropriate. The
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
new file mode 100644
index 00000000000..ff2ce71356f
--- /dev/null
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
@@ -0,0 +1,588 @@
+%%
+%% This is file `tocbasic.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% tocbasic.dtx (with options: `doc')
+%%
+%% Copyright (c) 2007-2008
+%% Markus Kohm and any individual authors listed elsewhere in this file.
+%%
+%% This file was generated from file(s) of the KOMA-Script bundle.
+%% ---------------------------------------------------------------
+%%
+%% This work may be distributed and/or modified under the conditions of
+%% the LaTeX Project Public License, version 1.3b of the license.
+%% The latest version of this license is in
+%% http://www.latex-project.org/lppl.txt
+%% and version 1.3b or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later and of this work.
+%%
+%% This work has the LPPL maintenance status "author-maintained".
+%%
+%% The Current Maintainer and author of this work is Markus Kohm.
+%%
+%% This file may only be distributed together with the files
+%% `scrlogo.dtx' and `tocbasic.dtx'. You may however distribute the files
+%% `scrlogo.dtx' and `tocbasic.dtx' without this file.
+%% See also `tocbasic.dtx' for additional information.
+%%
+%% If this file is a beta version, you are not allowed to distribute it.
+%%
+%% Currently there is only a short english manual at `tocbasic.dtx', that
+%% should also be found as `tocbasic.pdf'.
+%%
+%% The KOMA-Script bundle (but maybe not this file) was based upon the
+%% LaTeX2.09 Script family created by Frank Neukam 1993 and the LaTeX2e
+%% standard classes created by The LaTeX3 Project 1994-1996.
+%%
+%%% From File: tocbasic.dtx
+\def\tocbasicversion{2008/10/06 v1.0}
+\ProvidesFile{tocbasic.tex}
+ [\tocbasicversion
+ (manual)%
+ ]
+
+\chapter{Package \Package{tocbasic} for Class and Package Authors}
+\labelbase{tocbasic}
+
+\textsc{Note: This is only a short version of the documentation. The german
+ \KOMAScript{} guide does contain a long version with usefull examples, that
+ should also be translated!}
+
+If a package creates it's list ``list of something''---something like ``list
+of figures'', ``list of tables'', ``list of listings'', ``list of
+algorithms'', etc. also known as \emph{toc-files}---have to do some
+operations, that are equal for all those packages. Also it may be usefull
+for classes and other packages to know about these additional
+toc-files. This packages implements some basic functionality for all those
+packages. Using this package will also improve compatibility with
+\KOMAScript{} and---let us hope---other classes and packages.
+
+\section{Legal Note}
+\label{sec:tocbasic.legalnote}
+
+You are allowed to destribute this part of \KOMAScript{} without the main
+part of \KOMAScript{}. The files ``\File{scrlogo.dtx}'' and
+``\File{tocbasic.dtx}'' may be distributed together under the conditions
+of the \LaTeX{} Project Public License, either version~1.3b of this license
+or (at your option) any later version.
+
+The latest version of this license is in
+\mbox{http://www.latex-project.org/lppl.txt} and version~1.3b or later is
+part of all distributions of \LaTeX{} version~2005/12/01 or later.
+
+
+\section{Using Package \Package{tocbasic}}
+\label{sec:tocbasic.usage}
+
+This package was made to be used by class and package authors. Because of
+this the package has no options. If different packages would load it with
+different options a option clash would be the result. So using options
+would'nt be a good idea.
+
+There are two kind of commands. The first kind are basic command. Those
+are used to inform other packages about the extensions used for files that
+represent a list of something. Classes or packages may use this information
+e.g, for putting something to every of those files. Packages may also ask,
+if an extension is already in use. This does even work, if \Macro{nofiles}
+was used. The second kind are commands to create the list of something.
+
+\subsection{Basic Commands}
+\label{sec:tocbasic.basics}
+
+Basic commands are used to handle a list of all extensions known for files
+representing a list of something. Entries to such files are written using
+\Macro{addtocontents} or \Macro{addcontentsline} typically. There are also
+commands to do something for all known extensions. And there are commands to
+set or unset features of an extension or the file represented by the
+extension. Typically an extension also has an owner. This owner may be a
+class or package or a term decided by the author of the class or package
+using \Package{tocbasic}, e.g., \KOMAScript{} uses the owner \texttt{float}
+for list of figures ans list of tables and the default owner for the table of
+contents.
+
+\begin{Declaration}
+ \Macro{ifattoclist}\Parameter{extension}\Parameter{true
+ part}\Parameter{false part}
+\end{Declaration}
+\BeginIndex{Cmd}{ifattoclist}%
+This command
+may be used to ask, wether a \PName{extension} is already a known extension or
+not. If the \PName{extension} is already known the \PName{true part} will be
+used, otherwise the \PName{false part} will be used.
+\begin{Example}
+ Maybe you want to know if the extension ``\File{foo}'' is already in use to
+ report an error, if you can not use it:
+ \begin{lstlisting}
+ \ifattoclist{foo}{%
+ \PackageError{bar}{%
+ extension `foo' already in use%
+ }{%
+ Each extension may be used only
+ once.\MessageBreak
+ The class or another package already
+ uses extension `foo'.\MessageBreak
+ This error is fatal!\MessageBreak
+ You should not continue!}%
+ }{%
+ \PackageInfo{bar}{using extension `foo'}%
+ }
+ \end{lstlisting}
+\end{Example}
+\EndIndex{Cmd}{ifattoclist}%
+
+\begin{Declaration}
+ \Macro{addtotoclist}\OParameter{owner}\Parameter{extension}
+\end{Declaration}
+\BeginIndex{Cmd}{addtotoclist}%
+This command
+adds the \PName{extension} to the list of known extensions. If the optional
+argument, \OParameter{owner}, was given this \PName{owner} will be stored to
+be the owner of the \PName{extension}. If you omit the optional argument,
+\Package{tocbasic} tries to find out the filename of the current processed
+class or package and stores this as owner. This will fail if
+\Macro{addtotoclist} was not used, loading a class or package but using a
+command of a class or package after loading this class or package. In this
+case the owner will be set to ``\PValue{.}''. Note that an empty
+\PName{owner} is not the same like omitting the optional argument, but an
+empty owner.
+
+\begin{Example}
+ You want to add the extension ``\File{foo}'' to the list of known extension,
+ while loading your package with file name ``\File{bar.sty}'':
+ \begin{lstlisting}
+ \addtotoclist{foo}
+ \end{lstlisting}%
+ This will add the extension ``\PValue{foo}'' with owner ``\PValue{bar.sty}''
+ to the list of known extensions, if it was not already at the list of known
+ extensions. If the class or another package already added the extension you
+ will get the error:
+ \begin{lstlisting}
+ Package tocbasic Error: file extension `#2' cannot be used twice
+
+ See the tocbasic package documentation for explanation.
+ Type H <return> for immediate help.
+ \end{lstlisting}
+ and after typing \texttt{H <return>} you will get the help:
+ \begin{lstlisting}
+ File extension `foo' is already used by a toc-file, while bar.sty
+ tried to use it again for a toc-file.
+ This may be either an incompatibility of packages, an error at a package,
+ or a mistake by the user.
+ \end{lstlisting}
+
+ Maybe you package has a command, that creates list of files dynamically. In
+ this case you should use the optional argument of \Macro{addtotoclist} to
+ set the owner.
+ \begin{lstlisting}
+ \newcommand*{\createnewlistofsomething}[1]{%
+ \addtotoclist[bar.sty]{#1}%
+ % Do something more to make this list of something available
+ }
+ \end{lstlisting}
+ If the user calls know, e.g.
+ \begin{lstlisting}
+ \createnewlistofsomething{foo}
+ \end{lstlisting}
+ this would add the extension ``\PValue{foo}'' with the owner
+ ``\PValue{bar.sty}'' to the list of known extension or report an error, if the
+ extension is already in use. You may use any owner you want. But it should
+ be unique! So, if you are the author of package \Package{float} you may
+ use for example owner ``\PValue{float}'' instead of owner
+ ``\PValue{float.sty}'', so the \KOMAScript{} options for list of figure and
+ list of table will also handle the lists of this package, that are already
+ added to the known extensions, when the option is used.
+\end{Example}
+\EndIndex{Cmd}{addtotoclist}%
+
+\begin{Declaration}
+ \Macro{AtAddToTocList}\OParameter{owner}\Parameter{commands}
+\end{Declaration}
+\BeginIndex{Cmd}{AtAddToTocList}%
+This command
+adds the \PName{commands} to a internal list of commands, that should be
+processed, if a toc-file with the given \PName{owner} will be added to the
+list of known extensions using \Macro{addtoloclist}. If you omit the optional
+argument, \Package{tocbasic} tries to find out the filename of the current
+processed class or package and stores this as owner. This will fail if
+\Macro{AtAddToTocList} was not used, loading a class or package but using a
+command of a class or package after loading this class or package. In this
+case the owner will be set to ``\PValue{.}''. Note that an empty
+\PName{owner} is not the same like omitting the optional argument. With an
+empty \PName{owner} you may add \Parameter{commands}, that will be processed
+at every succefull \Macro{addtotoclist}, after processing the commands for the
+indivdual owner. While processing the \PValue{commands}, \Macro{@currext} wil
+be set to the extension of the currently added extension.
+\begin{Example}
+\Package{tocbasic} itself uses
+\begin{lstlisting}
+ \AtAddToTocList[]{%
+ \expandafter\tocbasic@extend@babel
+ \expandafter{\@currext}%
+ }
+\end{lstlisting}
+to add every extension to the \Package{tocbasic}-internal babel handling of
+toc-files. The \Macro{expandafter} are needed, because the argument of
+\Macro{tocbasic@extend@babel} has to expanded! See the description of
+\Macro{tocbasic@extend@babel} at \autoref{sec:tocbasic.internals}%
+, \autopageref{desc:tocbasic.cmd.tocbasic@extend@babel}
+for more information.
+\end{Example}
+\EndIndex{Cmd}{AtAddToTocList}%
+
+\begin{Declaration}
+ \Macro{removefromtoclist}\OParameter{owner}\Parameter{extension}
+\end{Declaration}
+\BeginIndex{Cmd}{removefromtoclist}%
+This command
+removes the \PName{extension} from the list of known extensions. If the
+optional argument, \OParameter{owner}, was given the \PName{extension} will
+only be removed, if it was added by this \PName{owner}. If you omit the
+optional argument, \Package{tocbasic} tries to find out the filename of the
+current processed class or package and use this as owner. This will fail if
+\Macro{removefromtoclist} was not used, loading a class or package but using a
+command of a class or package after loading this class or package. In this
+case the owner will be set to ``\PValue{.}''. Note that an empty
+\PName{owner} is not the same like omitting the optional argument, but removes
+the \PName{extension} without any owner test.
+\EndIndex{Cmd}{removefromtoclist}%
+
+\begin{Declaration}
+ \Macro{doforeachtocfile}\OParameter{owner}\Parameter{commands}
+\end{Declaration}
+\BeginIndex{Cmd}{doforeachtocfile}%
+This command
+processes \PName{commands} for every known toc-file of the given
+\PName{owner}. While processing the \PName{commands} \Macro{@currext} ist the
+extension of the current toc-file for every known toc-file. If you omit the
+optional argument, \OParameter{owner}, every known toc-file will be used. If
+the optional argument is empty, only toc-files with an empty owner will be
+used.
+\begin{Example}
+ If you want to type out all known extensions, you may simply write:
+ \begin{lstlisting}
+ \doforeachtocfile{\typeout{\@currext}}
+ \end{lstlisting}
+ and if only the extensions of owner ``\PValue{foo}'' should be typed out:
+ \begin{lstlisting}
+ \doforeachtocfile[foo]{\typeout{\@currext}}
+ \end{lstlisting}
+\end{Example}
+\EndIndex{Cmd}{doforeachtocfile}%
+
+\begin{Declaration}
+ \Macro{tocbasicautomode}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasicautomode}%
+This command
+redefines \LaTeX{} kernel macro \Macro{@starttoc} to add all not yet added
+extensions to the list of known extensions and use \Macro{tocbasic@starttoc}
+instead of \Macro{@starttoc}.
+\EndIndex{Cmd}{tocbasicautomode}%
+
+\subsection{Creating a List of Something}
+\label{sec:tocbasic.more}
+
+At the previous section you've seen commands to handle a list of known
+extensions and to trigger commands while adding a new extension to this
+list. You've also seen a command to do something for all known extensions or
+all known extensions of one owner. In this section you will see commands to
+handle the file corresponding with an extension or the list of known
+extensions.
+
+\begin{Declaration}
+ \Macro{addtoeachtocfile}\OParameter{owner}\Parameter{contents}
+\end{Declaration}
+\BeginIndex{Cmd}{addtoeachtocfile}%
+This command
+writes \PName{contents} to every known toc-file of \PName{owner}. If you omit
+the optional argument, \PName{contents} it written to every known
+toc-file. While writing the contents, \Macro{@currext} is the extension of
+the currently handled toc-file.
+\begin{Example}
+ You may add a vertical space of one text line to all toc-files.
+ \begin{lstlisting}
+ \addtoeachtocfile{%
+ \protect\addvspace{\protect\baselineskip}%
+ }
+ \end{lstlisting}
+ And if you want to do this, only for the toc-files of owner
+ ``\PValue{foo}'':
+ \begin{lstlisting}
+ \addtoeachtocfile[foo]{%
+ \protect\addvspace{\protect\baselineskip}%
+ }
+ \end{lstlisting}
+\end{Example}
+\EndIndex{Cmd}{addtoeachtocfile}%
+
+\begin{Declaration}
+ \Macro{addcontentslinetoeachtocfile}\OParameter{owner}\Parameter{level}%
+ \Parameter{contentsline}
+\end{Declaration}
+\BeginIndex{Cmd}{addcontentslinetoeachtocfile}%
+This command
+is something like \Macro{addcontentsline} not only for one file, but all known
+toc-files or all known toc-files of a given owner.
+\begin{Example}
+ You are a class author and want to write the chapter entry not only to the
+ table of contents toc-file but to all toc-files, while \texttt{\#1} is the
+ title, that should be written to the files.
+ \begin{lstlisting}
+ \addcontentslinetoeachtocfile{chapter}{%
+ \protect\numberline{\thechapter}#1}
+ \end{lstlisting}
+\end{Example}
+\EndIndex{Cmd}{addcontentslinetoeachtocfile}%
+
+\begin{Declaration}
+ \Macro{listoftoc*}\Parameter{extension}
+\\
+ \Macro{listoftoc}\OParameter{list of title}\Parameter{extension}
+\end{Declaration}
+\BeginIndex{Cmd}{listoftoc*}%
+\BeginIndex{Cmd}{listoftoc}%
+This commands
+may be used to set the ``list of'' of a toc-file. The star version
+\Macro{listoftoc*} needs only one argument, the extension of the toc-file. It
+does setup the vertical and horizontal spacing of paragraphs, calls before and
+after hooks and reads the toc-file. You may use it as direct replacement of
+the \LaTeX{} kernel macro \Macro{@starttoc}.
+
+The version without star, sets the whole toc-file with title, optional table
+of contents entry, and running heads. If the optional argument
+\OParameter{list of title} was given, it will be used as title term, optional
+table of contents entry and running head. Note: If the optional argument is
+empty, this term will be empty, too! If you omit the optional argument, but
+\Macro{listof\PName{extension}name} was defined, that will be used.
+
+\begin{Example}
+ You have a new ``list of algorithms'' with extension \PValue{loa} and want to
+ show it.
+ \begin{lstlisting}
+ \listof[list of algorithm]{loa}
+ \end{lstlisting}
+ Maybe you want, that the ``list of algorithms'' will create an entry at the
+ table of contents. You may set
+ \begin{lstlisting}
+ \setuptoc{loa}{totoc}
+ \end{lstlisting}
+ But maybe the ``list of algorithms'' should not be set with a title. So you
+ may use
+ \begin{lstlisting}
+ \listof*{loa}
+ \end{lstlisting}
+ Note that in this case no entry at the table of contents will be created,
+ even if you'd used the setup command above.
+\end{Example}
+
+The default heading new following features using \Macro{setuptoc}:
+\begin{description}
+\item[\texttt{totoc}] writes the title of the list of to the table of contents
+\item[\texttt{numbered}] uses a numbered headings for the list of
+\item[\texttt{leveldown}] uses not the top level heading (e.g., \Macro{chapter}
+ with book) but the first sub level (e.g., \Macro{section} with book).
+\end{description}
+\EndIndex{Cmd}{listoftoc*}%
+\EndIndex{Cmd}{listoftoc}%
+
+\begin{Declaration}
+ \Macro{BeforeStartingTOC}\OParameter{extension}\Parameter{commands}
+\\
+ \Macro{AfterStartingTOC}\OParameter{extension}\Parameter{commands}
+\end{Declaration}
+\BeginIndex{Cmd}{BeforeStartingTOC}%
+\BeginIndex{Cmd}{AfterStartingTOC}%
+This commands
+may be used to process \PName{commands} before or after loading the toc-file
+with given \PName{extension} using \Macro{listoftoc*} or \Macro{listoftoc}. If
+you omit the optional argument (or set an empty one) the general hooks will be
+set. The general before hook will be called before the individuel one and the
+general after hook will be called after the individuel one. While calling the
+hooks \Macro{@currext} is the extension of the toc-file and should not be
+changed.
+\EndIndex{Cmd}{AfterStartingTOC}%
+\EndIndex{Cmd}{BeforeStartingTOC}%
+
+\begin{Declaration}
+ \Macro{BeforeTOCHead}\OParameter{extension}\Parameter{commands}
+\\
+ \Macro{AfterTOCHead}\OParameter{extension}\Parameter{commands}
+\end{Declaration}
+\BeginIndex{Cmd}{BeforeTOCHead}%
+\BeginIndex{Cmd}{AfterTOCHead}%
+This commands
+may be used to process \PName{commands} before or after setting the title of a
+toc-file with given \PName{extension} using \Macro{listoftoc*} or
+\Macro{listoftoc}. If you omit the optional argument (or set an empty one) the
+general hooks will be set. The general before hook will be called before the
+individuel one and the general after hook will be called after the individuel
+one. While calling the hooks \Macro{@currext} is the extension of the toc-file
+and should not be changed.
+\EndIndex{Cmd}{AfterTOCHead}%
+\EndIndex{Cmd}{BeforeTOCHead}%
+
+\begin{Declaration}
+ \Macro{listofeachtoc}\OParameter{owner}
+\end{Declaration}
+\BeginIndex{Cmd}{listofeachtoc}%
+This command
+sets all toc-files or all toc-files of the given \PName{owner} using
+\Macro{listoftoc}. You should have defined
+\Macro{listof\PName{extension}name} for each toc-file, otherwise you'll get a
+warning.
+\EndIndex{Cmd}{listofeachtoc}%
+
+\begin{Declaration}
+ \Macro{MakeMarkcase}
+\end{Declaration}
+\BeginIndex{Cmd}{MakeMarkcase}%
+This command
+will be used to change the case of the letters at the running
+head. The default is, to use \Macro{@firstofone} for \KOMAScript{} classes and
+\Macro{MakeUppercase} for all other classes. If you are the class author you
+may define \Macro{MakeMarkcase} on your own. If \Package{scrpage2} or another
+package, that defines \Macro{MakeMarkcase} will be used, \Package{tocbasci}
+will not overwrite that Definition.
+\EndIndex{Cmd}{MakeMarkcase}%
+
+\begin{Declaration}
+ \Macro{deftocheading}\Parameter{extension}\Parameter{definition}
+\end{Declaration}
+\BeginIndex{Cmd}{deftocheading}%
+This command
+defines a heading command, that will be used instead of the
+default heading using \Macro{listoftoc}. The heading command has exactly one
+argument. You may reference to that argument using \texttt{\#1} at your
+\PName{defintion}.
+\EndIndex{Cmd}{deftocheading}%
+
+\begin{Declaration}
+ \Macro{setuptoc}\Parameter{extension}\Parameter{featurelist}
+\\
+ \Macro{unsettoc}\Parameter{extension}\Parameter{featurelist}
+\end{Declaration}
+\BeginIndex{Cmd}{setuptoc}%
+\BeginIndex{Cmd}{unsettoc}%
+This commands
+set up and unset features binded to an \PName{extension}. The
+\PName{featurelist} is a comma seperated list of single
+features. \Package{tocbasic} does know following features:
+\begin{description}
+\item[\texttt{totoc}] writes the title of the list of to the table of contents
+\item[\texttt{numbered}] uses a numbered headings for the list of
+\item[\texttt{leveldown}] uses not the top level heading (e.g., \Macro{chapter}
+ with book) but the first sub level (e.g., \Macro{section} with book).
+\item[\texttt{nobabel}] prevents the extension to be added to the babel
+ handling of toc-files. To make this work, you have to set the feature
+ before adding the extension to the list of known extension.
+\end{description}
+Classes and packages may know features, too, e.g, the \KOMAScript{} classes
+know following additional features:
+\begin{description}
+\item[\texttt{chapteratlist}] activates special code to be put into the list
+ at start of a new chapter. This code may either be vertical space or the
+ heading of the chapter.
+\end{description}
+\EndIndex{Cmd}{unsettoc}%
+\EndIndex{Cmd}{setuptoc}%
+
+\begin{Declaration}
+ \Macro{iftocfeature}\Parameter{extension}\Parameter{feature}%^^A
+ \Parameter{true-part}\Parameter{false-part}
+\end{Declaration}
+\BeginIndex{Cmd}{iftocfeature}%
+This command
+may be used, to test, if a \PName{feature} was set for \PName{extension}. If
+so the \PName{true-part} will be processed, otherwise the \PName{false-part}
+will be.
+\EndIndex{Cmd}{iftocfeature}%
+
+\subsection{Internal Commands for Class and Package Authors}
+\label{sec:tocbasic.internals}
+
+Commands with prefix \Macro{tocbasic@} are internal but class and package
+authors may use them. But even if you are a class or package author you
+should not change them!
+
+\begin{Declaration}
+ \Macro{tocbasic@extend@babel}\Parameter{extension}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@extend@babel}%
+This command
+extends the babel handling of toc-files. By default babel writes language
+selections only to \PValue{toc}, \PValue{lot} and
+\PValue{lof}. \Package{tocbasic} adds every \PName{extension} added to the
+list of known extensions (see \Macro{addtotoclist}, \autoref{sec:tocbasic.basics}%
+, \autopageref{desc:tocbasic.cmd.addtotoclist}%
+) using \Macro{tocbasic@extend@babel}. Note: This should be called only once
+per \PName{extension}. \Macro{tocbasic@extend@babel} does nothing, if the
+feature \PValue{nobabel} was set for \PName{extension} before using
+\Macro{addtotoclist}.
+\EndIndex{Cmd}{tocbasic@extend@babel}%
+
+\begin{Declaration}
+ \Macro{tocbasic@starttoc}\Parameter{extension}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@starttoc}
+This command is something like the \LaTeX{} kernel macro \Macro{@starttoc},
+but does some additional settings before using \Macro{@starttoc}. It does set
+\Macro{parskip} zu zero, \Macro{parindent} to zero, \Macro{parfillskip} to
+zero plus one fil, \Macro{@currext} to the \PName{extension}, and processes
+hooks before and after reading the toc-file.
+\EndIndex{Cmd}{tocbasic@starttoc}
+
+\begin{Declaration}
+ \Macro{tocbasic@@before@hook}\\
+ \Macro{tocbasic@@after@hook}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@@before@hook}%
+\BeginIndex{Cmd}{tocbasic@@after@hook}%
+This macros
+are processed before and after loading a toc-file. If you don't use
+\Macro{listoftoc} or \Macro{listoftoc*} or \Macro{tocbasic@starttoc} to load
+the toc-file, you should call these, too. But you should not redefine them!
+\EndIndex{Cmd}{tocbasic@@before@hook}%
+\EndIndex{Cmd}{tocbasic@@after@hook}%
+
+\begin{Declaration}
+ \Macro{tocbasic@\PName{extension}@before@hook}\\
+ \Macro{tocbasic@\PName{extension}@after@hook}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@\PName{extension}@before@hook}%
+\BeginIndex{Cmd}{tocbasic@\PName{extension}@after@hook}%
+This macros
+are processed before and after loading a toc-file. If you don't use
+\Macro{listoftoc} or \Macro{listoftoc*} or \Macro{tocbasic@starttoc} to load
+the toc-file, you should call these, too. But you should not redefine them!
+The first macro is processed just before \Macro{tocbasic@@before@hook}, the
+second one just after \Macro{tocbasic@@after@hook}
+\EndIndex{Cmd}{tocbasic@\PName{extension}@after@hook}%
+\EndIndex{Cmd}{tocbasic@\PName{extension}@before@hook}%
+
+\begin{Declaration}
+ \Macro{tocbasic@listhead}\Parameter{title}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@listhead}%
+This command
+is used by \Macro{listoftoc} to set the heading of the list, either the
+default heading or the indiviually defined heading. If you define your own
+list command not using \Macro{listoftoc} you may use
+\Macro{tocbasic@listhead}. In this case you should define \Macro{@currext} to
+be the extension of the toc-file before using \Macro{tocbasic@listhead}.
+\EndIndex{Cmd}{tocbasic@listhead}%
+
+\begin{Declaration}
+ \Macro{tocbasic@listhead@\PName{extension}}\Parameter{title}
+\end{Declaration}
+\BeginIndex{Cmd}{tocbasic@listhead@\PName{extension}}%
+This command
+is used in \Macro{tocbasic@listhead} to set the individual headings, optional
+toc-entry, and running head, if it was defined. If it was not defined it will
+be defined and used in \Macro{tocbasic@listhead}.
+\EndIndex{Cmd}{tocbasic@listhead@\PName{extension}}%
+\endinput
+%%
+%% End of file `tocbasic.tex'.
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex
index 3c61c55140a..bff6f4bca40 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex
@@ -1,6 +1,6 @@
% ======================================================================
% typearea.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% typearea.tex
-% Copyright (c) Markus Kohm, 2001-2007
+% Copyright (c) Markus Kohm, 2001-2008
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3b, verteilt und/oder veraendert werden.
@@ -45,7 +45,7 @@
%
% ======================================================================
-\ProvidesFile{typearea.tex}[2007/09/27 KOMA-Script guide (chapter: typearea)]
+\ProvidesFile{typearea.tex}[2008/07/10 KOMA-Script guide (chapter: typearea)]
\translator{Markus Kohm\and Gernot Hassenpflug}
% Date of translated german file: 2006-11-29
@@ -53,6 +53,13 @@
\chapter{Construction of the Page Layout with \Package{typearea}}
\labelbase{typearea}
+\textsc{Note:} Following commands are still missing in this chapter:
+\Macro{KOMAoptions}, \Macro{KOMAoption}, \Macro{recalctypearea}.
+
+\textsc{Note:} Following options are still missing in this chapter:
+\OptionValue{BCOR}{current}, \OptionValue{twoside}{semi},
+\KOption{headheight}\PName{height}, \OptionValue{pagesize}{automedia}.
+
\section{Fundamentals of Page Layout}
\begin{Explain}
@@ -258,11 +265,60 @@ Since the \Package{typearea} package is loaded automatically when
using the {\KOMAScript} main classes, the package options can be given
as class options (see \autoref{sec:maincls.options}).
+
+\begin{Declaration}
+ \KOption{twoside}\PName{value}
+\end{Declaration}%
+\BeginIndex{Option}{twoside~=\PName{value}}%
+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
+\Macro{flushbottom}\IndexCmd{flushbottom} is used to ensure that page
+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}{twoside~=\PName{value}}%
+
+
+\begin{Declaration}
+ \KOption{twocolumn}\PName{switch}
+\end{Declaration}%
+\BeginIndex{Option}{twocolumn~=\PName{switch}}%
+These values of the option (see \autoref{tab:truefalseswitch},
+\autopageref{tab:truefalseswitch}) have the same effect like the standard
+options \Option{twocolumn} and \Option{onecolumn}. They are used to switch
+between a one-column and a two-column 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}%
+\EndIndex{Option}{twocolumn~=\PName{switch}}
+
+\begin{table}
+ \begin{minipage}{\textwidth}
+ \centering
+ \caption{Standard values for simple switches within \KOMAScript}
+ \begin{tabular}{ll}
+ Value & Description \\\hline\\[-1.75ex]
+ \PValue{true}\footnote{This value will be used also, if you use the option
+ without assigning any value.} & activates the option \\
+ \PValue{on} & activates the option \\
+ \PValue{false}& deactivates the option \\
+ \PValue{off} & deactivates the option \\
+ \end{tabular}
+ \label{tab:truefalseswitch}
+ \end{minipage}
+\end{table}
+
\begin{Declaration}
- \Option{BCOR}\PName{Correction}
+ \KOption{BCOR}\PName{Correction}
\end{Declaration}%
-\BeginIndex{Option}{BCOR}%
-With the \Option{BCOR}\PName{Correction} option you specify the
+\BeginIndex{Option}{BCOR~=\PName{value}}%
+With the \KOption{BCOR}\PName{Correction} option you specify the
absolute value of the binding correction, i.\,e., the width of the area
that is used for the binding, thus ``lost'' from the paper width.
@@ -278,11 +334,11 @@ any valid {\TeX} unit for \PName{Correction}.
would use the following commands:
\begin{lstlisting}
\documentclass[a4paper]{report}
- \usepackage[BCOR8.25mm]{typearea}
+ \usepackage[BCOR=8.25mm]{typearea}
\end{lstlisting}
or, using a {\KOMAScript} class:
\begin{lstlisting}
- \documentclass[a4paper,BCOR8.25mm]{scrreprt}
+ \documentclass[a4paper,BCOR=8.25mm]{scrreprt}
\end{lstlisting}
\end{Example}
@@ -294,13 +350,13 @@ the standard classes, you need to give the option when you load
(see \cite{latex:clsguide}) before you are loading
\Package{typearea}, this always works.
%
-\EndIndex{Option}{BCOR}
+\EndIndex{Option}{BCOR~=\PName{value}}
\begin{Declaration}
- \Option{DIV}\PName{Factor}
+ \KOption{DIV}\PName{Factor}
\end{Declaration}%
\BeginIndex{Option}{DIV}%
-\Option{DIV}\PName{Factor} defines the number of stripes the page
+\KOption{DIV}\PName{Factor} defines the number of stripes the page
is split into when the page layout is constructed. The exact
method can be found in \autoref{sec:typearea.divConstruction},
but the most important thing is this: the higher \PName{Factor}, the
@@ -309,7 +365,7 @@ bigger the resulting text area, and the smaller the margins. For
Please note that depending on your other options a very high value
for \PName{Factor} can result in problems: for instance, in
extreme cases, the running title might be outside the actual page
-area. So if you use \Option{DIV}\PName{Factor}, it is your own
+area. So if you use \KOption{DIV}\PName{Factor}, it is your own
responsibility to choose a typographically acceptable line length
and to pay attention to the other parameters.
@@ -356,7 +412,7 @@ varying \Var{DIV} factors. Font size is not taken into account.
\begin{lstlisting}
\documentclass[a4paper,twoside]{protocol}
\usepackage{bookman}
- \usepackage[DIV15]{typearea}
+ \usepackage[DIV=15]{typearea}
\end{lstlisting}
After you are done you are told that the minutes will be collected and bound
as a book at the end of the year. The binding will be a simple glue binding
@@ -367,11 +423,11 @@ accordingly and use the ISO\,9000 document class:
\begin{lstlisting}
\documentclass[a4paper,twoside]{iso9000p}
\usepackage{bookman}
- \usepackage[DIV15,BCOR12mm]{typearea}
+ \usepackage[DIV=15,BCOR=12mm]{typearea}
\end{lstlisting}
Of course, you can also use a {\KOMAScript} class here:
\begin{lstlisting}
- \documentclass[twoside,DIV15,BCOR12mm]{scrartcl}
+ \documentclass[twoside,DIV=15,BCOR=12mm]{scrartcl}
\usepackage{bookman}
\end{lstlisting}
The option \Option{a4paper} was omitted using class \Class{scrartcl},
@@ -388,18 +444,18 @@ loading \Package{typearea}, this always works.
\EndIndex{Option}{DIV}
\begin{Declaration}
- \Option{DIVcalc}\\
- \Option{DIVclassic}
+ \Option{DIV=calc}\\
+ \Option{DIV=classic}
\end{Declaration}%
-\BeginIndex{Option}{DIVcalc}%
-\BeginIndex{Option}{DIVclassic}%
+\BeginIndex{Option}{DIV~=calc}%
+\BeginIndex{Option}{DIV~=classic}%
As mentioned in \autoref{sec:typearea.divConstruction}, only
paper format A4 has fixed defaults for the \Var{DIV} value. These
are listed in \autoref{tab:typearea.div}. If you choose a
different paper format, \Package{typearea} calculates a good
\Var{DIV} value itself. Of course, you can also have it calculate
-that for A4: use \Option{DIVcalc} instead of
-\Option{DIV}\PName{Factor}. This works for all other paper formats
+that for A4: use \Option{DIV=calc} instead of
+\KOption{DIV}\PName{Factor}. This works for all other paper formats
as well. If you want to use the automatic calculation, this is
even very useful, since you can then override the defaults that
are given in a configuration file (see
@@ -419,18 +475,18 @@ are given in a configuration file (see
The classic construction method as described in
\autoref{sec:typearea.circleConstruction} can also be selected
(with the difference that a good \Var{DIV} value is chosen). In
-this case, instead of \Option{DIV}\PName{Factor} or
-\Option{DIVcalc}, use the option \Option{DIVclassic}.
+this case, instead of \KOption{DIV}\PName{Factor} or
+\Option{DIV=calc}, use the option \Option{DIV=classic}.
\begin{Example}
- In the example for \Option{DIV}\PName{Factor} which used the
+ In the example for \KOption{DIV}\PName{Factor} which used the
Bookman font, there was the problem that we needed a \Var{DIV}
value which suited the font better. As a modification of the first
example, this calculation can be left to \Package{typearea}:
\begin{lstlisting}
\documentclass[a4paper,twoside]{protocol}
\usepackage{bookman}
- \usepackage[DIVcalc]{typearea}
+ \usepackage[DIV=calc]{typearea}
\end{lstlisting}
\end{Example}
@@ -450,18 +506,18 @@ to be used. Therefore, after evaluating the options, \Package{typearea}
calculates the page layout by using the
\Macro{typearea}\OParameter{BCOR}\Parameter{DIV} command. Here,
the chosen \Var{BCOR} value is given as an optional parameter and
-\Var{DIV} as a parameter. With the option \Option{DIVcalc}, the
+\Var{DIV} as a parameter. With the option \Option{DIV=calc}, the
(normally invalid) value~\(1\) is given; with the option
-\Option{DIVclassic} the (normally invalid) value~\(3\). You can
+\Option{DIV=classic} the (normally invalid) value~\(3\). You can
also call \Macro{typearea} explicitly in the preamble.
\begin{Example}
Let us assume again that we want to calculate a good page layout for the
Bookman font. We also want to use a {\KOMAScript} class. This is possible
- using the \Macro{typearea} command with \Option{DIVcalc} = 1 as
+ using the \Macro{typearea} command with \Option{DIV=calc} = 1 as
\PName{DIV} parameter:
\begin{lstlisting}
- \documentclass[BCOR12mm,DIVcalc,twoside]{scrartcl}
+ \documentclass[BCOR=12mm,DIV=calc,twoside]{scrartcl}
\usepackage{bookman}
\typearea[12mm]{1}% same as class options above
\end{lstlisting}
@@ -471,8 +527,8 @@ also call \Macro{typearea} explicitly in the preamble.
It would be ridiculous if one had to use the
\Macro{typearea} command with some pseudo-values, while the
-\Option{DIV} option allows the use of \Option{DIVcalc} and
-\Option{DIVclassic}. Thus the \Macro{typearea} also accepts
+\Option{DIV} option allows the use of \Option{DIV=calc} and
+\Option{DIV=classic}. Thus the \Macro{typearea} also accepts
symbolic values for the parameter \PName{DIV} which are listed in
\autoref{tab:symbolicDIV}.
@@ -515,13 +571,13 @@ re-enter the current value.
{\KOMAScript} class is easy when we use symbolic parameter values for
\PName{BCOR} and \PName{DIV}:
\begin{lstlisting}
- \documentclass[BCOR12mm,DIVcalc,twoside]{scrartcl}
+ \documentclass[BCOR=12mm,DIV=calc,twoside]{scrartcl}
\usepackage{bookman}
\typearea[current]{calc}
\end{lstlisting}
If we want to use a fixed value for \Var{DIV} we can use either:
\begin{lstlisting}
- \documentclass[BCOR12mm,DIV11,twoside]{scrartcl}
+ \documentclass[BCOR=12mm,DIV=11,twoside]{scrartcl}
\usepackage{bookman}
\typearea[current]{last}
\end{lstlisting}
@@ -548,7 +604,7 @@ line spacing requires a re-calculation of page layout.
assume that binding correction needs 12\Unit{mm}. Then you might use:
\begin{lstlisting}
\documentclass[10pt,twoside,%
- BCOR12mm,DIVcalc]{scrreprt}
+ BCOR=12mm,DIV=calc]{scrreprt}
\linespread{1.25}
\typearea[current]{last}
\end{lstlisting}\IndexCmd{linespread}
@@ -560,7 +616,7 @@ line spacing requires a re-calculation of page layout.
\cite{package:setspace}):
\begin{lstlisting}
\documentclass[10pt,twoside,%
- BCOR12mm,DIVcalc]{scrreprt}
+ BCOR=12mm,DIV=calc]{scrreprt}
\usepackage{setspace}
\onehalfspacing
\typearea[current]{last}
@@ -574,7 +630,7 @@ line spacing requires a re-calculation of page layout.
this:
\begin{lstlisting}
\documentclass[10pt,twoside,%
- BCOR12mm,DIVcalc]{scrreprt}
+ BCOR=12mm,DIV=calc]{scrreprt}
\usepackage{setspace}
\onehalfspacing
\typearea[current]{last}
@@ -602,20 +658,16 @@ line spacing requires a re-calculation of page layout.
incompatibilities when we change to {\LaTeX}3.%
\end{Explain}%
\EndIndex{Cmd}{typearea}%
-\EndIndex{Option}{DIVclassic}%
-\EndIndex{Option}{DIVcalc}%
+\EndIndex{Option}{DIV~=classic}%
+\EndIndex{Option}{DIV~=calc}%
\begin{Explain}
\begin{Declaration}
- \Option{headinclude}\\
- \Option{headexclude}\\
- \Option{footinclude}\\
- \Option{footexclude}
+ \KOption{headinclude}\PName{switch}\\
+ \KOption{footinclude}\PName{switch}
\end{Declaration}%
-\BeginIndex{Option}{headinclude}%
-\BeginIndex{Option}{headexclude}%
-\BeginIndex{Option}{footinclude}%
-\BeginIndex{Option}{footexclude}%
+\BeginIndex{Option}{headinclude~=\PName{switch}}%
+\BeginIndex{Option}{footinclude~=\PName{switch}}%
So far we have discussed how the page layout is calculated and what the ratios
are between the borders and between borders and text area. However, one
important question has not been answered: What constitutes the borders? This
@@ -662,38 +714,36 @@ separation of text and header or footer, important is only the
appearance when viewed out of focus.
\end{Explain}
-The \Package{typearea} package can not make the decision whether
-or not to count headers and footers to the text body or the
-border. Options \Option{headinclude} and \Option{footinclude}
-cause the header or footer to be counted as text, options
-\Option{headexclude} and \Option{footexclude} cause them to be
-counted as border. If you are unsure about the correct setting,
-re-read above explanations. Default is usually
-\Option{headexclude} and \Option{footexclude}., but this can
-change depending on {\KOMAScript} class and {\KOMAScript} packages used
-(see \autoref{sec:maincls.options} and \autoref{cha:scrpage}).
+The \Package{typearea} package can not make the decision whether or not to
+count headers and footers to the text body or the border. Options
+\Option{headinclude} and \Option{footinclude} cause the header or footer to be
+counted as text, options \OptionValue{headinclude}{false} and
+\OptionValue{footinclude}{false} cause them to be counted as border (see
+\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}). If you are
+unsure about the correct setting, re-read above explanations. Default is
+usually \OptionValue{headinclude}{false} and
+\OptionValue{footinclude}{false}, but this can change depending on
+{\KOMAScript} class and {\KOMAScript} packages used (see
+\autoref{sec:maincls.options} and \autoref{cha:scrpage}).
%
-\EndIndex{Option}{headinclude}%
-\EndIndex{Option}{headexclude}%
-\EndIndex{Option}{footinclude}%
-\EndIndex{Option}{footexclude}%
+\EndIndex{Option}{headinclude~=\PName{switch}}%
+\EndIndex{Option}{footinclude~=\PName{switch}}%
\begin{Declaration}
- \Option{mpinclude}\\
- \Option{mpexclude}
+ \KOption{mpinclude}\PName{switch}
\end{Declaration}
-\BeginIndex{Option}{mpinclude}%
-\BeginIndex{Option}{mpexclude}%
+\BeginIndex{Option}{mpinclude~=\PName{switch}}%
Besides\ChangedAt{v2.8q}{\Class{scrbook}\and \Class{scrreprt}\and
\Class{scrartcl}} documents where the head and foot is part of the text
area, there are also documents where the margin-note area must be counted to
-the text body as well. The option \Option{mpinclude} does exactly this. The
-effect is that one width-unit of the text body is taken for the margin-note
-area. Using option \Option{mpexclude}, the default setting, then the normal
-margin is used for the margin-note area. The width of that area is one or one
-and a half width-unit, depending on whether one-sided or double-sided page layout
-has been chosen. The option \Option{mpinclude} is mainly for experts and so
-not recommended.
+the text body as well. The option \Option{mpinclude} (see
+\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}) does exactly
+this. The effect is that one width-unit of the text body is taken for the
+margin-note area. Using option \OptionValue{mpinclude}{false}, the default
+setting, then the normal margin is used for the margin-note area. The width
+of that area is one or one and a half width-unit, depending on whether
+one-sided or double-sided page layout has been chosen. The option
+\Option{mpinclude} is mainly for experts and so not recommended.
\begin{Explain}
In the cases where the option \Option{mpinclude} is used often a wider
@@ -720,22 +770,21 @@ not recommended.
\Length{textwidth} and enlarges the margin width \Length{marginparwidth} by
the same amount. Unfortunately, this can not be attended when automatic
calculation of the \PName{DIV} value is used. In contrast
- \Option{DIVcalc}\IndexOption{DIVcalc} heeds \Option{mpinclude}.
+ \Option{DIV=calc}\IndexOption{DIV~=calc} heeds \Option{mpinclude}.
\end{Explain}
%
-\EndIndex{Option}{mpinclude}%
-\EndIndex{Option}{mpexclude}%
+\EndIndex{Option}{mpinclude~=\PName{switch}}%
\begin{Declaration}
- \PName{Value}\Option{headlines}
+ \KOption{headlines}\PName{value}
\end{Declaration}%
\BeginIndex{Option}{headlines}%
We have seen how to calculate the text layout and how to specify
whether header and footer are part of the text body or the
borders. However, we still have to specify the height in
particular of the header. This is achieved with the option
-\Option{headlines}, which is preceded by the number of lines in
+\Option{headlines}, which is followed by the number of lines in
the header. \Package{typearea} uses a default of 1.25. This is a
compromise, large enough for underlined headers (see
\autoref{sec:maincls.options}) and small enough that the
@@ -751,11 +800,11 @@ special cases.
calculate an appropriate page layout:
\begin{lstlisting}
\documentclass[a4paper]{article}
- \usepackage[2.1headlines]{typearea}
+ \usepackage[headlines=2.1]{typearea}
\end{lstlisting}
If you use a {\KOMAScript} class this must be given as a class option:
\begin{lstlisting}
- \documentclass[a4paper,2.1headlines]{scrartcl}
+ \documentclass[a4paper,headlines=2.1]{scrartcl}
\end{lstlisting}
A tool that can be used to define the contents of a header with two
lines is described in \autoref{cha:scrpage}.
@@ -784,7 +833,7 @@ possible. The \Package{typearea} package offers the command
the binding correction and the width and height of the text body.
Width and position of the borders will then be calculated
automatically, taking account of the options \Option{headinclude},
-\Option{headexclude}, \Option{footinclude} and \Option{footexclude}
+\OptionValue{headinclude}{false}, \Option{footinclude} and \OptionValue{footinclude}{false}
where needed.
\begin{Example}
@@ -827,34 +876,29 @@ values. If you have to do so you may use package \Package{geometry} (see
\Index{paper format}%
The {\LaTeX} standard classes support the options \Option{a4paper},
\Option{a5paper}, \Option{b5paper}, \Option{letterpaper},
-\Option{legalpaper} and \Option{executivepaper}.
+\Option{legalpaper} and \Option{executivepaper}. These are support be
+\Package{typearea} in the same way.
+
\begin{Declaration}
- \Option{letterpaper} \\
- \Option{legalpaper} \\
- \Option{executivepaper} \\
- \Option{a\Var{X}paper} \\
- \Option{b\Var{X}paper} \\
- \Option{c\Var{X}paper} \\
- \Option{d\Var{X}paper} \\
+ \OptionValue{paper}{letter} \\
+ \OptionValue{paper}{legal} \\
+ \OptionValue{paper}{executive} \\
+ \OptionValue{paper}{a\Var{X}} \\
+ \OptionValue{paper}{b\Var{X}} \\
+ \OptionValue{paper}{c\Var{X}} \\
+ \OptionValue{paper}{d\Var{X}} \\
\Option{landscape} \\
\Macro{isopaper}\OParameter{series}\Parameter{number}
\end{Declaration}%
-\BeginIndex{Option}{letterpaper}
-\BeginIndex{Option}{legalpaper}
-\BeginIndex{Option}{executivepaper}
-\BeginIndex{Option}{a0paper}
-\BeginIndex{Option}{b0paper}
-\BeginIndex{Option}{c0paper}
-\BeginIndex{Option}{d0paper}
+\BeginIndex{Option}{paper~=\PName{size}}
\BeginIndex{Option}{landscape}
\BeginIndex{Cmd}{isopaper}%
-The three American formats are supported by \Package{typearea}
-in the same way. In addition, all ISO A-, ISO B-, ISO C- and
-ISO D-formats are supported and derived from their basic sizes A0, B0,
-C0 and D0. They may be selected directly with options
-\Option{a0paper}, \Option{a1paper} and so on. Landscape orientation is
-selected with the \Option{landscape} option just as in the standard
-classes.
+In addition to the paper formats of the standard classes, all ISO A-, ISO B-,
+ISO C- and ISO D-formats are supported and derived from their basic sizes A0,
+B0, C0 and D0. They may be selected directly with options
+\OptionValue{paper}{a0}, \OptionValue{paper}{a1} and so on. Landscape
+orientation is selected with the \Option{landscape} option just as in the
+standard classes.
Alternatively the paper size can be adjusted with the macro
\Macro{isopaper}. This however required re-calculation of the
@@ -867,35 +911,28 @@ recommend the use of \Macro{isopaper}.
will be used.
\begin{lstlisting}
\documentclass{article}
- \usepackage[headexclude,footexclude,
- a8paper,landscape]{typearea}
+ \usepackage[headinclude=false,footinclude=false,
+ paper=a8,landscape]{typearea}
\areaset{7cm}{5cm}
\pagestyle{empty}
\begin{document}
\section*{Paper Size Options}
- letterpaper, legalpaper, executivepaper, a0paper,
- a1paper \dots\ b0paper, b1paper \dots\ c0paper,
- c1paper \dots\ d0paper, d1paper \dots
+ letterpaper, legalpaper, executivepaper, a4paper,
+ a5paper, paper=a0, paper=a1 \dots\ paper=b0,
+ paper=b1 \dots\ paper=c0, paper=c1 \dots\
+ paper=d0, paper=d1 \dots
\end{document}
\end{lstlisting}
\end{Example}
-All \Option{a\Var{X}paper}, \Option{b\Var{X}paper},
-\Option{c\Var{X}paper} and \Option{d\Var{X}paper} options need
-to be given as class options when {\KOMAScript} classes are used.
-For other classes this works only if they support
-\Package{typearea}. For the standard {\LaTeX} classes these options
-need to be declared when \Package{typearea} is loaded.
-\Macro{PassOptionsToPackage} (see \cite{latex:clsguide}) works in
-both cases.
+The options \Option{a4paper},
+\Option{a5paper}, \Option{b5paper}, \Option{letterpaper},
+\Option{legalpaper} and \Option{executivepaper} need
+to be given as class options when {\KOMAScript} classes are used. The
+\Option{paper}-Option may be set using \Macro{KOMAoptions} oder
+\Macro{KOMAoption} instead.
%
-\EndIndex{Option}{letterpaper}
-\EndIndex{Option}{legalpaper}
-\EndIndex{Option}{executivepaper}
-\EndIndex{Option}{a0paper}
-\EndIndex{Option}{b0paper}
-\EndIndex{Option}{c0paper}
-\EndIndex{Option}{d0paper}
+\EndIndex{Option}{paper~=\PName{size}}
\EndIndex{Option}{landscape}
\EndIndex{Cmd}{isopaper}
@@ -1025,7 +1062,7 @@ additional paper sizes.
\BeginIndex{Cmd}{SetDIVList}%
\begin{Explain}%
The \Macro{SetDIVList} parameter was also intended for use in this
- file. Before the option \Option{DIVcalc} was introduced this was the
+ file. Before the option \Option{DIV=calc} was introduced this was the
only possibility to define \Var{DIV} values for different paper and
font sizes. This list consists of a number of values in curly
parentheses. The leftmost value is the font size, \(10\Unit{pt}\),
@@ -1115,7 +1152,7 @@ listings\,---\,as well as the bibliography and the index. The
\Package{setspace} package offers for this a special environment and its own
instructions.
-The \Package{typearea} package even with option \Option{DIVcalc}
+The \Package{typearea} package even with option \Option{DIV=calc}
calculates a very generous text area. Many conservative typographers
will state that the resulting line length is still excessive. The
calculated \Var{DIV} value may be found in the \File{log} file to the