summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex88
1 files changed, 47 insertions, 41 deletions
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
index 78f7d83d496..177077a168c 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/tocbasic.tex
@@ -6,7 +6,7 @@
%%
%% tocbasic.dtx (with options: `doc')
%%
-%% Copyright (c) 2007-2010
+%% Copyright (c) 2007-2011
%% Markus Kohm and any individual authors listed elsewhere in this file.
%%
%% This file was generated from file(s) of the KOMA-Script bundle.
@@ -38,7 +38,7 @@
%% standard classes created by The LaTeX3 Project 1994-1996.
%%
%%% From File: tocbasic.dtx
-\def\tocbasicversion{2010/10/01 v3.07a}
+\def\tocbasicversion{2011/03/23 v3.09}
\ProvidesFile{tocbasic.tex}
[\tocbasicversion\space KOMA-Script package
(manual)%
@@ -534,56 +534,62 @@ prior sections for more informations about this. The optional parameter
\PName{options} is a comma separated list of \emph{key}=\emph{value}
pairs.
\begin{description}
-\item[\normalfont\PValue{owner}=\PName{string}]\hfill\\*
- The owner as described in the sections before. If no owner was given owner
- \PValue{float} will be used.
-\item[\normalfont\PValue{type}=\PName{string}]\hfill\\*
- sets the type of the new declared list. The type will be used e.g. to
- defined a \Macro{listof}\PName{string}. If no type is set up the extension
- from the mandatory argument will be used.
-\item[\normalfont\PValue{types}=\PName{string}]\hfill\\*
- the plural of the type. If no plural was given the value of \PValue{type}
- with postfix ``s'' will be used.
-\item[\normalfont\PValue{name}=\PName{string}]\hfill\\*
- The name of an element. If no name is given, the value of \PValue{type} with
- upper case first char will be used.
-\item[\normalfont\PValue{listname}=\PName{string}]\hfill\\*
- The name of the list of foo. If not given the value of \PValue{types} with
- upper case first char prefixed by ``List of '' will be used.
-\item[\normalfont\PValue{forcenames}]\hfill\\*
- If set, the names will be even defined, if they where already defined
- before.
-\item[\normalfont\PValue{level}=\PName{number}]\hfill\\*
- The level of the entries of that list. If not given level 1 will be used
- like standard classes use for entries to list of figures or list of tables.
-\item[\normalfont\PValue{indent}=\PName{length}]\hfill\\*
- The indent value for the entries of that list. If not given, 1\,em will be
- used like standard classes use for entries to list of figures or list of
- tables.
-\item[\normalfont\PValue{hang}=\PName{length}]\hfill\\*
- The amount of the hanging indent of the entries for that list. If not given,
- 1.5\,em will be used like standard classes use for entries to list of
- figures or list of tables.
+\item[\normalfont\PValue{atbegin}=\PName{code}]\hfill\\*
+ The \PName{code} will be executed at the begin of the float or nonfloat
+ environment.
+\item[\normalfont\PValue{atend}=\PName{code}]\hfill\\*
+ The \PName{code} will be executed at the end of the float or nonfloat
+ environment.
+\item[\normalfont\PValue{counterwithin}=\PName{parent counter}]\hfill\\*
+ If you define a float or nonfloat, the captions will be numbered. You may
+ declare another counter to be the parent counter. In this case, the parent
+ counter will be set before the float counter and the float counter will be
+ reset whenever the parent counter is increased using \Macro{stepcounter}
+ oder \Macro{refstepcounter}.
\item[\normalfont\PValue{float}]\hfill\\*
If set, float environments for that type will be defined. The names of the
environments are the value of \PName{type} and for double column floats the
value of \PName{type} with postfix ``\PValue{*}''.
+\item[\normalfont\PValue{floatpos}=\PName{float positions}]\hfill\\*
+ The default floating-position of the float. If no float position was given,
+ ``tbp'' will be used like the standard classes do for figures and tables.
\item[\normalfont\PValue{floattype}=\PName{number}]\hfill\\*
The numericle float type of the defined floats. Float types with common bits
cannot be reordered. At the standard classes figures has float type 1 and
tables has float type 2. If no float type was given, 16 will be used.
-\item[\normalfont\PValue{floatpos}=\PName{float positions}]\hfill\\*
- The default floating-position of the float. If no float position was given,
- ``tbp'' will be used like the standard classes do for figures and tables.
+\item[\normalfont\PValue{forcenames}]\hfill\\*
+ If set, the names will be even defined, if they where already defined
+ before.
+\item[\normalfont\PValue{hang}=\PName{length}]\hfill\\*
+ The amount of the hanging indent of the entries for that list. If not given,
+ 1.5\,em will be used like standard classes use for entries to list of
+ figures or list of tables.
+\item[\normalfont\PValue{indent}=\PName{length}]\hfill\\*
+ The indent value for the entries of that list. If not given, 1\,em will be
+ used like standard classes use for entries to list of figures or list of
+ tables.
+\item[\normalfont\PValue{level}=\PName{number}]\hfill\\*
+ The level of the entries of that list. If not given level 1 will be used
+ like standard classes use for entries to list of figures or list of tables.
+\item[\normalfont\PValue{listname}=\PName{string}]\hfill\\*
+ The name of the list of foo. If not given the value of \PValue{types} with
+ upper case first char prefixed by ``List of '' will be used.
+\item[\normalfont\PValue{name}=\PName{string}]\hfill\\*
+ The name of an element. If no name is given, the value of \PValue{type} with
+ upper case first char will be used.
\item[\normalfont\PValue{nonfloat}]\hfill\\*
If set, a non floating environment will be defined. The name of the
environment is the value of \PName{type} with postfix ``\PValue{-}''.
-\item[\normalfont\PValue{counterwithin}=\PName{parent counter}]\hfill\\*
- If you define a float or nonfloat, the captions will be numbered. You may
- declare another counter to be the parent counter. In this case, the parent
- counter will be set before the float counter and the float counter will be
- reset whenever the parent counter is increased using \Macro{stepcounter}
- oder \Macro{refstepcounter}.
+\item[\normalfont\PValue{owner}=\PName{string}]\hfill\\*
+ The owner as described in the sections before. If no owner was given owner
+ \PValue{float} will be used.
+\item[\normalfont\PValue{type}=\PName{string}]\hfill\\*
+ sets the type of the new declared list. The type will be used e.g. to
+ defined a \Macro{listof}\PName{string}. If no type is set up the extension
+ from the mandatory argument will be used.
+\item[\normalfont\PValue{types}=\PName{string}]\hfill\\*
+ the plural of the type. If no plural was given the value of \PValue{type}
+ with postfix ``s'' will be used.
\end{description}
\subsection{Internal Commands for Class and Package Authors}