diff options
author | Karl Berry <karl@freefriends.org> | 2007-09-08 15:59:17 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2007-09-08 15:59:17 +0000 |
commit | 788352558edd068d76fe19ad56b81827c0fe7646 (patch) | |
tree | ab733e20eaf33223cbfe9c59c783a30d802ee627 /Master/texmf-dist/doc | |
parent | ba8058f661bc514c2d960695ddb21d5501abbf97 (diff) |
caption 3.1 (7sep07)
git-svn-id: svn://tug.org/texlive/trunk@4911 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/anleitung.pdf | bin | 211736 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/anleitung.tex | 2044 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-deu.pdf | bin | 0 -> 318761 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-deu.tex | 2909 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-eng.pdf | bin | 0 -> 302947 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-eng.tex | 2645 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-rus.pdf | bin | 0 -> 429149 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-rus.tex | 2554 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption.pdf | bin | 327267 -> 348118 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption2.pdf | bin | 124990 -> 138982 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/ltcaption.pdf | bin | 0 -> 119481 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/manual.tex | 69 |
12 files changed, 8108 insertions, 2113 deletions
diff --git a/Master/texmf-dist/doc/latex/caption/anleitung.pdf b/Master/texmf-dist/doc/latex/caption/anleitung.pdf Binary files differdeleted file mode 100644 index 02748d4dc0e..00000000000 --- a/Master/texmf-dist/doc/latex/caption/anleitung.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/caption/anleitung.tex b/Master/texmf-dist/doc/latex/caption/anleitung.tex deleted file mode 100644 index 1881f645197..00000000000 --- a/Master/texmf-dist/doc/latex/caption/anleitung.tex +++ /dev/null @@ -1,2044 +0,0 @@ -%% -%% This is file `anleitung.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, caption.xml, and anleitung.tex and the derived files -%% caption.sty, caption2.sty, caption3.sty, and manual.tex. -%% -\ProvidesFile{anleitung.tex} -\NeedsTeXFormat{LaTeX2e}[1994/12/01] -\documentclass[a4paper]{ltxdoc} -\setlength\parindent{0pt} -\setlength\parskip{\medskipamount} - -\errorcontextlines9 -\def\StartTracing{\typeout{StartTracing}\tracingmacros=1\tracingcommands=1\relax} -\def\StopTracing{\tracingmacros=0\tracingcommands=0\relax\typeout{StopTracing}} - -\newcommand\NEWfeature{\NEW{Neues Feature}} -\newcommand\NEWdescription{\NEW{Neue Beschreibung}} -\newcommand\NEW[2]{\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} - -\font\manual=manfnt -\newcommand\DANGER{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{\manual\char127}}}} - -%%%\usepackage[T1]{fontenc} -\ifx\pdfoutput\undefined\else - \ifcase\pdfoutput\else - \usepackage{mathptmx,courier} - \usepackage[scaled=0.90]{helvet} - \addtolength\marginparwidth{15pt} - \fi -\fi - -\usepackage[german]{babel} -\usepackage{color,setspace} - -%\usepackage{float} -\usepackage{longtable} -%\usepackage[raggedright]{sidecap} - -\usepackage{caption}[2005/08/24] -\DeclareCaptionLabelSeparator{endash}{\space\textendash\space} -\usepackage{hyperref} - -\DeclareCaptionFont{singlespacing}{\setstretch{1}} -\DeclareCaptionFont{onehalfspacing}{\onehalfspacing} -\DeclareCaptionFont{doublespacing}{\doublespacing} -\DeclareCaptionFont{red}{\color{red}} -\DeclareCaptionFont{green}{\color{green}} -\DeclareCaptionFont{blue}{\color{blue}} - -\DeclareCaptionLabelSeparator{period-newline}{. \\} -\DeclareCaptionStyle{period-newline}[labelsep=period]{labelsep=period-newline} -\DeclareCaptionStyle{period-newline2}[labelsep=period,justification=centering]{labelsep=period-newline} -\DeclareCaptionStyle{period-newline3}[labelsep=period]{labelsep=period-newline,justification=centering} -\DeclareCaptionFormat{reverse}{#3#2#1} -\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par} -\DeclareCaptionLabelFormat{fullparens}{(\bothIfFirst{#1}{ }#2)} -\DeclareCaptionLabelSeparator{fill}{\hfill} - -\DeclareRobustCommand{\KOMAScript}{\textsf{K\kern.05em O\kern.05em% - M\kern.05em A\kern.1em-\kern.1em Script}} - -\newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}} -\newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}} -\newcommand*\purett[1]{{\upshape\mdseries\ttfamily #1}} -\let\package\puresf\def\thispackage{\package{caption}} -\let\env\purett \let\opt\purett - -\newcommand*\version[1]{$v#1$} - -\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} -\newcommand\example[3][figure]{% - \begingroup - \captionsetup{#2}% - \captionof{#1}[]{#3}% - \endgroup} - -\begin{document} - -\GetFileInfo{caption.sty} -\title{Setzen von Abbildungs- und Tabellenbeschriftungen mit dem - \thispackage-Paket\thanks{Dieses Paket hat die Versionsnummer - \fileversion, zuletzt ge"andert am \filedate.}} -\author{Axel Sommerfeldt\\\href{mailto:caption@sommerfee.de}{\texttt{caption@sommerfee.de}}} -\date{9. April 2007} -\maketitle - -\begin{abstract} -Das \thispackage\ Paket bietet einem Mittel und Wege das Erscheinungsbild der -Bildunterschriften und Tabellen"uberschriften den eigenen W"unschen -bzw.\ bestimmten Vorgaben anzupassen. -Hierbei wurde viel Wert auf die reibungslose Zusammenarbeit und in die -Integration anderer Dokumentenklassen und Pakete gelegt.\footnote{F"ur die -aktuelle Version 3.0 dieses Paketes wurde die Benutzerschnittstelle zusammen -mit Steven D. Cochran und Frank Mittelbach komplett "uberarbeitet.} -\end{abstract} - -\tableofcontents - -\newcommand\figuretext{% - Die auf die Rotationsfrequenz des Innenzylinders normierten Eigenfrequenzen - der gefundenen Grundmoden der Taylor"=Str"omung f"ur \mbox{$\eta = 0.5$}. %\\ - (Die azimutale Wellenzahl ist mit $m$ bezeichnet.)} - -% --------------------------------------------------------------------------- % - -\section{Einleitung} - -Mit |\caption| gesetzte Bildunterschriften und Tabellen"uberschriften werden -von den Standard"=Dokumentenklassen eher stiefm"utterlich behandelt. -In der Regel schlicht als ganz normaler Absatz gesetzt, ergibt sich keine -signifikante optische Abgrenzung vom eigentlichen Text, wie z.B. hier: - -\example{belowskip=\abovecaptionskip}{\figuretext} - -Es sollte aber eine M"oglichkeit geben, diesem Umstand abzuhelfen. Es w"are -zum Beispiel nett, wenn man den Text der Unterschrift etwas kleiner gestalten, -extra R"ander festlegen oder den Zeichensatz des Bezeichners dem der -Kapitel"uberschriften anpassen k"onnte. So in etwa: - -\example{belowskip=\abovecaptionskip,size=small,margin=10pt,labelfont=bf,labelsep=endash}{\figuretext} - -Mit Hilfe dieses Paketes k"onnen Sie dies leicht bewerkstelligen; es sind viele -vorgegebene Parameter einstellbar, Sie k"onnen aber auch eigene -Gestaltungsmerkmale einflie"sen lassen. - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\section{Verwendung des Paketes} -\label{usage} - -\DescribeMacro{\usepackage} -Mittels -\begin{quote} - |\usepackage|\oarg{Optionen}|{caption}[|\texttt{\filedate}|]| -\end{quote} -in dem Vorspann des Dokumentes wird das \thispackage\ Paket eingebunden, die -Optionen legen hierbei das Aussehen der "Uber- und Unterschriften fest. So -w"urde z.B. -\begin{quote} - |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}|%[|\texttt{\filedate}|]| -\end{quote} -zu dem obrigen Ergebnis mit Rand, kleinerem Zeichensatz und fetter Bezeichnung -f"uhren. - -\DescribeMacro{\captionsetup} -Eine "Anderung der Parameter ist auch zu einem sp"ateren Zeitpunkt jederzeit -mittels des Befehls -\begin{quote} - |\captionsetup|\oarg{Typ}\marg{Optionen} -\end{quote} -m"oglich. So sind z.B. die Befehlssequenzen -\begin{quote} - |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}|%[|\texttt{\filedate}|]| -\end{quote} -und -\begin{quote} - |\usepackage{caption}|\\%[|\texttt{\filedate}|]| - |\captionsetup{margin=10pt,font=small,labelfont=bf}| -\end{quote} -in ihrer Wirkung identisch. - -Weiterhin gilt zu beachten, da"s sich die Verwendung von |\captionsetup| -innerhalb von Umgebungen nur auf die Umgebung selber auswirkt, nicht aber auf -den Rest des Dokumentes. M"ochte man also z.B. die automatische Zentrierung der -Abbildungsunterschrift nur in einem konkreten Falle ausschalten, so kann dies -mit -\begin{quote} - |\begin{figure}|\\ - | |\ldots\\ - | \captionsetup{singlelinecheck=off}|\\ - | \caption{|\ldots|}|\\ - |\end{figure}| -\end{quote} -geschehen, ohne da"s die restlichen Abbildungsunterschriften hiervon -beeintr"achtigt werden. - -(Der optionale Parameter \meta{Typ} wird in Abschnitt - \ref{misc}: \textit{"`N"utzliches"'} behandelt.) - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\section{Beschreibung der Optionen} - -\def\OptionLabel{RaggedRight} -\def\UserDefined{\ldots} -\makeatletter -\newcommand*\Section{\@ifstar{\@Section\relax}{\@Section{Abschnitt}}} -\newcommand*\@Section[3]{#1 \ref{#2}: \textit{"`#3"'}} -\makeatother -\newcommand*\See[1]{{\small (Siehe #1)}} -\newcommand*\SeeUserDefined[1][]{% - \See{\Section{declare}{Eigene Erweiterungen}#1}} - -% --------------------------------------------------------------------------- % - -\subsection{Formatierung} - -\DescribeMacro{format=} -Eine Abbildungs- oder Tabellenbeschriftung besteht im wesentlichen aus drei -Teilen: -Dem Bezeichner (etwa "`Abbildung 3"'), dem Trenner -(etwa "`:\textvisiblespace"') und dem eigentlichen Text. -Mittels der Option -\begin{quote} - |format=|\meta{Name} -\end{quote} -wird festgelegt, wie diese drei Teile zusammengesetzt werden. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar:%\footnote{Es gibt -%hier wie auch bei vielen anderen Optionen die M"oglichkeit, auch eigene -%Formate, Zeichens"atze etc.\ zu definieren. Wie dies geht wird in Abschnitt -%\ref{declare}: \textit{"`Eigene Erweiterungen"'} dargelegt.} - -\begin{Options}{\OptionLabel} - \item[plain]\NEWdescription{v3.0h} - Die Beschriftung wird als gew"ohnlicher Abschnitt gesetzt. - (Dies ist z.Z.~das Standardverhalten, ab Version $3.1$ des - \package{caption} Paketes wird dies allerdings von der verwendeten - Dokumentenklasse abh"angen.) - - \item[hang] - Der Text wird so gesetzt, da"s er an dem Bezeichner "`h"angt"', d.h.~der - Platz unter dem Bezeichner und dem Trenner bleibt leer. - - \item[\UserDefined] - Eigene Formate k"onnen mittels |\DeclareCaptionFormat| definiert werden. - \SeeUserDefined -\end{Options} - -\begin{Example} - Ein Beispiel: Die Angabe der Option - \begin{quote} - |format=hang| - \end{quote} - f"uhrt zu Abbildungsunterschriften der Art - \example{format=hang}{\figuretext} -\end{Example} - -\DescribeMacro{indention=} -Bei beiden Formaten (\texttt{plain} und \texttt{hang}) kann der Einzug der Beschriftung -ab der zweiten Textzeile angepasst werden, dies geschieht mit Hilfe der Option -\begin{quote} - |indention=|\meta{Einzug}\quad, -\end{quote} -wobei anstelle von \meta{Einzug} jedes beliebige feste Ma"s angegeben werden kann. - -Zwei Beispiele: - -\begin{Example} - \begin{quote} - |format=plain,indention=.5cm| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{format=plain,indention=.5cm}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |format=hang,indention=-0.5cm| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{format=hang,indention=-0.5cm}{\figuretext} -\end{Example} - -%\pagebreak[3] -\DescribeMacro{labelformat=} -Mittels der Option -\nopagebreak[3] -\begin{quote} - |labelformat=|\meta{Name} -\end{quote} -\nopagebreak[3] -\NEWdescription{v3.0e} -wird die Zusammensetzung des Bezeichners festgelegt. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: - -\begin{Options}{\OptionLabel} - \item[default] - Der Bezeichner wird wie von der verwendeten Dokumentenklasse vorgegeben gesetzt, - "ublicherweise ist dies der Name und die Nummer, getrennt durch ein Leerzeichen - (wie \texttt{simple}). - (Dies ist das Standardverhalten.) - - \item[empty] - Der Bezeichner ist leer. (Diese Option macht in der Regel nur in Verbindung mit - anderen Optionen -- wie etwa \texttt{labelsep=none} -- Sinn.) - - \item[simple] - Der Bezeichner ist aus dem Namen und der Nummer zusammengesetzt. - - \item[parens] - Die Nummer des Bezeichners wird in runde Klammern gesetzt. - - \item[\UserDefined] - Eigene Formate k"onnen mittels |\DeclareCaptionLabelFormat| definiert werden. - \SeeUserDefined -\end{Options} - -\begin{Example} - Ein Beispiel: Die Optionen - \begin{quote} - |labelformat=parens,labelsep=quad| - \end{quote} - f"uhren zu Abbildungsunterschriften der Art - \example{labelformat=parens,labelsep=quad}{\figuretext} -\end{Example} - -\DescribeMacro{labelsep=} -Mittels der Option -\begin{quote} - |labelsep=|\meta{Name} -\end{quote} -wird die Zusammensetzung des Trenners festgelegt. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: - -\begin{Options}{\OptionLabel} - \item[none] - Der Trenner ist leer. (Diese Option macht in der Regel nur in Verbindung - mit anderen Optionen -- wie etwa \texttt{labelformat=empty} -- Sinn.) - - \item[colon] - Der Trenner besteht aus einem Doppelpunkt und einem Leerzeichen. - (Dies ist z.Z.~das Standardverhalten.) - - \item[period] - Der Trenner besteht aus einem Punkt und einem Leerzeichen. - - \item[space] - Der Trenner besteht lediglich aus einem einzelnen Leerzeichen. - - \item[quad] - Der Trenner besteht aus einem |\quad|. - - \item[newline] - Als Trenner wird ein Zeilenumbruch verwendet. - - \item[endash]\NEWfeature{v3.0h} - Als Trenner wird ein Gedankenstrich verwendet. - - \item[\UserDefined] - Eigene Trenner k"onnen mittels |\DeclareCaptionLabelSeparator| definiert werden. - \SeeUserDefined -\end{Options} - -Drei Beispiele: -\begin{Example} - \begin{quote} - |labelsep=period| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{labelsep=period}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |labelsep=newline,singlelinecheck=false| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{labelsep=newline,singlelinecheck=false}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |labelsep=endash| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{labelsep=endash}{\figuretext} -\end{Example} - -% --------------------------------------------------------------------------- % - -\subsection{Textausrichtung} -\label{justification} - -\DescribeMacro{justification=} -Mittels der Option -\begin{quote} - |justification=|\meta{Name} -\end{quote} -wird die Ausrichtung des Textes festgelegt. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: - -\begin{Options}{\OptionLabel} - \item[justified] - Der Text wird als Blocksatz gesetzt. - (Dies ist z.Z.~das Standardverhalten.) - - \item[centering] - Der Text wird zentriert gesetzt. - -% \item[Centering] -% Der Text wird zentriert gesetzt. Hierf"ur wird jedoch im Gegensatz -% zu \texttt{centering} der Befehl |\Centering| des \package{ragged2e}-Paketes -% verwendet, der \LaTeX\ das Trennen der Worte erlaubt. - - \item[centerlast] - Lediglich die letzte Zeile des Textes wird zentriert gesetzt. - - \item[centerfirst] - Lediglich die erste Zeile des Textes wird zentriert gesetzt. - - \item[raggedright] - Der Text wird linksb"undig gesetzt. - -% \item[RaggedRight] -% Der Text wird linksb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. - \item[RaggedRight] - Der Text wird ebenfalls linksb"undig gesetzt. Hierf"ur wird jedoch im Gegensatz - zu \texttt{raggedright} der Befehl |\RaggedRight| des \package{ragged2e}-Paketes - verwendet, der \LaTeX\ das Trennen der Worte erlaubt. - - \item[raggedleft] - Der Text wird rechtsb"undig gesetzt. - -% \item[RaggedLeft] -% Der Text wird rechtsb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. - - \item[\UserDefined] - Eigene Ausrichtungen k"onnen mittels |\DeclareCaptionJustification| definiert werden. - \SeeUserDefined -\end{Options} - -Einige Beispiele: -\begin{Example} - \begin{quote} - |justification=centerlast| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{justification=centerlast}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |format=hang,justification=raggedright| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{format=hang,justification=raggedright}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |format=hang,justification=RaggedRight| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{belowskip=\abovecaptionskip,format=hang,justification=RaggedRight}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |labelsep=newline,justification=centering| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{belowskip=\abovecaptionskip,labelsep=newline,justification=centering}{\figuretext} -\end{Example} - -\DescribeMacro{singlelinecheck=} -In den Standard"=Dokumentenclassen |article|, |report| und |book| sind die -Ab\-bildungs- und Tabellenbeschriftungen so realisiert, da"s sie automatisch -zentriert werden, wenn sie lediglich aus einer einzigen Textzeile bestehen: - -\example{belowskip=\abovecaptionskip}{Eine kurze Beschriftung.} - -%\example{belowskip=\abovecaptionskip}{% -% Eine lange Beschriftung, die gen"ugend Text enth"alt, um l"anger als -% eine einzelne Zeile zu sein.} - -\DANGER -Diesen Mechanismus "ubernimmt das \thispackage-Paket und ignoriert damit -in der Regel bei solch kurzen Beschriftungen die mittels der Option -|justification=| eingestellte Textausrichtung. Dieses Verhalten kann -jedoch mit der Option -\begin{quote} - |singlelinecheck=|\meta{bool} -\end{quote} -reguliert werden. Setzt man f"ur \meta{bool} entweder |false|, |no|, |off| -oder |0| ein, so wird der Zentrierungsmechnismus au"ser Kraft gesetzt. -Die obrige, kurze Abbildungsunterschrift w"urde z.B. nach Angabe der Option -\begin{quote} - |singlelinecheck=false| -\end{quote} -so aussehen: -\begingroup -\captionsetup{type=figure} -\ContinuedFloat -\endgroup -\example{belowskip=\abovecaptionskip,singlelinecheck=false}{Eine kurze Beschriftung.} - -Setzt man f"ur \meta{bool} hingegen |true|, |yes|, |on| oder |1| ein, so -wird die automatische Zentrierung wieder eingeschaltet. (Standardm"a"sig -ist sie eingeschaltet.) - -% --------------------------------------------------------------------------- % - -\subsection{Zeichens"atze} - -\DescribeMacro{font=} -\DescribeMacro{labelfont=} -\DescribeMacro{textfont=} -Das \thispackage-Paket kennt 3 Zeichens"atze: Denjenigen f"ur die gesammte Beschriftung -(|font|), denjenigen, der lediglich auf den Bezeichner und den Trenner angewandt wird -(|labelfont|), sowie denjenigen, der lediglich auf den Text wirkt (|textfont|). -So lassen sich die unterschiedlichen Teile der Beschriftung individuell mittels -\begin{quote}\begin{tabular}{@{}r@{}ll} - |font=| & \marg{Zeichensatzoptionen} & ,\\ - |labelfont=| & \marg{Zeichensatzoptionen} & und\\ - |textfont=| & \marg{Zeichensatzoptionen} & \\ -\end{tabular}\end{quote} -\nopagebreak[3] -anpassen. -\pagebreak[3] - -Als \meta{Zeichensatzoptionen} sind eine Kombination aus folgendem erlaubt: - -\begin{Options}{\OptionLabel} - \item[scriptsize] {\scriptsize Sehr kleine Schrift} - \item[footnotesize] {\footnotesize Fu"snotengr"o"se} - \item[small] {\small Kleine Schrift} - \item[normalsize] {\normalsize Normalgro"se Schrift} - \item[large] {\large Gro"se Schrift} - \item[Large] {\Large Gr"o"sere Schrift} - - \item[up] {\upshape Upright Schriftart} - \item[it] {\itshape Italic Schriftart} - \item[sl] {\slshape Slanted Schriftart} - \item[sc] {\scshape Small Caps Schriftart} - - \item[md] {\mdseries Medium Schriftserie} - \item[bf] {\bfseries Bold Schriftserie} - - \item[rm] {\rmfamily Roman Schriftfamilie} - \item[sf] {\sffamily Sans Serif Schriftfamilie} - \item[tt] {\ttfamily Typewriter Schriftfamilie} - - \item[\UserDefined] - Eigene Zeichensatzoptionen k"onnen mittels |\DeclareCaptionFont| definiert werden. - \SeeUserDefined -\end{Options} - -Wird lediglich eine einzelne Zeichensatzoption ausgew"ahlt, k"onnen die -geschweiften Klammern entfallen, d.h.~die Optionen -%\begin{quote} - |font={small}| -%\end{quote} -und -%\begin{quote} - |font=small| -%\end{quote} -sind in ihrer Wirkung identisch. - -Beispiele: -\begin{Example} - \begin{quote} - |font={small,it},labelfont=bf| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{font={small,it},labelfont=bf}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |font=small,labelfont=bf,textfont=it| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{font=small,labelfont=bf,textfont=it}{\figuretext} -\end{Example} - -% --------------------------------------------------------------------------- % - -\subsection{R"ander und Abs"atze} -\label{margins} - -\DescribeMacro{margin=} -\DescribeMacro{width=} -F"ur die Abbildungs- und Tabellenbeschriftungen kann \emph{entweder} ein extra Rand -\emph{oder} eine feste Breite festgelegt werden. Dies geschieht mit -\begin{quote}\begin{tabular}{@{}r@{}ll} - |margin=| & \meta{Rand} & \emph{oder}\\ - |width=| & \meta{Breite} & \\ -\end{tabular}\end{quote} -In beiden F"allen wird die Beschriftung zentriert, d.h.~der linke und rechte Rand -sind immer gleich gro"s. - -Zwei Beispiele hierzu: -\begin{Example} - \begin{quote} - |margin=10pt| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{margin=10pt}{\figuretext} -\end{Example} - -\begin{Example} - \begin{quote} - |width=.75\textwidth| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{width=.75\textwidth}{\figuretext} -\end{Example} - -\DescribeMacro{parskip=} -Diese Option wirkt auf Abbildungs- oder Tabellenbeschriftungen, die -aus mehr als einem Absatz bestehen; sie legt den Abstand zwischen den -Abs"atzen fest. -\begin{quote} - |parskip=|\meta{Abstand zwischen Abs"atzen} -\end{quote} -Ein Beispiel: -\begin{Example} - \begin{quote} - |margin=10pt,parskip=5pt| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{margin=10pt,parskip=5pt}{% - Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die - Auswirkungen der Optionen deutlich werden. - - Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, - so da"s die Auswirkungen der Optionen deutlich werden.} -\end{Example} - -\DescribeMacro{hangindent=} -Die Option -\begin{quote} - |hangindent=|\meta{Einzug} -\end{quote} -legt einen Einzug f"ur alle Zeilen au"ser der jeweils ersten des Absatzes fest. -Besteht die Beschriftung lediglich aus einem einzelnen Absatz, so ist die -Wirkung mit der Option |indention=|\meta{Einzug} identisch, bei mehreren -Abs"atzen zeigt sich jedoch der Unterschied: - -\begin{Example} - \begin{quote} - |format=hang,indention=-.5cm| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{format=hang,indention=-.5cm}{% - Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die - Auswirkungen der Optionen deutlich werden. - - Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, - so da"s die Auswirkungen der Optionen deutlich werden.} -\end{Example} - -\begin{Example} - \begin{quote} - |format=hang,hangindent=-.5cm| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{format=hang,hangindent=-.5cm}{% - Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die - Auswirkungen der Optionen deutlich werden. - - Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, - so da"s die Auswirkungen der Optionen deutlich werden.} -\end{Example} - -% --------------------------------------------------------------------------- % - -\subsection{Stile} -\label{style} - -\DescribeMacro{style=} -Eine geeignete Kombination aus den bisher vorgestellten Optionen wird \textit{Stil} -genannt; dies ist in etwa mit dem Seitenstil vergleichbar, den man bekannterma"sen -mit |\pagestyle| einstellen kann. - -Einen vordefinierten Abbildungs- und Tabellenbeschriftungsstil kann man mit der -Option -\begin{quote} - |style=|\meta{Stil} -\end{quote} -ausw"ahlen. Das \thispackage-Paket definiert in der Regel lediglich den Stil -|default|, der alle vorgehenden Optionen auf die Standardbelegung zur"ucksetzt, -d.h.~die Angabe der Option -\begin{quote} - |style=default| -\end{quote} -entspricht den Optionen -\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} - -Eigene Stile k"onnen mittels |\DeclareCaptionStyle| definiert werden. -\SeeUserDefined - - -% --------------------------------------------------------------------------- % - -\subsection{Abst"ande} - -\DescribeMacro{aboveskip=} -\DescribeMacro{belowskip=} -Die Standard-\LaTeX-Klassen |article|, |report| und |book| definieren -zwei Abst"ande, die in Zusammenhang mit den Abbildungs- und -Tabellenbeschriftungen gebraucht werden: |\abovecaptionskip| wird \emph{vor} -der Beschriftung angewandt und ist auf |10pt| vorbelegt. |\belowcaptionskip| -wird \emph{nach} der Beschriftung angewandt und ist auf |0pt| vorbelegt. - -\pagebreak[3] -Beide Abst"ande lassen sich gew"ohnlich mit |\setlength| "andern, aber auch mit den -\thispackage-Optionen -\nopagebreak[3] -\begin{quote}\begin{tabular}{@{}r@{}ll} - |aboveskip=| & \meta{Abstand nach oben} & und\\ - |belowskip=| & \meta{Abstand nach unten} & .\\ -\end{tabular}\end{quote} - -\DescribeMacro{position=} -Die sture Anwendung von |\abovecaptionskip| und |\belowcaptionskip| bei -Beschriftungen birgt einen gro"sen Nachteil: Ist die Beschriftung \emph{"uber} -und nicht \emph{unter} der Abbildung oder Tabelle (wie bei Tabellen durchaus -"ublich), so ist die Vorbelegung dieser beiden Abst"ande nicht mehr sinnvoll, -da hier kein Abstand zwischen der Beschriftung und der Tabelle gesetzt wird. -(Wir erinnern uns: |\belowcaptionskip| ist auf |0pt|, also kein Abstand, -vorbelegt.) - -Man vergleiche: -\begin{Example} - \begin{minipage}[c]{.5\linewidth}% -% \captionsetup{aboveskip=0pt}% - \captionof{table}{Eine Tabelle}% - \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}{Eine Tabelle}% - \end{minipage}% -\end{Example} - -Mit Hilfe des Parameters |position| kann man jedoch festlegen, wie -\LaTeX\ die Beschriftung behandeln soll, ob als \mbox{\emph{"Uber}schrift} -oder als \mbox{\emph{Unter}schrift}: -\begin{quote} - |position=top|\quad(oder |position=above|) -\end{quote} -gibt an, da"s die Abst"ande so gew"ahlt werden, da"s sie f"ur \mbox{\emph{"Uber}schriften} -sinnvoll gew"ahlt sind und -\begin{quote} - |position=bottom|\quad(oder |position=below|) -\end{quote} -gibt an, da"s die Abst"ande so gew"ahlt werden, da"s sie f"ur \mbox{\emph{"Uber}schriften} -sinnvoll gew"ahlt sind. (Dies ist die Standardeinstellung, allerdings nicht f"ur |longtable|s.) - -F"ugt man nun ein |\captionsetup{position=top}| in die linke Tabelle vor dem -|\caption| Befehl ein, so ergeben sich im Vergleich zwischen "Uberschrift und -Unterschrift stimmige Abst"ande: -\begin{Example} - \begin{minipage}[c]{.5\linewidth}% - \captionsetup{position=top}% - \captionof{table}{Eine Tabelle}% - \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}{Eine Tabelle}% - \end{minipage}% -\end{Example} - -(Technisch ist dies so realisiert, da"s bei "Uberschriften die Ab\-st"an\-de -|\abovecaptionskip| und |\belowcaptionskip| vertauscht werden, so da"s -|\abovecaptionskip| immer derjenige Abstand ist, der zwischen Tabelle -und Beschriftung zur Anwendung kommt.) - -Sinnvoll l"a"st sich diese Option insbesondere zusammen mit dem optionalen -Parameter bei |\captionsetup| anwenden: \See{auch \Section{misc}{N"utzliches}} -\begin{quote} - |\captionsetup[table]{position=top}| -\end{quote} -bewirkt, da"s bei allen Tabellen die Beschriftung bzgl.~der Abst"ande als -"Uberschrift behandelt wird. -\DescribeMacro{tableposition=} -\NEWfeature{v3.0a} -Da dies eine sehr gebr"auchliche Einstellung ist, -stellt das \thispackage"=Paket diesen Befehl auch als abk"urzende Option f"ur -|\usepackage| zur Verf"ugung: -\begin{quote} - |\usepackage[|\ldots|,tableposition=top]{caption}|\footnote{Beachten - Sie bitte, da"s dies \emph{nicht} ausreichend ist, wenn eine - \KOMAScript\ Dokumentenklasse zum Einsatz kommt. In diesem Falle mu"s - ebenfalls die \emph{globale} Option |tablecaptionabove| angegeben werden.} -\end{quote} -entspricht -\begin{quote} - |\usepackage[|\ldots|]{caption}|\\ - |\captionsetup[table]{position=top}| -\end{quote} - -% --------------------------------------------------------------------------- % - -\pagebreak[3] -\section{N"utzliches} -\label{misc} - -\DescribeMacro{\caption} -Der Befehl -\nopagebreak[3] -\begin{quote} - |\caption|\oarg{Kurzform f"ur das Verzeichnis}\marg{Beschriftung} -\end{quote} -\nopagebreak[3] -erzeugt eine "Uber- bzw.~Unterschrift innerhalb einer gleitenden Umgebung -wie |figure| oder |table|. Dies ist an sich nichts neues, neu ist allerdings, -da"s kein Eintrag ins Abbildungs- oder Tabellenverzeichnis vorgenommen -wird, wenn eine leere Kurzform angegeben wird, etwa so: -\begin{quote} - |\caption[]{Dies ist eine Abbildung, die nicht ins|\\ - | Abbildungsverzeichnis aufgenommen wird}| -\end{quote} - -\DescribeMacro{\caption*} -Das \package{longtable}-Paket definiert zus"atzlich zum Befehl |\caption| auch -den Befehl |\caption*|, der eine Beschriftung ohne Bezeichner und ohne Eintrag -ins Tabellenverzeichnis erzeugt. So erzeugt z.B. der Code -\begin{quote} - |\begin{longtable}{cc}|\\ - | \caption*{Eine Tabelle}\\|\\ - | A & B \\|\\ - | C & D \\|\\ - |\end{longtable}| -\end{quote} -diese Tabelle: -\begin{longtable}{cc} - \caption*{Eine Tabelle}\\ - A & B \\ - C & D \\ -\end{longtable} - -Das \thispackage-Paket bietet diesen Mechanismus auch f"ur normale Abbildungs- -und Tabellenbeschriftungen an. Ein Beispiel: -\begin{quote} - |\begin{table}|\\ - | \caption*{Eine Tabelle}|\\ - | \begin{tabular}{cc}|\\ - | A & B \\|\\ - | C & D \\|\\ - | \end{tabular}|\\ - |\end{table}| -\end{quote} - -\DescribeMacro{\captionof} -\DescribeMacro{\captionof*} -Der Befehl |\caption| funktioniert in der Regel nur innerhalb von gleitenden -Umgebungen, manchmal m"ochte man ihn jedoch auch anderweitig anwenden, -etwa um eine Abbildung in eine nicht-gleitende Umgebung wie |minipage| zu -setzen. - -\pagebreak[2] -Hierf"ur stellt das -\thispackage-Paket den Befehl -\begin{quote} - |\captionof|\marg{Umgebungstyp}\oarg{Kurzform}\marg{Langform} -\end{quote} -zur Verf"ugung. Die Angabe des Umgebungstypen ist hierbei notwendig, damit der -gew"unschte Bezeichner gew"ahlt wird und der Eintrag in das richtige Verzeichnis -vorgenommen wird. Ein Beispiel: -\begin{quote} - |\captionof{figure}{Abbildung}|\\ - |\captionof{table}{Tabelle}| -\end{quote} -f"uhrt zu folgendem Ergebnis: -\begin{Example} - \captionof{figure}{Abbildung} - \captionsetup{belowskip=\abovecaptionskip} - \captionof{table}{Tabelle} -\end{Example} - -Analog zu |\caption*| gibt es auch den Befehl |\captionof*| f"ur Beschriftungen -ohne Bezeichner und ohne Verzeichniseintrag. - -Beide Befehle, sowohl |\captionof| als auch |\captionof*|, sollten nur -\emph{innerhalb} von Umgebungen (wie |minipage| oder |\parbox|) angewandt werden. -Zum einen kann es sonst passieren, da"s \LaTeX\ zwischen dem Inhalt und der -Beschreibung einen Seitenumbruch setzt; zum anderen kann es bei Mi"sachtung gar -zu seltsamen Effekten (wie falsche Abst"ande um die Beschriftungen herum) kommen! - -\DescribeMacro{\ContinuedFloat} -Manchmal m"ochte man Abbildungen oder Tabellen aufteilen, jedoch ohne den einzelnen -Teilen eine eigene Abbildungs- oder Tabellennummer zu geben. Hierf"ur stellt das -\thispackage-Paket den Befehl -\begin{quote} - |\ContinuedFloat| -\end{quote} -zur Verf"ugung, der gleich als erstes innerhalb der folgenden Teile angewandt -werden sollte. Er verhindert, da"s die Z"ahlung fortgef"uhrt wird; eine Abbildung -oder Tabelle, die ein |\ContinuedFloat| enth"alt, erh"alt also die gleiche Nummer -wie die vorherige Abbildung oder Tabelle. - -Ein Beispiel: -\begin{quote} - |\begin{table}|\\ - |\caption{Eine Tabelle.}|\\ - \ldots\\ - |\end{table}|\\ - \ldots\\ - |\begin{table}\ContinuedFloat|\\ - |\caption{Eine Tabelle. (fortgef"uhrt)}|\\ - \ldots\\ - |\end{table}| -\end{quote} -ergibt als Ergebnis: -\begin{Example} - \makeatletter\def\@captype{table}\makeatother - \caption[]{Eine Tabelle.} - \centerline{\ldots} - \ContinuedFloat - \captionsetup{aboveskip=0pt} - \caption[]{Eine Tabelle. (fortgef"uhrt)} -\end{Example} - -\DescribeMacro{\captionsetup} -Den Befehl |\captionsetup| haben wir ja schon im \Section{usage} -{Verwendung des Paketes} kennengelernt, -uns dort allerdings die Bedeutung des optionalen Parameters -\meta{Typ} aufgespart. %Dies soll nun nachgeholt werden: - -Wir erinnern uns, die Syntax des Befehls lautet -\begin{quote} - |\captionsetup|\oarg{Typ}\marg{Optionen} -\end{quote} - -Wird hierbei ein \meta{Typ} angegeben, so werden die Optionen nicht -unmittelbar umgesetzt, sondern werden lediglich vermerkt und kommen erst dann -zum Einsatz, wenn eine "Uber- bzw.\ Unterschrift innerhalb des passenden -gleitenden Umgebungstyps gesetzt wird. So wirkt sich z.B. die Angabe -\begin{quote} - |\captionsetup[figure]|\marg{Optionen} -\end{quote} -lediglich auf die Unterschriften aus, die innerhalb einer |figure|"=Umgebung -gesetzt werden. - -Ein Beispiel: -\begin{quote} - |\captionsetup{font=small}|\\ - |\captionsetup[figure]{labelfont=bf}| -\end{quote} -f"uhrt zu Abbildungs- und Tabellenunterschriften der Art: -\begin{Example} - \captionsetup{font=small} - \captionsetup[figure]{labelfont=bf} - \captionof{figure}[]{Eine Abbildung} - \captionsetup{belowskip=\abovecaptionskip} - \captionof{table}[]{Eine Tabelle} -\end{Example} - -Wie man sieht, f"uhrt das |\captionsetup[figure]{labelfont=bf}| lediglich dazu, -da"s Abbildungsunterschriften mit fettem Bezeichner gesetzt werden, alle anderen -Unter- bzw.\ "Uberschriften werden hiervon nicht beeinflu"st. - -\DescribeMacro{\clearcaptionsetup} -Um diese vermerkten, typbezogenen Parameter aus dem Ged"achnis von \LaTeX\ zu -l"oschen, gibt es den Befehl -\begin{quote} - |\clearcaptionsetup|\marg{Typ}\quad. -\end{quote} - -|\clearcaptionsetup{figure}| w"urde z.B. die obrige Sonderbehandlung der -Abbildungsunterschriften wieder aufheben: -\begin{Example} - \captionsetup{font=small} - \captionof{figure}[]{Eine Abbildung} - \captionsetup{belowskip=\abovecaptionskip} - \captionof{table}[]{Eine Tabelle} -\end{Example} - -Als Umgebungstypen mit Unter- bzw.\ "Uberschriften gibt es in der Regel nur -zwei: |figure| und |table|. Wie wir jedoch sp"ater sehen werden, kommen durch die -Verwendung spezieller \LaTeX-Pakete (wie etwa das \package{float}, -\package{longtable} oder \package{sidecap}"=Paket) -ggf.~weitere Typen hinzu, deren Beschriftungen ebenfalls derart individuell -angepasst werden k"onnen. - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\section{Eigene Erweiterungen} -\label{declare} - -Wem die vorhandenen Formate, Trenner, Textausrichtungen, Zeichens"atze und Stile -nicht ausreichen, der hat die M"oglichkeit, sich eigene zu definieren. Hierzu -gibt es eine Reihe von Befehlen, die in dem Vorspann des Dokumentes (das ist der -Teil vor |\begin{document}|) zum Einsatz kommen. - -\pagebreak[2] -\DescribeMacro{\DeclareCaptionFormat} -Eigene Formate k"onnen mit dem Befehl -\begin{quote} - |\DeclareCaptionFormat|\marg{Name}\marg{Code mit \#1, \#2 und \#3} -\end{quote} -definiert werden. F"ur \#1 wird sp"ater der Bezeichner, f"ur \#2 der Trenner -und f"ur \#3 der Text eingesetzt. So ist z.B. das Standardformat |plain|, -welches die Beschriftung als gew"ohnlichen Absatz formatiert, folgenderma"sen -in |caption.sty| definiert: -\begin{quote} - |\DeclareCaptionFormat{plain}{#1#2#3\par}| -\end{quote} - -\DescribeMacro{\DeclareCaptionLabelFormat} -"Ahnlich k"onnen auch eigene Bezeichnerformate definiert werden: -\begin{quote} - |\DeclareCaptionLabelFormat|\marg{Name}\marg{Code mit \#1 und \#2} -\end{quote} -Bei den Bezeichnerformaten wird hierbei f"ur \#1 der Name (also z.B. -"`Abbildung"'), f"ur \#2 die Nummer (also z.B. "`12"') eingesetzt. - -\DescribeMacro{\bothIfFirst} -\DescribeMacro{\bothIfSecond} -Hierbei gibt es eine Besonderheit zu beachten: Wird das Bezeichnerformat -auch in Verbindung mit dem \package{subfig}"=Paket\cite{subfig} verwendet, -so kann der Bezeichnername (also \#1) auch leer sein. -Um dies flexibel handhaben zu k"onnen, stellt das \thispackage"=Paket die -Befehle -\begin{quote} - |\bothIfFirst|\marg{Erstes Argument}\marg{Zweites Argument}\quad und\\ - |\bothIfSecond|\marg{Erstes Argument}\marg{Zweites Argument} -\end{quote} -zur Verf"ugung. |\bothIfFirst| testet, ob das erste Argument leer ist, -|\bothIfSecond|, ob das zweite Argument leer ist. Nur wenn dies nicht der -Fall ist, werden beide Argumente ausgegeben, ansonsten werden beide -unterdr"uckt. - -So ist z.B. das Standard"=Bezeichnerformat |simple| nicht, wie man -naiverweise annehmen k"onnte, als -\begin{quote} - |\DeclareCaptionLabelFormat{simple}{#1 #2}| -\end{quote} -definiert, weil dies zu einem st"orendem f"uhrenden Leerzeichen f"uhren w"urde, -wenn \#1 leer ist. Stattdessen findet sich in |caption.sty| folgende -Definition, die sowohl mit |\caption| als auch mit |\subfloat| harmoniert: -\begin{quote} - |\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{ }#2}| -\end{quote} -d.h.~das Leerzeichen kommt nur dann zum Einsatz, wenn \#1 nicht leer ist. - -\pagebreak[3] -\DescribeMacro{\DeclareCaptionLabelSeparator} -Eigene Trenner werden mit -\nopagebreak[3] -\begin{quote} - |\DeclareCaptionLabelSeparator|\marg{Name}\marg{Code} -\end{quote} -\nopagebreak[3] -definiert. Auch hier wieder als einfaches Beispiel die Definition des -Standard"=Trenners aus |caption.sty|: -\nopagebreak[3] -\begin{quote} - |\DeclareCaptionLabelSeparator{colon}{: }| -\end{quote} -\pagebreak[3] - -\DescribeMacro{\DeclareCaptionJustification} -Eigene Textausrichtungen k"onnen mit -\begin{quote} - |\DeclareCaptionJustification|\marg{Name}\marg{Code} -\end{quote} -definiert werden. Der \meta{Code} wird dann der Beschriftung vorangestellt, -so f"uhrt z.B. die Verwendung der Ausrichtung -\begin{quote} - |\DeclareCaptionJustification{raggedright}{\raggedright}| -\end{quote} -dazu, da"s alle Zeilen der Beschriftung linksb"undig ausgegeben werden. - -\DescribeMacro{\DeclareCaptionFont} -Eigene Zeichensatzoptionen k"onnen mit -\begin{quote} - |\DeclareCaptionFont|\marg{Name}\marg{Code} -\end{quote} -definiert werden. So definiert z.B. das \thispackage"=Paket die Optionen -|small| und |bf| folgenderma"sen: -\begin{quote} - |\DeclareCaptionFont{small}{\small}|\\ - |\DeclareCaptionFont{bf}{\bfseries}| -\end{quote} -Die Zeilenabst"ande lie"sen sich z.B.~"uber das \package{setspace}"=Paket -regeln:\NEWdescription{v3.0h} -\begin{quote} - |\usepackage{setspace}|\\ -\iffalse - |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{% - \emph{Hinweis:} \cs{singlespacing} kann hier nicht benutzt werden, da es ein \cs{vskip} Kommando enth"alt.}\\ - |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\ - |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\ -\fi - |\captionsetup{font={onehalfspacing,small},labelfont=bf}| -\end{quote} -\example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}\figuretext -Ein Beispiel welches etwas Farbe ins Spiel bringt: -\begin{quote} - |\usepackage{color}|\\ - |\DeclareCaptionFont{red}{\color{red}}|\\ - |\DeclareCaptionFont{green}{\color{green}}|\\ - |\DeclareCaptionFont{blue}{\color{blue}}|\\ - |\captionsetup{labelfont=blue,textfont=green}| -\end{quote} -\example{labelfont=blue,textfont=green,singlelinecheck=off}\figuretext - -\DescribeMacro{\DeclareCaptionStyle} -Zu guter letzt noch die Definition eigener Stile. Stile sind einfach eine -Ansammlung von geeigneten Einstellungen, die unter einem eigenen Namen -zusammengefasst werden und mit der Paketoption |style=|\meta{Name} ausgew"ahlt -werden k"onnen. Sie werden wie folgt definiert: -\begin{quote} - |\DeclareCaptionStyle|\marg{Name}\oarg{zus"atzliche Optionen}\marg{Optionen} -\end{quote} -Hierbei ist zu beachten, da"s die \meta{Optionen} immer auf den Standardeinstellungen -basieren (siehe auch \Section{style}{Stile}), es brauchen -also nur davon abweichende Optionen angegeben werden. - -Sind \meta{zus"atzliche Optionen} angegeben, so kommen diese automatisch -zus"atzlich zum Einsatz, sofern die Beschreibung in eine einzelne Zeile passt -und diese Abfrage nicht mit |singlelinecheck=off| ausgeschaltet wurde. - -Als Beispiel mu"s mal wieder eine einfache Definition aus diesem Paket herhalten: -\begin{quote} - |\DeclareCaptionStyle{default}[justification=centering]{}| -\end{quote} - -% --------------------------------------------------------------------------- % - -\subsection{Weiterf"uhrende Beispiele} - -M"ochte man als Trenner einen Punkt \emph{und} einen Zeilenumbruch haben, -so lie"se sich das wie folgt realisieren: -\begin{quote} - |\DeclareCaptionLabelSeparator{period-newline}{. \\}| -\end{quote} -W"ahlt man diesen Trenner mit |\captionsetup{labelsep=period-newline}| aus, so -ergeben sich Beschriftungen der Art -\begin{Example} - \captionsetup{labelsep=period-newline,labelfont=bf,margin=10pt} - \captionsetup{aboveskip=0pt,type=figure} - \caption[]{\figuretext} -\end{Example} - -F"ur kurze Beschriftungen, die in eine Zeile passen, mag dieses Erscheinungsbild -jedoch st"orend sein, selbst wenn die automatische Zentrierung (mit -|singlelinecheck=off|) ausgeschaltet ist: -\begin{Example} - \captionsetup{labelsep=period-newline,labelfont=bf,margin=10pt,singlelinecheck=0} - \captionsetup{aboveskip=0pt,type=figure} - \caption[]{Eine Abbildung.} -\end{Example} - -Abhilfe schafft ein eigener Stil, der bei solchen Beschriftungen einen anderen -Trenner ohne Zeilenumbruch ausw"ahlt: -\begin{quote} - |\DeclareCaptionStyle{period-newline}%|\\ - | [labelsep=period]{labelsep=period-newline}| -\end{quote} -\begin{Example} - \captionsetup{style=period-newline,labelfont=bf,margin=10pt} - \captionsetup{aboveskip=0pt,type=figure} - \ContinuedFloat - \caption[]{Eine Abbildung.} -\end{Example} -M"ochte man die automatische Zentrierung ebenfalls implementieren, so w"are -\begin{quote} - |\DeclareCaptionStyle{period-newline}%|\\ - | [labelsep=period,justification=centering]%|\\ - | {labelsep=period-newline}| -\end{quote} -eine geeignete Definition: -\begin{Example} - \captionsetup{style=period-newline2,labelfont=bf,margin=10pt} - \captionsetup{aboveskip=0pt,type=figure} - \ContinuedFloat - \caption[]{Eine Abbildung.} -\end{Example} - -Leicht abgewandelt w"urde sich auch bei l"angeren Beschriftungen eine Zentrierung ergeben: -\begin{quote} - |\DeclareCaptionStyle{period-newline}%|\\ - | [labelsep=period]%|\\ - | {labelsep=period-newline,justification=centering}| -\end{quote} -\begin{Example} - \captionsetup{style=period-newline3,labelfont=bf,margin=10pt} - \captionsetup{aboveskip=0pt,type=figure} - \caption[]{\figuretext} -\end{Example} - -\bigskip\pagebreak[3] -Ein anderes Beispiel: Die Beschriftungen sollen wie folgt aussehen: -\begin{Example} - \captionsetup{format=reverse,labelformat=fullparens,labelsep=fill,font=small,labelfont=it} - \captionsetup{aboveskip=0pt} - \captionof{figure}[]{\figuretext} -\end{Example} -\pagebreak[2] -Dies lie"se sich z.B. wie folgt realisieren: -\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}} - -\bigskip\pagebreak[3] -Ein weiteres Beispiel: Der Bezeichner soll in den linken Rand verlagert -werden, so da"s die komplette Absatzbreite der Beschriftung selber zugute kommt: -{\leftmargini=10pt - \begin{quote} - |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\ - |\captionsetup{format=llap,singlelinecheck=no,labelsep=quad}| - \end{quote}} -Das Ergebnis w"aren Beschriftungen wie diese: -\begin{Example} - \captionsetup{format=llap,labelsep=quad,singlelinecheck=no} - \captionsetup{aboveskip=0pt} - \captionof{figure}[]{\figuretext} -\end{Example} - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\section{Verwendung mit speziellen Dokumentenklassen} - -\NEWdescription{v3.0p} -Das \thispackage"=Paket ist auf die Verwendung mit den -Standard"=Dokumentenklassen |article|, |report| und |book| ausgelegt; -ferner funktioniert es mit den Niederl"andischen Klassen |artikel|, -|rapport| und |boek|. Es ist \emph{inkompatibel} mit allen anderen -Dokumentenklassen, es sei denn, sie basieren auf einer der oben genannten. - -Im Zweifelsfalle ist von der Verwendung des \thispackage"=Paketes abzuraten. -Man kann versuchen, es trotzdem einzubinden und hoffen, da"s das Dokument -"ubersetzt und sich keine Nebeneffekte einstellen. Ein Nebeneffekt w"are -zum Beispiel die Tatsache, da"s sich alleine durch das Einbinden des -\thispackage"=Paketes ohne Optionen das Aussehen der Bild- oder -Tabellenbeschriftungen "andert. (Ist dies der Fall, mu"s man damit rechnen, -da"s sich die Ausgabe bei der Verwendung von zuk"unftigen Versionen des -\thispackage"=Paketes "andern kann.) Ist dies in Ordnung, so kann man -Einstellungen an den Beschriftungen setzen und die Finger gekreuzt halten. - -Die Version \version{3.1} des \thispackage"=Paketes wird an viele -weitere Dokumentenklassen, wie z.B.~die \package{beamer}"=Klasse und -die \KOMAScript"=Klassen, angepasst sein. Die Ver"offentlichung ist -f"ur Sommer 2007 geplant. - -% --------------------------------------------------------------------------- % - -\pagebreak[3] -\section{Interaktion mit anderen Paketen} -\label{packages} - -Das \thispackage"=Paket enth"alt spezielle Anpassungen an andere Pakete, damit -die Beschriftungen dort ebenfalls genauso ausgegeben werden, wie man es mit den oben -genannten Optionen eingestellt hat. Im einzelnen sind dies die folgenden Pakete: - -\begin{tabular}{ll} - |float| & Erlaubt die Definition eigener gleitenen Umgebungsstile\\ -% |hyperref| & Setzt Hyperlinks\\ -% |hypcap| & Korrigiert die von \package{hyperref} gesetzten Anker bei Beschriftungen\\ - |listings| & Setzt Quelltexte diverser Programmiersprachen\\ - |longtable| & Setzt Tabellen, die sich "uber mehrere Seiten erstrecken k"onnen\\ - |rotating| & Unterst"utzt rotierende Abbildungen und Tabellen\\ - |sidecap| & Erlaubt das Setzen von Beschriftungen \emph{neben} Abbildungen\\ - |supertabular| & Setzt Tabellen, die sich "uber mehrere Seiten erstrecken k"onnen\\ -\end{tabular} - -\NEWfeature{v3.0b} -Wird eines dieser Pakete zusammen mit dem \thispackage"=Paket verwendet, steht -einem zus"atzlich die M"oglichkeit bereit, mittels -\begin{quote}|\captionsetup|\oarg{Umgebung}\marg{Optionen}\end{quote} -Optionen festzulegen, die lediglich f"ur diese Umgebung gelten. So bewirkt z.B. -\begin{quote}|\captionsetup[lstlisting]{labelfont=bf}|\quad,\end{quote} -da"s Beschriftungen innerhalb der |lstlisting|"=Umgebung automatisch mit fettem -Bezeichner gesetzt werden. -(Dies funktioniert allerdings nicht mit den |sideways|"=Umgebungen, die vom -\package{rotating}"=Paket angeboten werden.) - -Ist die Unterst"utzung eines dieser Pakete im speziellen Falle nicht erw"unscht, -so kann dies durch Angabe der Option -\begin{quote} - |\usepackage[|\ldots|,|\meta{Paketname}|=no]{caption}| -\end{quote} -erreicht werden, etwa |float=no|, wenn die Unterst"utzung des -\package{float}"=Paketes nicht erw"unscht wird. (Hinweis: Diese Optionen k"onnen -nur innerhalb des |\usepackage|"=Befehls angegeben werden, also insbesondere -\emph{nicht} nachtr"aglich mit |\captionsetup|.) - -N"ahere Informationen zu den einzelnen Paketen entnehmen Sie bitte der -dazugeh"origen Anleitung oder dem \LaTeX-Begleiter\cite{companion}. - -% --------------------------------------------------------------------------- % - -\subsection{Das \package{float}-Paket} -\label{float} - -Ein sehr n"utzliches Feature stellt das \package{float}"=Paket\cite{float} -mit dem Platzierungsparameter |[H]| bereit: -Anders als beim Parameter |h|, den \LaTeX\ bereitstellt und der lediglich -eine Empfehlung darstellt, die Abbildung oder Tabelle nach M"oglichkeit -"`hier"' zu setzen, ist das |H| viel kompromi"sloser, denn es erzwingt -das Setzen genau an diesem Ort und nirgendwo anders. - -Weiterhin definiert es f"ur gleitende Umgebungen die Stile |plain|, -|plaintop|, |ruled| und |boxed|. -F"ur die vorhandenen Umgebungen |figure| und |table| kann hierbei der Stil -ge"andert werden, ferner k"onnen eigene Umgebungstypen definiert werden, -die ggf.~ein eigenes Verzeichnis bekommen. - -Bzgl.~der Abst"ande ist zu beachten, da"s bei Umgebungen des Stils |plain|, -|plaintop| und |boxed| lediglich |\abovecaptionskip| (und kein -|\belowcaptionskip|) zur Anwendung kommt. Ferner wird dieser Abstand vom -\package{float}"=Paket gesetzt und nicht vom \package{caption}"=Paket; -das hat f"ur Sie als Anwender zur Folge, da"s dieser Abstand nicht innerhalb -der Umgebung selbst mit |\captionsetup| ver"andert werden kann, ferner ist -die Option |position=| bei diesen Umgebungen wirkungslos. - -Beim Stil |boxed| ist der Abstand mit -\begin{quote} - |\captionsetup[boxed]{skip=2pt}| -\end{quote} -voreingestellt, bei |plain| und |plaintop| wird die globale Einstellung -verwendet, sofern keine lokale definiert wurde. - -Kommt das \package{float}"=Paket zusammen mit dem \thispackage"=Paket zum -Einsatz, so wird automatisch der Beschriftungsstil |ruled| definiert, der das -Aussehen der Beschriftungen innerhalb von Abbildungen des Umgebungsstils -|ruled| regelt: -\begin{quote} - |\DeclareCaptionStyle{ruled}{labelfont=bf,labelsep=space}| -\end{quote} -F"ur den Anwender bedeutet dies, da"s allgemein get"atigte Einstellungen an den -Beschriftungen hier unwirksam sind; stattdessen werden die Beschriftungen genau -so gesetzt, wie vom \package{float}"=Paket stilistisch vorgegeben, n"amlich so: - -\ifx\floatstyle\undefined - -\begin{Example} -\hrule height.8pt depth0pt \kern2pt -\vbox{\strut{\bfseries Programm 7.1} - Das erste Programm. Dies hat nichts mit dem Paket an sich zu tun, - dient aber als Beispiel. Man beachte den \texttt{ruled} Stil.} -\kern2pt\hrule\kern2pt -\begin{verbatim} -#include <stdio.h> - -int main(int argc, char **argv) -{ - for (int i = 0; i < argc; ++i) - printf("argv[%d] = %s\n", i, argv[i]); - return 0; -} -\end{verbatim} -\kern2pt\hrule\relax -\end{Example} - -\else - -\floatstyle{ruled} -\newfloat{Program}{tbp}{lop}[section] -\floatname{Program}{Programm} - -\begin{Program}[H] -\begin{verbatim} -#include <stdio.h> - -int main(int argc, char **argv) -{ - for (int i = 0; i < argc; ++i) - printf("argv[%d] = %s\n", i, argv[i]); - return 0; -} -\end{verbatim} -\caption{Das erste Programm. Dies hat nichts mit dem Paket an sich zu tun, - dient aber als Beispiel. Man beachte den \texttt{ruled} Stil.} -\end{Program} - -\fi - -M"ochte man das Aussehen dieser Beschriftungen "andern, ist der Stil |ruled| -mittels -\begin{quote} - |\DeclareCaptionStyle{ruled}|\marg{Optionen} -\end{quote} -geeignet zu definieren. - -Dieser Mechanismus funktioniert auch bei allen anderen Umgebungsstilen, -d.h.~auch bei Umgebungen des Types |plain|, |plaintop| und |boxed| kann ein -geeigneter Beschriftungsstil mit gleichem Namen definiert werden, der dann -automatisch bei gleitenden Umgebungen dieses Types zum Einsatz kommt. - -% --------------------------------------------------------------------------- % - -\subsection{Das \package{listings}-Paket} -\label{listings} - -\NEWdescription{v3.0b} -Das \package{listings}"=Paket\cite{listings} erlaubt die Einbindung von -Quelltexten diverser Programmiersprachen. - -\textbf{Achtung:} Die Zusammenarbeit klappt erst ab der Version 1.2 des -\package{listings}"=Paketes. "Altere Versionen verursachen eine Fehlermeldung! - -% --------------------------------------------------------------------------- % - -\subsection{Das \package{longtable}-Paket} -\label{longtable} - -Das \package{longtable}"=Paket\cite{longtable} definiert die Umgebung -|longtable|, die sich wie eine Tabelle anwenden l"a"st, aber im Gegensatz zu -|tabular| Seitenumbr"uche innerhalb der Tabelle gestattet. - -% TODO: \DANGER wg. Abstand zur \caption, der f"ur "Uberschriften ausgelegt ist -% => "tableposition=b" -% --------------------------------------------------------------------------- % - -\subsection{Das \package{rotating}-Paket} -\label{rotating} - -Das \package{rotating}"=Paket\cite{rotating} stellt u.a.~die -gleitenden Umgebungen \texttt{sideways\-figure} und \texttt{sideways\-table} -bereit, die im Gegensatz zu |figure| und |table| um 90 Grad gedreht werden -und immer eine ganze Seite einnehmen. - -% --------------------------------------------------------------------------- % - -\subsection{Das \package{sidecap}-Paket} -\label{sidecap} - -\NEWdescription{v3.0b} -Das \package{sidecap}"=Paket\cite{sidecap} definiert die Umgebungen |SCfigure| -und |SCtable|, die analog zu |figure| und |table| funktionieren, aber -Beschriftungen \emph{neben} der Abbildung oder Tabelle erlauben. - -Bei der Verwendung des \package{sidecap}"=Paketes ist zu beachten, da"s eine -dort angegebene Option |raggedright|, |raggedleft| oder |ragged| den Parameter -|justification=| des \thispackage"=Paketes f"ur die betreffenen Umgebungen -"uberschreibt, d.h.~bei Beschriftungen \emph{neben} der Abbildung oder Tabelle -erh"alt die Option des \package{sidecap}"=Paketes den Vorzug. - -\DescribeMacro{listof=} -%\NEWfeature{v3.0b} -Ferner liegt es im Design des \package{sidecap}"=Paketes begr"undet, -da"s das Unterdr"ucken des Verzeichniseintrages mit |\caption[]{|\ldots|}| -hier nicht klappt. Als Alternative kann in diesen F"allen die Unterdr"uckung -mittels |\captionsetup{listof=false}| innerhalb der Abbildung oder Tabelle -geschehen. - -\ifx\SCfigure\undefined - -\begin{Example} - \newsavebox\scbox - \begin{lrbox}{\scbox} - \setlength{\unitlength}{.75cm}% - \setlength{\fboxsep}{0pt}% - \fbox{\begin{picture}(4,4)% - \put(1,3){\circle{1}}% - \put(3,3){\circle{1}}% - \put(2,2){\circle{1}}% - \put(1,1){\circle{1}}% - \put(3,1){\circle{1}}% - \end{picture}}% - \end{lrbox} - \newlength\scboxwidth - \setlength\scboxwidth{\wd\scbox} - \makebox[\linewidth][c]{% - \parbox[b]{\scboxwidth}{\unhbox\scbox}% - \hspace\marginparsep - \parbox[b]{1.5\scboxwidth}{% - \captionsetup{justification=RaggedRight,labelfont=bf} - \captionof{figure}[]{Ein kleines Beispiel mit Beschriftung neben der Abbildung.}% - }% - } -\end{Example} - -\else - -\captionsetup{labelfont=bf} -\begin{SCfigure}[1.5][!ht] - \setlength{\unitlength}{.75cm}% - \setlength{\fboxsep}{0pt}% - \fbox{\begin{picture}(4,4)% - \put(1,3){\circle{1}}% - \put(3,3){\circle{1}}% - \put(2,2){\circle{1}}% - \put(1,1){\circle{1}}% - \put(3,1){\circle{1}}% - \end{picture}}% -% \captionsetup{labelfont=bf} - \caption[]{Ein kleines Beispiel mit Beschriftung neben der Abbildung.} -\end{SCfigure} -\captionsetup{labelfont=default} - -\fi - -% --------------------------------------------------------------------------- % - -\subsection{Das \package{supertabular}-Paket} - -Das \package{supertabular}"=Paket\cite{supertabular} definiert, "ahnlich wie -das \package{longtable}"=Paket, eine Umgebung |supertabular|, die sich -ebenfalls wie eine Tabelle anwenden l"a"st, aber im Gegensatz zu |tabular| -Seitenumbr"uche innerhalb der Tabelle gestattet. - -Eine ausf"uhrliche Behandlung der Unterschiede zwischen den beiden Paketen -\package{longtable} und \package{supertabular} ist im Buch "`Der \LaTeX-Begleiter"' -\cite{companion} zu finden. - -% --------------------------------------------------------------------------- % - -\subsection{Bekannte Inkompatibilit"aten} - -\NEWdescription{v3.0b} -Die Verwendung des \thispackage"=Paketes in Verbindung mit folgenden Paketen -ist nicht empfehlenswert, da es zu unerw"unschten Seiteneffekten -oder gar Fehlern kommen kann: -\begin{quote} - \package{ccaption}, \package{ftcap}, \package{hvfloat} und - \package{nonfloat} -\end{quote} - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\section{Kompatibilit"at zu "alteren Versionen} -\label{compatibility} - -\subsection{Das \package{caption}-Paket Version $1.x$} - -Diese Version des \thispackage"=Paketes ist weitgehend kompatibel zu "alteren -Versionen des Paketes; alte, vorhandene Dokumente sollten sich also in der -Regel ohne Probleme weiterhin "ubersetzen lassen. (Sollten wider Erwarten -Probleme auftauchen, schreiben sie mir bitte eine E-Mail.) - -Jedoch ist zu beachten, da"s eine Mischung aus alten Befehlen und neueren -Optionen bzw.~Befehlen zu unerw"unschten Nebeneffekten f"uhren kann. - -Hier eine kurze "Ubersicht "uber die alten, "uberholten Optionen und ihre -aktuellen Entsprechungen: - -{\small\begin{longtable}{ll} -\package{caption} \version{1.x} & \thispackage\ \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}} - -Neben den Optionen zum Einstellen des Zeichensatzes gab es auch die Befehle -|\captionsize| bzw. |\captionfont| und |\captionlabelfont|, die direkt -mittels |\renewcommand| ver"andert werden konnten. Dieser Mechanismus -wurde durch die Anweisungen -\begin{quote} - |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad und\\ - |\captionsetup{font=|\ldots|,labelfont=|\ldots|}| -\end{quote} -ersetzt. \SeeUserDefined - -Das Setzen eines Randes geschah in \version{1.x} mittels -\begin{quote} - |\setlength{\captionmargin}{|\ldots|}|\quad. -\end{quote} -Dies wurde durch -\begin{quote} - |\captionsetup{margin=|\ldots|}| -\end{quote} -ersetzt. \See{\Section{margins}{R"ander und Abs"atze}} - -Zum Beispiel w"urde -\begin{quote} -|\usepackage[hang,bf]{caption}|\\ -|\renewcommand\captionfont{\small\sffamily}|\\ -|\setlength\captionmargin{10pt}| -\end{quote} -in aktueller Notation -\begin{quote} -|\usepackage[format=hang,labelfont=bf,font={small,sf},|\\ -| margin=10pt]{caption}| -\end{quote} -bzw. -\begin{quote} -|\usepackage{caption}|\\ -|\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\ -| margin=10pt}| -\end{quote} -hei"sen. - -Die etwas exotische Option |ruled|, die eine partielle Anwendung der -eingestellten Parameter bei gleitenden Umgebungen des Typs |ruled| -aktivierte, wird ebenfalls emuliert, hat aber keine direkte -Entsprechung in dieser Version des \thispackage"=Paketes. -M"ochte man gezielt das Aussehen der Abbildungen des Stils |ruled|, -der durch das \package{float}"=Paket zur Verf"ugung gestellt wird, -ver"andern, so ist dies nun durch -\begin{quote} - |\DeclareCaptionStyle{ruled}{|\ldots|}| -\end{quote} -bzw. -\begin{quote} - |\captionsetup[ruled]{|\ldots|}| -\end{quote} -m"oglich. \SeeUserDefined[ und \Section*{misc}{N"utzliches} sowie - \Section*{float}{Das \package{float}-Paket}] - -\subsection{Das \package{caption2}-Paket Version $2.x$} - -Die Pakete \package{caption} und seine experimentelle, nun veraltete -Variante \package{caption2} sind vom internen Konzept -her zu unterschiedlich, um hier eine vollst"andige Kompatibilit"at -gew"ahrleisten zu k"onnen. -Daher liegt diesem Paket weiterhin die Datei |caption2.sty| bei, so da"s -"altere Dokumente, die das \package{caption2}"=Paket verwenden, weiterhin -"ubersetzt werden k"onnen. - -Neue Dokumente sollten jedoch auf dem aktuellen \thispackage"=Paket -aufgesetzt werden. In den meisten F"allen ist es ausreichend, einfach -ggf.~die Anweisung -\begin{quote} - |\usepackage[...]{caption2}| -\end{quote} -durch -\begin{quote} - |\usepackage[...]{caption}| -\end{quote} -zu ersetzen. Einige Optionen und Befehle werden jedoch nicht emuliert, -so da"s sie anschlie"send Fehlermeldungen erhalten k"onnen. -Die folgenden Abs"atze werden Ihnen jedoch bei der Umsetzung dieser -Optionen und Befehle helfen. Sollten dar"uberhinaus noch Fragen oder -Probleme auftreten, so z"ogern Sie bitte nicht, mich diesbez"uglich -per E-Mail zu kontaktieren. - -Zus"atzlich zu den bereits im vorherigen Abschnitt vorgestellten Optionen -werden auch folgende emuliert: - -{\small\begin{longtable}{ll} -\package{caption2} \version{2.x} & \thispackage\ \version{3.x}\\ -\hline -\endhead -|flushleft| & |justification=raggedright|\\ -|flushright| & |justification=raggedleft|\\ -|oneline| & |singlelinecheck=on|\\ -\end{longtable}} - -Das Setzen eines Randes geschah in \version{2.x} mittels -\begin{quote}\leavevmode\hbox{% - |\setcaptionmargin{|\ldots|}| bzw. - |\setcaptionwidth{|\ldots|}|\quad. -}\end{quote} -Dies wurde durch -\begin{quote}\leavevmode\hbox{% - |\captionsetup{margin=|\ldots|}| bzw. - |\captionsetup{width=|\ldots|}| -}\end{quote} -ersetzt. \See{\Section{margins}{R"ander und Abs"atze}} - -Das Setzen des Einzuges wurde in \version{2.x} mit -\begin{quote} - |\captionstyle{indent}|\\ - |\setlength\captionindent{|\ldots|}| -\end{quote} -erledigt, dies geschieht nun mit -\begin{quote} - |\captionsetup{format=plain,indention=|\ldots|}|\quad. -\end{quote} - -Die Sonderbehandlung von einzeiligen Beschriftungen lie"s sich in -\version{2.x} mit |\oneline|\-|captions|\-|false| aus- -bzw. |\oneline|\-|captions|\-|true| wieder einschalten. Dies wurde durch -|\captionsetup{|\discretionary{}{}{}|singlelinecheck=|\discretionary{}{}{}|off}| -bzw. -|\captionsetup{|\discretionary{}{}{}|singlelinecheck=|\discretionary{}{}{}|on}| -ersetzt. \See{\Section{justification}{Textausrichtung}} - -Die Befehle -\begin{quote} - |\captionlabeldelim|, |\captionlabelsep|, |\captionlabelfalse|, - |\captionstyle|, |\defcaptionstyle|, |\newcaptionstyle| und |\renewcaptionstyle| -\end{quote} -haben keine direkte Entsprechnung und werden daher durch diese -Version des \thispackage"=Paketes auch nicht emuliert. -Sie f"uhren also bei der Verwendung %mit diesem \thispackage"=Paket -zu Fehlermeldungen und m"ussen daher zwingend umgesetzt werden. -Die Umsetzung ist von Fall zu Fall verschieden, lesen Sie sich daher bitte -diese Anleitung gr"undlich durch und suchen Sie sich die Optionen bzw.~Befehle -als Ersatz heraus, die Ihren W"unschen entsprechen. -\iffalse -Als kleine Hilfestellung hier die Beispiele aus der alten Anleitung zum -\package{caption2}"=Paket und deren Umsetzung: - -\newenvironment{OldNew}% - {\begin{minipage}\linewidth - \def\Old{Alt:\begin{quote}}% - \def\New{\end{quote}Neu:\begin{quote}}% - \def\Or{\end{quote}\centerline{-- oder --}\begin{quote}}% - }% - {\end{quote}\end{minipage}} - -\begin{OldNew} -\Old - |\captionstyle{center}| -\New - |\captionsetup{justification=centering}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\captionstyle{indent}|\\ - |\setlength{\captionindent}{1cm}| -\New - |\captionsetup{format=plain,indention=1cm}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\renewcommand\captionfont{\small}|\\ - |\renewcommand\captionlabelfont{\itshape}| -\New - |\captionsetup{font=small,labelfont=it}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\renewcommand\captionfont{\small\itshape}|\\ - |\renewcommand\captionlabelfont{\upshape}| -\New - |\captionsetup{font=small,textfont=it}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\setcaptionwidth{.5\textwidth}| -\New - |\captionsetup{width=.5\textwidth}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\setcaptionmargin{.25\textwidth}| -\New - |\captionsetup{margin=.25\textwidth}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{absatz}{\captionlabel: \captiontext\par}|\\ - |\captionstyle{absatz}| -\New - |\DeclareCaptionFormat{absatz}{#1: #3\par}|\\ - |\captionsetup{format=absatz,singlelinecheck=off}| -\Or - |\captionsetup{format=plain,singlelinecheck=off}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{fancy}{\textsf{\captionlabel}\\\captiontext\par}|\\ - |\captionstyle{fancy}| -\New - |\DeclareCaptionFormat{fancy}{\textsf{#1}\\#3\par}|\\ - |\captionsetup{format=fancy,singlelinecheck=off}| -\Or - |\captionsetup{format=plain,labelfont=sf,labelsep=newline}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{fancy2}{\captiontext\hfill\textit{(\captionlabel)}}|\\ - |\captionstyle{fancy2}| -\New - |\DeclareCaptionFormat{fancy2}{#3\hfill\textit{(#1)}}|\\ - |\captionsetup{format=fancy2,singlelinecheck=off}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{mystyle}{%|\\ - | \normalcaptionparams|\\ - | \renewcommand\captionlabelfont{\bfseries}%|\\ - | \renewcommand\captionlabeldelim{.}%|\\ - | \onelinecaptionsfalse|\\ - | \usecaptionstyle{centerlast}}|\\ - |\captionstyle{mystyle}| -\New - |\DeclareCaptionStyle{mystyle}{labelfont=bf,labelsep=period,justification=centerlast}|\\ - |\captionsetup{style=mystyle}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{hangandleft}{%|\\ - | \let\oldcaptiontext\captiontext|\\ - | \def\captiontext{\raggedright\oldcaptiontext}%|\\ - | \usecaptionstyle{hang}}|\\ - |\captionstyle{hangandleft}| -\New - |\captionsetup{format=hang,justification=raggedright}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{fancy}{%|\\ - | \usecaptionmargin\captionfont|\\ - | \onelinecaption|\\ - | {{\captionlabelfont\captionlabel\captionlabeldelim}%|\\ - | \captionlabelsep\captiontext}%|\\ - | {{\centering\captionlabelfont\captionlabel\par}%|\\ - | \centerlast\captiontext\par}}|\\ - |\captionstyle{fancy}| -\New - |\DeclareCaptionFormat{fancy}{\centering#1\par\centerlast#3\par}|\\ - |\DeclareCaptionStyle{fancy}|\\ - | [format=plain,justification=centering]|\\ - | {format=fancy}|\\ - |\captionsetup{style=fancy}| -\Or - |\DeclareCaptionFormat{fancy}{#1\par#3\par}|\\ - |\DeclareCaptionStyle{fancy}|\\ - | [format=plain,justification=centering]|\\ - | {format=fancy,justification=centerlast}|\\ - |\captionsetup{style=fancy}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\renewcaptionstyle{longtable}{\usecaptionstyle{normal}}| -\New - |\captionsetup[longtable]{format=plain}| -\end{OldNew} -\fi - -Ebenfalls keine Entsprechung hat die \version{2.x}"=Option |ignoreLTcapwidth|. -Deren Verwendung kann in der Regel einfach entfallen, da das -\thispackage"=Paket den Wert von |\LTcapwidth| sowieso nicht beachtet, -solange er nicht explizit auf einen anderen Wert als den Standardwert -gesetzt wird. -\See{\Section{longtable}{Das \package{longtable}"=Paket}} - -% --------------------------------------------------------------------------- % - -%\pagebreak[4] -\section{Weiterf"uhrende Dokumente} - -Folgende Dokumente m"ochte ich an dieser Stelle jedem ans Herz legen: - -\begin{itemize} -\item - Die DANTE-FAQ:\nopagebreak - \begin{quote} - \url{http://www.dante.de/faq/de-tex-faq/} - \end{quote} - -\item - \emph{"`Gleitobjekte -- die richtige Schmierung"'} von Axel Reichert - erl"autert den Umgang mit gleitenden Umgebungen und ist hier im Netz - zu finden:\nopagebreak - \begin{quote} - \url{ftp://ftp.dante.de/pub/tex/info/german/gleitobjekte/} - \end{quote} - -\item - \textsf{epslatex} von Keith Reckdahl enth"alt viele n"utzliche Tips im - Zusammenhang mit der Einbindung von Graphiken in \LaTeXe. - Das Dokument ist unter\nopagebreak - \begin{quote} - \url{ftp://ftp.dante.de/pub/tex/info/epslatex/} - \end{quote} - zu finden. -\end{itemize} - -% --------------------------------------------------------------------------- % - -%\pagebreak[3] -\section{Danksagungen} - -Von ganzem Herzen danke ich Katja Melzner, -Steven D. Cochran, Frank Mittelbach, -David Carlisle, Carsten Heinz, Olga Lapko und Keith Reckdahl. - -Weiterhin m"ochte ich mich herzlich bei -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 -und -Prof.~Dr.~Dirk Hoffmann -f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\begin{thebibliography}{9} - \bibitem{companion} - Frank Mittelbach and Michel Goossens: - \newblock {\em The {\LaTeX} Companion (2nd.~Ed.)}, - \newblock Addison-Wesley, 2004. - - \bibitem{float} - Anselm Lingnau: - \emph{An Improved Environment for Floats}, - 2001/11/08 - - \bibitem{floatrow} - Olga Lapko: - \emph{The floatrow package documentation}, - 2005/05/22 - - \bibitem{hyperref} - Sebastian Rahtz \& Heiko Oberdiek: - \emph{Hypertext marks in \LaTeX}, - 2007/01/25 - - \bibitem{hypcap} - Heiko Oberdiek: - \emph{The hypcap package -- Adjusting anchors of captions} - 2007/02/19 - - \bibitem{listings} - Carsten Heinz: - \emph{The Listings Package}, - 2004/02/13 - - \bibitem{longtable} - David Carlisle: - \emph{The longtable package}, - 2000/10/22 - - \bibitem{rotating} - Sebastian Rahtz and Leonor Barroca: - \emph{A style option for rotated objects in \LaTeX}, - 1997/09/26 - - \bibitem{sidecap} - Rolf Niepraschk und Hubert G"a"slein: - \emph{The sidecap package}, - 2003/06/06 - - \bibitem{subfig} - Steven D. Cochran: - \emph{The subfig package}, - 2005/07/05 - - \bibitem{supertabular} - Johannes Braams und Theo Jurriens: - \emph{The supertabular environment}, - 2002/07/19 -\end{thebibliography} - -\end{document} diff --git a/Master/texmf-dist/doc/latex/caption/caption-deu.pdf b/Master/texmf-dist/doc/latex/caption/caption-deu.pdf Binary files differnew file mode 100644 index 00000000000..3d0d700d8df --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/caption-deu.pdf diff --git a/Master/texmf-dist/doc/latex/caption/caption-deu.tex b/Master/texmf-dist/doc/latex/caption/caption-deu.tex new file mode 100644 index 00000000000..c4f06dc4566 --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/caption-deu.tex @@ -0,0 +1,2909 @@ +% +% This is file `caption-deu.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-deu.tex}[2007/09/03 v3.1 Das caption-Paket] +\hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. +%\errorcontextlines=3 + +\documentclass[a4paper]{ltxdoc} +\setlength\parindent{0pt} +\setlength\parskip{\medskipamount} + +%%%\usepackage[T1]{fontenc} +\ifx\pdfoutput\undefined\else + \ifcase\pdfoutput\else + \usepackage{mathptmx,courier} + \usepackage[scaled=0.90]{helvet} + \addtolength\marginparwidth{15pt} + \fi +\fi + +\usepackage[german]{babel} +\IfFileExists{selinput.sty}% + {\usepackage{selinput}\SelectInputMappings{adieresis={д},germandbls={Я}}}% + {\usepackage[latin1]{inputenc}} +\usepackage{longtable,setspace} + +\usepackage{hypdoc}\hypersetup{german} +\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{das \package{caption}"=Paket} +\def\Thispackage{Das \package{caption}"=Paket} + +\newcommand\NEWfeature{\NEW{Neues Feature}} +\newcommand\NEWdescription{\NEW{Neue Beschreibung}} + +\makeatletter +\newcommand*\Ref{\@ifstar{\@Ref\ref}{\@Ref\autoref}} +\newcommand*\@Ref[2]{#1{#2}: \textit{"`\nameref{#2}"'}} +\makeatother +\newcommand*\See[1]{{\small (Siehe #1)}} +\newcommand*\SeeUserDefined[1][]{\See{\Ref{declare}#1}} + +\def\TODO{\emph{-- Hier fehlt noch 'was --}} + +% --------------------------------------------------------------------------- % + +\GetFileInfo{caption-deu.tex} +\let\docdate\filedate +\GetFileInfo{caption.sty} + +\title{Setzen von Abbildungs- und Tabellenbeschriftungen mit dem + caption-Paket\texorpdfstring{\thanks{% + Dieses Paket hat die Versionsnummer \fileversion, + zuletzt ge"andert am \filedate.}}{}} +\author{Axel Sommerfeldt\\ + \href{mailto:caption@sommerfee.de}{\texttt{caption@sommerfee.de}}} +\date{\docdate} +\maketitle + +% --------------------------------------------------------------------------- % + +\begin{abstract} +\Thispackage\ bietet einem Mittel und Wege das Erscheinungsbild der +Bildunterschriften und Tabellen"uberschriften den eigenen W"unschen +bzw.\ bestimmten Vorgaben anzupassen. +Hierbei wurde viel Wert auf die reibungslose Zusammenarbeit und in die +Integration anderer Dokumentenklassen und Pakete gelegt.\footnote{F"ur die +Version 3.0 dieses Paketes wurde die Benutzerschnittstelle zusammen +mit Steven D. Cochran und Frank Mittelbach komplett "uberarbeitet.} +\end{abstract} + +\newcommand\exampletext{% + Die auf die Rotationsfrequenz des Innenzylinders normierten Eigenfrequenzen + der gefundenen Grundmoden der Taylor"=Str"omung f"ur \mbox{$\eta = 0.5$}. %\\ + (Die azimutale Wellenzahl ist mit $m$ bezeichnet.)} + +% --------------------------------------------------------------------------- % + +\section*{Einleitung} + +Mit |\caption| gesetzte Bildunterschriften und Tabellenьberschriften werden +von den Standard"=Dokumentenklassen eher stiefmьtterlich behandelt. +In der Regel schlicht als ganz normaler Absatz gesetzt, ergibt sich keine +signifikante optische Abgrenzung vom eigentlichen Text, wie z.B. hier: + +\example*{size=normalsize,margin=0pt}{\exampletext} + +Es sollte aber eine Mцglichkeit geben, diesem Umstand abzuhelfen. Es wдre +zum Beispiel nett, wenn man den Text der Unterschrift etwas kleiner gestalten, +extra Rдnder festlegen oder den Zeichensatz des Bezeichners dem der +Kapitelьberschriften anpassen kцnnte. So in etwa: + +\example*{size=small,margin=10pt,labelfont=bf,labelsep=endash}{\exampletext} + +Mit Hilfe dieses Paketes kцnnen Sie dies leicht bewerkstelligen; es sind viele +vorgegebene Parameter einstellbar, Sie kцnnen aber auch eigene +Gestaltungsmerkmale einflieЯen lassen. + +% --------------------------------------------------------------------------- % + +\clearpage +\section*{Vorlдufige Dokumentation} + +Diese Anleitung beschreibt leider noch nicht alle Fassetten und Mцglichkeiten, +die einem \thispackage\ bietet. Ich werde mich bemьhen, jeden Monat eine +etwas vollstдndigere Fassung bereitzustellen; die jeweile aktuelle Fassung kann +\href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/caption/caption-eng.pdf}% +{hier} bezogen werden.\par\bigskip + +% --------------------------------------------------------------------------- % + +%\clearpage +\tableofcontents + +% --------------------------------------------------------------------------- % + +\clearpage +\section{Verwendung des Paketes} +\label{usage} + +\DescribeMacro{\usepackage} +Mittels +\begin{quote} + |\usepackage|\oarg{Optionen}|{caption}[|\texttt{\filedate}|]| +\end{quote} +in dem Vorspann des Dokumentes wird das \thispackage\ Paket eingebunden, die +Optionen legen hierbei das Aussehen der "Uber- und Unterschriften fest. So +w"urde z.B. +\begin{quote} + |\usepackage[margin=10pt,font=small,labelfont=bf,|\\ + | labelsep=endash]{caption}|% + %|[|\texttt{\filedate}|]| +\end{quote} +zu dem obrigen Ergebnis mit Rand, kleinerem Zeichensatz und fetter Bezeichnung +f"uhren. + +\DescribeMacro{\captionsetup} +Eine "Anderung der Parameter ist auch zu einem sp"ateren Zeitpunkt jederzeit +mittels des Befehls +\begin{quote} + |\captionsetup|\oarg{Typ}\marg{Optionen} +\end{quote} +m"oglich. So sind z.B. die Befehlssequenzen +\begin{quote} + |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}| +\end{quote} +und +\begin{quote} + |\usepackage{caption}|\\ + |\captionsetup{margin=10pt,font=small,labelfont=bf}| +\end{quote} +in ihrer Wirkung identisch. + +Weiterhin gilt zu beachten, da"s sich die Verwendung von |\captionsetup| +innerhalb von Umgebungen nur auf die Umgebung selber auswirkt, nicht aber auf +den Rest des Dokumentes. M"ochte man also z.B. die automatische Zentrierung der +Abbildungsunterschrift nur in einem konkreten Falle ausschalten, so kann dies +mit +\begin{quote} + |\begin{figure}|\\ + | |\ldots\\ + | \captionsetup{singlelinecheck=off}|\\ + | \caption{|\ldots|}|\\ + |\end{figure}| +\end{quote} +geschehen, ohne da"s die restlichen Abbildungsunterschriften hiervon +beeintr"achtigt werden. + +(Der optionale Parameter \meta{Typ} wird in \Ref{commands} behandelt.) + +% --------------------------------------------------------------------------- % + +\pagebreak[4] +\section{Optionen} +\label{options} + +\def\OptionLabel{RaggedRight} +\def\UserDefined{\ldots} + +% --------------------------------------------------------------------------- % + +\subsection{Formatierung} +\label{formats} + +\DescribeMacro{format=} +Eine Abbildungs- oder Tabellenbeschriftung besteht im wesentlichen aus drei +Teilen: +Dem Bezeichner (etwa "`Abbildung 3"'), dem Trenner +(etwa "`:\textvisiblespace"') und dem eigentlichen Text. +Mittels der Option +\begin{quote} + |format=|\meta{Name} +\end{quote} +wird festgelegt, wie diese drei Teile zusammengesetzt werden. +F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar:%\footnote{Es gibt +%hier wie auch bei vielen anderen Optionen die M"oglichkeit, auch eigene +%Formate, Zeichens"atze etc.\ zu definieren. Wie dies geht wird in Abschnitt +%\ref{declare}: \textit{"`Eigene Erweiterungen"'} dargelegt.} + +\begin{Options}{\OptionLabel} + \item[plain]%\NEWdescription{v3.0h} + Die Beschriftung wird als gew"ohnlicher Abschnitt gesetzt. + + \item[hang] + Der Text wird so gesetzt, da"s er an dem Bezeichner "`h"angt"', d.h.~der + Platz unter dem Bezeichner und dem Trenner bleibt leer. + + \item[\UserDefined] + Eigene Formate k"onnen mittels |\DeclareCaptionFormat| definiert werden. + \SeeUserDefined +\end{Options} + +\begin{Example} + Ein Beispiel: Die Angabe der Option + \begin{quote} + |format=hang| + \end{quote} + f"uhrt zu Abbildungsunterschriften der Art + \example{format=hang}{\exampletext} +\end{Example} + +\DescribeMacro{indention=} +Bei beiden Formaten (\texttt{plain} und \texttt{hang}) kann der Einzug der Beschriftung +ab der zweiten Textzeile angepasst werden, dies geschieht mit Hilfe der Option +\begin{quote} + |indention=|\meta{Einzug}\quad, +\end{quote} +wobei anstelle von \meta{Einzug} jedes beliebige feste Ma"s angegeben werden kann. + +Zwei Beispiele: + +\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=} +Mittels der Option +\nopagebreak[3] +\begin{quote} + |labelformat=|\meta{Name} +\end{quote} +\nopagebreak[3] +%\NEWdescription{v3.0e} +wird die Zusammensetzung des Bezeichners festgelegt. +F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: + +\begin{Options}{\OptionLabel} + \item[default] + Der Bezeichner wird wie von der verwendeten Dokumentenklasse vorgegeben gesetzt, + "ublicherweise ist dies der Name und die Nummer, getrennt durch ein Leerzeichen + (wie \texttt{simple}). + (Dies ist das Standardverhalten.) + + \item[empty] + Der Bezeichner ist leer. (Diese Option macht in der Regel nur in Verbindung mit + anderen Optionen -- wie etwa \texttt{labelsep=none} -- Sinn.) + + \item[simple] + Der Bezeichner ist aus dem Namen und der Nummer zusammengesetzt. + + \item[parens] + Die Nummer des Bezeichners wird in runde Klammern gesetzt. + + \item[\UserDefined] + Eigene Formate k"onnen mittels |\DeclareCaptionLabelFormat| definiert werden. + \SeeUserDefined +\end{Options} + +\begin{Example} + Ein Beispiel: Die Optionen + \begin{quote} + |labelformat=parens,labelsep=quad| + \end{quote} + f"uhren zu Abbildungsunterschriften der Art + \example{labelformat=parens,labelsep=quad}{\exampletext} +\end{Example} + +\DescribeMacro{labelsep=} +Mittels der Option +\begin{quote} + |labelsep=|\meta{Name} +\end{quote} +wird die Zusammensetzung des Trenners festgelegt. +F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: + +\begin{Options}{\OptionLabel} + \item[none] + Der Trenner ist leer. (Diese Option macht in der Regel nur in Verbindung + mit anderen Optionen -- wie etwa \texttt{labelformat=empty} -- Sinn.) + + \item[colon] + Der Trenner besteht aus einem Doppelpunkt und einem Leerzeichen. + + \item[period] + Der Trenner besteht aus einem Punkt und einem Leerzeichen. + + \item[space] + Der Trenner besteht lediglich aus einem einzelnen Leerzeichen. + + \item[quad] + Der Trenner besteht aus einem |\quad|. + + \item[newline] + Als Trenner wird ein Zeilenumbruch verwendet. + + \item[endash]%\NEWfeature{v3.0h} + Als Trenner wird ein Gedankenstrich verwendet. + + \item[\UserDefined] + Eigene Trenner k"onnen mittels |\DeclareCaptionLabelSeparator| definiert werden. + \SeeUserDefined +\end{Options} + +Drei Beispiele: +\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{Textausrichtung} +\label{justification} + +\DescribeMacro{justification=} +Mittels der Option +\begin{quote} + |justification=|\meta{Name} +\end{quote} +wird die Ausrichtung des Textes festgelegt. +F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: + +\begin{Options}{\OptionLabel} + \item[justified] + Der Text wird als Blocksatz gesetzt. + + \item[centering] + Der Text wird zentriert gesetzt. + +% \item[Centering] +% Der Text wird zentriert gesetzt. Hierf"ur wird jedoch im Gegensatz +% zu \texttt{centering} der Befehl |\Centering| des \package{ragged2e}-Paketes +% verwendet, der \LaTeX\ das Trennen der Worte erlaubt. + + \item[centerlast] + Lediglich die letzte Zeile des Textes wird zentriert gesetzt. + + \item[centerfirst] + Lediglich die erste Zeile des Textes wird zentriert gesetzt. + + \item[raggedright] + Der Text wird linksb"undig gesetzt. + +% \item[RaggedRight] +% Der Text wird linksb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. + \item[RaggedRight] + Der Text wird ebenfalls linksb"undig gesetzt. Hierf"ur wird jedoch im Gegensatz + zu \texttt{raggedright} der Befehl |\RaggedRight| des \package{ragged2e}-Paketes + verwendet, der \LaTeX\ das Trennen der Worte erlaubt. + + \item[raggedleft] + Der Text wird rechtsb"undig gesetzt. + +% \item[RaggedLeft] +% Der Text wird rechtsb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. + + \item[\UserDefined] + Eigene Ausrichtungen k"onnen mittels |\DeclareCaptionJustification| definiert werden. + \SeeUserDefined +\end{Options} + +Einige Beispiele: +\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} + |format=hang,justification=RaggedRight| + \end{quote} + \captionsetup{aboveskip=0pt} + \example{belowskip=\abovecaptionskip,format=hang,justification=RaggedRight}{\exampletext} +\end{Example} + +\begin{Example} + \begin{quote} + |labelsep=newline,justification=centering| + \end{quote} + \captionsetup{aboveskip=0pt} + \example{belowskip=\abovecaptionskip,labelsep=newline,justification=centering}{\exampletext} +\end{Example} + +\DescribeMacro{singlelinecheck=} +In den Standard"=Dokumentenclassen |article|, |report| und |book| sind die +Ab\-bildungs- und Tabellenbeschriftungen so realisiert, da"s sie automatisch +zentriert werden, wenn sie lediglich aus einer einzigen Textzeile bestehen: + +\example*{}{Eine kurze Beschriftung.} + +%\example{belowskip=\abovecaptionskip}{% +% Eine lange Beschriftung, die gen"ugend Text enth"alt, um l"anger als +% eine einzelne Zeile zu sein.} + +\INFO +Diesen Mechanismus "ubernimmt \thispackage\ und ignoriert damit +in der Regel bei solch kurzen Beschriftungen die mittels der Optionen +|format=| und |justification=| eingestellte Textausrichtung. +Dieses Verhalten kann jedoch mit der Option +\begin{quote} + |singlelinecheck=|\meta{bool} +\end{quote} +reguliert werden. Setzt man f"ur \meta{bool} entweder |false|, |no|, |off| +oder |0| ein, so wird der Zentrierungsmechnismus au"ser Kraft gesetzt. +Die obrige, kurze Abbildungsunterschrift w"urde z.B. nach Angabe der Option +\begin{quote} + |singlelinecheck=false| +\end{quote} +so aussehen: + +\begingroup + \captionsetup{type=figure} + \ContinuedFloat + \example*{singlelinecheck=false}{Eine kurze Beschriftung.} +\endgroup + +Setzt man f"ur \meta{bool} hingegen |true|, |yes|, |on| oder |1| ein, so +wird die automatische Zentrierung wieder eingeschaltet. (Standardm"a"sig +ist sie eingeschaltet.) + +% --------------------------------------------------------------------------- % + +\subsection{Zeichens"atze} +\label{fonts} + +\DescribeMacro{font=} +\DescribeMacro{labelfont=} +\DescribeMacro{textfont=} +Das \thispackage-Paket kennt 3 Zeichens"atze: Denjenigen f"ur die gesammte Beschriftung +(|font|), denjenigen, der lediglich auf den Bezeichner und den Trenner angewandt wird +(|labelfont|), sowie denjenigen, der lediglich auf den Text wirkt (|textfont|). +So lassen sich die unterschiedlichen Teile der Beschriftung individuell mittels +\begin{quote}\begin{tabular}{@{}r@{}ll} + |font=| & \marg{Zeichensatzoptionen} & ,\\ + |labelfont=| & \marg{Zeichensatzoptionen} & und\\ + |textfont=| & \marg{Zeichensatzoptionen} & \\ +\end{tabular}\end{quote} +\nopagebreak[3] +anpassen. +\pagebreak[3] + +Als \meta{Zeichensatzoptionen} sind eine Kombination aus folgendem erlaubt: + +\begin{Options}{\OptionLabel} + \item[scriptsize] {\scriptsize Sehr kleine Schrift} + \item[footnotesize] {\footnotesize Fu"snotengr"o"se} + \item[small] {\small Kleine Schrift} + \item[normalsize] {\normalsize Normalgro"se Schrift} + \item[large] {\large Gro"se Schrift} + \item[Large] {\Large Gr"o"sere Schrift} + + \item[up] {\upshape Upright Schriftart} + \item[it] {\itshape Italic Schriftart} + \item[sl] {\slshape Slanted Schriftart} + \item[sc] {\scshape Small Caps Schriftart} + + \item[md] {\mdseries Medium Schriftserie} + \item[bf] {\bfseries Bold Schriftserie} + + \item[rm] {\rmfamily Roman Schriftfamilie} + \item[sf] {\sffamily Sans Serif Schriftfamilie} + \item[tt] {\ttfamily Typewriter Schriftfamilie} + + \item[singlespacing] |\singlespacing| (siehe \package{setspace}-Paket) + \item[onehalfspacing] |\onehalfspacing| + \item[doublespacing] |\doublespacing| + + \item[\UserDefined] + Eigene Zeichensatzoptionen k"onnen mittels |\DeclareCaptionFont| definiert werden. + \SeeUserDefined +\end{Options} + +Wird lediglich eine einzelne Zeichensatzoption ausgew"ahlt, k"onnen die +geschweiften Klammern entfallen, d.h.~die Optionen +%\begin{quote} + |font={small}| +%\end{quote} +und +%\begin{quote} + |font=small| +%\end{quote} +sind in ihrer Wirkung identisch. + +Beispiele: +\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{R"ander und Abs"atze} +\label{margins} + +\DescribeMacro{margin=} +\DescribeMacro{width=} +F"ur die Abbildungs- und Tabellenbeschriftungen kann \emph{entweder} ein extra Rand +\emph{oder} eine feste Breite festgelegt werden. Dies geschieht mit +\begin{quote}\begin{tabular}{@{}r@{}ll} + |margin=| & \meta{Rand} & \emph{oder}\\ + |width=| & \meta{Breite} & \\ +\end{tabular}\end{quote} +In beiden F"allen wird die Beschriftung zentriert, d.h.~der linke und rechte Rand +sind immer gleich gro"s. + +Zwei Beispiele hierzu: +\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=} +Diese Option wirkt auf Abbildungs- oder Tabellenbeschriftungen, die +aus mehr als einem Absatz bestehen; sie legt den Abstand zwischen den +Abs"atzen fest. +\begin{quote} + |parskip=|\meta{Abstand zwischen Abs"atzen} +\end{quote} +Ein Beispiel: +\begin{Example} + \begin{quote} + |margin=10pt,parskip=5pt| + \end{quote} + \captionsetup{aboveskip=0pt} + \example{margin=10pt,parskip=5pt}{% + Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die + Auswirkungen der Optionen deutlich werden.\par + Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, + so da"s die Auswirkungen der Optionen deutlich werden.} +\end{Example} + +\DescribeMacro{hangindent=} +Die Option +\begin{quote} + |hangindent=|\meta{Einzug} +\end{quote} +legt einen Einzug f"ur alle Zeilen au"ser der jeweils ersten des Absatzes fest. +Besteht die Beschriftung lediglich aus einem einzelnen Absatz, so ist die +Wirkung mit der Option |indention=|\meta{Einzug} identisch, bei mehreren +Abs"atzen zeigt sich jedoch der Unterschied: + +\begin{Example} + \begin{quote} + |format=hang,indention=-.5cm| + \end{quote} + \captionsetup{aboveskip=0pt} + \example{format=hang,indention=-.5cm}{% + Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die + Auswirkungen der Optionen deutlich werden.\par + Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, + so da"s die Auswirkungen der Optionen deutlich werden.} +\end{Example} + +\begin{Example} + \begin{quote} + |format=hang,hangindent=-.5cm| + \end{quote} + \captionsetup{aboveskip=0pt} + \example{format=hang,hangindent=-.5cm}{% + Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die + Auswirkungen der Optionen deutlich werden.\par + Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, + so da"s die Auswirkungen der Optionen deutlich werden.} +\end{Example} + +% --------------------------------------------------------------------------- % + +\subsection{Stile} +\label{style} + +\DescribeMacro{style=} +Eine geeignete Kombination aus den bisher vorgestellten Optionen wird \textit{Stil} +genannt; dies ist in etwa mit dem Seitenstil vergleichbar, den man bekannterma"sen +mit |\pagestyle| einstellen kann. + +Einen vordefinierten Abbildungs- und Tabellenbeschriftungsstil kann man mit der +Option +\begin{quote} + |style=|\meta{Stil} +\end{quote} +ausw"ahlen. \Thispackage\ definiert zwei Stile: |base| und |default|. + +\NEWfeature{v3.1} +Der Stil |base| setzt alle bisher vorgestellten Optionen auf die Belegung +zurьck, die das Aussehen der Beschriftungen der Standard"=\LaTeX"=Dokumentenklassen +|article|, |report| und |book| reprдsentiert. D.h.~die Angabe der Option +\begin{quote} + |style=default| +\end{quote} +entspricht den Optionen +\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} +(Aber |justification=centering| wird automatisch gewдhlt werden, + wenn die Beschriftung in eine einzelne Zeile passt.) + +Der Stil |default| hingegen folgt den Standardwerten der verwendeten +Dokumentenklasse. Dieser Stil wird vorausgewдhlt und entspricht den +Optionen +\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|\quad. +\end{quote} +(Aber |justification=centering| und |format=plain| wird automatisch gewдhlt werden, + wenn die Beschriftung in eine einzelne Zeile passt.) + +Wenn also eine der drei Standard"=\LaTeX"=Dokumentenklassen verwendet wird, +zeigen |base| und |default| auf (fast) die gleichen Einstellungen. + +\emph{Hinweis:} Eigene Stile k"onnen mittels |\DeclareCaptionStyle| definiert werden. +\SeeUserDefined + +% --------------------------------------------------------------------------- % + +\subsection{Abst"ande} +\label{skips} + +\DescribeMacro{aboveskip=} +\DescribeMacro{belowskip=} +Die vertikalen Abstдnde vor und nach der Beschriftung werden von +|\abovecaptionskip| und |\belowcaptionskip| kontrolliert. +Die Standard"=\LaTeX"=Klassen |article|, |report| und |book| belegen den +Abstand |\abovecaptionskip| mit |10pt| und |\belowcaptionskip| mit |0pt|, +andere Dokumentenklassen ggf.~ mit anderen Werten. + +\pagebreak[3] +Beide Abst"ande lassen sich gew"ohnlich mit |\setlength| "andern, aber auch mit den +\thispackage-Optionen +\nopagebreak[3] +\begin{quote}\begin{tabular}{@{}r@{}ll} + |aboveskip=| & \meta{Abstand nach oben} & und\\ + |belowskip=| & \meta{Abstand nach unten} & .\\ +\end{tabular}\end{quote} + +\DescribeMacro{position=} +Die sture Anwendung von |\abovecaptionskip| und |\belowcaptionskip| bei +Beschriftungen birgt einen gro"sen Nachteil: Ist die Beschriftung \emph{"uber} +und nicht \emph{unter} der Abbildung oder Tabelle (wie bei Tabellen durchaus +"ublich), so ist die Vorbelegung dieser beiden Abst"ande nicht mehr sinnvoll, +da hier kein Abstand zwischen der Beschriftung und der Tabelle gesetzt wird. +(Wir erinnern uns: |\belowcaptionskip| ist auf |0pt|, also kein Abstand, +vorbelegt.) + +Man vergleiche: +\begin{Example} + \begin{minipage}[c]{.5\linewidth}% +% \captionsetup{aboveskip=0pt}% + \captionof{table}{Eine Tabelle}% + \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}{Eine Tabelle}% + \end{minipage}% +\end{Example} + +Mit Hilfe des Parameters |position| kann man jedoch festlegen, wie +\LaTeX\ die Beschriftung behandeln soll, ob als \mbox{\emph{"Uber}schrift} +oder als \mbox{\emph{Unter}schrift}: +\begin{quote} + |position=top|\quad(oder |position=above|) +\end{quote} +gibt an, da"s die Abst"ande so gew"ahlt werden, da"s sie f"ur \mbox{\emph{"Uber}schriften} +sinnvoll gew"ahlt sind und +\begin{quote} + |position=bottom|\quad(oder |position=below|) +\end{quote} +gibt an, da"s die Abst"ande so gew"ahlt werden, da"s sie f"ur \mbox{\emph{"Uber}schriften} +sinnvoll gew"ahlt sind. (Dies ist die Standardeinstellung, allerdings nicht f"ur |longtable|s.) + +F"ugt man nun ein |\captionsetup{position=top}| in die linke Tabelle vor dem +|\caption| Befehl ein, so ergeben sich im Vergleich zwischen "Uberschrift und +Unterschrift stimmige Abst"ande: +\begin{Example} + \begin{minipage}[c]{.5\linewidth}% + \captionsetup{position=top}% + \captionof{table}{Eine Tabelle}% + \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}{Eine Tabelle}% + \end{minipage}% +\end{Example} + +(Technisch ist dies so realisiert, da"s bei "Uberschriften die Ab\-st"an\-de +|\abovecaptionskip| und |\belowcaptionskip| vertauscht werden, so da"s +|\abovecaptionskip| immer derjenige Abstand ist, der zwischen Tabelle +und Beschriftung zur Anwendung kommt.) + +Sinnvoll l"a"st sich diese Option insbesondere zusammen mit dem optionalen +Parameter bei |\captionsetup| anwenden: \See{auch \Ref{commands}} +\begin{quote} + |\captionsetup[table]{position=top}| +\end{quote} +bewirkt, da"s bei allen Tabellen die Beschriftung bzgl.~der Abst"ande als +"Uberschrift behandelt wird. +\DescribeMacro{tableposition=}%\NEWfeature{v3.0a} +Da dies eine sehr gebr"auchliche Einstellung ist, +stellt das \thispackage"=Paket diesen Befehl auch als abk"urzende Option f"ur +|\usepackage| zur Verf"ugung: +\begin{quote} + |\usepackage[|\ldots|,tableposition=top]{caption}| +\end{quote} +entspricht +\begin{quote} + |\usepackage[|\ldots|]{caption}|\\ + |\captionsetup[table]{position=top}| +\end{quote} + +% --------------------------------------------------------------------------- % + +\pagebreak[3] +\section{Befehle} +\label{commands} + +\DescribeMacro{\caption} +Der Befehl +\nopagebreak[3] +\begin{quote} + |\caption|\oarg{Kurzform f"ur das Verzeichnis}\marg{Beschriftung} +\end{quote} +\nopagebreak[3] +erzeugt eine "Uber- bzw.~Unterschrift innerhalb einer gleitenden Umgebung +wie |figure| oder |table|. Dies ist an sich nichts neues, neu ist allerdings, +da"s kein Eintrag ins Abbildungs- oder Tabellenverzeichnis vorgenommen +wird, wenn eine leere Kurzform angegeben wird, etwa so: +\begin{quote} + |\caption[]{Dies ist eine Abbildung, die nicht ins|\\ + | Abbildungsverzeichnis aufgenommen wird}| +\end{quote} + +\DescribeMacro{\caption*} +Das \package{longtable}-Paket definiert zus"atzlich zum Befehl |\caption| auch +den Befehl |\caption*|, der eine Beschriftung ohne Bezeichner und ohne Eintrag +ins Tabellenverzeichnis erzeugt. So erzeugt z.B. der Code +\begin{quote} + |\begin{longtable}{cc}|\\ + | \caption*{Eine Tabelle}\\|\\ + | A & B \\|\\ + | C & D \\|\\ + |\end{longtable}| +\end{quote} +diese Tabelle: +\begin{longtable}{cc} + \caption*{Eine Tabelle}\\ + A & B \\ + C & D \\ +\end{longtable} + +\Thispackage\ bietet diesen Mechanismus auch f"ur normale Abbildungs- +und Tabellenbeschriftungen an. Ein Beispiel: +\begin{quote} + |\begin{table}|\\ + | \caption*{Eine Tabelle}|\\ + | \begin{tabular}{cc}|\\ + | A & B \\|\\ + | C & D \\|\\ + | \end{tabular}|\\ + |\end{table}| +\end{quote} + +\DescribeMacro{\captionof} +\DescribeMacro{\captionof*} +Der Befehl |\caption| funktioniert in der Regel nur innerhalb von gleitenden +Umgebungen, manchmal m"ochte man ihn jedoch auch anderweitig anwenden, +etwa um eine Abbildung in eine nicht-gleitende Umgebung wie |minipage| zu +setzen. + +\pagebreak[2] +Hierf"ur stellt \thispackage\ den Befehl +\begin{quote} + |\captionof|\marg{Umgebungstyp}\oarg{Kurzform}\marg{Langform} +\end{quote} +zur Verf"ugung. Die Angabe des Umgebungstypen ist hierbei notwendig, damit der +gew"unschte Bezeichner gew"ahlt wird und der Eintrag in das richtige Verzeichnis +vorgenommen wird. Ein Beispiel: +\begin{quote} + |\captionof{figure}{Abbildung}|\\ + |\captionof{table}{Tabelle}| +\end{quote} +f"uhrt zu folgendem Ergebnis: +\begin{Example} + \captionof{figure}{Abbildung} + \captionsetup{belowskip=\abovecaptionskip} + \captionof{table}{Tabelle} +\end{Example} + +Analog zu |\caption*| gibt es auch den Befehl |\captionof*| f"ur Beschriftungen +ohne Bezeichner und ohne Verzeichniseintrag. + +\DANGER % \NEWdescription{v3.1} +Beide Befehle, sowohl |\captionof| als auch |\captionof*|, sollten nur +\emph{innerhalb} von Umgebungen (wie |minipage| oder |\parbox|) angewandt werden; +ansonsten hat dies einen \LaTeX"=Fehler zur Folge.\footnote{% +Nur wenn \eTeX\ zum Einsatz kommt. Ansonsten gibt es zwar keine Fehlermeldung, +aber es kann passieren, da"s \LaTeX\ zwischen dem Inhalt und der +Beschreibung einen Seitenumbruch setzt; zum anderen kann es bei Mi"sachtung gar +zu seltsamen Effekten und unerwьnschten Formatierungen der folgenden +Abbildungs- und Tabellenbeschriftungen kommen!} + +\DescribeMacro{\captionsetup} +Den Befehl |\captionsetup| haben wir ja schon im \Ref{usage} kennengelernt, +uns dort allerdings die Bedeutung des optionalen Parameters +\meta{Typ} aufgespart. %Dies soll nun nachgeholt werden: + +Wir erinnern uns, die Syntax des Befehls lautet +\begin{quote} + |\captionsetup|\oarg{Typ}\marg{Optionen} +\end{quote} + +Wird hierbei ein \meta{Typ} angegeben, so werden die Optionen nicht +unmittelbar umgesetzt, sondern werden lediglich vermerkt und kommen erst dann +zum Einsatz, wenn eine "Uber- bzw.\ Unterschrift innerhalb des passenden +gleitenden Umgebungstyps gesetzt wird. So wirkt sich z.B. die Angabe +\begin{quote} + |\captionsetup[figure]|\marg{Optionen} +\end{quote} +lediglich auf die Unterschriften aus, die innerhalb einer |figure|"=Umgebung +gesetzt werden. + +Ein Beispiel: +\begin{quote} + |\captionsetup{font=small}|\\ + |\captionsetup[figure]{labelfont=bf}| +\end{quote} +f"uhrt zu Abbildungs- und Tabellenunterschriften der Art: +\begin{Example} + \captionsetup{font=small} + \captionsetup[figure]{labelfont=bf} + \begingroup + \captionof{figure}{Eine Abbildung} + \endgroup + \captionsetup{belowskip=\abovecaptionskip} + \begingroup + \captionof{table}{Eine Tabelle} + \endgroup +\end{Example} + +Wie man sieht, f"uhrt das |\captionsetup[figure]{labelfont=bf}| lediglich dazu, +da"s Abbildungsunterschriften mit fettem Bezeichner gesetzt werden, alle anderen +Unter- bzw.\ "Uberschriften werden hiervon nicht beeinflu"st. + +\DescribeMacro{\clearcaptionsetup} +Um diese vermerkten, typbezogenen Parameter aus dem Ged"achnis von \LaTeX\ zu +l"oschen, gibt es den Befehl +\begin{quote} + |\clearcaptionsetup|\marg{Typ}\quad. +\end{quote} + +|\clearcaptionsetup{figure}| w"urde z.B. die obrige Sonderbehandlung der +Abbildungsunterschriften wieder aufheben: +\begin{Example} + \captionsetup{font=small} + \begingroup + \captionof{figure}{Eine Abbildung} + \endgroup + \captionsetup{belowskip=\abovecaptionskip} + \begingroup + \captionof{table}{Eine Tabelle} + \endgroup +\end{Example} + +Als Umgebungstypen mit Unter- bzw.\ "Uberschriften gibt es in der Regel nur +zwei: |figure| und |table|. Wie wir jedoch sp"ater sehen werden, kommen durch die +Verwendung spezieller \LaTeX-Pakete (wie etwa das \package{float}, +\package{longtable} oder \package{sidecap}"=Paket) +ggf.~weitere Typen hinzu, deren Beschriftungen ebenfalls derart individuell +angepasst werden k"onnen. + +\subsection{Fortlaufende gleitende Umgebungen} +\label{ContinuedFloat} + +\DescribeMacro{\ContinuedFloat} +Manchmal m"ochte man Abbildungen oder Tabellen aufteilen, jedoch ohne den einzelnen +Teilen eine eigene Abbildungs- oder Tabellennummer zu geben. Hierf"ur stellt das +\thispackage-Paket den Befehl +\begin{quote} + |\ContinuedFloat| +\end{quote} +zur Verf"ugung, der gleich als erstes innerhalb der folgenden Teile angewandt +werden sollte. Er verhindert, da"s die Z"ahlung fortgef"uhrt wird; eine Abbildung +oder Tabelle, die ein |\ContinuedFloat| enth"alt, erh"alt also die gleiche Nummer +wie die vorherige Abbildung oder Tabelle. + +Ein Beispiel: +\begin{quote} + |\begin{table}|\\ + |\caption{Eine Tabelle.}|\\ + \ldots\\ + |\end{table}|\\ + \ldots\\ + |\begin{table}\ContinuedFloat|\\ + |\caption{Eine Tabelle. (fortgef"uhrt)}|\\ + \ldots\\ + |\end{table}| +\end{quote} +ergibt als Ergebnis: +\begin{Example} + \makeatletter\def\@captype{table}\makeatother + \caption[]{Eine Tabelle.} + \centerline{\ldots} + \ContinuedFloat + \captionsetup{aboveskip=0pt} + \caption[]{Eine Tabelle. (fortgef"uhrt)} +\end{Example} + +% --------------------------------------------------------------------------- % + +\pagebreak[4] +\section{Eigene Erweiterungen} +\label{declare} + +Wem die vorhandenen Formate, Trenner, Textausrichtungen, Zeichens"atze und Stile +nicht ausreichen, der hat die M"oglichkeit, sich eigene zu definieren. Hierzu +gibt es eine Reihe von Befehlen, die in dem Vorspann des Dokumentes (das ist der +Teil vor |\begin{document}|) zum Einsatz kommen. + +\pagebreak[2] +\DescribeMacro{\DeclareCaptionFormat} +Eigene Formate k"onnen mit dem Befehl +\begin{quote} + |\DeclareCaptionFormat|\marg{Name}\marg{Code mit \#1, \#2 und \#3} +\end{quote} +definiert werden. F"ur \#1 wird sp"ater der Bezeichner, f"ur \#2 der Trenner +und f"ur \#3 der Text eingesetzt. So ist z.B. das Standardformat |plain|, +welches die Beschriftung als gew"ohnlichen Absatz formatiert, folgenderma"sen +in |caption.sty| definiert: +\begin{quote} + |\DeclareCaptionFormat{plain}{#1#2#3\par}| +\end{quote} + +\DescribeMacro{\DeclareCaptionLabelFormat} +"Ahnlich k"onnen auch eigene Bezeichnerformate definiert werden: +\begin{quote} + |\DeclareCaptionLabelFormat|\marg{Name}\marg{Code mit \#1 und \#2} +\end{quote} +Bei den Bezeichnerformaten wird hierbei f"ur \#1 der Name (also z.B. +"`Abbildung"'), f"ur \#2 die Nummer (also z.B. "`12"') eingesetzt. + +\DescribeMacro{\bothIfFirst} +\DescribeMacro{\bothIfSecond} +Hierbei gibt es eine Besonderheit zu beachten: Wird das Bezeichnerformat +auch in Verbindung mit dem \package{subfig}"=Paket\cite{subfig} verwendet, +so kann der Bezeichnername (also \#1) auch leer sein. +Um dies flexibel handhaben zu k"onnen, stellt das \thispackage"=Paket die +Befehle +\begin{quote} + |\bothIfFirst|\marg{Erstes Argument}\marg{Zweites Argument}\quad und\\ + |\bothIfSecond|\marg{Erstes Argument}\marg{Zweites Argument} +\end{quote} +zur Verf"ugung. |\bothIfFirst| testet, ob das erste Argument leer ist, +|\bothIfSecond|, ob das zweite Argument leer ist. Nur wenn dies nicht der +Fall ist, werden beide Argumente ausgegeben, ansonsten werden beide +unterdr"uckt. + +So ist z.B. das Standard"=Bezeichnerformat |simple| nicht, wie man +naiverweise annehmen k"onnte, als +\begin{quote} + |\DeclareCaptionLabelFormat{simple}{#1 #2}| +\end{quote} +definiert, weil dies zu einem st"orendem f"uhrenden Leerzeichen f"uhren w"urde, +wenn \#1 leer ist. Stattdessen findet sich in |caption.sty| folgende +Definition, die sowohl mit |\caption| als auch mit |\subfloat| harmoniert: +\begin{quote} + |\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{~}#2}| +\end{quote} +d.h.~das Leerzeichen kommt nur dann zum Einsatz, wenn \#1 nicht leer ist. + +\pagebreak[3] +\DescribeMacro{\DeclareCaptionLabelSeparator} +Eigene Trenner werden mit +\nopagebreak[3] +\begin{quote} + |\DeclareCaptionLabelSeparator|\marg{Name}\marg{Code} +\end{quote} +\nopagebreak[3] +definiert. Auch hier wieder als einfaches Beispiel die Definition des +Standard"=Trenners aus |caption.sty|: +\nopagebreak[3] +\begin{quote} + |\DeclareCaptionLabelSeparator{colon}{: }| +\end{quote} +\pagebreak[3] + +\DescribeMacro{\DeclareCaptionJustification} +Eigene Textausrichtungen k"onnen mit +\begin{quote} + |\DeclareCaptionJustification|\marg{Name}\marg{Code} +\end{quote} +definiert werden. Der \meta{Code} wird dann der Beschriftung vorangestellt, +so f"uhrt z.B. die Verwendung der Ausrichtung +\begin{quote} + |\DeclareCaptionJustification{raggedright}{\raggedright}| +\end{quote} +dazu, da"s alle Zeilen der Beschriftung linksb"undig ausgegeben werden. + +\DescribeMacro{\DeclareCaptionFont} +Eigene Zeichensatzoptionen k"onnen mit +\begin{quote} + |\DeclareCaptionFont|\marg{Name}\marg{Code} +\end{quote} +definiert werden. So definiert z.B. das \thispackage"=Paket die Optionen +|small| und |bf| folgenderma"sen: +\begin{quote} + |\DeclareCaptionFont{small}{\small}|\\ + |\DeclareCaptionFont{bf}{\bfseries}| +\end{quote} +\iffalse +Die Zeilenabst"ande lie"sen sich z.B.~"uber das \package{setspace}"=Paket +regeln:%\NEWdescription{v3.0h} +\begin{quote} + |\usepackage{setspace}|\\ + |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{% + \emph{Hinweis:} \cs{singlespacing} kann hier nicht benutzt werden, + da es ein \cs{vskip} Kommando enth"alt.}\\ + |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\ + |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\ + |\captionsetup{font={onehalfspacing,small},labelfont=bf}| +\end{quote} +\example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}{\exampletext} +\fi +Ein Beispiel, welches etwas Farbe ins Spiel bringt: +\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} +Aber da \thispackage\ schon die pfiffige Definition +\begin{quote} + |\DeclareCaptionFont{color}{\color{#1}}| +\end{quote} +enthдlt, kann man das selbe Resultat auch einfach mit +\begin{quote} + |\usepackage{color}|\\ + |\captionsetup{labelfont={color=blue,bf},|\\ + | textfont={color=green}}|\quad. +\end{quote} +erreichen. + +\DescribeMacro{\DeclareCaptionStyle} +Zu guter letzt noch die Definition eigener Stile. Stile sind einfach eine +Ansammlung von geeigneten Einstellungen, die unter einem eigenen Namen +zusammengefasst werden und mit der Paketoption |style=|\meta{Name} ausgew"ahlt +werden k"onnen. Sie werden wie folgt definiert: +\begin{quote} + |\DeclareCaptionStyle|\marg{Name}\oarg{zus"atzliche Optionen}\marg{Optionen} +\end{quote} +Hierbei ist zu beachten, da"s die \meta{Optionen} immer auf dem Stil |base| +basieren (siehe auch \Ref{style}), es brauchen also nur davon abweichende +Optionen angegeben werden. + +Sind \meta{zus"atzliche Optionen} angegeben, so kommen diese automatisch +zus"atzlich zum Einsatz, sofern die Beschreibung in eine einzelne Zeile passt +und diese Abfrage nicht mit |singlelinecheck=off| ausgeschaltet wurde. + +Als Beispiel mu"s mal wieder eine einfache Definition innerhalb dieses Paketes +herhalten, so ist der Stil |base| definiert als +\begin{quote} + |\DeclareCaptionStyle{base}%|\\ + | [format=plain,justification=centering]{}|\quad. +\end{quote} + +% --------------------------------------------------------------------------- % + +\subsection{Weiterf"uhrende Beispiele} + +%\NEWdescription{v3.1} +Mцchte man die Bezeichnung (inkl. Trenner wie Doppelpunkt) vom Text mit einem +Zeilenumbruch getrennt haben, so kцnnte man dies z.B.~so bewerkstelligen: +\begin{quote} + |\DeclareCaptionFormat{myformat}{#1#2\\#3}| +\end{quote} +Wдhlt man anschlieЯend dieses Format mit |\captionsetup{format=myformat}| aus, +so erhдlt man Beschriftungen der Art: +%\begin{Example} +% \captionsetup{aboveskip=0pt} + \example{format=myformat1,labelfont=bf}{\exampletext} +%\end{Example} +Auch einen Einzug kцnnte man diesem Format mit auf den Weg geben: +\begin{quote} + |\captionsetup{format=myformat,indention=1cm}| +\end{quote} +fьhrt zu Beschriftungen wie: +%\begin{Example} +% \captionsetup{aboveskip=0pt} + \example{format=myformat1,indention=1cm,labelfont=bf}{\exampletext} +%\end{Example} +Aber Sie mцchten den Einzug nur auf die erste Zeile des Texts anwenden? +Kein Problem, so wьrde z.B.~die Definition +\begin{quote} + |\newlength\myindention|\\ + |\DeclareCaptionFormat{myformat}%|\\ + | {#1#2\\\hspace*{\myindention}#3}|\\ + \ldots\\ + |\setlength\myindention{1cm}|\\ + |\captionsetup{format=myformat}| +\end{quote} +zu Beschriftungen dieser Art fьhren: +%\begin{Example} +% \captionsetup{aboveskip=0pt} + \example{format=myformat2,myindention=1cm,labelfont=bf}{\exampletext} +%\end{Example} +Zu der Lдnge |\myindention| hдtten Sie gerne eine Option, so daЯ man diesen +Einzug auch z.B.~mit |\captionsetup|\xx|[figure]|\xx|{myindention=|\ldots|}| setzen kann? +Auch dies lдЯt sich bewerkstelligen, z.B.~folgendermaЯen: +\begin{quote} + |\newlength\myindention|\\ + |\DeclareCaptionOption{myindention}%|\\ + | {\setlength\myindention{#1}}|\\ + |\DeclareCaptionFormat{myformat}%|\\ + | {#1#2\\\hspace\myindention #3}|\\ + \ldots\\ + |\captionsetup{format=myformat,myindention=1cm}| +\end{quote} + +\bigskip\pagebreak[3] +Ein anderes Beispiel: Die Beschriftungen sollen wie folgt aussehen: +%\begin{Example} +% \captionsetup{aboveskip=0pt} + \example{format=reverse,labelformat=fullparens,labelsep=fill,labelfont=it}{\exampletext} +%\end{Example} +\pagebreak[2] +Dies lie"se sich z.B. wie folgt realisieren: +\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}} +Fьr kurze Beschriftungen, die in eine einzige Zeile passen, wird dieses +Format jedoch nicht automatisch angewandt, da die Option |format=plain| Teil +der \meta{zusдtzlichen Optionen} des Beschrifungsstils |default| ist. +Dies lдЯt sich auf verschiedene Arten дndern, so kцnnte man z.B.~den +|singlelinecheck| auf |off| setzen. Wenn man die Zentrierung aber beibehalten +mцchte, bietet sich die Definition eines eigenen Beschriftungstils an, etwa so: +\begin{quote} + |\DeclareCaptionStyle{mystyle}%|\\ + | [justification=centering]{format=myformat}|\\ + |\captionsetup{style=mystyle}| +\end{quote} +oder +\begin{quote} + |\DeclareCaptionFormat{myshortformat}{|\ldots + \textit{was-auch-immer\ldots}|}|\\ + |\DeclareCaptionStyle{mystyle}%|\\ + | [format=myshortformat]{format=myformat}|\\ + |\captionsetup{style=mystyle}| +\end{quote} + +\bigskip\pagebreak[3] +Ein weiteres Beispiel: Der Bezeichner soll in den linken Rand verlagert +werden, so da"s die komplette Absatzbreite der Beschriftung selber zugute kommt: +{\leftmargini=10pt + \begin{quote} + |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\ + |\captionsetup{format=llap,labelsep=quad,singlelinecheck=no}| + \end{quote}} +Das Ergebnis w"aren Beschriftungen wie diese: +%\begin{Example} +% \captionsetup{aboveskip=0pt} + \example{format=llap,labelsep=quad,singlelinecheck=no,margin=0pt}{\exampletext} +%\end{Example} + +% --------------------------------------------------------------------------- % + +\pagebreak[4] +\section{Unterstьtzung der Dokumentenklassen} % \& Babel} +\label{classes} + +%\NEWdescription{v3.1} +{\small\emph{Bitte beachten Sie:} Viele Dokumentenklassen haben bereits +eingebaute Optionen und Befehle, um das Erscheinungsbild der Abbildungs- und +Tabellenbeschriftungen individuell anzupassen. +Wenn diese Mцglichkeiten fьr Sie ausreichend sind, gibt es in der Regel +keinen Grund, \thispackage\ zu benutzen. Und falls Sie lediglich an dem +Befehl |\captionof| interessiert sind, ist in der Regel das Laden des +kleinen aber feinen \package{capt-of}"=Paketes hierzu vцllig ausreichend.} + +Dieser Teil der Dokumentation mцchte Ihnen einen Ьberblick ьber diejenigen +Dokumentenklassen, an welche \thispackage\ angepasst ist, geben: +Welche Mцglichkeiten zur Beschriftungsgestaltung sie bereits verfьgen, +mit welchen Seiteneffekten Sie rechnen mьssen, wenn Sie dieses Paket verwenden, +und zuletzt mit welchen Standardwerten die Optionen belegt werden. + +\NEWfeature{v3.1} +Die Standardwerte "`default"' hдngen von der verwendeten Dokumentenklasse ab; +sie reprдsentieren quasi das Aussehen, wie es vom Autor der Klasse gewьnscht war. +So kann z.B.~die Einstellung |format=default| je nach verwendeter Klasse +unterschiedliche Aussehen der Beschriftungen hervorbringen. + +\DANGER +Sollten Sie Ihre Dokumentenklasse nicht in diesem Abschnitt finden, so haben Sie +trotzdem oftmals keinen Grund zur Sorge: Viele Dokumentenklassen sind von den +Standardklassen |article|, |report| und |book| abgeleitet, und verhalten sich +bezьglich der Abbildungs- und Tabellenbeschriftungen gleich. +\Thispackage ьberprьft automatisch die Kompatibilitдt zur Dokumentenklasse und +gibt eine klare Warnung aus, wenn es eine Unvertrдglichkeit entdeckt. +Wenn Sie keine solche Warnung erhalten, ist alles bestens, wenn doch, wird von +der Verwendung des \package{caption}"=Paketes abgeraten, insbesondere wird eine +solche Verwendung nicht supportet. + +{\small(Sollten Sie trotz der angemahnten Inkompatibilitдt \thispackage{} + nutzen wollen, sollten Sie vorsichtig auf Seiteneffekte achten; gewцhnlich + дndert sich alleine durch das Einbinden des \package{caption}"=Paketes + ohne Optionen bereits das eigentlich von der Dokumentenklasse vorgebene + Aussehen der Beschriftungen. + Wenn dies fьr Sie in Ordnung ist, sollten Sie als erstes die Option + |style=base| mittels |\usepackage|\xx|[style=base]|\xx|{caption}| oder + |\captionsetup|\xx|{style=base}| angeben, um \thispackage\ in einen + dokumentierten Grundstatus zu versetzen. + AnschlieЯend kцnnen Sie anfangen, mittels zusдtzlicher Optionen erste + Anpassungen vorzunehmen und die Daumen gedrьckt zu halten.)} + +\newcommand*\Option{Option} +\newcommand*\defaultvalue{\texttt{default} Belegung} +\newcommand*\use{\textit{verwendet}} +\newcommand*\settings{\textit{Einstellungen}} +\newcommand*\nofont{\textit{keiner}} + +\subsection{Standard \LaTeX: article, report und book} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |plain| \\ +|labelformat=| & |simple| \\ +|labelsep=| & |colon| \\ +|justification=| & |justified| \\ +|font=| & \nofont \\ +|labelfont=| & \nofont \\ +|textfont=| & \nofont \\ +\end{tabular} + +\textbf{Von der Klasse angebotene Befehle:} Keine + +\noindent{\small(\emph{Hinweis:} Dies gilt in der Regel auch fьr abgeleitete +Dokumentenklassen.)} + +\subsection{\AmS: amsart, amsproc und amsbook} +\label{AMS} + +\TODO + +\subsection{beamer} +\label{beamer} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |plain| \\ +|labelformat=| & \textit{nicht nummeriert} \\ +|labelsep=| & |colon| \\ +|justification=| & |raggedright| \\ +|font=| & \use\ \package{beamer} |caption| \settings \\ +|labelfont=| & \use\ \package{beamer} |caption name| \settings \\ +|textfont=| & \nofont \\ +\end{tabular} + +\textbf{Von der Klasse angebotene Befehle und Seiteneffekte:}\\ +Die Zeichensatz- und Farbeinstellungen kцnnen mit +|\setbeamerfont|\xx|{caption}|\xx\marg{options} und +|\setbeamerfont|\xx|{caption name}|\xx\marg{options} vorgenommen werden. +Dies wird auch mit dem \package{caption}"=Paket noch funktionieren, zumindest +solange Sie keinen anderen Zeichensatz mit +|\captionsetup|\xx|{font=|\xx\meta{options}|}| oder +|\captionsetup|\xx|{labelfont=|\xx\meta{options}|}| einstellen.\par +Weiterhin bietet die \package{beamer}"=Klasse verschiedene "`Templates"' fьr +die Beschriftungen an, diese kцnnen mit +|\set|\x|beamter|\x|template|\xx|{caption}|\xx|[|\meta{template}|]| +ausgewдhlt werden. +Da \thispackage\ diesen Mechanismus ersetzt, haben +|\def|\x|beamer|\x|template*|\xx|{caption}|\xx\marg{template code} +und +|\set|\x|beamer|\x|template|\xx|{caption}|\xx|[|\meta{template}|]| +keine Funktion mehr, wenn \thispackage\ verwendet wird. + +\subsection{\KOMAScript: scrartcl, scrreprt, and scrbook} +\label{KOMA} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & \use\ |\setcapindent| \textit{\&} |\setcaphanging| \\ +|labelformat=| & |simple| \\ +|labelsep=| & \use\ |\captionformat| \\ +|justification=| & |justified| \\ +|font=| & \use\ |\setkomafont{caption}| \settings \\ +|labelfont=| & \use\ |\setkomafont{captionlabel}| \settings \\ +|textfont=| & \nofont \\ +\end{tabular} + +\textbf{Von der Klasse angebotene Befehle:}\\ +Die \KOMAScript"=Dokumentenklassen bietet sehr viele Mцglichkeiten, das Design +der Abbildungs- und Tabellenbeschriftungen anzupassen. Fьr eine Ьbersicht schauen +Sie bitte in die sehr gute \KOMAScript"=Dokumentation, Abschnitt "`Tabellen +und Abbildungen"'. + +\textbf{Seiteneffekte:}\\ +Das optionale Argument von |\setcapwidth| wird (noch) nicht vom +\package{caption}"=Paket unterstьtzt und daher ignoriert. +Weiterhin ьberschreiben die \KOMAScript"=Optionen |tablecaptionabove| \& +|tablecaptionbelow| sowie die dazugehцrigen Befehle |\captionabove| \& +|\captionbelow| die Einstellungsmцglichkeit |position=|, die \thispackage{} +anbietet. + +\subsection{\NTG: artikel, rapport und 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{Von der Klasse angebotene Befehle und Seiteneffekte:}\\ +|\CaptionLabelFont| und |\CaptionTextFont| kцnnen entweder direkt oder +indirekt ьber |\CaptionFonts| definiert werden. +Beides funktioniert auch weiterhin, zumindest solange kein anderer +Zeichensatz mittels der \package{caption}"=Paket"=Optionen +|labelfont=| oder |textfont=| festgelegt wird. + +\subsection{\SmF: smfart und smfbook} +\label{SMF} + +\TODO + +\subsection{Die franzцsische Babel Option} +\label{frenchb} + +\TODO\iffalse +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. +\fi + +\INFO* +Bitte laden Sie \thispackage\ \emph{nach} dem \package{babel}"=Paket. + +\subsection{Das frenchle- und frenchpro-Paket} +\label{frenchpro} + +\TODO\iffalse +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. +\fi + +\INFO* +Bitte laden Sie \thispackage\ \emph{nach} dem \package{frenchle} +oder \package{frenchpro}"=Paket. + +% --------------------------------------------------------------------------- % + +\pagebreak[3] +\section{Interaktion mit anderen Paketen} +\label{packages} + +%\NEWdescription{v3.1} +\Thispackage\ ist an folgende Pakete, die ebenfalls Abbildungs- oder +Tabellenbeschriftungen anbieten, angepasst: +\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} und \package{wrapfig} +\end{quote} + +Weiterhin arbeiten das \package{floatrow}- und das \package{subfig}"=Paket +aktiv mit diesem Paket zusammen und verwenden die |\captionsetup|"=Schnittstelle. + +\subsection{float} +\label{float} + +\TODO + +\subsection{floatflt} +\label{floatflt} + +\TODO + +\subsection{fltpage} +\label{fltpage} + +\TODO + +\subsection{hyperref} +\label{hyperref} + +\NEWfeature{v3.1} +Zwei Optionen regeln das Setzen von Hyperlinks: +\begin{description} +\item{\texttt{hypcap=}}\\[\smallskipamount] +Auf |true| gesetzt, werden alle Hyperlink"=Anker -- wohin Eintrдge im +Abbildungs- und Tabellenverzeichnis, sowie |\ref| und |\autoref| +verweisen -- an den Anfang der (gleitenden) Umgebungen wie Abbildung +oder Tabelle plaziert.\par +Auf |false| gesetzt zeigen hingegen alle Hyperlink"=Anker auf die +Beschriftung.\par +(Die Voreinstellung ist |hypcap=true|.) +\item{\texttt{hypcapspace=}}\\[\smallskipamount] +Dies regelt den vertikalen Abstand zwischen dem Hyperlink"=Anker und der +(gleitenden) Umgebung, so entfernt z.B.~|hypcapspace=0pt| diesen Abstand.\par +(Die Voreinstellung ist|hypcapspace=0.5\baselineskip|.) +\end{description} + +Bitte beachten Sie: + +\begin{description} +\item{\cs{captionof}\marg{type}\csmarg\ldots\ vs. + \cs{captionsetup}\csmarg{type=\meta{Typ}}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount] +Ohne geladenes \package{hyperref}"=Paket bekommen Sie identische Resultate. +Aber mit \package{hyperref} geladen und mit |hypcap=true| versehen wird der +Hyperlink"=Anker unterschiedlich gesetzt. So plaziert z.B. +\begin{quote} +|\begin{minipage}{\linewidth}|\\ +| |\ldots\\ +| \captionof{figure}{A figure}|\\ +|\end{minipage}| +\end{quote} +den Anker bei der Beschriftung. +(Und wenn |hypcap=true| gesetzt ist, wird eine Warnung deswegen ausgegeben.) +\begin{quote} +|\begin{minipage}{\linewidth}|\\ +| \captionsetup{type=figure}|\\ +| |\ldots\\ +| \caption{A figure}|\\ +|\end{minipage}| +\end{quote} +hingegen plaziert den Anker an den Anfang der |minipage|. + +\item{\cs{caption}\csoarg{}\csmarg\ldots\ vs. + \cs{captionsetup}\csmarg{listof=false}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount] +Wiederum bekommen Sie ohne geladenes \package{hyperref}"=Paket identische Resultate. +Aber mit \package{hyperref} geladen liegen die Unterschiede in den Feinheiten. +So wird z.B.~das optionale Argument von \cs{caption} auch in die |aux|-Datei +geschrieben und vom \cs{nameref} Befehl verwendet. +Wenn Sie also \cs{caption} mit leerem Argument angeben, wird ein auf diese +Abbildung oder Tabelle angewandtes \cs{nameref} nicht das erwьnschte, +nдmlich ein leeres Resultat zur Folge haben. +Daher ist es besser \cs{captionsetup}\csmarg{listof=false} zu verwenden, +wenn Sie keinen Eintrag in dem Abbildungs- oder Tabellenverzeichnis wьnschen. +\end{description} + +\subsection{hypcap} +\label{hypcap} + +Wird das \package{hypcap}"=Paket zusдtzlich zum \package{hyperref}"=Paket +geladen, so ьbernimmt es die Kontrolle ьber die Platzierung der Hyperlink"=Anker. + +Dies hat den Nebeneffekt, daЯ die Hyperlink"=Anker innerhalb der Umgebungen +|floatingfigure| (vom \package{floatflt}"=Paket bereitgestellt), +|figwindow| (vom \package{picinpar}"=Paket bereitgestellt), +|parpic| (vom \package{picins}"=Paket bereitgestellt) und +|wrapfigure| (vom \package{wrapfig}"=Paket bereitgestellt) +nicht mehr optimal platziert werden. + +AuЯerdem ist zu beachten, daЯ dann |\captionsetup{type=|\meta{Type}|}| +keinen Hyperlink"=Anker mehr setzt, dies muЯ dann stattdessen mit +|\capstart|(welches vom \package{hypcap}"=Paket angeboten wird) geschehen. + +\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{Kompatibilit"at zu "alteren Versionen} +\label{compatibility} + +\subsection{caption v\texorpdfstring{$1.x$}{1.x}} +\label{caption1} + +Diese Version des \thispackage"=Paketes ist weitgehend kompatibel zu "alteren +Versionen des Paketes; alte, vorhandene Dokumente sollten sich also in der +Regel ohne Probleme weiterhin "ubersetzen lassen. +Jedoch ist zu beachten, da"s eine Mischung aus alten Befehlen und neueren +Optionen bzw.~Befehlen zu unerw"unschten Nebeneffekten f"uhren kann. + +Hier eine kurze "Ubersicht "uber die alten, "uberholten Optionen und ihre +aktuellen Entsprechungen: + +{\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}} + +Neben den Optionen zum Einstellen des Zeichensatzes gab es auch die Befehle +|\captionsize| bzw. |\captionfont| und |\captionlabelfont|, die direkt +mittels |\renewcommand| ver"andert werden konnten. Dieser Mechanismus +wurde durch die Anweisungen +\begin{quote} + |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad und\\ + |\captionsetup{font=|\ldots|,labelfont=|\ldots|}| +\end{quote} +ersetzt. \SeeUserDefined + +Das Setzen eines Randes geschah in \version{1.x} mittels +\begin{quote} + |\setlength{\captionmargin}{|\ldots|}|\quad. +\end{quote} +Dies wurde durch +\begin{quote} + |\captionsetup{margin=|\ldots|}| +\end{quote} +ersetzt. \See{\Ref{margins}} + +Zum Beispiel w"urde +\begin{quote} +|\usepackage[hang,bf]{caption}|\\ +|\renewcommand\captionfont{\small\sffamily}|\\ +|\setlength\captionmargin{10pt}| +\end{quote} +in aktueller Notation +\begin{quote} +|\usepackage[format=hang,labelfont=bf,font={small,sf},|\\ +| margin=10pt]{caption}| +\end{quote} +bzw. +\begin{quote} +|\usepackage{caption}|\\ +|\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\ +| margin=10pt}| +\end{quote} +hei"sen. + +Die etwas exotische Option |ruled|, die eine partielle Anwendung der +eingestellten Parameter bei gleitenden Umgebungen des Typs |ruled| +aktivierte, wird ebenfalls emuliert, hat aber keine direkte +Entsprechung in dieser Version des \package{caption}"=Paketes. +M"ochte man gezielt das Aussehen der Abbildungen des Stils |ruled|, +der durch das \package{float}"=Paket zur Verf"ugung gestellt wird, +ver"andern, so ist dies nun durch +\begin{quote} + |\DeclareCaptionStyle{ruled}{|\ldots|}| +\end{quote} +bzw. +\begin{quote} + |\captionsetup[ruled]{|\ldots|}| +\end{quote} +m"oglich. +\SeeUserDefined[, \Ref{commands} und \Ref{float}] + +\subsection{caption2 v\texorpdfstring{$2.x$}{2.x}} +\label{caption2} + +Die Pakete \package{caption} und seine experimentelle, nun veraltete +Variante \package{caption2} sind vom internen Konzept +her zu unterschiedlich, um hier eine vollst"andige Kompatibilit"at +gew"ahrleisten zu k"onnen. +Daher liegt diesem Paket weiterhin die Datei |caption2.sty| bei, so da"s +"altere Dokumente, die das \package{caption2}"=Paket verwenden, weiterhin +"ubersetzt werden k"onnen. + +Neue Dokumente sollten jedoch auf dem aktuellen \package{caption}"=Paket +aufgesetzt werden. In den meisten F"allen ist es ausreichend, einfach +ggf.~die Anweisung +\begin{quote} + |\usepackage[...]{caption2}| +\end{quote} +durch +\begin{quote} + |\usepackage[...]{caption}| +\end{quote} +zu ersetzen. Einige Optionen und Befehle werden jedoch nicht emuliert, +so da"s sie anschlie"send Fehlermeldungen erhalten k"onnen. +Die folgenden Abs"atze werden Ihnen jedoch bei der Umsetzung dieser +Optionen und Befehle helfen. Sollten dar"uberhinaus noch Fragen oder +Probleme auftreten, so z"ogern Sie bitte nicht, mich diesbez"uglich +per E-Mail zu kontaktieren. + +Zus"atzlich zu den bereits im vorherigen Abschnitt vorgestellten Optionen +werden auch folgende emuliert: + +{\small\begin{longtable}{ll} +\package{caption2} \version{2.x} & \thispackage\ \version{3.x}\\ +\hline +\endhead +|flushleft| & |justification=raggedright|\\ +|flushright| & |justification=raggedleft|\\ +|oneline| & |singlelinecheck=on|\\ +\end{longtable}} + +Das Setzen eines Randes geschah in \version{2.x} mittels +\begin{quote}\leavevmode\hbox{% + |\setcaptionmargin{|\ldots|}| bzw. + |\setcaptionwidth{|\ldots|}|\quad. +}\end{quote} +Dies wurde durch +\begin{quote}\leavevmode\hbox{% + |\captionsetup{margin=|\ldots|}| bzw. + |\captionsetup{width=|\ldots|}| +}\end{quote} +ersetzt. \See{\Ref{margins}} + +Das Setzen des Einzuges wurde in \version{2.x} mit +\begin{quote} + |\captionstyle{indent}|\\ + |\setlength\captionindent{|\ldots|}| +\end{quote} +erledigt, dies geschieht nun mit +\begin{quote} + |\captionsetup{format=plain,indention=|\ldots|}|\quad. +\end{quote} + +Die Sonderbehandlung von einzeiligen Beschriftungen lie"s sich in +\version{2.x} mit |\oneline|\-|captions|\-|false| aus- +bzw. |\oneline|\-|captions|\-|true| wieder einschalten. Dies wurde durch +|\captionsetup{|\xx|singlelinecheck=|\xx|off}| +bzw. +|\captionsetup{|\xx|singlelinecheck=|\xx|on}| +ersetzt. \See{\Ref{justification}} + +Die Befehle +\begin{quote} + |\captionlabeldelim|, |\captionlabelsep|, |\captionstyle|,\\ + |\defcaptionstyle|, |\newcaptionstyle| und |\renewcaptionstyle| +\end{quote} +haben keine direkte Entsprechnung und werden daher durch diese +Version des \package{caption}"=Paketes auch nicht emuliert. +Sie f"uhren also bei der Verwendung %mit diesem \thispackage"=Paket +zu Fehlermeldungen und m"ussen daher zwingend umgesetzt werden. +Die Umsetzung ist von Fall zu Fall verschieden, lesen Sie sich daher bitte +diese Anleitung gr"undlich durch und suchen Sie sich die Optionen bzw.~Befehle +als Ersatz heraus, die Ihren W"unschen entsprechen. + +\iffalse +Als kleine Hilfestellung hier die Beispiele aus der alten Anleitung zum +\package{caption2}"=Paket und deren Umsetzung: + +\newenvironment{OldNew}% + {\begin{minipage}\linewidth + \def\Old{Alt:\begin{quote}}% + \def\New{\end{quote}Neu:\begin{quote}}% + \def\Or{\end{quote}\centerline{-- oder --}\begin{quote}}% + }% + {\end{quote}\end{minipage}} + +\begin{OldNew} +\Old + |\captionstyle{center}| +\New + |\captionsetup{justification=centering}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\captionstyle{indent}|\\ + |\setlength{\captionindent}{1cm}| +\New + |\captionsetup{format=plain,indention=1cm}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcommand\captionfont{\small}|\\ + |\renewcommand\captionlabelfont{\itshape}| +\New + |\captionsetup{font=small,labelfont=it}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcommand\captionfont{\small\itshape}|\\ + |\renewcommand\captionlabelfont{\upshape}| +\New + |\captionsetup{font=small,textfont=it}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\setcaptionwidth{.5\textwidth}| +\New + |\captionsetup{width=.5\textwidth}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\setcaptionmargin{.25\textwidth}| +\New + |\captionsetup{margin=.25\textwidth}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{absatz}{\captionlabel: \exampletext\par}|\\ + |\captionstyle{absatz}| +\New + |\DeclareCaptionFormat{absatz}{#1: #3\par}|\\ + |\captionsetup{format=absatz,singlelinecheck=off}| +\Or + |\captionsetup{format=plain,singlelinecheck=off}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy}{\textsf{\captionlabel}\\\exampletext\par}|\\ + |\captionstyle{fancy}| +\New + |\DeclareCaptionFormat{fancy}{\textsf{#1}\\#3\par}|\\ + |\captionsetup{format=fancy,singlelinecheck=off}| +\Or + |\captionsetup{format=plain,labelfont=sf,labelsep=newline}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy2}{\exampletext\hfill\textit{(\captionlabel)}}|\\ + |\captionstyle{fancy2}| +\New + |\DeclareCaptionFormat{fancy2}{#3\hfill\textit{(#1)}}|\\ + |\captionsetup{format=fancy2,singlelinecheck=off}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{mystyle}{%|\\ + | \normalcaptionparams|\\ + | \renewcommand\captionlabelfont{\bfseries}%|\\ + | \renewcommand\captionlabeldelim{.}%|\\ + | \onelinecaptionsfalse|\\ + | \usecaptionstyle{centerlast}}|\\ + |\captionstyle{mystyle}| +\New + |\DeclareCaptionStyle{mystyle}{labelfont=bf,labelsep=period,justification=centerlast}|\\ + |\captionsetup{style=mystyle}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{hangandleft}{%|\\ + | \let\oldcaptiontext\exampletext|\\ + | \def\exampletext{\raggedright\oldcaptiontext}%|\\ + | \usecaptionstyle{hang}}|\\ + |\captionstyle{hangandleft}| +\New + |\captionsetup{format=hang,justification=raggedright}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy}{%|\\ + | \usecaptionmargin\captionfont|\\ + | \onelinecaption|\\ + | {{\captionlabelfont\captionlabel\captionlabeldelim}%|\\ + | \captionlabelsep\exampletext}%|\\ + | {{\centering\captionlabelfont\captionlabel\par}%|\\ + | \centerlast\exampletext\par}}|\\ + |\captionstyle{fancy}| +\New + |\DeclareCaptionFormat{fancy}{\centering#1\par\centerlast#3\par}|\\ + |\DeclareCaptionStyle{fancy}|\\ + | [format=plain,justification=centering]|\\ + | {format=fancy}|\\ + |\captionsetup{style=fancy}| +\Or + |\DeclareCaptionFormat{fancy}{#1\par#3\par}|\\ + |\DeclareCaptionStyle{fancy}|\\ + | [format=plain,justification=centering]|\\ + | {format=fancy,justification=centerlast}|\\ + |\captionsetup{style=fancy}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcaptionstyle{longtable}{\usecaptionstyle{normal}}| +\New + |\captionsetup[longtable]{format=plain}| +\end{OldNew} +\fi + +Ebenfalls keine Entsprechung hat die \version{2.x}"=Option |ignoreLTcapwidth|. +Deren Verwendung kann in der Regel einfach entfallen, da \thispackage\ den +Wert von |\LTcapwidth| sowieso nicht beachtet, solange er nicht explizit auf +einen anderen Wert als den Standardwert ($=$|4in|) gesetzt wird. +\See{\Ref{longtable}} + +\subsection{caption v\texorpdfstring{$3.0$}{3.0}} +\label{caption3} + +%\NEWdescription{v3.1} +\Thispackage\ \version{3.0} hatte keine weiteren Dokumentenklassen +aktiv unterstьtzt als die drei Standard"=Klassen, die \LaTeX\ selber +mitbringt: |article|, |report| und |book|. +Daher waren die Vorbelegungen der Einstellungsmцglichkeiten fest durch +dieses Paket vorgegeben, sie reprдsentierten das Aussehen bei Verwendung +einer dieser Klassen. +Nun aber unterstьtzt \thispackage\ mehr Dokumentenklasse aktiv, folglich +kann die Vorbelegung nun von der verwendeten Dokumentenklasse abhдngen. + +Ein Beispiel: Wдhrend in \version{3.0} die Vorbelegung der Ausrichtung +immer |justification=|\xx|justified| was, ist sie nun immer noch |justified| +wenn eine der drei Standardklassen verwendet wird, aber +|justification=|\xx|raggedright|, wenn die \package{beamer}"=Klasse verwendet +wird. + +Mцchten sie weiterhin die "`alten"' Vorbelegungen, so kцnnen Sie die Option +|style=base| beim Laden des \package{caption}"=Paketes angeben oder spдter +mittels |\captionsetup|\xx|{style=base}| den alten Grundzustand wieder herstellen. + +% --------------------------------------------------------------------------- % + +\pagebreak[4] +\section{Alphabetische Referenz} + +%\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{Befehle} + +\begin{longtable}{lll} +Befehl & & Abschnitt \\ +\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{Optionen} +\newcommand\preambleoption{ \footnotemark[1]} + +\begin{longtable}{lll} +Option & Kurzbeschreibung & Abschnitt \\ +\hline +\endhead +|aboveskip| & setzt den Abstand ьber der Beschriftung & \ref{skips} \\ +|belowskip| & setzt den Abstand unter der Beschriftung & \ref{skips} \\ +|compatibility|\preambleoption & erzwingt (Nicht-)Kompatibilitдt & \ref{classes} \\ +%|config| & & \ref{x} \\ +|figurename|\preambleoption & setzt den Abbildungsnamen & \ref{x} \\ +|figureposition|\preambleoption & gibt einen Hinweis auf die Position & \ref{skips} \\ +|font| & wдhlt den Zeichensatz & \ref{fonts} \\ +|format| & wдhlt das Format & \ref{formats} \\ +|hangindent| & setzt den "`hдngenden"' Einzug & \ref{margins} \\ +|hypcap| & wдhlt das "`hypcap"' Feature aus & \ref{hyperref} \\ +|hypcapspace| & setzt den Abstand ьber einem Hyperlink & \ref{hyperref} \\ +|indention| & setzt den Einzug & \ref{margins} \\ +|justification| & wдhlt die Ausrichtung & \ref{justification} \\ +|labelfont| & wдhlt den Zeichensatz des Bezeichners & \ref{fonts} \\ +|labelformat| & wдhlt das Format des Bezeichners & \ref{formats} \\ +|labelsep| & wдhlt den Trenner zw. Bezeichner$+$Text & \ref{formats} \\ +|labelseparator| & wдhlt den Trenner zw. Bezeichner$+$Text & \ref{formats} \\ +|listof| & schaltet die Listeneintrдge an bzw. aus & \ref{listof} \\ +|listofformat| & wдhlt das Listenformat & \ref{listof} \\ +|margin| & setzt den Rand bzw. die Rдnder & \ref{margins} \\ +|margin*| & setzt den Rand, sofern keine Breite gesetzt ist & \ref{margins} \\ +|maxmargin| & setzt den max. zu verwendenen Rand & \ref{margins} \\ +|minmargin| & setzt den min. zu verwendenen Rand & \ref{margins} \\ +|options| & fьhrt die angegebene Optionsliste aus & \ref{x} \\ +|parindent| & setzt den Absatzeinzug & \ref{margins} \\ +|parskip| & setzt den Absatzabstand & \ref{margins} \\ +|position| & gibt einen Hinweis auf die Position & \ref{skips} \\ +|singlelinecheck| & schaltet die "`Ein-Zeilen-Prьfung"' ein bzw. aus & \ref{justification} \\ +%|size| & wдhlt die GrцЯe des Zeichensatzes & \ref{x} \\ +|skip| & setzt den Abstand zwischen Inhalt \& Beschriftung & \ref{skips} \\ +|strut| & schaltet die Verwendung von |\strut| ein bzw. aus & \ref{formats} \\ +|style| & wдhlt einen kompletten Stil aus & \ref{style} \\ +|tablename|\preambleoption & setzt den Tabellennamen & \ref{x} \\ +|tableposition|\preambleoption & gibt einen Hinweis auf die Position & \ref{skips} \\ +|textfont| & wдhlt den Zeichensatz des Textes & \ref{fonts} \\ +|textformat| & wдhlt das Format des Textes & \ref{formats} \\ +|twoside| & wдhlt den zweiseitigen Modus & \ref{x} \\ +|type| & setzt den Typ \& setzt einen Hyperlink-Anker & \ref{x} \\ +|type*| & setzt (nur) den Typ & \ref{x} \\ +|width| & setzt eine feste Breite & \ref{margins} \\ +\end{longtable} +\footnotetext[1]{Diese Optionen stehen nur in dem Dokumentenvorspann (Preamble) + zur Verfьgung.} +\nopagebreak +{\small\emph{Hinweis:} Veraltete, aber emulierte Optionen sind hier nicht gelistet. + Eine Auflistung dieser Optionen ist in\\ + \hspace*{1em}\Ref{caption1} und\\ + \hspace*{1em}\Ref{caption2} zu finden.} + +\pagebreak[4] +\subsection{Warnungen} + +\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 + Wenn \thispackage\ eine vorhandene (und unbekannte) Erweiterung des Befehls + |\caption| erkannt hat, definiert es |\caption| nicht erneut um, da dies + unweigerlich den Verlust der ursprьnglichen Erweiterung zur Folge hдtte. + Daher funktionieren manche Features, wie |\caption*|, + |\ContinuedFloat|, das optionale Argument von |\captionsetup|, + sowie die Optionen |listof=| und |hypcap=| nicht mehr; sie werden + entweder ignoriert oder arbeiten nicht erwartungsgemдЯ.\par + Wenn Sie an der ursprьnglichen Erweiterung nicht interessiert sind + und stattdessen den vollen Umfang des \package{caption}"=Paketes + verwenden wollen, kцnnen Sie es mit der nicht supporteten(!) + Option |compatibility=false| probieren und die Daumen drьcken. + (Aber Sie werden die nдchste Warnung stattdessen bekommen.) + \par\See{\Ref{classes}} + +\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 + Da Sie so mutig waren, die Option |compatibility=false| zu probieren, + wird \thispackage\ sein bestes geben, um diesen Wunsch zu erfьllen. + Aber je nach verwendeter Dokumentenklasse bzw.~Pakete sollten Sie sich + auf nicht"=funktionierende Features oder gar Fehlermeldungen einstellen. + Also bitte die Daumen gedrьckt halten! + \par\See{\Ref{classes}} + +\Message + |Caption type was already set to `|\meta{type}|'.| +\Description + Diese Warnung informiert Sie ьber vermische \package{caption}"=Optionen. + Wenn Sie z.B.~ein |\captionof|\xx|{table}|\xx|{|\ldots|}| in einer |figure| + Umgebung verwenden, werden beide Optionensдtze, sowohl derjenige fьr |figure| + (mittels |\captionsetup|\xx|[figure]|\xx|{|\ldots|}| angegeben) als auch + derjenige fьr |table| (mittels |\captionsetup|\xx|[table]|\xx|{|\ldots|}| + angegeben), angewandt. + \par\See{\Ref{commands}} + +\Message + |Hyperref support is turned off because hyperref has|\\ + |stopped early.| +\Description + Wenn das \package{hyperref}"=Paket seinen Dienst einstellt (den Grund hierfьr + teilt es Ihnen mit), ist auch die \package{hyperref}"=Unterstьtzung des + \package{caption}"=Paketes nicht verfьgbar. Als Folge werden Sie einige + Warnungen des \package{hyperref}"=Paketes bekommen, ferner werden Hyperlinks + auf Abbildungen und Tabellen nicht funktionsfдhig sein. + \par\See{\Ref{hyperref}} + +\Message + |Ignoring optional argument [|\meta{pos}|] of \setcapwidth.| +\Description + \Thispackage\ bemьht sich, so gut es kann, die \KOMAScript"=Befehle + bzgl.~Tabellen und Abbildungen zu emulieren. Aber das optionale Argument + von |\setcapwidth| funktioniert (noch) nicht; wenn Sie es angeben, + wird diese Warnung ausgegeben. + \par\See{\Ref{KOMA}} + +\Message + |Option `|\meta{option}|' was not in list `|\meta{option list}|'.| +\Description + Wenn Sie versuchen, eine bestimmte Option aus einer Optionsliste zu + entfernen, zum Beispiel mit |\clearcaptionsetup[position]{table}|, + und die angegebene Option kann nicht in der Liste gefunden werden, so + erhalten Sie die obenstehende Warnung. + Liegt dies nicht an einem Schreibfehler Ihrerseits und mцchten Sie ferner + diese Warnung unterdrьcken, so verwenden kцnnen Sie hierzu |\clearcaptionsetup*| + anstelle von |\clearcaptionsetup| verwenden. + \par\See{\Ref{commands}} + +\Message + |Option list `|\meta{option list}|' undefined.| +\Description + Wenn Sie versuchen, eine bestimmte Option aus einer Optionsliste zu + entfernen, zum Beispiel mit |\clearcaptionsetup[format]{figure}|, + und die angegebene Optionsliste ist (noch) nicht definiert, so + erhalten Sie die obenstehende Warnung. + Liegt dies nicht an einem Schreibfehler Ihrerseits und mцchten Sie ferner + diese Warnung unterdrьcken, so verwenden kцnnen Sie hierzu |\clearcaptionsetup*| + anstelle von |\clearcaptionsetup| verwenden. + \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 + Die Option |justification=|\xx|RaggedRight| ist nur dann voll funktionsfдhig, + wenn Sie das \package{ragged2e}"=Paket auf Ihrem \TeX"=System installiert haben. + Ist dies nicht der Fall, erhalten Sie diese Warnung und |justification=|\xx|RaggedRight| + wird im spдteren Verlauf des Dokumentes wie |justification=|\xx|raggedright| + behandelt werden. + \par\See{\Ref{justification}} + +\Message + |Obsolete option `ignoreLTcapwidth' ignored.| +\Description + Die Option |ignoreLTcapwidth| des \package{caption2}"=Paketes wird nicht von + diesem Paket emuliert. In der Regel kцnnen Sie aber diese Option ohne Nebeneffekte + einfach entfernen. + \par\See{\Ref{caption2} und \Ref{longtable}} + +\Message + |`ragged2e' support has been changed. Rerun to get|\\ + |captions right.| +\Description + Das \package{ragged2e} wird nur dann vom \package{caption}"=Paket geladen, + wenn es tatsдchlich benцtigt wird. + Um dies zu gewдhrleisten, sind zwei \LaTeX"=Lдufe notwendig, daher kцnnen Sie + beim ersten Durchlauf diese Warnung bekommen. + Im nдchsten \LaTeX"=Lauf sollte also diese Warnung verschwunden sein. + \par\See{\Ref{justification}} + +\Message + |Reference on page |\meta{page no.}| undefined.| +\Description + Ist ein zweiseitiges Dokumentenlayout gewдhlt, benцtigt \thispackage\ zwei + \LaTeX"=Lдufe, um die Rдnder richtig zuordnen zu kцnnen; + daher kцnnen Sie beim ersten Durchlauf diese Warnung bekommen. + Im nдchsten \LaTeX"=Lauf sollte also diese Warnung verschwunden sein. + \par\See{\Ref{margins}} + +\Message + |The option `hypcap=true' will be ignored for this|\\ + |particular \caption.| +\Description + \Thispackage\ hat keinen geeigneten Hyperlink"=Anker fьr diese Beschriftung + gefunden, daher hat es entschlossen, die Einstellung |hypcap=true| (die per + Standard gesetzt ist) zu ignorieren. + Als Folge werden Hyperlinks zu dieser Abbildung oder Tabelle (etwa ьber das + Abbildungsverzeichnis, oder selber mit |\ref| oder |\autoref| angelegt) + nicht auf den Beginn der Abbildung oder Tabelle verweisen, sondern stattdessen + auf deren Beschriftung.\par + Dies kann z.B.~passieren, wenn eine Beschriftung mittels |\captionof| innerhalb + einer nicht-gleitenden Umgebung gesetzt wird, aber auch, wenn ein Sie ein Paket + in Ihrem Dokument verwenden, welches die Umgebungen |figure| oder |table| + umdefiniert hat, dieses Paket aber dem \package{caption}"=Paket unbekannt + ist.\par + Ist dies fьr Sie ok, aber die Warnung stцrt Sie, kцnnen Sie sie + |\captionsetup{|\xx|hypcap=|\xx|false}| direkt vor dem betroffenen |\caption| + oder |\captionof| Befehl platzieren. + Ist dies hingegen nicht fьr Sie ok, kцnnen Sie versuchen, selber an geeigneter + Stelle einen Hyperlink"=Anker mit |\captionsetup{|\xx|type=|\xx\meta{Typ}|}| + zu setzen. + \par\See{\Ref{hyperref}} + +\Message + |Unsupported document class (or package) detected,|\\ + |usage of the caption package is *not* recommended.| +\Description + Entweder ist die verwendete Dokumentenklasse dem \package{caption}"=Paket + unbekannt, oder aber Sie haben ein Paket in Ihrem Dokument eingebunden, + welches ebenfalls das interne Makro |\@makecaption| (was fьr das Setzen + der Abbildungs- und Tabellenbeschriftungen zustдndig ist) umdefiniert. + Wie-auch-immer, \thispackage\ wird entweder das Design der Beschriftungen + in einer ungewollten Art \& Weise verдndern, oder aber es wird zu keinem + geordneten Verhalten und/oder Fehlermeldungen kommen. Deswegen wird in + diesem Falle die Verwendung des \package{caption}"=Paketes nicht empfohlen. + \par\See{\Ref{classes}} + +\Message + |Unused \captionsetup[|\meta{type}|].| +\Description + Es wurden Optionen mit |\captionsetup[|\meta{Typ}|]| definiert, die im Laufe + des Dokumentes aber nicht zur Anwendung gekommen sind. + Dies kann zum einen an einem Schreibfehler im Argument \meta{Typ} liegen, + aber auch daran, daЯ ein dem \package{caption}"=Paket unbekanntes Paket + die Umgebungen |figure| und/oder |table| umdefiniert hat, oder auch einfach, + weil Sie die angegebene Umgebung gar nicht im spдteren Verlauf Ihres Dokumentes + verwenden.\par + Mцchten Sie diese Warnung unterdrьcken, so verwenden Sie hierzu + |\caption|\x|setup*| anstelle von |\caption|\x|setup|. + \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 + Das angegebene Paket mischt sich ebenfalls in die Verwendung der Abstдnde + ьber- und unterhalb der Beschriftungen ein. Viele Kцche verderben den Brei, + also ist es ratsam, sich fьr eines der Pakete -- das angegebene oder + \thispackage\ -- zu entscheiden, um falsche Abstдnde zu vermeiden. + \par\See{\Ref{skips}} + +\Message + |Wrong TeX mode, no hyper anchor was set.| +\Description +% \Thispackage\ kann nur im sog.~vertikalen Modus von \TeX\ Hyperlink"=Anker +% setzen.\par + Diese Warnung sollten Sie niemals sehen; entweder verwenden Sie ein Paket, + welches |figure| und/oder |table| in einer dem \package{caption}"=Paket + unbekannten Art \& Weise verдndert, oder aber es ist ein Bug im + \package{caption}"=Paket. + Bitte senden Sie mir einen Fehlerbericht diesbezьglich per E-Mail. Danke! + +\end{Warnings} + +\pagebreak[4] +\subsection{Fehlermeldungen} + +\begin{Warnings} + +\Message + |! Argument of \@caption has an extra }.| +\Description + Beim Setzen von Beschriftungen, die etwas spezielles wie z.B.~eine + Tabelle enthдlt, ist zu beachten, daЯ immer ein alternativer Listeneintrag + als optionales Argument bei |\caption| bzw. |\captionof| mit angegeben + werden muЯ, auch wenn Ihr Dokument gar kein Abbildungs- oder + Tabellenverzeichnis beeinhaltet. + \par\See{\Ref{commands}, \Ref{listof}, and \Ref{hyperref}\,} + +\Message + |\caption outside float.| +\Description + |\caption| ist (in der Regel) nur fьr die Anwendung in gleitenden + Umgebungen wie |figure| oder |table|, oder fьr die Anwendung innerhalb + |longtable| konzipiert, ansonsten bekommen Sie obenstehende Fehlermeldung.\par + Um eine Beschriftung innerhalb einer anderen Umgebung zu setzen, verwenden Sie + bitte entweder die Kombination |\captionsetup{|\xx|type=|\xx\meta{type}|}| $+$ + |\caption|, oder aber |\captionof|. + \par\See{\Ref{commands}} + +\Message + |\caption outside group or environment.| +\Description + |\caption| bzw. |\captionof| sind nur fьr die Anwendung innerhalb einer + Box, Gruppe oder Umgebung konzipiert. + \par\See{\Ref{commands}} + +\Message + |\captionsetup{type=|\meta{type}|} outside group or environment.| +\Description + |\captionof| bzw. |\captionsetup{|\xx|type=|\xx\meta{type}|}| sind nur + fьr die Anwendung innerhalb einer Box, Gruppe oder Umgebung konzipiert. + \par\See{\Ref{commands}} + +\Message + |\ContinuedFloat outside float.| +\Description + |\ContinuedFloat| ist nur fьr die Anwendung innerhalb einer gleitenden + Umgebung wie |figure| oder |table| konzipiert. %oder auch |longtable| + Fьr die Anwendung in einer Box, Gruppe oder nicht-gleitenden Umgebung + bietet sich die Kombination + |\captionsetup{|\xx|type=|\xx\meta{Typ}|}| $+$ |\ContinuedFloat| an.\par + |\ContinuedFloat| innerhalb einer |longtable| funktioniert zwar (noch) + nicht, aber vielleicht ist die |longtable*| Umgebung, die eine longtable + ohne Erhцhung des Tabellenzдhlers setzt, fьr Sie hilfreich. + \par\See{\Ref{commands} und \Ref{longtable}} + +\Message + |Continued `|\meta{type}|' after `|\meta{type}|'.| +\Description + Z.Z.~ dьrfen fortlaufende Abbildungen oder Tabellen nicht von anderen gleitenden + Umgebungen oder einer |longtable| unterbrochen werden, so ist z.B.~ eine Tabelle + zwischen einer Abbildung und einer (mit |\ContinuedFloat|) fortgesetzten Abbildung + nicht mцglich. + \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 + Achten Sie bei der gleichzeitigen Verwendung der Pakete \package{wrapfig} + und \package{float} unbedingt auf die richtige Ladereihenfolge und + Anwendung. + \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 + Fьr die gleichzeitige Verwendung der Pakete \package{wrapfig} und + \package{float} wird die Version $3.6$ des \package{wrapfig}"=Paketes + benцtigt. + \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 + Das aktuelle \package{caption}"=Paket kann nicht mit einem solchen, + veralteten Paket zusammen betrieben werden. + Bitte aktualisieren Sie das betroffene Paket, zumindest auf die + benцtigte Version. + +\Message + |Internal error: |\meta{internal-error-message}|.| +\Description + Diesen Fehler sollten Sie niemals sehen. Wenn doch, senden Sie mir bitte + einen Fehlerbericht per E-Mail. + +\Message + |Not allowed in longtable* environment.| +\Description + Der Befehl |\caption| ist nicht immerhalb einer |longtable*| Umgebung + erlaubt. Verwenden sie entweder |\caption*| fьr eine Beschriftung ohne + Bezeichner oder benutzen Sie die regulдre |longtable| Umgebung. + +\Message + |Not available in compatibility mode.| +\Description + Das angeforderte Feature steht im sog.~Kompatibilitдtsmodus nicht zur + Verfьgung, d.h.~\thispackage\ hat eine inkompatible Dokumentenklasse oder + ein inkompatibles Paket entdeckt, welches ebenfalls |\caption| erweitert + und damit die Anwendung dieses Features bzw.~Befehls verhindert. + \par\See{\Ref{compatibility}} + +\Message + |Runaway argument?|\\ + |! Paragraph ended before \caption@makecurrent was complete.| +\Description + Beim Setzen von Beschriftungen, die mehr als aus einem Absatz bestehen, + ist zu beachten, daЯ immer ein alternativer Listeneintrag als optionales + Argument bei |\caption| bzw. |\captionof| mit angegeben werden muЯ, + auch wenn Ihr Dokument gar kein Abbildungs- oder Tabellenverzeichnis + beeinhaltet. + \par\See{\Ref{commands}, \Ref{listof}, and \Ref{hyperref}\,} + +\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 + Achten Sie bei der gleichzeitigen Verwendung der Pakete \package{wrapfig} + und \package{float} unbedingt auf die richtige Ladereihenfolge und + Anwendung. Aber vielleicht hat auch ein anderes Paket das + \package{float}"=Paket in einer fьr \thispackage\ inkompatiblen + Art \& Weise erweitert!? + \par\See{\Ref{float} und \Ref{wrapfig}} + +\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 package option `caption=false' is obsolete.|\\ + |Please pass this option to the subfig package instead|\\ + |and do *not* load the caption package anymore.| +\Description + Sie haben die Option |caption=false| angegeben. Diese war frьher mal eine + Krьcke, um nicht das komplette \package{caption}"=Paket zu laden, sondern + nur den fьr das \package{subfig}"=Paket zwingend benцtigten Teil. + Dieser Mechanismus ist veraltet und wird nicht mehr angeboten; stattdessen + sollten sie diese Option dem \package{subfig}"=Paket ьbergeben und + \thispackage\ nicht mehr explizit laden. + \par\See{Dokumentation des \package{subfig}"=Paketes\cite{subfig}} + +\Message + |Undefined boolean value `|\meta{value}|'.| +\Description + Es wurde versucht, eine boolische Option (wie z.B.~|singlelinecheck=| oder + |hypcap=|) auf einen unbekannten Wert zu setzen. Nur die Werte |false|, |no|, + |off|, |0| bzw.~|true|, |yes|, |on| und |1| sind hier mцglich. + +\Message + |Undefined format `|\meta{name}|'.| +\Description + Es wurde versucht, ein Beschriftungsformat auszuwдhlen, welches nicht + definiert ist. Vielleicht ein Schreibfehler!? + \par\See{\Ref{formats}} + +\Message + |Undefined label format `|\meta{name}|'.| +\Description + Es wurde versucht, ein Bezeichnungsformat auszuwдhlen, welches nicht + definiert ist. Vielleicht ein Schreibfehler!? + \par\See{\Ref{formats}} + +\Message + |Undefined label separator `|\meta{name}|'.| +\Description + Es wurde versucht, ein Beschriftungstrenner auszuwдhlen, welcher nicht + definiert ist. Vielleicht ein Schreibfehler!? + \par\See{\Ref{formats}} + +\Message + |Undefined list-of format `|\meta{name}|'.| +\Description + Es wurde versucht, ein Listenformat auszuwдhlen, welches nicht + definiert ist. Vielleicht ein Schreibfehler!? + \par\See{\Ref{listof}} + +\Message + |Undefined position `|\meta{name}|'.| +\Description + Es wurde versucht, den Positionshinweis auf einen unbekannten Wert zu + setzen. Vielleicht ein Schreibfehler!? + \par\See{\Ref{skips}} + +\Message + |Undefined style `|\meta{name}|'.| +\Description + Es wurde versucht, ein Beschriftungsstil auszuwдhlen, welcher nicht + definiert ist. Vielleicht ein Schreibfehler!? + \par\See{\Ref{style}} + +\Message + |Undefined text format `|\meta{name}|'.| +\Description + Es wurde versucht, ein Textformat auszuwдhlen, welches nicht + definiert ist. Vielleicht ein Schreibfehler!? + \par\See{\Ref{formats}} + +\Message + |You can't use both, the (obsolete) caption2 *and*|\\ + |the (current) caption package.| +\Description + Die Pakete \package{caption} und \package{caption2} kцnnen nicht + innerhalb eines Dokumentes gleichzeitig verwendet werden. + Verwenden Sie bitte nur das aktuelle \package{caption}"=Paket. + \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) + Das angegebene Paket mischt sich ebenfalls in die Verwendung der Abstдnde + ьber- und unterhalb der Beschriftungen ein. + Sie mьssen sich daher fьr eines der Pakete -- das angegebene oder + \thispackage\ -- zu entscheiden, um falsche Abstдnde zu verhindern. + \par\See{\Ref{skips}} + +\end{Warnings} + +% --------------------------------------------------------------------------- % + +\pagebreak[4] +\section{Weiterf"uhrende Dokumente} + +Folgende, im Internet verfьgbare Dokumente m"ochte ich an dieser Stelle +jedem ans Herz legen: + +\begin{itemize} +\item + Die \TeX\ FAQ -- "`Frequently Asked Questions"' ьber \TeX\ und \LaTeX: + \begin{quote}\url{http://faq.tug.org/}\end{quote} + +\iffalse +\item + Die DANTE-FAQ -- Oft gestellte Fragen \& deren Antworten: + \begin{quote}\url{http://www.dante.de/faq/de-tex-faq/}\end{quote} +\fi + +\item + \emph{"`Hilfe fьr LaTeX-Einsteiger"'} von Christian Faulhammer: + \begin{quote}\url{http://www.minimalbeispiel.de/}\end{quote} + +\item + \emph{"`Gleitobjekte -- die richtige Schmierung"'} von Axel Reichert + erl"autert den Umgang mit gleitenden Umgebungen und ist hier im Netz + zu finden: + \begin{quote} + \url{ftp://dante.ctan.org/pub/tex/info/german/gleitobjekte/} + \end{quote} + +\item + \emph{"`Bilder einfьgen in \LaTeX: Ein How-To"'} von Dominik Bischoff + beinhaltet die hдufigsten Fragen und Antworten, die im Zusammenhang + mit \LaTeX\ und Abbildungen auftreten: + \begin{quote} + \url{http://tug.ctan.org/info/l2picfaq/german/l2picfaq.pdf} + \end{quote} + +\item + \textsf{epslatex} von Keith Reckdahl enth"alt viele n"utzliche Tips im + Zusammenhang mit der Einbindung von Graphiken in \LaTeXe. + Das Dokument ist in Englisch und unter + \begin{quote}\url{ftp://dante.ctan.org/pub/tex/info/epslatex/}\end{quote} + zu finden. +\end{itemize} + +% --------------------------------------------------------------------------- % + +\pagebreak[2] +\section{Danksagungen} + +Von ganzem Herzen danke ich Katja Melzner, +Steven D. Cochran, Frank Mittelbach, Olga Lapko, +David Carlisle, Carsten Heinz und Keith Reckdahl. + +Weiterhin m"ochte ich mich herzlich bei +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 +und +Prof.~Dr.~Dirk Hoffmann +f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. + +% --------------------------------------------------------------------------- % + +\pagebreak[4] +\begin{thebibliography}{99} + \bibitem{TLC2} + Frank Mittelbach and Michel Goossens:\\ + \newblock {\em Der {\LaTeX} Begleiter (2.\,Auflage)},\\ + \newblock Addison-Wesley, 2004. + + \bibitem{beamer} + Till Tantau:\\ + \href{ftp://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguide.pdf}% + {\emph{KOMA-Script -- ein wandelbares \LaTeXe-Paket}},\\ + 2007-03-02 + + \bibitem{NTG} + Victor Eijkhout:\\ + \href{ftp://dante.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://dante.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://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}% + {\emph{The floatrow package documentation}},\\ + 2006/07/24 + + \bibitem{fltpage} + Sebastian Gross:\\ + \href{ftp://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}% + {\emph{Hypertext marks in \LaTeX}},\\ + June 14, 2007 + + \bibitem{hypcap} + Heiko Oberdiek:\\ + \href{ftp://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}% + {\emph{The Listings Package}},\\ + 2007/02/22 + + \bibitem{longtable} + David Carlisle:\\ + \href{ftp://dante.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}% + {\emph{The longtable package}},\\ + 2004/02/01 + + \bibitem{picinpar} + Friedhelm Sowa:\\ + \href{ftp://dante.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% + {\emph{Pictures in Paragraphs}},\\ + July 13, 1993 + + \bibitem{picins} + Joachim Bleser and Edmund Lang:\\ + \href{ftp://dante.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://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}% + {\emph{The sidecap package}},\\ + 2003/06/06 + + \bibitem{subfigure} + Steven D. Cochran:\\ + \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}% + {\emph{The subfigure package}},\\ + 2002/07/02 + + \bibitem{subfig} + Steven D. Cochran:\\ + \href{ftp://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}% + {\emph{The supertabular environment}},\\ + 2002/07/19 + + \bibitem{threeparttable} + Donald Arseneau:\\ + \href{ftp://dante.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://dante.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% + {\emph{WRAPFIG.STY ver 3.6}},\\ + 2003/01/31 +\end{thebibliography} + +% --------------------------------------------------------------------------- % + +\end{document} diff --git a/Master/texmf-dist/doc/latex/caption/caption-eng.pdf b/Master/texmf-dist/doc/latex/caption/caption-eng.pdf Binary files differnew file mode 100644 index 00000000000..04b1557a86b --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/caption-eng.pdf diff --git a/Master/texmf-dist/doc/latex/caption/caption-eng.tex b/Master/texmf-dist/doc/latex/caption/caption-eng.tex new file mode 100644 index 00000000000..ca513786f49 --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/caption-eng.tex @@ -0,0 +1,2645 @@ +% +% 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/03 v3.1 The caption package] +\hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. +%\errorcontextlines=3 + +\documentclass{ltxdoc} +\setlength\parindent{0pt} +\setlength\parskip{\smallskipamount} + +\ifx\pdfoutput\undefined\else + \ifcase\pdfoutput\else + \usepackage{mathptmx,courier} + \usepackage[scaled=0.90]{helvet} + \addtolength\marginparwidth{15pt} + \fi +\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 consits 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} + \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=top} + \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} + +(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|). + +% --------------------------------------------------------------------------- % + +\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} \\ +|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 +{\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 + |*****************************************************|\\ + |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 + |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 + |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 + |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 in the document. 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}} + +\Message + |Wrong TeX mode, no hyperlink anchor was set.| +\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. + +\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{internal-error-message}|.| +\Description + You should never see this error. + Please send me an e-mail reporting this issue. + +\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}\,} + +\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}} + +\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 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}\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, +and +Prof.~Dr.~Dirk Hoffmann, +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} diff --git a/Master/texmf-dist/doc/latex/caption/caption-rus.pdf b/Master/texmf-dist/doc/latex/caption/caption-rus.pdf Binary files differnew file mode 100644 index 00000000000..80802bf0584 --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/caption-rus.pdf diff --git a/Master/texmf-dist/doc/latex/caption/caption-rus.tex b/Master/texmf-dist/doc/latex/caption/caption-rus.tex new file mode 100644 index 00000000000..8a47c6521c8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/caption-rus.tex @@ -0,0 +1,2554 @@ +% \iffalse meta-comment +% +% This is file `caption-rus.tex'. +% Russian translation of documented part of `caption.dtx' +% +% Copyright (C) 1994-2007 Axel Sommerfeldt (caption@sommerfee.de) +% and Olga Lapko (Lapko.O@g23.relcom.ru) +% +% -------------------------------------------------------------------------- +% +% 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, +% ltcaption.dtx, and subcaption.dtx, the derived files caption.sty, +% caption2.sty, caption3.sty, ltcaption.sty, and subcaption.sty, and the +% user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. +% +% \fi +% \CheckSum{0} +% +% \iffalse +%<*driver> +\documentclass[russian]{ltxdoc} + +\usepackage{mathtext} +\usepackage[T2A]{fontenc} +\usepackage[cp1251]{inputenc} +\usepackage{babel} +\usepackage{listpen} +\setlength\parindent{0pt} +\setlength\parskip{\smallskipamount} +% +\newcommand\NEWfeature{\NEW{Новая возможность}} +\newcommand\NEWdescription{\NEW{Новое описание}} +% +\font\manual=manfnt +\newcommand\DANGER{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{\manual\char127}}}} +% +\ifx\pdfoutput\undefined\else + \ifcase\pdfoutput\else +% \usepackage{mathptmx,courier} +% \usepackage[scaled=0.90]{helvet} +% \def\rmdefault{ftm} +% \def\sfdefault{ftx} +% \def\ttdefault{cmtt} + \addtolength\marginparwidth{15pt} + \fi +\fi +% +%\usepackage[french,USenglish]{babel} +\usepackage{color,setspace} +% +%\usepackage{float} +\usepackage{longtable} +%\usepackage[raggedright]{sidecap} +% +\usepackage{caption}[2005/08/24] +\DeclareCaptionLabelSeparator{endash}{\space\textendash\space} +\usepackage[unicode]{hyperref} +% +\DeclareCaptionFont{singlespacing}{\setstretch{1}} +\DeclareCaptionFont{onehalfspacing}{\onehalfspacing} +\DeclareCaptionFont{doublespacing}{\doublespacing} +\DeclareCaptionFont{red}{\color{red}} +\DeclareCaptionFont{green}{\color{green}} +\DeclareCaptionFont{blue}{\color{blue}} +% +\DeclareCaptionLabelSeparator{period-newline}{. \\} +\DeclareCaptionStyle{period-newline}[labelsep=period]{labelsep=period-newline} +\DeclareCaptionStyle{period-newline2}[labelsep=period,justification=centering]{labelsep=period-newline} +\DeclareCaptionStyle{period-newline3}[labelsep=period]{labelsep=period-newline,justification=centering} +\DeclareCaptionFormat{reverse}{#3#2#1} +\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par} +\DeclareCaptionLabelFormat{fullparens}{(\bothIfFirst{#1}{ }#2)} +\DeclareCaptionLabelSeparator{fill}{\hfill} +% +\DeclareRobustCommand{\KOMAScript}{\textsf{K\kern.05em O\kern.05em% + M\kern.05em A\kern.1em-\kern.1em Script}} +\clubpenalty10000 + +\let\oriquote\quote +\def\quote{\allowprelistbreaks[-4]\oriquote} + +\makeatletter +\let\NoBreak\@nobreaktrue +\newcommand\NEW[2]{\hskip 1sp\@nobreaktrue + \marginpar + {\footnotesize\sffamily\raggedleft#1\\#2}} +\makeatother +\setcounter{IndexColumns}2 +\def\IndexParms{\raggedright\advance\rightskip1em} +% +%<+driver>\OnlyDescription +% +\begin{document} + \DocInput{caption-rus.tex} +\end{document} +%</driver> +% \fi +% +% +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% \newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}} +% \newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}} +% \newcommand*\purett[1]{{\upshape\mdseries\ttfamily #1}} +% \let\package\puresf\def\thispackage{\package{caption}} +% \let\env\purett \let\opt\purett +% +% \newcommand*\version[2][]{$v#2$} +% +% \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} +% \newcommand\example[3][figure]{% +% \begingroup +% \captionsetup{#2}% +% \captionof{#1}[]{#3}% +% \endgroup} +% +% \GetFileInfo{caption.sty} +% \title{Печать подписей плавающих объектов (флотов) с~помощью пакета +% \thispackage\thanks{Данный пакет версии +% \fileversion, последний раз модифицирован \filedate. +%^^A% Translated by O. Lapko 2007/05/24. The questions and notes +%^^A% about translation please +%^^A% send to \texttt{Lapko.O@g23.relcom.ru} (Olga Lapko). +%^^A% The version of translation could be obsolete. Please +%^^A% look English or German documentation for the new information +%^^A% (see margin labels).}} +% Перевод О.\,Лапко, 2007/05/24. Вопросы и~замечания по переводу +% направляйте по адресу \texttt{Lapko.O@g23.relcom.ru}. +% \emph{Версия перевода относится к~одной из предыдущих версий пакета и~может +% содержать устаревшие данные. +% Обращайтесь к~английской или немецкой документации за более свежей информацией +% (см.~пометки на полях)}.}} +% \author{Аксель Зоммерфельдт (Axel Sommerfeldt)\\ +% \href{mailto:caption@sommerfee.de}{\texttt{caption@sommerfee.de}}} +% \date{2007/04/09} +% \maketitle +% +%^^A \begin{abstract} +%^^A The \thispackage\ package offers customization of captions +%^^A in floating environments such |figure| and |table| and cooperates with +%^^A many other packages.\footnote{A complete re-work of the user interface +%^^A done with Steven D. Cochran and Frank Mittelbach has lead to +%^^A this new enhanced version 3.0.} +%^^A \end{abstract} +% \begin{abstract} +% Пакет \thispackage\ предлагает множество путей настройки печати +% подписей для плавающих объектов (флотов) +% |figure| и~|table| и~совместим (кооперируется) +% со~многими пакетами.\footnote{Полная переработка пользовательского +% интерфейса сделана совместно со~Стивеном Кокрейном (Steven~D.~Cochran) +% и~Франком Миттельбахом (Frank Mittelbach) +% и~создана для новой расширенной версии~3.0.} +% \end{abstract} +% +% \begingroup\small +%^^A% \vspace{2ex}\centerline{\textbf{Frequently Appeared Design\footnote +%^^A% {Added in translated text.}}\nopagebreak} +% \vspace{2ex}\centerline{\textbf{\TeX ническое редактирование\footnote +% {Добавлено при переводе.}}\nopagebreak} +% \begin{multicols}{2}\raggedright\advance\rightskip1em +% \makeatletter\let\item\@idxitem\ignorespaces\makeatother +%^^A% \item Last line of caption centered +% \item Выключка последней строки по центру +% \pageref{TeXr:centerlast} +%^^A% \item Hanged caption label +% \item Нумерационный заголовок на весу +% \pageref{TeXr:hang:label} +% +% %^^A \indexspace +% +%^^A% \item Spaces above and below captions +% \item Отбивки у~подписей над и~под флотами +% \pageref{TeXr:captionskips:a}%^^A--\pageref{TeXr:captionskips:z} +%^^A% \item Settings, for caption label +% \item Оформление +%^^A% \subitem for caption label +% \subitem нумерационных заголовков +% \pageref{TeXr:caplabel:a}%^^A--\pageref{TeXr:caplabel:z} +%^^A% \subitem for one-line captions +% \subitem однострочных подписей +% \pageref{TeXr:singleline:a}%^^A--\pageref{TeXr:singleline:z} +%^^A% \subitem for multi-paragraph captions +% \subitem подписей из нескольких абзацев +% \pageref{TeXr:multipar:a}%^^A--\pageref{TeXr:multipar:z} +% +% %^^A \indexspace +% +%^^A% \item Captions +% \item Подписи\nopagebreak +%^^A% \subitem for continued floats +% \subitem к~флотам с~продолжением +% \pageref{TeXr:continued:a}\nopagebreak %^^A--\pageref{TeXr:continued:z} +%^^A% \subitem above tables +% \subitem над таблицами +% \pageref{TeXr:captop:a}%^^A--\pageref{TeXr:captop:z} +%^^A% \subitem skipped entry in list +% \subitem без записи в~списке рисунков, +%^^A% \subsubitem trick with empty option +% \subsubitem трюк с~дополнительным аргументом команды +% |\caption| \pageref{TeXr:nolistentry:I} +%^^A% \subsubitem key |listof=| +% \subsubitem ключ пакета |listof=| +% \pageref{TeXr:nolistentry:II} +%^^A% \subitem unlabeled +% \subitem без нумерационного заголовка +% \pageref{TeXr:starcaption:a}%^^A--\pageref{TeXr:starcaption:z} +%^^A% \subitem outside float +% \subitem вне окружения флота +% \pageref{TeXr:captiononof:a}%^^A--\pageref{TeXr:captiononof:z} +% +% \end{multicols}% +% \endgroup +% \newpage +% +% \tableofcontents +%^^A \newcommand\figuretext{^^A +%^^A White sand beaches. The pink smoothness of the conch shell. A sea abundant +%^^A with possibilities. Duty-free shops filled with Europe's finest gifts and +%^^A perfumes. Play your favorite game of golf amidst the tropical greens on one +%^^A of the many championship courses.} +%^^A^^A Here is not translation! +% \newcommand\figuretext{^^A +% Тибетская мандала (1800\,г.) представляет собой своеобразную карту как +% особого храма, так и Шамбалы~(?). Хорошо видны ворота по четырём сторонам +% света, сама постройка идёт уступами вверх. (Мозаика пола рыцарского храма +% на о.~Родос точным образом воспроизводит узор тибетской мандалы.)} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \section{Introduction} +% \section{Введение} +% +%^^A Within the standard \LaTeX\ classes captions haven't received the attention +%^^A they deserve. Simply typeset as an ordinary paragraph there is no +%^^A remarkable visual difference from the rest of the text, like here: +% Внутри стандартных классов \LaTeX'а~подписи не получили заслуженного +% внимания. Они набираются как обычный абзац без всяких отличий от основного +% текста, как здесь: +% +% \example{belowskip=\abovecaptionskip}{\figuretext} +% +%^^A There should be possibilities to change this; for example, it would be nice +%^^A if you could make the text of the caption a little bit smaller as the normal +%^^A text, add an extra margin, typeset the caption label with the same font +%^^A family and shape as your headings etc. Just like this one: +% Должна быть возможность изменить это; например будет лучше, если текст +% задать меньшим кеглем, добавить втяжку (с~обеих сторон), набрать +% нумерационный заголовок подписи шрифтом основного текста, но задать +% начертание или насыщенность как у~заголовков и~т.\,д. Например, как следующую подпись: +% +% \example{belowskip=\abovecaptionskip,size=small,margin=10pt,labelfont=bf,labelsep=endash}{\figuretext} +% +%^^A You can do this easily with this package as there are many ready-to-use +%^^A caption formatting options, but you are free to define your very own stuff, too. +% С~данным пакетом это просто сделать, поскольку в~нём уже есть множество готовых +% опций ключей настройки, и~вы свободны и~выбрать своё сочетание опций для +% оформления, и~создать свои опции. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% +%^^A \section{Using the package} +% \section{Использование пакета} +% \label{usage} +% +% \DescribeMacro{\usepackage} +%^^A Insert +% Добавьте +% \begin{quote} +% |\usepackage|\oarg{options}|{caption}[|\texttt{\filedate}|]| +% \end{quote} +%^^A into the preamble of your document, i.e.~the part of your document +%^^A between |\documentclass| and |\begin{document}|. +%^^A The options control how your captions will look like; e.g., +% в~преамбулу вашего документа, т.\,е. в~часть файла между командами +% |\documentclass| и~|\begin{document}|. +% Опции задают настройки оформления подписей в~книге; например, опции +% \begin{quote} +% |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}| +% \end{quote} +%^^A would result in captions looking like the second one in the introduction. +% зададут подписи, похожие на второй пример во введении. +% +% \DescribeMacro{\captionsetup} +%^^A For a later change of options the \thispackage\ package provides the command +% Для последующих изменений пакет \thispackage\ предлагает команду +% \begin{quote} +% |\captionsetup|\oarg{float type}\marg{options} +% \end{quote} +%^^A So +% Следовательно, определения +% \begin{quote} +% |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}| +% \end{quote} +%^^A and +% и +% \begin{quote} +% |\usepackage{caption}|\\ +% |\captionsetup{margin=10pt,font=small,labelfont=bf}| +% \end{quote} +%^^A are equal in their results. +% эквивалентны. +% +%^^A It's good to know that |\captionsetup| has an effect on the current +%^^A environment only. So if you want to change some settings for the +%^^A current |figure| or |table| only, just place the |\captionsetup| command +%^^A inside the |figure| or |table| right before the |\caption| command. +%^^A For example +% Нужно обратить внимание, что установки |\captionsetup| могут действовать и~на одно +% окружение. Так что, если вы хотите изменить установки только +% текущего окружения |figure| или |table|, поместите команду |\captionsetup| +% внутри |figure| или |table| прямо перед командой |\caption|. +% Например +% \begin{quote} +% |\begin{figure}|\\ +% | |\ldots\\ +% | \captionsetup{singlelinecheck=off}|\\ +% | \caption{|\ldots|}|\\ +% |\end{figure}| +% \end{quote} +%^^A switches the single-line-check off, but only for this |figure| so all +%^^A the other captions remain untouched. +% отключает контроль однострочной подписи (см.~об этом ниже), но только для данного +% окружения |figure|, другие подписи не изменятся. +% +%^^A (For a description of the optional parameter \meta{float type} see +%^^A section \ref{misc}: \textit{``Useful stuff''}.) +% (Для описания дополнительного параметра \meta{float type} +% см.~разд.~\ref{misc}: \textit{«Полезные утилиты»}.) +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% +%^^A \section{Options} +% \section{Опции} +% +% \def\OptionLabel{RaggedRight} +% \def\UserDefined{\ldots} +% \makeatletter +% \newcommand*\Section{\@ifstar{\@Section\relax}{\@Section{разд.}}} +% \newcommand*\@Section[3]{#1 \ref{#2}: \textit{«#3»}} +% \makeatother +% \newcommand*\See[1]{{\small (См.~#1)}} +% \newcommand*\SeeUserDefined[1][]{% +% \See{\Section{declare}{Делаем сами}#1}} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{Formatting} +% \subsection{Оформление} +% +% \DescribeMacro{format=} +%^^A A figure or table caption mainly consists of three parts: the caption label, +%^^A which says if this object is a `Figure' or `Table' and what number is +%^^A associated with it, the caption text itself, which is normally a short +%^^A description of contents, and the caption separator which separates the text +%^^A from the label. +% Подпись рисунка или таблицы обычно имеет три части\nopagebreak: нумерационный +% заголовок, который объявляет, что этот объект `Рис'унок или `Таблица' и~какой +% номер он имеет, собственно текст подписи, который обычно даёт краткое описание +% содержания, и~разделитель между нумерационной частью подписи и~текстом. +% +%^^A The \textit{caption format} determines how this information will be presented; +%^^A it is specified with the option +% \textit{Формат подписи} определяет, как данная информация будет представлена; +% это определяется ключом +% \begin{quote} +% |format=|\meta{format name}\quad , +% \end{quote} +%^^A having the name of the caption format as its argument. +% с~опцией, определяющей оформление (формат) подписи. +% +%^^A There are two standard caption formats: +% Далее два стандартных оформления подписи: +% \iffalse +%^^A \footnote{You have the option to +%^^A define your own ones, too. See section \ref{declare}: +%^^A \textit{``Do it yourself!''} for details.} +% \footnote{Вы можете задавать опции +% для создания своего оформления. См. подробнее в~разд.~\ref{declare}: +% \textit{«Делаем сами!»}.} +% \fi +% +% \begin{Options}{\OptionLabel} +% \item[plain]\NEWdescription{v3.0h} +%^^A Typesets the captions as a normal paragraph. +%^^A (This is the default behaviour, it +%^^A is adapted from the standard \LaTeX\ document classes.) +% Печатает подписи как обычный абзац. +% (Это оформление задано по умолчанию, +% и~аналогично стандартному оформлению классов \LaTeX'а.) +% +% \item[hang] +%^^A Indents the caption text, so it will `hang' under the first line of the text. +% Делает втяжку так, что первая строка (нумерационный заголовок) выступает влево.%^^A +% \label{TeXr:hang:label} +% +% \item[\UserDefined] +%^^A Own formats can be defined using |\DeclareCaptionFormat|. +% Собственное оформление может быть определено, с~помощью команды +% |\DeclareCaptionFormat|. \SeeUserDefined +% \end{Options} +% +% \begin{Example} +%^^A An example: Specifying the option +% Пример: задание опции +% \begin{quote} +% |format=hang| +% \end{quote} +%^^A yields captions like this: +% создаёт подписи как эта: +% \example{format=hang}{\figuretext} +% \end{Example} +% +% \DescribeMacro{indention=} +%^^A For both formats (\texttt{plain} and \texttt{hang}) you can setup an extra +%^^A indention starting at the second line of the caption. You do this with the +%^^A option +% Для обоих оформлений (\texttt{plain} и~\texttt{hang}) можно установить +% дополнительную втяжку второй строки подписи. Это можно сделать с~ключом +% \begin{quote} +% |indention=|\meta{amount}. +% \end{quote} +%^^A% [Please note, that indention of the keys \verb|format=hang| and +%^^A% |indention=|\meta{amount} are summarized.---\emph{Trans.}] +% [Обратите внимание, что втяжка из ключей \verb|format=hang| и~|indention=|\meta{amount} +% суммируются. \cdash--- \emph{Прим.\,перев.}] +% +%^^A Two examples: +% Пара примеров: +% +% \begin{Example} +% \begin{quote} +% |format=plain,indention=.5cm| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{format=plain,indention=.5cm}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |format=hang,indention=-0.5cm| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{format=hang,indention=-0.5cm}{\figuretext} +% \end{Example} +% +% +% \DescribeMacro{labelformat=} +%^^A With the option +% С~ключом\label{TeXr:caplabel:a} +% \nopagebreak[3] +% \begin{quote} +% |labelformat=|\meta{label format name} +% \end{quote} +% \NEWdescription{v3.0e} +%^^A you specify how the caption label will be typeset. +%^^A There are four standard caption label formats: +% вы задаёте, как печатается нумерационная часть. +% Существуют четыре стандартных оформления нумерационного заголовка: +% +% \begin{Options}{\OptionLabel} +% \item[default] +%^^A the caption label will be typeset as specified by the document class, +%^^A usually this means the name and the number (like \texttt{simple}). +%^^A (this is the default behaviour.) +% нумерационный заголовок печатается так же как в~стандартных классах, +% это обычно название флота и~номер (как \texttt{simple}). +% (Задаётся по умолчанию.) +% +% \item[empty] +%^^A The caption label will be empty. (This option makes sense when used +%^^A together with other options like \texttt{labelsep=none}.) +% Нумерационный заголовок отсутствует. (Эта опция имеет смысл вместе +% с~опциями типа \texttt{labelsep=none}.) +% +% \item[simple] +%^^A The caption label will be typeset as a name and a number. +% Нумерационный заголовок печатается как название флота и~его номер. +% +% \item[parens] +%^^A The number of the caption label will be typeset in parentheses. +% Номер в~нумерационной части заголовка печатается в~скобках. +% +% \item[\UserDefined] +%^^A Own label formats can be defined using |\DeclareCaptionLabelFormat|. +% Собственное оформление может быть определено с~помощью +% команды |\DeclareCaptionLabelFormat|. +% \SeeUserDefined +% \end{Options} +% +% \begin{Example} +%^^A An example: Using the options +% Пример: с~опциями ключей +% \begin{quote} +% |labelformat=parens,labelsep=quad| +% \end{quote} +%^^A gives captions like this one: +% создаётся такая подпись: +% \example{labelformat=parens,labelsep=quad}{\figuretext} +% \end{Example} +% +% \DescribeMacro{labelsep=} +%^^A With the option +% С~ключом +% \begin{quote} +% |labelsep=|\meta{label separator name} +% \end{quote} +%^^A you specify what caption separator will be used. +%^^A You can choose one of the following: +% вы определяете какой разделитель [между нумерационным заголовком и~текстом] +% будет использоваться. +% Вы можете задать следующие опции: +% +% \begin{Options}{\OptionLabel} +% \item[none] +%^^A There is no caption separator. (This option makes sense when used +%^^A together with other options like \texttt{labelformat=empty}.) +% Отсутствует разделитель нумерационной части и~текста подписи. (Применение этой опции +% имеет смысл вместе с~опциями типа \texttt{labelformat=empty}.) +% +% \item[colon] +%^^A The caption label and text will be separated by a colon and a space. +%^^A (This is the default one.) +% Нумерационный заголовок и~текст разделены двоеточием и~пробелом. +% (Задаётся по умолчанию.) +% +% \item[period] +%^^A The caption label and text will be separated by a period and a space. +% Нумерационная часть и~текст разделены точкой и~пробелом. +% +% \item[space] +%^^A The caption label and text will be separated by a single space. +% Нумерационная часть и~текст разделяется пробелом. +% +% \item[quad] +%^^A The caption label and text will be separated by a |\quad|. +% Нумерационная часть и~текст разделяется кегельной (|\quad|). +% +% \item[newline] +%^^A The caption label and text will be separated by a line break (|\\|). +% Нумерационный заголовок и~текст разделены новой строкой~(|\\|). +% +% +% \item[endash]\NEWfeature{v3.0h} +%^^A The caption label and text will be separated by an en-dash, +%^^A surrounded by spaces (| -- |). +% Нумерационный заголовок и~текст разделяется кратким тире, +% окружённым пробелами (| -- |). +% +% \item[\UserDefined] +%^^A Own separators can be defined using |\DeclareCaptionLabelSeparator|. +% Собственные разделители можно определить, используя команду +% |\DeclareCaptionLabelSeparator|. +% \SeeUserDefined +% \end{Options} +% +%^^A Three examples: +% Три примера: +% \begin{Example} +% \begin{quote} +% |labelsep=period| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{labelsep=period}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |labelsep=newline,singlelinecheck=false| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{labelsep=newline,singlelinecheck=false}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |labelsep=endash| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{labelsep=endash}{\figuretext}%^^A +% \label{TeXr:caplabel:z} +% \end{Example} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{Justification} +% \subsection{Выключка} +% \label{justification} +% +% \DescribeMacro{justification=} +%^^A As addition to the caption format you could also specify a +%^^A \emph{caption justification}; it is specified with the option +% При оформлении подписи вы можете определить +% \emph{выключку подписи}; она задаётся ключом +% \begin{quote} +% |justification=|\meta{justification name}\quad. +% \end{quote} +% +%^^A You can choose one of the following: +% Вы можете выбрать следующие опции: +% +% \begin{Options}{\OptionLabel} +% \item[justified] +%^^A Typesets the caption as a normal paragraph. (This is the default.) +% Печатает подпись в~виде обычного абзаца. (По умолчанию.) +% +% \item[centering] +%^^A Each line of the caption will be centered. +% Все строки выключены по центру. +% +% \iffalse +% \item[Centering] +%^^A Each line of the caption will be centered, too. +%^^A But this time the command |\Centering| of the \package{ragged2e} package +%^^A will be used to achieve this. This difference is that this time the word +%^^A breaking algorithm of \TeX\ will work inside the caption. +% Каждая строка также выключена по центру. +% Но в~данном случае используется команда |\Centering| из пакета \package{ragged2e}. +% Это означает что включается алгоритм разрыва [слов] на строки Plain \TeX'а. +% \fi +% +% \item[centerlast] +%^^A The last line of each paragraph of the caption text will be centered. +% Абзац набирается на полный формат, последняя строка выключена по центру. +% +% \item[centerfirst] +%^^A Only the first line of the caption will be centered. +% Центрируется только первая строка [остальные, в~том числе и~концевая, +% выключаются на полный формат]. +% +% \item[raggedright] +%^^A Each line of the caption will be moved to the left margin. +% Строки подписи выключены влево. +% +% \iffalse +% \item[RaggedRight] +%^^A Each line of the caption will be moved to the left margin using +%^^A the command |\RaggedRight| from the \package{ragged2e} package. +% Строки подписи выключены влево с~использованием команды +% |\RaggedRight| из пакета \package{ragged2e}. +% \fi +% \item[RaggedRight] +%^^A Each line of the caption will be moved to the left margin, too. +%^^A But this time the command |\RaggedRight| of the \package{ragged2e} package +%^^A will be used to achieve this. The main difference is that the word +%^^A breaking algorithm of \TeX\ will work inside captions. +% Строки подписи также выключены влево, +% но в~данном случае используется |\RaggedRight| пакета \package{ragged2e}. +% Отличие состоит в~том, что используется +% алгоритм разрыва [слов] на строки Plain \TeX'а. +% +% \item[raggedleft] +%^^A Each line of the caption will be moved to the right margin. +% Строки подписи выключены вправо. +% +% \iffalse +% \item[RaggedLeft] +%^^A Each line of the caption will be moved to the right margin using +%^^A the command |\RaggedLeft| from the \package{ragged2e} package. +% Строки подписи выключены вправо с~использованием команды +% |\RaggedRight| из пакета \package{ragged2e}. +% \fi +% +% \item[\UserDefined] +%^^A Own justifications can be defined using |\DeclareCaptionJustification|. +% Собственные определения выключки можно задать с~помощью команды +% |\DeclareCaptionJustification|. +% \SeeUserDefined +% \end{Options} +% +%^^A Three examples: +% Три примера:\label{TeXr:centerlast} +% \begin{Example} +% \begin{quote} +% |justification=centerlast| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{justification=centerlast}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |format=hang,justification=raggedright| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{format=hang,justification=raggedright}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |labelsep=newline,justification=centering| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{belowskip=\abovecaptionskip,labelsep=newline,justification=centering}{\figuretext} +% \end{Example} +% +% \DescribeMacro{singlelinecheck=}\label{TeXr:singleline:a} +%^^A The standard \LaTeX\ document classes (|article|, |report|, and |book|) +%^^A automatically center a caption if it fits in one single line: +% Стандартные классы \LaTeX'а (|article|, |report|, и~|book|) +% автоматически центрируют подпись если она однострочная: +% +% \example{belowskip=\abovecaptionskip}{Коротенькая подпись.} +% +% \DANGER +%^^A The \thispackage\ package adapts this behaviour and therefore usually +%^^A ignores the justification you have set with |justification=| in such case. +%^^A But you can switch this special treatment of such short captions off +%^^A with the option +% Пакет \thispackage\ следует за этим алгоритмом и~поэтому +% в~таких случаях игнорирует выключку, заданную ключом |justification=|. +% Определить, следовать этому алгоритму или нет можно, +% задав ключ +% \begin{quote} +% |singlelinecheck=|\meta{bool}\quad. +% \end{quote} +%^^A Using |false|, |no|, |off| or |0| for \meta{bool} switches the +%^^A extra centering off: +% Используя |false|, |no|, |off| или |0| вместо \meta{bool} вы отключите +% центрирование однострочной подписи: +% \begin{quote} +% |singlelinecheck=false| +% \end{quote} +%^^A Doing so the above short caption would look like +% После этого определения короткие подписи +% [при задании выключки по умолчанию в~виде обычного абзаца] +% будут выглядеть так +% +% \begingroup +% \captionsetup{type=figure} +% \ContinuedFloat +% \endgroup +% \example{belowskip=\abovecaptionskip,singlelinecheck=false}{Коротенькая подпись.} +% +%^^A You switch the extra centering on again by using |true|, |yes|, |on| or |1| +%^^A for \meta{bool}. (The default is on.) +% Используя |true|, |yes|, |on| или |1| вместо \meta{bool} вы включите механизм +% центрирования коротких подписей. (Задано по умолчанию.)%^^A +% \label{TeXr:singleline:z} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{Fonts} +% \subsection{Шрифты} +% \label{fonts} +% +% \DescribeMacro{font=} +% \DescribeMacro{labelfont=} +% \DescribeMacro{textfont=} +%^^A There are three font options which affects different parts of the caption: +%^^A One affecting the whole caption (|font|), one which only affects the caption +%^^A label and separator (|labelfont|) and at least one which only affects the +%^^A caption text (|textfont|). +%^^A You set them up using the options +% Заданы три ключа которые определяют шрифт разных элементов подписи: +% Один задаёт шрифт для всей подписи (|font|), другой задаёт шрифт только +% для нумерационного заголовка и~разделителя (|labelfont|), и~ещё один +% \cdash--- шрифт для текста (|testfont|). +% Вы задаёте их, используя ключи +% \begin{quote}\begin{tabular}{@{}r@{}ll} +% |font=| & \marg{font options} & ,\\ +% |labelfont=| & \marg{font options} & и\\ +% |textfont=| & \marg{font options} & .\\ +% \end{tabular}\end{quote} +% +%^^A 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[\UserDefined] +%^^A Own font options can be defined using |\DeclareCaptionFont|. +% Собственные опции могут быть определены с~помощью команды +% |\DeclareCaptionFont|. +% \SeeUserDefined +% \end{Options} +% +%^^A If you use only one of these options you can omit the braces; +%^^A e.g., the options +% Если используется одна опция ключа, фигурные скобки можно опустить; +% например, опции +% \iffalse +% \begin{quote} +% \fi +% |font={small}| +% \iffalse +% \end{quote} +% \fi +% и +% \iffalse +% \begin{quote} +% \fi +% |font=small| +% \iffalse +% \end{quote} +% \fi +%^^A will give the same result. +% дадут одинаковый результат. +% +%^^A Two examples: +% Пара примеров: +% \begin{Example} +% \begin{quote} +% |font={small,it},labelfont=bf| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{font={small,it},labelfont=bf}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |font=small,labelfont=bf,textfont=it| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{font=small,labelfont=bf,textfont=it}{\figuretext} +% \end{Example} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{Margins and further paragraph options} +% \subsection{Поля и~другие опции формирования абзаца} +% \label{margins} +% +% \DescribeMacro{margin=} +% \DescribeMacro{width=} +%^^A For all captions you can specify \emph{either} an extra margin \emph{or} +%^^A a fixed width. You do this by using the options +% Для всех подписей можно определить \emph{либо} дополнительную втяжку +% \emph{либо} фиксированную ширину. Это задаётся ключами +% \begin{quote} +% \begin{tabular}{@{}r@{}ll} +% |margin=| & \meta{amount} & \emph{или}\\ +% |width=| & \meta{amount} & \\ +% \end{tabular}\end{quote} +%^^A Nevertheless what option you use, the left and right margin will be the +%^^A same. +% Независимо от того, какой ключ используется, левое и~правое поле +% будут симметричны. +% +%^^A Two examples will illustrating this: +% Два иллюстрирующих примера: +% \begin{Example} +% \begin{quote} +% |margin=10pt| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{margin=10pt}{\figuretext} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |width=.75\textwidth| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{width=.75\textwidth}{\figuretext} +% \end{Example} +% +% \DescribeMacro{parskip=}\label{TeXr:multipar:a} +%^^A This option is useful for captions containing more than one paragraph. +%^^A It specifies the extra vertical space inserted between them: +% Данный ключ понадобится, если подписи содержат более одного абзаца. +% Он задаёт дополнительную вертикальную отбивку между абзацами: +% \begin{quote} +% |parskip=|\meta{amount} +% \end{quote} +%^^A One example: +% Пример: +% \begin{Example} +% \begin{quote} +% |margin=10pt,parskip=5pt| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{margin=10pt,parskip=5pt}{ +%^^A First paragraph of the caption. This one contains some test, just to +%^^A show how these options affect the layout of the caption. +%^^A +%^^A Second paragraph of the caption. This one contains some text, too, to +%^^A show how these options affect the layout of the caption.} +% Первый абзац подписи. Он содержит немного текста, чтобы показать +% как заданные настройки создают оформление подписи. +% +% Второй абзац подписи. Он тоже содержит немного текста, чтобы показать +% как заданные настройки создают оформление подписи.} +% \end{Example} +% +% \DescribeMacro{hangindent=} +%^^A The option +% Ключ +% \begin{quote} +% |hangindent=|\meta{amount} +% \end{quote} +%^^A is for setting up a hanging indention starting from the second line of each +%^^A paragraph. If the caption contains just a single paragraph, using this option +%^^A leads to the same result as the option |indention=| you already know about. +%^^A But if the caption contains multiple paragraphs you will notice the difference: +% задаёт втяжку для вторых строк каждого абзаца подписи. +% Если подпись состоит из одного абзаца, этот ключ даёт тот же результат +% что и~известный вам ключ |indention=|. +% Но в~подписи из нескольких абзацев вы увидите разницу: +% +% \begin{Example} +% \begin{quote} +% |format=hang,indention=-.5cm| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{format=hang,indention=-.5cm}{ +% Первый абзац подписи. Он содержит немного текста, чтобы показать +% как заданные настройки создают оформление подписи. +% +% Второй абзац подписи. Он тоже содержит немного текста, чтобы показать +% как заданные настройки создают оформление подписи.} +% \end{Example} +% +% \begin{Example} +% \begin{quote} +% |format=hang,hangindent=-.5cm| +% \end{quote} +% \captionsetup{aboveskip=0pt} +% \example{format=hang,hangindent=-.5cm}{ +% Первый абзац подписи. Он содержит немного текста, чтобы показать +% как заданные настройки создают оформление подписи. +% +% Второй абзац подписи. Он тоже содержит немного текста, чтобы показать +% как заданные настройки создают оформление подписи.} +% \label{TeXr:multipar:z} +% \end{Example} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% +%^^A \subsection{Styles} +% \subsection{Стили} +% \label{style} +% +% \NoBreak\DescribeMacro{style=} +%^^A A suitable combination of caption options is called \emph{caption style}. +%^^A You can compare them more or less to page styles which you set up with +%^^A |\pagestyle|: The caption style provides all settings for a whole caption layout. +% Определённая\nopagebreak[4] комбинация нескольких ключей создаёт \emph{стиль подписи}. +% Это можно сравнить со стилями колонтитула, задаваемого командой +% |\pagestyle|: стиль подписи задаёт все настройки для оформления подписи. +% +%^^A You switch to an already defined caption style with the option +% Предварительно созданный стиль можно вызвать ключом +% \begin{quote} +% |style=|\meta{style name}\quad. +% \end{quote} +%^^A The \thispackage\ package usually defines only the style |default| which +%^^A puts all options you already know about to the default ones. +%^^A This means that specifying the option +% Пакет \thispackage\ задаёт стиль |default|, который +% устанавливает известным вам ключам значения по умолчанию. +% Это означает, что определение этого ключа как +% \begin{quote} +% |style=default| +% \end{quote} +%^^A has the same effect as specifying all 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} +% +%^^A Own caption styles can be defined using |\DeclareCaptionStyle|. +% Собственный стиль подписи можно определить, используя |\DeclareCaptionStyle|. +% \SeeUserDefined +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{Skips} +% \subsection{Отбивки} +% +% \DescribeMacro{aboveskip=} +% \DescribeMacro{belowskip=} +%^^A The spaces above and below the caption are controlled by the skips +%^^A |\abovecaptionskip| and |\belowcaptionskip|. The standard \LaTeX\ document +%^^A classes |article|, |report| and |book| set |\abovecaptionskip| to |10pt| +%^^A and |\belowcaptionskip| to |0pt|. +% Отбивки сверху и~снизу подписи определяются командами +% |\abovecaptionskip| и~|\belowcaptionskip|. Стандартные классы \LaTeX'а +% |article|, |report| и~|book| задают |\abovecaptionskip| равным |10pt|, +% а~|\belowcaptionskip|\hbox{ \cdash--- |0pt|}. +% +% +%^^A Both skips can be changed with the command |\setlength|, but you can +%^^A use these options, too: +% Обе отбивки могут быть изменены командой |\setlength|, но также можно +% использовать и~ключи: +% \nopagebreak[3] +% \begin{quote}\begin{tabular}{@{}r@{}ll} +% |aboveskip=| & \meta{amount} & и\\ +% |belowskip=| & \meta{amount} & .\\ +% \end{tabular}\end{quote} +% +% \DescribeMacro{position=}\label{TeXr:captionskips:a} +%^^A Using |\abovecaptionskip| and |\belowcaptionskip| has a major design flaw: +%^^A If the caption is typeset \emph{above} (and not \emph{below}) the figure +%^^A or table they are not set up very useful at default, because there will be +%^^A some extra space above the caption but no space between the caption and the +%^^A figure or table itself. (Remember: |\belowcaptionskip| is usually set to |0pt|.) +% Использование команд |\abovecaptionskip| и~|\belowcaptionskip| имеет один +% недостаток: если подпись должна быть помещена \emph{над}, а~не \emph{под} +% плавающим объектом, то, в~результате, мы можем получить ненужную отбивку сверху +% и~никакой отбивки между подписью и~объектом. +% (Напомним: |\belowcaptionskip| обычно определена как~|0pt|.) +% +%^^A Please compare the spacing in these small tables: +% Пожалуйста, сравните отбивки у~двух небольших таблиц: +% \begin{Example} +% \begin{minipage}[c]{.5\linewidth} +% \iffalse +% \captionsetup{aboveskip=0pt}% +% \fi +% \captionof{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}{Табличка} +% \end{minipage} +% \end{Example} +% +%^^A But you can fix this by using the option |position=|: It specifies how the +%^^A spacing above and below the caption will be used: +% Но это можно исправить используя ключ |position=|: он определяет, как +% отбивки сверху и~снизу будут использованы; опция +% \begin{quote} +% |position=top|\quad(или |position=above|) +% \end{quote} +%^^A tells the \thispackage\ package to use the spacing useful for caption +%^^A \emph{above} the figure or table and +% говорит пакету \thispackage, что нужно задать соответствующие отбивки для подписи +% \emph{сверху} рисунка или таблицы и~опция +% \begin{quote} +% |position=bottom|\quad(или |position=below|) +% \end{quote} +%^^A tells the \thispackage\ package to use the spacing useful for captions +%^^A \emph{below} the figure or table. (The last one is the default setting +%^^A except for |longtable|s.) +% велит пакету \thispackage\ расставить соответствующие отбивки для подписи +% \emph{снизу} рисунка или таблицы. (Данная опция задаётся по умолчанию +% кроме окружения многостраничной таблицы |longtable|.) +% +%^^A So adding an extra |\captionsetup{position=top}| to the left example +%^^A table gives you proper spacing around both captions: +% Итак задание |\captionsetup{position=top}| для левой таблицы, +% в~примере выше даст нужные отбивки для обеих подписей: +% \begin{Example} +% \begin{minipage}[c]{.5\linewidth} +% \captionsetup{position=top} +% \captionof{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}{Табличка} +% \end{minipage} +% \end{Example} +% +%^^A (Technically speaking |\abovecaptionskip| and |\belowcaptionskip| will +%^^A be swapped if you specify the option |position=top|, so in both cases +%^^A |\abovecaptionskip| will be used between the caption and the figure or +%^^A table itself.) +% («Техника» работы ключа такова: |\abovecaptionskip| и~|\belowcaptionskip| +% меняются местами если задана опция |position=top|, поэтому в~обоих случаях +% |\abovecaptionskip| задаётся между подписью и~рисунком или таблицей.) +% +%^^A This option is especially useful when used together with the optional +%^^A argument of the |\captionsetup| command. +%^^A \See{\Section{misc}{Useful stuff} for details}\par +%^^A For example +% Этот ключ нужен когда используется вместе с~дополнительным аргументом +% команды |\captionsetup|. +% \See{\Section{misc}{Полезные утилиты}, чтобы узнать +% подробности.}\par Например, опция ключа +% \begin{quote} +% |\captionsetup[table]{position=top}| +% \end{quote} +%^^A causes all captions within tables to be treated as captions \emph{above} +%^^A the table (regarding spacing around it). +% говорит, что подписи в~плавающих таблицах помещаются \emph{сверху} +% (с~соответствующим отбивками). +% \DescribeMacro{tableposition=}\label{TeXr:captop:a}%^^A +% \NEWfeature{v3.0a} +%^^A Because this is a very common setting the \thispackage\ package offers +%^^A an abbreviating option for the use with |\usepackage|: +% Поскольку такая установка очень популярна, пакет \thispackage\ предлагает +% ключ"=аббревиатуру, для использования его в~строке |\usepackage|: +% \begin{quote} +%^^A% |\usepackage[|\ldots|,tableposition=top]{caption}|\footnote{Please +%^^A% note that this is \emph{not} sufficient when using a +%^^A% \KOMAScript\ document class, you need to use the \emph{global} +%^^A% option |tablecaptionabove|, too.} +% |\usepackage[|\ldots|,tableposition=top]{caption}|\footnote{Обратите внимание, +% что этот ключ \emph{не} достаточен, если используется класс +% \KOMAScript, вам понадобится также \emph{глобальная} +% опция |tablecaptionabove|.} +% \end{quote} +%^^A is equivalent to +% что эквивалентно +% \begin{quote} +% |\usepackage[|\ldots|]{caption}|\\ +% |\captionsetup[table]{position=top}| +% \end{quote}\label{TeXr:captionskip:z}%^^A +% \label{TeXr:captop:z} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% +%^^A \section{Useful stuff} +% \section{Полезные утилиты} +% \label{misc} +% +% \DescribeMacro{\caption} +%^^A The command +% Команда +% \nopagebreak[3] +% \begin{quote} +% |\caption|\oarg{lst\_entry}\marg{heading} +% \end{quote} +% \nopagebreak[3] +%^^A typesets the caption inside a floating environment like |figure| or |table|. +%^^A Well, you already know this, but the \thispackage\ package offers an extension: +%^^A If you leave the argument \meta{lst\_entry} empty, no entry in the list of +%^^A figures or tables will be made. For example: +% печатает подпись внутри окружения флота, типа |figure| или |table|. +% Так, это нам известно, но новость состоит в~том, что если +% задать аргумент \meta{lst\_entry} пустым, подпись в~списке рисунков или +% таблиц не появится; например, +% \begin{quote} +%^^A |\caption[]{A figure without entry in the list of figures.}| +% |\caption[]{Подпись без записи в списке рисунков.}| +% \label{TeXr:nolistentry:I} +% \end{quote} +% +% \DescribeMacro{\caption*}\label{TeXr:starcaption:a}%^^A +%^^A The \package{longtable} package defines the command |\caption*| which +%^^A typesets the caption without label and without entry in the list of tables. +%^^A An example: +% Пакет \package{longtable} определяет команду |\caption*| которая +% печатает подпись без метки и~занесения её в~список таблиц. +% Пример: +% \begin{quote} +% |\begin{longtable}{cc}|\\ +% | \caption*{Табличка}\\|\\ +% | A & B \\|\\ +% | C & D \\|\\ +% |\end{longtable}| +% \end{quote} +% выглядит следующим образом:\nopagebreak +% \begin{longtable}{cc} +% \caption*{Табличка}\\ +% A & B \\ +% C & D \\ +% \end{longtable} +% +%^^A This package offers this feature, too, so you can use this command now within +%^^A every floating environment like |figure| or |table|, like: +% Данный пакет тоже предлагает такую возможность. И~теперь вы можете использовать эту команду +% с~любым окружением плавающего объекта, например |figure| или |table|, как здесь: +% \begin{quote} +% |\begin{table}|\\ +% | \caption*{Табличка}|\\ +% | \begin{tabular}{cc}|\\ +% | A & B \\|\\ +% | C & D \\|\\ +% | \end{tabular}|\\ +% |\end{table}| +% \end{quote} +% +% \DescribeMacro{\captionof}%^^A +% \DescribeMacro{\captionof*}\label{TeXr:captiononof:a}%^^A +%^^A Sometimes you want to typeset a caption \emph{outside} a floating environment, +%^^A putting a figure within a |minipage| for instance. For this purpose the +%^^A \thispackage\ package offers the command +% Иногда вам нужно создать подпись \emph{вне} окружения флота, +% поместив, к~примеру, подпись внутри окружения |minipage|. Для этой цели пакет +% \thispackage\ предлагает команду +% \begin{quote} +% |\captionof|\marg{float type}\oarg{lst\_entry}\marg{heading}\quad. +% \end{quote} +%^^A Note that the first argument, the \meta{float type}, is mandatory here, because +%^^A the |\captionof| command needs to know which name to put into the caption label +%^^A (e.g. ``Figure'' or ``Table'') and in which list to put the contents entry. +%^^A An example: +% Обратите внимание, что первый аргумент, \meta{float type}, в~данном случае является +% обязательным, поскольку команда |\captionof| должна знать, к~какому плавающему +% объекту создать подпись (например. «Рис.» или «Таблица») и~в~какой список поместить +% подпись. Пример +% \begin{quote} +% |\captionof{figure}{Картинка}|\\ +% |\captionof{table}{Табличка}| +% \end{quote} +%^^A typesets captions like this: +% создаёт подписи как здесь: +% \begin{Example} +% \captionof{figure}{Картинка} +% \captionsetup{belowskip=\abovecaptionskip} +% \captionof{table}{Табличка} +% \end{Example} +% +%^^A The star variant |\captionof*| has the same behaviour as the |\caption*| command: +%^^A it typesets the caption without label and without entry to the list of figures +%^^A or tables. +% «Звёздный» вариант |\captionof*| даёт тот же результат, что и~|\caption*|: +% печатает подпись без нумерационного заголовка и~вывода в~список рисунков или +% таблиц. +% +%^^A Please use both |\captionof| and |\captionof*| only \emph{inside} environments +%^^A (like |minipage| or |\parbox|), otherwise a page break can appear between content +%^^A and caption. Furthermore some strange effects could occur (e.g., wrong spacing +%^^A around captions). +% Используйте обе команды, |\captionof| и~|\captionof*|, только в~окружениях +% (типа |minipage| или |\parbox|), иначе подпись может разорваться между страницами. +% Кроме этого могут возникнуть побочные эффекты (например, неверные отбивки +% вокруг подписи).\label{TeXr:captiononof:z}\label{TeXr:starcaption:z} +% +% \DescribeMacro{\ContinuedFloat}\label{TeXr:continued:a} +%^^A Sometimes you want to split figures or tables without giving them +%^^A their own reference number. This is what the command +% Иногда возникает необходимость разбить рисунки или таблицы на несколько +% частей, задав им общий номер. Для этого предназначена команда +% \begin{quote} +% |\ContinuedFloat|\quad. +% \end{quote} +%^^A is for; it should be used as first command inside the floating environment. +%^^A It prevents the increment of the relevant counter (usually done by |\caption|) +%^^A so a figure or table with a |\ContinuedFloat| in it gets the same reference +%^^A number as the figure or table before. +% Лучше её поставить первой внутри окружения флота. +% Команда |\ContinuedFloat| отменяет увеличение соответствующего счётчика флота +% (используемого командой |\caption|) +% и~задаёт тот же номер как и~у~рисунка или таблицы выше. +% +%^^A An example: +% Пример: +% \begin{quote} +% |\begin{table}|\\ +% |\caption{Табличка}|\\ +% \ldots\\ +% |\end{table}|\\ +% \ldots\\ +% |\begin{table}\ContinuedFloat|\\ +% |\caption{Табличка (продолжение)}|\\ +% \ldots\\ +% |\end{table}| +% \end{quote} +%^^A gives the following result: +% даст следующий результат: +% \begin{Example} +% \makeatletter\def\@captype{table}\makeatother +% \caption[]{Табличка} +% \centerline{\ldots} +% \ContinuedFloat +% \captionsetup{aboveskip=0pt} +% \caption[]{Табличка (продолжение)} +% \label{TeXr:continued:z} +% \end{Example} +% +% \DescribeMacro{\captionsetup} +%^^A We already know the |\captionsetup| command (see \Section{usage} +%^^A {Using the package}), but this time we get enlighten about +%^^A its optional argument \meta{float type}. +% Нам уже известна команда |\captionsetup| (см.~\Section{usage} +% {Использование пакета}), Но сейчас мы разберём значение +% дополнительного аргумента, \meta{float type}. +% +%^^A Remember, the syntax of this command is +% Напомним синтаксис этой команды +% \begin{quote} +% |\captionsetup|\oarg{float type}\marg{options}\quad. +% \end{quote} +% +%^^A If a \meta{float type} gets specified, all the \meta{options} don't +%^^A change anything at this time. Instead they only get marked for a later use, +%^^A when a caption inside of a floating environment of the particular type +%^^A \meta{float type} gets typeset. +%^^A For example +% Если \meta{float type} задан, все ключи и~опции, \meta{options} ничего +% не изменят в~месте задания. Они только определены для будущего использования, +% в~момент, когда подпись внутри окружения флота данного типа, +% \meta{float type}, будет напечатана. +% Например +% \begin{quote} +% |\captionsetup[figure]|\marg{options} +% \end{quote} +%^^A forces captions within a |figure| environment to use the given \meta{options}. +% определяет оформление \meta{options} для подписи внутри окружения |figure|. +% +%^^A Here comes an example to illustrate this: +% Далее идёт пример иллюстрирующий сказанное: +% \begin{quote} +% |\captionsetup{font=small}|\\ +% |\captionsetup[figure]{labelfont=bf}| +% \end{quote} +%^^A gives captions like this: +% создаст подписи вида: +% \begin{Example} +% \captionsetup{font=small} +% \captionsetup[figure]{labelfont=bf} +% \captionof{figure}[]{Картинка} +% \captionsetup{belowskip=\abovecaptionskip} +% \captionof{table}[]{Табличка} +% \end{Example} +% +%^^A As you see the command |\captionsetup[figure]{labelfont=bf}| only changed +%^^A the font of the figure caption labels, not touching all other ones. +% Как вы видите установка |\captionsetup[figure]{labelfont=bf}| изменяет +% только шрифт нумерационной части подписи, всё остальное остаётся. +% +% \DescribeMacro{\clearcaptionsetup} +%^^A If you want to get rid of these parameters marked for an automatic use within +%^^A a particular environment you can use the command +% Если вам внутри данного окружения нужно отменить параметры, заданные для +% текущего типа флота, используйте команду +% \begin{quote} +% |\clearcaptionsetup|\marg{float type}\quad. +% \end{quote} +% +%^^A For example |\clearcaptionsetup{figure}| would clear the extra handling in the +%^^A example above: +% Например |\clearcaptionsetup{figure}| отменит дополнительные настройки +% из примера выше: +% \begin{Example} +% \captionsetup{font=small} +% \captionof{figure}[]{Картика} +% \captionsetup{belowskip=\abovecaptionskip} +% \captionof{table}[]{Табличка} +% \end{Example} +% +%^^A As \meta{float type} you can usually give one of these two only: +%^^A |figure| or |table|. +%^^A But as we will see later some \LaTeX\ packages (like the +%^^A \package{float}, \package{longtable}, and \package{sidecap} package +%^^A for example) offer additional floating environments and these two +%^^A commands can also be used with them. +% В~качестве опции в~\meta{float type} вы можете обычно указывать два из них: +% |figure| или |table|. +% Но, как увидите позже, некоторые пакеты \LaTeX'а (как, например, +% \package{float}, \package{longtable}, и~\package{sidecap}) +% определяют дополнительные окружения и~эти две команды могут быть +% в~них использованы. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% +%^^A \section{Do it yourself!} +% \section{Делаем сами!} +% \label{declare} +% +%^^A A family of commands is provided to allow users to define their own formats. +%^^A This enables information on separators, justification, fonts, and styles to +%^^A be associated with a name and kept in one place +%^^A (these commands need to appear in the document preamble, +%^^A this is the part between |\documentclass| and |\begin{document}|). +% Имеется семейство команд, позволяющих пользователю самостоятельно +% создать собственное оформление. +% Это позволяет информацию о~разделителях, выключке, шрифтах, и~стилях +% привязать к~определённому ключу, и~поместить всё это в~одном месте +% (такие команды должны находиться в~преамбуле документа \cdash--- +% это часть между строками команд |\documentclass| и~|\begin{document}|). +% +% +% \DescribeMacro{\DeclareCaptionFormat} +%^^A 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} +%^^A At usage the system replaces \#1 with the caption label, \#2 with the +%^^A separator and \#3 with the text. So the standard format |plain| is +%^^A pre-defined by the \thispackage\ package as +% При использовании пакет заменяет \#1 на нумерационный заголовок, \#2 на +% разделитель и~\#3 на текст подписи. Итак, стандартный формат |plain| определён +% внутри пакета \thispackage\ как +% \begin{quote} +% |\DeclareCaptionFormat{plain}{#1#2#3\par}| +% \end{quote} +% +% \DescribeMacro{\DeclareCaptionLabelFormat} +%^^A Likewise you can define your own caption label formats: +% Аналогично вы можете определить формат нумерационного заголовка: +% \begin{quote} +% |\DeclareCaptionLabelFormat|\marg{name}\marg{code using \#1 and \#2} +% \end{quote} +%^^A At usage \#1 gets replaced with the name (e.g. ``figure'') and \#2 +%^^A gets replaced with the reference number (e.g. ``12''). +% При использовании \#1 заменяется на имя флота (например. «Рис.») и~\#2 +% заменяется на порядковый номер (например «12»). +% +% \DescribeMacro{\bothIfFirst} +% \DescribeMacro{\bothIfSecond} +%^^A If you define your own caption label formats and use the \package{subfig} +%^^A package\cite{subfig}, you should take care of empty caption label names. +%^^A For this purpose the commands +% Когда вы определяете своё оформление нумерационного заголовка и~используете +% также пакет \package{subfig}, вы должны помнить что в~подфлотах элемент +% «имя флота» будет пустым. Для этой цели следующие команды +% \begin{quote} +% |\bothIfFirst|\marg{first arg}\marg{second arg}\quad и\\ +% |\bothIfSecond|\marg{first arg}\marg{second arg} +% \end{quote} +%^^A are offered. |\bothIfFirst| tests if the first argument exists (means: is +%^^A not empty), |\bothIfSecond| tests if the second argument exists. If yes, +%^^A both arguments get typeset, otherwise none of them. +% и~предложены. Команда |\bothIfFirst| тестирует наличие первого аргумента (что он +% непустой), команда |\bothIfSecond| тестирует наличие второго. Если тестируемый +% аргумент есть, то печатаются оба аргумента, в~противном случае ни одного. +% +%^^A For example the standard label format |simple| is \emph{not} defined as +% Например, стандартное оформление нумерации |simple| определено не так: +% \begin{quote} +% |\DeclareCaptionLabelFormat{simple}{#1 #2}|\quad, +% \end{quote} +%^^A because this could cause an extra space if \#1 is empty. Instead |simple| +%^^A is defined as +% поскольку аргумент \#1 может быть пустым. Вместо этого |simple| +% определён следующим образом +% \begin{quote} +% |\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{ }#2}|\quad, +% \end{quote} +%^^A causing the space to appear only if the label name is present. +% в~результате пробел появится только тогда, когда есть имя нумерационного +% заголовка. +% +% +% \DescribeMacro{\DeclareCaptionLabelSeparator} +%^^A You can define your own caption label separators with +% Можно определить свой разделитель номера и~текста подписи с~помощью +% команды +% \begin{quote} +% |\DeclareCaptionLabelSeparator|\marg{name}\marg{code}\quad. +% \end{quote} +% \nopagebreak[3] +%^^A Again an easy example taken from the \thispackage\ package itself: +% И~опять простой пример из самого пакета \thispackage: +% \nopagebreak[3] +% \begin{quote} +% |\DeclareCaptionLabelSeparator{colon}{: }| +% \end{quote} +% +% +% \DescribeMacro{\DeclareCaptionJustification} +%^^A You can define your own caption justifications with +% Вы можете определить собственную выключку с~помощью команды +% \begin{quote} +% |\DeclareCaptionJustification|\marg{name}\marg{code}\quad. +% \end{quote} +%^^A The \meta{code} simply gets typeset just before the caption. +%^^A E.g.~using the justification |raggedright|, which is defined as +% Аргумент \meta{code} задаёт выключку до начала подписи. +% Например использование выключки |raggedright|, которая определена как +% \begin{quote} +% |\DeclareCaptionJustification{raggedright}{\raggedright}|\quad, +% \end{quote} +%^^A lets captions with all lines moved to the left margin. +% выключает все строки подписи к~левому полю. +% +% \DescribeMacro{\DeclareCaptionFont} +%^^A You can define your own caption fonts with +% Вы можете задать свой шрифт для подписи с~помощью +% \begin{quote} +% |\DeclareCaptionFont|\marg{name}\marg{code}\quad. +% \end{quote} +%^^A For example this package defines the options |small| and |bf| as +% Например данный пакет определяет опции |small| и~|bf| как +% \begin{quote} +% |\DeclareCaptionFont{small}{\small}|\quad и\\ +% |\DeclareCaptionFont{bf}{\bfseries}|\quad. +% \end{quote} +%^^A The line spacing could be customized using the \package{setspace} package, +%^^A for example:\NEWdescription{v3.0h} +% Интерлиньяж может быть настроен с~помощью пакета \package{setspace}, +% например:\NEWdescription{v3.0h} +% \begin{quote} +% |\usepackage{setspace}|\\ +% \iffalse +%^^A |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{% +%^^A \emph{Note:} Using \cs{singlespacing} does not work here since it contains +%^^A a \cs{vskip} command.}\\ +% |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{% +% \emph{Примечание:} Использование \cs{singlespacing} в данном случае +% не работает поскольку содержит команду \cs{vskip}.}\\ +% |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\ +% |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\ +% \fi +% |\captionsetup{font={onehalfspacing,small},labelfont=bf}| +% \end{quote} +% \example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}\figuretext +%^^A 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,textfont=green}| +% \end{quote} +% \example{labelfont=blue,textfont=green,singlelinecheck=off}\figuretext +% +% \DescribeMacro{\DeclareCaptionStyle} +%^^A You can define your own caption styles with +% Вы можете определить свои собственные стили с~помощью +% \begin{quote} +% |\DeclareCaptionStyle|\marg{name}\oarg{additional options}\marg{options} +% \end{quote} +%^^A Remember, caption styles are just a collection of suitable options, saved +%^^A under a given name. You can wake up these options at any time with the +%^^A option |style=|\meta{style name}. +% Вспомним, что стили подписи это коллекция ключей, сохранённых +% под данным именем. Вы можете привести их в~действие с~помощью ключа +% |style=|\meta{style name}. +% +%^^A All caption styles are based on the default set of options. (See \Section +%^^A {style}{Styles} for a complete list.) So you only need +%^^A to specify options which are different to them. +% Все стили подписей базируются на установках по умолчанию. (См. полный список +% в~\Section {style}{Стили}.) Поэтому достаточно определить опции, отличные +% от уже заданных. +% +%^^A If you specify \meta{additional options} they get used in addition when +%^^A the caption fits into a single line and this check was not disabled with +%^^A the option |singlelinecheck=off|. +% Если вы определите \meta{additional options} они будут использоваться когда +% подпись будет однострочной, и~контроль коротких подписей не отключен +% заданием опции |singlelinecheck=off|. +% +%^^A Again a very easy example taken from the core of this package: The +%^^A caption style |default| is pre-defined as +% Опять же очень простой пример из самого |caption.sty|: +% \begin{quote} +% |\DeclareCaptionStyle{default}[justification=centering]{}| +% \end{quote} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{Further Examples} +% \subsection{Ещё несколько примеров} +% +%^^A If you would like to have a colon \emph{and} a line break as caption +%^^A separator you could define it this way: +% Если вам нужно точка и новая строка как разделитель между номером и~текстом +% определите это так: +% \begin{quote} +% |\DeclareCaptionLabelSeparator{period-newline}{. \\}| +% \end{quote} +%^^A Selecting this separator with |\captionsetup{labelsep=period-newline}| you +%^^A get captions like this: +% Задав этот разделитель как |\captionsetup{labelsep=period-newline}| вы +% получите следующую подпись: +% \begin{Example} +% \captionsetup{labelsep=period-newline,labelfont=bf,margin=10pt} +% \captionsetup{aboveskip=0pt,type=figure} +% \caption[]{\figuretext} +% \end{Example} +% +%^^A For short captions---which fit into one single line---this separator +%^^A may not be satisfying, even when the automatically centering process +%^^A is switched off (with |singlelinecheck=off|): +% Для кратких подписей \cdash--- которые помещаются на одной строке \cdash--- такой +% разделитель не годится, даже если отменено автоматическое центрирование +% (с~помощью |singlelinecheck=off|): +% \begin{Example} +% \captionsetup{labelsep=period-newline,labelfont=bf,margin=10pt,singlelinecheck=0} +% \captionsetup{aboveskip=0pt,type=figure} +% \caption[]{Картинка.} +% \end{Example} +% +%^^A An own caption style which selects another caption separator automatically +%^^A puts this right: +% Специальный стиль, который определяет другой разделитель автоматически +% возвращает всё на места: +% \begin{quote} +% |\DeclareCaptionStyle{period-newline}%|\\ +% | [labelsep=period]{labelsep=period-newline}| +% \end{quote} +% \begin{Example} +% \captionsetup{style=period-newline,labelfont=bf,margin=10pt} +% \captionsetup{aboveskip=0pt,type=figure} +% \ContinuedFloat +% \caption[]{Картинка.} +% \end{Example} +%^^A If you would like to keep the centering of these captions instead, an +%^^A appropriate definition would be something like +% Если вы предпочтёте оставить центрирование короткой строки +% нужно определить +% \begin{quote} +% |\DeclareCaptionStyle{period-newline}%|\\ +% | [labelsep=period,justification=centering]%|\\ +% | {labelsep=period-newline}|\quad. +% \end{quote} +%^^A Using this definition short captions look like +% При этом определении короткие подписи будут выглядеть так +% \begin{Example} +% \captionsetup{style=period-newline2,labelfont=bf,margin=10pt} +% \captionsetup{aboveskip=0pt,type=figure} +% \ContinuedFloat +% \caption[]{Картинка.} +% \end{Example} +%^^A while long ones still have a line break after the caption label. +% в~то же время длинные подписи сохранят разрыв после номера флота. +% +%^^A Slightly changed, you also get centered captions if they are longer than +%^^A one line: +% Чуть изменив стиль, вы получите и~длинные подписи центрированными: +% \begin{quote} +% |\DeclareCaptionStyle{period-newline}%|\\ +% | [labelsep=period]%|\\ +% | {labelsep=period-newline,justification=centering}| +% \end{quote} +% \begin{Example} +% \captionsetup{style=period-newline3,labelfont=bf,margin=10pt} +% \captionsetup{aboveskip=0pt,type=figure} +% \caption[]{\figuretext} +% \end{Example} +% +% \bigskip +%^^A Another example: You want captions to look like this: +% Другой пример: вы хотите получить такие подписи: +% \begin{Example} +% \captionsetup{format=reverse,labelformat=fullparens,labelsep=fill,font=small,labelfont=it} +% \captionsetup{aboveskip=0pt} +% \captionof{figure}[]{\figuretext} +% \end{Example} +% \pagebreak[2] +%^^A 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}} +% +% \bigskip\pagebreak[3] +%^^A Another example: The caption text should go into the left margin; a possible +%^^A solution would be: +% Ещё пример: поместить нумерационный заголовок подписи на левом поле; возможное решение: +% {\leftmargini=10pt +% \begin{quote} +% |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\ +% |\captionsetup{format=llap,labelsep=quad,singlelinecheck=no}| +% \end{quote}} +%^^A As a result you would get captions like this: +% В~результате вы получите такую подпись: +% \begin{Example} +% \captionsetup{format=llap,singlelinecheck=no,labelsep=quad} +% \captionsetup{aboveskip=0pt} +% \captionof{figure}[]{\figuretext} +% \end{Example} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% \pagebreak[1] +%^^A \section{Using non-standard document classes} +% \section{Использование нестандартных классов документа} +% +% \NEWdescription{v3.0p} +%^^A% The \thispackage\ package was developed using the standard document classes +%^^A% |article|, |report| and |book|, it also works with the Dutch document classes +%^^A% |artikel|, |rapport| and |boek|. It is \emph{incompatible} with all other +%^^A% document classes, except the ones based on one of the above. +% Пакет \thispackage\nopagebreak\ настроен на использование со стандартными классами +% |article|, |report| и~|book|, он также работает с~классами для немецких публикаций +% |artikel|, |rapport| и~|boek|. +% +%^^A% If you are unsure if your document class is supported or not, it's better +%^^A% \emph{not} to use this package. You could try if your document will compile +%^^A% fine with the \thispackage\ package anyway, but you should watch carefully +%^^A% if side-effects occur, i.e. the look and feel of your captions should +%^^A% \emph{not} change if you just include the caption package without options. +%^^A% (If it does, you can carry on, but you should be warned that the output +%^^A% could change with upcoming versions of the \thispackage\ package.) +%^^A% If this is fine, you can start setting options with +%^^A% |\usepackage[|\ldots|]{caption}| or |\captionsetup| and keep your fingers +%^^A% crossed. +% Если вы не уверены поддерживается ли ваш класс документа или нет, +% лучше данный пакет не использовать. Вы в~любом случае можете попробовать +% обработать свой документ с~пакетом \thispackage, но в~этом случае внимательно +% проверьте, есть ли побочные эффекты, т.\,е. при подключённом без опций пакете +% и~без него вид подрисуночных подписей \emph{не} должен меняться. +% (Если это происходит, можете продолжить, но знайте, что следующие версии +% пакета \thispackage\ могут изменить вывод вашего документа.) +% Если всё прекрасно, можно теперь задать опции, используя +% |\usepackage[|\ldots|]{caption}| или |\captionsetup| и~надеяться на лучшее. +% +%^^A% The upcoming version \version{3.1} of the \thispackage\ package will be +%^^A% adapted to several document classes, e.g. the \package{beamer} class and +%^^A% the \KOMAScript\ ones. It's planned for release during Summer 2007. +% Следующая версия \version{3.1} пакета \thispackage\ будет работать с~такими классами, +% как \package{beamer} и~классы \KOMAScript. Выход версии планируется на лето 2007\,г. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \section{Compatibility to other packages} +% \section{Совместимость с другими пакетами} +% \label{packages} +% +%^^A The \thispackage\ package contains special adaptations to other packages, +%^^A so the captions should always look like you have specified them to look like. +% Пакет \thispackage\ содержит специальные адаптации с~другими пакетами, +% также работающими с~подписями, поэтому подписи \emph{всегда} выглядят так, +% как вы определили им настройки. +% +%^^A These are the packages the \thispackage\ package is adapted to: +% Здесь приведены пакеты, которые адаптированы на совместное использование +% с~\thispackage: +% +%^^A \begin{tabular}{ll} +%^^A |float| & Gives you the possibility to define new floating environments\\ +%^^A |listings| & Typesets source code listings\\ +%^^A |longtable| & Typesets tables spanned over multiple pages\\ +%^^A |rotating| & Supports rotated figures and tables\\ +%^^A |sidecap| & Offers captions \emph{beside} figures or tables\\ +%^^A |supertabular| & Typesets tables spanned over multiple pages\\ +%^^A \end{tabular} +% \begin{tabular}{ll} +% |float| & Даёт возможность определить новое окружение флота \\ +% |listings| & Печатает исходные тексты программ\\ +% |longtable| & Печатает многостраничные таблицы\\ +% |rotating| & Поддерживает поворот рисунков и таблиц\\ +% |sidecap| & Предлагает окружения с подписями сбоку\\ +% |supertabular| & Печатает многостраничные таблицы [альтернатива |longtable|]\\ +% \end{tabular} +% +% \NEWfeature{v3.0b} +%^^A If you use one of the above packages together with the {\thispackage} package +%^^A you get the additional possibility to set up captions with +% Если вы используете один из этих пакетов вместе с~пакетом {\thispackage} +% вы получаете дополнительные возможности для настроек оформления с~помощью +% \begin{quote}|\captionsetup|\oarg{environment}\marg{options}\quad,\end{quote} +%^^A where \meta{environment} stands for any environment the above packages offer. +%^^A (Please note that this do not work with the |sideways| environments offered by +%^^A the \package{rotating} package.) +%^^A For example +% где \meta{environment} определяет окружения, заданные упомянутыми выше пакетами. +% (Обратите внимание, что это не работает с~окружениями |sideways...| пакета +% \package{rotating}.) +% Например +% \begin{quote}|\captionsetup[lstlisting]{labelfont=bf}|\end{quote} +%^^A forces captions inside the |lstlisting| environment to have bold labels. +% Задаёт подписям внутри окружения |lstlisting| полужирные нумерационные части. +% +%^^A If a certain support is not desired you can switch it off using the +%^^A \thispackage\ package option +% Если такая поддержка нежелательна вы можете задать соответствующую опцию +% пакета \thispackage +% \begin{quote} +% |\usepackage[|\ldots|,|\meta{package}|=no]{caption}|\quad. +% \end{quote} +%^^A For example specifying the option |float=no| means you don't like the +%^^A \thispackage\ package to support the \package{float} package. +%^^A (Note: You can specify these options only within the |\usepackage| command, +%^^A especially \emph{not} at a later time with |\captionsetup|.) +% Например, задание опции |float=no| означает, что вы не хотите, чтобы пакет +% \thispackage\ поддерживал пакет \package{float}. (Примечание: +% вы можете определить эти опции только в~строке команды |\usepackage|, +% тем более \emph{не} в~командах |\captionsetup|.) +% +%^^A For further information about the packages mentioned above please take a look +%^^A at the documentation belonging to them or buy yourself +%^^A The \LaTeX\ Companion\cite{companion}. +% Для подробной информации о~пакетах, которые поддерживаются см. документацию +% этих пакетов или в~книге The \LaTeX\ Companion\cite{companion}. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{The \package{float} package} +% \subsection{Пакет \package{float}} +% \label{float} +% +%^^A A very useful feature is provided by the \package{float} package\cite{float}: +%^^A It offers the float placement specifier |H| which is much more restrictive +%^^A than the specifier |h| offered by \LaTeX. While the latter one is only a +%^^A recommendation to \LaTeX\ to set the float ``here'', the |H| forces the +%^^A float to appear exactly at the spot where it occurs in your input file +%^^A and nowhere else. +% Очень полезные настройки предлагаются пакетом \package{float}\cite{float}. +% Пакет предлагает специальную опцию размещения флота |H| которая жёстче, по +% сравнению с~опцией |h| стандартного \LaTeX'а. Если стандартная опция только +% «рекомендует» \LaTeX'у~поместить флот «здесь», опция |H| помещает +% флот точно в~том месте где он записан и~нигде больше [При этой +% опции флот реально встаёт на якорь! \cdash--- \emph{Прим. перев}]. +% +%^^A Furthermore it offers different styles for floating environments, these +%^^A styles are |plain|, |plaintop|, |ruled|, and |boxed|. +%^^A You can link one of these styles to either new floating environments or +%^^A to one of the existing environments |figure| and |table|. +% Помимо этого пакет предлагает различные стили для окружений флотов, это стили +% |plain|, |plaintop|, |ruled|, и~|boxed|. +% Вы можете задать один из этих стилей как для новых окружений флотов, так +% и~для уже существующих |figure| и~|table|. +% +%^^A If you are using the \thispackage\ package together with the \package{float} +%^^A package a caption style called |ruled| gets defined automatically: +% Если вы используете пакет \thispackage\ вместе с~пакетом \package{float} +% стиль подписи |ruled| будет определён автоматически: +% \begin{quote} +% |\DeclareCaptionStyle{ruled}{labelfont=bf,labelsep=space}| +% \end{quote} +%^^A This style represents the caption layout in |ruled| styled floats. +%^^A For you as an end user this means that captions within |ruled| floats will +%^^A always look like this, nevertheless what generic caption options do you +%^^A specify: +% Этот стиль предлагает стиль подписей в~стиле флотов |ruled|. +% Для вас как пользователя это значит, что подписи внутри |ruled| флотов будут +% всегда выглядеть так, если только не переопределены заданные опции пакета: +% +% \ifx\floatstyle\undefined +% +% \begin{Example} +% \hrule height.8pt depth0pt \kern2pt +% \vbox{\strut{\bfseries Program 7.1} +% The first program. This hasn't got anything to do with the package +% but is included as an example. Note the \texttt{ruled} float style.} +% \kern2pt\hrule\kern2pt +% \begin{verbatim} +% #include <stdio.h> +% +% int main(int argc, char **argv) +% { +% for (int i = 0; i < argc; ++i) +% printf("argv[%d] = %s\n", i, argv[i]); +% return 0; +% } +% \end{verbatim} +% \kern2pt\hrule\relax +% \end{Example} +% +% \else +% +% \floatstyle{ruled} +% \newfloat{Program}{tbp}{lop}[section] +% \floatname{Program}{Program} +% +% \begin{Program}[H] +% \begin{verbatim} +% #include <stdio.h> +% +% int main(int argc, char **argv) +% { +% for (int i = 0; i < argc; ++i) +% printf("argv[%d] = %s\n", i, argv[i]); +% return 0; +% } +% \end{verbatim} +% \caption{The first program. This hasn't got anything to do with the package +% but is included as an example. Note the \texttt{ruled} float style.} +% \end{Program} +% +% \fi +% +%^^A If you want a different layout for |ruled| captions you have to define +%^^A your own one using the command +% Если вы желаете другое оформление для |ruled| подписей нужно +% задать свои установки, используя команду +% \begin{quote} +% |\DeclareCaptionStyle{ruled}|\marg{options}\quad. +% \end{quote} +% +%^^A This mechanism also works with all other float styles. If you want a special +%^^A caption layout---for |plain| or |boxed| floats for example---you can simply define +%^^A a suitable caption style with the same name as the float style. +% Этот механизм действует и~на другие стили флотов. Если вам нужно специальное +% оформление подписи для стиля |plain| или |boxed|, вы просто +% определяете соответствующий стиль с~тем же названием. +% +%^^A \textbf{Note:} For successful cooperation you need the float package +%^^A version 1.3 or newer. +% \textbf{Примечание:} Для успешной кооперации вам нужна версия пакета +% под номером 1.3 или выше. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% \pagebreak[3] +%^^A \subsection{The \package{listings} package} +% \subsection{Пакет \package{listings}} +% \label{listings} +% +% \NEWdescription{v3.0b} +%^^A The \package{listings} package\cite{listings} is a source code printer for \LaTeX. +%^^A You can typeset stand alone files as well as listings with an environment +%^^A similar to \texttt{verbatim} as well as you can print code snippets using +%^^A a command similar to |\verb|. +%^^A Many parameters control the output and if your preferred programming +%^^A language isn't already supported, you can make your own definition. +% Пакет \package{listings} \cite{listings} предназначен для печати исходного +% кода в~\LaTeX'е. Вы можете печатать отдельные файлы в~окружении, аналогичном +% окружению \texttt{verbatim} или фрагменты кода так же как при использовании +% команды |\verb|. +% Множество параметров контролируют вывод кода и~если вам нужно оформить +% язык, который ещё не имеет поддержки, вы можете задать свои определения. +% +%^^A \textbf{Note:} For successful cooperation you need the listings package +%^^A version 1.2 or higher. You'll get an error message when using an +%^^A older version! +% \textbf{Примечание:} для успешной кооперации вам нужен пакет +% версии не ниже 1.2. Иначе вы получите сообщение об ошибке! +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{The \package{longtable} package} +% \subsection{Пакет \package{longtable}} +% \label{longtable} +% +%^^A The \package{longtable} package\cite{longtable} offers the environment +%^^A |longtable| which behaves similar to the |tabular| environment, but +%^^A the table itself can span multiple pages. +% Пакет \package{longtable} \cite{longtable} предлагает окружение +% |longtable| которое, аналогично окружение |tabular|, создаёт табличный +% материал, но он может разместиться на нескольких полосах. +% +%^^A \textbf{Note:} For successful cooperation you need the longtable package +%^^A version 3.15 or newer. +% \textbf{Примечание:} Для успешной кооперации используйте версию +% 3.15 или выше. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{The \package{rotating} package} +% \subsection{Пакет \package{rotating}} +% \label{rotating} +% +%^^A The \package{rotating} package\cite{rotating} offers the floating +%^^A environments \texttt{sideways\-figure} and \texttt{sideways\-table} +%^^A which are just like normal figures and tables but rotated by 90 degree. +%^^A Furthermore they always use a full page on their own. +% Пакет \package{rotating} \cite{rotating} предлагает окружения +% \texttt{sideways\-figure} и~\texttt{sideways\-table} +% которые, аналогичны обычным рисункам и~таблицам, но повёрнуты на 90 градусов. +% Эти окружения всегда занимают полную полосу. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{The \package{sidecap} package} +% \subsection{Пакет \package{sidecap}} +% \label{sidecap} +% +% \NEWdescription{v3.0b} +%^^A The \package{sidecap} package\cite{sidecap} offers the floating +%^^A environments |SCfigure| and |SCtable| which are like normal figures +%^^A and tables but the caption will be put \emph{beside} the contents. +% Пакет \package{sidecap}\cite{sidecap} предлагает окружения флотов +% |SCfigure| и~|SCtable|, которые аналогичны обычным рисункам и~таблицам +% но подпись помещается \emph{сбоку}. +% +%^^A The \package{sidecap} package offers it's own options for justification. +%^^A If set, they will override the one specified with the caption option +%^^A |justification=| for captions beside their contents. +% Пакет \package{sidecap} предлагает свои опции выключки. +% Если они заданы, они перекрывают заданные опции в~ключе +% |justification=|. +% +% \DescribeMacro{listof=}\label{TeXr:nolistentry:II} +%^^A Using the \package{sidecap} package you will probably notice that +%^^A suppressing the entry in the list of figures or tables with +%^^A |\caption[]{|\ldots|}| won't work inside these environments. +%^^A This is caused by the implementation design of the \package{sidecap} +%^^A package, but you can use |\captionsetup{listof=false}| inside the +%^^A figure or table as an alternative here. +% Используя пакет the \package{sidecap} вы возможно заметите, что +% отмена вывода в~список подписи с~помощью кода +% |\caption[]{|\ldots|}| не работает в~этих окружениях. +% Это связано с~настройками пакета \package{sidecap}, +% но можно использовать для этого ключ |\captionsetup{listof=false}| внутри +% нужной фигуры или таблицы. +% +% \ifx\SCfigure\undefined +% +% \begin{Example} +% \newsavebox\scbox +% \begin{lrbox}{\scbox} +% \setlength{\unitlength}{.75cm} +% \setlength{\fboxsep}{0pt} +% \fbox{\begin{picture}(4,4) +% \put(1,3){\circle{1}} +% \put(3,3){\circle{1}} +% \put(2,2){\circle{1}} +% \put(1,1){\circle{1}} +% \put(3,1){\circle{1}} +% \end{picture}} +% \end{lrbox} +% \newlength\scboxwidth +% \setlength\scboxwidth{\wd\scbox} +% \makebox[\linewidth][c]{ +% \parbox[b]{\scboxwidth}{\unhbox\scbox} +% \hspace\marginparsep +% \parbox[b]{1.5\scboxwidth}{ +% \captionsetup{justification=raggedright,labelfont=bf} +% \captionof{figure}[]{Небольшой пример с~подписью сбоку.} +% } +% } +% \end{Example} +% +% \else +% +% \captionsetup{labelfont=bf} +% \begin{SCfigure}[1.5][!ht] +% \setlength{\unitlength}{.75cm} +% \setlength{\fboxsep}{0pt} +% \fbox{\begin{picture}(4,4) +% \put(1,3){\circle{1}} +% \put(3,3){\circle{1}} +% \put(2,2){\circle{1}} +% \put(1,1){\circle{1}} +% \put(3,1){\circle{1}} +% \end{picture}} +% \iffalse +% \captionsetup{labelfont=bf} +% \fi +% \caption[]{A small example with the caption beside the figure.} +% \end{SCfigure} +% \captionsetup{labelfont=default} +% +% \fi +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \subsection{The \package{supertabular} package} +% \subsection{Пакет \package{supertabular}} +% \label{supertabular} +% +%^^A The \package{supertabular} package\cite{supertabular} offers the environment +%^^A |supertabular| which is quite similar to the |longtable| environment provided +%^^A by the \package{longtable} package. Both offers the typesetting of tables +%^^A which can span multiple pages. For a detailed discussion about the +%^^A differences between these powerful packages please take a look at +%^^A The \LaTeX\ Companion\cite{companion}. +% Пакет \package{supertabular}\cite{supertabular} предлагает окружение +% |supertabular| которое аналогично |longtable| из пакета +% \package{longtable}. Оба они предлагают создание таблиц на несколько +% страниц. Детальный разбор различий этих пакетов +% приведён в~The \LaTeX\ Companion\cite{companion}. +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%\begingroup\samepage +%^^A \subsection{Known incompatibilities} +% \subsection{Известные несовместимости} +% +% \NEWdescription{v3.0b} +%^^A Using the \thispackage\ package together with one of the following packages +%^^A is not recommended; usually this would cause unwanted side effects or even +%^^A errors +%^^A\footnote{This translation could be obsolete, please check German or English +%^^A version for new information.}: +% Использование пакета \thispackage\ вместе с~одним из следующих пакетов +% не рекомендуется; обычно это даёт неожиданные побочные эффекты или даже +% ошибки\footnote{Данные перевода этого раздела могут содержать устаревшие данные. +% Обращайтесь к~английской или немецкой документации за более свежей информацией. \cdash--- +% \emph{Прим. перев.}}: +% \begin{quote} +% \package{captcont}, \package{ccaption}, \package{ftcapt}, (\package{hvfloat}), +% \package{multicap}, \package{topcapt}, \package{nonfloat} +% \end{quote} +%\endgroup +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \section{Compatibility to older versions} +% \section{Совместимость со старыми версиями} +% \label{compatibility} +% +%^^A \subsection{The \thispackage\ package version $1.x$} +% \subsection{Пакет \thispackage\ версии $1.x$} +% +%^^A This version of the \thispackage\ package still supports the old options +%^^A and commands provided by the version $1.x$ of this package. So there +%^^A shouldn't occur any problems compiling old documents, but please don't mix +%^^A old options and commands with the new ones. This isn't supported and can +%^^A cause ugly side effects. +% Эта версия пакета \thispackage\ поддерживает старые опции и~команды +% созданные в~версиях $1.x$ этого пакета. Поэтому не должно возникать +% проблем в~компиляции старых документов, но, пожалуйста, не смешивайте +% старые опции и~команды с~новыми. Это не поддерживается +% и~может дать неприятные побочные эффекты. +% +%^^A Here comes a short oversight of the obsolete options and commands and how +%^^A they have been replaced within this version of the \thispackage\ package: +% Здесь дан краткий обзор устаревших опций и~команд и~чем +% они заменены в~современной версии пакета \thispackage: +% +% {\small\begin{longtable}{ll} +% \thispackage\ \version{1.x} & \thispackage\ \version{3.x}\\ +% \hline +% \endhead +% |normal| & |format=plain|\\ +% |hang| & |format=hang|\\ +% |isu| & |format=hang|\\ +% |center| & |justification=centering|\\ +% |centerlast| & |justification=centerlast|\\ +% \iffalse +% |anne| & |justification=centerlast|\\ +% \fi +% |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}} +% +%^^A Beside the options for setting up the desired font there were also +%^^A the commands |\captionsize| resp.~|\captionfont| and |\captionlabelfont| +%^^A who could be redefined with |\renewcommand| and allowed an alternate and +%^^A more flexible way to change the font used for captions. +%^^A This mechanism was replaced by the commands +% Помимо опций для настроек нужного шрифта были также команды +% |\captionsize|, а~также |\captionfont| и~|\captionlabelfont| +% которые могли быть переопределены с~помощью |\renewcommand| и~позволяли +% альтернативный и~более гибкий способ изменить шрифт подписей. +% Данный механизм заменён на команды +% \begin{quote} +% |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad и\\ +% |\captionsetup{font=|\ldots|,labelfont=|\ldots|}|\qquad. +% \end{quote}\SeeUserDefined +% +%^^A Setting the margin for captions was done in \version{1.x} with +% Установки полей в~версии \version{1.x} задавались с~помощью +% \begin{quote} +% |\setlength{\captionmargin}{|\ldots|}|\quad. +% \end{quote} +%^^A This was replaced by +% Это заменено на +% \begin{quote} +% |\captionsetup{margin=|\ldots|}|\qquad. +% \end{quote} +%^^A \See{\Section{margins}{Margins and further paragraph options}} +% \See{\Section{margins}{Поля и другие опции формирования абзаца}} +% +%^^A For example the old-style code +% Например, старый код +% \begin{quote} +% |\usepackage[hang,bf]{caption}|\\ +% |\renewcommand\captionfont{\small\sffamily}|\\ +% |\setlength\captionmargin{10pt}| +% \end{quote} +%^^A 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} +%^^A or +% или +% \begin{quote} +% |\usepackage{caption}|\\ +% |\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\ +% | margin=10pt}|\qquad. +% \end{quote} +% +%^^A The quite exotic option |ruled| which allowed a partial usage of +%^^A the caption settings for |ruled| floats defined with the +%^^A \package{float} package will be emulated by this version of the +%^^A caption package, too. +%^^A But using this option is not recommended anymore since this +%^^A version of the \thispackage\ package offers a more flexible way +%^^A for changing the captions of these floating environments: +% Такая экзотическая опция |ruled| которая позволяла частично использовать +% настройки подписи для флотов с~оформлением |ruled| из пакета +% \package{float} эмулируется и~данным пакетом тоже. +% Но использование этой опции не рекомендуется, поскольку данная версия пакета +% \thispackage\ предлагает более гибкий способ для изменения подписей +% таких окружений плавающих флотов: +% \begin{quote} +% |\DeclareCaptionStyle{ruled}{|\ldots|}| +% \end{quote} +%^^A resp. +% и, соответственно +% \begin{quote} +% |\captionsetup[ruled]{|\ldots|}|\qquad. +% \end{quote} +% \SeeUserDefined[, \Section*{misc}{Полезные утилиты} и +% \Section*{float}{Пакет \package{float}}] +% +%^^A \subsection{The \package{caption2} package version $2.x$} +% \subsection{Пакет \package{caption2} версии $2.x$} +% +%^^A Although they do very similar stuff, the packages \package{caption} and +%^^A its experimental and now obsolete variant \package{caption2} have a +%^^A very different implementation design. +%^^A Therefore a full compatibility could not be offered. +%^^A For that reason you will still find a file called |caption2.sty| in +%^^A this package distribution, so old documents using the \package{caption2} +%^^A package will still compile fine. +% Хотя используются одни и~те же настройки и~в~пакете \package{caption} +% и~в~экспериментальной, но сейчас устаревшей версии"=пакете +% \package{caption2}, у~этих пакетов совершенно разный механизм их задания. +% Поэтому полная совместимость невозможна. +% По этой причине до сих пор существует пакет |caption2.sty| в~данном +% дистрибутиве, и~старые документы, использующие пакет \package{caption2} +% будут компилироваться. +% +%^^A Newly created documents should use the actual version of the +%^^A \thispackage\ package instead. In most cases it's sufficient to replace +%^^A the command +% Новые документы должны использовать современные версии пакета +% \thispackage. В~большинстве случаев можно заменить строку +% \begin{quote} +% |\usepackage[...]{caption2}| +% \end{quote} +%^^A by +% на +% \begin{quote} +% |\usepackage[...]{caption}|\qquad. +% \end{quote} +%^^A But some options and commands will not be emulated, so you can get +%^^A error messages afterwards. This section will hopefully help you removing +%^^A these errors. If you have problems migrating from \package{caption2} +%^^A to \package{caption} please don't hesitate to send me an e-mail asking +%^^A for help. +% Но некоторые опции и~команды не эмулируются, и~вы можете +% получить сообщения об ошибках. Данный раздел поможет вам ликвидировать +% такие ошибки. Если у~вас проблемы по замене пакета \package{caption2} +% на \package{caption} не раздумывайте и~отправляйте мне e-mail. +% +%^^A In addition to the obsolete options shown in the last section +%^^A these ones will be emulated, too: +% Помимо устаревших опций из предыдущего раздела +% следующие также эмулируются: +% +% {\small\begin{longtable}{ll} +% \package{caption2} \version{2.x} & \thispackage\ \version{3.x}\\ +% \hline +% \endhead +% |flushleft| & |justification=raggedright|\\ +% |flushright| & |justification=raggedleft|\\ +% |oneline| & |singlelinecheck=on|\\ +% \end{longtable}} +% +%^^A Setting the margin for captions was done in \version{2.x} with +% Задание втяжек (полей) для подписей, созданных в~\version{2.x} +% \begin{quote}\leavevmode\hbox{% +% |\setcaptionmargin{|\ldots|}| resp. +% |\setcaptionwidth{|\ldots|}|\quad. +% }\end{quote} +%^^A This was replaced by +% Они могут быть заменены на +% \begin{quote}\leavevmode\hbox{% +% |\captionsetup{margin=|\ldots|}| resp. +% |\captionsetup{width=|\ldots|}|\quad. +% }\end{quote} +%^^A \See{\Section{margins}{Margins and further paragraph options}} +% \See{\Section{margins}{Поля и другие опции формирования абзаца}} +% +%^^A Setting an indention was done in \version{2.x} with +% Задание втяжки в~версии \version{2.x} задавалось как +% \begin{quote} +% |\captionstyle{indent}|\\ +% |\setlength\captionindent{|\ldots|}|\quad. +% \end{quote} +%^^A This is now done with +% Сейчас это задаётся в~виде +% \begin{quote} +% |\captionsetup{format=plain,indention=|\ldots|}|\quad. +% \end{quote} +% +%^^A The so-called single-line-check was controlled by the commands +%^^A |\oneline|\-|captions|\-|false| (for switching the check off) and +%^^A |\oneline|\-|captions|\-|true| (for switching the check on). +%^^A This was replaced by +% Контроль короткой подписи контролируется командами +% |\oneline|\-|captions|\-|false| (отключает контроль) +% и~|\oneline|\-|captions|\-|true| (для включения контроля). +% Это заменено +% |\captionsetup{|\discretionary{}{}{}|singlelinecheck=|\discretionary{}{}{}|off}| +%^^A resp. +% и, соответственно +% |\captionsetup{|\discretionary{}{}{}|singlelinecheck=|\discretionary{}{}{}|on}|. +% \See{\Section{justification}{Выключка}} +% +%^^A The commands +% Команды +% \begin{quote} +% |\captionlabeldelim|, |\captionlabelsep|, |\captionstyle|,\\ +% |\defcaptionstyle|, |\newcaptionstyle|, and |\renewcaptionstyle| +% \end{quote} +%^^A do not have a simple replacement and therefore will not be emulated +%^^A by this version of the \thispackage\ package. (So using them will +%^^A cause error messages.) Rewriting such code is not always easy and +%^^A straight-ahead, but by conscientious reading of this manual you should +%^^A find appropriate options and commands instead. +% не имеют простой замены поэтому не эмулируются +% данной версией пакета \thispackage. (Их использование вызовет +% сообщение об ошибке.) Замена этого кода не всегда проста, +% но добросовестно прочитав данное руководство, вы найдёте +% подходящие опции и~команды замены. +% +% \iffalse +% ... (some examples) +% \fi +% +%^^A The \version{2.x} option |ignoreLTcapwidth| do not have a replacement, too. +%^^A But in most cases you can simply drop using that option because +%^^A in this version of the \thispackage\ package the value of |\LTcapwidth| +%^^A will be ignored anyway (unless you set it to a different value than the +%^^A default one). +%^^A \See{\Section{longtable}{The \package{longtable} package}} +% Опция версии \version{2.x} |ignoreLTcapwidth| тоже не имеет замены. +% Но в~большинстве случаев эту опцию можно опустить, потому что в~данной +% версии пакета \thispackage\ значение |\LTcapwidth| +% будет игнорировать в~любом случае (если только вы не зададите значение, +% отличное от заданного по умолчанию). +% \See{\Section{longtable}{Пакет \package{longtable}}} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +% \pagebreak[3] +%^^A \section{Further reading} +% \section{Рекомендуемая литература} +% +%^^A I recommend the following documents for further reading: +% Я рекомендую следующие документы для дальнейшего чтения: +% \begin{itemize} +% \def\tempa{ftm}\ifx\rmdefault\tempa +% \fontencoding{T1}\fontfamily{ptm}\selectfont\fi +% \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 +% \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://ftp.ctan.org/pub/tex/info/epslatex/}\end{quote} +% \end{itemize} +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% +%^^A \section{Thanks} +% \section{Благоданости} +% +%\begingroup +% \fontencoding{T1}\fontfamily{ptm}\selectfont +% I would like to thank Katja Melzner, +% Steven D. Cochran, Frank Mittelbach, +% David Carlisle, Carsten Heinz, Olga Lapko, 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, +% and +% Prof.~Dr.~Dirk Hoffmann, +% who all helped to make this package a better one. +% +%\endgroup +% +% \iffalse +% --------------------------------------------------------------------------- % +% \fi +% \StopEventually{\begin{thebibliography}{9} +% \fontencoding{T1}\fontfamily{ptm}\selectfont +% \bibitem{companion} +% Frank Mittelbach and Michel Goossens: +% \newblock {\em The {\LaTeX} Companion (2nd.~Ed.)}, +% \newblock Addison-Wesley, 2004. +% +% \bibitem{float} +% Anselm Lingnau: +% \emph{An Improved Environment for Floats}, +% 2001/11/08 +% +% \bibitem{floatrow} +% Olga Lapko: +% \emph{The floatrow package documentation}, +% 2005/05/22 +% +% \bibitem{hyperref} +% Sebastian Rahtz \& Heiko Oberdiek: +% \emph{Hypertext marks in \LaTeX}, +% 2007/01/25 +% +% \bibitem{hypcap} +% Heiko Oberdiek: +% \emph{The hypcap package -- Adjusting anchors of captions} +% 2001/08/27 +% +% \bibitem{listings} +% Carsten Heinz: +% \emph{The Listings Package}, +% 2004/02/13 +% +% \bibitem{longtable} +% David Carlisle: +% \emph{The longtable package}, +% 2000/10/22 +% +% \bibitem{rotating} +% Sebastian Rahtz and Leonor Barroca: +% \emph{A style option for rotated objects in \LaTeX}, +% 1997/09/26 +% +% \bibitem{sidecap} +% Rolf Niepraschk und Hubert G\"a\ss lein: +% \emph{The sidecap package}, +% 2003/06/06 +% +% \bibitem{subfig} +% Steven D. Cochran: +% \emph{The subfig package}, +% 2005/07/05 +% +% \bibitem{supertabular} +% Johannes Braams und Theo Jurriens: +% \emph{The supertabular environment}, +% 2002/07/19 +% +% \bibitem{Anne} +% Anne Br\"uggemann-Klein: +% \emph{Einf\"uhrung in die Dokumentverarbeitung}, +% B.G. Teubner, Stuttgart, 1989 +% \end{thebibliography}} +% +% \Finale +% +\endinput diff --git a/Master/texmf-dist/doc/latex/caption/caption.pdf b/Master/texmf-dist/doc/latex/caption/caption.pdf Binary files differindex ba899d3fc9a..3977586333f 100644 --- a/Master/texmf-dist/doc/latex/caption/caption.pdf +++ b/Master/texmf-dist/doc/latex/caption/caption.pdf diff --git a/Master/texmf-dist/doc/latex/caption/caption2.pdf b/Master/texmf-dist/doc/latex/caption/caption2.pdf Binary files differindex 18d202beb92..a5f59885e63 100644 --- a/Master/texmf-dist/doc/latex/caption/caption2.pdf +++ b/Master/texmf-dist/doc/latex/caption/caption2.pdf diff --git a/Master/texmf-dist/doc/latex/caption/ltcaption.pdf b/Master/texmf-dist/doc/latex/caption/ltcaption.pdf Binary files differnew file mode 100644 index 00000000000..a3bdde8d319 --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/ltcaption.pdf diff --git a/Master/texmf-dist/doc/latex/caption/manual.tex b/Master/texmf-dist/doc/latex/caption/manual.tex deleted file mode 100644 index fcf3be9b2c9..00000000000 --- a/Master/texmf-dist/doc/latex/caption/manual.tex +++ /dev/null @@ -1,69 +0,0 @@ -%% -%% This is file `manual.tex', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% caption.dtx (with options: `driver') -%% -%% 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 anleitung.tex and the derived files -%% caption.sty, caption2.sty, caption3.sty, and manual.tex. -%% -\NeedsTeXFormat{LaTeX2e}[1994/12/01] -\documentclass{ltxdoc} -\setlength\parindent{0pt} -\setlength\parskip{\smallskipamount} -\newcommand\NEWfeature{\NEW{New feature}} -\newcommand\NEWdescription{\NEW{New description}} -\newcommand\NEW[2]{\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} -\font\manual=manfnt -\newcommand\DANGER{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{\manual\char127}}}} -\ifx\pdfoutput\undefined\else - \ifcase\pdfoutput\else - \usepackage{mathptmx,courier} - \usepackage[scaled=0.90]{helvet} - \addtolength\marginparwidth{15pt} - \fi -\fi -\usepackage{color,setspace} -\usepackage{longtable} -\usepackage{caption}[2005/08/24] -\DeclareCaptionLabelSeparator{endash}{\space\textendash\space} -\usepackage{hyperref} -\DeclareCaptionFont{red}{\color{red}} -\DeclareCaptionFont{green}{\color{green}} -\DeclareCaptionFont{blue}{\color{blue}} -\DeclareCaptionLabelSeparator{period-newline}{. \\} -\DeclareCaptionStyle{period-newline}[labelsep=period]{labelsep=period-newline} -\DeclareCaptionStyle{period-newline2}[labelsep=period,justification=centering]{labelsep=period-newline} -\DeclareCaptionStyle{period-newline3}[labelsep=period]{labelsep=period-newline,justification=centering} -\DeclareCaptionFormat{reverse}{#3#2#1} -\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par} -\DeclareCaptionLabelFormat{fullparens}{(\bothIfFirst{#1}{ }#2)} -\DeclareCaptionLabelSeparator{fill}{\hfill} -\DeclareRobustCommand{\KOMAScript}{\textsf{K\kern.05em O\kern.05em% - M\kern.05em A\kern.1em-\kern.1em Script}} -\OnlyDescription -\begin{document} - \DocInput{caption.dtx} -\end{document} -\endinput -%% -%% End of file `manual.tex'. |