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.tex92
1 files changed, 88 insertions, 4 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 1d806429c01..9779b3e2c44 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
@@ -38,7 +38,7 @@
%% standard classes created by The LaTeX3 Project 1994-1996.
%%
%%% From File: tocbasic.dtx
-\def\tocbasicversion{2010/01/05 v3.04b}
+\def\tocbasicversion{2010/06/09 v3.06}
\ProvidesFile{tocbasic.tex}
[\tocbasicversion\space KOMA-Script package
(manual)%
@@ -80,7 +80,14 @@ part of all distributions of \LaTeX{} version~2005/12/01 or later.
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.
+wouldn't be a good idea.
+
+This package may be used by by other class and package authors. It is also
+allowed to distribute it without the main part of \KOMAScript{} (see
+section~\ref{sec:tocbasic.legalnote}. Because of this, it does not use any
+\KOMAScript{} package, that isn't allowed to be distributed without the main
+part of \KOMAScript{}, too. Currently \Package{tocbasic} does only need
+package \Package{keyval} from the graphics bundle.
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
@@ -204,7 +211,7 @@ empty owner.
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
+list of known extensions using \Macro{addtotoclist}. 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
@@ -475,11 +482,18 @@ features. \Package{tocbasic} does know following features:
\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{onecolumn}] switch to internal one column mode, if the toc
+\item[\texttt{onecolumn}] switchs to internal one column mode, if the toc
is set in internal two column mode and no \texttt{leveldown} was used.
\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.
+\item[\texttt{noprotrusion}] prevents disabling character protrusion at the
+ lists of something. Character protrusion at the lists will be disabled by
+ default if package \Package{microtype} or another package, that supports
+ \Macro{microtypesetup}, was loaded. So if you want protrusion at the lists,
+ you have to set this feature. But note, that with character protrusion
+ entries at the list may be set wrong. This is a known issue of character
+ protrusion.
\end{description}
Classes and packages may know features, too, e.g, the \KOMAScript{} classes
know following additional features:
@@ -502,6 +516,76 @@ so the \PName{true-part} will be processed, otherwise the \PName{false-part}
will be.
\EndIndex{Cmd}{iftocfeature}%
+\subsection{Generating new Lists of and new Floats}
+\label{sec:tocbasic.highlevel}
+
+There is one simple command to generate either a new list of foo or a new list
+of a new float.
+
+\begin{Declaration}
+ \Macro{DeclareNewTOC}\OParameter{options}\Parameter{extension}
+\end{Declaration}
+\BeginIndex{Cmd}{DeclareNewTOC}%
+This command
+declares at least a new list of \PName{extension}. Depending on the
+\PName{options} it may also define a new float. The mandatory argument
+\PName{extension} is the extension of the help file for that list. See the
+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{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{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{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}.
+\end{description}
+
\subsection{Internal Commands for Class and Package Authors}
\label{sec:tocbasic.internals}