path: root/Master/texmf-dist/doc/latex/caption/caption-eng.tex

% 
% This is file `caption-eng.tex'.
% 
% Copyright (C) 1994-2007 Axel Sommerfeldt (caption@sommerfee.de)
% 
% --------------------------------------------------------------------------
% 
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2003/12/01 or later.
% 
% This work has the LPPL maintenance status "maintained".
% 
% This Current Maintainer of this work is Axel Sommerfeldt.
% 
% This work consists of the files caption.ins, caption.dtx, caption2.dtx,
% and ltcaption.dtx, the derived files caption.sty, caption2.sty,
% caption3.sty, and ltcaption.sty, and the user manuals caption-deu.tex,
% caption-eng.tex, and caption-rus.tex.
% 
\NeedsTeXFormat{LaTeX2e}[1994/12/01]
\ProvidesFile{caption-eng.tex}[2007/09/22 v3.1b The caption package]
\hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up.
%\errorcontextlines=3

\documentclass{ltxdoc}
\setlength\parindent{0pt}
\setlength\parskip{\smallskipamount}

\usepackage{ifpdf}
\ifpdf
  \usepackage{mathptmx,courier}
  \usepackage[scaled=0.90]{helvet}
  \addtolength\marginparwidth{15pt}
\fi

\usepackage[USenglish]{babel}
\usepackage{longtable,setspace}

\usepackage{hypdoc}
\hypersetup{pdfkeywords={LaTeX, package, caption},pdfstartview={}}
\usepackage[listof=0,hypcap=false]{caption}[2007/09/01]

\DeclareRobustCommand*\eTeX{\texorpdfstring
  {\leavevmode\hbox{$\varepsilon$}-\TeX}%
  {e-TeX}}
\DeclareRobustCommand*\AmS{\texorpdfstring
  {{\protect\usefont{OMS}{cmsy}{m}{n}A\kern-.1667em\lower.5ex\hbox{M}\kern-.125emS}}%
  {AMS}}
\DeclareRobustCommand*\KOMAScript{\texorpdfstring
  {\textsf{K\kern.05em O\kern.05em M\kern.05em A\kern.1em-\kern.1em Script}}%
  {KOMA-Script}}
\DeclareRobustCommand*\NTG{NTG}
\DeclareRobustCommand*\SmF{SMF}

\newcommand\NEW[2]{\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}}

\usepackage{marvosym}
\makeatletter
\newcommand*\INFO{\@ifstar{\@INFO{}}{\@INFO{\vbox to \ht\strutbox}}}
\newcommand*\@INFO[1]{\MARGINSYM{#1{\Huge\Info}}}
\makeatother
\font\manual=manfnt
\newcommand*\DANGER{\MARGINSYM{\manual\char127}}
\newcommand*\MARGINSYM[1]{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{#1}}}}

\DeclareCaptionFormat{myformat1}{#1#2\\#3}
\newlength\myindention
\DeclareCaptionFormat{myformat2}{#1#2\\\hspace*\myindention#3}
\DeclareCaptionOption{myindention}{\setlength\myindention{#1}}
\DeclareCaptionFormat{reverse}{#3#2#1}
\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}
\DeclareCaptionLabelFormat{fullparens}{(\bothIfFirst{#1}{~}#2)}
\DeclareCaptionLabelSeparator{fill}{\hfill}

\newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}}
\newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}}
\newcommand*\purett[1]{{\upshape\mdseries\ttfamily #1}}
\let\package\puresf
\let\env\purett \let\opt\purett

\newcommand*\csmarg[1]{\texttt{\char`\{#1\char`\}}}
\newcommand*\csoarg[1]{\texttt{\char`\[#1\char`\]}}
\newcommand*\version[2][]{$v#2$}
\newcommand*\x{\discretionary{-}{}{}}
\newcommand*\xx{\discretionary{}{}{}}

\newenvironment{Options}[1]%
  {\list{}{\renewcommand{\makelabel}[1]{\texttt{##1}\hfil}%
   \settowidth{\labelwidth}{\texttt{#1\space}}%
   \setlength{\leftmargin}{\labelwidth}%
   \addtolength{\leftmargin}{\labelsep}}}%
  {\endlist}

\newenvironment{Example}%
  {\ifvmode\else\unskip\par\fi
   \minipage{\linewidth}\smallskip}%
  {\smallskip\endminipage}

\makeatletter
\newcommand\example{\@ifstar
  {\@example{belowskip=\abovecaptionskip}}%
  {\@example{}}}
\def\@example#1{%
  \@testopt{\@@example{#1}}{figure}}
\long\def\@@example#1[#2]#3#4{%
  \begingroup
    \captionsetup{#1,size=small,margin={\leftmargini,10pt},#3}%
    \captionof{#2}[]{#4}%
  \endgroup}
\makeatother

\begin{document}
\let\subsectionautorefname\sectionautorefname
\let\subsubsectionautorefname\sectionautorefname

\def\thispackage{the \package{caption} package}
\def\Thispackage{The \package{caption} package}

\newcommand\NEWfeature{\NEW{New feature}}
\newcommand\NEWdescription{\NEW{New description}}

\makeatletter
\newcommand*\Ref{\@ifstar{\@Ref\ref}{\@Ref\autoref}}
\newcommand*\@Ref[2]{#1{#2}: \textit{\nameref{#2}}}
\makeatother
\newcommand*\See[1]{\nopagebreak{\small (See #1)}}
\newcommand*\SeeUserDefined[1][]{\See{\Ref{declare}#1}}

\def\TODO{\emph{-- Some information is missing here --}}

% --------------------------------------------------------------------------- %

\GetFileInfo{caption-eng.tex}
\let\docdate\filedate
\GetFileInfo{caption.sty}

\title{Typesetting captions with the caption package\texorpdfstring{\thanks{%
         This package has version number \fileversion,
         last revised \filedate.}}{}}
\author{Axel Sommerfeldt\\
        \href{mailto:caption@sommerfee.de}{\texttt{caption@sommerfee.de}}}
\date{\docdate}
\maketitle

% --------------------------------------------------------------------------- %

\begin{abstract}
\Thispackage\ offers customization of captions
in floating environments such |figure| and |table| and cooperates with
many other packages.\footnote{A complete re-work of the user interface
done with Steven D. Cochran and Frank Mittelbach has lead to
the enhanced version $3.0$.}
\end{abstract}

\newcommand\exampletext{%
  White sand beaches. The pink smoothness of the conch shell. A sea abundant
  with possibilities. Duty-free shops filled with Europe's finest gifts and
  perfumes. Play your favorite game of golf amidst the tropical greens on one
  of the many championship courses.}

% --------------------------------------------------------------------------- %

\section*{Introduction}

Within the standard \LaTeX\ classes captions haven't received the attention
they deserve. Simply typeset as an ordinary paragraph there is no
remarkable visual difference from the rest of the text, like here:

\example*{size=normalsize,margin=0pt}{\exampletext}

There should be possibilities to change this; for example, it would be nice
if you could make the text of the caption a little bit smaller as the normal
text, add an extra margin, typeset the caption label with the same font
family and shape as your headings etc. Just like this one:

\example*{size=small,margin=10pt,labelfont=bf,labelsep=endash}{\exampletext}

You can do this easily with this package as there are many ready-to-use
caption formatting options, but you are free to define your very own stuff, too.

% --------------------------------------------------------------------------- %

\section*{Preliminary documentation}

Please note that this document is not describing all features of \thispackage\ yet.
It'll try to update it every month; the actual version can be found
\href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/caption/caption-eng.pdf}%
{here}.\par\bigskip

% --------------------------------------------------------------------------- %

\clearpage
\tableofcontents

% --------------------------------------------------------------------------- %

\clearpage
\section{Using this package}
\label{usage}

\DescribeMacro{\usepackage}
Insert
\begin{quote}
  |\usepackage|\oarg{options}|{caption}[|\texttt{\filedate}|]|
\end{quote}
into the preamble of your document, i.e.~the part of your document
between |\documentclass| and |\begin{document}|.
The options control how your captions will look like; e.g.,
\begin{quote}
  |\usepackage[margin=10pt,font=small,labelfont=bf,|\\
  |            labelsep=endash]{caption}|%
  %|[|\texttt{\filedate}|]|
\end{quote}
would result in captions looking like the second one in the introduction.

\DescribeMacro{\captionsetup}
For a later change of options \thispackage\ provides the command
\begin{quote}
  |\captionsetup|\oarg{float type}\marg{options}
\end{quote}
So
\begin{quote}
  |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}|
\end{quote}
and
\begin{quote}
  |\usepackage{caption}|\\
  |\captionsetup{margin=10pt,font=small,labelfont=bf}|
\end{quote}
are equal in their results.

It's good to know that |\captionsetup| has an effect on the current
environment only. So if you want to change settings for the
current |figure| or |table| only, just place the |\captionsetup| command
inside the |figure| or |table| right before the |\caption| command.
For example
\begin{quote}
  |\begin{figure}|\\
  |  |\ldots\\
  |  \captionsetup{singlelinecheck=off}|\\
  |  \caption{|\ldots|}|\\
  |\end{figure}|
\end{quote}
switches the single-line-check off, but only for this |figure| so all
the other captions remain untouched.

(For a description of the optional parameter \meta{float type} see
 \Ref{commands}.)

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Options}
\label{options}

\def\OptionLabel{RaggedRight}
\def\UserDefined{\ldots}

% --------------------------------------------------------------------------- %

\subsection{Formatting}
\label{formats}

\DescribeMacro{format=}
A figure or table caption mainly consists of three parts: the caption label,
which says if this object is a `Figure' or `Table' and what number is
associated with it, the caption text itself, which is normally a short
description of contents, and the caption separator which separates the text
from the label.

The \textit{caption format} determines how this information will be presented;
it is specified with the option
\begin{quote}
  |format=|\meta{format name}\quad ,
\end{quote}
having the name of the caption format as its argument.

There are two standard caption formats:
%\footnote{You have the option to
%define your own ones, too. See section \ref{declare}:
%\textit{``Do it yourself!''} for details.}

\begin{Options}{\OptionLabel}
  \item[plain]%\NEWdescription{v3.0h}
  Typesets the captions as a normal paragraph.

  \item[hang]
  Indents the caption text, so it will `hang' under the first line of the text.

  \item[\UserDefined]
  Own formats can be defined using |\DeclareCaptionFormat|.\\
  \SeeUserDefined
\end{Options}

\begin{Example}
  An example: Specifying the option
  \begin{quote}
    |format=hang|
  \end{quote}
  yields captions like this:
  \example{format=hang}{\exampletext}
\end{Example}

\DescribeMacro{indention=}
For both formats (\texttt{plain} and \texttt{hang}) you can setup an extra
indention starting at the second line of the caption. You do this with the
option
\begin{quote}
  |indention=|\meta{amount}.
\end{quote}

Two examples:

\begin{Example}
  \begin{quote}
    |format=plain,indention=.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=plain,indention=.5cm}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |format=hang,indention=-0.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,indention=-0.5cm}{\exampletext}
\end{Example}

\pagebreak[3]
\DescribeMacro{labelformat=}
With the option
\nopagebreak[3]
\begin{quote}
  |labelformat=|\meta{label format name}
\end{quote}
\nopagebreak[3]
%\NEWdescription{v3.0e}
you specify how the caption label will be typeset.
There are four standard caption label formats:

\begin{Options}{\OptionLabel}
  \item[default]
  The caption label will be typeset as specified by the document class,
  usually this means the name and the number (like \texttt{simple}).
  (This is the default behaviour.)

  \item[empty]
  The caption label will be empty. (This option makes sense when used
  together with other options like \texttt{labelsep=none}.)

  \item[simple]
  The caption label will be typeset as a name and a number.

  \item[parens]
  The number of the caption label will be typeset in parentheses.

  \item[\UserDefined]
  Own label formats can be defined using |\DeclareCaptionLabelFormat|.\\
  \SeeUserDefined
\end{Options}

\begin{Example}
  An example: Using the options
  \begin{quote}
    |labelformat=parens,labelsep=quad|
  \end{quote}
  gives captions like this one:
  \example{labelformat=parens,labelsep=quad}{\exampletext}
\end{Example}

\DescribeMacro{labelsep=}
With the option
\begin{quote}
  |labelsep=|\meta{label separator name}
\end{quote}
you specify what caption separator will be used.
You can choose one of the following:

\begin{Options}{\OptionLabel}
  \item[none]
  There is no caption separator. (This option makes sense when used
  together with other options like \texttt{labelformat=empty}.)

  \item[colon]
  The caption label and text will be separated by a colon and a space.

  \item[period]
  The caption label and text will be separated by a period and a space.

  \item[space]
  The caption label and text will be separated by a single space.

  \item[quad]
  The caption label and text will be separated by a |\quad|.

  \item[newline]
  The caption label and text will be separated by a line break (|\\|).

  \item[endash]%\NEWfeature{v3.0h}
  The caption label and text will be separated by an en-dash,
  surrounded by spaces (| -- |).

  \item[\UserDefined]
  Own separators can be defined using |\DeclareCaptionLabelSeparator|.\\
  \SeeUserDefined
\end{Options}

Three examples:
\begin{Example}
  \begin{quote}
    |labelsep=period|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{labelsep=period}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |labelsep=newline,singlelinecheck=false|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{labelsep=newline,singlelinecheck=false}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |labelsep=endash|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{labelsep=endash}{\exampletext}
\end{Example}

% --------------------------------------------------------------------------- %

\subsection{Justification}
\label{justification}

\DescribeMacro{justification=}
As addition to the caption format you could also specify a
\emph{caption justification}; it is specified with the option
\begin{quote}
  |justification=|\meta{justification name}\quad.
\end{quote}

You can choose one of the following:

\begin{Options}{\OptionLabel}
  \item[justified]
  Typesets the caption as a normal paragraph.

  \item[centering]
  Each line of the caption will be centered.

%  \item[Centering]
%  Each line of the caption will be centered, too.
%  But this time the command |\Centering| of the \package{ragged2e} package
%  will be used to achieve this. This difference is that this time the word
%  breaking algorithm of \TeX\ will work inside the caption.

  \item[centerlast]
  The last line of each paragraph of the caption text will be centered.

  \item[centerfirst]
  Only the first line of the caption will be centered.

  \item[raggedright]
  Each line of the caption will be moved to the left margin.

\iffalse
  \item[RaggedRight]
  Each line of the caption will be moved to the left margin using
  the command |\RaggedRight| from the \package{ragged2e} package.
\else
  \item[RaggedRight]
  Each line of the caption will be moved to the left margin, too.
  But this time the command |\RaggedRight| of the \package{ragged2e}
  package will be used to achieve this.\footnote{%
    The need for the \package{ragged2e} package will be detected at
    run-time, therefore you maybe need a second \LaTeX\ run if this
    option is used.}
  The main difference is that the word breaking algorithm of \TeX\ will
  work inside captions.
\fi

  \item[raggedleft]
  Each line of the caption will be moved to the right margin.

%  \item[RaggedLeft]
%  Each line of the caption will be moved to the right margin using
%  the command |\RaggedLeft| from the \package{ragged2e} package.

  \item[\UserDefined]
  Own justifications can be defined using |\DeclareCaptionJustification|.\\
  \SeeUserDefined
\end{Options}

Three examples:
\begin{Example}
  \begin{quote}
    |justification=centerlast|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{justification=centerlast}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |format=hang,justification=raggedright|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,justification=raggedright}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |labelsep=newline,justification=centering|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example*{labelsep=newline,justification=centering}{\exampletext}
\end{Example}

\DescribeMacro{singlelinecheck=}
The standard \LaTeX\ document classes (|article|, |report|, and |book|)
automatically center a caption if it fits in one single line:

\example*{}{A short caption.}

\INFO
\Thispackage\ adapts this behaviour and therefore usually
ignores the format \& justification you have set with |format=| \&
|justification=| in such case.
But you can switch this special treatment of such short captions off
with the option
\begin{quote}
  |singlelinecheck=|\meta{bool}\quad.
\end{quote}
Using |false|, |no|, |off| or |0| for \meta{bool} switches the
extra centering off:
\begin{quote}
  |singlelinecheck=false|
\end{quote}
Doing so the above short caption would look like

\begingroup
  \captionsetup{type=figure}
  \ContinuedFloat
  \example*{singlelinecheck=false}{A short caption.}
\endgroup

You switch the extra centering on again by using |true|, |yes|, |on| or |1|
for \meta{bool}. (The default is on.)

% --------------------------------------------------------------------------- %

\subsection{Fonts}
\label{fonts}

\DescribeMacro{font=}
\DescribeMacro{labelfont=}
\DescribeMacro{textfont=}
There are three font options which affects different parts of the caption:
One affecting the whole caption (|font|), one which only affects the caption
label and separator (|labelfont|) and at least one which only affects the
caption text (|textfont|).
You set them up using the options
\begin{quote}\begin{tabular}{@{}r@{}ll}
  |font=|      & \marg{font options} & ,\\
  |labelfont=| & \marg{font options} & , and\\
  |textfont=|  & \marg{font options} & .\\
\end{tabular}\end{quote}

And these are the available font options:

\begin{Options}{\OptionLabel}
  \item[scriptsize]   {\scriptsize Very small size}
  \item[footnotesize] {\footnotesize The size usually used for footnotes}
  \item[small]        {\small Small size}
  \item[normalsize]   {\normalsize Normal size}
  \item[large]        {\large Large size}
  \item[Large]        {\Large Even larger size}

  \item[up]           {\upshape Upright shape}
  \item[it]           {\itshape Italic shape}
  \item[sl]           {\slshape Slanted shape}
  \item[sc]           {\scshape Small Caps shape}

  \item[md]           {\mdseries Medium series}
  \item[bf]           {\bfseries Bold series}

  \item[rm]           {\rmfamily Roman family}
  \item[sf]           {\sffamily Sans Serif family}
  \item[tt]           {\ttfamily Typewriter family}

  \item[singlespacing]  |\singlespacing| (see \package{setspace} package)
  \item[onehalfspacing] |\onehalfspacing|
  \item[doublespacing]  |\doublespacing|

  \item[\UserDefined]
  Own font options can be defined using |\DeclareCaptionFont|.\\
  \SeeUserDefined
\end{Options}

If you use only one of these options you can omit the braces;
e.g., the options
%\begin{quote}
  |font={small}|
%\end{quote}
and
%\begin{quote}
  |font=small|
%\end{quote}
will give the same result.

Two examples:
\begin{Example}
  \begin{quote}
    |font={small,it},labelfont=bf|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{font={small,it},labelfont=bf}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |font=small,labelfont=bf,textfont=it|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{font=small,labelfont=bf,textfont=it}{\exampletext}
\end{Example}

% --------------------------------------------------------------------------- %

\subsection{Margins and further paragraph options}
\label{margins}

\DescribeMacro{margin=}
\DescribeMacro{width=}
For all captions you can specify \emph{either} an extra margin \emph{or}
a fixed width. You do this by using the options
\begin{quote}\begin{tabular}{@{}r@{}ll}
  |margin=| & \meta{amount}   & \emph{or}\\
  |width=|  & \meta{amount} & \\
\end{tabular}\end{quote}
Nevertheless what option you use, the left and right margin will be the
same.

Two examples will illustrating this:
\begin{Example}
  \begin{quote}
    |margin=10pt|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{margin=10pt}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |width=.75\textwidth|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{width=.75\textwidth}{\exampletext}
\end{Example}

\DescribeMacro{parskip=}
This option is useful for captions containing more than one paragraph.
It specifies the extra vertical space inserted between them:
\begin{quote}
  |parskip=|\meta{amount}
\end{quote}
One example:
\begin{Example}
  \begin{quote}
    |margin=10pt,parskip=5pt|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{margin=10pt,parskip=5pt}{%
    First paragraph of the caption. This one contains some test, just to
    show how these options affect the layout of the caption.\par
    Second paragraph of the caption. This one contains some text, too, to
    show how these options affect the layout of the caption.}
\end{Example}

\DescribeMacro{hangindent=}
The option
\begin{quote}
  |hangindent=|\meta{amount}
\end{quote}
is for setting up a hanging indention starting from the second line of each
paragraph. If the caption contains just a single paragraph, using this option
leads to the same result as the option |indention=| you already know about.
But if the caption contains multiple paragraphs you will notice the difference:

\begin{Example}
  \begin{quote}
    |format=hang,indention=-.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,indention=-.5cm}{%
    First paragraph of the caption. This one contains some test, just to
    show how these options affect the layout of the caption.\par
    Second paragraph of the caption. This one contains some text, too, to
    show how these options affect the layout of the caption.}
\end{Example}

\begin{Example}
  \begin{quote}
    |format=hang,hangindent=-.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,hangindent=-.5cm}{%
    First paragraph of the caption. This one contains some test, just to
    show how these options affect the layout of the caption.\par
    Second paragraph of the caption. This one contains some text, too, to
    show how these options affect the layout of the caption.}
\end{Example}

% --------------------------------------------------------------------------- %

\subsection{Styles}
\label{style}

\DescribeMacro{style=}
A suitable combination of caption options is called \emph{caption style}.
You can compare them more or less to page styles which you set up with
|\pagestyle|: The caption style provides all settings for a whole caption layout.

You switch to an already defined caption style with the option
\begin{quote}
  |style=|\meta{style name}\quad.
\end{quote}
\Thispackage\ pre-defines two styles: |base| and |default|.

\NEWfeature{v3.1}
The |base| style puts all options you already know about to values reflecting
the look of the captions when using one of the base \LaTeX\ document classes
|article|, |report|, and |book|.
This means that specifying the option
\begin{quote}
  |style=base|
\end{quote}
has the same effect as specifying all these options:
\begin{quote}
  |format=plain,labelformat=default,labelsep=colon,|\\
  |justification=justified,font=,labelfont=,|\\
  |textfont=,margin=0pt,indention=0pt,parindent=0pt|\\
  |hangindent=0pt,singlelinecheck=true|
\end{quote}
(But |justification=centering| will be set if the caption fits into a
 single line.)

In contrast the |default| style follows the default values, reflecting
the look of the captions given by the document class you actually use.
This style is selected by default and represents these options:
\begin{quote}
  |format=default,labelformat=default,labelsep=default,|\\
  |justification=default,font=default,labelfont=default,|\\
  |textfont=default,margin=0pt,indention=0pt,parindent=0pt|\\
  |hangindent=0pt,singlelinecheck=true|
\end{quote}
(But |justification=centering| and |format=plain| will be set if the
 caption fits into a single line.)

So if you use one of the base \LaTeX\ document classes,
both |base| and |default| point to the nearly same settings.

\emph{Note:} Own caption styles can be defined using |\DeclareCaptionStyle|.
\SeeUserDefined

% --------------------------------------------------------------------------- %

\subsection{Skips}
\label{skips}

\DescribeMacro{aboveskip=}
\DescribeMacro{belowskip=}
The vertical spaces above and below the caption are controlled by the skips
|\abovecaptionskip| and |\belowcaptionskip|. The standard \LaTeX\ document
classes |article|, |report| and |book| set |\abovecaptionskip| to |10pt|
and |\belowcaptionskip| to |0pt|, other document classes may use other values.

\pagebreak[3]
Both skips can be changed with the command |\setlength|, but you can
use these options, too:
\nopagebreak[3]
\begin{quote}\begin{tabular}{@{}r@{}ll}
  |aboveskip=| & \meta{amount} & and\\
  |belowskip=| & \meta{amount} & .\\
\end{tabular}\end{quote}

\DescribeMacro{position=}
Using |\abovecaptionskip| and |\belowcaptionskip| has a major design flaw:
If the caption is typeset \emph{above} (and not \emph{below}) the figure
or table they are not set up very useful at default, because there will be
some extra space above the caption but no space between the caption and the
figure or table itself. (Remember: |\belowcaptionskip| is usually set to |0pt|.)

Please compare the spacing in these small tables:
\begin{Example}
  \captionsetup{position=b}
  \begin{minipage}[c]{.5\linewidth}
%   \captionsetup{aboveskip=0pt}%
    \captionof{table}{A table}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
  \end{minipage}
  \begin{minipage}[c]{.5\linewidth}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
    \captionof{table}{A table}
  \end{minipage}
\end{Example}

But you can fix this by using the option |position=|: It specifies how the
spacing above and below the caption will be used:
\begin{quote}
  |position=top|\quad(or |position=above|)
\end{quote}
tells \thispackage\ to use the spacing useful for caption
\emph{above} the figure or table and
\begin{quote}
  |position=bottom|\quad(or |position=below|)
\end{quote}
tells \thispackage\ to use the spacing useful for captions
\emph{below} the figure or table. (The last one is the default setting
except for |longtable|s.)

So adding an extra |\captionsetup{position=top}| to the left example
table gives you proper spacing around both captions:
\begin{Example}
  \begin{minipage}[c]{.5\linewidth}
    \captionsetup{position=t}
    \captionof{table}{A table}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
  \end{minipage}
  \begin{minipage}[c]{.5\linewidth}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
    \captionsetup{position=b}
    \captionof{table}{A table}
  \end{minipage}
\end{Example}

(Technically speaking |\abovecaptionskip| and |\belowcaptionskip| will
be swapped if you specify the option |position=top|, so in both cases
|\abovecaptionskip| will be used between the caption and the figure or
table itself.)

This option is especially useful when used together with the optional
argument of the |\captionsetup| command.
\See{\Ref{commands} for details}\par
For example
\begin{quote}
  |\captionsetup[table]{position=top}|
\end{quote}
causes all captions within tables to be treated as captions \emph{above}
the table (regarding spacing around it).
\DescribeMacro{tableposition=}%\NEWfeature{v3.0a}
Because this is a very common setting \thispackage\ offers
an abbreviating option for the use with |\usepackage|:
\begin{quote}
  |\usepackage[|\ldots|,tableposition=top]{caption}|
\end{quote}
is equivalent to
\begin{quote}
  |\usepackage[|\ldots|]{caption}|\\
  |\captionsetup[table]{position=top}|
\end{quote}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Commands}
\label{commands}

\DescribeMacro{\caption}
The command
\nopagebreak[3]
\begin{quote}
  |\caption|\oarg{lst\_entry}\marg{heading}
\end{quote}
\nopagebreak[3]
typesets the caption inside a floating environment like |figure| or |table|.
Well, you already know this, but \thispackage\ offers an extension:
If you leave the argument \meta{lst\_entry} empty, no entry in the list of
figures or tables will be made. For example:
\begin{quote}
  |\caption[]{A figure without entry in the list of figures.}|
\end{quote}

\DescribeMacro{\caption*}
The \package{longtable} package defines the command |\caption*| which
typesets the caption without label and without entry in the list of tables.
An example:
\begin{quote}
  |\begin{longtable}{cc}|\\
  |  \caption*{A table}\\|\\
  |  A & B \\|\\
  |  C & D \\|\\
  |\end{longtable}|
\end{quote}
looks like
\begin{longtable}{cc}
  \caption*{A table}\\
  A & B \\
  C & D \\
\end{longtable}

This package offers this feature, too, so you can use this command now within
every floating environment like |figure| or |table|, like:
\begin{quote}
  |\begin{table}|\\
  |  \caption*{A table}|\\
  |  \begin{tabular}{cc}|\\
  |    A & B \\|\\
  |    C & D \\|\\
  |  \end{tabular}|\\
  |\end{table}|
\end{quote}

\DescribeMacro{\captionof}
\DescribeMacro{\captionof*}
Sometimes you want to typeset a caption \emph{outside} a floating environment,
putting a figure within a |minipage| for instance. For this purpose
\thispackage\ offers the command
\begin{quote}
  |\captionof|\marg{float type}\oarg{lst\_entry}\marg{heading}\quad.
\end{quote}
Note that the first argument, the \meta{float type}, is mandatory here, because
the |\captionof| command needs to know which name to put into the caption label
(e.g. ``Figure'' or ``Table'') and in which list to put the contents entry.
An example:
\begin{quote}
  |\captionof{figure}{A figure}|\\
  |\captionof{table}{A table}|
\end{quote}
typesets captions like this:
\begin{Example}
  \captionof{figure}{A figure}
  \captionsetup{belowskip=\abovecaptionskip}
  \captionof{table}{A table}
\end{Example}

The star variant |\captionof*| has the same behaviour as the |\caption*| command:
it typesets the caption without label and without entry to the list of figures
or tables.

\DANGER % \NEWdescription{v3.1}
Please note that you should use both |\captionof| and |\captionof*| only
\emph{inside} boxes or environments (like |\parbox| or |minipage|),
otherwise an error message will be issued.\footnote{%
This only happens if you use \eTeX\ as underlying \TeX\ engine.
Otherwise no error message will be issued, but a page break can appear
between content and caption.
Furthermore some strange effects could occur,
e.g., mixed-up figure and table settings regarding captions.}

\DescribeMacro{\captionsetup}
We already know the |\captionsetup| command (see \Ref{usage}),
but this time we get enlighten about its optional argument
\meta{float type}.

Remember, the syntax of this command is
\begin{quote}
  |\captionsetup|\oarg{float type}\marg{options}\quad.
\end{quote}

If a \meta{float type} gets specified, all the \meta{options} don't
change anything at this time. Instead they only get marked for a later use,
when a caption inside of a floating environment of the particular type
\meta{float type} gets typeset.
For example
\begin{quote}
  |\captionsetup[figure]|\marg{options}
\end{quote}
forces captions within a |figure| environment to use the given \meta{options}.

Here comes an example to illustrate this:
\begin{quote}
  |\captionsetup{font=small}|\\
  |\captionsetup[figure]{labelfont=bf}|
\end{quote}
gives captions like this:
\begin{Example}
  \captionsetup{font=small}
  \captionsetup[figure]{labelfont=bf}
  \begingroup
    \captionof{figure}{A figure}
  \endgroup
  \captionsetup{belowskip=\abovecaptionskip}
  \begingroup
    \captionof{table}{A table}
  \endgroup
\end{Example}

As you see the command |\captionsetup[figure]{labelfont=bf}| only changed
the font of the figure caption labels, not touching all other ones.

\DescribeMacro{\clearcaptionsetup}
If you want to get rid of these parameters marked for an automatic use within
a particular environment you can use the command
\begin{quote}
  |\clearcaptionsetup|\marg{float type}\quad.
\end{quote}

For example |\clearcaptionsetup{figure}| would clear the extra handling in the
example above:
\begin{Example}
  \captionsetup{font=small}
  \begingroup
    \captionof{figure}{A figure}
  \endgroup
  \captionsetup{belowskip=\abovecaptionskip}
  \begingroup
    \captionof{table}{A table}
  \endgroup
\end{Example}

As \meta{float type} you can usually give one of these two only:
|figure| or |table|.
But as we will see later some \LaTeX\ packages (like the
\package{float}, \package{longtable}, and \package{sidecap} package
for example) offer additional floating environments and these two
commands can also be used with them.

\subsection{Continued floats}
\label{ContinuedFloat}

\DescribeMacro{\ContinuedFloat}
Sometimes you want to split figures or tables without giving them
their own reference number. This is what the command
\begin{quote}
  |\ContinuedFloat|
\end{quote}
is for; it should be used as first command inside the floating environment.
It prevents the increment of the relevant counter (usually done by |\caption|)
so a figure or table with a |\ContinuedFloat| in it gets the same reference
number as the figure or table before.

An example:
\begin{quote}
  |\begin{table}|\\
  |\caption{A table}|\\
  \ldots\\
  |\end{table}|\\
  \ldots\\
  |\begin{table}\ContinuedFloat|\\
  |\caption{A table (cont.)}|\\
  \ldots\\
  |\end{table}|
\end{quote}
gives the following result:
\begin{Example}
  \captionsetup{type=table}
  \caption{A table}
  \centerline{\ldots}
  \ContinuedFloat
  \captionsetup{aboveskip=0pt}
  \caption{A table (cont.)}
\end{Example}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Own enhancements}
\label{declare}

A family of commands is provided to allow users to define their own formats.
This enables information on separators, justification, fonts, and styles to
be associated with a name and kept in one place
(these commands need to appear in the document preamble,
this is the part between |\documentclass| and |\begin{document}|).

\pagebreak[2]
\DescribeMacro{\DeclareCaptionFormat}
You can define your own caption formats using the command
\begin{quote}
  |\DeclareCaptionFormat|\marg{name}\marg{code using \#1, \#2 and \#3}\quad.
\end{quote}
At usage the system replaces \#1 with the caption label, \#2 with the
separator and \#3 with the text. So the standard format |plain| is
pre-defined by \thispackage\ as
\begin{quote}
  |\DeclareCaptionFormat{plain}{#1#2#3\par}|
\end{quote}

\DescribeMacro{\DeclareCaptionLabelFormat}
Likewise you can define your own caption label formats:
\begin{quote}
  |\DeclareCaptionLabelFormat|\marg{name}\marg{code using \#1 and \#2}
\end{quote}
At usage \#1 gets replaced with the name (e.g. ``figure'') and \#2
gets replaced with the reference number (e.g. ``12'').

\DescribeMacro{\bothIfFirst}
\DescribeMacro{\bothIfSecond}
If you define your own caption label formats and use the \package{subfig}
package\cite{subfig}, you should take care of empty caption label names.
For this purpose the commands
\begin{quote}
  |\bothIfFirst|\marg{first arg}\marg{second arg}\quad and\\
  |\bothIfSecond|\marg{first arg}\marg{second arg}
\end{quote}
are offered. |\bothIfFirst| tests if the first argument exists (means: is
not empty), |\bothIfSecond| tests if the second argument exists. If yes,
both arguments get typeset, otherwise none of them.

For example the standard label format |simple| is \emph{not} defined as
\begin{quote}
  |\DeclareCaptionLabelFormat{simple}{#1~#2}|\quad,
\end{quote}
because this could cause an extra space if \#1 is empty. Instead |simple|
is defined as
\begin{quote}
  |\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{~}#2}|\quad,
\end{quote}
causing the space to appear only if the label name is present.

\pagebreak[3]
\DescribeMacro{\DeclareCaptionLabelSeparator}
You can define your own caption label separators with
\nopagebreak[3]
\begin{quote}
  |\DeclareCaptionLabelSeparator|\marg{name}\marg{code}\quad.
\end{quote}
\nopagebreak[3]
Again an easy example taken from \thispackage\ itself:
\nopagebreak[3]
\begin{quote}
  |\DeclareCaptionLabelSeparator{colon}{: }|
\end{quote}
\pagebreak[3]

\DescribeMacro{\DeclareCaptionJustification}
You can define your own caption justifications with
\begin{quote}
  |\DeclareCaptionJustification|\marg{name}\marg{code}\quad.
\end{quote}
The \meta{code} simply gets typeset just before the caption.
E.g.~using the justification |raggedright|, which is defined as
\begin{quote}
  |\DeclareCaptionJustification{raggedright}{\raggedright}|\quad,
\end{quote}
lets captions with all lines moved to the left margin.

\DescribeMacro{\DeclareCaptionFont}
You can define your own caption fonts with
\begin{quote}
  |\DeclareCaptionFont|\marg{name}\marg{code}\quad.
\end{quote}
For example this package defines the options |small| and |bf| as
\begin{quote}
  |\DeclareCaptionFont{small}{\small}|\quad and\\
  |\DeclareCaptionFont{bf}{\bfseries}|\quad.
\end{quote}
\iffalse
The line spacing could be customized using the \package{setspace} package,
for example:%\NEWdescription{v3.0h}
\begin{quote}
  |\usepackage{setspace}|\\
  |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{%
  \emph{Note:} Using \cs{singlespacing} does not work here since it contains
  a \cs{vskip} command.}\\
  |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\
  |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\
  |\captionsetup{font={onehalfspacing,small},labelfont=bf}|
\end{quote}
\example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}{\exampletext}
\fi
An example which brings color into life:
\begin{quote}
  |\usepackage{color}|\\
  |\DeclareCaptionFont{red}{\color{red}}|\\
  |\DeclareCaptionFont{green}{\color{green}}|\\
  |\DeclareCaptionFont{blue}{\color{blue}}|\\
  |\captionsetup{labelfont={blue,bf},textfont=green}|
\end{quote}
\example*{labelfont={color=blue,bf},textfont={color=green},singlelinecheck=off}{\exampletext}
But since \thispackage\ already includes the tricky definition
\begin{quote}
  |\DeclareCaptionFont{color}{\color{#1}}|
\end{quote}
you can get the same result simply with
\begin{quote}
  |\usepackage{color}|\\
  |\captionsetup{labelfont={color=blue,bf},|\\
  |               textfont={color=green}}|\quad.
\end{quote}

\DescribeMacro{\DeclareCaptionStyle}
You can define your own caption styles with
\begin{quote}
  |\DeclareCaptionStyle|\marg{name}\oarg{additional options}\marg{options}
\end{quote}
Remember, caption styles are just a collection of suitable options, saved
under a given name. You can wake up these options at any time with the
option |style=|\meta{style name}.

All caption styles are based on the |base| set of options. (See \Ref{style}
for a complete list.) So you only need to specify options which are different
to them.

If you specify \meta{additional options} they get used in addition when
the caption fits into a single line and this check was not disabled with
the option |singlelinecheck=off|.

Again a very easy example taken from the core of this package: The
caption style |base| is pre-defined as
\begin{quote}
  |\DeclareCaptionStyle{base}%|\\
  |  [format=plain,justification=centering]{}|\quad.
\end{quote}

% --------------------------------------------------------------------------- %

\subsection{Further Examples}

%\NEWdescription{v3.1}
If you would like to have a line break between caption label and text
you could define it this way:
\begin{quote}
  |\DeclareCaptionFormat{myformat}{#1#2\\#3}|
\end{quote}
If you select this format with |\captionsetup{format=myformat}|
you get captions like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=myformat1,labelfont=bf}{\exampletext}
%\end{Example}
You could even use an indention with this caption format:
\begin{quote}
  |\captionsetup{format=myformat,indention=1cm}|
\end{quote}
This would look like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=myformat1,indention=1cm,labelfont=bf}{\exampletext}
%\end{Example}
Instead, you would like to have an indention only of the first line of
the caption text? No problem, e.g.
\begin{quote}
  |\newlength\myindention|\\
  |\DeclareCaptionFormat{myformat}%|\\
  |       {#1#2\\\hspace*{\myindention}#3}|\\
  \ldots\\
  |\setlength\myindention{1cm}|\\
  |\captionsetup{format=myformat}|
\end{quote}
would give you captions like
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=myformat2,myindention=1cm,labelfont=bf}{\exampletext}
%\end{Example}
But you want to have an caption option for this indention, so you can use
it for example with |\captionsetup|\xx|[figure]|\xx|{myindention=|\ldots|}|?
This could be done, too:
\begin{quote}
  |\newlength\myindention|\\
  |\DeclareCaptionOption{myindention}%|\\
  |       {\setlength\myindention{#1}}|\\
  |\DeclareCaptionFormat{myformat}%|\\
  |       {#1#2\\\hspace\myindention #3}|\\
  \ldots\\
  |\captionsetup{format=myformat,myindention=1cm}|
\end{quote}
would give the same result as the example above.

\bigskip\pagebreak[3]
A different example: You want captions to look like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=reverse,labelformat=fullparens,labelsep=fill,labelfont=it}{\exampletext}
%\end{Example}
\pagebreak[2]
You could do it this way:
\nopagebreak[3]
{\leftmargini=10pt
 \begin{quote}
   |\DeclareCaptionFormat{reverse}{#3#2#1}|\\
   |\DeclareCaptionLabelFormat{fullparens}%|\\
   |       {(\bothIfFirst{#1}{~}#2)}|\\
   |\DeclareCaptionLabelSeparator{fill}{\hfill}|\\
   |\captionsetup{format=reverse,labelformat=fullparens,|\\
   |              labelsep=fill,font=small,labelfont=it}|
 \end{quote}}
For short captions---which fit into one single line---this format will not
be used, since |format=plain| is part of the \meta{single-line-code} of the
caption style |default| which will be used as long as no different style is
selected. If you don't like this, you could either switch the |singlelinecheck|
|off|, or you could define an appropriate style for yourself, e.g.:
\begin{quote}
  |\DeclareCaptionStyle{mystyle}%|\\
  |  [justification=centering]{format=myformat}|\\
  |\captionsetup{style=mystyle}|
\end{quote}
or
\begin{quote}
  |\DeclareCaptionFormat{myshortformat}{|\ldots
         \textit{use your illusion here}|}|\\
  |\DeclareCaptionStyle{mystyle}%|\\
  |  [format=myshortformat]{format=myformat}|\\
  |\captionsetup{style=mystyle}|
\end{quote}

\bigskip\pagebreak[3]
Another example: The caption text should go into the left margin; a possible
solution would be:
{\leftmargini=10pt
 \begin{quote}
   |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\
   |\captionsetup{format=llap,labelsep=quad,singlelinecheck=no}|
 \end{quote}}
As a result you would get captions like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=llap,labelsep=quad,singlelinecheck=no,margin=0pt}{\exampletext}
%\end{Example}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Document classes \& Babel support}
\label{classes}

%\NEWdescription{v3.1}
{\small\emph{Please note:} Many document classes already have build-in options and
commands for customizing captions. If these possibilities are sufficient for
you, there is usually no need for you to use the \package{caption} package
at all. And if you are just interested in using the command \cs{captionof},
loading of the very small \package{capt-of} is usually sufficient.}

This section will give you an overview of the document classes the
\package{caption} supports, what do they already offer regarding captions,
what side effects will occur when using the \package{caption} package with
them, and what are the `default' settings for them.

\NEWfeature{v3.1}
The `default' settings depend on the document class you use; they represent
how the class author wanted the captions to look like. So for example
setting |format=default| can give you different visual designs when used
with different document classes.

\DANGER
If you don't find the document class you use in this section, you usually
don't have to worry: Many document classes are derived from one of the
standard document classes |article|, |report|, or |book|, and behave the
same regarding captions.
\Thispackage\ automatically does a compatibility check against the document
class used and will give you a clear warning if a incompatibility was detected.
If you don't get such warning everything is fine, but if you get it the usage of
\thispackage\ is not recommended and especially not supported.

{\small(If you get such a compatibility warning but decide to use \thispackage{}
 anyway, you should watch carefully what side-effects occur, usually the
 look and feel of your captions will change by just including \thispackage{}
 without options, meaning they do not look like as intended by the author
 of the document class.
 If this is fine for you, you should first specify the option |style=base|
 via |\usepackage[style=base]{caption}| or |\captionsetup{style=base}|
 to set \thispackage\ into a well-defined state.
 Afterwards you can start setting your own options additionally and
 keep your fingers crossed.)}

\newcommand*\Option{Option}
\newcommand*\defaultvalue{\texttt{default} value}
\newcommand*\use{\textit{use}}
\newcommand*\settings{\textit{settings}}
\newcommand*\nofont{\textit{none}}

\subsection{Standard \LaTeX: article, report, and book}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & |simple| \\
|labelsep=|      & |colon| \\
|justification=| & |justified| \\
|font=|          & \nofont \\
|labelfont=|     & \nofont \\
|textfont=|      & \nofont \\
\end{tabular}

\textbf{Build-in features:} None

\noindent{\small(\emph{Note:} This also applies to document classes derived from them.)}

\subsection{\AmS: amsart, amsproc, and amsbook}
\label{AMS}

\TODO

\subsection{beamer}
\label{beamer}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & \textit{not numbered} \\
|labelsep=|      & |colon| \\
|justification=| & |raggedright| \\
|font=|          & \use\ \package{beamer} |caption| \settings \\
|labelfont=|     & \use\ \package{beamer} |caption name| \settings \\
|textfont=|      & \nofont \\
\end{tabular}

\textbf{Build-in features and side-effects:}\\
You can setup font and color settings with
|\setbeamerfont|\xx|{caption}|\xx\marg{options} and
|\setbeamerfont|\xx|{caption name}|\xx\marg{options}.
This will still work, unless you set a different font with
|\captionsetup|\xx|{font=|\xx\meta{options}|}| or
|\captionsetup|\xx|{labelfont=|\xx\meta{options}|}|.\par
Furthermore the \package{beamer} classes offer different caption templates
which can be choosen with
|\set|\x|beamter|\x|template|\xx|{caption}|\xx|[|\meta{template}|]|.
Since \thispackage\ replaces this caption template mechanism,
|\def|\x|beamer|\x|template*|\xx|{caption}|\xx\marg{template code}
and
|\set|\x|beamer|\x|template|\xx|{caption}|\xx|[|\meta{template}|]|
will have no function when \thispackage\ is used.

\subsection{\KOMAScript: scrartcl, scrreprt, and scrbook}
\label{KOMA}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & \use\ |\setcapindent| \textit{\&} |\setcaphanging| \settings \\
|labelformat=|   & |simple| \\
|labelsep=|      & \use\ |\captionformat| \\
|justification=| & |justified| \\
|font=|          & \use\ |\setkomafont{caption}| \settings \\
|labelfont=|     & \use\ |\setkomafont{captionlabel}| \settings \\
|textfont=|      & \nofont \\
\end{tabular}

\textbf{Build-in features:}\\
The \KOMAScript\ document classes offer many ways to customize the look and
feel of the captions. For an overview and a full description please take a
look at the \KOMAScript\ documentation, section `Tables and Figures'.

\textbf{Side effects:}\\
The optional argument of |\setcapwidth| is not supported (yet) and will be
ignored if used in conjunction with the \package{caption} package.
Furthermore the \KOMAScript\ options |tablecaptionabove| \&
|tablecaptionbelow| and the commands |\captionabove| \& |\captionbelow|
are stronger than the |position=| setting offered by the \package{caption}
package.

\subsection{\NTG: artikel, rapport, and boek}
\label{NTG}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & |simple| \\
|labelsep=|      & |colon| \\
|justification=| & |justified| \\
|font=|          & \nofont \\
|labelfont=|     & \use\ |\CaptionLabelFont| \\
|textfont=|      & \use\ |\CaptionTextFont| \\
\end{tabular}

\textbf{Build-in features and side-effects:}\\
|\CaptionLabelFont| and |\CaptionTextFont| can be set either directly or
by using |\CaptionFonts|. Both is still supported unless you use
one of the two options |labelfont=| or |textfont=| offered by \thispackage.

\subsection{\SmF{} classes: smfart and smfbook}
\label{SMF}

\TODO

\subsection{The frenchb Babel option}
\label{frenchb}

If you use the \package{frenchb} option of the \package{babel} package
with one of the three standard \LaTeX{} classes (or a one derived from them)
the default |labelsep=| will be set to \cs{CaptionSeparator} (offered by
\package{frenchb}), overriding the default value set by the document class.
So redefining \cs{CaptionSeparator} will still work, unless you don't
select a different |labelsep=| than the default one.

\INFO*
Please load \thispackage\ \emph{after} the \package{babel} package.

\subsection{The frenchle and frenchpro packages}
\label{frenchpro}

If you use the \package{frenchle} or \package{frenchpro} package,
the default |labelsep=| will be set to \cs{captionseparator} (offered by
\package{frenchle/pro}) plus \cs{space}, overriding the default value set
by the document class.
So redefining \cs{captionseparator} will still work, unless you don't
select a different |labelsep=| than the default one.

Furthermore the default |textfont=| will be set to |textfont=it|,
since this emulates the default setting of |\captionfont| defined by the
\package{frenchle} or \package{frenchpro} package.
%If you redefine |\captionfont| after loading the \package{frenchle} or
%\package{frenchpro} package, this redefinition gets lost.
Please note that the command \cs{captionfont} is used by the
\package{caption} package internally for a different purpose,
so you should not change it (anymore).

The command \cs{unnumberedcaptions}\marg{figure or table} will still work,
but only unless you don't select a different |labelformat=| than the default
one.

\INFO*
Please load \thispackage\ \emph{after} the \package{frenchle}
or \package{frenchpro} package.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Supported packages}
\label{packages}

%\NEWdescription{v3.1}
\Thispackage\ was adapted to the following packages which deals with
captions, too:
\begin{quote}
  \package{float}, \package{floatflt}, \package{fltpage},
  \package{hyperref}, \package{hypcap}, \package{listings},
  \package{longtable}, \package{picinpar}, \package{picins},
  \package{rotating}, \package{sidecap}, \package{subfigure},
  \package{supertabular}, \package{threeparttable}, and \package{wrapfig}
\end{quote}

Furthermore the \package{floatrow} and the \package{subfig} package
supports \thispackage\ and use its |\captionsetup| interface.

\subsection{float}
\label{float}

\TODO

\subsection{floatflt}
\label{floatflt}

\TODO

\subsection{fltpage}
\label{fltpage}

\TODO

\subsection{hyperref}
\label{hyperref}

\NEWfeature{v3.1}
There are two options available to control hyperlinks:
\begin{description}
\item{\texttt{hypcap=}}\\[\smallskipamount]
If set to |true| all hyperlink anchors -- where entries in the
List of Figures, |\ref|, and |\autoref| will link to -- are placed at
the beginning of the (floating) environment.\par
If set to |false| the hyperlink anchor is placed at the caption.\par
(The default setting is |hypcap=true|.)
\item{\texttt{hypcapspace=}}\\[\smallskipamount]
This controls the vertical distance between the hyperlink anchor and
the (floating) environment, e.g.~|hypcapspace=0pt| removes the space.\par
(The default setting is |hypcapspace=0.5\baselineskip|.)
\end{description}

Please note:

\begin{description}
\item{\cs{captionof}\marg{type}\csmarg\ldots\ vs.
      \cs{captionsetup}\csmarg{type=\meta{type}}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount]
Without \package{hyperref} loaded, both will give you identical results.
But with \package{hyperref} loaded, and with |hypcap=true| requested, the
hyperlink anchor will be placed different.
For example:
\begin{quote}
|\begin{minipage}{\linewidth}|\\
|  |\ldots\\
|  \captionof{figure}{A figure}|\\
|\end{minipage}|
\end{quote}
will place the hyperlink anchor at the caption.
(And if |hypcap=true| is set, you will get a warning about this.)
But
\begin{quote}
|\begin{minipage}{\linewidth}|\\
|  \captionsetup{type=figure}|\\
|  |\ldots\\
|  \caption{A figure}|\\
|\end{minipage}|
\end{quote}
will place the hyperlink anchor at the beginning of the |minipage|.

\item{\cs{caption}\csoarg{}\csmarg\ldots\ vs.
      \cs{captionsetup}\csmarg{listof=false}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount]
Again, without \package{hyperref} loaded, both will give you identical results.
But with \package{hyperref} loaded, the difference is in the nuances.
So for example the optional argument of \cs{caption} will also be written to
the |aux| file, and will be used by the \cs{nameref} command.
So if you choose to use \cs{caption} with empty optional argument,
\cs{nameref} will also give you an empty result.
So it's better to use \cs{captionsetup}\csmarg{listof=false} if you don't
want an entry in the List of Figures or List of Tables.
\end{description}

\subsection{hypcap}
\label{hypcap}

If the \package{hypcap} package is loaded additionally to the \package{hyperref}
package, it takes over the control of the hyperlink anchor placement.

This has the side-effect that you lost the good placement of the hyperlink anchors
in |floatingfigure|s (provided by the \package{floatflt} package),
in |figwindow|s (provided by the \package{picinpar} package),
in |parpic|s (provided by the \package{picins} package), and
in |wrapfigure|s (provided by the \package{wrapfig} package).

Furthermore |\captionsetup{type=|\meta{type}|}| will not place hyperlink anchors
anymore, instead you need to use |\capstart| (provided by the \package{hypcap} package).

\subsection{listings}
\label{listings}

\TODO

\subsection{longtable}
\label{longtable}

\TODO

\subsection{picinpar}
\label{picinpar}

\TODO

\subsection{picins}
\label{picins}

\TODO

\subsection{rotating}
\label{rotating}

\TODO

\subsection{sidecap}
\label{sidecap}

\TODO

\subsection{subfigure}
\label{subfigure}

\TODO

\subsection{supertabular}
\label{supertabular}

\TODO

\subsection{threeparttable}
\label{threeparttable}

\TODO

\subsection{wrapfig}
\label{wrapfig}

\TODO

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Compatibility to older versions}
\label{compatibility}

\subsection{caption v\texorpdfstring{$1.x$}{1.x}}
\label{caption1}

This version of \thispackage\ still supports the old options
and commands provided by the version $1.x$ of this package. So there
shouldn't occur any problems compiling old documents, but please don't mix
old options and commands with the new ones. This isn't supported and can
cause ugly side effects.

Here comes a short oversight of the obsolete options and how
they have been replaced within this version of \thispackage:

{\small\begin{longtable}{ll}
\package{caption} \version{1.x} & \package{caption} \version{3.x}\\
\hline
\endhead
|normal|        & |format=plain|\\
|hang|          & |format=hang|\\
|isu|           & |format=hang|\\
|center|        & |justification=centering|\\
|centerlast|    & |justification=centerlast|\\
%|anne|         & |justification=centerlast|\\
|nooneline|     & |singlelinecheck=off|\\
|scriptsize|    & |font=scriptsize|\\
|footnotesize|  & |font=footnotesize|\\
|small|         & |font=small|\\
|normalsize|    & |font=normalsize|\\
|large|         & |font=large|\\
|Large|         & |font=Large|\\
|up|            & |labelfont=up|\\
|it|            & |labelfont=it|\\
|sl|            & |labelfont=sl|\\
|sc|            & |labelfont=sc|\\
|md|            & |labelfont=md|\\
|bf|            & |labelfont=bf|\\
|rm|            & |labelfont=rm|\\
|sf|            & |labelfont=sf|\\
|tt|            & |labelfont=tt|\\
\end{longtable}}

Beside the options for setting up the desired font there were also
the commands |\captionsize| resp.~|\captionfont| and |\captionlabelfont|
who could be redefined with |\renewcommand| and allowed an alternate and
more flexible way to change the font used for captions.
This mechanism was replaced by the commands
\begin{quote}
  |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad and\\
  |\captionsetup{font=|\ldots|,labelfont=|\ldots|}|\qquad.
\end{quote}\SeeUserDefined

Setting the margin for captions was done in \version{1.x} with
\begin{quote}
  |\setlength{\captionmargin}{|\ldots|}|\quad.
\end{quote}
This was replaced by
\begin{quote}
  |\captionsetup{margin=|\ldots|}|\qquad.
\end{quote}
\See{\Ref{margins}}

For example the old-style code
\begin{quote}
|\usepackage[hang,bf]{caption}|\\
|\renewcommand\captionfont{\small\sffamily}|\\
|\setlength\captionmargin{10pt}|
\end{quote}
will still work fine, but should be written today as
\begin{quote}
|\usepackage[format=hang,labelfont=bf,font={small,sf},|\\
|            margin=10pt]{caption}|
\end{quote}
or
\begin{quote}
|\usepackage{caption}|\\
|\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\
|              margin=10pt}|\qquad.
\end{quote}

The quite exotic option |ruled| which allowed a partial usage of
the caption settings for |ruled| floats defined with the
\package{float} package will be emulated by this version of the
caption package, too.
But using this option is not recommended anymore since this
version of \thispackage\ offers a more flexible way
for changing the captions of these floating environments:
\begin{quote}
  |\DeclareCaptionStyle{ruled}{|\ldots|}|
\end{quote}
resp.
\begin{quote}
  |\captionsetup[ruled]{|\ldots|}|\qquad.
\end{quote}
\SeeUserDefined[, \Ref{commands}, and \Ref{float}]

\subsection{caption2 v\texorpdfstring{$2.x$}{2.x}}
\label{caption2}

Although they do very similar stuff, the packages \package{caption} and
its experimental and now obsolete variant \package{caption2} have a
very different implementation design.
Therefore a full compatibility could not be offered.
For that reason you will still find a file called |caption2.sty| in
this package distribution, so old documents using the \package{caption2}
package will still compile fine.

Newly created documents should use the actual version of
\thispackage\ instead. In most cases it's sufficient to replace the command
\begin{quote}
  |\usepackage[...]{caption2}|
\end{quote}
by
\begin{quote}
  |\usepackage[...]{caption}|\qquad.
\end{quote}
But some options and commands will not be emulated, so you can get
error messages afterwards. This section will hopefully help you removing
these errors. If you have problems migrating from \package{caption2}
to \package{caption} please don't hesitate to send me an e-mail asking
for help.

In addition to the obsolete options shown in the last section
these ones will be emulated, too:

{\small\begin{longtable}{ll}
\package{caption2} \version{2.x} & \package{caption} \version{3.x}\\
\hline
\endhead
|flushleft|   & |justification=raggedright|\\
|flushright|  & |justification=raggedleft|\\
|oneline|     & |singlelinecheck=on|\\
\end{longtable}}

Setting the margin for captions was done in \version{2.x} with
\begin{quote}\leavevmode\hbox{%
  |\setcaptionmargin{|\ldots|}| resp.
  |\setcaptionwidth{|\ldots|}|\quad.
}\end{quote}
This was replaced by
\begin{quote}\leavevmode\hbox{%
  |\captionsetup{margin=|\ldots|}| resp.
  |\captionsetup{width=|\ldots|}|\quad.
}\end{quote}
\See{\Ref{margins}}

Setting an indention was done in \version{2.x} with
\begin{quote}
  |\captionstyle{indent}|\\
  |\setlength\captionindent{|\ldots|}|\quad.
\end{quote}
This is now done with
\begin{quote}
  |\captionsetup{format=plain,indention=|\ldots|}|\quad.
\end{quote}

The so-called single-line-check was controlled by the commands
|\oneline|\-|captions|\-|false| (for switching the check off) and
|\oneline|\-|captions|\-|true| (for switching the check on).
This was replaced by
|\captionsetup{|\xx|singlelinecheck=|\xx|off}|
resp.
|\captionsetup{|\xx|singlelinecheck=|\xx|on}|.
\See{\Ref{justification}}

The commands
\begin{quote}
  |\captionlabeldelim|, |\captionlabelsep|, |\captionstyle|,\\
  |\defcaptionstyle|, |\newcaptionstyle|, and |\renewcaptionstyle|
\end{quote}
do not have a simple replacement and therefore will not be emulated
by this version of \thispackage. (So using them will
cause error messages.) Rewriting such code is not always easy and
straight-ahead, but by conscientious reading of this manual you should
find appropriate options and commands instead.

\iffalse
... (some examples)
\fi

The \version{2.x} option |ignoreLTcapwidth| do not have a replacement, too.
But in most cases you can simply drop using that option because
in this version of \thispackage\ the value of |\LTcapwidth|
will be ignored anyway (unless you set it to a different value than the
default one which is |4in|).
\See{\Ref{longtable}}

\subsection{caption v\texorpdfstring{$3.0$}{3.0}}
\label{caption3}

%\NEWdescription{v3.1}
\Thispackage\ \version{3.0} did not support any document classes
other than the standard \LaTeX\ ones: |article|, |report|, and |book|.
Therefore the default settings used to be fixed, but now \thispackage{}
supports more classes, therefore they are now set in dependence on the
document class used.

For example: While in \version{3.0} the default caption |justification| used
to be always |justified|, it's now still |justified| when using one of the
standard document classes, but |raggedright| will be used as default format
when when used with the \package{beamer} document class.

%An easy way to select the `old' defaults---if desired---is using the option
An easy way to select the `old' defaults is using the option
|style=base| when loading \thispackage\ (or later on using |\captionsetup|).

Another new feature is the automatic check for compatibility; if an
incompatibility will be found, a warning message will be issued and if a strong
incompatibility was found some features of \thispackage\ will be disabled.
Please note that only this check was added to \thispackage, so if you get
such warning message, the previous versions of \thispackage\ were incompatible
as well, but did not issued such warning, they were ``only'' having
side-effects or causing problems.
So these warnings only say that some bad side effects or problems could
happen, but not that they actually will happen.
Anyway, if you use \thispackage\ in such circumstances,
you should use it with care.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Alphabetical Reference}

%\newenvironment{Warnings}%
% {\begin{trivlist}%
%   \def\Message{\pagebreak[3]\leftskip=0pt\relax\item[]\color{blue}}%
%   \def\Description{\nopagebreak\par\nopagebreak\color{black}\leftskip=1.5em\nopagebreak}%
% }%
% {\color{black}\end{trivlist}}
\newenvironment{Warnings}{%
  \newif\ifMessage
  \def\Message{%
    \ifMessage\end{minipage}\par\vspace\itemsep\pagebreak[3]\fi
    \begin{minipage}{\linewidth}%
    \setlength\parindent{0pt}%
    \setlength\parskip{\smallskipamount}%
    \setlength\leftskip{0pt}%
    \color{blue}%
    \Messagetrue}%
  \def\Description{%
    \par\color{black}\leftskip=1.5em}%
}{%
  \ifMessage\end{minipage}\par\fi
}

\subsection{Commands}

\begin{longtable}{lll}
Command                          & & Section \\
\hline
\endhead
|\abovecaptionskip|              & & \ref{skips} \\
%|\AtBeginCaption|               & & \ref{x} \\
%|\AtEndCaption|                 & & \ref{x} \\
|\belowcaptionskip|              & & \ref{skips} \\
|\caption|                       & & \ref{commands} \\
|\caption*|                      & & \ref{commands} \\
|\captionbox|                    & & \ref{x} \\
|\captionof|                     & & \ref{commands} \\
|\captionof*|                    & & \ref{commands} \\
|\captionsetup|                  & & \ref{commands} \\
|\captionsetup*|                 & & \ref{commands} \\
|\centerfirst|                   & & \ref{justification} \\
|\centerlast|                    & & \ref{justification} \\
|\clearcaptionsetup|             & & \ref{commands} \\
|\clearcaptionsetup*|            & & \ref{commands} \\
|\ContinuedFloat|                & & \ref{ContinuedFloat} \\
|\DeclareCaptionFont|            & & \ref{declare} \\
|\DeclareCaptionFormat|          & & \ref{declare} \\
|\DeclareCaptionFormat*|         & & \ref{declare} \\
|\DeclareCaptionJustification|   & & \ref{declare} \\
|\DeclareCaptionLabelFormat|     & & \ref{declare} \\
|\DeclareCaptionLabelSeparator|  & & \ref{declare} \\
|\DeclareCaptionLabelSeparator*| & & \ref{declare} \\
|\DeclareCaptionListOfFormat|    & & \ref{declare} \\
|\DeclareCaptionOption|          & & \ref{declare} \\
|\DeclareCaptionStyle|           & & \ref{declare} \\
|\DeclareCaptionTextFormat|      & & \ref{declare} \\
|\showcaptionsetup|              & & \ref{commands} \\
\end{longtable}

\pagebreak[4]
\subsection{Options}
\newcommand\preambleoption{ \footnotemark[1]}

\begin{longtable}{lll}
Option & Short description & Section \\
\hline
\endhead
|aboveskip|       & sets the skip above caption & \ref{skips} \\
|belowskip|       & sets the skip below caption & \ref{skips} \\
|compatibility|\preambleoption & force (non-)compatibility & \ref{classes} \\
%|config| &       & \ref{x} \\
|figurename|\preambleoption & sets the figure name & \ref{x} \\
|figureposition|\preambleoption & gives a hint about the figure caption position & \ref{skips} \\
|font|            & sets the font & \ref{fonts} \\
|format|          & sets the format & \ref{formats} \\
|FPlist|          & to where the list entry of a FPfigure should link? & \ref{fltpage} \\
|FPref|           & to where a |\ref| to a FPfigure should link? & \ref{fltpage} \\
|hangindent|      & sets the hang indention & \ref{margins} \\
|hypcap|          & select `hypcap' feature & \ref{hyperref} \\
|hypcapspace|     & sets the distance between hyperlink \& contents & \ref{hyperref} \\
|indention|       & sets the indention & \ref{margins} \\
|justification|   & sets the justification & \ref{justification} \\
|labelfont|       & sets the font of the caption label & \ref{fonts} \\
|labelformat|     & sets the format of the caption label & \ref{formats} \\
|labelsep|        & sets the label separator & \ref{formats} \\
|labelseparator|  & sets the label separator & \ref{formats} \\
|listof|          & switches the entries in the `List of' on or off & \ref{listof} \\
|listofformat|    & sets the `List of' entry format & \ref{listof} \\
|margin|          & sets the margin & \ref{margins} \\
|margin*|         & sets the margin, but only if no width is set & \ref{margins} \\
|maxmargin|       & sets the max. margin & \ref{margins} \\
|minmargin|       & sets the min. margin & \ref{margins} \\
|options|         & executes the given option list & \ref{x} \\
|parindent|       & sets the paragraph indention & \ref{margins} \\
|parskip|         & sets the skip between paragraphs & \ref{margins} \\
|position|        & gives a hint about the caption position & \ref{skips} \\
|singlelinecheck| & switches the single-line-check on or off & \ref{justification} \\
%|size|           & sets the size of font & \ref{x} \\
|skip|            & sets the skip between content \& caption & \ref{skips} \\
|strut|           & switches the usage of |\strut|s on or off & \ref{formats} \\
|style|           & sets the caption style & \ref{style} \\
|tablename|\preambleoption & sets the table name & \ref{x} \\
|tableposition|\preambleoption & gives a hint about the table caption position & \ref{skips} \\
|textfont|        & sets the font of the caption text & \ref{fonts} \\
|textformat|      & sets the format of the caption text & \ref{formats} \\
|twoside|         & selects the two-side mode & \ref{x} \\
|type|            & sets the caption type \& places a hyperlink anchor & \ref{x} \\
|type*|           & sets the caption type only & \ref{x} \\
|width|           & sets a fixed caption width & \ref{margins} \\
\end{longtable}
\footnotetext[1]{These options are only available in the preamble of the document.}

\nopagebreak\parbox[t]{\linewidth}{\small\emph{Note:}
  Obsolete options are not listed here. See\\
  \hspace*{1em}\Ref{caption1} and\\
  \hspace*{1em}\Ref{caption2} for a list of these options.}

\pagebreak[4]
\subsection{Warnings}

\begin{Warnings}

\Message
  |\caption will not be redefined since it's already|\\
  |redefined by a document class or package which is|\\
  |unknown to the caption package.|\\
  |As a result some new features of the caption|\\
  |package will not work as expected.|
\Description
  If \thispackage\ detects that some (unknown) documentclass or
  package has enhanced |\caption|, it will not redefine
  |\caption|, too, since this would simply kill the enhancement.
  As a result some features, like |\caption*|, |\ContinuedFloat|,
  using the optional argument of |\captionsetup|,
  or the options |listof=| \& |hypcap=| will be ignored or
  not work as expected.\par
  If you don't care about the original enhancements but would
  like to use the full range of features of \thispackage\ instead
  you can give the unsupported(!) option |compatibility=false|
  a try and keep your fingers crossed.
  (But you will get the next warning instead.)
  \par\See{\Ref{classes}}

\Message
  |Caption type was already set to `|\meta{type}|'.|
\Description
  This warning informs you about mixed caption options. For example if
  you use a |\captionof{table}{|\ldots|}| inside a |figure| environment,
  this would result in using both option sets for that specific caption,
  the ones for |figure| (specified with |\captionsetup[figure]{|\ldots|}|)
  and the one for |table| (specified with |\captionsetup[table]{|\ldots|}|)
  as well.
  \par\See{\Ref{commands}}

\Message
  |Forced redefinition of \caption since the|\\
  |unsupported(!) package option `compatibility=false'|\\
  |was given. Please fasten your seat belts, as we may|\\
  |experience turbulence!|
\Description
  Since you were so keen to specify the option |compatibility=false|
  \thispackage\ will try to do its best to fulfill your wishes.
  But depending on the document class or other packages you use that
  can end in non-functional features or even errors. So keep your
  fingers crossed!
  \par\See{\Ref{classes}}

\Message
  |Hyperref support is turned off because hyperref has|\\
  |stopped early.|
\Description
  If the \package{hyperref} package stopps early during loading
  (because of what-ever reason), the \package{hyperref} support of
  \thispackage\ will not be available. As a result you could get
  \package{hyperref} warnings and non-functional hyperlinks to figures
  or tables.
  \par\See{\Ref{hyperref}}

\Message
  |Ignoring optional argument [|\meta{pos}|] of \setcapwidth.|
\Description
  \Thispackage\ tries to emulate the \KOMAScript\ commands regarding
  captions as best as it can. But the optional argument of the
  \KOMAScript\ command |\setcapwidth| is not (yet) working if you use
  this package, so if you try to use it anyway, you will get this warning.
  \par\See{\Ref{KOMA}}

\Message
  |Internal Warning: |\meta{warning message}|.|
\Description
% \Thispackage\ can only set hyperanchors in \TeX s vertical mode.\par
  You should never see this warning, either you use a package which redefines
  |figure| or |table| and which is unknown to \thispackage, or this is a bug
  in \thispackage.
  Please send me an e-mail reporting this issue.

\Message
  |\label before \caption ignored|
\Description
  Regarding |\label| the floating environments behave differently than its
  non-floating counterparts: The internal reference will not be generated
  at the beginning of the environment, but at |\caption| instead.
  So you have to place the |\label| command either \emph{after} the
  |\caption| command or inside the caption text.

\Message
  |Option `|\meta{option}|' was not in list `|\meta{option list}|'.|
\Description
  If you try to remove a specific option of an option list,
  for example with\linebreak|\clearcaptionsetup[position]{table}|,
  and this option can not be found inside the option list, you will
  get this warning. If this is not because of a typo and you would like
  to suppress this warning, use |\clearcaptionsetup*| instead of
  |\clearcaptionsetup|.
  \par\See{\Ref{commands}}

\Message
  |Option list `|\meta{option list}|' undefined.|
\Description
  If you try to remove a specific option of an option list,
  for example with\linebreak|\clearcaptionsetup[format]{figure}|,
  and this option list is not defined (yet), you will
  get this warning. If this is not because of a typo and you would like
  to suppress this warning, use |\clearcaptionsetup*| instead of
  |\clearcaptionsetup|.
  \par\See{\Ref{commands}}

\iffalse
\Message
  |Possibly superfluous \restylefloat{|\meta{type}|} detected.|\\
  |If you think that this warning is unjustified,|\\
  |you can switch it off using the caption package|\\
  |option `restylefloatcheck=off'.|
\Description
  \TODO
\fi

\Message
  |`ragged2e' package not loaded, therefore|\\
  |substituting \raggedright for \RaggedRight.|
\Description
  The caption option |justification=|\xx|RaggedRight| is only full functional
  if you have the \package{ragged2e} package installed in your \TeX\ system.
  If not, you will get this warning, and |justification=|\xx|RaggedRight|
  will be treated as |justification=|\xx|raggedright|.
  \par\See{\Ref{justification}}

\Message
  |Obsolete option `ignoreLTcapwidth' ignored.|
\Description
  The \package{caption2} package option |ignoreLTcapwidth| will not be
  emulated by this version of \thispackage, usually you can simply wipe it
  away.
  \par\See{\Ref{caption2} and \Ref{longtable}}

\Message
  |`ragged2e' support has been changed. Rerun to get|\\
  |captions right.|
\Description
  The \package{ragged2e} package will only be loaded by \thispackage\ if it
  is actually needed.
  At least two \LaTeX\ runs are needed for that, so on the first run you could
  get this warning.
  Just compile your document again and this warning should go away.
  \par\See{\Ref{justification}}

\Message
  |Reference on page |\meta{page no.}| undefined.|
\Description
  If you use a |twoside| page layout, \thispackage\ needs to track the
  page numbers to get the margins right.
  At least two \LaTeX\ runs are needed for that, on the first run you could get
  this warning.
  Just compile your document again and this warning should go away.
  \par\See{\Ref{margins}}

\Message
  |The option `hypcap=true' will be ignored for this|\\
  |particular \caption.|
\Description
  \Thispackage\ hasn't found a proper hyperlink anchor for this particular
  caption, so it decides to ignore the setting |hypcap=true| (which is set by
  default). As a result a link to this caption (e.g.~in the List of Figures,
  or set by |\ref| or |\autoref|) will link you to the caption of the figure
  or table, not to the figure or table itself.\par
  This can happen if you use |\captionof| inside a non-floating environment,
  but also if you use some package which redefines |figure| or |table|, and
  which is unknown to \thispackage.\par
  If this is ok for you but you want to supress this warning, simply place a
  |\captionsetup{|\xx|hypcap=|\xx|false}| just before the |\caption| or
  |\captionof| command which is causing the warning.
  If this is not ok for you you can try to set a hyperlink anchor with
  |\captionsetup{|\xx|type=|\xx\meta{float type}|}| for yourself.
  \par\See{\Ref{hyperref}}

\Message
  |Unsupported document class (or package) detected,|\\
  |usage of the caption package is *not* recommended.|
\Description
  Either the document class you use is unknown to \thispackage, or you
  have included a package in your document which redefines |\@makecaption|
  (which is responsible for typeseting the caption) as well.
  This means \thispackage\ will either change the design of captions in an
  unwanted way, or it even refuses to work correctly at all.
  \par\See{\Ref{classes}}

\Message
  |Unused \captionsetup[|\meta{type}|].|
\Description
  You have specified options with |\captionsetup[|\meta{type}|]| which are
  not used later on.
  This can be because of a typo in \meta{type},
  or because you use a package which redefines |figure| or |table| and
  which is unknown to \thispackage, or simply because you don't have any usage
  of the environment \meta{type} after this line.\par
  If you want to supress this warning you can use |\captionsetup*| instead of
  |\captionsetup|.
  \par\See{\Ref{commands}}

\Message
  |Usage of the |\meta{package}| package together with the|\\
  |caption package is strongly *not* recommended.|\\
  |Instead of loading the |\meta{package}| package you should|\\
  |use the caption package option `tableposition=top'.|
\Description
  The package \meta{package} is dealing with caption skips as well.
  Please decide which one do you actually want to use, \thispackage\ or the
  other one, using both can lead to wrong skips above or below the caption.
  \par\See{\Ref{skips}}

\end{Warnings}

\pagebreak[4]
\subsection{Errors}

\begin{Warnings}

\Message
  |! Argument of \@caption has an extra }.|
\Description
  If you want to typeset something special (like a tabular) as caption,
  you need to give an optional argument to |\caption| resp.~|\captionof|
  for the List of Figures resp.~List of Tables, too, even if you don't
  use such list.
  \par\See{\Ref{commands}, \Ref{listof}, and \Ref{hyperref}\,}

\Message
  |\caption outside float.|
\Description
  You have placed a |\caption| command outside a floating environment or
  a |longtable|. If this is what you want to, please use either
  |\captionsetup{|\xx|type=|\xx\meta{type}|}| $+$ |\caption| or |\captionof|.
  \par\See{\Ref{commands}}

\Message
  |\caption outside group or environment.|
\Description
  You have placed a |\caption| command outside an box, group, or environment.
  This is not supported.
  \par\See{\Ref{commands}}

\Message
  |\captionsetup{type=|\meta{type}|} outside group or environment.|
\Description
  You have placed a |\captionof| or |\captionsetup{|\xx|type=|\xx\meta{type}|}|
  command outside an box, group, or environment. This is not supported.
  \par\See{\Ref{commands}}

\Message
  |\ContinuedFloat outside float.|
\Description
  You have placed a |\ContinuedFloat| command outside a floating environment.
%  or |longtable|.
  If this is what you want to, please use the combination
  |\captionsetup{|\xx|type=|\xx\meta{type}|}| $+$ |\ContinuedFloat|.\par
  Please note that |\ContinuedFloat| inside a |longtable| is not working (yet),
  but maybe using the |longtable*| environment, which typesets a longtable
  without incrementing the |table| counter, if sufficient for you.
  \par\See{\Ref{commands} and \Ref{longtable}}

\Message
  |Continued `|\meta{type}|' after `|\meta{type}|'.|
\Description
  At the moment continued figures or tables are not allowed to be interrupted
  by a floating envionment of another type, e.g.~a table between a figure and a
  continued figure.
  \par\See{\Ref{ContinuedFloat}}

\Message
  |For a successful cooperation of the `wrapfig' package|\\
  |with the `float' package you should load the `wrapfig'|\\
  |package *(right) after* the `float' package.|
\Description
  Please take care of the load order of packages
  if you use the \package{wrapfig} package in coorperation with the
  \package{float} package.
  \par\See{\Ref{wrapfig}}

\Message
  |For a successful cooperation of the `wrapfig' package|\\
  |with the `float' package you should use at least|\\
  |`wrapfig' version 3.6.|
\Description
  Please take care of the version of the \package{wrapfig} package
  if you use the \package{wrapfig} package in coorperation with the
  \package{float} package.
  \par\See{\Ref{wrapfig}}

\Message
  |For a successful cooperation we need at least version|\\
  |`|\meta{date}|' of package |\meta{package}|, but only version|\\
  |`|\meta{old-date}|' is available.|
\Description
  \Thispackage\ does not work with such an outdated package, please update it
  to a more recent version, at least to the one requested.

\Message
  |Internal Error: |\meta{error message}|.|
\Description
  You should never see this error.
  Please send me an e-mail reporting this issue.

\Message
  |! LaTeX Error: Option clash for package caption.|\\
{\color{black}\hspace{1.5em}-- oder --}\\
  |! LaTeX Error: Missing \begin{document}.|
\Description
  \Thispackage\ has already been loaded by some other \LaTeX\ package,
  so you can't do that again specifying different options.
  A candidate causing this could be the \package{subfig} package; if this is
  the case, please load \thispackage\ \emph{before} the \package{subfig}
  package or specify the option |caption=false| while loading the
  \package{subfig} package.
  \par\See{the \package{subfig} package\cite{subfig} documentation}

\Message
  |Not allowed in longtable* environment.|
\Description
  The usage of |\caption| is not allowed inside the |longtable*| environment.
  Please use either |\caption*| for a caption without label or use the regular
  |longtable| environment instead.

\Message
  |Not available in compatibility mode.|
\Description
  The feature required is not supported in compatibility mode.
  `compatibility mode' means that \thispackage\ has detected either an
  incompatible document class or an incompatible package which also
  extents the |\caption| command. Leaving the original extention intact,
  some features of \thispackage\ are not supported.
  \par\See{\Ref{compatibility}}

\Message
  |Runaway argument?|\\
  |! Paragraph ended before \caption@makecurrent was complete.|
\Description
  If you want to typeset multi-paragraph captions, you need to give an
  optional argument to |\caption| resp.~|\captionof| for the List of
  Figures resp.~List of Tables, too, even if you don't use such list.
  \par\See{\Ref{commands}, \Ref{listof}, and \Ref{hyperref}\,}

\iffalse % was removed in v3.1b
\Message
  |Something is going wrong here...|\\
  |For a removal of this problem please consult the|\\
  |caption package documentation, especially the sections|\\
  |about the `float' and the `wrapfig' package.|
\Description
  Please take care of the load order of packages
  if you use the \package{wrapfig} package in coorperation with the
  \package{float} package. But maybe a different package tried to extent
  the \package{float} package in a manner which is incompatible to
  \thispackage!?
  \par\See{\Ref{float} and \Ref{wrapfig}}
\fi

\iffalse
\Message
  |Something's wrong--perhaps a missing \caption|\\
  |in the last figure or table.|
\Description
  It seems that you have used a |\subcaption| command without a
  corresponding |\caption| command. This is not supported.
\fi

\Message
  |The option `labelsep=|\meta{name}|' does not work|\\
  |with `format=hang'.|\\
{\color{black}\hspace{1.5em}-or-}\\
  |The option `labelsep=|\meta{name}|' does not work|\\
  |with \setcaphanging (which is set by default).|
\Description
  A caption label separator which contains a newline command (|\\|)
  does not work with a hanging caption format.
  Please select another caption format or another caption label seperator.
  \par\See{\Ref{formats} resp.~\Ref{KOMA}}

\Message
  |The package option `caption=false' is obsolete.|\\
  |Please pass this option to the subfig package instead|\\
  |and do *not* load the caption package anymore.|
\Description
  You have specified the option |caption=false|. This used to be a workaround
  for not using the whole \package{caption} package, leaving the caption stuff
  offered by the document class or other packages intact, but keeping the
  \package{subfig} package working. This mechanism is obsolet and not offered
  anymore, please pass this option to the \package{subfig} instead and do not
  load \thispackage\ anymore.
  \par\See{the \package{subfig} package\cite{subfig} documentation}

\Message
  |Undefined boolean value `|\meta{value}|'.|
\Description
  You tried to set a boolean option (like |singlelinecheck=| or |hypcap=|)
  with an improper value. Only |false|, |no|, |off|, |0| or |true|, |yes|,
  |on|, |1| is allowed here.

\Message
  |Undefined format `|\meta{name}|'.|
\Description
  You tried to set a caption format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |Undefined label format `|\meta{name}|'.|
\Description
  You tried to set a caption label format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |Undefined label separator `|\meta{name}|'.|
\Description
  You tried to set a caption label separator which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |Undefined list-of format `|\meta{name}|'.|
\Description
  You tried to set a caption list-of format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{listof}}

\Message
  |Undefined position `|\meta{name}|'.|
\Description
  You tried to set a caption position with an improper value.
  Maybe a typo!?
  \par\See{\Ref{skips}}

\Message
  |Undefined style `|\meta{name}|'.|
\Description
  You tried to set a caption style which does not exists.
  Maybe a typo!?
  \par\See{\Ref{style}}

\Message
  |Undefined text format `|\meta{name}|'.|
\Description
  You tried to set a caption text format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |You can't use both, the (obsolete) caption2 *and*|\\
  |the (current) caption package.|
\Description
  This error message says it all, you simply can't do that.
  Please use only \thispackage.
  \par\See{\Ref{caption2}}

\Message
  |You can't use the caption package option|\\
  |  `tableposition=|\meta{position}|'|\\
  |and use the |\meta{package}| package, too.|\\
{\color{black}\hspace{1.5em}-or-}\\
  |You can't use the global option|\\
  |  `tablecaptionabove'|\\
  |and use the |\meta{package}| package, too.|
\Description
% (ftcap,nonfloat,topcapt)
  The package \meta{package} is dealing with caption skips as well.
  Please decide which one do you actually want to use, \thispackage\ or the
  other one, using both this way will lead to wrong skips above or below the
  caption.
  \par\See{\Ref{skips}}

\end{Warnings}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Further reading}

I recommend the following documents for further reading:

\begin{itemize}
\item
  The \TeX\ FAQ -- Frequently asked questions about \TeX\ and \LaTeX:
  \begin{quote}\url{http://faq.tug.org/}\end{quote}

\item
  A French FAQ can be found at
  \begin{quote}\url{http://www.grappa.univ-lille3.fr/FAQ-LaTeX/}\end{quote}

\item
  ``What is a minimal working example?'' from Christian Faulhammer and Ulrich Schwarz:
  \begin{quote}\url{http://www.minimalbeispiel.de/mini-en.html}\end{quote}

\item
  \textsf{epslatex} from Keith Reckdahl contains many tips around
  including graphics in \LaTeXe\ documents.
  You will find this document in the directory
  \begin{quote}\url{ftp://tug.ctan.org/pub/tex/info/epslatex/}\end{quote}
\end{itemize}

% --------------------------------------------------------------------------- %

\pagebreak[2]
\section{Thanks}

I would like to thank Katja Melzner,
Steven D. Cochran, Frank Mittelbach, Olga Lapko,
David Carlisle, Carsten Heinz, and Keith Reckdahl.
Thanks a lot for all your help, ideas, patience, spirit, and support!

Also I would like to thank
Harald Harders,
Peter L\"offler,
Peng Yu,
Alexander Zimmermann,
Matthias Pospiech,
J\"urgen Wieferink,
Christoph Bartoschek,
Uwe St\"ohr,
Ralf Stubner,
Geoff Vallis,
Florian Keiler,
J\"urgen G\"obel,
Uwe Siart,
Sang-Heon Shim,
Henrik Lundell,
David Byers,
William Asquith,
Prof.~Dr.~Dirk Hoffmann,
Frank Martini,
and
Danie Els
who all helped to make this package a better one.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\begin{thebibliography}{99}
  \bibitem{TLC2}
  Frank Mittelbach and Michel Goossens:\\
  \newblock {\em The {\LaTeX} Companion (2nd.~Ed.)},\\
  \newblock Addison-Wesley, 2004.

  \bibitem{beamer}
  Till Tantau:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf}%
       {\emph{User Guide to the Beamer Class, Version 3.07}},\\
  March 11, 2007

  \bibitem{KOMAScript}
  Markus Kohm \& Jens-Uwe-Morawski:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguien.pdf}%
       {\emph{KOMA-Script -- a versatile \LaTeXe\ bundle}},\\
  2007-01-09

  \bibitem{NTG}
  Victor Eijkhout:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/classdoc.pdf}%
       {\emph{An introduction to the Dutch \LaTeX\ document classes}},\\
  3 September 1989

  \bibitem{float}
  Anselm Lingnau:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/float/float.pdf}%
       {\emph{An Improved Environment for Floats}},\\
  2001/11/08

  \bibitem{floatflt}
  Mats Dahlgren:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf}%
       {\emph{Welcome to the floatflt package}},\\
  1998/06/05

  \bibitem{floatrow}
  Olga Lapko:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}%
       {\emph{The floatrow package documentation}},\\
  2006/07/24

  \bibitem{fltpage}
  Sebastian Gross:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/fltpage.pdf}%
       {\emph{Welcome to the beta test of fltpage package!}},\\
  1998/11/13

  \bibitem{hyperref}
  Sebastian Rahtz \& Heiko Oberdiek:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}%
       {\emph{Hypertext marks in \LaTeX}},\\
  June 14, 2007

  \bibitem{hypcap}
  Heiko Oberdiek:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.pdf}%
       {\emph{The hypcap package -- Adjusting anchors of captions}},\\
  2007/04/09

  \bibitem{listings}
  Carsten Heinz \& Brooks Moses:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}%
       {\emph{The Listings Package}},\\
  2007/02/22

  \bibitem{longtable}
  David Carlisle:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}%
       {\emph{The longtable package}},\\
  2004/02/01

  \bibitem{picinpar}
  Friedhelm Sowa:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}%
       {\emph{Pictures in Paragraphs}},\\
  July 13, 1993

  \bibitem{picins}
  Joachim Bleser and Edmund Lang:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/mpic.dvi}%
       {\emph{PicIns-Benutzerhandbuch Version 3.0}},\\
  September~1992

  \bibitem{rotating}
  Sebastian Rahtz and Leonor Barroca:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}%
       {\emph{A style option for rotated objects in \LaTeX}},\\
  1997/09/26

  \bibitem{sidecap}
  Rolf Niepraschk \& Hubert G\"a\ss lein:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}%
       {\emph{The sidecap package}},\\
  2003/06/06

  \bibitem{subfigure}
  Steven D. Cochran:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}%
       {\emph{The subfigure package}},\\
  2002/07/02

  \bibitem{subfig}
  Steven D. Cochran:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/subfig.pdf}%
       {\emph{The subfig package}},\\
  2005/07/05

  \bibitem{supertabular}
  Johannes Braams and Theo Jurriens:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}%
       {\emph{The supertabular environment}},\\
  2002/07/19

  \bibitem{threeparttable}
  Donald Arseneau:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/misc/threeparttable.sty}%
       {\emph{Three part tables: title, tabular environment, notes}},\\
  2003/06/13

  \bibitem{wrapfig}
  Donald Arseneau:\\
  \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}%
       {\emph{WRAPFIG.STY ver 3.6}},\\
  2003/01/31
\end{thebibliography}

% --------------------------------------------------------------------------- %

\end{document}