diff options
15 files changed, 1407 insertions, 1392 deletions
diff --git a/Master/texmf-dist/doc/latex/caption/README b/Master/texmf-dist/doc/latex/caption/README index b9bf2a9e799..96aceb06fad 100644 --- a/Master/texmf-dist/doc/latex/caption/README +++ b/Master/texmf-dist/doc/latex/caption/README @@ -7,8 +7,8 @@ License: LPPL = LaTeX Project Public Licence Maintenance Status: maintained (by Axel Sommerfeldt) If you need help for installation please visit: -http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instpackages -http://www.tex.ac.uk/cgi-bin/texfaq2html?label=miktexinst +http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-miktex +http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings http://www.tex.ac.uk/cgi-bin/texfaq2html?label=privinst -------------------------------------------------------------------------- @@ -18,18 +18,18 @@ environments such `figure' and `table' and cooperates with the packages float, floatflt, fltpage, hyperref, hypcap, listings, longtable, picinpar, picins, rotating, sidecap, subfigure, supertabular, - threeparttable, and wrapfig. + threeparttable, wrapfig, and xtab. -Furthermore the `floatrow' and the `subfig' package supports the -`caption' package and uses its \captionsetup interface. +Furthermore the `floatrow', the `subcaption', and the `subfig' package +supports the `caption' package and uses its \captionsetup interface. User Manual: caption-eng.pdf (English) caption-rus.pdf (Russian, outdated) - caption-deu.pdf (German, not completely finished yet) + caption-deu.pdf (German) -------------------------------------------------------------------------- -The `ltcaption' package v1.1 fixes caption problems with +The `ltcaption' package v1.2 fixes caption problems with other-than-center aligned longtables. (solving LaTeX PR `tools/3387') A bonus feature is the addition of the environment longtable* which does @@ -42,7 +42,7 @@ User Manual: ltcaption.pdf (English) -------------------------------------------------------------------------- -The `subcaption' package v0.3 is a tiny package to demonstrate the +The `subcaption' package v1.0 is a tiny package which demonstrates the sub-caption feature of the `caption' package. User Manual: subcaption.pdf (English) diff --git a/Master/texmf-dist/doc/latex/caption/caption-deu.pdf b/Master/texmf-dist/doc/latex/caption/caption-deu.pdf Binary files differindex 784015d1fec..507ede59b1c 100644 --- a/Master/texmf-dist/doc/latex/caption/caption-deu.pdf +++ 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 index 2d189a0e2b8..997a541b954 100644 --- a/Master/texmf-dist/doc/latex/caption/caption-deu.tex +++ b/Master/texmf-dist/doc/latex/caption/caption-deu.tex @@ -1,7 +1,7 @@ % % This is file `caption-deu.tex'. % -% Copyright (C) 1994-2007 Axel Sommerfeldt (caption@sommerfee.de) +% Copyright (C) 1994-2008 Axel Sommerfeldt (caption@sommerfee.de) % % -------------------------------------------------------------------------- % @@ -23,7 +23,7 @@ % user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. % \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{caption-deu.tex}[2008/03/16 v3.1g Das caption-Paket] +\ProvidesFile{caption-deu.tex}[2008/04/06 v3.1h Das caption-Paket] \hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. %\errorcontextlines=3 @@ -65,7 +65,7 @@ \hypersetup{pdfkeywords={LaTeX, package, caption},pdfstartpage={},pdfstartview={}} \hypersetup{breaklinks=true} -\usepackage[listof=0,hypcap=false]{caption}[2008/01/12] +\usepackage[listof=0,hypcap=false]{caption}[2008/04/01] \DeclareRobustCommand*\eTeX{\texorpdfstring {\leavevmode\hbox{$\varepsilon$}-\TeX}% @@ -79,19 +79,18 @@ \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{\LARGE\Info}}} \makeatother -\font\manual=manfnt -\newcommand*\DANGER{\MARGINSYM{\manual\char127}} + \newcommand*\MARGINSYM[1]{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{#1}}}} +\newcommand*\NEW[2]{}%\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} % \ContinuedFloat -\DeclareCaptionLabelFormat{continued}{#1~#2 (Fortsetzung)} +\DeclareCaptionLabelFormat{continued1}{#1~#2 (Fortsetzung)} +\DeclareCaptionLabelFormat{continued2}{#1~#2\alph{ContinuedFloat}} % \DeclareCaptionLabelFormat \DeclareCaptionLabelFormat{bf-parens}{(\textbf{#2})} % \DeclareCaptionStyle @@ -216,6 +215,16 @@ und Tabellenbeschriftungen den eigenen Wünschen bzw.\ Vorgaben anzupassen. Hierbei wurde Wert auf die reibungslose Zusammenarbeit mit zahlreichen Dokumentenklassen und Paketen gelegt. +\iffalse +\par\smallskip +\textit{Bitte beachten Sie:} Viele Dokumentenklassen bieten bereits +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 |\caption|\-|of| interessiert sind, ist in der Regel das Laden des +kleinen aber feinen \package{capt-of}"=Paketes hierzu völlig ausreichend. +\fi \end{abstract} \newcommand\exampletext{% @@ -255,39 +264,9 @@ dieser kann aber mit anderen Paketen wie etwa dem \package{floatrow}"=Paket\cite{floatrow} variiert werden. \end{minipage} -\clearpage - -% --------------------------------------------------------------------------- % - -\section*{Vorläufige Dokumentation} - -\INFO -Diese Anleitung ist (im Gegensatz zur englischsprachigen Anleitung) leider -noch an einigen Stellen inkonsistent bzw.~unvollständig. -Ich werde mich bemühen, sie in den nächsten Monaten zu vervollständigen; -die aktuelle Interimsversion kann immer -\href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/caption/caption-deu.pdf}% -{hier} bezogen werden.\par\bigskip - -\def\beginTODO{% - \bigskip - \hrule - \smallskip - \centerline{\itshape Beginn des noch zu überarbeitenden Teils} - \smallskip - \hrule - \bigskip} -\def\endTODO{% - \bigskip - \hrule - \smallskip - \centerline{\itshape Ende des noch zu überarbeitenden Teils} - \smallskip - \hrule - \bigskip} - % --------------------------------------------------------------------------- % +\clearpage \tableofcontents % --------------------------------------------------------------------------- % @@ -677,7 +656,7 @@ Drei Beispiele: \smallskip -\pagebreak[3] +\PageBreak \DescribeMacro{singlelinecheck=} In den Standard"=Dokumentenklassen von \LaTeX\ (\class{article}, \class{report} und \class{book}) sind die Ab\-bildungs- und @@ -721,7 +700,7 @@ ist sie eingeschaltet.) \DescribeMacro{font=} \DescribeMacro{labelfont=} \DescribeMacro{textfont=} -Das \thispackage\ kennt drei Zeichensätze: Denjenigen für die gesammte +\Thispackage\ kennt drei Zeichensätze: Denjenigen für die gesammte Beschriftung (|font|), denjenigen, der lediglich auf den Bezeichner und den Trenner angewandt wird (|label|\-|font|), sowie denjenigen, der lediglich auf den Text wirkt (|text|\-|font|). @@ -1134,7 +1113,7 @@ identisch mit \medskip -\DANGER +\INFO Bitte beachten Sie, daß die Optionen |skip=|, |position=|, |figure|\-|position=| und |table|\-|position=| nicht immer einen Effekt haben. Da die Gleitumgebungen üblicherweise von den Dokumentenklassen bereitgestellt @@ -1161,11 +1140,11 @@ Weiterhin gibt es eine zweite Länge, |\below|\-|caption|\-|skip|, die üblicherweise auf |0pt| vorbelegt ist und den Abstand auf der anderen Seite der Beschriftung regelt. Technisch gesprochen vertauscht also \thispackage\ die Bedeutungen dieser -beiden Längen when |position=top| gesetzt ist. +beiden Längen wenn |position=|\x|top| gesetzt ist. Bitte beachten Sie, daß diverse andere Pakete (wie etwa das \package{ftcap}-, das \package{nonfloat}- und das \package{topcap}"=Paket) den gleichen -Kniff anwenden, so daß die Benutzung solcher Pakete zusammen mit dem -\package{caption}"=Paket zu vermeiden ist. +Kniff anwenden, so daß die Benutzung solcher Pakete zusammen mit der +\package{caption}"=Option |position=| nicht unterstützt wird. \end{Expert*} % --------------------------------------------------------------------------- % @@ -1219,9 +1198,10 @@ Es gibt fünf vordefinierte Listenformate: \SeeUserDefined \end{Options} -Das Präfix ($=$|\p@figure| bzw.~|\p@table|), welches in Listen und bei -Referenzen der Nummer ($=$|\the|\-|figure| bzw.~|\the|\-|table|) vorangestellt -wird, ist normalerweise leer, so daß die Listenformate |simple| und |subsimple| +Das Präfix ($=$|\p@figure| bzw.~|\p@table|), welches in Verzeichnissen (wie +dem Abbildungs- und Tabellenverzeichnis) und bei Referenzen der Nummer +($=$|\the|\-|figure| bzw.~|\the|\-|table|) vorangestellt wird, +ist normalerweise leer, so daß die Listenformate |simple| und |subsimple| indentische Ergebnisse abliefern; ebenso |parens| und |subparens|. Aber dies kann z.B. bei Unterabbildungen anders sein.\footnote{% Unterabbildungen können z.B.~mit dem \package{subcaption}- oder @@ -1358,7 +1338,7 @@ gesetzt ist), tut dies |type*=| nicht. \end{Expert} \begin{Expert} \emph{\DefaultNoteText:} Bitte definieren Sie das interne Makro |\@captype| -nicht, wie von manchen Dokumentationen vorgeschlagen wird, selber um, +nicht, wie in manchen Dokumentationen vorgeschlagen wird, selber um, sondern verwenden Sie stattdessen immer |\caption|\-|setup{type=|\x\ldots|}|. \end{Expert} @@ -1371,9 +1351,9 @@ oder |\Declare|\-|New|\-|Float|\-|Type| (angeboten vom \medskip -\DANGER % \NEWdescription{v3.1} +\INFO % \NEWdescription{v3.1} Bitte verwenden Sie die Option |type=| nur \emph{innerhalb} von Boxen oder -Umgebungen (wie |\par|\x|box| oder |mini|\x|page|), am besten solcher, wo +Umgebungen (wie |\par|\-|box| oder |mini|\-|page|), am besten solcher, wo kein Seitenumbruch innerhalb möglich ist, damit die Abbildung bzw.~Tabelle und die Beschriftung nicht durch einen solchen getrennt werden kann. Weiterhin können einige unschöne Nebeneffekte auftreten, wenn |type=| @@ -1523,7 +1503,7 @@ führt zu folgendem Ergebnis: Analog zu |\caption*| gibt es auch den Befehl |\captionof*| für Beschriftungen ohne Bezeichner und ohne Verzeichniseintrag. -\DANGER % \NEWdescription{v3.1} +\INFO % \NEWdescription{v3.1} Da |\caption|\-|of| intern die Option |type| verwendet, gelten hier die gleichen Einschränkungen wie für die Option |type|, d.h.~sowohl |\caption|\-|of| als auch |\caption|\-|of*| sollten nur \emph{innerhalb} von @@ -1631,7 +1611,7 @@ zwei: |figure| und |table|. Wie wir jedoch später sehen werden, kommen durch die Verwendung spezieller \LaTeX-Pakete (wie etwa das \package{floatrow}, \package{longtable} oder \package{sidecap}"=Paket) ggf.~weitere Typen hinzu, deren Beschriftungen ebenfalls derart individuell angepasst werden können. -\See{\Ref{declare} and \Ref{packages}} +\See{\Ref{declare} und \Ref{packages}} \begin{Expert} \NEWfeature{v3.1} @@ -1758,8 +1738,8 @@ die Info: \DescribeMacro{\ContinuedFloat} Manchmal möchte man Abbildungen oder Tabellen aufteilen, jedoch ohne den einzelnen -Teilen eine eigene Abbildungs- oder Tabellennummer zu geben. Hierfür stellt das -\thispackage"=Paket den Befehl +Teilen eine eigene Abbildungs- oder Tabellennummer zu geben. Hierfür stellt +\thispackage\ den Befehl \begin{quote} |\ContinuedFloat| \end{quote} @@ -1807,22 +1787,125 @@ auf ein anderes Bezeichner- oder Textformat umzuschalten, wie etwa hier: \end{quote} \begin{Example} \captionsetup{type=table,position=b,skip=0pt} - \captionsetup[ContinuedFloat]{labelformat=continued} + \captionsetup[ContinuedFloat]{labelformat=continued1} \ContinuedFloat - \caption{Eine Tabelle} + \caption{Eine Tabelle}\label{continued1} \centerline{\ldots} \end{Example} -\medskip +\smallskip \See{\Ref{declare} für die Erläuterung des Befehls \cs{Declare}\-\texttt{Caption}\-\texttt{Label}\-\texttt{Format}.} -\bigskip +\medskip -Möchten Sie hingegen bei fortgeführten |long|\-|table|s einen anderen -Bezeichner (nach einem Seitenumbruch), so kann dies \emph{nicht} -mit |\Continued|\-|Float| bewerkstelligt werden, aber mit Hilfe -der vom \package{longtable}"=Paket\cite{longtable} bereitgestellten -Befehle |\end|\-|first|\-|head| und |\end|\-|head|; in etwa so: +Weiterhin existiert auch ein \LaTeX"=Zähler namens |Continued|\-|Float|, +der auch für eigene Zwecke eingesetzt werden kann. +Für gewöhnliche (gleitende) Umgebungen ist er auf Null gesetzt, auf Eins +in der ersten fortgeführten Umgebung, Zwei in der nächsten und so weiter. +Jedes |\Continued|\-|Float| erhöht also diesen Zähler um Eins, während +eine Gleitumgebung ohne |\Continued|\-|Float| den Zähler auf Null zurücksetzt. +Ein Beispiel: +\begin{quote} + |\DeclareCaptionLabelFormat{cont}{#1~#2\alph{ContinuedFloat}}|\\ + |\captionsetup[ContinuedFloat]{labelformat=cont}|\\ + \ldots\\ + |\begin{table}\ContinuedFloat|\\ + | \caption{Eine Tabelle}|\\ + | |\ldots\\ + |\end{table}| +\end{quote} +\begin{Example} + \captionsetup{type=table,position=b,skip=0pt} + \captionsetup[ContinuedFloat]{labelformat=continued2} + \ContinuedFloat + \caption{Eine Tabelle}\label{continued2} + \centerline{\ldots} +\end{Example} +\medskip +Eine Referenz auf diese Tabelle würde "`\autoref{continued2}"' ergeben, +da lediglich das Format der Tabellenbeschriftung geändert wurde. +Sollen Referenzen ebenfalls diesen Zähler enthalten, so kann stattdessen der +Befehl |\the|\-|Continued|\-|Float| passend umdefiniert werden. +Dieser Befehl wird automatisch bei der Anwendung von |\Continued|\-|Float| +dem Abbildungs- bzw.~Tabellenzähler angehängt und hat normalerweise einen +leeren Inhalt. +\begin{quote} + |\renewcommand\theContinuedFloat{\alph{ContinuedFloat}}|\\ + \ldots\\ + |\begin{table}\ContinuedFloat|\\ + | \caption{Eine Tabelle}|\\ + | |\ldots\\ + |\end{table}| +\end{quote} +\begin{Example} + \captionsetup{type=table,position=b,skip=0pt} + \renewcommand\theContinuedFloat{\alph{ContinuedFloat}} + \ContinuedFloat + \caption{Eine Tabelle}\label{continued3} + \centerline{\ldots} +\end{Example} +\medskip +Eine Referenz auf diese Tabelle würde nun "`\autoref{continued3}"' ergeben. + +\pagebreak[3] +\DescribeMacro{\ContinuedFloat*} +Angenommen man möchte gerne die erste Abbildung oder Tabelle einer +fortlaufenden Serie mit einer Beschriftung der Art "`Abbildung 7a"' und +nicht mit "`Abbildung 7"' beschriften. (Und die zweite entsprechend mit +"`Abbildung 7b"' statt "`Abbildung 7a"'.) +Dies ist auch möglich, indem man die Stern"=Variante |\Continued|\-|Float*| +anwendet. +Diese führt genau wie |\ContinuedFloat| auch die mit "`|Continued|\-|Float|"' +verknüpften Optionen aus und erhöht den \LaTeX"=Zähler |Continued|\-|Float|, +markiert aber die erste Abbildung bzw.~Tabelle einer fortlaufenden Serie: +\begin{quote} + |\renewcommand\theContinuedFloat{\alph{ContinuedFloat}}|\\ + \ldots\\ + |\begin{figure}\ContinuedFloat*|\\ + | |\ldots\\ + | \caption{Erste Abbildung einer Serie}|\\ + |\end{figure}|\\ + \ldots\\ + |\begin{figure}\ContinuedFloat|\\ + | |\ldots\\ + | \caption{Zweite Abbildung einer Serie}|\\ + |\end{figure}|\\ + \ldots\\ + |\begin{figure}\ContinuedFloat|\\ + | |\ldots\\ + | \caption{Dritte Abbildung einer Serie}|\\ + |\end{figure}| +\end{quote} +\begin{Example} + \captionsetup{type=figure,position=b,skip=0pt} + \renewcommand\theContinuedFloat{\alph{ContinuedFloat}} + \begingroup + \ContinuedFloat* + \centerline{\ldots} + \caption{Erste Abbildung einer Serie} + \endgroup + \begingroup + \ContinuedFloat + \centerline{\ldots} + \caption{Zweite Abbildung einer Serie} + \endgroup + \begingroup + \ContinuedFloat + \centerline{\ldots} + \caption{Dritte Abbildung einer Serie} + \endgroup +\end{Example} +\smallskip +\Note{Leider ist \cs{ContinuedFloat*} nicht verfügbar, wenn das + \package{subfig}"=Paket\cite{subfig} geladen ist.} + +\pagebreak[3] +\subsubsection*{Eine Anmerkung zur longtable-Umgebung} +Möchten Sie hingegen bei fortgeführten |long|\-|table|"=Umgebungen einen +anderen Bezeichner (nach einem Seitenumbruch), so kann dies \emph{nicht} +mit |\Continued|\-|Float| bewerkstelligt werden, aber mit Hilfe der vom +\package{longtable}"=Paket\cite{longtable} bereitgestellten Befehle +|\end|\-|first|\-|head| und |\end|\-|head|; in etwa so: \begin{quote} |\DeclareCaptionLabelFormat{continued}{#1~#2 (Fortsetzung)}|\\ \ldots\\ @@ -1889,8 +1972,7 @@ Bei der Definition von eigenen Bezeichnerformaten gibt es eine Besonderheit zu beachten: Wird das Bezeichnerformat auch in Verbindung mit dem \package{subcaption} oder \package{subfig}"=Paket\cite{subfig} verwendet, so kann der Bezeichnername (also \#1) auch leer sein. -Um dies flexibel handhaben zu können, stellt das \thispackage"=Paket die -Befehle +Um dies flexibel handhaben zu können, stellt \thispackage\ die Befehle \begin{quote} |\bothIfFirst|\marg{Erstes Argument}\marg{Zweites Argument}\quad und\\ |\bothIfSecond|\marg{Erstes Argument}\marg{Zweites Argument} @@ -2112,6 +2194,7 @@ und |wrap|\meta{Typ} (\package{wrapfig}"=Paket) definiert. \smallskip +\pagebreak[3] So definiert zum Beispiel \begin{quote} |\DeclareCaptionType{diagram}[Diagramm][Diagrammverzeichnis]| @@ -2125,7 +2208,7 @@ Abhängig von den geladenen Paketen werden auch ggf.~die Umgebungen |FPdiagram|, % --------------------------------------------------------------------------- % -\PageBreak +\pagebreak[3] \subsection{Weiterführende Beispiele} \label{examples} @@ -2255,126 +2338,75 @@ realisiert: a & 1 & 2 \\ b & 3 & 4 \\ \end{tabular} - \captionlistentry[table]{A figure and a table with a common caption} + \captionlistentry[table]{Eine Abbildung und Tabelle mit gemeinsamer Beschriftung} \captionsetup{labelformat=andtable} - \caption{A figure and a table with a common caption~\footnotemark} + \caption{Eine Abbildung und Tabelle mit gemeinsamer Beschriftung~\footnotemark} \end{minipage} \footnotetext{Das Katzenbild wurde den Beispielen zum \LaTeX"=Begleiter\cite{TLC2} entnommen, die Erlaubnis hierzu wurde eingeholt.} \MakeShortVerb{\|} -% --------------------------------------------------------------------------- % - -\clearpage -%\section{Dokumentenklassen \& Babel-Unterstützung} -%\label{classes} +(Beachten Sie, daß |\caption|\-|list|\-|entry| den Abbildungs- bzw.~Tabellenzähler + erhöht.) -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -\iffalse +% --------------------------------------------------------------------------- % +\clearpage \section{Dokumentenklassen \& Babel-Unterstützung} \label{classes} %\NEWdescription{v3.1} -\begin{Note*}[Bitte beachten Sie] -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} package is usually sufficient. -%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 |\caption|\-|of| interessiert sind, ist in der Regel das Laden des -%kleinen aber feinen \package{capt-of}"=Paketes hierzu völlig ausreichend. -\end{Note*} - -\medskip - -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. -%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. +Dieser Teil der Dokumentation wird Ihnen einen Überblick über diejenigen +Dokumentenklassen geben, an welche \thispackage\ angepasst ist: +Welche Möglichkeiten zur Beschriftungsgestaltung sie bereits verfügen, +mit welchen Seiteneffekten Sie rechnen müssen, wenn Sie dieses Paket verwenden, +und mit welchen Standardwerten die Optionen belegt werden. \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. -%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. +Die Standardwerte namens "`default"' hängen von der verwendeten +Dokumentenklasse ab; sie repräsentieren quasi das Aussehen, wie es vom Autor +der Klasse vorgesehen war. +So kann z.B.~die Einstellung |format=|\x|default| je nach verwendeter Klasse +unterschiedliche Aussehen der Beschriftungen hervorbringen. \begingroup\setlength\leftmargini{0.3em}% default = 2.5em -\DANGER -If you don't find the document class you use in this section, you usually -don't have to worry: Many document classes (e.g.~the \class{octavo} class) -are derived from one of the standard document classes \class{article}, -\class{report}, or \class{book}, and behave the same regarding captions. -\Thispackage\ automatically does a compatibility check against the document -class used and will give you the clear warning +\INFO +Sollten Sie Ihre Dokumentenklasse nicht in diesem Abschnitt finden, so haben Sie +trotzdem oftmals keinen Grund zur Sorge: Viele Dokumentenklassen (wie z.B.~die +\class{octavo} Klasse) sind von einer der Standardklassen \class{article}, +\class{report} oder \class{book} abgeleitet und verhalten sich bezüglich der +Abbildungs- und Tabellenbeschriftungen gleich. +\Thispackage\ überprüft automatisch die Kompatibilität zur Dokumentenklasse und +gibt Ihnen die Warnung \begin{quote}\footnotesize |Package caption Warning: Unsupported document class (or package) detected,|\\ |(caption) usage of the caption package is not recommended.|\\ |See the caption package documentation for explanation.| \end{quote} -if such an 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. -%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 erhalten -%Sie in einem solchen Fall keinen Support. +aus, wenn es eine Unverträglichkeit entdeckt. +Wenn Sie keine solche Warnung erhalten, ist alles bestens, falls aber doch, +wird der Einsatz des \package{caption}"=Paketes nicht empfohlen und +insbesondere nicht unterstützt. \endgroup \begin{Expert} -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=|\x|base| -via |\use|\-|package[style=|\x|base]{caption}| or -|\caption|\-|setup{style=|\x|base}| to set \thispackage\ into a well-defined -state. -Afterwards you can start setting your own options additionally and -keep your fingers crossed. -%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| mit |\usepackage|\x|[style=base]|\x|{caption}| oder -% |\caption|\-|setup{style=|\x|base}| angeben, um \thispackage\ in einen -% dokumentierten Grundstatus zu versetzen. -% Anschließend können Sie anfangen, mit zusätzlichen Optionen erste -% Anpassungen vorzunehmen und die Daumen gedrückt zu halten. +Sollten Sie trotz der angemahnten Inkompatibilität \thispackage{} +nutzen wollen, sollten Sie gründlich auf Seiteneffekte achten; gewöhnlich +ändert sich alleine durch das Einbinden des \package{caption}"=Paketes +ohne Optionen bereits das von der Dokumentenklasse vorgegebene Aussehen der +Beschriftungen. +Wenn dies für Sie in Ordnung ist, sollten Sie als erstes die Option +|style=|\x|base| mittels |\use|\-|package[style=|\x|base]{caption}| oder +|\caption|\-|setup{style=|\x|base}| angeben, um \thispackage\ in einen +wohldefinierten Grundstatus zu versetzen. +Anschließend können Sie anfangen, mit zusätzlichen Optionen erste +Anpassungen vorzunehmen und dabei die Daumen gedrückt zu halten. \end{Expert} \newcommand*\Option{Option} \newcommand*\defaultvalue{Standard-Belegung (\texttt{default})} -\newcommand*\use{\textit{verwendet}} +\newcommand*\uses{\textit{verwendet}} \newcommand*\settings{\textit{Einstellungen}} \newcommand*\nofont{\textit{keiner}} @@ -2392,8 +2424,8 @@ keep your fingers crossed. \end{tabular} \begin{Annotation} -This also applies to document classes derived from them. -%Dies gilt in der Regel auch für abgeleitete Dokumentenklassen. +Dies gilt auch für von \class{article}, \class{report} und \class{book} +abgeleitete Dokumentenklassen. \end{Annotation} \subsection{\AmS: amsart, amsproc und amsbook} @@ -2403,7 +2435,7 @@ This also applies to document classes derived from them. \Option & \defaultvalue \\\hline |format=| & |plain| \\ |labelformat=| & |simple| \\ -|labelsep=| & a period $+$ |\enspace| \\ +|labelsep=| & |.\enspace| \\ |justification=| & |justified| \\ |font=| & |\@captionfont| \\ |labelfont=| & |\@captionheadfont| \\ @@ -2411,21 +2443,22 @@ This also applies to document classes derived from them. \end{tabular} \begin{Annotation*} -|\@caption|\-|font| will be set to |\normal|\-|font|, and -|\@caption|\-|head|\-|font| to |\sc|\-|shape| by the \AmS\ document classes. +|\@caption|\-|font| wird von den \AmS\ Dokumentenklassen auf |\normal|\-|font| +vorbelegt, und |\@caption|\-|head|\-|font| auf |\sc|\-|shape|. \end{Annotation*} -Furthermore the margin will be set to |\caption|\-|indent| for -more-than-one-line captions (which will be set to |3pc| by the \AmS\ classes), -the margin for single-line captions will be set to the half of it instead. -If you want to use a common margin for both, insert +Weiterhin wird der Rand für mehrzeilige Abbildungs- bzw.~Tabellenbeschriftungen +auf |\caption|\-|indent| gesetzt, bei einzeiligen Beschriftungen wird lediglich +die Hälfte davon verwendet. (|\caption|\-|indent| wird von den \AmS\ Klassen +auf |3pc| vorbelegt.) +Möchten Sie einen einheitlichen Rand, so fügen Sie bitte |\clear|\-|caption|\-|setup[margin*]{single|\-|line}| -into the preamble of your document, after loading \thispackage. +in Ihren Dokumentenvorspann ein, nachdem Sie \thispackage\ geladen haben. -Additionally the options |figure|\-|position=b,|\x|table|\-|position=t| -will be set. You can override these settings by specifying other values for -|figure|\-|position=| or |table|\-|position=| in the option list while -loading \thispackage. +Zusätzlich werden automatisch die Optionen |figure|\-|position=b,|\x|table|\-|position=t| +gesetzt. Dies können Sie überschreiben, indem Sie beim Laden des +\package{caption}"=Paketes einfach andere Werte für +|figure|\-|position=| und |table|\-|position=| angeben. \subsection{beamer} \label{beamer} @@ -2436,81 +2469,56 @@ loading \thispackage. |labelformat=| & \textit{nicht nummeriert} \\ |labelsep=| & |colon| \\ |justification=| & |raggedright| \\ -|font=| & \use\ \class{beamer} |caption| \settings \\ -|labelfont=| & \use\ \class{beamer} |caption name| \settings \\ +|font=| & \class{beamer} "`|caption|"' \settings \\ +|labelfont=| & \class{beamer} "`|caption name|"' \settings \\ |textfont=| & \nofont \\ \end{tabular} -\subsubsection*{Build-in features and side-effects} -You can setup font and color settings with -|\set|\-|beamer|\-|font{caption}|\marg{options} and -|\set|\-|beamer|\-|font{caption name}|\marg{options}. -This will still work, unless you set a different font with -|\caption|\-|setup{font=|\x\meta{options}|}| or -|\caption|\-|setup{label|\-|font=|\x\meta{options}|}|.\par -Furthermore the \class{beamer} classes offer different caption templates -which can be chosen with -|\set|\-|beamter|\-|template|\x|{caption}|\x|[|\meta{template}|]|. -Since \thispackage\ replaces this caption template mechanism, -|\def|\-|beamer|\-|template*|\x|{caption}|\x\marg{template code} -and -|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{template}|]| -will have no effect when \thispackage\ is used. -%\textbf{Von der Klasse angebotene Befehle und Seiteneffekte:}\\ -%Die Zeichensatz- und Farbeinstellungen können mit -%|\setbeamerfont|\x|{caption}|\x\marg{options} und -%|\setbeamerfont|\x|{caption name}|\x\marg{options} vorgenommen werden. -%Dies wird auch mit dem \package{caption}"=Paket noch funktionieren, zumindest -%solange Sie keinen anderen Zeichensatz mit -%|\captionsetup|\x|{font=|\x\meta{options}|}| oder -%|\captionsetup|\x|{labelfont=|\x\meta{options}|}| einstellen.\par -%Weiterhin bietet die \package{beamer}"=Klasse verschiedene "`Templates"' für -%die Beschriftungen an, diese können mit -%|\set|\-|beamter|\-|template|\x|{caption}|\x|[|\meta{template}|]| -%ausgewählt werden. -%Da \thispackage\ diesen Mechanismus ersetzt, haben -%|\def|\-|beamer|\-|template*|\x|{caption}|\x\marg{template code} -%und -%|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{template}|]| -%keine Funktion mehr, wenn \thispackage\ verwendet wird. +\subsubsection*{Von der Klasse angebotene Befehle und deren Seiteneffekte} +Die Zeichensatz- und Farbeinstellungen können mit +|\set|\-|beamer|\-|font{caption}|\marg{Optionen} und +|\set|\-|beamer|\-|font{caption name}|\marg{Optionen} vorgenommen werden. +Dies wird auch mit dem \package{caption}"=Paket noch funktionieren, +zumindest solange Sie keinen anderen Zeichensatz mit +|\caption|\-|setup{font=|\x\meta{Optionen}|}| oder +|\caption|\-|setup{label|\-|font=|\x\meta{Optionen}|}| einstellen.\par +Weiterhin bietet die \package{beamer}"=Klasse verschiedene "`Templates"' für +die Beschriftungen an, diese können mit +|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{Template}|]| +ausgewählt werden. +Da \thispackage\ diesen Mechanismus ersetzt, haben +|\def|\-|beamer|\-|template*|\x|{caption}|\x\marg{Template Code} +und +|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{Template}|]| +keine Funktion mehr, wenn \thispackage\ verwendet wird. \subsection{\KOMAScript: scrartcl, scrreprt und scrbook} \label{KOMA} \begin{tabular}{ll} \Option & \defaultvalue \\\hline -|format=| & \use\ |\setcapindent| \textit{\&} |\setcaphanging| \settings \\ -|labelformat=| & \textit{like \purett{simple}, but with support of ``autodot''}\\ -|labelsep=| & \use\ |\captionformat| \\ +|format=| & \uses\ |\setcapindent| \textit{\&} |\setcaphanging| \settings \\ +|labelformat=| & \textit{wie \purett{simple}, aber mit ``autodot'' Feature}\\ +|labelsep=| & |\captionformat| \\ |justification=| & |justified| \\ -|font=| & \use\ |\setkomafont{caption}| \settings \\ -|labelfont=| & \use\ |\setkomafont{captionlabel}| \settings \\ +|font=| & |\setkomafont{caption}| \settings \\ +|labelfont=| & |\setkomafont{captionlabel}| \settings \\ |textfont=| & \nofont \\ \end{tabular} -\subsubsection*{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{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"'. - -\subsubsection*{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. -%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. +\subsubsection*{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"'. + +\subsubsection*{Seiteneffekte} +Das optionale Argument von |\set|\-|cap|\-|width| wird nicht vom +\package{caption}"=Paket unterstützt und daher ignoriert. +Weiterhin überschreiben die \KOMAScript"=Optionen |table|\-|caption|\-|above| +\& |table|\-|caption|\-|below| sowie die dazugehörigen Befehle +|\caption|\-|above| \& |\caption|\-|below| die mit |position=| getätigten +Einstellungen. \subsection{\NTG: artikel, rapport und boek} \label{NTG} @@ -2522,31 +2530,26 @@ package. |labelsep=| & |colon| \\ |justification=| & |justified| \\ |font=| & \nofont \\ -|labelfont=| & \use\ |\CaptionLabelFont| \\ -|textfont=| & \use\ |\CaptionTextFont| \\ +|labelfont=| & |\CaptionLabelFont| \\ +|textfont=| & |\CaptionTextFont| \\ \end{tabular} -\subsubsection*{Build-in features and side-effects} -|\Caption|\-|Label|\-|Font| and |\Caption|\-|Text|\-|Font| can be set either -directly or by using |\Caption|\-|Fonts|. -Both is still supported unless you use one of the two options -|label|\-|font=| or |text|\-|font=| offered by \thispackage. -%|\CaptionLabelFont| und |\CaptionTextFont| können entweder direkt oder -%indirekt über |\CaptionFonts| definiert werden. -%Beides funktioniert auch weiterhin, zumindest solange kein anderer -%Zeichensatz mit der \package{caption}"=Paket"=Optionen -%|labelfont=| oder |textfont=| festgelegt wird. - -\subsection{\SmF{} classes: smfart und smfbook} +\subsubsection*{Von der Klasse angebotene Befehle und deren Seiteneffekte} +|\Caption|\-|Label|\-|Font| und |\Caption|\-|Text|\-|Font| können entweder +direkt oder indirekt über |\Caption|\-|Fonts| definiert werden. +Beides funktioniert auch weiterhin, zumindest solange kein anderer +Zeichensatz mit den \package{caption}"=Paketoptionen +|label|\-|font=| und |text|\-|font=| festgelegt wird. + +\subsection{\SmF: smfart und smfbook} \label{SMF} -Since the \SmF\ document classes are derived from the \AmS\ document classes -the same default values are valid here. +Da die \SmF\ Dokumentenklassen von den \AmS\ Klassen abgeleitet wurden, +gelten hier dieselben Standardbelegungen wie dort. -Additionally the margin is limited up to the tenth of the |\line|\-|width|. -If you don't like this limitation, you can switch it off with the option -|max|\-|margin=|\x|off| or |max|\-|margin=|\x|false| -(which both means the same). +Zusätzlich ist der Rand auf den zehnten Teil von |\line|\-|width| limiert. +Mögen Sie diese Limitierung nicht, kann sie mit der Option +|max|\-|margin=|\x|off| oder |max|\-|margin=|\x|false| ausgeschaltet werden. \subsection{thesis} \label{thesis} @@ -2554,104 +2557,98 @@ If you don't like this limitation, you can switch it off with the option \begin{tabular}{ll} \Option & \defaultvalue \\\hline |format=| & |hang| \\ -|labelformat=| & \textit{like \purett{simple}, but with short name}\\ +|labelformat=| & \textit{wie \purett{simple}, aber mit kurzem Namen}\\ |labelsep=| & |colon| \\ |justification=| & |justified| \\ |font=| & \nofont \\ -|labelfont=| & \use\ |\captionheaderfont| \\ -|textfont=| & \use\ |\captionbodyfont| \\ +|labelfont=| & |\captionheaderfont| \\ +|textfont=| & |\captionbodyfont| \\ \end{tabular} -\subsubsection*{Build-in features and side-effects} -The caption label font can be set with |\caption|\-|header|\-|font|, -the caption text font with |\caption|\-|body|\-|font|. -Both is still supported unless you use one of the two options -|label|\-|font=| or |text|\-|font=| offered by \thispackage. +\subsubsection*{Von der Klasse angebotene Befehle und deren Seiteneffekte} +Der Zeichensatz des Bezeichners kann hier mit |\caption|\-|header|\-|font|, +derjenige des Textes mit |\caption|\-|body|\-|font| gesetzt werden. +Beides funktioniert auch weiterhin, zumindest solange kein anderer +Zeichensatz mit den \package{caption}"=Paketoptionen +|label|\-|font=| und |text|\-|font=| gesetzt wird. -\subsection{Die französische Babel-Option} +\subsection{Babel-Option frenchb} \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. +Wird die Option \package{frenchb} des \package{babel}"=Paketes mit einer +der drei Standardklassen (oder einer davon abgeleiteten) verwendet, +dann wird |label|\-|sep=| auf |\Caption|\-|Sep|\-|a|\-|ra|\-|tor| vorbelegt +und damit die Vorbelegung der Dokumentenklasse überschrieben. +In diesem Falle wird eine Umdefinition von |\Caption|\-|Sep|\-|a|\-|ra|\-|tor| +auch weiterhin funktionieren, zumindest solange kein anderer Trenner mit +der Option |label|\-|sep=| gesetzt wird. \INFO* -Please load \thispackage\ \emph{after} the \package{babel} package. -%Bitte laden Sie \thispackage\ \emph{nach} dem \package{babel}"=Paket. +Bitte laden Sie \thispackage\ \emph{nach} dem \package{babel}"=Paket. -\subsection{Das frenchle- und frenchpro-Paket} -\label{frenchle} +\subsection{Pakete frenchle und frenchpro} \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 |text|\-|font=| will be set to |text|\-|font=|\x|it|, -since this emulates the default setting of |\caption|\-|font| 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 |\caption|\-|font| is used by the -\package{caption} package internally for a different purpose, -so you should not change it (anymore). - -The command |\un|\-|numbered|\-|captions|\marg{figure or table} will still work, -but only unless you don't select a different |label|\-|format=| than the default -one. +Wird das \package{frenchle}- oder \package{frenchpro}"=Paket verwendet, +dann wird |label|\-|sep=| auf |\caption|\-|sep|\-|a|\-|ra|\-|tor| plus +\cs{space} vorbelegt und damit die Vorbelegung der Dokumentenklasse +überschrieben. +Eine Umdefinition von |\caption|\-|sep|\-|a|\-|ra|\-|tor| wird auch weiterhin +funktionieren, zumindest solange kein anderer Trenner mit der Option +|label|\-|sep=| gesetzt wird. + +Weiterhin wird |text|\-|font=| auf |text|\-|font=|\x|it| vorbelegt, +um das Standardverhalten des \package{frenchle}- bzw.~\package{frenchpro}"=Paketes +bzgl.~des Beschriftungstext"=Zeichensatzes zu emulieren. +Bitte beachten Sie, daß der Befehl |\caption|\-|font| auch intern vom +\package{caption}"=Paket verwendet wird, und zwar auf eine andere Art und Weise +als das \package{frenchle}- bzw.~\package{frenchpro}"=Paket ihn verwendet; +daher sollten Sie ihn nicht (mehr) verwenden. + +Der Befehl |\un|\-|numbered|\-|captions|\marg{figure \emph{oder} table} wird +weiterhin seinen Dienst tun, aber nur solange Sie kein anderes Bezeichnerformat +mit |label|\-|format=| auswählen. \INFO* -Please load \thispackage\ \emph{after} the \package{frenchle} -or \package{frenchpro} package. -%Bitte laden Sie \thispackage\ \emph{nach} dem \package{frenchle} -%oder \package{frenchpro}"=Paket. +Bitte laden Sie \thispackage\ \emph{nach} dem \package{frenchle} +oder \package{frenchpro}"=Paket. % --------------------------------------------------------------------------- % \clearpage -\section{Interaktion mit anderen Paketen} +\section{Unterstützung anderer Pakete} \label{packages} \label{compatibility} %\NEWdescription{v3.1} -\Thispackage\ was adapted to the following packages which deals with -captions, too: -%\Thispackage\ ist an folgende Pakete, die ebenfalls Abbildungs- oder -%Tabellenbeschriftungen anbieten, angepasst: +\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{setspace}, \package{sidecap}, \package{subfigure}, \package{supertabular}, \package{threeparttable}, - and \package{wrapfig} + \package{wrapfig} und \package{xtab} \end{quote} -Furthermore the \package{floatrow} package\cite{floatrow}, the -\package{subcaption} package (which is part of the \package{caption} package -bundle), and the \package{subfig} package\cite{subfig} support \thispackage{} -and use its |\caption|\-|setup| interface. -%Weiterhin arbeiten das \package{floatrow}- und das \package{subfig}"=Paket -%aktiv mit diesem Paket zusammen und verwenden die |\captionsetup|"=Schnittstelle. +Weiterhin arbeitet das \package{floatrow}"=Paket\cite{floatrow}, +das \package{subcaption}"=Paket (welches Bestandteil der +\package{caption}"=Paketfamilie ist), sowie das \package{subfig}"=Paket\cite{subfig} +aktiv mit diesem Paket zusammen und verwenden dessen |\caption|\-|setup|"=Schnittstelle. \bigskip \begingroup\setlength\leftmargini{0.3em}% default = 2.5em -\DANGER -If a package (or document class) unknown to \thispackage\ redefines -the |\caption| command as well, this redefinition will be preferred -over the one this package offers, providing maximum compatibility and -avoiding incompatibilities. -If such a potential incompatibility is detected, you will see this -warning message:~\footnote{% - You can suppress this warning by specifying the option |compatibility=true| - when loading \thispackage.} +\INFO +Definiert ein anderes Paket (oder eine Dokumentenklasse), welches \thispackage{} +nicht kennt, ebenfalls den Befehl |\caption| um, so wird diese Umdefinition +bevorzugt, um maximale Kompatibilität zu gewährleisten und Konflikte +zu vermeiden. +Wird solch eine potentielle Inkompatiblität erkannt, wird diese Warnung +ausgegeben:~\footnote{% + Diese Warnung kann durch Angabe der Option \texttt{compatibility=true} + beim Laden des \package{caption}"=Paketes abgeschaltet werden.} \begin{quote}\footnotesize |Package caption Warning: \caption will not be redefined since it's already|\\ |(caption) redefined by a document class or package which is|\\ @@ -2660,27 +2657,29 @@ warning message:~\footnote{% \end{quote} \endgroup -As a result, the following features offered by \thispackage\ will not be available: +Als Folge stehen diese Ausstattungsmerkmale des \package{caption}"=Paketes nicht +zur Verfügung: \begin{itemize} - \item the options |labelformat=|, |position=auto|, and |list=| \& |listformat=| - \item |\caption*| (to produce a caption without label) - \item |\caption[]{|\ldots|}| (to produce no entry in the List of Figures or Tables) - \item |\caption{}| (to produce an empty caption without label separator) + \item die Optionen |labelformat=|, |position=auto|, |list=| und |listformat=| + \item |\caption*| (um eine Beschrifung ohne Bezeichner zu setzen) + \item |\caption[]{|\ldots|}| (um den Eintrag ins Verzeichnis zu unterbinden) + \item |\caption{}| (um eine leere Beschriftung ohne Trenner zu setzen) \item |\ContinuedFloat| - \item correctly justified captions in environments like \texttt{wide} or \texttt{addmargin} - \item the \textsf{hypcap} feature \See{\Ref{hyperref}\,} - \item the sub-caption feature \See{\package{subcaption} package documentation} + \item korrekt ausgerichtete Beschriftungen in Umgebungen wie \texttt{wide} und + \texttt{addmargin}, die die Seitenränder verändern + \item das sog.~\textsf{hypcap}"=Feature \See{\Ref{hyperref}\,} + \item Setzen von Unter-Beschriftungen \See{\package{subcaption}"=Paketdokumentation} \end{itemize} \DescribeMacro{compatibility=} -You can override this compatibility mode by specifying the option +Dieser Kompatibilitäts"=Modus kann durch die Angabe der Option \begin{quote} |compatibility=false| \end{quote} -when loading \thispackage. -But please note that using this option is neither recommended nor supported -since unwanted side-effects or even errors could occur afterwards. -(For that reason you will get a warning about this.) +beim Laden des \package{caption}"=Paketes ausgeschaltet werden. +Aber bitte beachten Sie, daß die Anwendung dieser Option weder empfohlen noch +unterstützt wird, da hierdurch unerwünschte Nebeneffekte oder Fehler auftreten +können. (Aus diesem Grunde wird hier ebenfalls eine Warnung ausgegeben.) \newcommand\packagedescription[1]{% \ifvmode\else\par\fi @@ -2692,13 +2691,14 @@ since unwanted side-effects or even errors could occur afterwards. \subsection{algorithms} \label{algorithms} \packagedescription{% -The \package{algorithms} package bundle\cite{algorithms} provides two -environments: The \texttt{algorithmic} environment provides an environment -for describing algorithms, and the \texttt{algorithm} environment provides -a ``float'' wrapper for algorithms.} +Die \package{algorithms}"=Paketfamilie\cite{algorithms} bietet zwei Umgebungen +an: Die Umgebung \texttt{algorithmic} bietet eine Möglichkeit, Algorithmen +zu beschreiben, und die Umgebung \texttt{algorithm} bietet eine passende +Gleitumgebung an.} -Since the \texttt{algorithm} environment is implemented via |\newfloat| -provided by the \package{float} package\cite{float}, please see \Ref{float}. +Da die \texttt{algorithm}"=Umgebung intern mittels |\new|\-|float| realisiert +ist, welches vom \package{float}"=Paket\cite{float} bereitgestellt wird, +schauen Sie bitte in \Ref{float} nach. \iffalse \pagebreak[3] @@ -2772,58 +2772,65 @@ An alternative would be using the \package{algorithmicx} package. \subsection{float} \label{float} \packagedescription{% -The \package{float} package\cite{float} introduces the commands -\cs{restylefloat} to give existing floating environments a new look \& feel -and \cs{newfloat} to define new floating environments. -It also provides the \texttt{H} float placement option of the obsolete -\package{here} package.} - -For floating environments defined with \cs{newfloat} or \cs{restylefloat} the -|po|\-|si|\-|tion| option has no effect on the main caption anymore, since its -placement and spacing will be controlled by the selected float style instead. - -Furthermore a caption style and options defined with the name of the float -style will be executed additionally to the regular ones. -Using this mechanism \thispackage\ emulates the default look \& feel of the -|ruled| captions: It defines the caption style +Das \package{float}"=Paket\cite{float} bietet den Befehl \cs{restylefloat} an, +der bestehende Gleitumgebungen zu einem neuen Design verhilft, ferner +\cs{newfloat} um neue Gleitumgebungen zu definieren. +Weiterhin wird die Platzierungs-Option "`\texttt{H}"' angeboten, die bei +Gleitumgebungen das Gleiten unterbindet.} + +Bei Gleitumgebungen, die mit \cs{newfloat} oder \cs{restylefloat} definiert +wurden, hat die Option |po|\-|si|\-|tion=| keinen Effekt auf die Beschriftung, +da die Platzierung und die Abstände von dem gewählten Gleitumgebungs"=Stil +festgelegt werden. + +Ein Beschriftungs"=Stil und Beschriftungs"=Optionen mit demselben Namen +wie der Gleitumgebungs"=Stil werden zusätzlich zu den normalen Optionen +ausgewählt. +Mit diesem Mechanismus emuliert \thispackage\ das Aussehen der Beschriftungen +vom Stil "`|ruled|"': Es definiert den Beschriftungs"=Stil \begin{quote} |\DeclareCaptionStyle{ruled}%|\\ | {labelfont=bf,labelsep=space,strut=off}|\mbox{\quad.} \end{quote} -So to change this you need either define your own caption style called -|ruled| or use |\caption|\-|setup[ruled]|\marg{options} to specify additional -options.%, -%e.g.~|\caption|\-|setup[ruled]{labelsep=|\x|colon}|. +Um dies zu ändern, müssen Sie entweder einen eigenen Stil namens "`|ruled|"' +definieren, oder aber mit |\caption|\-|setup[ruled]|\marg{Optionen} zusätzliche +Optionen angeben.%, +%z.B.~|\caption|\-|setup[ruled]{labelsep=|\x|colon}|. -Also by using this mechanism the skip between a |boxed| float and its caption -is specified, overriding its global value: +Dieser Mechanismus wird ebenso benutzt, um den Abstand zwischen einer +Gleitumgebung vom Stil "`|boxed|"' und seiner Beschriftung individuell +festzulegen: \begin{quote} |\captionsetup[boxed]{skip=2pt}| \end{quote} -For changing this, just use |\caption|\-|setup[boxed]{skip=|\x\meta{value}|}| -with an appropriate value. Or if you want to use the global |skip| setting -instead, you can remove the usage of the local setting for these floats with -|\clearcaptionsetup[skip]{boxed}|. +Um dies zu ändern, geben Sie einfach mit +|\caption|\-|setup[boxed]{skip=|\x\meta{Wert}|}| +einen anderen Wert an. +Oder wenn Sie stattdessen die globale Einstellung der Option |skip=| verwenden +wollen, können Sie die individuelle Abstandseinstellung mit +|\clear|\-|caption|\-|setup[skip]{boxed}| entfernen. \begin{Note} -Only one single caption can be typeset inside environments defined with -|\new|\-|float| or |\re|\-|style|\-|float|, furthermore these environments -are not behaving exactly like the pre-defined floats |figure| \& |table|. -As a consequence many packages do not cooperate well with these. -Furthermore the float package has some caveats \& limitations, so if you -just want to define a new simple floating environment---behaving like -|figure| or |table|---I recommend using \cs{DeclareCaptionType} -instead. -And for defining non-simple floating environments and customization I -recommend using |\DeclareNewFloatType| offered by the \package{floatrow} -package\cite{floatrow}. +Es kann immer nur \emph{eine} Beschriftung innerhalb der Gleitumgebungen +gesetzt werden, die mit |\new|\-|float| oder |\re|\-|style|\-|float| +definiert werden; außerdem verhalten sich diese Gleitumgebungen auch in +anderen Belangen nicht exakt wie die Umgebungen |figure| und |table|. +Als Konsequenz arbeiten viele Pakete nicht sehr gut mit diesen zusammen. +Weiterhin hat das \package{float}"=Paket einige Fallstricke und Schwächen, +weswegen ich als Alternative den Befehl |\Declare|\-|Caption|\-|Type| +anbiete, um neue Gleitumgebungen zu definieren, die sich wie |figure| +und |table| verhalten sollen. +Und für die Definition von mächtigeren Gleitumgebungen bzw.~der +stilistischen Umgestaltung von vorhandenen Gleitumgebungen empfehle ich als +Alternative den Befehl |\Declare|\-|New|\-|Float|\-|Type| des +moderneren \package{floatrow}"=Paketes\cite{floatrow}. \end{Note} \iffalse -Please also note that you \emph{don't} need a |\restylefloat| for using -the |H| float placement specifier. Some docs say so, but they are +Please also note that you \emph{don't} need a |\restyle|\-|float| for using +the ``|H|'' float placement specifier. Some docs say so, but they are wrong. -And |\restylefloat{table}| is a very good method to shoot yourself +And |\restyle|\-|float{table}| is a very good method to shoot yourself in the foot, since many packages using |table| internally are not working correctly afterwards. \fi @@ -2832,338 +2839,315 @@ correctly afterwards. \subsection{floatflt} \label{floatflt} \packagedescription{% -The \package{floatflt} package\cite{floatflt} offers figures and tables -which do not span the full width of a page and are float around by text.} +Das \package{floatflt}"=Paket\cite{floatflt} bietet Umgebungen zum Setzen von +Abbildungen und Tabellen an, die nicht die Gesamtbreite der Seite einnehmen, +sondern stattdessen vom Text umflossen werden.} \NEWfeature{v3.1} -If you want to setup special options for the |float|\-|ing|\-|figure| \& -|float|\-|ing|\-|table| environments you can use +Spezielle Optionen für die Umgebungen |float|\-|ing|\-|figure| und +|float|\-|ing|\-|table| können mit \begin{quote} - |\captionsetup[floatingfigure]|\marg{options}\\ - |\captionsetup[floatingtable]|\marg{options}\quad. + |\captionsetup[floatingfigure]|\marg{Optionen}\quad\emph{und}\\ + |\captionsetup[floatingtable]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|figure| or |table|. +festgelegt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures \& tables, -unless you set it explicit with |\caption|\-|setup[floating|\-|figure]{|\ldots|}| -or |\caption|\-|setup[floating|\-|table]{|\ldots|}|. +Die Einstellungen |margin=| bzw.~|width=| werden nicht auf diese Abbildungen +bzw.~Tabellen angewandt, solange sie nicht explizit mit +|\caption|\-|setup[floating|\-|figure]{|\ldots|}| +bzw.~|\caption|\-|setup[floating|\-|table]{|\ldots|}| gesetzt werden. \end{Note} \pagebreak[3] \subsection{fltpage} \label{fltpage} \packagedescription{% -The \package{fltpage} package\cite{fltpage} offers the outhouse of the -caption for |figure|s or |table|s which needs the whole page -for its contents. This will be done by placing the caption on the bottom -of the previous or next page.} +Das \package{fltpage}"=Paket\cite{fltpage} bietet die Ausgliederung der +Beschriftung für Abbildungen und Tabellen, die die gesamte Seitenhöhe +einnehmen, an. Hierbei wird die Beschriftung ans Ende der vorherigen +oder nächsten Seite verschoben.} \NEWfeature{v3.1} -Two options control the links to the |FPfigure| and |FPtable|: +Zwei Optionen regeln die Verweise auf die Umgebungen |FPfigure| und |FPtable|: \begin{description} -\item{\texttt{FPlist=caption} or \texttt{FPlist=figure}}\\[\smallskipamount] -If set to |caption|, the list entry will link to the caption; if set to -|figure|, it will link to the figure contents. -(The default setting is |FPlist=caption|.) -\item{\texttt{FPref=caption} or \texttt{FPref=figure}}\\[\smallskipamount] -If set to |caption|, a \cs{ref}, \cs{pageref}, \cs{autoref}, or \cs{nameref} -will link to the caption; if set to |figure|, it will link to the figure contents. -(The default setting is |FPref=figure|.) +\item{\texttt{FPlist=caption} oder \texttt{FPlist=figure}}\\[\smallskipamount] +Auf "`|caption|"' gesetzt, wird der Verzeichniseintrag auf die Beschriftung +der Abbildung bzw.~Tabelle verweisen, auf "`|figure|"' gesetzt auf den Inhalt +der Abbildung. +(Die Vorbelegung ist |FP|\-|list=|\x|caption|.) +\item{\texttt{FPref=caption} oder \texttt{FPref=figure}}\\[\smallskipamount] +Auf "`|caption|"' gesetzt, werden die mit \cs{ref}, \cs{pageref}, \cs{autoref} +oder \cs{nameref} plazierten Referenzen auf die Beschriftung der Abbildung +bzw.~Tabelle verweisen, auf "`|figure|"' gesetzt auf den Inhalt der Abbildung. +(Die Vorbelegung ist |FP|\-|ref=|\x|figure|.) \end{description} -If you want to setup special options for the |FPfigure| \& |FPtable| -environments you can use +Spezielle Einstellungen für die Umgebungen |FPfigure| und |FPtable| können mit \begin{quote} - |\captionsetup[FPfigure]|\marg{options}\\ - |\captionsetup[FPtable]|\marg{options}\quad. + |\captionsetup[FPfigure]|\marg{Optionen}\quad\emph{und}\\ + |\captionsetup[FPtable]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|figure| or |table|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. -Furthermore \cs{DeclareCaptionType}\marg{name} will also define -an environment called |FP|\meta{name} which behaves like |FPfigure| and -|FPtable|. +Weiterhin definiert |\Declare|\-|Caption|\-|Type|\marg{Name} auch automatisch +eine Umgebung namens "`|FP|\meta{Name}"', die sich wie |FP|\-|figure| und +|FP|\-|table| verhält. \pagebreak[3] \subsection{hyperref} \label{hyperref} \packagedescription{% -The hyperref package\cite{hyperref} is used to handle cross-referencing -commands in LaTeX to produce hypertext links in the document.} +Das \package{hyperref}"=Paket\cite{hyperref} behandelt \LaTeX"=Querverweise +derart, daß sie zusätzlich Hyperlinks im Dokument erzeugen.} \NEWfeature{v3.1} -There are two options available to control the placement of hyperlink -anchors:~\footnote{These options are named after the \package{hypcap} package -which they supersede.} -%Zwei Optionen regeln das Setzen von Hyperlinks: +Zwei Optionen regeln das Setzen von Hyperlinks:~\footnote{Diese Optionen sind +nach dem \package{hypcap}"=Paket benannt, welches sie ersetzen.} \begin{description} -\item{\texttt{hypcap=true} or \texttt{hypcap=false}}\\[\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 (usually) placed at the caption.\par -(The default setting is |hypcap=|\x|true|.) -%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=}\meta{amount}}\\[\smallskipamount] -Because it looks poor if the hyperlink points exactly at the top of -the figure or table, you can specify a vertical distance between -the hyperlink anchor and the (floating) environment itself, -e.g.~|hyp|\-|cap|\-|space=|\x|0pt| removes this distance.\par -(The default setting is |hyp|\-|cap|\-|space=|\x|0.5\base|\-|line|\-|skip|.) -%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|.) +\item{\texttt{hypcap=true} oder \texttt{hypcap=false}}\\[\smallskipamount] +Auf |true| gesetzt, werden alle Hyperlink"=Anker -- wohin Einträge im +Abbildungs- und Tabellenverzeichnis, sowie |\ref| und |\auto|\-|ref| +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=}\meta{Abstand}}\\[\smallskipamount] +Da es nicht sehr ästhetisch wirkt, wenn der Hyperlink exakt auf den Beginn der +Abbildung bzw.~Tabelle springt, kann ein vertikaler Abstand zwischen dem +Hyperlink"=Anker und der (gleitenden) Umgebung gesetzt werden, z.B.~entfernt +|hyp|\-|cap|\-|space=|\x|0pt| diesen Abstand.\par +(Die Voreinstellung ist |hyp|\-|cap|\-|space=|\x|0.5\base|\-|line|\-|skip|.) \end{description} -Both settings have no effect in |lst|\-|listing|s (provided by the -\package{listings} package), |long|\-|table|s (provided by the -\package{longtable} package), and |super|\-|tabular|s (provided by the -\package{supertabular} package), within these environments hyperlink -anchors will always be placed as if |hyp|\-|cap=|\x|true| \& -|hyp|\-|cap|\-|space=|\x|0pt| would be set. +Beide Optionen haben keine Auswirkung in den Umgebungen |lst|\-|listing| +(vom \package{listings}"=Paket bereitgestellt), |long|\-|table| (vom +\package{longtable}"=Paket bereitgestellt, |super|\-|tabular| (vom +\package{supertabular}"=Paket bereitgestellt), und |x|\-|tabular| (vom +\package{xtab}"=Paket bereitgestellt); +innerhalb dieser Umgebungen werden Hyperlink"=Anker immer so gesetzt, als sei +|hyp|\-|cap=|\x|true| und |hyp|\-|cap|\-|space=|\x|0pt| eingestellt. -\pagebreak[3]Please note:\nopagebreak -%Bitte beachten Sie: +\pagebreak[3]Bitte beachten Sie:\nopagebreak \begin{description} -\item{\cs{captionof}\marg{type}\csmarg{\purerm\ldots} - vs.~\cs{captionsetup}\csmarg{type=\textrm{\meta{type}}}$+$\cs{caption}\csmarg{\purerm\ldots}}% -Without \package{hyperref} loaded, both will give you identical results. -But with \package{hyperref} loaded, and with |hyp|\-|cap=|\x|true| requested, -the hyperlink anchor will be placed different. -For example: -%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. +\item{\cs{captionof}\marg{Typ}\csmarg{\purerm\ldots} + vs.~\cs{captionsetup}\csmarg{type=\textrm{\meta{Typ}}}$+$\cs{caption}\csmarg{\purerm\ldots}}% +\\[\smallskipamount] +Ohne geladenes \package{hyperref}"=Paket bekommen Sie hier identische Resultate. +Aber mit \package{hyperref} geladen und mit der Einstellung |hyp|\-|cap=|\x|true| +versehen wird der Hyperlink"=Anker unterschiedlich gesetzt. +So plaziert zum Beispiel \begin{quote} |\begin{minipage}{\linewidth}|\\ | |\ldots\\ -| \captionof{figure}{A figure}|\\ +| \captionof{figure}{Eine Abbildung}|\\ |\end{minipage}| \end{quote} -will place the hyperlink anchor at the caption. -(And if |hypcap=|\x|true| is set, you will get a warning about this.) -But -%den Anker bei der Beschriftung. -%(Und wenn |hypcap=true| gesetzt ist, wird eine Warnung deswegen ausgegeben.) +den Anker bei der Beschriftung. +(Und wenn |hyp|\-|cap=|\x|true| gesetzt ist, wird deswegen eine Warnung ausgegeben.) \begin{quote} |\begin{minipage}{\linewidth}|\\ | \captionsetup{type=figure}|\\ | |\ldots\\ -| \caption{A figure}|\\ +| \caption{Eine Abbildung}|\\ |\end{minipage}| \end{quote} -will place the hyperlink anchor at the beginning of the |minipage|, -since |\caption|\-|setup{type=|\x|figure}| does not only set the caption type -to ``figure'' but does place a hyperlink anchor, too. -%hingegen plaziert den Anker an den Anfang der |minipage|. +hingegen plaziert den Anker an den Anfang der |mini|\-|page|, +da die Anweisung |\caption|\-|setup{type=|\x|figure}| nicht nur den Typ der +Beschriftung auf "`figure"' festlegt, sondern auch einen Hyperlink"=Anker setzt. \item{\cs{caption}\csoarg{}\csmarg{\purerm\ldots} vs.~\cs{captionsetup}\csmarg{list=false}$+$\cs{caption}\csmarg{\purerm\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{list=false} if you don't -want an entry in the List of Figures or List of Tables. -%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{list=false} zu verwenden, -%wenn Sie keinen Eintrag in dem Abbildungs- oder Tabellenverzeichnis wünschen. +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 |\caption| auch in die |aux|-Datei +geschrieben und vom |\name|\-|ref| Befehl verwendet. +Wenn Sie also |\caption| mit leerem Argument angeben, wird ein auf diese +Abbildung oder Tabelle angewandtes |\name|\-|ref| nicht das erwünschte, +sondern stattdessen ein leeres Resultat zur Folge haben. +Daher ist es besser, |\caption|\-|setup{list=|\x|false}| zu verwenden, +wenn Sie keinen Eintrag in dem Abbildungs- oder Tabellenverzeichnis wünschen. \end{description} \pagebreak[3] \subsection{hypcap} \label{hypcap} \packagedescription{% -The \package{hypcap} package\cite{hypcap} offers a solution to the problem -that links to a float using \package{hyperref} may anchors to the caption -rather than the beginning of the float. -Since \thispackage\ \version{3.1} already solves this problem for itself, -the \package{hypcap} package is usually not needed, at least when you use -\thispackage.} - -If the \package{hypcap} package is loaded additionally to the \package{hyperref} -package, it takes over the control of the hyperlink anchor placement from -\thispackage, overriding the options |hyp|\-|cap=| \& |hyp|\-|cap|\-|space=|. -%Wird das \package{hypcap}"=Paket zusätzlich zum \package{hyperref}"=Paket -%geladen, so übernimmt es die Kontrolle über die Platzierung der Hyperlink"=Anker. - -So for a manual placement of hyperlink anchors -|\caption|\-|setup{type=|\x\meta{type}|}| is not sufficient anymore, -instead you need to use |\cap|\-|start| (provided by the \package{hypcap} -package) for this. -%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. - -Regarding the automatically placement the \package{hypcap} package offers good -placement of hyperlink anchors for the floating environments |figure| and -|table| only. In contrast the |hypcap=true| option of \thispackage\ also -offers good placements of hyperlink anchors for -|floatingfigure|s (provided by the \package{floatflt} package), -|FPfigure|s \& |FPtable|s (provided by the \package{fltpage} package), -|figwindow|s (provided by the \package{picinpar} package), -|parpic|s (provided by the \package{picins} package), -|SCfigure|s (provided by the \package{sidecap} package), -|threeparttable|s (provided by the \package{threeparttable} package), -and |wrapfigure|s (provided by the \package{wrapfig} package).%---% -%so by loading the \package{hypcap} package additionally you will -%loose that. -%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. +Das \package{hyp\-cap}"=Paket\cite{hypcap} bietet eine Lösung zu dem Problem +an, daß Hyperlinks auf Gleitumgebungen nicht auf die Abbildung bzw.~Tabelle +verweisen, sondern stattdessen auf die Beschriftung. +Die Version $3.1$ des \package{caption}"=Paketes löst dieses Problem bereits +auf seine eigene Art und Weise, so daß das \package{hypcap}"=Paket in der +Regel nicht mehr zusätzlich benötigt wird.} + +Wird das \package{hypcap}"=Paket zusätzlich zum \package{hyperref}"=Paket +geladen, so übernimmt es die Kontrolle über die Platzierung der +Hyperlink"=Anker, und die Optionen |hyp|\-|cap=| und |hyp|\-|cap|\-|space=| +verlieren ihre Wirkung. + +Außerdem ist zu beachten, daß dann |\caption|\-|setup{type=|\x\meta{Typ}|}| +keinen Hyperlink"=Anker mehr setzt; dies muß dann ggf.~mit dem Befehl +|\cap|\-|start|, welcher vom \package{hypcap}"=Paket angeboten wird, +geschehen. + +Weiterhin hat das Laden des \package{hypcap}"=Paketes den Nebeneffekt, daß +die Hyperlink"=Anker innerhalb der Umgebungen +|floating|\-|figure| (vom \package{float\-flt}"=Paket bereitgestellt), +|FP|\-|figure| \& |FPtable| (vom \package{flt\-page}"=Paket bereitgestellt), +|fig|\-|window| (vom \package{pic\-in\-par}"=Paket bereitgestellt), +|par|\-|pic| (vom \package{pic\-ins}"=Paket bereitgestellt), +|SC|\-|figure| (vom \package{side\-cap}"=Paket bereitgestellt), +|three|\-|part|\-|table| (vom \package{three\-part\-table}"=Paket +bereitgestellt) und |wrap|\-|figure| (vom \package{wrap\-fig}"=Paket +bereitgestellt) nicht mehr optimal platziert werden. \pagebreak[3] \subsection{listings} \label{listings} \packagedescription{% -The \package{listings} package\cite{listings} typesets programming code.} +Das \package{listings}"=Paket\cite{listings} bietet Möglichkeiten, +Programmcode zu setzen.} -If you want to setup special options for the |lstlinsting| environment -you can use +Spezielle Einstellungen für die Umgebung |lst|\-|listing| können mit \begin{quote} - |\captionsetup[lstlisting]|\marg{options}\quad. + |\captionsetup[lstlisting]|\marg{Optionen} \end{quote} +getätigt werden. -Please note that the \package{listings} package has its very own options -for controlling the position and the skips of the caption: -|caption|\-|pos=|, |above|\-|caption|\-|skip=| \& |below|\-|caption|\-|skip=|. -\See{\package{listings} documentation for details.} -These \package{listings} options override the \package{caption}'s ones, but -can be again overwritten by |\caption|\-|setup[lst|\-|listing]{|\ldots|}|, -e.g.~|\caption|\-|setup[lst|\-|listing]{skip=|\x|10pt}|. +Bitte beachten Sie, daß das \package{listings}"=Paket seine eigenen +Optionen für die Kontrolle der Position und Abstände der Beschriftungen +mitbringt: +|caption|\-|pos=|, |above|\-|caption|\-|skip=| und |below|\-|caption|\-|skip=|. +\See{Dokumentation des \package{listings}"=Paketes.} +Diese Optionen überschreiben diejenigen des \package{caption}"=Paketes, +können aber wiederum mit |\caption|\-|setup[lst|\-|listing]{|\ldots|}| +überschrieben werden, z.B.~mit +\begin{quote}|\caption|\-|setup[lst|\-|listing]{skip=|\x|10pt}|\quad.\end{quote} \pagebreak[3] \subsection{longtable} \label{longtable} \packagedescription{% -The \package{longtable} package\cite{longtable} offers an environment -which behaves similar to the |tabular| environment, but the table -itself can span multiple pages.} +Das \package{longtable}"=Paket\cite{longtable} bietet eine Umgebung an, +die sich ähnlich wie die Umgebung \texttt{tabular} verhält, aber Seitenumbrüche +innerhalb der Tabelle erlaubt.} -If you want to setup special options for the |longtable| environment -you can use +Spezielle Einstellungen für die Umgebung |long|\-|table| können mit \begin{quote} - |\captionsetup[longtable]|\marg{options}\quad. + |\captionsetup[longtable]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|table|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |table| +berücksichtigt. -The |margin| \& |width| settings usually override |\LT|\-|cap|\-|width|, so -you get an equal look \& feel of the captions in |table|s and |long|\-|table|s. -But if you set |\LT|\-|cap|\-|width| to a value different than its default -$=$ |4in|, \thispackage\ will follow that. -(But |\LT|\-|cap|\-|width| will be overwritten by -|\caption|\-|setup[long|\-|table]{width=|\x\meta{value}|}|, -even if it is set to a value different than |4in|.) +Die Optionen |margin=| und |width=| überschreiben gewöhnlich die Länge +|\LT|\-|cap|\-|width|, so daß ein einheitliches Aussehen der +Tabellenüberschriften gewährleistet wird. +Wird aber |\LT|\-|cap|\-|width| auf einen anderen Wert als den Standardwert +|4in| gesetzt, wird \thispackage\ dies berücksichtigen. +(Aber |\LT|\-|cap|\-|width| wird wiederum von +|\caption|\-|setup[long|\-|table]{width=|\x\meta{Breite}|}| überschrieben, +auch wenn |\LT|\-|cap|\-|width| auf einen anderen Wert als |4in| gesetzt ist.) \begin{Note} -|\caption|\-|of| and |\Continued|\-|Float| do not work for |long|\-|table|s. -Furthermore neither |\caption| nor |\caption|\-|list|\-|entry| will increment -the |table| counter here; it's incremented by the |long|\-|table| environment -instead. +Die Befehle |\caption|\-|of| und |\Continued|\-|Float| funktionieren +\emph{nicht} innerhalb der Umgebung |long|\-|table|. +Weiterhin erhöhen weder |\caption| noch |\caption|\-|list|\-|entry| den +Tabellenzähler, er wird stattdessen von der Umgebung |long|\-|table| selbst +erhöht. \NEWfeature{v3.1} -If you need a |long|\-|table| which does \emph{not} increment the |table| -counter please use the |long|\-|table*| environment (offered by the -\package{ltcaption} package which is part of \thispackage\ bundle and will be -loaded automatically). +Benötigen Sie eine Umgebung |long|\-|table|, die den Tabellenzähler +nicht erhöht, so verwenden Sie bitte die Umgebung |long|\-|table*| +(die das \package{ltcaption}"=Paket bereitstellt und als Bestandteil der +\package{caption}"=Paketfamilie automatisch geladen wird). \end{Note} \pagebreak[3] \subsection{picinpar} \label{picinpar} \packagedescription{% -Similar to the \package{floatflt} package the \package{picinpar} -package\cite{picinpar} offers figures and tables which do not span the full -width of a page and are float around by text. -For a detailed discussion about the differences between these packages -please take a look at The \LaTeX\ Companion\cite{TLC2}.} +Ähnlich wie das \package{floatflt}"=Paket stellt auch das +\package{picinpar}"=Paket Umgebungen zum Setzen von Abbildungen und Tabellen +zur Verfügung, die nicht die gesamte Seitenbreite ausfüllen und vom Text +umflossen werden. +Für eine detailierte Beschreibung der Unterschiede zwischen diesen Paketen +schauen Sie bitte in den "`LaTeX Begleiter"'\cite{TLC2}.} \NEWfeature{v3.1} -If you want to setup special options for the |figwindow| \& |tabwindow| -environments you can use +Spezielle Einstellungen für die Umgebungen |fig|\-|window| und |tab|\-|window| +können mit \begin{quote} - |\captionsetup[figwindow]|\marg{options}\\ - |\captionsetup[tabwindow]|\marg{options}\quad. + |\captionsetup[figwindow]|\marg{Optionen}\quad\emph{und}\\ + |\captionsetup[tabwindow]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|figure| or |table|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures \& tables, -unless you set it explicit with |\caption|\-|setup[fig|\-|window]{|\ldots|}| or -|\caption|\-|setup[fig|\-|table]{|\ldots|}|. +Die Einstellungen |margin=| bzw.~|width=| werden nicht auf diese Abbildungen +bzw.~Tabellen angewandt, solange sie nicht explizit mit +|\caption|\-|setup[fig|\-|window]{|\ldots|}| +bzw.~|\caption|\-|setup[tab|\-|window]{|\ldots|}| gesetzt werden. \end{Note} \pagebreak[3] \subsection{picins} \label{picins} \packagedescription{% -Similar to the \package{floatflt} and \package{picinpar} package the -\package{picins} package\cite{picins} offers figures and tables which do not -span the full width of a page and are float around by text. -For a detailed discussion about the differences between these packages -please take a look at The \LaTeX\ Companion\cite{TLC2}.} +Ähnlich wie das \package{floatflt}- und \package{picinpar}"=Paket stellt auch +das \package{picins}"=Paket Umgebungen zum Setzen von Abbildungen und +Tabellen zur Verfügung, die nicht die gesamte Seitenbreite ausfüllen und vom +Text umflossen werden. +Für eine detailierte Beschreibung der Unterschiede zwischen diesen Paketen +schauen Sie bitte in den "`LaTeX Begleiter"'\cite{TLC2}.} \NEWfeature{v3.1} -If you want to setup special options for the |parpic| environment you can use +Spezielle Einstellungen für die Umgebung |par|\-|pic| können mit \begin{quote} - |\captionsetup[parpic]|\marg{options}\quad. + |\captionsetup[parpic]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|figure| or |table|.\par -Furthermore |\piccaption[]{|\ldots|}| produce no entry in the List of Figures, -and |\piccaption*{|\ldots|}| gives an unlabeled \& unnumbered caption. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. + +Weiterhin erzeugt |\pic|\-|caption[]{|\ldots|}| keinen Verzeichniseintrag, +und |\pic|\-|caption*{|\ldots|}| ergibt eine Beschriftung ohne Bezeichner und +Nummerierung. \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures \& tables. -\iffalse -if |pic|\-|caption|\-|side| or |pic|\-|caption|\-|top|\-|side| is used. -The |width| setting will not be used (but the |margin| setting will) if -|pic|\-|caption|\-|out|\-|side| or |pic|\-|caption|\-|in|\-|side| is used. -\fi -But you can override this by setting it explicit with -|\caption|\-|setup[par|\-|pic]{|\ldots|}|. +Die Einstellungen |margin=| bzw.~|width=| werden nicht auf diese Abbildungen +bzw.~Tabellen angewandt, solange sie nicht explizit mit +|\caption|\-|setup[par|\-|pic]{|\ldots|}| gesetzt werden. \end{Note} -\begin{Note} -If you want to have a |\pic|\-|caption| of another type as |figure|, please -do \emph{not} re-define |\@cap|\-|type| as suggested by the \package{picins} -documentation. Please use the |\pic|\-|caption|\-|type|\marg{type} command -which is offered by \thispackage\ instead, e.g.: +Wird ein |\pic|\-|caption| gewünscht, das keine Abbildungs-, sondern eine +Tabellenbeschrifung erzeugt, so definieren Sie bitte \emph{nicht} +|\@cap|\-|type| um, wie es von der Dokumentation zum \package{picins}"=Paket +vorgeschlagen wird. Stattdessen benutzen Sie bitte den Befehl +|\pic|\-|caption|\-|type|\marg{Typ}, der Ihnen vom \package{caption}"=Paket +zu diesem Zweck bereitgestellt wird. Zum Beispiel: \begin{quote} |\piccaptiontype{table}|\\ - |\piccaption{An example table}|\\ + |\piccaption{Eine Beispieltabelle}|\\ |\parpic(50mm,10mm)[s]{|\ldots|}| \end{quote} -\end{Note} \pagebreak[3] \subsection{rotating} \label{rotating} \packagedescription{% -The \package{rotating} package\cite{rotating} offers the floating -environments \texttt{side\-ways\-figure} and \texttt{side\-ways\-table} -which are just like normal figures and tables but rotated by 90 degree. -Furthermore a command \cs{rotcaption} is offered for rotated captions only.} +Das \package{rotating}"=Paket\cite{rotating} bietet die Gleitumgebungen +\texttt{side\-ways\-figure} und \texttt{side\-ways\-table}, +die sich wie \texttt{figure} und \texttt{table} verhalten, den Inhalt aber +um 90 bzw. 270 Grad drehen. +Weiterhin wird ein Befehl \cs{rot\-caption} bereitgestellt, der lediglich +die Beschriftung dreht.} \iffalse % No, we don't do that If you want to setup special options for the |side|\-|ways|\-|figure| \& @@ -3176,471 +3160,226 @@ These options will be executed additionally to the regular ones for |figure| or |table|. \fi -The command |\rot|\-|caption| will be extended by \thispackage, so -|\rot|\-|caption*| or |\rot|\-|caption|\-|of| can be used analogous to -|\caption| and |\caption|\-|of|. +Der Befehl |\rot|\-|caption| wird vom \package{caption}"=Paket derart +erweitert, daß |\rot|\-|caption*| und |\rot|\-|caption|\-|of| analog zu +|\caption*| und |\caption|\-|of| verwendet werden können. \NEWfeature{v3.1} -Furthermore |\Declare|\-|Caption|\-|Type|\marg{name} will also define -an environment called |side|\-|ways|\meta{name} which behaves like -|side|\-|ways|\-|figure| and |side|\-|ways|\-|table|. +Weiterhin definiert |\Declare|\-|Caption|\-|Type|\marg{Name} automatisch +zusätzlich eine Gleitumgebung, die sich wie |side|\-|ways|\-|figure| und +|side|\-|ways|\-|table| verhält. \pagebreak[3] \subsection{setspace} \label{setspace} \packagedescription{% -The \package{setspace} package\cite{setspace} offers options and commands -to change the spacing, -e.g.\ \cs{usepackage}\x\csoarg{one\x half\x spacing}\x\csmarg{set\x space} -causes the document to be typeset in one-and-a-half spacing.} - -If the \package{setspace} package is used in conjunction with \thispackage, -the caption will be typeset with single spacing as default. This can be changed -by specifying either |font=|\x|one|\-|half|\-|spacing|, -|font=|\x|double|\-|spacing|, or |font={stretch=|\x\meta{amount}|}|. -\See{\Ref{fonts}} +Das \package{setspace}"=Paket\cite{setspace} bietet Optionen und Befehle, +um den Zeilenabstand festzulegen, so führt +z.B.\ \cs{usepackage}\x\csoarg{one\-half\-spacing}\x\csmarg{set\-space} +zu einem Dokument, welches einanhalbzeilig gesetzt wird.} + +Wird das \package{setspace}"=Paket zusammen mit dem \package{caption}"=Paket +verwendet, sind alle Abbildungs- und Tabellenbeschriftungen auf "`einzeilig"' +voreingestellt. Dies kann durch |font=|\x|one|\-|half|\-|spacing| (welches +auf "`einanhalbzeilig"' umstellt), |font=|\x|double|\-|spacing| (welches +auf "`zweizeilig"' umstellt) oder |font={stretch=|\x\meta{Wert}|}| geändert +werden. +\See{auch \Ref{fonts}} \pagebreak[3] \subsection{sidecap} \label{sidecap} \packagedescription{% -The \package{sidecap} package\cite{sidecap} offers the floating -environments |SCfigure| and |SCtable| which are like usual figures -and tables but the caption will be put \emph{beside} the contents.} +Das \package{sidecap}"=Paket\cite{sidecap} bietet die Gleitumgebungen +\texttt{SC\-figure} und \texttt{SC\-table}, die anders als \texttt{figure} +und \texttt{table} die Beschriftung \emph{neben} den Inhalt setzen.} -If you want to setup special options for the |SCfigure| \& |SCtable| -environments you can use +Spezielle Einstellungen für die Umgebungen |SC|\-|figure| und |SC|\-|table| +können mit \begin{quote} - |\captionsetup[SCfigure]|\marg{options}\\ - |\captionsetup[SCtable]|\marg{options}\quad. + |\captionsetup[SCfigure]|\marg{Optionen}\quad\emph{und}\\ + |\captionsetup[SCtable]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|figure| or |table|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. \pagebreak[3] \NEWfeature{v3.1} -Furthermore \cs{DeclareCaptionType}\marg{name} will also define -an environment called |SC|\meta{name} which behaves like |SCfigure| and -|SCtable|. +Weiterhin definiert |\Declare|\-|Caption|\-|Type|\marg{Name} automatisch +zusätzlich eine Gleitumgebung, die sich wie |SC|\-|figure| und |SC|\-|table| +verhält. \begin{Note} -The \package{sidecap} package offers its own options for justification. -If set, they will override the one specified with the caption option -|justification=| for captions beside their contents. +Das \package{sidecap}"=Paket bietet eigene Optionen für die Ausrichtung der +Beschriftung. Werden diese verwendet, so überschreiben sie die Einstellungen, +die mit der Option |jus|\-|ti|\-|fi|\-|ca|\-|tion=| getätigt worden sind. \end{Note} \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures \& tables, -unless you set it explicit with |\caption|\-|setup[SC|\-|figure]{|\ldots|}| -or |\caption|\-|setup[SC|\-|table]{|\ldots|}|. +Die Einstellungen |margin=| bzw.~|width=| werden nicht auf diese Abbildungen +bzw.~Tabellen angewandt, solange sie nicht explizit mit +|\caption|\-|setup[SC|\-|figure]{|\ldots|}| +bzw.~|\caption|\-|setup[SC|\-|table]{|\ldots|}| gesetzt werden. \end{Note} \medskip \begin{Annotation*} -Instead of using the \package{sidecap} package you can also use -the more powerful \package{floatrow} package\cite{floatrow} for this purpose. +Anstelle des \package{sidecap}"=Paketes können Sie für Beschrifungen neben der +Abbildung bzw.~Tabelle auch das leistungsfähigere und vielseitigere +\package{floatrow}"=Paket\cite{floatrow} benutzen. \end{Annotation*} \pagebreak[3] -\subsubsection*{Undocumented features} -The \package{sidecap} package \version{1.6} has some undocumented package -options and commands which allow further customization of the side-captions: +\subsubsection*{Undokumentierte Eigenschaften} +Das \package{sidecap}"=Paket \version{1.6} hat einige undokumentierte +Paketoptionen und Befehle, die eine weitere Anpassung der Beschrifungen erlauben: \pagebreak[3] \DescribeMacro{margincaption} -The package option +Die Paketoption \begin{quote} - |margincaption|\qquad{\small(e.g.~|\usepackage[margincaption]{sidecap}|)} + |margincaption|\qquad{\small(z.B.~|\usepackage[margincaption]{sidecap}|)} \end{quote} -causes all side-captions to be placed into the margin. +führt dazu, daß alle Beschriftungen in den Umgebungen |SC|\-|figure| und +|SC|\-|table| in den Rand gesetzt werden. \pagebreak[3] \DescribeMacro{\sidecaptionvpos} -The command +Der Befehl \begin{quote} - |\sidecaptionvpos|\marg{float type}\marg{pos} + |\sidecaptionvpos|\marg{Typ}\marg{Position} \end{quote} -sets the vertical position of the side-caption. \meta{pos} can be either `|t|' -(for top alignment), `|b|' (for bottom alignment), or `|c|' (for center alignment). -The default setting for |table| is `|t|', for |figure| and all other ones -defined with |\Declare|\-|Caption|\-|Type| it's `|b|'. +legt die vertikale Ausrichtung der Beschriftung fest. \meta{Position} kann +entweder `|t|' (für eine Ausrichtung am oberen Rand), `|b|' (für eine +Ausrichtung am unteren Rand), oder `|c|' (für eine zentrierte Ausrichtung) +sein. +Die Vorbelegung für die Umgebung |table| ist `|t|', für |figure| und alle +anderen, die mit |\Declare|\-|Caption|\-|Type| definiert werden, `|b|'. \pagebreak[3] \subsection{subfigure} \label{subfigure} \packagedescription{% -The \package{subfigure} package\cite{subfigure} provides support for small or -`sub' figures and tables within a single figure or table environment. -This package is obsolete, new users should use \package{subfig} instead.} +Das \package{subfigure}"=Paket\cite{subfigure} bietet Unterstützung für +Unter"=Abbildungen und -Tabellen. +Es ist veraltet und wurde vom Autor durch das modernere +\package{subfig}"=Paket ersetzt.} -Since the \package{subfigure} package is obsolete it will only be supported in -a way that old documents (which have used \thispackage\ \version{1.x} during -development) should still compile as expected. +Da das \package{subfigure}"=Paket veraltet ist, wird es nur derart vom +\package{caption}"=Paket unterstützt, daß alte Dokumente (welche mit dem +\package{caption}"=Paket \version{1.x} gesetzt wurden) noch übersetzbar sind +und das erwartete Ergebnis liefern. -Please use the \package{subfig} package instead with supports \thispackage\ -\version{3.x}. +Bitte verwenden Sie daher stattdessen das \package{subfig}"=Paket, welches +\thispackage\ \version{3.x} aktiv unterstützt. -\See{the \package{subfig} package\cite{subfig} documentation for details.} +\See{auch Dokumentation des \package{subfig}"=Paketes\cite{subfig}} \pagebreak[3] -\subsection{supertabular} +\subsection{supertabular und xtab} \label{supertabular} \packagedescription{% -The \package{supertabular} package\cite{supertabular} offers an environment -which is quite similar to the |longtable| environment provided -by the \package{longtable} package\cite{longtable}: -Both offers the typesetting of tables which can span multiple pages. -For a detailed discussion about the differences between these two powerful -packages please take a look at The \LaTeX\ Companion\cite{TLC2}.} +Die Pakete \package{supertabular}\cite{supertabular} und \package{xtab}\cite{xtab} +bieten eine Umgebung, die ähnlich wie die Umgebung \texttt{long\-table} des +\package{longtable}"=Paketes\cite{longtable} einen Seitenumbruch inmitten der +Tabelle erlaubt. +Für eine detailierte Beschreibung der Unterschiede zwischen diesen Paketen +schauen Sie bitte in den "`LaTeX Begleiter"'\cite{TLC2}.} -If you want to setup special options for the |super|\-|tabular| environment -you can use +Spezielle Einstellungen für die Umgebung |super|\-|tabular| bzw.~|x|\-|tabular| +können mit \begin{quote} - |\captionsetup[supertabular]|\marg{options}\quad. + |\captionsetup[supertabular]|\marg{Optionen}\quad\emph{bzw.}\\ + |\captionsetup[xtabular]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|table|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |table| +berücksichtigt. \begin{Note} -|\Continued|\-|Float| does not work for |super|\-|tabular|s. +Der Befehl |\Continued|\-|Float| funktioniert \emph{nicht} innerhalb der +Umgebungen |super|\-|tabular| und |x|\-|tabular|. \end{Note} \pagebreak[3] \subsection{threeparttable} \label{threeparttable} \packagedescription{% -Provides a scheme for tables that have a structured note section after the -table contents and the caption. -This scheme provides an answer to the old problem of putting footnotes in -tables---by making footnotes entirely unnecessary.} +Das \package{threeparttable}"=Paket\cite{threeparttable} bietet ein Schema +für Tabellen, welches strukturierte Anmerkungen nach dem Tabelleninhalt +erlaubt. +Dieses Schema bietet eine Lösungsmöglichkeit für das alte Problem "`Fußnoten +in Tabellen"'.} \NEWfeature{v3.1} -If you want to setup special options for the |three|\-|part|\-|table| \& -|measured|\-|figure| environments you can use +Spezielle Einstellungen für die Umgebungen |three|\-|part|\-|table| und +|measured|\-|figure| können mit \begin{quote} - |\captionsetup[threeparttable]|\marg{options}\\ - |\captionsetup[measuredfigure]|\marg{options}\quad. + |\captionsetup[threeparttable]|\marg{Optionen}\quad\emph{und}\\ + |\captionsetup[measuredfigure]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|table| or |figure|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. \begin{Note} -Since the caption will have the same width as the contents here, -the |margin| resp.~|width| setting will not be used for these figures \& tables, -at least unless you set it explicit with -|\caption|\-|setup[three|\-|part|\-|table]{|\ldots|}| or -|\caption|\-|setup[measured|\-|figure]{|\ldots|}|. +Da die Breite der Beschriftung hier die gleiche Breite wie die Abbildung +bzw.~Tabelle hat, werden die Einstellungen |margin=| bzw.~|width=| hier nicht +angewandt, solange sie nicht explizit mit +|\caption|\-|setup[three|\-|part|\-|table]{|\ldots|}| oder +|\caption|\-|setup[measured|\-|figure]{|\ldots|}| gesetzt werden. \end{Note} \medskip \begin{Annotation*} -Instead of using the \package{threeparttable} package you can -also use the \package{floatrow} package\cite{floatrow} for this purpose. +Das \package{floatrow}"=Paket\cite{floatrow} bietet eine vergleichbare +Funktionalität an. \end{Annotation*} \pagebreak[3] \subsection{wrapfig} \label{wrapfig} \packagedescription{% -Similar to the \package{floatflt}, the \package{picinpar}, and the -\package{picins} package the \package{wrapfig} package\cite{wrapfig} offers -figures and tables which do not span the full width of a page and are float -around by text. -For a detailed discussion about the differences between these packages -please take a look at The \LaTeX\ Companion\cite{TLC2}.} +Ähnlich wie das \package{floatflt}-, \package{picinpar}- und +\package{picins}"=Paket stellt auch das \package{wrapfig}"=Paket Umgebungen +zum Setzen von Abbildungen und Tabellen zur Verfügung, die nicht die gesamte +Seitenbreite ausfüllen und vom Text umflossen werden. +Für eine detailierte Beschreibung der Unterschiede zwischen diesen Paketen +schauen Sie bitte in den "`LaTeX Begleiter"'\cite{TLC2}.} \NEWfeature{v3.1} -If you want to setup special options for the |wrapfigure| \& |wraptable| -environments you can use +Spezielle Einstellungen für die Umgebungen |wrap|\-|figure| und +|wrap|\-|table| können mit \begin{quote} - |\captionsetup[wrapfigure]|\marg{options}\\ - |\captionsetup[wraptable]|\marg{options}\quad. + |\captionsetup[wrapfigure]|\marg{Optionen}\quad\emph{und}\\ + |\captionsetup[wraptable]|\marg{Optionen} \end{quote} -These options will be executed additionally to the regular ones for -|figure| or |table|. +getätigt werden. +Diese Einstellungen werden dann zusätzlich zu denjenigen für |figure| +bzw.~|table| berücksichtigt. -Furthermore \cs{DeclareCaptionType}\marg{name} will also define -an environment called |wrap|\meta{name} which behaves like |wrapfigure| and -|wraptable|. +Weiterhin definiert |\Declare|\-|Caption|\-|Type|\marg{Name} automatisch +zusätzlich eine Gleitumgebung, die sich wie |wrap|\-|figure| und +|wrap|\-|table| verhält. \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures \& tables, -unless you set it explicit with |\caption|\-|setup[wrap|\-|figure]{|\ldots|}| -or |\caption|\-|setup[wrap|\-|table]{|\ldots|}|. +Die Einstellungen |margin=| bzw.~|width=| werden nicht auf diese Abbildungen +bzw.~Tabellen angewandt, solange sie nicht explizit mit +|\caption|\-|setup[wrap|\-|figure]{|\ldots|}| +bzw.~|\caption|\-|setup[wrap|\-|table]{|\ldots|}| gesetzt werden. \end{Note} \begin{Note} -If the \package{wrapfig} package should be used in coorperation with the -\package{float} package, it needs to be loaded \emph{after} the -\package{float} package. Furthermore \cs{newfloat} or \cs{restylefloat} -commands \emph{must} be placed after \emph{both} packages have been loaded. +Soll das \package{wrapfig}"=Paket in Zusammenarbeit mit dem +\package{float}"=Paket verwendet werden, ist es wichtig, daß Sie das +\package{wrapfig}"=Paket \emph{nach} dem \package{float}"=Paket laden. +Weiterhin müssen die Befehle |\new|\-|float| und |\restyle|\-|float| +\emph{nach} dem Laden beider Pakete angewandt werden. \end{Note} -\else - -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% -%*****************************************************************************% - -\beginTODO - -\section{Dokumentenklassen \& Babel-Unterstützung} -\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 erhalten -Sie in einem solchen Fall keinen Support. - -{\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|\x|[style=base]|\x|{caption}| oder - |\captionsetup|\x|{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 \& 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{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|\x|{caption}|\x\marg{options} und -|\setbeamerfont|\x|{caption name}|\x\marg{options} vorgenommen werden. -Dies wird auch mit dem \package{caption}"=Paket noch funktionieren, zumindest -solange Sie keinen anderen Zeichensatz mit -|\captionsetup|\x|{font=|\x\meta{options}|}| oder -|\captionsetup|\x|{labelfont=|\x\meta{options}|}| einstellen.\par -Weiterhin bietet die \package{beamer}"=Klasse verschiedene "`Templates"' für -die Beschriftungen an, diese können mit -|\set|\-|beamter|\-|template|\x|{caption}|\x|[|\meta{template}|]| -ausgewählt werden. -Da \thispackage\ diesen Mechanismus ersetzt, haben -|\def|\-|beamer|\-|template*|\x|{caption}|\x\marg{template code} -und -|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{template}|]| -keine Funktion mehr, wenn \thispackage\ verwendet wird. - -\subsection{\KOMAScript: scrartcl, scrreprt \& 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 \& 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. - -% --------------------------------------------------------------------------- % - -\pagebreak[4] -\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{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{list=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 |\name|\-|ref| Befehl verwendet. -Wenn Sie also |\caption| mit leerem Argument angeben, wird ein auf diese -Abbildung oder Tabelle angewandtes |\name|\-|ref| nicht das erwünschte, -nämlich ein leeres Resultat zur Folge haben. -Daher ist es besser |\caption|\-|setup{list=|\x|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 -|float|\-|ing|\-|figure| (vom \package{floatflt}"=Paket bereitgestellt), -|fig|\-|window| (vom \package{picinpar}"=Paket bereitgestellt), -|par|\-|pic| (vom \package{picins}"=Paket bereitgestellt) und -|wrap|\-|figure| (vom \package{wrapfig}"=Paket bereitgestellt) -nicht mehr optimal platziert werden. - -Außerdem ist zu beachten, daß dann |\caption|\-|setup{type=|\x\meta{Type}|}| -keinen Hyperlink"=Anker mehr setzt, dies muß dann stattdessen mit -|\cap|\-|start| (welches vom \package{hypcap}"=Paket angeboten wird) geschehen. - -\endTODO - -\fi - % --------------------------------------------------------------------------- % \clearpage @@ -4052,7 +3791,7 @@ Befehl & & Abschnitt \\ |particular \caption.| \Description \Thispackage\ hat keinen geeigneten Hyperlink"=Anker für diese Beschriftung - gefunden, daher hat es entschlossen, die Einstellung |hypcap=|\-|true| (die per + gefunden, daher hat es entschlossen, die Einstellung |hypcap=|\x|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 |\auto|\-|ref| angelegt) @@ -4113,7 +3852,7 @@ Befehl & & Abschnitt \\ \end{Warnings} -\PageBreak +\pagebreak[3] \subsection{Fehlermeldungen} \begin{Warnings} @@ -4217,8 +3956,8 @@ Befehl & & Abschnitt \\ \Message |Not allowed in longtable* environment.| \Description - Der Befehl |\caption| ist immerhalb einer |long|\-|table*| Umgebung - nicht erlaubt. Verwenden sie entweder |\caption*| für eine Beschriftung + Der Befehl |\caption| ist innerhalb einer |long|\-|table*| Umgebung + nicht erlaubt. Verwenden Sie entweder |\caption*| für eine Beschriftung ohne Bezeichner oder benutzen Sie die reguläre |long|\-|table| Umgebung. \Message @@ -4248,7 +3987,7 @@ Befehl & & Abschnitt \\ \package{subfig}"=Paket in Frage; sollte dies zutreffen, laden Sie bitte \thispackage\ \emph{vor} dem betreffenen Paket. Im Falle des \package{subfig}"=Paketes können Sie auch alternativ beim - Laden des \package{subfig}"=Paketes die Option |caption=|\-|false| angeben. + Laden des \package{subfig}"=Paketes die Option |caption=|\x|false| angeben. \par\See{Dokumentation des \package{subfig}"=Paketes\cite{subfig}} \Message @@ -4309,7 +4048,7 @@ Befehl & & Abschnitt \\ |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 + Sie haben die Option |caption=|\x|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 @@ -4374,6 +4113,19 @@ Befehl & & Abschnitt \\ \par\See{\Ref{formats}} \Message + |Usage of the `position' option is incompatible|\\ + |to the `|\meta{package}|' package.| +\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 \emph{einen} der Mechanismen entscheiden: + Entweder Sie verwenden das angegebene Paket für die Anpassung + der Abstände, oder aber die |position|"=Option des + \package{caption}"=Paketes, beides geht nicht. + \par\See{\Ref{skips}} + +\Message |You can't use both, the (obsolete) caption2 *and*|\\ |the (current) caption package.| \Description @@ -4382,22 +4134,6 @@ Befehl & & Abschnitt \\ 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.| -\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} % --------------------------------------------------------------------------- % @@ -4465,7 +4201,7 @@ Einen weiteren Gewinn stellt der neu integrierte Kompatibilitätscheck \subsection{caption v\texorpdfstring{$1.x$}{1.x}} \label{caption1} -Diese Version des \thispackage"=Paketes ist weitgehend kompatibel zu den +Diese Version des \package{caption}"=Paketes ist weitgehend kompatibel zu den älteren Versionen $1.0$ bis $1.4$ des Paketes; alte, vorhandene Dokumente sollten sich also in der Regel ohne Probleme weiterhin übersetzen lassen. Jedoch ist zu beachten, daß eine Mischung aus alten Befehlen und neueren @@ -4544,10 +4280,10 @@ bzw. \end{quote} 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öchte man gezielt das Aussehen der Abbildungen des Stils |ruled|, +eingestellten Parameter bei Umgebungen des Typs |ruled| aktivierte, +wird ebenfalls emuliert, hat aber keine direkte Entsprechung in +dieser Version des \package{caption}"=Paketes. +Möchte man das Aussehen der Abbildungen des Stils |ruled|, der durch das \package{float}"=Paket zur Verfügung gestellt wird, verändern, so ist dies nun durch \begin{quote} @@ -4588,8 +4324,8 @@ Optionen und Befehle helfen. Sollten darüberhinaus noch Fragen offen sein oder Probleme auftreten, dann zögern Sie bitte nicht, mich diesbezüglich per E-Mail zu kontaktieren. -Zusätzlich zu den bereits im vorherigen Abschnitt vorgestellten Optionen -werden auch folgende emuliert: +Zusätzlich zu den bereits im letzten Abschnitt vorgestellten Optionen +werden ebenfalls emuliert: \begin{center}\small \begin{tabular}{ll} @@ -4829,8 +4565,8 @@ explizit auf einen anderen Wert als den Standardwert ($=$|4in|) gesetzt wird. %\NEWdescription{v3.1} \Thispackage\ \version{3.0} hatte keine weiteren Dokumentenklassen -aktiv unterstützt als die drei Standard"=Klassen, die \LaTeX\ selber -mitbringt: \class{article}, \class{report} und \class{book}. +unterstützt als die drei Standard"=Klassen, die \LaTeX\ selber mitbringt: +\class{article}, \class{report} und \class{book}. Daher waren die Vorbelegungen der Einstellungsmöglichkeiten fest durch dieses Paket vorgegeben, sie repräsentierten das Aussehen bei Verwendung einer dieser Klassen. @@ -4848,14 +4584,14 @@ Möchten sie weiterhin die "`alten"' Vorbelegungen, so können Sie die Option mit |\caption|\-|setup{style=|\x|base}| den alten Grundzustand wieder herstellen. -Weiterhin prüft die aktuelle Version des \package{caption}"=Paketes automatisch -nach Inkompatibilitäten und gibt ggf.~ eine Warnung diesbezüglich aus. +Weiterhin prüft das \package{caption}"=Paket nun automatisch auf +Inkompatibilitäten und gibt ggf.~ eine Warnung aus. Sollte eine ernsthafte Inkompatibilität festgestellt werden, werden außerdem einige Features des \package{caption}"=Paketes abgeschaltet. Lediglich diese Prüfung ist neu, wenn sie also neuerdings eine Kompatibilitätswarnung erhalten, so waren auch bereits vorangegangene Versionen des \package{caption}"=Paketes inkompatibel, dies hatte sich aber früher "`nur"' -durch Seiteneffekte bzw.~nicht korrekt funktionierende Optionen bzw.~Befehle +durch Seiteneffekte bzw.~nicht korrekt funktionierende Optionen oder Befehle geäußert. Die Kompatibilitätswarnungen sagen auch nicht aus, daß etwas schief gegangen ist, sondern lediglich, daß etwas schief gehen könnte. Sie sollten aber auf jeden Fall, @@ -4865,9 +4601,9 @@ und Tabellenbeschriftungen bzgl.~ihres Aussehens genau im Auge behalten. \bigskip \begin{Note*} -Die Option |caption=false| wurde damals als Interimslösung zur Verfügung -gestellt, um nicht das ganze \package{caption}"=Paket zu laden, -sondern nur denjenigen Teil, der für den Betrieb des +\Thispackage\ \version{3.0} hatte als Interimslösung die Option +|caption=|\x|false| bereitgestellt, um nicht das ganze \package{caption}"=Paket +zu laden, sondern nur denjenigen Teil, der für den Betrieb des \package{subfig}"=Paketes\cite{subfig} notwendig war. Dieser Mechanismus ist veraltet und wird nicht mehr angeboten, bitte übergeben Sie stattdessen bei Bedarf diese Option an das \package{subfig}"=Paket @@ -4885,6 +4621,7 @@ und laden Sie nicht mehr \thispackage. \clearpage \begin{thebibliography}{99} + \bibitem{TLC2} Frank Mittelbach und Michel Goossens:\\ \newblock {\em Der {\LaTeX} Begleiter (2.\,Auflage)},\\ @@ -4991,14 +4728,14 @@ und laden Sie nicht mehr \thispackage. July 13, 1993 \bibitem{picins} - Joachim Bleser and Edmund Lang:\\ + Joachim Bleser und Edmund Lang:\\ \href{http://dante.ctan.org/tex-archive/macros/latex209/contrib/picins/}% % \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:\\ + Sebastian Rahtz und Leonor Barroca:\\ \href{http://dante.ctan.org/tex-archive/macros/latex/contrib/rotating/}% % \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/rotating/}% {\emph{A style option for rotated objects in \LaTeX}},\\ @@ -5033,7 +4770,7 @@ und laden Sie nicht mehr \thispackage. 2005/07/05 \bibitem{supertabular} - Johannes Braams and Theo Jurriens:\\ + Johannes Braams und Theo Jurriens:\\ \href{http://dante.ctan.org/tex-archive/macros/latex/contrib/supertabular/}% % \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}% {\emph{The supertabular environment}},\\ @@ -5052,6 +4789,13 @@ und laden Sie nicht mehr \thispackage. % \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% {\emph{WRAPFIG.STY ver 3.6}},\\ 2003/01/31 + + \bibitem{xtab} + Peter Wilson:\\ + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/xtab/}% + {\emph{The xtab package}},\\ + 2004/05/24 + \end{thebibliography} % --------------------------------------------------------------------------- % diff --git a/Master/texmf-dist/doc/latex/caption/caption-eng.pdf b/Master/texmf-dist/doc/latex/caption/caption-eng.pdf Binary files differindex b6997647a96..f4f965de52e 100644 --- a/Master/texmf-dist/doc/latex/caption/caption-eng.pdf +++ 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 index 8c1645c0de7..f720949032c 100644 --- a/Master/texmf-dist/doc/latex/caption/caption-eng.tex +++ b/Master/texmf-dist/doc/latex/caption/caption-eng.tex @@ -23,7 +23,7 @@ % user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. % \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{caption-eng.tex}[2008/03/16 v3.1g The caption package] +\ProvidesFile{caption-eng.tex}[2008/04/06 v3.1h The caption package] \hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. %\errorcontextlines=3 @@ -56,7 +56,7 @@ \hypersetup{pdfkeywords={LaTeX, package, caption},pdfstartpage={},pdfstartview={}} \hypersetup{breaklinks=true} -\usepackage[listof=0,hypcap=false]{caption}[2008/01/12] +\usepackage[listof=0,hypcap=false]{caption}[2008/04/01] \DeclareRobustCommand*\eTeX{\texorpdfstring {\leavevmode\hbox{$\varepsilon$}-\TeX}% @@ -70,19 +70,18 @@ \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{\LARGE\Info}}} \makeatother -\font\manual=manfnt -\newcommand*\DANGER{\MARGINSYM{\manual\char127}} + \newcommand*\MARGINSYM[1]{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{#1}}}} +\newcommand*\NEW[2]{}%\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} % \ContinuedFloat -\DeclareCaptionLabelFormat{continued}{Continued #1~#2} +\DeclareCaptionLabelFormat{continued1}{Continued #1~#2} +\DeclareCaptionLabelFormat{continued2}{#1~#2\alph{ContinuedFloat}} % \DeclareCaptionLabelFormat \DeclareCaptionLabelFormat{bf-parens}{(\textbf{#2})} % \DeclareCaptionStyle @@ -206,6 +205,13 @@ \Thispackage\ offers customization of captions in floating environments such |figure| and |table| and cooperates with many other packages. +\par\smallskip +\textit{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} package is usually sufficient. \end{abstract} \newcommand\exampletext{% @@ -632,7 +638,7 @@ Three examples: \smallskip -\pagebreak[3] +\PageBreak \DescribeMacro{singlelinecheck=} The standard \LaTeX\ document classes (\class{article}, \class{report}, and \class{book}) automatically center a caption if it fits in one single line: @@ -1074,7 +1080,7 @@ is equivalent to \medskip -\DANGER +\INFO Please note that the options |skip=|, |position=|, |figure|\-|position=|, and |table|\-|position=| do not always have an effect. Since it's a matter of the document class to supply the environments @@ -1101,10 +1107,11 @@ But there is a second value |\below|\-|caption|\-|skip| (usually set to |0pt| by default) which is set below the caption in \LaTeX{}s implementation, but on the other side than |\above|\-|caption|\-|skip| by this package. So technically speaking, this package swaps the meaning of these two skips -when |position=top| is set. +when |position=|\x|top| is set. Please note that there are several packages around which do the same trick (like the \package{ftcap}, the \package{nonfloat}, and the \package{topcap} -package) which usage should be avoided when this package is used. +package), so the usage of the \package{caption} option |position=| is not +supported if one of these packages will be used, too. \end{Expert*} % --------------------------------------------------------------------------- % @@ -1158,8 +1165,8 @@ There are five standard caption list formats: \end{Options} The prefix ($=$|\p@figure| resp.~|\p@table|), which runs ahead of the -number ($=$|\the|\-|figure| resp.~|\the|\-|table|) in lists and references, -is usually empty, +number ($=$|\the|\-|figure| resp.~|\the|\-|table|) in lists (e.g.~List of +Figure/Table) and references, is usually empty, so the list formats |simple| and |subsimple| gives equal results; same with |parens| and |subparens|. But this can be different for sub-figures or sub-tables listed in the List of @@ -1308,9 +1315,9 @@ package\cite{float}, or |\Declare|\-|New|\-|Float|\-|Type| offered by the \medskip -\DANGER % \NEWdescription{v3.1} +\INFO % \NEWdescription{v3.1} Please note that you should use the option |type=| only -\emph{inside} boxes or environments (like |\par|\x|box| or |mini|\x|page|), +\emph{inside} boxes or environments (like |\par|\-|box| or |mini|\-|page|), at best one where no page break could happen between contents and caption. Furthermore some visual side-effects (e.g.~mixed-up figure and table settings regarding captions) could occur without using a box or environment, @@ -1450,7 +1457,7 @@ command: It typesets the caption without label and without entry to the list of figures or tables. -\DANGER % \NEWdescription{v3.1} +\INFO % \NEWdescription{v3.1} Since |\caption|\-|of| uses the option |type| internally, the same restrictions as for the |type| option apply here, so you should use both |\caption|\-|of| and |\caption|\-|of*| only \emph{inside} boxes or @@ -1684,8 +1691,9 @@ their own reference number. This is what the command \end{quote} is for; it should be used as first command inside the floating environment. It prevents the incrementation of the relevant counter (usually done by -|\caption|), so a figure or table with a |\Continued|\-|Float| in it gets the -same reference number as the figure or table before. An example: +|\caption|), so a figure or table containing a |\Continued|\-|Float| inside +gets the same reference number as the figure or table before. +An example: \begin{quote} |\begin{table}|\\ | \caption{A table}|\\ @@ -1724,24 +1732,122 @@ to a different label format for continued figures or tables, as shown here: \end{quote} \begin{Example} \captionsetup{type=table,position=b,skip=0pt} - \captionsetup[ContinuedFloat]{labelformat=continued} + \captionsetup[ContinuedFloat]{labelformat=continued1} \ContinuedFloat - \caption{A table} + \caption{A table}\label{continued1} \centerline{\ldots} \end{Example} -\medskip +\smallskip \See{\Ref{declare} for an explanation of \cs{Declare}\-\texttt{Caption}\-\texttt{Label}\-\texttt{Format}.} -\bigskip +\medskip -If you want to have a different caption label in |long|\-|table|s after -a page break, this can \emph{not} be archived by using |\Continued|\-|Float|, -\iffalse -(since |\Continued|\-|Float| is not available for |long|\-|table|s, see -\Ref{longtable}) -\fi -but you could write something like: +There is also a \LaTeX\ counter called |Continued|\-|Float| which could be +used for own purposes. +For ordinary (floating) environments it's set to zero, to one for the first +continued float, to two inside the second one, and so on. +So every |\Continued|\-|Float| increments this counter and a floating +environment without |\Continued|\-|Float| command resets this counter to zero. +An example: +\begin{quote} + |\DeclareCaptionLabelFormat{cont}{#1~#2\alph{ContinuedFloat}}|\\ + |\captionsetup[ContinuedFloat]{labelformat=cont}|\\ + \ldots\\ + |\begin{table}\ContinuedFloat|\\ + | \caption{A table}|\\ + | |\ldots\\ + |\end{table}| +\end{quote} +\begin{Example} + \captionsetup{type=table,position=b,skip=0pt} + \captionsetup[ContinuedFloat]{labelformat=continued2} + \ContinuedFloat + \caption{A table}\label{continued2} + \centerline{\ldots} +\end{Example} +\medskip +A reference to this table would still result in the output +``\autoref{continued2}'' since only the caption label format was changed. +If you would like to use the |Continued|\-|Float| counter for the references, +too, you could redefine the command |\the|\-|Continued|\-|Float| instead, +which will be appended to the figure or table counter automatically in +continued floats and is preset to be empty. +\begin{quote} + |\renewcommand\theContinuedFloat{\alph{ContinuedFloat}}|\\ + \ldots\\ + |\begin{table}\ContinuedFloat|\\ + | \caption{A table}|\\ + | |\ldots\\ + |\end{table}| +\end{quote} +\begin{Example} + \captionsetup{type=table,position=b,skip=0pt} + \renewcommand\theContinuedFloat{\alph{ContinuedFloat}} + \ContinuedFloat + \caption{A table}\label{continued3} + \centerline{\ldots} +\end{Example} +\medskip +A reference to that table would result in the output ``\autoref{continued3}''. + +\pagebreak[3] +\DescribeMacro{\ContinuedFloat*} +Suppose you want to start the first figure or table of such a series with a +kind of ``Figure 7a'' and not with ``Figure 7'' (and the second one with +``Figure 7b'' instead of ``Figure 7a''). +This is possible, too, by using the starred variant |\Continued|\-|Float*| +which---just like |\Continued|\-|Float|---executes options associated with the +type name ``|Continued|\-|Float|'' and increments the \LaTeX\ counter +|Continued|\-|Float|, \emph{but} marks the first figure or table of a series +instead: +\begin{quote} + |\renewcommand\theContinuedFloat{\alph{ContinuedFloat}}|\\ + \ldots\\ + |\begin{figure}\ContinuedFloat*|\\ + | |\ldots\\ + | \caption{First figure of a series}|\\ + |\end{figure}|\\ + \ldots\\ + |\begin{figure}\ContinuedFloat|\\ + | |\ldots\\ + | \caption{Second figure of a series}|\\ + |\end{figure}|\\ + \ldots\\ + |\begin{figure}\ContinuedFloat|\\ + | |\ldots\\ + | \caption{Third figure of a series}|\\ + |\end{figure}| +\end{quote} +\begin{Example} + \captionsetup{type=figure,position=b,skip=0pt} + \renewcommand\theContinuedFloat{\alph{ContinuedFloat}} + \begingroup + \ContinuedFloat* + \centerline{\ldots} + \caption{First figure of a series} + \endgroup + \begingroup + \ContinuedFloat + \centerline{\ldots} + \caption{Second figure of a series} + \endgroup + \begingroup + \ContinuedFloat + \centerline{\ldots} + \caption{Third figure of a series} + \endgroup +\end{Example} +\smallskip +\Note{Unfortunately \cs{ContinuedFloat*} is not available if the + \package{subfig} package\cite{subfig} is loaded.} + +\pagebreak[3] +\subsubsection*{A note about longtables} +If you want to have a different caption label in |long|\-|table|s (offered +by the \package{longtable} package\cite{longtable}) after a page break, +this can \emph{not} be archived by using |\Continued|\-|Float|, +but instead you could write something like: \begin{quote} |\DeclareCaptionLabelFormat{continued}{Continued #1~#2}|\\ \ldots\\ @@ -2016,6 +2122,7 @@ and |wrap|\meta{type} (\package{wrapfig} package). \smallskip +\pagebreak[3] So for example \begin{quote} |\DeclareCaptionType{diagram}| @@ -2166,6 +2273,9 @@ This will be achieved by a combination of \LaTeX\ Companion\cite{TLC2} examples.} \MakeShortVerb{\|} +(Please remember that |\caption|\-|list|\-|entry| increments the figure + resp.~table counter.) + % --------------------------------------------------------------------------- % \clearpage @@ -2173,16 +2283,6 @@ This will be achieved by a combination of \label{classes} %\NEWdescription{v3.1} -\begin{Note*}[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} package is usually sufficient. -\end{Note*} - -\medskip - 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 @@ -2191,11 +2291,11 @@ 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 +setting |format=|\x|default| can give you different visual designs when used with different document classes. \begingroup\setlength\leftmargini{0.3em}% default = 2.5em -\DANGER +\INFO If you don't find the document class you use in this section, you usually don't have to worry: Many document classes (e.g.~the \class{octavo} class) are derived from one of the standard document classes \class{article}, @@ -2228,7 +2328,7 @@ keep your fingers crossed. \newcommand*\Option{Option} \newcommand*\defaultvalue{\texttt{default} value} -\newcommand*\use{\textit{use}} +\newcommand*\uses{\textit{uses}} \newcommand*\settings{\textit{settings}} \newcommand*\nofont{\textit{none}} @@ -2256,7 +2356,7 @@ This also applies to document classes derived from them. \Option & \defaultvalue \\\hline |format=| & |plain| \\ |labelformat=| & |simple| \\ -|labelsep=| & a period $+$ |\enspace| \\ +|labelsep=| & |.\enspace| \\ |justification=| & |justified| \\ |font=| & |\@captionfont| \\ |labelfont=| & |\@captionheadfont| \\ @@ -2289,12 +2389,12 @@ loading \thispackage. |labelformat=| & \textit{not numbered} \\ |labelsep=| & |colon| \\ |justification=| & |raggedright| \\ -|font=| & \use\ \class{beamer} |caption| \settings \\ -|labelfont=| & \use\ \class{beamer} |caption name| \settings \\ +|font=| & \class{beamer} ``|caption|'' \settings \\ +|labelfont=| & \class{beamer} ``|caption name|'' \settings \\ |textfont=| & \nofont \\ \end{tabular} -\subsubsection*{Build-in features and side-effects} +\subsubsection*{Build-in features, and side-effects} You can setup font and color settings with |\set|\-|beamer|\-|font{caption}|\marg{options} and |\set|\-|beamer|\-|font{caption name}|\marg{options}. @@ -2303,7 +2403,7 @@ This will still work, unless you set a different font with |\caption|\-|setup{label|\-|font=|\x\meta{options}|}|.\par Furthermore the \class{beamer} classes offer different caption templates which can be chosen with -|\set|\-|beamter|\-|template|\x|{caption}|\x|[|\meta{template}|]|. +|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{template}|]|. Since \thispackage\ replaces this caption template mechanism, |\def|\-|beamer|\-|template*|\x|{caption}|\x\marg{template code} and @@ -2315,12 +2415,12 @@ will have no effect when \thispackage\ is used. \begin{tabular}{ll} \Option & \defaultvalue \\\hline -|format=| & \use\ |\setcapindent| \textit{\&} |\setcaphanging| \settings \\ +|format=| & \uses\ |\setcapindent| \textit{\&} |\setcaphanging| \settings \\ |labelformat=| & \textit{like \purett{simple}, but with support of ``autodot''}\\ -|labelsep=| & \use\ |\captionformat| \\ +|labelsep=| & |\captionformat| \\ |justification=| & |justified| \\ -|font=| & \use\ |\setkomafont{caption}| \settings \\ -|labelfont=| & \use\ |\setkomafont{captionlabel}| \settings \\ +|font=| & |\setkomafont{caption}| \settings \\ +|labelfont=| & |\setkomafont{captionlabel}| \settings \\ |textfont=| & \nofont \\ \end{tabular} @@ -2330,12 +2430,12 @@ feel of the captions. For an overview and a full description please take a look at the \KOMAScript\ documentation, section `Tables and Figures'. \subsubsection*{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. +The optional argument of |\set|\-|cap|\-|width| is not supported and +will be ignored if used in conjunction with the \package{caption} package. +Furthermore the \KOMAScript\ options |table|\-|caption|\-|above| \& +|table|\-|caption|\-|below| and the commands |\caption|\-|above| \& +|\caption|\-|below| are stronger than the |position=| setting offered by +the \package{caption} package. \subsection{\NTG: artikel, rapport, and boek} \label{NTG} @@ -2347,17 +2447,17 @@ package. |labelsep=| & |colon| \\ |justification=| & |justified| \\ |font=| & \nofont \\ -|labelfont=| & \use\ |\CaptionLabelFont| \\ -|textfont=| & \use\ |\CaptionTextFont| \\ +|labelfont=| & |\CaptionLabelFont| \\ +|textfont=| & |\CaptionTextFont| \\ \end{tabular} -\subsubsection*{Build-in features and side-effects} +\subsubsection*{Build-in features, and side-effects} |\Caption|\-|Label|\-|Font| and |\Caption|\-|Text|\-|Font| can be set either directly or by using |\Caption|\-|Fonts|. Both is still supported unless you use one of the two options |label|\-|font=| or |text|\-|font=| offered by \thispackage. -\subsection{\SmF{} classes: smfart and smfbook} +\subsection{\SmF: smfart and smfbook} \label{SMF} Since the \SmF\ document classes are derived from the \AmS\ document classes @@ -2378,38 +2478,39 @@ If you don't like this limitation, you can switch it off with the option |labelsep=| & |colon| \\ |justification=| & |justified| \\ |font=| & \nofont \\ -|labelfont=| & \use\ |\captionheaderfont| \\ -|textfont=| & \use\ |\captionbodyfont| \\ +|labelfont=| & |\captionheaderfont| \\ +|textfont=| & |\captionbodyfont| \\ \end{tabular} -\subsubsection*{Build-in features and side-effects} +\subsubsection*{Build-in features, and side-effects} The caption label font can be set with |\caption|\-|header|\-|font|, the caption text font with |\caption|\-|body|\-|font|. Both is still supported unless you use one of the two options |label|\-|font=| or |text|\-|font=| offered by \thispackage. -\subsection{The frenchb Babel option} +\subsection{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. +the default |label|\-|sep=| will be set to |\Caption|\-|Sep|\-|a|\-|ra|\-|tor| +(offered by \package{frenchb}), overriding the default value set by the +document class. +So redefining |\Caption|\-|Sep|\-|a|\-|ra|\-|tor| will still work, unless you +don't select a different |label|\-|sep=| than the default one. \INFO* Please load \thispackage\ \emph{after} the \package{babel} package. -\subsection{The frenchle and frenchpro packages} +\subsection{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. +the default |label|\-|sep=| will be set to |\caption|\-|sep|\-|a|\-|ra|\-|tor| +(offered by \package{frenchle/pro}) plus \cs{space}, overriding the default +value set by the document class. +So redefining |\caption|\-|sep|\-|a|\-|ra|\-|tor| will still work, unless you +don't select a different |label|\-|sep=| than the default one. Furthermore the default |text|\-|font=| will be set to |text|\-|font=|\x|it|, since this emulates the default setting of |\caption|\-|font| defined by the @@ -2420,9 +2521,9 @@ Please note that the command |\caption|\-|font| is used by the \package{caption} package internally for a different purpose, so you should not change it (anymore). -The command |\un|\-|numbered|\-|captions|\marg{figure or table} will still work, -but only unless you don't select a different |label|\-|format=| than the default -one. +The command |\un|\-|numbered|\-|captions|\marg{figure \emph{or} table} will +still work, but only unless you don't select a different |label|\-|format=| +than the default one. \INFO* Please load \thispackage\ \emph{after} the \package{frenchle} @@ -2444,7 +2545,7 @@ captions, too: \package{longtable}, \package{picinpar}, \package{picins}, \package{rotating}, \package{setspace}, \package{sidecap}, \package{subfigure}, \package{supertabular}, \package{threeparttable}, - and \package{wrapfig} + \package{wrapfig}, and \package{xtab} \end{quote} Furthermore the \package{floatrow} package\cite{floatrow}, the @@ -2455,15 +2556,15 @@ and use its |\caption|\-|setup| interface. \bigskip \begingroup\setlength\leftmargini{0.3em}% default = 2.5em -\DANGER +\INFO If a package (or document class) unknown to \thispackage\ redefines the |\caption| command as well, this redefinition will be preferred over the one this package offers, providing maximum compatibility and -avoiding incompatibilities. +avoiding conflicts. If such a potential incompatibility is detected, you will see this warning message:~\footnote{% - You can suppress this warning by specifying the option |compatibility=true| - when loading \thispackage.} + You can suppress this warning by specifying the option + \texttt{compatibility=true} when loading \thispackage.} \begin{quote}\footnotesize |Package caption Warning: \caption will not be redefined since it's already|\\ |(caption) redefined by a document class or package which is|\\ @@ -2474,12 +2575,13 @@ warning message:~\footnote{% As a result, the following features offered by \thispackage\ will not be available: \begin{itemize} - \item the options |labelformat=|, |position=auto|, and |list=| \& |listformat=| + \item the options |labelformat=|, |position=auto|, |list=|, and |listformat=| \item |\caption*| (to produce a caption without label) \item |\caption[]{|\ldots|}| (to produce no entry in the List of Figures or Tables) \item |\caption{}| (to produce an empty caption without label separator) \item |\ContinuedFloat| - \item correctly justified captions in environments like \texttt{wide} or \texttt{addmargin} + \item correctly justified captions in environments like \texttt{wide} and + \texttt{addmargin} which add extra margins \item the \textsf{hypcap} feature \See{\Ref{hyperref}\,} \item the sub-caption feature \See{\package{subcaption} package documentation} \end{itemize} @@ -2505,11 +2607,11 @@ since unwanted side-effects or even errors could occur afterwards. \label{algorithms} \packagedescription{% The \package{algorithms} package bundle\cite{algorithms} provides two -environments: The \texttt{algorithmic} environment provides an environment +environments: The \texttt{algorithmic} environment provides a possibility for describing algorithms, and the \texttt{algorithm} environment provides a ``float'' wrapper for algorithms.} -Since the \texttt{algorithm} environment is implemented via |\newfloat| +Since the \texttt{algorithm} environment is implemented via |\new|\-|float| provided by the \package{float} package\cite{float}, please see \Ref{float}. \iffalse @@ -2587,15 +2689,15 @@ An alternative would be using the \package{algorithmicx} package. The \package{float} package\cite{float} introduces the commands \cs{restylefloat} to give existing floating environments a new look \& feel and \cs{newfloat} to define new floating environments. -It also provides the \texttt{H} float placement option of the obsolete -\package{here} package.} +It also provides the ``\texttt{H}'' float placement option which places +the environments ``here'' instead of letting them floating around.} For floating environments defined with \cs{newfloat} or \cs{restylefloat} the |po|\-|si|\-|tion| option has no effect on the main caption anymore, since its placement and spacing will be controlled by the selected float style instead. -Furthermore a caption style and options defined with the name of the float -style will be executed additionally to the regular ones. +A caption style and options defined with the name of the float style will be +executed additionally to the regular ones. Using this mechanism \thispackage\ emulates the default look \& feel of the |ruled| captions: It defines the caption style \begin{quote} @@ -2615,27 +2717,27 @@ is specified, overriding its global value: For changing this, just use |\caption|\-|setup[boxed]{skip=|\x\meta{value}|}| with an appropriate value. Or if you want to use the global |skip| setting instead, you can remove the usage of the local setting for these floats with -|\clearcaptionsetup[skip]{boxed}|. +|\clear|\-|caption|\-|setup[skip]{boxed}|. \begin{Note} Only one single caption can be typeset inside environments defined with |\new|\-|float| or |\re|\-|style|\-|float|, furthermore these environments -are not behaving exactly like the pre-defined floats |figure| \& |table|. +are not behaving exactly like the pre-defined floats |figure| and |table|. As a consequence many packages do not cooperate well with these. -Furthermore the float package has some caveats \& limitations, so if you -just want to define a new simple floating environment---behaving like -|figure| or |table|---I recommend using \cs{DeclareCaptionType} +Furthermore the \package{float} package has some caveats \& limitations, +so if you just want to define a new simple floating environment---behaving +like |figure| or |table|---I recommend using |\Declare|\-|Caption|\-|Type| instead. And for defining non-simple floating environments and customization I -recommend using |\DeclareNewFloatType| offered by the \package{floatrow} -package\cite{floatrow}. +recommend using |\Declare|\-|New|\-|Float|\-|Type| offered by the +\package{floatrow} package\cite{floatrow}. \end{Note} \iffalse -Please also note that you \emph{don't} need a |\restylefloat| for using -the |H| float placement specifier. Some docs say so, but they are +Please also note that you \emph{don't} need a |\restyle|\-|float| for using +the ``|H|'' float placement specifier. Some docs say so, but they are wrong. -And |\restylefloat{table}| is a very good method to shoot yourself +And |\restyle|\-|float{table}| is a very good method to shoot yourself in the foot, since many packages using |table| internally are not working correctly afterwards. \fi @@ -2648,19 +2750,19 @@ The \package{floatflt} package\cite{floatflt} offers figures and tables which do not span the full width of a page and are float around by text.} \NEWfeature{v3.1} -If you want to setup special options for the |float|\-|ing|\-|figure| \& +If you want to setup special options for the |float|\-|ing|\-|figure| and |float|\-|ing|\-|table| environments you can use \begin{quote} - |\captionsetup[floatingfigure]|\marg{options}\\ + |\captionsetup[floatingfigure]|\marg{options}\quad\emph{and}\\ |\captionsetup[floatingtable]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for -|figure| or |table|. +|figure| resp.~|table|. \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures and tables, +The |margin| resp.~|width| setting will not be used for these figures resp.~tables, unless you set it explicit with |\caption|\-|setup[floating|\-|figure]{|\ldots|}| -or |\caption|\-|setup[floating|\-|table]{|\ldots|}|. +resp.~|\caption|\-|setup[floating|\-|table]{|\ldots|}|. \end{Note} \pagebreak[3] @@ -2673,37 +2775,37 @@ for its contents. This will be done by placing the caption on the bottom of the previous or next page.} \NEWfeature{v3.1} -Two options control the links to the |FPfigure| and |FPtable|: +Two options control the links to the environments |FPfigure| and |FPtable|: \begin{description} \item{\texttt{FPlist=caption} or \texttt{FPlist=figure}}\\[\smallskipamount] If set to |caption|, the list entry will link to the caption; if set to |figure|, it will link to the figure contents. -(The default setting is |FPlist=caption|.) +(The default setting is |FP|\-|list=|\x|caption|.) \item{\texttt{FPref=caption} or \texttt{FPref=figure}}\\[\smallskipamount] If set to |caption|, a \cs{ref}, \cs{pageref}, \cs{autoref}, or \cs{nameref} will link to the caption; if set to |figure|, it will link to the figure contents. -(The default setting is |FPref=figure|.) +(The default setting is |FP|\-|ref=|\x|figure|.) \end{description} -If you want to setup special options for the |FPfigure| \& |FPtable| +If you want to setup special options for the |FPfigure| and |FPtable| environments you can use \begin{quote} - |\captionsetup[FPfigure]|\marg{options}\\ + |\captionsetup[FPfigure]|\marg{options}\quad\emph{and}\\ |\captionsetup[FPtable]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for |figure| or |table|. -Furthermore \cs{DeclareCaptionType}\marg{name} will also define -an environment called |FP|\meta{name} which behaves like |FPfigure| and -|FPtable|. +Furthermore |\Declare|\-|Caption|\-|Type|\marg{name} will also define +an environment called |FP|\meta{name} which behaves like |FP|\-|figure| and +|FP|\-|table|. \pagebreak[3] \subsection{hyperref} \label{hyperref} \packagedescription{% -The hyperref package\cite{hyperref} is used to handle cross-referencing -commands in LaTeX to produce hypertext links in the document.} +The \package{hyperref} package\cite{hyperref} is used to handle cross +referencing commands in LaTeX to produce hypertext links in the document.} \NEWfeature{v3.1} There are two options available to control the placement of hyperlink @@ -2712,7 +2814,7 @@ which they supersede.} \begin{description} \item{\texttt{hypcap=true} or \texttt{hypcap=false}}\\[\smallskipamount] If set to |true| all hyperlink anchors -- where entries in the -List of Figures, |\ref|, and |\autoref| will link to -- are placed at +List of Figures, |\ref|, and |\auto|\-|ref| will link to -- are placed at the beginning of the (floating) environment.\par If set to |false| the hyperlink anchor is (usually) placed at the caption.\par (The default setting is |hypcap=|\x|true|.) @@ -2726,8 +2828,9 @@ e.g.~|hyp|\-|cap|\-|space=|\x|0pt| removes this distance.\par Both settings have no effect in |lst|\-|listing|s (provided by the \package{listings} package), |long|\-|table|s (provided by the -\package{longtable} package), and |super|\-|tabular|s (provided by the -\package{supertabular} package), within these environments hyperlink +\package{longtable} package), |super|\-|tabular|s (provided by the +\package{supertabular} package), and |x|\-|tabular|s (provided by the +\package{xtab} package), within these environments hyperlink anchors will always be placed as if |hyp|\-|cap=|\x|true| and |hyp|\-|cap|\-|space=|\x|0pt| would be set. @@ -2747,7 +2850,7 @@ For example: |\end{minipage}| \end{quote} will place the hyperlink anchor at the caption. -(And if |hypcap=|\x|true| is set, you will get a warning about this.) +(And if |hyp|\-|cap=|\x|true| is set, you will get a warning about this.) But \begin{quote} |\begin{minipage}{\linewidth}|\\ @@ -2756,7 +2859,7 @@ But | \caption{A figure}|\\ |\end{minipage}| \end{quote} -will place the hyperlink anchor at the beginning of the |minipage|, +will place the hyperlink anchor at the beginning of the |mini|\-|page|, since |\caption|\-|setup{type=|\x|figure}| does not only set the caption type to ``figure'' but does place a hyperlink anchor, too. @@ -2780,13 +2883,13 @@ The \package{hyp\-cap} package\cite{hypcap} offers a solution to the problem that links to a float using \package{hyper\-ref} may anchors to the caption rather than the beginning of the float. Since \thispackage\ \version{3.1} already solves this problem for itself, -the \package{hypcap} package is usually not needed, at least when you use -\thispackage.} +the \package{hypcap} package is usually not needed.} +%, at least when you use \thispackage.} If the \package{hyp\-cap} package is loaded additionally to the \package{hyper\-ref} package, it takes over the control of the hyperlink -anchor placement from \thispackage, overriding the options |hyp|\-|cap| -and |hyp|\-|cap|\-|space|. +anchor placement from \thispackage, overriding the options |hyp|\-|cap=| +and |hyp|\-|cap|\-|space=|. So for a manual placement of hyperlink anchors |\caption|\-|setup{type=|\x\meta{type}|}| is not sufficient anymore, @@ -2813,7 +2916,7 @@ and |wrapfigure|s (provided by the \package{wrap\-fig} package).%---% \packagedescription{% The \package{listings} package\cite{listings} typesets programming code.} -If you want to setup special options for the |lstlinsting| environment +If you want to setup special options for the |lst|\-|listing| environment you can use \begin{quote} |\captionsetup[lstlisting]|\marg{options}\quad. @@ -2825,17 +2928,18 @@ for controlling the position and the skips of the caption: \See{\package{listings} documentation for details.} These \package{listings} options override the \package{caption}'s ones, but can be again overwritten by |\caption|\-|setup[lst|\-|listing]{|\ldots|}|, -e.g.~|\caption|\-|setup[lst|\-|listing]{skip=|\x|10pt}|. +e.g.%~ +\begin{quote}|\caption|\-|setup[lst|\-|listing]{skip=|\x|10pt}|\quad.\end{quote} \pagebreak[3] \subsection{longtable} \label{longtable} \packagedescription{% The \package{longtable} package\cite{longtable} offers an environment -which behaves similar to the |tabular| environment, but the table +which behaves similar to the \texttt{tabular} environment, but the table itself can span multiple pages.} -If you want to setup special options for the |longtable| environment +If you want to setup special options for the |long|\-|table| environment you can use \begin{quote} |\captionsetup[longtable]|\marg{options}\quad. @@ -2853,13 +2957,13 @@ $=$ |4in|, \thispackage\ will follow that. even if it is set to a value different than |4in|.) \begin{Note} -|\caption|\-|of| and |\Continued|\-|Float| do not work for |long|\-|table|s. +|\caption|\-|of| and |\Continued|\-|Float| do \emph{not} work for |long|\-|table|s. Furthermore neither |\caption| nor |\caption|\-|list|\-|entry| will increment the |table| counter here; it's incremented by the |long|\-|table| environment instead. \NEWfeature{v3.1} -If you need a |long|\-|table| which does \emph{not} increment the |table| -counter please use the |long|\-|table*| environment (offered by the +If you need a |long|\-|table| which does not increment the |table| counter +please use the |long|\-|table*| environment (offered by the \package{ltcaption} package which is part of \thispackage\ bundle and will be loaded automatically). \end{Note} @@ -2875,10 +2979,10 @@ For a detailed discussion about the differences between these packages please take a look at The \LaTeX\ Companion\cite{TLC2}.} \NEWfeature{v3.1} -If you want to setup special options for the |figwindow| \& |tabwindow| -environments you can use +If you want to setup special options for the |fig|\-|window| and +|tab|\-|window| environments you can use \begin{quote} - |\captionsetup[figwindow]|\marg{options}\\ + |\captionsetup[figwindow]|\marg{options}\quad\emph{and}\\ |\captionsetup[tabwindow]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for @@ -2901,14 +3005,15 @@ For a detailed discussion about the differences between these packages please take a look at The \LaTeX\ Companion\cite{TLC2}.} \NEWfeature{v3.1} -If you want to setup special options for the |parpic| environment you can use +If you want to setup special options for the |par|\-|pic| environment you can use \begin{quote} |\captionsetup[parpic]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for -|figure| or |table|.\par -Furthermore |\piccaption[]{|\ldots|}| produce no entry in the List of Figures, -and |\piccaption*{|\ldots|}| gives an unlabeled \& unnumbered caption. +|figure| or |table|. + +Furthermore |\pic|\-|caption[]{|\ldots|}| produce no entry in the List of Figures, +and |\pic|\-|caption*{|\ldots|}| gives an unlabeled \& unnumbered caption. \begin{Note} The |margin| resp.~|width| setting will not be used for these figures and tables. @@ -2921,7 +3026,6 @@ But you can override this by setting it explicit with |\caption|\-|setup[par|\-|pic]{|\ldots|}|. \end{Note} -\begin{Note} If you want to have a |\pic|\-|caption| of another type as |figure|, please do \emph{not} re-define |\@cap|\-|type| as suggested by the \package{picins} documentation. Please use the |\pic|\-|caption|\-|type|\marg{type} command @@ -2931,19 +3035,18 @@ which is offered by \thispackage\ instead, e.g.: |\piccaption{An example table}|\\ |\parpic(50mm,10mm)[s]{|\ldots|}| \end{quote} -\end{Note} \pagebreak[3] \subsection{rotating} \label{rotating} \packagedescription{% The \package{rotating} package\cite{rotating} offers the floating -environments \texttt{side\-ways\-figure} and \texttt{side\-ways\-table} -which are just like normal figures and tables but rotated by 90 degree. -Furthermore a command \cs{rotcaption} is offered for rotated captions only.} +environments \texttt{side\-ways\-figure} and \texttt{side\-ways\-table} which +are just like normal figures and tables but rotated by 90 resp.~270 degree. +Furthermore a command \cs{rot\-caption} is offered for rotated captions only.} \iffalse % No, we don't do that -If you want to setup special options for the |side|\-|ways|\-|figure| \& +If you want to setup special options for the |side|\-|ways|\-|figure| and |side|\-|ways|\-|table| environments you can use \begin{quote} |\captionsetup[sidewaysfigure]|\marg{options}\\ @@ -2954,8 +3057,8 @@ These options will be executed additionally to the regular ones for \fi The command |\rot|\-|caption| will be extended by \thispackage, so -|\rot|\-|caption*| or |\rot|\-|caption|\-|of| can be used analogous to -|\caption| and |\caption|\-|of|. +|\rot|\-|caption*| and |\rot|\-|caption|\-|of| can be used analogous to +|\caption*| and |\caption|\-|of|. \NEWfeature{v3.1} Furthermore |\Declare|\-|Caption|\-|Type|\marg{name} will also define @@ -2975,20 +3078,20 @@ If the \package{setspace} package is used in conjunction with \thispackage, the caption will be typeset with single spacing as default. This can be changed by specifying either |font=|\x|one|\-|half|\-|spacing|, |font=|\x|double|\-|spacing|, or |font={stretch=|\x\meta{amount}|}|. -\See{\Ref{fonts}} +\See{also \Ref{fonts}} \pagebreak[3] \subsection{sidecap} \label{sidecap} \packagedescription{% -The \package{sidecap} package\cite{sidecap} offers the floating -environments |SCfigure| and |SCtable| which are like usual figures +The \package{sidecap} package\cite{sidecap} offers the floating environments +\texttt{SC\-figure} and \texttt{SC\-table} which are like usual figures and tables but the caption will be put \emph{beside} the contents.} -If you want to setup special options for the |SCfigure| \& |SCtable| +If you want to setup special options for the |SCfigure| and |SCtable| environments you can use \begin{quote} - |\captionsetup[SCfigure]|\marg{options}\\ + |\captionsetup[SCfigure]|\marg{options}\quad\emph{and}\\ |\captionsetup[SCtable]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for @@ -2996,14 +3099,14 @@ These options will be executed additionally to the regular ones for \pagebreak[3] \NEWfeature{v3.1} -Furthermore \cs{DeclareCaptionType}\marg{name} will also define -an environment called |SC|\meta{name} which behaves like |SCfigure| and -|SCtable|. +Furthermore |\Declare|\-|Caption|\-|Type|\marg{name} will also define +an environment called |SC|\meta{name} which behaves like |SC|\-|figure| and +|SC|\-|table|. \begin{Note} The \package{sidecap} package offers its own options for justification. If set, they will override the one specified with the caption option -|justification=| for captions beside their contents. +|jus|\-|ti|\-|fi|\-|ca|\-|tion=| for captions beside their contents. \end{Note} \begin{Note} @@ -3015,8 +3118,9 @@ or |\caption|\-|setup[SC|\-|table]{|\ldots|}|. \medskip \begin{Annotation*} -Instead of using the \package{sidecap} package you can also use -the more powerful \package{floatrow} package\cite{floatrow} for this purpose. +Instead of using the \package{sidecap} package you can also use the more +powerful and flexible \package{floatrow} package\cite{floatrow} for typesetting +captions beside the contents. \end{Annotation*} \pagebreak[3] @@ -3061,42 +3165,44 @@ Please use the \package{subfig} package instead with supports \thispackage\ \See{the \package{subfig} package\cite{subfig} documentation for details.} \pagebreak[3] -\subsection{supertabular} +\subsection{supertabular and xtab} \label{supertabular} \packagedescription{% -The \package{supertabular} package\cite{supertabular} offers an environment -which is quite similar to the |longtable| environment provided -by the \package{longtable} package\cite{longtable}: -Both offers the typesetting of tables which can span multiple pages. -For a detailed discussion about the differences between these two powerful +The \package{supertabular}\cite{supertabular} and \package{xtab}\cite{xtab} +packages offer an environment which can span multiple pages and is quite +similar to the \texttt{long\-table} environment provided by the +\package{longtable} package\cite{longtable}. +For a detailed discussion about the differences between these powerful packages please take a look at The \LaTeX\ Companion\cite{TLC2}.} -If you want to setup special options for the |super|\-|tabular| environment -you can use +If you want to setup special options for the |super|\-|tabular| +resp.~|x|\-|tabular| environment you can use \begin{quote} - |\captionsetup[supertabular]|\marg{options}\quad. + |\captionsetup[supertabular]|\marg{options}\quad\emph{resp.}\\ + |\captionsetup[xtabular]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for |table|. \begin{Note} -|\Continued|\-|Float| does not work for |super|\-|tabular|s. +|\Continued|\-|Float| does not work for |super|\-|tabular|s and |x|\-|tabular|s. \end{Note} \pagebreak[3] \subsection{threeparttable} \label{threeparttable} \packagedescription{% -Provides a scheme for tables that have a structured note section after the -table contents and the caption. +The \package{threeparttable} package\cite{threeparttable} provides a scheme +for tables that have a structured note section after the table contents and +the caption. This scheme provides an answer to the old problem of putting footnotes in tables---by making footnotes entirely unnecessary.} \NEWfeature{v3.1} -If you want to setup special options for the |three|\-|part|\-|table| \& +If you want to setup special options for the |three|\-|part|\-|table| and |measured|\-|figure| environments you can use \begin{quote} - |\captionsetup[threeparttable]|\marg{options}\\ + |\captionsetup[threeparttable]|\marg{options}\quad\emph{and}\\ |\captionsetup[measuredfigure]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for @@ -3129,30 +3235,31 @@ For a detailed discussion about the differences between these packages please take a look at The \LaTeX\ Companion\cite{TLC2}.} \NEWfeature{v3.1} -If you want to setup special options for the |wrapfigure| \& |wraptable| -environments you can use +If you want to setup special options for the |wrap|\-|figure| and +|wrap|\-|table| environments you can use \begin{quote} - |\captionsetup[wrapfigure]|\marg{options}\\ + |\captionsetup[wrapfigure]|\marg{options}\quad\emph{and}\\ |\captionsetup[wraptable]|\marg{options}\quad. \end{quote} These options will be executed additionally to the regular ones for |figure| or |table|. -Furthermore \cs{DeclareCaptionType}\marg{name} will also define -an environment called |wrap|\meta{name} which behaves like |wrapfigure| and -|wraptable|. +Furthermore |\Declare|\-|Caption|\-|Type|\marg{name} will also define +an environment called |wrap|\meta{name} which behaves like |wrap|\-|figure| +and |wrap|\-|table|. \begin{Note} -The |margin| resp.~|width| setting will not be used for these figures and tables, -unless you set it explicit with |\caption|\-|setup[wrap|\-|figure]{|\ldots|}| +The |margin| resp.~|width| setting will not be used for these figures and +tables, unless you set it explicit with +|\caption|\-|setup[wrap|\-|figure]{|\ldots|}| or |\caption|\-|setup[wrap|\-|table]{|\ldots|}|. \end{Note} \begin{Note} If the \package{wrapfig} package should be used in coorperation with the \package{float} package, it needs to be loaded \emph{after} the -\package{float} package. Furthermore \cs{newfloat} or \cs{restylefloat} -commands \emph{must} be placed after \emph{both} packages have been loaded. +\package{float} package. Furthermore |\new|\-|float| and |\restyle|\-|float| +commands \emph{should} be placed after \emph{both} packages have been loaded. \end{Note} % --------------------------------------------------------------------------- % @@ -3545,7 +3652,7 @@ Command & & Section \\ |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 + caption, so it decides to ignore the setting |hypcap=|\x|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 |\auto|\-|ref|) will link you to the caption of the figure or table, not to the figure or table itself.\par @@ -3721,7 +3828,7 @@ Command & & Section \\ so you can't do that again specifying different options. A candidate causing this could be the \package{subfig} package; if this is the case, please load \thispackage\ \emph{before} the \package{subfig} - package or specify the option |caption=|\-|false| while loading the + package or specify the option |caption=|\x|false| while loading the \package{subfig} package. \par\See{the \package{subfig} package\cite{subfig} documentation} @@ -3778,7 +3885,7 @@ Command & & Section \\ |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 + You have specified the option |caption=|\x|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 obsolete and not offered @@ -3836,6 +3943,18 @@ Command & & Section \\ \par\See{\Ref{style}} \Message + |Usage of the `position' option is incompatible|\\ + |to the `|\meta{package}|' package.| +\Description +% (ftcap,nonfloat,topcapt) + The given package is dealing with caption skips as well. + Please decide which one do you actually want to use: The |position=| option + of \thispackage\ or the mechanism of the other one; using both this way + would lead to wrong skips above or below the caption and is therefore + not supported. + \par\See{\Ref{skips}} + +\Message |Undefined text format `|\meta{name}|'.| \Description You tried to set a caption text format which does not exists. @@ -3850,22 +3969,6 @@ Command & & Section \\ 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.| -\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} % --------------------------------------------------------------------------- % @@ -3880,7 +3983,7 @@ Furthermore this version already supported the \package{rotating} and \package{subfigure} packages. Version $1.1$ introduced the |center|\-|last| option; version $1.2$ added the support of the \package{float} package. -Version offered a better support of the \package{subfigure} package, +Version $1,3$ offered a better support of the \package{subfigure} package, while version $1.4$ came with the new option |nooneline|. The \package{caption2} package $2.0$ was an experimental side-version of @@ -4134,7 +4237,7 @@ document class used. For example: While in \version{3.0} the default caption |jus|\-|ti|\-|fi|\-|ca|\-|tion| used to be always |jus|\-|ti|\-|fied|, it's now still |jus|\-|ti|\-|fied| when using one of the standard document -classes, but |ragged|\-|right| will be used as default format when when used +classes, but |ragged|\-|right| will be used as default format when used with the \class{beamer} document class. %An easy way to select the `old' defaults---if desired---is using the option @@ -4156,10 +4259,10 @@ you should use it with care. \bigskip \begin{Note*} -The option |caption=false|, which 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\cite{subfig} working. +\Thispackage\ \version{3.0} offered the option |caption=|\x|false|, +which 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\cite{subfig} working. This mechanism is obsolete and not offered anymore, please pass this option to the \package{subfig} package instead and do not load \thispackage\ anymore. %\par\See{the \package{subfig} package documentation} @@ -4169,6 +4272,7 @@ to the \package{subfig} package instead and do not load \thispackage\ anymore. \clearpage \begin{thebibliography}{99} + \bibitem{TLC2} Frank Mittelbach and Michel Goossens:\\ \newblock {\em The {\LaTeX} Companion (2nd.~Ed.)},\\ @@ -4196,7 +4300,7 @@ to the \package{subfig} package instead and do not load \thispackage\ anymore. 3 September 1989 \bibitem{algorithms} - Rogério Brito:\\ + Rog\'erio Brito:\\ \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/algorithms/}% % \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/algorithms/algorithms.pdf}% {\emph{Algorithms}},\\ @@ -4336,6 +4440,13 @@ to the \package{subfig} package instead and do not load \thispackage\ anymore. % \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% {\emph{WRAPFIG.STY ver 3.6}},\\ 2003/01/31 + + \bibitem{xtab} + Peter Wilson:\\ + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/xtab/}% + {\emph{The xtab package}},\\ + 2004/05/24 + \end{thebibliography} % --------------------------------------------------------------------------- % diff --git a/Master/texmf-dist/doc/latex/caption/caption.pdf b/Master/texmf-dist/doc/latex/caption/caption.pdf Binary files differindex 85611aa98e3..771b9dfda03 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/ltcaption.pdf b/Master/texmf-dist/doc/latex/caption/ltcaption.pdf Binary files differindex 5b7284a26ef..42429e33c44 100644 --- a/Master/texmf-dist/doc/latex/caption/ltcaption.pdf +++ b/Master/texmf-dist/doc/latex/caption/ltcaption.pdf diff --git a/Master/texmf-dist/doc/latex/caption/subcaption.pdf b/Master/texmf-dist/doc/latex/caption/subcaption.pdf Binary files differindex 40d80eb0d94..63cd802e3b3 100644 --- a/Master/texmf-dist/doc/latex/caption/subcaption.pdf +++ b/Master/texmf-dist/doc/latex/caption/subcaption.pdf diff --git a/Master/texmf-dist/source/latex/caption/caption.dtx b/Master/texmf-dist/source/latex/caption/caption.dtx index 5019819460b..a489d57fe58 100644 --- a/Master/texmf-dist/source/latex/caption/caption.dtx +++ b/Master/texmf-dist/source/latex/caption/caption.dtx @@ -24,12 +24,12 @@ % user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. % % \fi -% \CheckSum{6216} +% \CheckSum{6230} % % \iffalse %<*driver> \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{caption.drv}[2008/03/20 v3.1g Implementation of the caption package] +\ProvidesFile{caption.drv}[2008/04/01 v3.1h Implementation of the caption package] \hbadness=9999 \newcount\hbadness \hfuzz=100pt % Make TeX shut up. %\errorcontextlines=3 % @@ -56,7 +56,7 @@ \ifpdf\usepackage{hypdestopt}\fi \hypersetup{pdfkeywords={LaTeX, package, caption},pdfstartpage={},pdfstartview={}} % -\usepackage[debug]{caption}[2008/03/01] +\usepackage[debug]{caption}[2008/04/01] % \DeclareRobustCommand*\eTeX{\texorpdfstring {\leavevmode\hbox{$\varepsilon$}-\TeX}% @@ -233,7 +233,7 @@ % % \begin{macrocode} \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{caption3}[2008/03/20 v3.1g caption3 kernel (AR)] +\ProvidesPackage{caption3}[2008/03/20 v3.1h caption3 kernel (AR)] % \end{macrocode} % % \subsection{Generic helpers} @@ -3226,7 +3226,7 @@ % % \begin{macrocode} \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{caption}[2008/03/20 v3.1g Customizing captions (AR)] +\ProvidesPackage{caption}[2008/04/01 v3.1h Customizing captions (AR)] %\@ifundefined{PackageRedefines}{}{\PackageRedefines{caption}{caption}} % \end{macrocode} % @@ -3243,7 +3243,7 @@ % \subsection{Loading the kernel} % % \begin{macrocode} -\RequirePackage{caption3}[2008/03/01] % needs v3.1g +\RequirePackage{caption3}[2008/03/20] % needs v3.1g or newer % \end{macrocode} % % \subsection{Check against incompatible packages} @@ -3263,36 +3263,30 @@ % \changes{v3.1}{2007/06/18}{Check against incompatible \package{topcapt} package added} % \begin{macrocode} \caption@AtBeginDocument{% - \@ifpackageloaded{ftcap}{% - \caption@IncompatiblePackage{ftcap}{}% - }{}% - \@ifpackageloaded{nonfloat}{% - \caption@IncompatiblePackage{nonfloat}{.\MessageBreak - Furthermore you should use \noexpand\captionof instead of\MessageBreak - \noexpand\figcaption or \string\tabcaption}% - }{}% - \@ifpackageloaded{topcapt}{% - \caption@IncompatiblePackage{topcapt}{}% - }{}% -} + \@ifpackageloaded{ftcap}{\caption@DisablePositionOption{ftcap}}{}% + \@ifpackageloaded{nonfloat}{\caption@DisablePositionOption{nonfloat}}{}% + \@ifpackageloaded{topcapt}{\caption@DisablePositionOption{topcapt}}{}} % \end{macrocode} -% -% \begin{macro}{\caption@Incompatible} +% \begin{macro}{\caption@DisablePositionOption} % \changes{v3.1g}{2008/03/20}{\texttt{position=b} added} -% Issue an `incompatible' warning. +% \changes{v3.1h}{2008/03/29}{% +% Name changed from \cs{caption@IncompatiblePackage} to \cs{caption@DisablePositionOption}; +% moved from package to kernel; disables the `position' option now instead of issuing a warning} +% |\caption@DisablePositionOption|\marg{package}\par +% disables the `position' option. % \begin{macrocode} -\newcommand*\caption@IncompatiblePackage[2]{% - \PackageWarningNoLine{caption}{% - Usage of the #1 package together with the\MessageBreak - caption package is strongly not recommended.\MessageBreak - Instead of loading the #1 package you should\MessageBreak - use the caption package option\MessageBreak - \space\space`tableposition=top'#2}% - \caption@Info{Setting position=b for compatibility reasons}% - \caption@setposition b} +\newcommand*\caption@DisablePositionOption[1]{% + \caption@Info{% + `#1' package detected; setting `position=b' for compatibility reasons}% + \caption@setposition b% +% \end{macrocode} +% \begin{macrocode} + \DeclareCaptionOption{position}{% + \caption@Error{Usage of the `position' option is incompatible\MessageBreak + to the `#1' package}}} % \end{macrocode} % \begin{macrocode} -\@onlypreamble\caption@IncompatiblePackage +\@onlypreamble\caption@DisablePositionOption % \end{macrocode} % \end{macro} % @@ -3349,15 +3343,6 @@ % % \begin{macrocode} \if@tablecaptionabove - \caption@AtBeginDocument{% - \def\caption@tempa#1{% - \@ifpackageloaded{#1}{\caption@Error{% - You can't use the global option\MessageBreak - \space\space`tablecaptionabove'\MessageBreak - and use the #1 package, too}}{}}% - \caption@tempa{ftcap}% - \caption@tempa{nonfloat}% - \caption@tempa{topcapt}}% \@tablecaptionabovetrue \else \@tablecaptionabovefalse @@ -3503,15 +3488,6 @@ % \end{macrocode} % \begin{macrocode} \DeclareCaptionOption{tableposition}{% - \caption@AtBeginDocument{% - \def\caption@tempa##1{% - \@ifpackageloaded{##1}{\caption@Error{% - You can't use the caption package option\MessageBreak - \space\space`tableposition=#1'\MessageBreak - and use the ##1 package, too}}{}}% - \caption@tempa{ftcap}% - \caption@tempa{nonfloat}% - \caption@tempa{topcapt}}% \captionsetup*[table]{position=#1}} \@onlypreamble@key{caption}{tableposition} % \end{macrocode} @@ -6741,7 +6717,7 @@ }{} % \end{macrocode} % -% \subsubsection{The supertabular package} +% \subsubsection{The supertabular and xtab packages} % % \begin{macrocode} \caption@IfPackageLoaded{supertabular}[2002/07/19 v4.1e]{% @@ -6749,15 +6725,30 @@ % % \begin{macro}{\tablecaption} % \changes{v3.0e}{2005/05/05}{Made \cs{topcaption*} and \cs{bottomcaption*} work} +% \changes{v3.1h}{2008/04/01}{Bugfix: Star variant does not increment table counter anymore} % Make |\topcaption*| and |\bottomcaption*| work. % \begin{macrocode} - \let\caption@ORI@tablecaption\tablecaption - \def\tablecaption{\caption@star\relax\caption@ORI@tablecaption}% + \renewcommand*\tablecaption{% + \caption@star + {\refstepcounter{table}}% + {\caption@dblarg{\@xtablecaption}}}% +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\@xtablecaption} +% \changes{v3.1h}{2008/04/01}{Made \cs{nameref} \& \cs{autoref} work} +% Make |\nameref| and |\autoref| work. +% \begin{macrocode} + \let\caption@ORI@xtablecaption\@xtablecaption + \long\def\@xtablecaption[#1]#2{% + \def\@currentlabelname{#2}% + \caption@ORI@xtablecaption[#1]{#2}}% % \end{macrocode} % \end{macro} % % \begin{macro}{\ST@caption} % \changes{v3.0a}{2004/01/23}{Bugfix: Missing \cs{par} added} +% \changes{v3.1h}{2008/04/01}{Bugfix: \cs{@currentlabelname} will be set now} % The original code: % \begin{verbatim} % \long\def\ST@caption#1[#2]#3{\par% @@ -6794,9 +6785,76 @@ % \end{macro} % % \begin{macrocode} -}{% - \let\caption@setSTposition\@undefined -} +}{} +% \end{macrocode} +% +% \changes{v3.1h}{2008/04/01}{Support of the xtab package added} +% \begin{macrocode} +\caption@IfPackageLoaded{xtab}[2000/04/09 v2.3]{% +% \end{macrocode} +% +% \begin{macro}{\tablecaption} +% Make |\topcaption*| and |\bottomcaption*| work. +% \begin{macrocode} + \renewcommand*\tablecaption{% + \caption@star + {\refstepcounter{table}}% + {\caption@dblarg{\@xtablecaption}}}% +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\@xtablecaption} +% Make |\nameref| and |\autoref| work. +% \begin{macrocode} + \let\caption@ORI@xtablecaption\@xtablecaption + \long\def\@xtablecaption[#1]#2{% + \def\@currentlabelname{#2}% + \caption@ORI@xtablecaption[#1]{#2}}% +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ST@caption} +% The original code: +% \begin{verbatim} +% \long\def\ST@caption#1[#2]#3{\par% +% \@initisotab +% \addcontentsline{\csname ext@#1\endcsname}{#1}% +% {\protect\numberline{% +% \csname the#1\endcsname}{\ignorespaces #2}} +% \begingroup +% \@parboxrestore +% \normalsize +% %% \if@topcaption \vskip -10\p@ \fi +% \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par +% %% \if@topcaption \vskip 10\p@ \fi +% \endgroup +% \global\advance\ST@pageleft -\PWSTcapht +% \ST@trace\tw@{Added caption. Space left for xtabular: \the\ST@pageleft} +% } +% \end{verbatim}%^^A +% \begin{macrocode} + \long\def\ST@caption#1[#2]#3{\par% + \caption@settype*{#1}% + \caption@setoptions{xtabular}% +% \end{macrocode} +% \begin{macrocode} + \def\caption@fixposition{% + \caption@setposition{\if@topcaption t\else b\fi}}% +% \end{macrocode} +% \begin{macrocode} + \@initisotab + \caption@beginex{#1}{#2}{#3}% + \caption@boxrestore + \caption@normalsize + \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par + \caption@end + \global\advance\ST@pageleft -\PWSTcapht + \ST@trace\tw@{Added caption. Space left for xtabular: \the\ST@pageleft}}% +% \end{macrocode} +% \end{macro} +% +% \begin{macrocode} +}{} % \end{macrocode} % % \subsubsection{The threeparttable package} @@ -7152,6 +7210,12 @@ % {\emph{WRAPFIG.STY ver 3.6}},\\ % 2003/01/31 % +% \bibitem{xtab} +% Peter Wilson:\\ +% \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/xtab/}% +% {\emph{The xtab package}},\\ +% 2004/05/24 +% % \bibitem{Anne} % Anne Br\"uggemann-Klein:\\ % \emph{Einf\"uhrung in die Dokumentverarbeitung},\\ diff --git a/Master/texmf-dist/source/latex/caption/ltcaption.dtx b/Master/texmf-dist/source/latex/caption/ltcaption.dtx index 2b77a784b5d..8963d46dfcb 100644 --- a/Master/texmf-dist/source/latex/caption/ltcaption.dtx +++ b/Master/texmf-dist/source/latex/caption/ltcaption.dtx @@ -24,13 +24,13 @@ % user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. % % \fi -% \CheckSum{336} +% \CheckSum{340} % % \iffalse %<*driver> \NeedsTeXFormat{LaTeX2e}[1994/12/01] \ProvidesFile{ltcaption.drv}% - [2007/10/03 v1.1 This package fixes caption problems with + [2008/03/28 v1.2 This package fixes caption problems with other-than-centered aligned longtables] \hbadness=9999 \newcount\hbadness \hfuzz=48pt % Make TeX shut up. % @@ -114,6 +114,14 @@ % % \subsection{Further justification} % +% \DescribeMacro{\LTcapskip} +% This length is controlling the skip between the caption and the contents +% below the caption and can be altered with |\setlength\LTcapskip{|\ldots|}|. +% When \thispackage\ is loaded it will be set to |\abovecaptionskip| which +% usually represents the skip between caption and contents in floating +% environments. +% (Without this package, the \package{longtable} package uses |\baselineskip| here.) +% % \DescribeMacro{\LTcapleft} % \DescribeMacro{\LTcapright} % You can alter the centering of the caption box (of width |\LTcapwidth|) @@ -132,9 +140,9 @@ % captions as well. % % \emph{Note:} -% These commands do not work when used with one of the \KOMAScript\ -% classes\cite{KOMAScript} |scrartcl|, |scrreprt| or |scrbook|, -% the \KOMAScript\ settings for captions are used instead. +% These lengths \& commands do not work when \thispackage\ is used with one +% of the \KOMAScript\ classes\cite{KOMAScript} |scrartcl|, |scrreprt| or +% |scrbook|, the \KOMAScript\ settings for captions are used instead. % Same with the \package{caption} package which also uses its own options % and settings. % @@ -155,9 +163,9 @@ % \setcounter{figure}{6} % \begingroup % \renewcommand\LTcaptype{figure} -% \begin{longtable}{ll} +% \begin{longtable}{l} % \caption{An example longtable}\\ -% A & B \\ +% \ldots \\ % \end{longtable} % \endgroup % @@ -344,6 +352,7 @@ % \fi % % \StopEventually{%^^A +% \pagebreak[3] % \begin{thebibliography}{9} % \bibitem{longtable} % David Carlisle: @@ -439,7 +448,7 @@ % % \begin{macrocode} \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{ltcaption}[2008/03/21 v1.1a longtable captions (AR)] +\ProvidesPackage{ltcaption}[2008/03/28 v1.2 longtable captions (AR)] % \end{macrocode} % % \subsection{User interface} @@ -459,8 +468,7 @@ % \begin{macrocode} \@ifundefined{caption@AtBeginDocument}\AtBeginDocument\caption@AtBeginDocument{% \@ifpackageloaded{listings}{% - \providecommand*\ext@lstlisting{lol}% - }{}} + \providecommand*\ext@lstlisting{lol}}{}} % \end{macrocode} % \end{macro} % @@ -474,6 +482,13 @@ % \changes{v1.1}{2007/04/20}{The skips will not be defined if the % \package{caption} package is loaded} % +% \begin{macro}{\LTcapskip} +% \changes{v1.2}{2007/03/28}{This skip added} +% \begin{macrocode} + \newskip\LTcapskip \LTcapskip=\abovecaptionskip +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\LTcapleft} % \begin{macro}{\LTcapright} % \begin{macro}{\ifLTcapmargins} @@ -518,8 +533,6 @@ % i.e. |\AtBeginDocument|. % \begin{macrocode} \@ifundefined{caption@AtBeginDocument}\AtBeginDocument\caption@AtBeginDocument{% -% \end{macrocode} -% \begin{macrocode} \let\ltcaption@ORI@LT@array\LT@array \renewcommand*\LT@array{% % \end{macrocode} @@ -542,10 +555,7 @@ \def\lst@@caption{\relax}% % \end{macrocode} % \begin{macrocode} - \ltcaption@ORI@LT@array}% -% \end{macrocode} -% \begin{macrocode} -} + \ltcaption@ORI@LT@array}} % \end{macrocode} % \begin{macrocode} \newcommand*\caption@LTtype[2]{% @@ -592,6 +602,8 @@ % % \begin{macro}{\LT@makecaption} % \changes{v1.1}{2007/04/20}{\cs{LT@@makecaption} added} +% \changes{v1.1}{2007/06/27}{Adapted to the \package{floatrow} package by Olga Lapko} +% \changes{v1.2}{2007/03/28}{Uses \cs{LTcapskip} instead of \cs{baselineskip} now} % |\LT@makecaption|\marg{cmd}\marg{label}\marg{text}\par % \smallskip % Original code: @@ -610,7 +622,6 @@ % \hss}}} % \end{verbatim}%^^A % Our code:\footnote{Adapted to the \package{floatrow} package by Olga Lapko} -% \changes{v1.1}{2007/06/27}{Adapted to the \package{floatrow} package by Olga Lapko} % \begin{macrocode} \renewcommand\LT@makecaption[3]{% \LT@@makecaption{% @@ -620,7 +631,7 @@ \else \hbox to\hsize{\hfil\box\@tempboxa\hfil}% \fi - \endgraf\vskip\baselineskip}} + \endgraf\vskip\LTcapskip}} % \end{macrocode} % \begin{macrocode} \newcommand\LT@@makecaption[1]{% diff --git a/Master/texmf-dist/source/latex/caption/subcaption.dtx b/Master/texmf-dist/source/latex/caption/subcaption.dtx index 6a8d6b6e17f..defb3b40dae 100644 --- a/Master/texmf-dist/source/latex/caption/subcaption.dtx +++ b/Master/texmf-dist/source/latex/caption/subcaption.dtx @@ -24,12 +24,12 @@ % user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. % % \fi -% \CheckSum{144} +% \CheckSum{204} % % \iffalse %<*driver> \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{subcaption.drv}[2008/01/12 v0.3 Adds a sub-caption feature to the caption package] +\ProvidesFile{subcaption.drv}[2008/03/30 v0.3 Adds a sub-caption feature to the caption package] \hbadness=9999 \newcount\hbadness \hfuzz=74pt % Make TeX shut up. %\errorcontextlines=3 % @@ -75,13 +75,17 @@ \newcommand*\x{\discretionary{}{}{}} % \usepackage{marvosym} +\makeatletter +\newcommand*\INFO{\@ifstar{\@INFO{}}{\@INFO{\vbox to \ht\strutbox}}} +\newcommand*\@INFO[1]{\MARGINSYM{#1{\LARGE\Info}}} +\makeatother +% +\usepackage[alpine]{ifsym} +\newenvironment{background}{\par\bigskip\csname background*\endcsname}{\csname endbackground*\endcsname} +\newenvironment{background*}{\small\MARGINSYM{\Mountain}\ignorespaces}{\par} +% \newcommand*\MARGINSYM[1]{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{#1}}}} -\newenvironment{info}{\par\bigskip\csname info*\endcsname}{\csname endinfo*\endcsname} -\newenvironment{info*}% - {\small - \MARGINSYM{\vbox to \ht\strutbox{\LARGE\Info}}% - \ignorespaces}% - {\par} +%\newcommand*\NEW[2]{}%\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} % \begin{document} \DocInput{subcaption.dtx} @@ -121,26 +125,30 @@ % \package{caption} package. % \end{abstract} % -% \subsection*{Introduction} -% \begin{info*} -% Prepared with either |\Declare|\-|Caption|\-|Sub|\-|Type| (offered by the -% \package{caption} package) or |\new|\-|sub|\-|float| (offered by the -% \package{subfig} package), the caption package option |subtype| becames -% available, causing |\caption| to typeset a sub-caption instead of an -% ordinary one.\par +% \begin{background} +% At the end of each section, text marked with the mountain symbol +% will contain background knowledge on how the particular command or +% environment is actually implemented. +% If you just want to use this package as it is, you don't have to read or +% understand them. +% \end{background} +% +% \begin{background*} % This package demonstrates the usage of |\Declare|\-|Caption|\-|Sub|\-|Type|, % |\caption|\-|setup{sub|\-|type}|, and the internal hook -% |\caption@sub|\-|type|\-|hook|. -% \end{info*} +% |\caption@sub|\-|type|\-|hook| (offered by the \package{caption} package). +% \end{background*} % % \setcounter{tocdepth}{2} % \tableofcontents % +% \iffalse % \vfill +% \INFO* % \emph{Please note:} % This package is incompatible with the \package{subfigure} and \package{subfig} % packages. -% \medskip +% \fi % % \clearpage % \section{The user interface} @@ -256,18 +264,19 @@ % % \bigskip % -% \begin{info} -% Actually the |\subcaption| command is just a simple combination of -% |\caption|\-|setup{sub|\-|type*}| and |\caption|. -% Analogous to the |type| option, the |subtype| option (both offered by the -% \package{caption} package) sets the sub-type of the box or environment +% \begin{background} +% Prepared with either |\Declare|\-|Caption|\-|Sub|\-|Type| (offered by the +% \package{caption} package) or |\new|\-|sub|\-|float| (offered by the +% \package{subfig} package), the caption package option |subtype| becames +% available. +% Analogous to the |type| option of the \package{caption} package, +% the |subtype| option sets the sub-type of the box or environment % (so |\caption| will typeset a sub-caption instead of an ordinary one), % places a proper hyperlink anchor (non-starred variant only), -% executes options associated with the sub-type etc.\iffalse~\footnote{\emph{Note:} -% Since \cs{captionsetup}\csmarg{subtype} is part of the \package{caption} -% package, it works in coorparation with the \package{subfig} package as -% well.}\fi -% \end{info} +% executes options associated with the sub-type etc.\par +% The |\subcaption| command is just a simple combination of +% |\caption|\-|setup{sub|\-|type*}| and |\caption|. +% \end{background} % % \PageBreak % \subsection{The subfigure \& subtable environments} @@ -315,13 +324,13 @@ % % \bigskip % -% \begin{info} +% \begin{background} % The |subfigure| \& |subtable| environments are just simple minipage % environments with |\caption|\-|setup|\x|{subtype}| as first contents line. % These environments are defined with the help of % |\caption@For{subtypelist}|, which executes code for every sub-type % declared with |\DeclareCaptionSubType|. -% \end{info} +% \end{background} % % \PageBreak % \subsection{The \cs{subcaptionbox} command} @@ -431,11 +440,11 @@ % % \bigskip % -% \begin{info} +% \begin{background} % The |\sub|\-|caption|\-|box| is a |\par|\-|box| with % |\caption|\-|setup{sub|\-|type}| as first contents line. % \iffalse See implementation for details.\fi -% \end{info} +% \end{background} % % \PageBreak % \subsection{The \cs{subref} command} @@ -460,10 +469,10 @@ % the same result. % \end{small} % -% \begin{info} +% \begin{background} % The |\sub|\-|ref| command demonstrates the usage of |\caption@sub|\-|type|\-|hook| % which will be called during |\caption|\-|setup{sub|\-|type}|. -% \end{info} +% \end{background} % % \pagebreak[3] % \subsection{The \cs{DeclareCaptionSubType} command} @@ -520,10 +529,10 @@ % \subcaptionbox{Table two}[3cm][c]{\begin{tabular}{cc}E & F\\ G & H\\ \end{tabular}} % \end{minipage} % -% \begin{info} +% \begin{background} % |\Declare|\-|Caption|\-|Sub|\-|Type| is an integral part of the \package{caption} % package kernel. -% \end{info} +% \end{background} % % \pagebreak[3] % \subsection{Where do hyperlinks jump?} @@ -575,7 +584,7 @@ % \fi % % \pagebreak[3] -% \section{Beyond this package} +% \subsection{Beyond this package} % \label{floatrow} % % For a more advanced usage of the sub-caption feature of the @@ -681,6 +690,7 @@ % \changes{v0.1}{2007/09/01}{First demo} % \changes{v0.2}{2007/11/11}{\cs{subcaptionbox} added} % \changes{v0.3}{2007/12/06}{Adapted to \package{caption} package \version{3.1f}} +% \changes{v1.0}{2008/03/16}{\cs{subfloat} added} % % \newcommand*\Note[2][Note]{\par{\small\emph{#1:} #2}} % @@ -698,7 +708,7 @@ % % \begin{macrocode} \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{subcaption}[2007/12/06 v0.3 Adding subcaptions (AR)] +\ProvidesPackage{subcaption}[2008/03/16 v1.0 Adding subcaptions (AR)] % \end{macrocode} % % \subsection{Initial code} @@ -841,6 +851,58 @@ % \end{macro} % % \pagebreak[3] +% \subsubsection{The \cs{subfloat} command} +% +% \begin{macro}{\subfloat} +% \changes{v0.4}{2008/03/01}{This macro added} +% |\subfloat|\oarg{list\_entry}\oarg{sub-caption}\marg{body}\\ +% |\subfloat*|\marg{body}\par +% If \meta{sub-caption} is given, we simply map this to \cs{subcaptionbox}. +% If not, we do the same as \cs{subcaptionbox}, but increment the +% sub-caption counter instead of typesetting a sub-caption. +% (The star variant is neither incrementing the sub-caption counter +% nor setting an hyperref anchor.) +% \begin{macrocode} +\newcommand*\subfloat{% + \@ifnextchar[\@subfloat\subfloat@} +% \end{macrocode} +% \begin{macrocode} +\long\def\@subfloat[#1]{% + \@ifnextchar[{\@@subfloat{#1}}{\subcaptionbox{#1}}} +% \end{macrocode} +% \begin{macrocode} +\long\def\@@subfloat#1[#2]{\subcaptionbox[{#1}]{#2}} +% \end{macrocode} +% \begin{macrocode} +\newcommand*\subfloat@{% + \caption@teststar\subfloat@@\@firstoftwo\@secondoftwo} +% \end{macrocode} +% \begin{macrocode} +\newcommand\subfloat@@[2]{% + \setbox\@tempboxa\hbox{#2}% + \begingroup + \captionsetup{subtype*}% set \caption@position + \caption@iftop{\subfloat@@@ t}{\subfloat@@@ b}% + {#1}\subcaptionbox@hj@default} +% \end{macrocode} +% \begin{macrocode} +\newcommand\subfloat@@@[3]{% + \endgroup + \parbox[#1]{\wd\@tempboxa}{% + #2% \@firstoftwo in star form, \@secondoftwo otherwise + {\captionsetup{subtype*,position=#1}}% + {\captionsetup{subtype,position=#1}% + \caption@refstepcounter\@subcaptype + \caption@prepareanchor\@subcaptype{}% + \caption@makeanchor{}}% + \caption@iftop{\hrule\@height\z@}{}% + \csname caption@hj@#3\endcsname + \unhbox\@tempboxa + \caption@iftop{}{\hrule\@height\z@}}}% +% \end{macrocode} +% \end{macro} +% +% \pagebreak[3] % \subsubsection{The \cs{subref} command} % % At |\captionsetup{subtype}|, we redefine |\label|. diff --git a/Master/texmf-dist/tex/latex/caption/caption.sty b/Master/texmf-dist/tex/latex/caption/caption.sty index 3836fa359dc..3c68e16ad11 100644 --- a/Master/texmf-dist/tex/latex/caption/caption.sty +++ b/Master/texmf-dist/tex/latex/caption/caption.sty @@ -28,10 +28,10 @@ %% user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. %% \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{caption}[2008/03/20 v3.1g Customizing captions (AR)] +\ProvidesPackage{caption}[2008/04/01 v3.1h Customizing captions (AR)] \newcommand*\caption@Info[1]{\PackageInfo{caption}{#1\@gobble}} \@onlypreamble\caption@Info -\RequirePackage{caption3}[2008/03/01] % needs v3.1g +\RequirePackage{caption3}[2008/03/20] % needs v3.1g or newer \@ifpackageloaded{caption2}{% \caption@Error{% You can't use both, the (obsolete) caption2 *and*\MessageBreak @@ -39,28 +39,17 @@ \endinput }{} \caption@AtBeginDocument{% - \@ifpackageloaded{ftcap}{% - \caption@IncompatiblePackage{ftcap}{}% - }{}% - \@ifpackageloaded{nonfloat}{% - \caption@IncompatiblePackage{nonfloat}{.\MessageBreak - Furthermore you should use \noexpand\captionof instead of\MessageBreak - \noexpand\figcaption or \string\tabcaption}% - }{}% - \@ifpackageloaded{topcapt}{% - \caption@IncompatiblePackage{topcapt}{}% - }{}% -} -\newcommand*\caption@IncompatiblePackage[2]{% - \PackageWarningNoLine{caption}{% - Usage of the #1 package together with the\MessageBreak - caption package is strongly not recommended.\MessageBreak - Instead of loading the #1 package you should\MessageBreak - use the caption package option\MessageBreak - \space\space`tableposition=top'#2}% - \caption@Info{Setting position=b for compatibility reasons}% - \caption@setposition b} -\@onlypreamble\caption@IncompatiblePackage + \@ifpackageloaded{ftcap}{\caption@DisablePositionOption{ftcap}}{}% + \@ifpackageloaded{nonfloat}{\caption@DisablePositionOption{nonfloat}}{}% + \@ifpackageloaded{topcapt}{\caption@DisablePositionOption{topcapt}}{}} +\newcommand*\caption@DisablePositionOption[1]{% + \caption@Info{% + `#1' package detected; setting `position=b' for compatibility reasons}% + \caption@setposition b% + \DeclareCaptionOption{position}{% + \caption@Error{Usage of the `position' option is incompatible\MessageBreak + to the `#1' package}}} +\@onlypreamble\caption@DisablePositionOption \caption@ifbool{documentclass}{}{% \PackageWarningNoLine{caption}{% Unsupported document class (or package) detected,\MessageBreak @@ -76,15 +65,6 @@ \g@addto@macro\@tablecaptionabovetrue{\captionsetup*[table]{position=t}} \g@addto@macro\@tablecaptionabovefalse{\captionsetup*[table]{position=b}} \if@tablecaptionabove - \caption@AtBeginDocument{% - \def\caption@tempa#1{% - \@ifpackageloaded{#1}{\caption@Error{% - You can't use the global option\MessageBreak - \space\space`tablecaptionabove'\MessageBreak - and use the #1 package, too}}{}}% - \caption@tempa{ftcap}% - \caption@tempa{nonfloat}% - \caption@tempa{topcapt}}% \@tablecaptionabovetrue \else \@tablecaptionabovefalse @@ -155,15 +135,6 @@ \captionsetup*[figure]{position=#1}} \@onlypreamble@key{caption}{figureposition} \DeclareCaptionOption{tableposition}{% - \caption@AtBeginDocument{% - \def\caption@tempa##1{% - \@ifpackageloaded{##1}{\caption@Error{% - You can't use the caption package option\MessageBreak - \space\space`tableposition=#1'\MessageBreak - and use the ##1 package, too}}{}}% - \caption@tempa{ftcap}% - \caption@tempa{nonfloat}% - \caption@tempa{topcapt}}% \captionsetup*[table]{position=#1}} \@onlypreamble@key{caption}{tableposition} \DeclareCaptionOption{figurename}{\caption@SetName{figure}{#1}} @@ -1387,8 +1358,14 @@ \fi}} }{} \caption@IfPackageLoaded{supertabular}[2002/07/19 v4.1e]{% - \let\caption@ORI@tablecaption\tablecaption - \def\tablecaption{\caption@star\relax\caption@ORI@tablecaption}% + \renewcommand*\tablecaption{% + \caption@star + {\refstepcounter{table}}% + {\caption@dblarg{\@xtablecaption}}}% + \let\caption@ORI@xtablecaption\@xtablecaption + \long\def\@xtablecaption[#1]#2{% + \def\@currentlabelname{#2}% + \caption@ORI@xtablecaption[#1]{#2}}% \long\def\ST@caption#1[#2]#3{\par% \caption@settype*{#1}% \caption@setoptions{supertabular}% @@ -1399,9 +1376,30 @@ \caption@normalsize \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par \caption@end}% -}{% - \let\caption@setSTposition\@undefined -} +}{} +\caption@IfPackageLoaded{xtab}[2000/04/09 v2.3]{% + \renewcommand*\tablecaption{% + \caption@star + {\refstepcounter{table}}% + {\caption@dblarg{\@xtablecaption}}}% + \let\caption@ORI@xtablecaption\@xtablecaption + \long\def\@xtablecaption[#1]#2{% + \def\@currentlabelname{#2}% + \caption@ORI@xtablecaption[#1]{#2}}% + \long\def\ST@caption#1[#2]#3{\par% + \caption@settype*{#1}% + \caption@setoptions{xtabular}% + \def\caption@fixposition{% + \caption@setposition{\if@topcaption t\else b\fi}}% + \@initisotab + \caption@beginex{#1}{#2}{#3}% + \caption@boxrestore + \caption@normalsize + \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par + \caption@end + \global\advance\ST@pageleft -\PWSTcapht + \ST@trace\tw@{Added caption. Space left for xtabular: \the\ST@pageleft}}% +}{} \caption@IfPackageLoaded{threeparttable}[2003/06/13 v3.0]{% \let\caption@ORI@threeparttable\threeparttable \renewcommand*\threeparttable{% diff --git a/Master/texmf-dist/tex/latex/caption/caption3.sty b/Master/texmf-dist/tex/latex/caption/caption3.sty index c6a6a36cd42..1b468ec5d50 100644 --- a/Master/texmf-dist/tex/latex/caption/caption3.sty +++ b/Master/texmf-dist/tex/latex/caption/caption3.sty @@ -28,7 +28,7 @@ %% user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. %% \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{caption3}[2008/03/20 v3.1g caption3 kernel (AR)] +\ProvidesPackage{caption3}[2008/03/20 v3.1h caption3 kernel (AR)] \providecommand*\@nameundef[1]{% \expandafter\let\csname #1\endcsname\@undefined} \providecommand\l@addto@macro[2]{% diff --git a/Master/texmf-dist/tex/latex/caption/ltcaption.sty b/Master/texmf-dist/tex/latex/caption/ltcaption.sty index 046cc927990..073a52f626e 100644 --- a/Master/texmf-dist/tex/latex/caption/ltcaption.sty +++ b/Master/texmf-dist/tex/latex/caption/ltcaption.sty @@ -28,14 +28,14 @@ %% user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. %% \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{ltcaption}[2008/03/21 v1.1a longtable captions (AR)] +\ProvidesPackage{ltcaption}[2008/03/28 v1.2 longtable captions (AR)] \providecommand*\LTcaptype{table} \providecommand*\ext@table{lot} \@ifundefined{caption@AtBeginDocument}\AtBeginDocument\caption@AtBeginDocument{% \@ifpackageloaded{listings}{% - \providecommand*\ext@lstlisting{lol}% - }{}} + \providecommand*\ext@lstlisting{lol}}{}} \@ifpackageloaded{caption}{}{% + \newskip\LTcapskip \LTcapskip=\abovecaptionskip \newskip\LTcapleft \LTcapleft=\fill \newskip\LTcapright \LTcapright=\fill \newif\ifLTcapmargins \LTcapmarginstrue @@ -55,8 +55,7 @@ \def\hyper@makecurrent{% \caption@LTtype\caption@LT@makecurrent}% \def\lst@@caption{\relax}% - \ltcaption@ORI@LT@array}% -} + \ltcaption@ORI@LT@array}} \newcommand*\caption@LTtype[2]{% \edef\caption@LT@tempa{#2}% \ifx\caption@LT@tempa\caption@LT@table @@ -83,7 +82,7 @@ \else \hbox to\hsize{\hfil\box\@tempboxa\hfil}% \fi - \endgraf\vskip\baselineskip}} + \endgraf\vskip\LTcapskip}} \newcommand\LT@@makecaption[1]{% \caption@LT@make{\hb@xt@\hsize{% \ifLTcapmargins diff --git a/Master/texmf-dist/tex/latex/caption/subcaption.sty b/Master/texmf-dist/tex/latex/caption/subcaption.sty index 5944c6d8759..c5af2ecf25e 100644 --- a/Master/texmf-dist/tex/latex/caption/subcaption.sty +++ b/Master/texmf-dist/tex/latex/caption/subcaption.sty @@ -28,7 +28,7 @@ %% user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. %% \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{subcaption}[2007/12/06 v0.3 Adding subcaptions (AR)] +\ProvidesPackage{subcaption}[2008/03/16 v1.0 Adding subcaptions (AR)] \@ifundefined{caption@subtypehook}{% we need caption v3.1f or newer \PackageError{subcaption}{`caption' package not loaded\MessageBreak (which is needed by this package)\@gobble}{% @@ -86,6 +86,32 @@ \providecommand*\caption@hj@r{\raggedleft} \providecommand*\caption@hj@s{} \newcommand*\subcaptionbox@hj@default{c} +\newcommand*\subfloat{% + \@ifnextchar[\@subfloat\subfloat@} +\long\def\@subfloat[#1]{% + \@ifnextchar[{\@@subfloat{#1}}{\subcaptionbox{#1}}} +\long\def\@@subfloat#1[#2]{\subcaptionbox[{#1}]{#2}} +\newcommand*\subfloat@{% + \caption@teststar\subfloat@@\@firstoftwo\@secondoftwo} +\newcommand\subfloat@@[2]{% + \setbox\@tempboxa\hbox{#2}% + \begingroup + \captionsetup{subtype*}% set \caption@position + \caption@iftop{\subfloat@@@ t}{\subfloat@@@ b}% + {#1}\subcaptionbox@hj@default} +\newcommand\subfloat@@@[3]{% + \endgroup + \parbox[#1]{\wd\@tempboxa}{% + #2% \@firstoftwo in star form, \@secondoftwo otherwise + {\captionsetup{subtype*,position=#1}}% + {\captionsetup{subtype,position=#1}% + \caption@refstepcounter\@subcaptype + \caption@prepareanchor\@subcaptype{}% + \caption@makeanchor{}}% + \caption@iftop{\hrule\@height\z@}{}% + \csname caption@hj@#3\endcsname + \unhbox\@tempboxa + \caption@iftop{}{\hrule\@height\z@}}}% \g@addto@macro\caption@subtypehook{% \ifx\label\subcaption@label \else \let\subcaption@ORI@label\label |