diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/README | 39 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-deu.pdf | bin | 321472 -> 320101 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-deu.tex | 167 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-eng.pdf | bin | 306378 -> 330119 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-eng.tex | 620 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption.pdf | bin | 352782 -> 354519 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption2.pdf | bin | 139001 -> 139207 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/ltcaption.pdf | bin | 119481 -> 121528 bytes |
8 files changed, 640 insertions, 186 deletions
diff --git a/Master/texmf-dist/doc/latex/caption/README b/Master/texmf-dist/doc/latex/caption/README new file mode 100644 index 00000000000..c325886fd90 --- /dev/null +++ b/Master/texmf-dist/doc/latex/caption/README @@ -0,0 +1,39 @@ +The caption package bundle +Copyright (C) 1994-2007 Axel Sommerfeldt (caption@sommerfee.de) + +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 + +-------------------------------------------------------------------------- + +The caption package v3.1 offers customization of captions in floating +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. + +Furthermore the `floatrow' and the `subfig' package supports the +caption package and use its \captionsetup interface. + +User Manual: caption-eng.pdf (English) + caption-rus.pdf (Russian) + caption-deu.pdf (German) + +-------------------------------------------------------------------------- + +The ltcaption package v1.1 fixes caption problems with other-than-centered +aligned longtables. (solving LaTeX PR `tools/3387') + +A bonus feature is the addition of the environment longtable* which does +not increment the table counter. + +This package will be loaded by the caption package v3.1 automatically, +but can be used without the caption package, too. + +User Manual: ltcaption.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 b1dc4ca62f6..b5398813498 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 e4319a124bc..3b2b526eefd 100644 --- a/Master/texmf-dist/doc/latex/caption/caption-deu.tex +++ b/Master/texmf-dist/doc/latex/caption/caption-deu.tex @@ -23,7 +23,7 @@ % caption-eng.tex, and caption-rus.tex. % \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{caption-deu.tex}[2007/09/22 v3.1b Das caption-Paket] +\ProvidesFile{caption-deu.tex}[2007/10/01 v3.1c Das caption-Paket] \hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. %\errorcontextlines=3 @@ -196,9 +196,10 @@ Gestaltungsmerkmale einfließen lassen. \clearpage \section*{Vorläufige Dokumentation} -Diese Anleitung beschreibt leider noch nicht alle Fassetten und Möglichkeiten, -die einem \thispackage\ bietet. Ich werde mich bemühen, jeden Monat eine -etwas vollständigere Fassung bereitzustellen; die jeweile aktuelle Fassung kann +Diese Anleitung ist leider teilweise inkonsistent und insbesondere noch nicht +fertiggestellt. +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-eng.pdf}% {hier} bezogen werden.\par\bigskip @@ -543,7 +544,7 @@ zentriert werden, wenn sie lediglich aus einer einzigen Textzeile bestehen: \INFO Diesen Mechanismus "ubernimmt \thispackage\ und ignoriert damit in der Regel bei solch kurzen Beschriftungen die mittels der Optionen -|format=| und |justification=| eingestellte Textausrichtung. +|justification=| und |indention=| eingestellte Textausrichtung. Dieses Verhalten kann jedoch mit der Option \begin{quote} |singlelinecheck=|\meta{bool} @@ -764,8 +765,8 @@ entspricht den Optionen |textfont=,margin=0pt,indention=0pt,parindent=0pt|\\ |hangindent=0pt,singlelinecheck=true| \end{quote} -(Aber |justification=centering| wird automatisch gewählt werden, - wenn die Beschriftung in eine einzelne Zeile passt.) +{\small(Aber |justification=centering,indention=0pt| wird automatisch + gewählt werden, wenn die Beschriftung in eine einzelne Zeile passt.)} Der Stil |default| hingegen folgt den Standardwerten der verwendeten Dokumentenklasse. Dieser Stil wird vorausgewählt und entspricht den @@ -776,14 +777,14 @@ Optionen |textfont=default,margin=0pt,indention=0pt,parindent=0pt|\\ |hangindent=0pt,singlelinecheck=true|\quad. \end{quote} -(Aber |justification=centering| und |format=plain| wird automatisch gewählt werden, - wenn die Beschriftung in eine einzelne Zeile passt.) +{\small(Aber |justification=centering,indention=0pt| wird ebenso automatisch + gewählt werden, wenn die Beschriftung in eine einzelne Zeile passt.)} Wenn also eine der drei Standard"=\LaTeX"=Dokumentenklassen verwendet wird, zeigen |base| und |default| auf (fast) die gleichen Einstellungen. -\emph{Hinweis:} Eigene Stile k"onnen mittels |\DeclareCaptionStyle| definiert werden. -\SeeUserDefined +{\small\emph{Hinweis:} Eigene Stile k"onnen mittels |\DeclareCaptionStyle| + definiert werden. \SeeUserDefined} % --------------------------------------------------------------------------- % @@ -1250,7 +1251,7 @@ Als Beispiel mu"s mal wieder eine einfache Definition innerhalb dieses Paketes herhalten, so ist der Stil |base| definiert als \begin{quote} |\DeclareCaptionStyle{base}%|\\ - | [format=plain,justification=centering]{}|\quad. + | [justification=centering,indention=0pt]{}|\quad. \end{quote} % --------------------------------------------------------------------------- % @@ -1307,6 +1308,7 @@ Auch dies läßt sich bewerkstelligen, z.B.~folgendermaßen: \end{quote} \bigskip\pagebreak[3] + Ein anderes Beispiel: Die Beschriftungen sollen wie folgt aussehen: %\begin{Example} % \captionsetup{aboveskip=0pt} @@ -1324,27 +1326,9 @@ Dies lie"se sich z.B. wie folgt realisieren: |\captionsetup{format=reverse,labelformat=fullparens,|\\ | labelsep=fill,font=small,labelfont=it}| \end{quote}} -Für kurze Beschriftungen, die in eine einzige Zeile passen, wird dieses -Format jedoch nicht automatisch angewandt, da die Option |format=plain| Teil -der \meta{zusätzlichen Optionen} des Beschrifungsstils |default| ist. -Dies läßt sich auf verschiedene Arten ändern, so könnte man z.B.~den -|singlelinecheck| auf |off| setzen. Wenn man die Zentrierung aber beibehalten -möchte, bietet sich die Definition eines eigenen Beschriftungstils an, etwa so: -\begin{quote} - |\DeclareCaptionStyle{mystyle}%|\\ - | [justification=centering]{format=myformat}|\\ - |\captionsetup{style=mystyle}| -\end{quote} -oder -\begin{quote} - |\DeclareCaptionFormat{myshortformat}{|\ldots - \textit{was-auch-immer\ldots}|}|\\ - |\DeclareCaptionStyle{mystyle}%|\\ - | [format=myshortformat]{format=myformat}|\\ - |\captionsetup{style=mystyle}| -\end{quote} \bigskip\pagebreak[3] + Ein weiteres Beispiel: Der Bezeichner soll in den linken Rand verlagert werden, so da"s die komplette Absatzbreite der Beschriftung selber zugute kommt: {\leftmargini=10pt @@ -1414,7 +1398,7 @@ Sie in einem solchen Fall keinen Support. \newcommand*\settings{\textit{Einstellungen}} \newcommand*\nofont{\textit{keiner}} -\subsection{Standard \LaTeX: article, report und book} +\subsection{Standard \LaTeX: article, report \& book} \begin{tabular}{ll} \Option & \defaultvalue \\\hline @@ -1469,7 +1453,7 @@ und |\set|\x|beamer|\x|template|\xx|{caption}|\xx|[|\meta{template}|]| keine Funktion mehr, wenn \thispackage\ verwendet wird. -\subsection{\KOMAScript: scrartcl, scrreprt, and scrbook} +\subsection{\KOMAScript: scrartcl, scrreprt \& scrbook} \label{KOMA} \begin{tabular}{ll} @@ -1497,7 +1481,7 @@ Weiterhin überschreiben die \KOMAScript"=Optionen |tablecaptionabove| \& |\captionbelow| die Einstellungsmöglichkeit |position=|, die \thispackage{} anbietet. -\subsection{\NTG: artikel, rapport und boek} +\subsection{\NTG: artikel, rapport \& boek} \label{NTG} \begin{tabular}{ll} @@ -2183,6 +2167,7 @@ Befehl & & Abschnitt \\ |\DeclareCaptionOption| & & \ref{declare} \\ |\DeclareCaptionStyle| & & \ref{declare} \\ |\DeclareCaptionTextFormat| & & \ref{declare} \\ +|\DeclareFloatingEnvironment| & & \ref{DeclareFloatingEnvironment} \\ |\showcaptionsetup| & & \ref{commands} \\ \end{longtable} @@ -2478,7 +2463,9 @@ Option & Kurzbeschreibung & Abschnitt \\ \begin{Warnings} \Message - |! Argument of \@caption has an extra }.| + |Argument of \@caption has an extra }.|\\ +{\color{black}\hspace{1.5em}-- oder --}\\ + |Paragraph ended before \@caption was complete.| \Description Beim Setzen von Beschriftungen, die etwas spezielles wie z.B.~eine Tabelle enthält, ist zu beachten, daß immer ein alternativer Listeneintrag @@ -2571,19 +2558,6 @@ Option & Kurzbeschreibung & Abschnitt \\ einen Fehlerbericht per E-Mail. \Message - |! LaTeX Error: Option clash for package caption.|\\ -{\color{black}\hspace{1.5em}-- oder --}\\ - |! LaTeX Error: Missing \begin{document}.| -\Description - Ein anderes \LaTeX-Paket hat \thispackage\ bereits geladen, Sie können es - daher nicht noch einmal mit anderen Optionen laden. - Als Verdächtiger kommt das \package{subfig}"=Paket in Frage, sollte dies - zutreffen, laden Sie bitte entweder \thispackage\ \emph{vor} dem - \package{subfig}"=Paket oder geben beim Laden des \package{subfig}"=Paketes - die Option |caption=false| an. - \par\See{Dokumentation des \package{subfig}"=Paketes\cite{subfig}} - -\Message |Not allowed in longtable* environment.| \Description Der Befehl |\caption| ist nicht immerhalb einer |longtable*| Umgebung @@ -2600,8 +2574,28 @@ Option & Kurzbeschreibung & Abschnitt \\ \par\See{\Ref{compatibility}} \Message + |Only one \caption can be placed in this environment.| +\Description + Innerhalb der Umgebungen, die das \package{fltpage} oder \package{sidecap} + Paket zur Verfügung stellt, kann nur eine Bildbeschriftung gesetzt werden. + +\Message + |Option clash for package caption.|\\ +{\color{black}\hspace{1.5em}-- oder vielleicht auch --}\\ + |Missing \begin{document}.| +\Description + Ein anderes \LaTeX-Paket hat \thispackage\ bereits geladen, Sie können es + daher nicht noch einmal mit anderen Optionen laden. + Als Verdächtiger kommt z.B.~das \package{ctable} oder das + \package{subfig}"=Paket in Frage; sollte dies zutreffen, + laden Sie bitte entweder \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. + \par\See{Dokumentation des \package{subfig}"=Paketes\cite{subfig}} + +\Message |Runaway argument?|\\ - |! Paragraph ended before \caption@makecurrent was complete.| + |Paragraph ended before \caption@makecurrent was complete.| \Description Beim Setzen von Beschriftungen, die mehr als aus einem Absatz bestehen, ist zu beachten, daß immer ein alternativer Listeneintrag als optionales @@ -2641,12 +2635,13 @@ Option & Kurzbeschreibung & Abschnitt \\ |The option `labelsep=|\meta{name}|' does not work|\\ |with \setcaphanging (which is set by default).| \Description - Ein Bezeichnungstrenner, der ein |\\| Kommando enthält, kann - nicht mit einem Format kombiniert werden, welches "`hängende"' - Beschriftungen liefert. - Bitte wählen Sie einen anderen Trenner oder ein anderes - Beschriftungsformat aus. - \par\See{\Ref{formats} bzw.~\Ref{KOMA}} + Ein Bezeichnungstrenner, der ein |\\| Kommando enthält (wie etwa + |labelsep=|\xx|newline|), kann nicht mit einem Format kombiniert werden, + welches "`hängende"' Beschriftungen liefert (wie etwa |format=|\xx|hang|). + Bitte wählen Sie entweder einen anderen Trenner (wie + z.B. |labelsep=|\xx|colon|), oder aber ein anderes Beschriftungsformat + (wie z.B. |format=|\xx|plain|) aus. + \par\See{\Ref{formats} bzw.~\Ref*{KOMA}} \Message |The package option `caption=false' is obsolete.|\\ @@ -2835,121 +2830,141 @@ f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. \bibitem{beamer} Till Tantau:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf}% {\emph{User Guide to the Beamer Class, Version 3.07}},\\ March 11, 2007 \bibitem{KOMAScript} Markus Kohm \& Jens-Uwe-Morawski:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguide.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguide.pdf}% {\emph{KOMA-Script -- ein wandelbares \LaTeXe-Paket}},\\ 2007-03-02 \bibitem{NTG} Victor Eijkhout:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/ntgclass/classdoc.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/ntgclass/classdoc.pdf}% {\emph{An introduction to the Dutch \LaTeX\ document classes}},\\ 3 September 1989 \bibitem{float} Anselm Lingnau:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/float/float.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/float/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/float/float.pdf}% {\emph{An Improved Environment for Floats}},\\ 2001/11/08 \bibitem{floatflt} Mats Dahlgren:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf}% {\emph{Welcome to the floatflt package}},\\ 1998/06/05 \bibitem{floatrow} Olga Lapko:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}% {\emph{The floatrow package documentation}},\\ - 2006/07/24 + 2007/08/24 \bibitem{fltpage} Sebastian Gross:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/fltpage/fltpage.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/fltpage/fltpage.pdf}% {\emph{Welcome to the beta test of fltpage package!}},\\ 1998/11/13 \bibitem{hyperref} Sebastian Rahtz \& Heiko Oberdiek:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}% {\emph{Hypertext marks in \LaTeX}},\\ June 14, 2007 \bibitem{hypcap} Heiko Oberdiek:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.pdf}% {\emph{The hypcap package -- Adjusting anchors of captions}},\\ 2007/04/09 \bibitem{listings} Carsten Heinz \& Brooks Moses:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/listings/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}% {\emph{The Listings Package}},\\ 2007/02/22 \bibitem{longtable} David Carlisle:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/required/tools/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}% {\emph{The longtable package}},\\ 2004/02/01 \bibitem{picinpar} Friedhelm Sowa:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% + \href{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% {\emph{Pictures in Paragraphs}},\\ July 13, 1993 \bibitem{picins} Joachim Bleser und Edmund Lang:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex209/contrib/picins/mpic.dvi}% + \href{http://tug.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 und Leonor Barroca:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/rotating/}% + \href{http://tug.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}},\\ 1997/09/26 \bibitem{sidecap} Rolf Niepraschk \& Hubert G\"a\ss lein:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}% {\emph{The sidecap package}},\\ 2003/06/06 \bibitem{subfigure} Steven D. Cochran:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}% {\emph{The subfigure package}},\\ 2002/07/02 \bibitem{subfig} Steven D. Cochran:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/subfig/subfig.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/subfig/subfig.pdf}% {\emph{The subfig package}},\\ 2005/07/05 \bibitem{supertabular} Johannes Braams und Theo Jurriens:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}% + \href{http://tug.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}},\\ 2002/07/19 \bibitem{threeparttable} Donald Arseneau:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/misc/threeparttable.sty}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/misc/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/misc/threeparttable.sty}% {\emph{Three part tables: title, tabular environment, notes}},\\ 2003/06/13 \bibitem{wrapfig} Donald Arseneau:\\ - \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% {\emph{WRAPFIG.STY ver 3.6}},\\ 2003/01/31 \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 76d0c31ece3..6bb484396d2 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 831e97f493e..6f27f879e0f 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 @@ % caption-eng.tex, and caption-rus.tex. % \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{caption-eng.tex}[2007/09/22 v3.1b The caption package] +\ProvidesFile{caption-eng.tex}[2007/10/17 v3.1c The caption package] \hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. %\errorcontextlines=3 @@ -90,10 +90,11 @@ \newcommand*\xx{\discretionary{}{}{}} \newenvironment{Options}[1]% - {\list{}{\renewcommand{\makelabel}[1]{\texttt{##1}\hfil}% - \settowidth{\labelwidth}{\texttt{#1\space}}% - \setlength{\leftmargin}{\labelwidth}% - \addtolength{\leftmargin}{\labelsep}}}% + {\list{}{\renewcommand\makelabel[1]{\texttt{##1}\hfil}% + \settowidth\labelwidth{\texttt{#1\space}}% + \setlength\leftmargin{10pt}% + \addtolength\leftmargin{\labelwidth}% + \addtolength\leftmargin{\labelsep}}}% {\endlist} \newenvironment{Example}% @@ -131,7 +132,7 @@ \newcommand*\See[1]{\nopagebreak{\small (See #1)}} \newcommand*\SeeUserDefined[1][]{\See{\Ref{declare}#1}} -\def\TODO{\emph{-- Some information is missing here --}} +%\def\TODO{\emph{-- Some information is missing here --}} % --------------------------------------------------------------------------- % @@ -187,8 +188,8 @@ caption formatting options, but you are free to define your very own stuff, too. \section*{Preliminary documentation} -Please note that this document is not describing all features of \thispackage\ yet. -It'll try to update it every month; the actual version can be found +Please note that this document is inconsistent and not finished yet. +It'll try to update it within the next months; the actual version can always be found \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/caption/caption-eng.pdf}% {here}.\par\bigskip @@ -533,8 +534,8 @@ automatically center a caption if it fits in one single line: \INFO \Thispackage\ adapts this behaviour and therefore usually -ignores the format \& justification you have set with |format=| \& -|justification=| in such case. +ignores the justification \& indention you have set with |justification=| \& +|indention=| in such case. But you can switch this special treatment of such short captions off with the option \begin{quote} @@ -751,8 +752,8 @@ has the same effect as specifying all these options: |textfont=,margin=0pt,indention=0pt,parindent=0pt|\\ |hangindent=0pt,singlelinecheck=true| \end{quote} -(But |justification=centering| will be set if the caption fits into a - single line.) +{\small(But |justification=centering,indention=0pt| will be set if + the caption fits into a single line.)} In contrast the |default| style follows the default values, reflecting the look of the captions given by the document class you actually use. @@ -763,14 +764,14 @@ This style is selected by default and represents these options: |textfont=default,margin=0pt,indention=0pt,parindent=0pt|\\ |hangindent=0pt,singlelinecheck=true| \end{quote} -(But |justification=centering| and |format=plain| will be set if the - caption fits into a single line.) +{\small(But again |justification=centering,indention=0pt| will be set if + the caption fits into a single line.)} So if you use one of the base \LaTeX\ document classes, both |base| and |default| point to the nearly same settings. -\emph{Note:} Own caption styles can be defined using |\DeclareCaptionStyle|. -\SeeUserDefined +{\small\emph{Note:} Own caption styles can be defined using + |\DeclareCaptionStyle|. \SeeUserDefined} % --------------------------------------------------------------------------- % @@ -1222,7 +1223,7 @@ Again a very easy example taken from the core of this package: The caption style |base| is pre-defined as \begin{quote} |\DeclareCaptionStyle{base}%|\\ - | [format=plain,justification=centering]{}|\quad. + | [justification=centering,indention=0pt]{}|\quad. \end{quote} % --------------------------------------------------------------------------- % @@ -1280,6 +1281,7 @@ This could be done, too: would give the same result as the example above. \bigskip\pagebreak[3] + A different example: You want captions to look like this: %\begin{Example} % \captionsetup{aboveskip=0pt} @@ -1297,26 +1299,9 @@ You could do it this way: |\captionsetup{format=reverse,labelformat=fullparens,|\\ | labelsep=fill,font=small,labelfont=it}| \end{quote}} -For short captions---which fit into one single line---this format will not -be used, since |format=plain| is part of the \meta{single-line-code} of the -caption style |default| which will be used as long as no different style is -selected. If you don't like this, you could either switch the |singlelinecheck| -|off|, or you could define an appropriate style for yourself, e.g.: -\begin{quote} - |\DeclareCaptionStyle{mystyle}%|\\ - | [justification=centering]{format=myformat}|\\ - |\captionsetup{style=mystyle}| -\end{quote} -or -\begin{quote} - |\DeclareCaptionFormat{myshortformat}{|\ldots - \textit{use your illusion here}|}|\\ - |\DeclareCaptionStyle{mystyle}%|\\ - | [format=myshortformat]{format=myformat}|\\ - |\captionsetup{style=mystyle}| -\end{quote} \bigskip\pagebreak[3] + Another example: The caption text should go into the left margin; a possible solution would be: {\leftmargini=10pt @@ -1394,14 +1379,34 @@ If you don't get such warning everything is fine, but if you get it the usage of |textfont=| & \nofont \\ \end{tabular} -\textbf{Build-in features:} None - \noindent{\small(\emph{Note:} This also applies to document classes derived from them.)} \subsection{\AmS: amsart, amsproc, and amsbook} \label{AMS} -\TODO +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |plain| \\ +|labelformat=| & |simple| \\ +|labelsep=| & a period $+$ |\enspace| \\ +|justification=| & |justified| \\ +|font=| & |\@captionfont| \\ +|labelfont=| & |\@captionheadfont| \\ +|textfont=| & |\@captionfont\upshape| \\ +\end{tabular} + +{\small(|\@captionfont| will be set to |\normalfont|, and |\@captionheadfont| to |\scshape| + by the \AmS\ document classes.)} + +Furthermore the margin will be set to |\captionindent| 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 |\clearcaptionsetup[margin]{SingleLine}| +into the preamble of your document, after loading \thispackage. + +Additionally the options |figureposition=b,tableposition=t| will be set. +You can override these settings by specifing other values for +|figureposition=| or |tableposition=| in the option list while loading \thispackage. \subsection{beamer} \label{beamer} @@ -1482,7 +1487,12 @@ one of the two options |labelfont=| or |textfont=| offered by \thispackage. \subsection{\SmF{} classes: smfart and smfbook} \label{SMF} -\TODO +Since the \SmF\ document classes are derived from the \AmS\ document classes +the same default values are valid here. + +Additionally the margin is limited up to the tenth of the |\linewidth|. +If you don't like this limitation, you can switch it off with the option +|maxmargin=off| or |maxmargin=false| (which both means the same). \subsection{The frenchb Babel option} \label{frenchb} @@ -1544,41 +1554,158 @@ captions, too: Furthermore the \package{floatrow} and the \package{subfig} package supports \thispackage\ and use its |\captionsetup| interface. +\newcommand\packagedescription[1]{% + \nopagebreak + \parbox[b]{\linewidth}{\footnotesize\leftskip=10pt\rightskip=10pt\relax#1}% + \nopagebreak\smallskip\nopagebreak} +\newcommand\Note{\smallskip\emph{Note:}~} + +\pagebreak[3] \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 +|position| 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 +\begin{quote} + |\DeclareCaptionStyle{ruled}{labelfont=bf,labelsep=space,|\\ + | strut=off}|~. +\end{quote} +So to change this you need either define your own caption style called +|ruled| or use |\captionsetup[ruled]|\marg{options}.%, +%e.g.~|\captionsetup[ruled]{labelsep=colon}|. + +Also by using this mechanism the skip between a |boxed| float and its caption +is specified, overriding its global value: +\begin{quote} + |\captionsetup[boxed]{skip=2pt}| +\end{quote} +For changing this just use |\captionsetup[boxed]{skip=|\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}|. + +\Note +Only one single caption can be typeset inside environments defined with +\cs{newfloat} or \cs{restylefloat}, futhermore these environments are not +behaving exactly like the pre-defined floats |figure| \& |table|. +As a consequence many packages do not coorperate 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{DeclareFloatingEnvironment} +instead. +And for defining non-simple floating environments and customization I +recommend using the \package{floatrow} package\cite{floatrow} instead. -\TODO +\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 +wrong. +And |\restylefloat{table}| is a very good method to shoot yourself +in the foot, since many packages using |table| internally are not working +correctly afterwards. +\fi +\pagebreak[4] \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.} + +\NEWfeature{v3.1} +If you want to setup special options for the |floatingfigure| \& |floatingtable| +environments you can use +\begin{quote} + |\captionsetup[floatingfigure]|\marg{options}\\ + |\captionsetup[floatingtable]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|figure| or |table|. -\TODO +\Note +The |margin| resp.~|width| setting will not be used for these figures \& tables, +unless you set it explicit with |\captionsetup[floatingfigure]{|\ldots|}| or +|\captionsetup[floatingtable]{|\ldots|}|. +\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.} + +\NEWfeature{v3.1} +Two options control the links to the |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|.) +\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|.) +\end{description} + +If you want to setup special options for the |FPfigure| \& |FPtable| +environments you can use +\begin{quote} + |\captionsetup[FPfigure]|\marg{options}\\ + |\captionsetup[FPtable]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|figure| or |table|. -\TODO +Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define +an environment called |FP|\meta{name} which behaves like |FPfigure| and +|FPtable|. +\pagebreak[4] \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.} \NEWfeature{v3.1} -There are two options available to control hyperlinks: +There are two options available to control the placement of hyperlink anchors: \begin{description} -\item{\texttt{hypcap=}}\\[\smallskipamount] +\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 placed at the caption.\par +If set to |false| the hyperlink anchor is (usually) placed at the caption.\par (The default setting is |hypcap=true|.) -\item{\texttt{hypcapspace=}}\\[\smallskipamount] -This controls the vertical distance between the hyperlink anchor and -the (floating) environment, e.g.~|hypcapspace=0pt| removes the space.\par +\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.~|hypcapspace=0pt| removes this distance.\par (The default setting is |hypcapspace=0.5\baselineskip|.) \end{description} -Please note: +Both settings have no effect in |lstlisting|s (provided by the +\package{listings} package), |longtable|s (provided by the +\package{longtable} package), and |supertabular|s (provided by the +\package{supertabular} package), within these environments hyperlink +anchors will always be placed as if |hypcap=true| \& |hypcapspace=0pt| +would be set. +\pagebreak[3]Please note:\nopagebreak \begin{description} \item{\cs{captionof}\marg{type}\csmarg\ldots\ vs. \cs{captionsetup}\csmarg{type=\meta{type}}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount] @@ -1602,7 +1729,9 @@ 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 |minipage|, +since |\captionsetup{type=figure}| does not only set the caption type +to ``figure'' but does place a hyperlink anchor, too. \item{\cs{caption}\csoarg{}\csmarg\ldots\ vs. \cs{captionsetup}\csmarg{listof=false}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount] @@ -1616,70 +1745,310 @@ So it's better to use \cs{captionsetup}\csmarg{listof=false} if you don't want an entry in the List of Figures or List of Tables. \end{description} +\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 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. - -This has the side-effect that you lost the good placement of the hyperlink anchors -in |floatingfigure|s (provided by the \package{floatflt} package), -in |figwindow|s (provided by the \package{picinpar} package), -in |parpic|s (provided by the \package{picins} package), and -in |wrapfigure|s (provided by the \package{wrapfig} package). - -Furthermore |\captionsetup{type=|\meta{type}|}| will not place hyperlink anchors -anymore, instead you need to use |\capstart| (provided by the \package{hypcap} package). +package, it takes over the control of the hyperlink anchor placement from \thispackage, +overriding the options |hypcap=| \& |hypcapspace=|. + +So for a manual placement of hyperlink anchors |\captionsetup{type=|\meta{type}|}| +is not sufficient anymore, instead you need to use |\capstart| +(provided by the \package{hypcap} package) for this. + +Regarding the automatical 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. +\pagebreak[3] \subsection{listings} \label{listings} +\packagedescription{% +The \package{listings} package\cite{listings} typesets programming code.} -\TODO +If you want to setup special options for the |lstlinsting| environment +you can use +\begin{quote} + |\captionsetup[lstlisting]|\marg{options}\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.} + +If you want to setup special options for the |longtable| environment +you can use +\begin{quote} + |\captionsetup[longtable]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|table|. -\TODO +The |margin| \& |width| settings usually override |\LTcapwidth|, so +you get an equal look \& feel of the captions in |table|s and +|longtable|s. But if you set |\LTcapwidth| to a value different from +its default $=$ |4in|, \thispackage\ will follow that. +(But |\LTcapwidth| will be overwritten by +|\captionsetup[longtable]{width=|\meta{value}|}|, even if it is set +to a value different than |4in|.) +\Note +\cs{captionof} and \cs{ContinuedFloat} do not work for |longtable|s. +\NEWfeature{v3.1} +If you need a |longtable| which does not increment the |table| counter +please use the |longtable*| environment offered by \thispackage. + +\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}.} + +\NEWfeature{v3.1} +If you want to setup special options for the |figwindow| \& |tabwindow| +environments you can use +\begin{quote} + |\captionsetup[figwindow]|\marg{options}\\ + |\captionsetup[tabwindow]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|figure| or |table|. -\TODO +\Note +The |margin| resp.~|width| setting will not be used for these figures \& tables, +unless you set it explicit with |\captionsetup[figwindow]{|\ldots|}| or +|\captionsetup[figtable]{|\ldots|}|. +\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}.} + +\NEWfeature{v3.1} +If you want to setup special options for the |parpic| 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|. -\TODO +\Note +The |margin| resp.~|width| setting will not be used for these figures \& tables +if \cs{piccaptionside} or \cs{piccaptiontopside} is used. +The |width| setting will not be used (but the |margin| setting will) if +\cs{piccaptionoutside} or \cs{piccaptioninside} is used. +But you can override this by setting it explicit with +|\captionsetup[parpic]{|\ldots|}|. +\Note +If you want to have a |\piccaption| of another type as |figure|, please do +\emph{not} re-define |\@captype| as suggested by the \package{picins} +documentation. Please use the |\piccaptiontype|\marg{type} command which is +offered by \thispackage\ instead, e.g.: +\begin{quote} + |\piccaptiontype{table}|\\ + |\piccaption{An example table}|\\ + |\parpic(50mm,10mm)[s]{|\ldots|}| +\end{quote} + +\pagebreak[3] \subsection{rotating} \label{rotating} +\packagedescription{% +The \package{rotating} package\cite{rotating} offers the floating +environments \texttt{sideways\-figure} and \texttt{sideways\-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.} + +\iffalse % No, we don't do that +If you want to setup special options for the |sidewaysfigure| \& |sidewaystable| +environments you can use +\begin{quote} + |\captionsetup[sidewaysfigure]|\marg{options}\\ + |\captionsetup[sidewaystable]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|figure| or |table|. +\fi + +The command \cs{rotcaption} will be extended by \thispackage, so +|\rotcaption*| or |\rotcaptionof| can be used analogous to |\caption| and +|\captionof|. -\TODO +\NEWfeature{v3.1} +Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define +an environment called |sideways|\meta{name} which behaves like +|sidewaysfigure| and |sidewaystable|. +\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.} + +If you want to setup special options for the |SCfigure| \& |SCtable| +environments you can use +\begin{quote} + |\captionsetup[SCfigure]|\marg{options}\\ + |\captionsetup[SCtable]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|figure| or |table|. + +\NEWfeature{v3.1} +Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define +an environment called |SC|\meta{name} which behaves like |SCfigure| and +|SCtable|. -\TODO +\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. +\Note +The |margin| resp.~|width| setting will not be used for these figures \& tables, +unless you set it explicit with |\captionsetup|\xx|[SCfigure]|\xx|{|\ldots|}| +or |\captionsetup|\xx|[SCtable]|\xx|{|\ldots|}|. + +\medskip{\small(Instead of using the \package{sidecap} package you can also use +the \package{floatrow} package\cite{floatrow} for this purpose.)} + +\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 subfig instead.} + +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. -\TODO +Please use the \package{subfig} package instead with supports \thispackage\ +\version{3.x}. +\See{the \package{subfig} package\cite{subfig} documentation for details.} + +\pagebreak[3] \subsection{supertabular} \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}.} + +If you want to setup special options for the |supertabular| environment +you can use +\begin{quote} + |\captionsetup[supertabular]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|table|. -\TODO +\Note +\cs{ContinuedFloat} does not work for |supertabular|s. +\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.} + +\NEWfeature{v3.1} +If you want to setup special options for the |threeparttable| \& +|measuredfigure| environments you can use +\begin{quote} + |\captionsetup[threeparttable]|\marg{options}\\ + |\captionsetup[measuredfigure]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|table| or |figure|. -\TODO +\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 +|\captionsetup|\xx|[threeparttable]|\xx|{|\ldots|}| +or |\captionsetup|\xx|[measuredfigure]|\xx|{|\ldots|}|. +\medskip{\small(Instead of using the \package{sidecap} package you can also use +the \package{floatrow} package\cite{floatrow} for this purpose.)} + +\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}.} -\TODO +\NEWfeature{v3.1} +If you want to setup special options for the |wrapfigure| \& |wraptable| +environments you can use +\begin{quote} + |\captionsetup[wrapfigure]|\marg{options}\\ + |\captionsetup[wraptable]|\marg{options}\quad. +\end{quote} +These options will be executed additionally to the regular ones for +|figure| or |table|. + +Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define +an environment called |wrap|\meta{name} which behaves like |wrapfigure| and +|wraptable|. + +\Note +The |margin| resp.~|width| setting will not be used for these figures \& tables, +unless you set it explicit with |\captionsetup[wrapfigure]{|\ldots|}| or +|\captionsetup[wraptable]{|\ldots|}|. + +\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. % --------------------------------------------------------------------------- % @@ -1963,6 +2332,7 @@ Command & & Section \\ |\DeclareCaptionOption| & & \ref{declare} \\ |\DeclareCaptionStyle| & & \ref{declare} \\ |\DeclareCaptionTextFormat| & & \ref{declare} \\ +|\DeclareFloatingEnvironment| & & \ref{DeclareFloatingEnvironment} \\ |\showcaptionsetup| & & \ref{commands} \\ \end{longtable} @@ -2245,7 +2615,9 @@ Option & Short description & Section \\ \begin{Warnings} \Message - |! Argument of \@caption has an extra }.| + |Argument of \@caption has an extra }.|\\ +{\color{black}\hspace{1.5em}-or-}\\ + |Paragraph ended before \@caption was complete.| \Description If you want to typeset something special (like a tabular) as caption, you need to give an optional argument to |\caption| resp.~|\captionof| @@ -2330,19 +2702,6 @@ Option & Short description & Section \\ Please send me an e-mail reporting this issue. \Message - |! LaTeX Error: Option clash for package caption.|\\ -{\color{black}\hspace{1.5em}-- oder --}\\ - |! LaTeX Error: Missing \begin{document}.| -\Description - \Thispackage\ has already been loaded by some other \LaTeX\ package, - so you can't do that again specifying different options. - A candidate causing this could be the \package{subfig} package; if this is - the case, please load \thispackage\ \emph{before} the \package{subfig} - package or specify the option |caption=false| while loading the - \package{subfig} package. - \par\See{the \package{subfig} package\cite{subfig} documentation} - -\Message |Not allowed in longtable* environment.| \Description The usage of |\caption| is not allowed inside the |longtable*| environment. @@ -2360,8 +2719,26 @@ Option & Short description & Section \\ \par\See{\Ref{compatibility}} \Message - |Runaway argument?|\\ - |! Paragraph ended before \caption@makecurrent was complete.| + |Only one \caption can be placed in this environment.| +\Description + Inside the environments offered by the \package{fltpage} and \package{sidecap} + package only one caption can be placed. (This is due implementation design.) + +\Message + |Option clash for package caption.|\\ +{\color{black}\hspace{1.5em}-- or maybe --}\\ + |Missing \begin{document}.| +\Description + \Thispackage\ has already been loaded by some other \LaTeX\ package, + so you can't do that again specifying different options. + A candidate causing this could be the \package{subfig} package; if this is + the case, please load \thispackage\ \emph{before} the \package{subfig} + package or specify the option |caption=false| while loading the + \package{subfig} package. + \par\See{the \package{subfig} package\cite{subfig} documentation} + +\Message + |Paragraph ended before \caption@makecurrent was complete.| \Description If you want to typeset multi-paragraph captions, you need to give an optional argument to |\caption| resp.~|\captionof| for the List of @@ -2399,9 +2776,12 @@ Option & Short description & Section \\ |The option `labelsep=|\meta{name}|' does not work|\\ |with \setcaphanging (which is set by default).| \Description - A caption label separator which contains a newline command (|\\|) - does not work with a hanging caption format. - Please select another caption format or another caption label seperator. + A caption label separator which contains a |\\| command (like + |labelsep=|\xx|newline|) can not be combined with a hanging caption format + (like |format=|\xx|hang|). + Please select either another caption label seperator + (e.g.~|labelsep=|\xx|colon|) or another caption format + (e.g.~|format=|\xx|plain|). \par\See{\Ref{formats} resp.~\Ref{KOMA}} \Message @@ -2571,121 +2951,141 @@ who all helped to make this package a better one. \bibitem{beamer} Till Tantau:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf}% {\emph{User Guide to the Beamer Class, Version 3.07}},\\ March 11, 2007 \bibitem{KOMAScript} Markus Kohm \& Jens-Uwe-Morawski:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguien.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguien.pdf}% {\emph{KOMA-Script -- a versatile \LaTeXe\ bundle}},\\ 2007-01-09 \bibitem{NTG} Victor Eijkhout:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/classdoc.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/classdoc.pdf}% {\emph{An introduction to the Dutch \LaTeX\ document classes}},\\ 3 September 1989 \bibitem{float} Anselm Lingnau:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/float/float.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/float/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/float/float.pdf}% {\emph{An Improved Environment for Floats}},\\ 2001/11/08 \bibitem{floatflt} Mats Dahlgren:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf}% {\emph{Welcome to the floatflt package}},\\ 1998/06/05 \bibitem{floatrow} Olga Lapko:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}% {\emph{The floatrow package documentation}},\\ - 2006/07/24 + 2007/08/24 \bibitem{fltpage} Sebastian Gross:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/fltpage.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/fltpage.pdf}% {\emph{Welcome to the beta test of fltpage package!}},\\ 1998/11/13 \bibitem{hyperref} Sebastian Rahtz \& Heiko Oberdiek:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}% {\emph{Hypertext marks in \LaTeX}},\\ June 14, 2007 \bibitem{hypcap} Heiko Oberdiek:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.pdf}% {\emph{The hypcap package -- Adjusting anchors of captions}},\\ 2007/04/09 \bibitem{listings} Carsten Heinz \& Brooks Moses:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/listings/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}% {\emph{The Listings Package}},\\ 2007/02/22 \bibitem{longtable} David Carlisle:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/required/tools/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}% {\emph{The longtable package}},\\ 2004/02/01 \bibitem{picinpar} Friedhelm Sowa:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% + \href{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% {\emph{Pictures in Paragraphs}},\\ July 13, 1993 \bibitem{picins} Joachim Bleser and Edmund Lang:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/mpic.dvi}% + \href{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/mpic.dvi}% {\emph{PicIns-Benutzerhandbuch Version 3.0}},\\ September~1992 \bibitem{rotating} Sebastian Rahtz and Leonor Barroca:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}% {\emph{A style option for rotated objects in \LaTeX}},\\ 1997/09/26 \bibitem{sidecap} Rolf Niepraschk \& Hubert G\"a\ss lein:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}% {\emph{The sidecap package}},\\ 2003/06/06 \bibitem{subfigure} Steven D. Cochran:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}% {\emph{The subfigure package}},\\ 2002/07/02 \bibitem{subfig} Steven D. Cochran:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/subfig.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/subfig.pdf}% {\emph{The subfig package}},\\ 2005/07/05 \bibitem{supertabular} Johannes Braams and Theo Jurriens:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}% {\emph{The supertabular environment}},\\ 2002/07/19 \bibitem{threeparttable} Donald Arseneau:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/misc/threeparttable.sty}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/misc/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/misc/threeparttable.sty}% {\emph{Three part tables: title, tabular environment, notes}},\\ 2003/06/13 \bibitem{wrapfig} Donald Arseneau:\\ - \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% + \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/}% +% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}% {\emph{WRAPFIG.STY ver 3.6}},\\ 2003/01/31 \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 f2a77dbc3cb..2ff8927af65 100644 --- a/Master/texmf-dist/doc/latex/caption/caption.pdf +++ b/Master/texmf-dist/doc/latex/caption/caption.pdf diff --git a/Master/texmf-dist/doc/latex/caption/caption2.pdf b/Master/texmf-dist/doc/latex/caption/caption2.pdf Binary files differindex b147a061142..ab1a998f21b 100644 --- a/Master/texmf-dist/doc/latex/caption/caption2.pdf +++ b/Master/texmf-dist/doc/latex/caption/caption2.pdf diff --git a/Master/texmf-dist/doc/latex/caption/ltcaption.pdf b/Master/texmf-dist/doc/latex/caption/ltcaption.pdf Binary files differindex a3bdde8d319..a7917e089a9 100644 --- a/Master/texmf-dist/doc/latex/caption/ltcaption.pdf +++ b/Master/texmf-dist/doc/latex/caption/ltcaption.pdf |