diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/caption/caption-deu.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/caption/caption-deu.tex | 4682 |
1 files changed, 3381 insertions, 1301 deletions
diff --git a/Master/texmf-dist/doc/latex/caption/caption-deu.tex b/Master/texmf-dist/doc/latex/caption/caption-deu.tex index a4cd8cedece..2d189a0e2b8 100644 --- a/Master/texmf-dist/doc/latex/caption/caption-deu.tex +++ b/Master/texmf-dist/doc/latex/caption/caption-deu.tex @@ -1,6 +1,6 @@ -% +% % This is file `caption-deu.tex'. -% +% % Copyright (C) 1994-2007 Axel Sommerfeldt (caption@sommerfee.de) % % -------------------------------------------------------------------------- @@ -23,32 +23,49 @@ % user manuals caption-deu.tex, caption-eng.tex, and caption-rus.tex. % \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesFile{caption-deu.tex}[2007/10/02 v3.1c Das caption-Paket] +\ProvidesFile{caption-deu.tex}[2008/03/16 v3.1g Das caption-Paket] \hbadness=9999 \newcount\hbadness \hfuzz=20pt % Make TeX shut up. %\errorcontextlines=3 -\documentclass[a4paper]{ltxdoc} +\RequirePackage{fix-cm} +\documentclass[german]{ltxdoc} +\usepackage{fixltx2e} \setlength\parindent{0pt} -\setlength\parskip{\medskipamount} +\setlength\parskip{\smallskipamount} +\setlength\leftmargini{2em}% default = 2.5em +\makeatletter\g@addto@macro\MacroFont{\normalcolor}\makeatother -%%%\usepackage[T1]{fontenc} +\newcommand\LineBreak{\linebreak[3]} +\newcommand\PageBreak{\pagebreak[3]} \usepackage{ifpdf} \ifpdf \usepackage{mathptmx,courier} \usepackage[scaled=0.90]{helvet} \addtolength\marginparwidth{15pt} + \ifdim\paperheight=297mm % a4paper + \renewcommand\LineBreak{\\} + \renewcommand\PageBreak{\clearpage} + \fi \fi -\usepackage[german]{babel} +\usepackage[T1]{fontenc} +\usepackage{babel} +\selectlanguage{german} +\input dehyphtex.tex \IfFileExists{selinput.sty}% {\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}}% {\usepackage[latin1]{inputenc}} -\usepackage{longtable,setspace} + +\usepackage[bottom]{footmisc} +\usepackage{graphicx,longtable,setspace} +\IfFileExists{test/tlc2/cat.eps}{\graphicspath{{test/tlc2/}}}{}% \usepackage{hypdoc} \ifpdf\usepackage{hypdestopt}\fi -\hypersetup{german,pdfkeywords={LaTeX, package, caption},pdfstartpage={},pdfstartview={}} -\usepackage[listof=0,hypcap=false]{caption}[2007/09/01] +\hypersetup{pdfkeywords={LaTeX, package, caption},pdfstartpage={},pdfstartview={}} +\hypersetup{breaklinks=true} + +\usepackage[listof=0,hypcap=false]{caption}[2008/01/12] \DeclareRobustCommand*\eTeX{\texorpdfstring {\leavevmode\hbox{$\varepsilon$}-\TeX}% @@ -62,49 +79,61 @@ \DeclareRobustCommand*\NTG{NTG} \DeclareRobustCommand*\SmF{SMF} -\newcommand\NEW[2]{\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} +\newcommand\NEW[2]{}%\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} \usepackage{marvosym} \makeatletter \newcommand*\INFO{\@ifstar{\@INFO{}}{\@INFO{\vbox to \ht\strutbox}}} -\newcommand*\@INFO[1]{\MARGINSYM{#1{\Huge\Info}}} +\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}}}} +% \ContinuedFloat +\DeclareCaptionLabelFormat{continued}{#1~#2 (Fortsetzung)} +% \DeclareCaptionLabelFormat +\DeclareCaptionLabelFormat{bf-parens}{(\textbf{#2})} +% \DeclareCaptionStyle +\DeclareCaptionStyle{mystyle}[margin=5mm,justification=centering]% + {font=footnotesize,labelfont=sc,margin={10mm,0mm}} +% Example 1 \DeclareCaptionFormat{myformat1}{#1#2\\#3} \newlength\myindention \DeclareCaptionFormat{myformat2}{#1#2\\\hspace*\myindention#3} \DeclareCaptionOption{myindention}{\setlength\myindention{#1}} +% Example 2 \DeclareCaptionFormat{reverse}{#3#2#1} -\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par} \DeclareCaptionLabelFormat{fullparens}{(\bothIfFirst{#1}{~}#2)} \DeclareCaptionLabelSeparator{fill}{\hfill} +% Example 3 +\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par} +\DeclareCaptionFormat{llapx}{\llap{\makebox[2.5cm][l]{#1}}#3\par} +% Example 4 +\DeclareCaptionLabelFormat{andtable}{#1~#2 \& \tablename~\thetable} \newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}} \newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}} \newcommand*\purett[1]{{\upshape\mdseries\ttfamily #1}} -\let\package\puresf -\let\env\purett \let\opt\purett +\let\class\puresf \let\package\puresf \newcommand*\csmarg[1]{\texttt{\char`\{#1\char`\}}} \newcommand*\csoarg[1]{\texttt{\char`\[#1\char`\]}} \newcommand*\version[2][]{$v#2$} -\newcommand*\x{\discretionary{-}{}{}} -\newcommand*\xx{\discretionary{}{}{}} +\newcommand*\x{\discretionary{}{}{}} -\newenvironment{Options}[1]% - {\list{}{\renewcommand{\makelabel}[1]{\texttt{##1}\hfil}% - \settowidth{\labelwidth}{\texttt{#1\space}}% - \setlength{\leftmargin}{\labelwidth}% - \addtolength{\leftmargin}{\labelsep}}}% - {\endlist} +\newenvironment{Annotation}% + {\ifvmode\else\unskip\par\fi\pagebreak[2]% + \smallskip + \small(\ignorespaces}{\unskip)\par} +\newenvironment{Annotation*}% + {\ifvmode\else\unskip\par\fi\pagebreak[2]% + \small(\ignorespaces}{\unskip)\par} \newenvironment{Example}% - {\ifvmode\else\unskip\par\fi + {\ifvmode\else\unskip\par\fi\pagebreak[2]% \minipage{\linewidth}\smallskip}% - {\smallskip\endminipage} + {\smallskip\endminipage\par} \makeatletter \newcommand\example{\@ifstar @@ -119,6 +148,37 @@ \endgroup} \makeatother +\newenvironment{Expert}% + {\ifvmode\else\unskip\par\fi\pagebreak[3]% + \smallskip + \footnotesize\ignorespaces}{\par} +\newenvironment{Expert*}% + {\ifvmode\else\unskip\par\fi\pagebreak[3]% + \footnotesize\ignorespaces}{\par} + +\newenvironment{Note}[1][\DefaultNoteText]% + {\ifvmode\else\unskip\par\fi + \smallskip + \small\emph{#1:}~\ignorespaces}{\par} +\newenvironment{Note*}[1][\DefaultNoteText]% + {\ifvmode\else\unskip\par\fi + \small\emph{#1:}~\ignorespaces}{\par} + +\newenvironment{Options}[1]% + {\list{}{\renewcommand\makelabel[1]{\texttt{##1}\hfil}% + \settowidth\labelwidth{\texttt{#1\space}}% + \setlength\leftmargin{10pt}% + \addtolength\leftmargin{\labelwidth}% + \addtolength\leftmargin{\labelsep}}}% + {\endlist} + +\makeatletter +\newcommand*\Ref{\@ifstar{\@Ref\ref}{\@Ref\autoref}} +\newcommand*\@Ref[2]{#1{#2}: \textit{\nameref{#2}}} +\newcommand*\SEE[3][]{\nopagebreak{#1(#2 #3)}} +\newcommand*\SeeUserDefined[1][]{\See{\Ref{declare}#1}} +\makeatother + \begin{document} \let\subsectionautorefname\sectionautorefname \let\subsubsectionautorefname\sectionautorefname @@ -126,17 +186,13 @@ \def\thispackage{das \package{caption}"=Paket} \def\Thispackage{Das \package{caption}"=Paket} -\newcommand\NEWfeature{\NEW{Neues Feature}} -\newcommand\NEWdescription{\NEW{Neue Beschreibung}} - +\newcommand*\DefaultNoteText{Hinweis} +\newcommand*\NEWfeature{\NEW{Neues Feature}} +\newcommand*\NEWdescription{\NEW{Neue Beschreibung}} \makeatletter -\newcommand*\Ref{\@ifstar{\@Ref\ref}{\@Ref\autoref}} -\newcommand*\@Ref[2]{#1{#2}: \textit{"`\nameref{#2}"'}} +\newcommand*\See{\@ifstar{\SEE{Siehe}}{\SEE[\small]{Siehe}}} +\newcommand*\see{\@ifstar{\SEE{siehe}}{\SEE[\small]{siehe}}} \makeatother -\newcommand*\See[1]{{\small (Siehe #1)}} -\newcommand*\SeeUserDefined[1][]{\See{\Ref{declare}#1}} - -\def\TODO{\emph{-- Hier fehlt noch 'was --}} % --------------------------------------------------------------------------- % @@ -144,8 +200,8 @@ \let\docdate\filedate \GetFileInfo{caption.sty} -\title{Setzen von Abbildungs- und Tabellenbeschriftungen mit dem - caption-Paket\texorpdfstring{\thanks{% +\title{Anpassen der Abbildungs- und Tabellenbeschriftungen + mit Hilfe des caption-Paketes\texorpdfstring{\thanks{% Dieses Paket hat die Versionsnummer \fileversion, zuletzt ge"andert am \filedate.}}{}} \author{Axel Sommerfeldt\\ @@ -156,13 +212,10 @@ % --------------------------------------------------------------------------- % \begin{abstract} -\Thispackage\ bietet einem Mittel und Wege das Erscheinungsbild der -Bildunterschriften und Tabellen"uberschriften den eigenen W"unschen -bzw.\ bestimmten Vorgaben anzupassen. -Hierbei wurde viel Wert auf die reibungslose Zusammenarbeit und in die -Integration anderer Dokumentenklassen und Pakete gelegt.\footnote{F"ur die -Version 3.0 dieses Paketes wurde die Benutzerschnittstelle zusammen -mit Steven D. Cochran und Frank Mittelbach komplett "uberarbeitet.} +\Thispackage\ bietet einem Mittel und Wege, das Erscheinungsbild der Bild- +und Tabellenbeschriftungen den eigenen Wünschen bzw.\ Vorgaben anzupassen. +Hierbei wurde Wert auf die reibungslose Zusammenarbeit mit zahlreichen +Dokumentenklassen und Paketen gelegt. \end{abstract} \newcommand\exampletext{% @@ -192,21 +245,49 @@ Mit Hilfe dieses Paketes können Sie dies leicht bewerkstelligen; es sind viele vorgegebene Parameter einstellbar, Sie können aber auch eigene Gestaltungsmerkmale einfließen lassen. -% --------------------------------------------------------------------------- % +\bigskip + +\INFO\begin{minipage}[t]{\textwidth} +\small +Bitte beachten Sie, daß \thispackage\ nur das Aussehen der Beschriftungen +kontrolliert. Es kontrolliert \emph{nicht} den Ort der Beschriftung; +dieser kann aber mit anderen Paketen wie etwa dem +\package{floatrow}"=Paket\cite{floatrow} variiert werden. +\end{minipage} \clearpage + +% --------------------------------------------------------------------------- % + \section*{Vorläufige Dokumentation} -Diese Anleitung ist (im Gegensatz zur englischensprachigen Anleitung) leider -noch an einigen Stellen inkonsistent und insbesondere noch nicht fertiggestellt. +\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 % --------------------------------------------------------------------------- % @@ -216,28 +297,28 @@ die aktuelle Interimsversion kann immer \label{usage} \DescribeMacro{\usepackage} -Mittels +Durch \begin{quote} |\usepackage|\oarg{Optionen}|{caption}[|\texttt{\filedate}|]| \end{quote} in dem Vorspann des Dokumentes wird das \thispackage\ Paket eingebunden, die -Optionen legen hierbei das Aussehen der "Uber- und Unterschriften fest. So -w"urde z.B. +Optionen legen hierbei das Aussehen der Über- und Unterschriften fest. So +würde z.B. \begin{quote} |\usepackage[margin=10pt,font=small,labelfont=bf,|\\ | labelsep=endash]{caption}|% %|[|\texttt{\filedate}|]| \end{quote} zu dem obrigen Ergebnis mit Rand, kleinerem Zeichensatz und fetter Bezeichnung -f"uhren. +führen. \DescribeMacro{\captionsetup} -Eine "Anderung der Parameter ist auch zu einem sp"ateren Zeitpunkt jederzeit -mittels des Befehls +Eine Änderung der Parameter ist auch zu einem späteren Zeitpunkt jederzeit +mit dem Befehl \begin{quote} |\captionsetup|\oarg{Typ}\marg{Optionen} \end{quote} -m"oglich. So sind z.B. die Befehlssequenzen +möglich. So sind z.B. die Befehlssequenzen \begin{quote} |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}| \end{quote} @@ -248,11 +329,11 @@ und \end{quote} in ihrer Wirkung identisch. -Weiterhin gilt zu beachten, da"s sich die Verwendung von |\captionsetup| +Es ist zu beachten, daß sich die Verwendung von |\caption|\-|setup| innerhalb von Umgebungen nur auf die Umgebung selber auswirkt, nicht aber auf -den Rest des Dokumentes. M"ochte man also z.B. die automatische Zentrierung der -Abbildungsunterschrift nur in einem konkreten Falle ausschalten, so kann dies -mit +den Rest des Dokumentes. +Möchte man also z.B. die automatische Zentrierung der Abbildungsunterschrift +nur in einem konkreten Falle ausschalten, so kann dies mit \begin{quote} |\begin{figure}|\\ | |\ldots\\ @@ -260,14 +341,17 @@ mit | \caption{|\ldots|}|\\ |\end{figure}| \end{quote} -geschehen, ohne da"s die restlichen Abbildungsunterschriften hiervon -beeintr"achtigt werden. +geschehen, ohne daß die restlichen Abbildungsunterschriften hiervon +beeinträchtigt werden. -(Der optionale Parameter \meta{Typ} wird in \Ref{commands} behandelt.) +\begin{Annotation} +Der optionale Parameter \meta{Typ} von |\caption|\-|setup| wird in +\Ref{captionsetup} behandelt. +\end{Annotation} % --------------------------------------------------------------------------- % -\pagebreak[4] +\clearpage \section{Optionen} \label{options} @@ -281,29 +365,30 @@ beeintr"achtigt werden. \DescribeMacro{format=} Eine Abbildungs- oder Tabellenbeschriftung besteht im wesentlichen aus drei -Teilen: -Dem Bezeichner (etwa "`Abbildung 3"'), dem Trenner +Teilen: Dem Bezeichner (etwa "`Abbildung 3"'), dem Trenner (etwa "`:\textvisiblespace"') und dem eigentlichen Text. -Mittels der Option + +Mit der Option \begin{quote} |format=|\meta{Name} \end{quote} wird festgelegt, wie diese drei Teile zusammengesetzt werden. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar:%\footnote{Es gibt -%hier wie auch bei vielen anderen Optionen die M"oglichkeit, auch eigene -%Formate, Zeichens"atze etc.\ zu definieren. Wie dies geht wird in Abschnitt -%\ref{declare}: \textit{"`Eigene Erweiterungen"'} dargelegt.} + +Für \meta{Name} sind folgende Möglichkeiten verfügbar:%~\footnote{Es gibt +%hier wie auch bei vielen anderen Optionen die Möglichkeit, auch eigene +%Formate, Zeichensätze etc.\ zu definieren. Wie dies geht wird in Abschnitt +%\Ref{declare} dargelegt.} \begin{Options}{\OptionLabel} \item[plain]%\NEWdescription{v3.0h} - Die Beschriftung wird als gew"ohnlicher Abschnitt gesetzt. + Die Beschriftung wird als gewöhnlicher Absatz gesetzt. \item[hang] - Der Text wird so gesetzt, da"s er an dem Bezeichner "`h"angt"', d.h.~der + Der Text wird so gesetzt, daß er an dem Bezeichner "`hängt"', d.h.~der Platz unter dem Bezeichner und dem Trenner bleibt leer. \item[\UserDefined] - Eigene Formate k"onnen mittels |\DeclareCaptionFormat| definiert werden. + Eigene Formate können mit |\Declare|\-|Caption|\-|Format| definiert werden. \SeeUserDefined \end{Options} @@ -312,17 +397,19 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar:%\footnote{Es gibt \begin{quote} |format=hang| \end{quote} - f"uhrt zu Abbildungsunterschriften der Art + führt zu Abbildungsunterschriften der Art \example{format=hang}{\exampletext} \end{Example} +\pagebreak[3] \DescribeMacro{indention=} -Bei beiden Formaten (\texttt{plain} und \texttt{hang}) kann der Einzug der Beschriftung -ab der zweiten Textzeile angepasst werden, dies geschieht mit Hilfe der Option +Bei beiden Formaten (\texttt{plain} und \texttt{hang}) kann der Einzug der +Beschriftung ab der zweiten Textzeile angepasst werden, dies geschieht mit \begin{quote} |indention=|\meta{Einzug}\quad, \end{quote} -wobei anstelle von \meta{Einzug} jedes beliebige feste Ma"s angegeben werden kann. +wobei anstelle von \meta{Einzug} jedes beliebige feste Maß angegeben werden +kann. Zwei Beispiele: @@ -330,7 +417,7 @@ Zwei Beispiele: \begin{quote} |format=plain,indention=.5cm| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{format=plain,indention=.5cm}{\exampletext} \end{Example} @@ -338,13 +425,15 @@ Zwei Beispiele: \begin{quote} |format=hang,indention=-0.5cm| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{format=hang,indention=-0.5cm}{\exampletext} \end{Example} -%\pagebreak[3] +\bigskip + +\pagebreak[3] \DescribeMacro{labelformat=} -Mittels der Option +Mit der Option \nopagebreak[3] \begin{quote} |labelformat=|\meta{Name} @@ -352,51 +441,74 @@ Mittels der Option \nopagebreak[3] %\NEWdescription{v3.0e} wird die Zusammensetzung des Bezeichners festgelegt. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: +Für \meta{Name} sind folgende Möglichkeiten verfügbar: \begin{Options}{\OptionLabel} \item[default] Der Bezeichner wird wie von der verwendeten Dokumentenklasse vorgegeben gesetzt, - "ublicherweise ist dies der Name und die Nummer, getrennt durch ein Leerzeichen + üblicherweise ist dies der Name und die Nummer, getrennt durch ein Leerzeichen (wie \texttt{simple}). (Dies ist das Standardverhalten.) \item[empty] - Der Bezeichner ist leer. (Diese Option macht in der Regel nur in Verbindung mit - anderen Optionen -- wie etwa \texttt{labelsep=none} -- Sinn.) + Der Bezeichner ist leer. +\iffalse + (Diese Option macht in der Regel nur in Verbindung mit + anderen Optionen -- wie etwa \texttt{labelsep=none} -- Sinn.) +\fi \item[simple] Der Bezeichner ist aus dem Namen und der Nummer zusammengesetzt. + \item[brace]\NEWfeature{v3.1f} + Der Bezeichner wird mit einer einzelnen (rechten) Klammer abgeschlossen. + \item[parens] Die Nummer des Bezeichners wird in runde Klammern gesetzt. \item[\UserDefined] - Eigene Formate k"onnen mittels |\DeclareCaptionLabelFormat| definiert werden. + Eigene Formate können mit |\Declare|\-|Caption|\-|Label|\-|Format| + definiert werden. \SeeUserDefined \end{Options} \begin{Example} Ein Beispiel: Die Optionen \begin{quote} - |labelformat=parens,labelsep=quad| + |format=plain,labelformat=parens,labelsep=quad| \end{quote} - f"uhren zu Abbildungsunterschriften der Art - \example{labelformat=parens,labelsep=quad}{\exampletext} + führen zu Abbildungsunterschriften der Art + \example{format=plain,labelformat=parens,labelsep=quad}{\exampletext} \end{Example} +\medskip + +\begin{Note*} +Manche Umgebungen, wie z.B.~die vom \package{algorithm2e}"=Paket angebotende +|al|\-|go|\-|rithm|"=Umgebung, reagieren allergisch auf eine Änderung des +Bezeichnerformats. +\end{Note*} + +\bigskip + +\pagebreak[3] \DescribeMacro{labelsep=} -Mittels der Option +Mit der Option \begin{quote} |labelsep=|\meta{Name} \end{quote} -wird die Zusammensetzung des Trenners festgelegt. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: +wird die Zusammensetzung des Trenners festgelegt.\footnote{% + Wenn der Bezeichner oder der Text der Beschriftung leer ist, + wird kein Trenner verwendet.} +Für \meta{Name} sind folgende Möglichkeiten verfügbar: \begin{Options}{\OptionLabel} \item[none] - Der Trenner ist leer. (Diese Option macht in der Regel nur in Verbindung - mit anderen Optionen -- wie etwa \texttt{labelformat=empty} -- Sinn.) + Der Trenner ist leer. +\iffalse + (Diese Option macht in der Regel nur in Verbindung + mit anderen Optionen -- wie etwa \texttt{labelformat=empty} -- Sinn.) +\fi \item[colon] Der Trenner besteht aus einem Doppelpunkt und einem Leerzeichen. @@ -411,53 +523,84 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: Der Trenner besteht aus einem |\quad|. \item[newline] - Als Trenner wird ein Zeilenumbruch verwendet. + Als Trenner wird ein Zeilenumbruch (|\\|) verwendet. + Bitte beachten Sie, daß dieser Trenner nicht mit allen Formaten + (z.B.~|format=|\x|hang|) zusammenarbeitet; ggf. erhalten Sie + deswegen eine Fehlermeldung. - \item[endash]%\NEWfeature{v3.0h} - Als Trenner wird ein Gedankenstrich verwendet. + \item[endash]\NEWfeature{v3.0h} + Als Trenner wird ein Gedankenstrich (\verb*| -- |) verwendet. \item[\UserDefined] - Eigene Trenner k"onnen mittels |\DeclareCaptionLabelSeparator| definiert werden. + Eigene Trenner können mit |\Declare|\-|Caption|\-|Label|\-|Sep|\-|a|\-|ra|\-|tor| + definiert werden. \SeeUserDefined \end{Options} Drei Beispiele: \begin{Example} \begin{quote} - |labelsep=period| + |format=plain,labelsep=period| \end{quote} - \captionsetup{aboveskip=0pt} - \example{labelsep=period}{\exampletext} + \captionsetup{skip=0pt} + \example{format=plain,labelsep=period}{\exampletext} \end{Example} \begin{Example} \begin{quote} - |labelsep=newline,singlelinecheck=false| + |format=plain,labelsep=newline,singlelinecheck=false| \end{quote} - \captionsetup{aboveskip=0pt} - \example{labelsep=newline,singlelinecheck=false}{\exampletext} + \captionsetup{skip=0pt} + \example{format=plain,labelsep=newline,singlelinecheck=false}{\exampletext} \end{Example} \begin{Example} \begin{quote} - |labelsep=endash| + |format=plain,labelsep=endash| \end{quote} - \captionsetup{aboveskip=0pt} - \example{labelsep=endash}{\exampletext} + \captionsetup{skip=0pt} + \example{format=plain,labelsep=endash}{\exampletext} \end{Example} +\bigskip + +\pagebreak[3] +\DescribeMacro{textformat=}\NEWfeature{v3.0l} +Mit der Option +\nopagebreak[3] +\begin{quote} + |textformat=|\meta{Name} +\end{quote} +\nopagebreak[3] +wird das Format des eigentlichen Textes festgelegt. +Für \meta{Name} sind folgende Möglichkeiten verfügbar: + +\begin{Options}{\OptionLabel} + \item[simple] + Der Text wird nicht verändert. + + \item[period] + Dem Text wird ein Punkt angehängt. + + \item[\UserDefined] + Eigene Textformate können mit |\Declare|\-|Caption|\-|Text|\-|Format| + definiert werden. + \SeeUserDefined +\end{Options} + % --------------------------------------------------------------------------- % +\PageBreak \subsection{Textausrichtung} \label{justification} \DescribeMacro{justification=} -Mittels der Option +Mit der Option \begin{quote} |justification=|\meta{Name} \end{quote} wird die Ausrichtung des Textes festgelegt. -F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: +Für \meta{Name} sind folgende Möglichkeiten verfügbar: \begin{Options}{\OptionLabel} \item[justified] @@ -467,92 +610,94 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: Der Text wird zentriert gesetzt. % \item[Centering] -% Der Text wird zentriert gesetzt. Hierf"ur wird jedoch im Gegensatz +% Der Text wird zentriert gesetzt. Hierfür wird jedoch im Gegensatz % zu \texttt{centering} der Befehl |\Centering| des \package{ragged2e}-Paketes % verwendet, der \LaTeX\ das Trennen der Worte erlaubt. \item[centerlast] - Lediglich die letzte Zeile des Textes wird zentriert gesetzt. + Lediglich die letzte Zeile des Absatzes wird zentriert gesetzt. \item[centerfirst] Lediglich die erste Zeile des Textes wird zentriert gesetzt. \item[raggedright] - Der Text wird linksb"undig gesetzt. + Der Text wird linksbündig gesetzt. -% \item[RaggedRight] -% Der Text wird linksb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. +\iffalse + \item[RaggedRight] + Der Text wird linksbündig mit Hilfe des \package{ragged2e}-Paketes gesetzt. +\else \item[RaggedRight] - Der Text wird ebenfalls linksb"undig gesetzt. Hierf"ur wird jedoch im Gegensatz - zu \texttt{raggedright} der Befehl |\RaggedRight| des \package{ragged2e}-Paketes - verwendet, der \LaTeX\ das Trennen der Worte erlaubt. + Der Text wird ebenfalls linksbündig gesetzt. + Hierfür wird jedoch im Gegensatz zur Option |raggedright| der Befehl + |\RaggedRight| des \package{ragged2e}-Paketes verwendet, + der \LaTeX\ das Trennen der Worte erlaubt.\footnote{% + Ob das \package{ragged2e}"=Paket benötigt wird oder nicht, + wird zur Laufzeit ermittelt, d.h.~ggf.~ist ein weiterer \LaTeX"=Lauf + erforderlich, wenn diese Option erstmalig eingesetzt wird.} +\fi \item[raggedleft] - Der Text wird rechtsb"undig gesetzt. + Der Text wird rechtsbündig gesetzt. % \item[RaggedLeft] -% Der Text wird rechtsb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. +% Der Text wird rechtsbündig mit Hilfe des \package{ragged2e}-Paketes gesetzt. +%\showhyphens{justification} \item[\UserDefined] - Eigene Ausrichtungen k"onnen mittels |\DeclareCaptionJustification| definiert werden. + Eigene Ausrichtungen können mit |\Declare|\-|Caption|\-|Jus|\-|ti|\-|fi|\-|ca|\-|tion| + definiert werden. \SeeUserDefined \end{Options} -Einige Beispiele: +Drei Beispiele: \begin{Example} \begin{quote} - |justification=centerlast| + |format=plain,justification=centerlast| \end{quote} - \captionsetup{aboveskip=0pt} - \example{justification=centerlast}{\exampletext} + \captionsetup{skip=0pt} + \example{format=plain,justification=centerlast}{\exampletext} \end{Example} \begin{Example} \begin{quote} |format=hang,justification=raggedright| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{format=hang,justification=raggedright}{\exampletext} \end{Example} \begin{Example} \begin{quote} - |format=hang,justification=RaggedRight| + |format=plain,labelsep=newline,justification=centering| \end{quote} - \captionsetup{aboveskip=0pt} - \example{belowskip=\abovecaptionskip,format=hang,justification=RaggedRight}{\exampletext} + \captionsetup{skip=0pt} + \example*{format=plain,labelsep=newline,justification=centering}{\exampletext} \end{Example} -\begin{Example} - \begin{quote} - |labelsep=newline,justification=centering| - \end{quote} - \captionsetup{aboveskip=0pt} - \example{belowskip=\abovecaptionskip,labelsep=newline,justification=centering}{\exampletext} -\end{Example} +\smallskip +\pagebreak[3] \DescribeMacro{singlelinecheck=} -In den Standard"=Dokumentenclassen |article|, |report| und |book| sind die -Ab\-bildungs- und Tabellenbeschriftungen so realisiert, da"s sie automatisch -zentriert werden, wenn sie lediglich aus einer einzigen Textzeile bestehen: +In den Standard"=Dokumentenklassen von \LaTeX\ (\class{article}, +\class{report} und \class{book}) sind die Ab\-bildungs- und +Tabellenbeschriftungen so realisiert, daß sie automatisch zentriert werden, +wenn sie lediglich aus einer einzigen Textzeile bestehen: \example*{}{Eine kurze Beschriftung.} -%\example{belowskip=\abovecaptionskip}{% -% Eine lange Beschriftung, die gen"ugend Text enth"alt, um l"anger als -% eine einzelne Zeile zu sein.} - \INFO -Diesen Mechanismus "ubernimmt \thispackage\ und ignoriert damit -in der Regel bei solch kurzen Beschriftungen die mittels der Optionen +Diesen Mechanismus übernimmt \thispackage\ und ignoriert damit +in der Regel bei solch kurzen Beschriftungen die mit den Optionen |justification=| und |indention=| eingestellte Textausrichtung. Dieses Verhalten kann jedoch mit der Option \begin{quote} |singlelinecheck=|\meta{bool} \end{quote} -reguliert werden. Setzt man f"ur \meta{bool} entweder |false|, |no|, |off| -oder |0| ein, so wird der Zentrierungsmechnismus au"ser Kraft gesetzt. -Die obrige, kurze Abbildungsunterschrift w"urde z.B. nach Angabe der Option +reguliert werden. +Setzt man für \meta{bool} entweder |false|, |no|, |off| oder |0| ein, +so wird der automatische Zentrierungsmechnismus außer Kraft gesetzt. +Die obrige, kurze Abbildungsunterschrift würde z.B.~nach Angabe der Option \begin{quote} |singlelinecheck=false| \end{quote} @@ -564,22 +709,23 @@ so aussehen: \example*{singlelinecheck=false}{Eine kurze Beschriftung.} \endgroup -Setzt man f"ur \meta{bool} hingegen |true|, |yes|, |on| oder |1| ein, so -wird die automatische Zentrierung wieder eingeschaltet. (Standardm"a"sig +Setzt man für \meta{bool} hingegen |true|, |yes|, |on| oder |1| ein, so +wird die automatische Zentrierung wieder eingeschaltet. (Standardmäßig ist sie eingeschaltet.) % --------------------------------------------------------------------------- % -\subsection{Zeichens"atze} +\subsection{Zeichensätze} \label{fonts} \DescribeMacro{font=} \DescribeMacro{labelfont=} \DescribeMacro{textfont=} -Das \thispackage-Paket kennt 3 Zeichens"atze: Denjenigen f"ur die gesammte Beschriftung -(|font|), denjenigen, der lediglich auf den Bezeichner und den Trenner angewandt wird -(|labelfont|), sowie denjenigen, der lediglich auf den Text wirkt (|textfont|). -So lassen sich die unterschiedlichen Teile der Beschriftung individuell mittels +Das \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|). +So lassen sich die unterschiedlichen Teile der Beschriftung individuell mit \begin{quote}\begin{tabular}{@{}r@{}ll} |font=| & \marg{Zeichensatzoptionen} & ,\\ |labelfont=| & \marg{Zeichensatzoptionen} & und\\ @@ -589,15 +735,20 @@ So lassen sich die unterschiedlichen Teile der Beschriftung individuell mittels anpassen. \pagebreak[3] -Als \meta{Zeichensatzoptionen} sind eine Kombination aus folgendem erlaubt: +Als \meta{Zeichensatzoptionen} sind Kombinationen aus folgenden (durch Komma +getrennte) Optionen möglich: -\begin{Options}{\OptionLabel} +\begin{Options}{stretch=\meta{amount}} \item[scriptsize] {\scriptsize Sehr kleine Schrift} - \item[footnotesize] {\footnotesize Fu"snotengr"o"se} + \item[footnotesize] {\footnotesize Fußnotengröße} \item[small] {\small Kleine Schrift} - \item[normalsize] {\normalsize Normalgro"se Schrift} - \item[large] {\large Gro"se Schrift} - \item[Large] {\Large Gr"o"sere Schrift} + \item[normalsize] {\normalsize Normalgroße Schrift} + \item[large] {\large Große Schrift} + \item[Large] {\Large Größere Schrift} +\end{Options} +\vspace{0pt}\pagebreak[3] +\begin{Options}{stretch=\meta{amount}} + \item[normalfont] {\normalfont Normale Schriftart \& -serie \& -familie} \item[up] {\upshape Upright Schriftart} \item[it] {\itshape Italic Schriftart} @@ -610,17 +761,33 @@ Als \meta{Zeichensatzoptionen} sind eine Kombination aus folgendem erlaubt: \item[rm] {\rmfamily Roman Schriftfamilie} \item[sf] {\sffamily Sans Serif Schriftfamilie} \item[tt] {\ttfamily Typewriter Schriftfamilie} - - \item[singlespacing] |\singlespacing| (siehe \package{setspace}-Paket) - \item[onehalfspacing] |\onehalfspacing| - \item[doublespacing] |\doublespacing| +\end{Options} +\vspace{0pt}\pagebreak[3] +\begin{Options}{stretch=\meta{amount}} + \item[singlespacing] Einfacher Zeilenabstand \See{\Ref{setspace}} + \item[onehalfspacing] Eineinhalbfacher Zeilenabstand \See{\Ref{setspace}} + \item[doublespacing] Doppelter Zeilenabstand \See{\Ref{setspace}} + \item[stretch=\meta{amount}] |\setstretch|\marg{amount} \See{\Ref{setspace}} +\end{Options} +\vspace{0pt}\pagebreak[3] +\begin{Options}{stretch=\meta{amount}} + \item[normalcolor] |\normalcolor| + \item[color=\meta{colour}] |\color|\marg{colour} + {\small(Sofern das \package{color}- oder das \package{xcolor}"=Paket + geladen ist; für ein Beispiel siehe \Ref{declare})} +\end{Options} +\vspace{0pt}\pagebreak[3] +\begin{Options}{stretch=\meta{amount}} + \item[normal] Die Kombination aus den Optionen |normal|\-|color|, + |normal|\-|font|, |normal|\-|size| und |single|\-|spacing| \item[\UserDefined] - Eigene Zeichensatzoptionen k"onnen mittels |\DeclareCaptionFont| definiert werden. + Eigene Zeichensatzoptionen können mit |\Declare|\-|Caption|\-|Font| + definiert werden. \SeeUserDefined \end{Options} -Wird lediglich eine einzelne Zeichensatzoption ausgew"ahlt, k"onnen die +Wird lediglich eine einzelne Zeichensatzoption ausgewählt, können die geschweiften Klammern entfallen, d.h.~die Optionen %\begin{quote} |font={small}| @@ -629,145 +796,238 @@ und %\begin{quote} |font=small| %\end{quote} -sind in ihrer Wirkung identisch. +sind identisch. -Beispiele: +Drei Beispiele: \begin{Example} \begin{quote} - |font={small,it},labelfont=bf| + |font=it,labelfont=bf| \end{quote} - \captionsetup{aboveskip=0pt} - \example{font={small,it},labelfont=bf}{\exampletext} + \captionsetup{skip=0pt} + \example{font=it,labelfont=bf}{\exampletext} \end{Example} \begin{Example} \begin{quote} - |font=small,labelfont=bf,textfont=it| + |labelfont=bf,textfont=it| \end{quote} - \captionsetup{aboveskip=0pt} - \example{font=small,labelfont=bf,textfont=it}{\exampletext} + \captionsetup{skip=0pt} + \example{labelfont=bf,textfont=it}{\exampletext} \end{Example} +\begin{Example} + \begin{quote} + |font={small,stretch=0.80}| + \end{quote} + \captionsetup{skip=0pt} + \example{font={small,stretch=0.80}}{\exampletext} +\end{Example} + +\medskip + +\pagebreak[3] +\DescribeMacro{font+=} +\DescribeMacro{labelfont+=} +\DescribeMacro{textfont+=} +\NEWfeature{v3.1f} +Es ist auch möglich, Zeichensatzoptionen zu den bisher ausgewählten +hinzuzufügen, so ist zum Beispiel +\begin{quote} + |\captionsetup{font=small}|\\ + |\captionsetup{font+=it}| +\end{quote} +mit +\begin{quote} + |\captionsetup{font={small,it}}| +\end{quote} +\nopagebreak[3] +identisch. +\pagebreak[3] + % --------------------------------------------------------------------------- % -\subsection{R"ander und Abs"atze} +\subsection{Ränder und Absätze} \label{margins} \DescribeMacro{margin=} \DescribeMacro{width=} -F"ur die Abbildungs- und Tabellenbeschriftungen kann \emph{entweder} ein extra Rand -\emph{oder} eine feste Breite festgelegt werden. Dies geschieht mit +Für die Abbildungs- und Tabellenbeschriftungen kann \emph{entweder} ein extra +Rand \emph{oder} eine feste Breite festgelegt werden:~\footnote{Nur feste Maße +sind hier gestattet. Suchen Sie nach einem Weg, die Breite automatisch auf die +Breite der Abbildung oder Tabelle zu begrenzen, schauen Sie sich bitte das +\package{floatrow}\cite{floatrow} oder +\package{threeparttable}"=Paket\cite{threeparttable} an.} \begin{quote}\begin{tabular}{@{}r@{}ll} - |margin=| & \meta{Rand} & \emph{oder}\\ + |margin=| & \meta{Rand} & \emph{-- oder --}\\ + |margin=| & |{|\meta{Linker Rand}|,|\meta{Rechter Rand}|}| & \emph{-- oder --}\\ |width=| & \meta{Breite} & \\ \end{tabular}\end{quote} -In beiden F"allen wird die Beschriftung zentriert, d.h.~der linke und rechte Rand -sind immer gleich gro"s. - -Zwei Beispiele hierzu: +\NEWfeature{v3.1} +Wird nur ein Wert für den Rand angegeben, so wird er für beide Ränder +(links und rechts) verwendet, so ist z.B.~|margin=|\x|10pt| identisch mit +|margin=|\x|{10pt,10pt}|. +In zweiseitigen Dokumenten wird der linke und rechte Rand auf geraden Seiten +vertauscht. +\DescribeMacro{oneside} +\DescribeMacro{twoside} +Dies kann jedoch mit der zusätzlichen Option |oneside| abgeschaltet werden, +z.B.~|\caption|\-|setup{margin=|\x|{0pt,10pt},|\x|oneside}|.\par +Wird hingegen eine \meta{Breite} angegeben, wird die Beschriftung zentriert, +d.h.~der linke und rechte Rand sind in diesem Falle immer gleich groß. + +Drei Beispiele illustrieren dies: \begin{Example} \begin{quote} |margin=10pt| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{margin=10pt}{\exampletext} \end{Example} \begin{Example} \begin{quote} + |margin={1cm,0cm}| + \end{quote} + \captionsetup{skip=0pt} + \example{margin={1cm,0cm}}{\exampletext} +\end{Example} + +\begin{Example} + \begin{quote} |width=.75\textwidth| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{width=.75\textwidth}{\exampletext} \end{Example} +\begin{Note} +Wird die Beschriftung neben der Abbildung bzw.~Tabelle angebracht (z.B.~mit +Hilfe der |SC|\-|figure|"=Umgebung des \package{sidecap}"=Paketes\cite{sidecap}), +oder wird die Abbildung bzw.~Tabelle innerhalb eines Absatzes gesetzt (z.B.~mit +Hilfe der |wrap|\-|figure|"=Umgebung des \package{wrapfig}"=Paketes\cite{wrapfig}), +dann wird der Rand am Anfang der Umgebung automatisch auf |0pt| zurückgesetzt. +Soll hier ebenfalls ein extra Rand gesetzt werden, so kann dieser Rand entweder +innerhalb der Umgebung neu gesetzt werden, oder aber global für bestimmte +Umgebungen, z.B.~mit |\caption|\-|setup[SC|\-|figure]{margin=|\x|10pt}|. +\end{Note} + +\begin{Expert} +\DescribeMacro{margin*=}\NEWfeature{v3.1} +Neben der Option |margin=| gibt es auch die Option |margin*=|, die nur dann +einen Rand neu setzt, wenn keine Breite mit |width=| gesetzt wurde. +\end{Expert} + +\begin{Expert} +\DescribeMacro{minmargin=} +\DescribeMacro{maxmargin=}\NEWfeature{v3.1} +Weiterhin kann auch ein minimaler bzw.~maximaler Rand gesetzt werden. +Dies kann z.B.~sinnvoll sein, um in schmaleren Umgebungen wie |minipage|s +den Rand prozentual zu begrenzen. +So begrenzen z.B.~die \SmF"=Dokumentenklassen den Rand auf +|maxmargin=|\x|0.1\linewidth|. (Siehe \Ref{SMF}) +\end{Expert} + +\medskip + +\pagebreak[3] \DescribeMacro{parskip=} Diese Option wirkt auf Abbildungs- oder Tabellenbeschriftungen, die aus mehr als einem Absatz bestehen; sie legt den Abstand zwischen den -Abs"atzen fest. +Absätzen fest: \begin{quote} - |parskip=|\meta{Abstand zwischen Abs"atzen} + |parskip=|\meta{Abstand zwischen Absätzen} \end{quote} -Ein Beispiel: +Ein Beispiel hierzu: \begin{Example} \begin{quote} |margin=10pt,parskip=5pt| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{margin=10pt,parskip=5pt}{% - Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die + Erster Absatz der Beschriftung; dieser enthält einigen Text, so daß die Auswirkungen der Optionen deutlich werden.\par - Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, - so da"s die Auswirkungen der Optionen deutlich werden.} + Zweiter Absatz der Beschriftung; dieser enthält ebenfalls einigen Text, + so daß die Auswirkungen der Optionen deutlich werden.} \end{Example} +\pagebreak[3] \DescribeMacro{hangindent=} Die Option \begin{quote} |hangindent=|\meta{Einzug} \end{quote} -legt einen Einzug f"ur alle Zeilen au"ser der jeweils ersten des Absatzes fest. +legt einen Einzug für alle Zeilen außer der jeweils ersten des Absatzes fest. Besteht die Beschriftung lediglich aus einem einzelnen Absatz, so ist die Wirkung mit der Option |indention=|\meta{Einzug} identisch, bei mehreren -Abs"atzen zeigt sich jedoch der Unterschied: +Absätzen zeigt sich jedoch der Unterschied: \begin{Example} \begin{quote} |format=hang,indention=-.5cm| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{format=hang,indention=-.5cm}{% - Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die + Erster Absatz der Beschriftung; dieser enthält einigen Text, so daß die Auswirkungen der Optionen deutlich werden.\par - Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, - so da"s die Auswirkungen der Optionen deutlich werden.} + Zweiter Absatz der Beschriftung; dieser enthält ebenfalls einigen Text, + so daß die Auswirkungen der Optionen deutlich werden.} \end{Example} \begin{Example} \begin{quote} |format=hang,hangindent=-.5cm| \end{quote} - \captionsetup{aboveskip=0pt} + \captionsetup{skip=0pt} \example{format=hang,hangindent=-.5cm}{% - Erster Absatz der Beschriftung; dieser enth"alt einigen Text, so da"s die + Erster Absatz der Beschriftung; dieser enthält einigen Text, so daß die Auswirkungen der Optionen deutlich werden.\par - Zweiter Absatz der Beschriftung; dieser enth"alt ebenfalls einigen Text, - so da"s die Auswirkungen der Optionen deutlich werden.} + Zweiter Absatz der Beschriftung; dieser enthält ebenfalls einigen Text, + so daß die Auswirkungen der Optionen deutlich werden.} \end{Example} +\begin{Note} +Enthält die Beschriftung mehr als einen Absatz, muß über das optionale +Argument von |\caption| bzw.~|\caption|\-|of| eine alternative Beschriftung +für das Abbildungs- bzw.~Tabellenverzeichnis angegeben werden; +ansonsten kommt es zu einer Fehlermeldung. +\end{Note} + % --------------------------------------------------------------------------- % +\pagebreak[3] \subsection{Stile} \label{style} \DescribeMacro{style=} -Eine geeignete Kombination aus den bisher vorgestellten Optionen wird \textit{Stil} -genannt; dies ist in etwa mit dem Seitenstil vergleichbar, den man bekannterma"sen -mit |\pagestyle| einstellen kann. +Eine geeignete Kombination aus den bisher vorgestellten Optionen wird +\textit{Stil} genannt; dies ist in etwa mit dem Seitenstil vergleichbar, +den man mit |\page|\-|style| einstellen kann. -Einen vordefinierten Abbildungs- und Tabellenbeschriftungsstil kann man mit der +Einen vordefinierten Abbildungs- bzw.~Tabellenbeschriftungsstil kann man mit der Option \begin{quote} |style=|\meta{Stil} \end{quote} -ausw"ahlen. \Thispackage\ definiert zwei Stile: |base| und |default|. +auswählen. \Thispackage\ vordefiniert zwei Stile: |base| und |default|. \NEWfeature{v3.1} Der Stil |base| setzt alle bisher vorgestellten Optionen auf die Belegung zurück, die das Aussehen der Beschriftungen der Standard"=\LaTeX"=Dokumentenklassen |article|, |report| und |book| repräsentiert. D.h.~die Angabe der Option \begin{quote} - |style=default| + |style=base| \end{quote} entspricht den Optionen \begin{quote} |format=plain,labelformat=default,labelsep=colon,|\\ - |justification=justified,font=,labelfont=,|\\ - |textfont=,margin=0pt,indention=0pt,parindent=0pt|\\ - |hangindent=0pt,singlelinecheck=true| + |justification=justified,font={},labelfont={},|\\ + |textfont={},margin=0pt,indention=0pt|\\ + |parindent=0pt,hangindent=0pt,singlelinecheck=true|\quad. \end{quote} -{\small(Aber |justification=centering,indention=0pt| wird automatisch - gewählt werden, wenn die Beschriftung in eine einzelne Zeile passt.)} +\begin{Annotation*} +Aber |justification=centering,indention=0pt| wird automatisch +gewählt werden, wenn die Beschriftung in eine einzelne Zeile passt. +\end{Annotation*} Der Stil |default| hingegen folgt den Standardwerten der verwendeten Dokumentenklasse. Dieser Stil wird vorausgewählt und entspricht den @@ -775,442 +1035,965 @@ Optionen \begin{quote} |format=default,labelformat=default,labelsep=default,|\\ |justification=default,font=default,labelfont=default,|\\ - |textfont=default,margin=0pt,indention=0pt,parindent=0pt|\\ - |hangindent=0pt,singlelinecheck=true|\quad. + |textfont=default,margin=0pt,indention=0pt|\\ + |parindent=0pt,hangindent=0pt,singlelinecheck=true|\quad. \end{quote} -{\small(Aber |justification=centering,indention=0pt| wird ebenso automatisch - gewählt werden, wenn die Beschriftung in eine einzelne Zeile passt.)} +\begin{Annotation*} +Auch hier wird |justification=centering,indention=0pt| automatisch +gewählt werden, wenn die Beschriftung in eine einzelne Zeile passt. +\end{Annotation*} Wenn also eine der drei Standard"=\LaTeX"=Dokumentenklassen verwendet wird, -zeigen |base| und |default| auf (fast) die gleichen Einstellungen. +repräsentieren die Stile |base| und |default| (fast) die gleichen Einstellungen. -{\small\emph{Hinweis:} Eigene Stile k"onnen mittels |\DeclareCaptionStyle| - definiert werden. \SeeUserDefined} +\begin{Note} +Eigene Stile können mit |\Declare|\-|Caption|\-|Style| definiert werden. +\SeeUserDefined +\end{Note} % --------------------------------------------------------------------------- % -\subsection{Abst"ande} +\subsection{Abstände} \label{skips} -\DescribeMacro{aboveskip=} -\DescribeMacro{belowskip=} -Die vertikalen Abstände vor und nach der Beschriftung werden von -|\abovecaptionskip| und |\belowcaptionskip| kontrolliert. -Die Standard"=\LaTeX"=Klassen |article|, |report| und |book| belegen den -Abstand |\abovecaptionskip| mit |10pt| und |\belowcaptionskip| mit |0pt|, -andere Dokumentenklassen ggf.~ mit anderen Werten. +\DescribeMacro{skip=}\NEWfeature{v3.0d} +Der vertikale Abstand zwischen der Beschriftung und der Abbildung +bzw.~Tabelle wird über die Option +\begin{quote} + |skip=|\meta{Abstand} +\end{quote} +gesteuert. +Die Standard"=\LaTeX"=Dokumentenklassen \class{article}, \class{report} +und \class{book} belegen diesen Abstand auf |skip=|\x|10pt| vor, +andere Dokumentenklassen ggf.~auf einen anderen Wert. + +\bigskip + +\pagebreak[3] +\DescribeMacro{position=} +Die von \LaTeX\ vorgegebene Implementierung von |\caption| birgt eine +Design\-schwäche: +Der |\caption| Befehl weiß dort nicht, ob er über oder unter der Abbildung +bzw.~Tabelle steht, folglich weiß er auch nicht, wo er den Abstand zur +Abbildung bzw.~Tabelle setzen soll. +Während die Standard"=Implementierung den Abstand immer über die +Beschriftung setzt (und inkonsequenterweise in |long|\-|table|"=Umgebungen +unter die Beschriftung), handhabt es dieses Paket etwas flexibler: +Nach Angabe der Option +\begin{quote} + |position=top|\quad oder\quad |position=above| +\end{quote} +wird angenommen, daß die Beschrifung am \emph{Anfang} der Umgebung +steht, der mit |skip=|\x\meta{Abstand} gesetzte Abstand also unter die +Beschriftung gesetzt wird. +(Bitte beachten Sie, daß |position=|\x|top| keineswegs bedeutet, daß +die Beschriftung an den Anfang der Gleitumgebung gesetzt wird. +Stattdessen wird die Beschriftung gewöhnlich dort gesetzt, wo der +|\caption|"=Befehl platziert wird.) +Hingegen nach +\begin{quote} + |position=bottom|\quad oder\quad |position=below| +\end{quote} +wird angenommen, daß die Beschriftung am \emph{Ende} der Umgebung +steht, der Abstand also über die Beschriftung gesetzt wird. +Und letztendlich nach +\begin{quote} + |position=auto|\quad {\small(welches die Vorbelegung ist)} +\end{quote} +versucht \thispackage\ sein bestes, um die tatsächliche Position der +Beschrifung selbst zu bestimmen. Bitte beachten Sie, daß dies zwar in +der Regel gelingt, unter seltenen Umständen aber falsche Resultate +liefern könnte. + +\medskip + +\pagebreak[3] +\DescribeMacro{figureposition=}%\NEWfeature{v3.0a} +\DescribeMacro{tableposition=}%\NEWfeature{v3.0a} +Die Option |position| ist insbesondere in Verbindung mit dem optionalen +Argument von |\caption|\-|setup| nützlich. +\See{auch \Ref{captionsetup}}\par +So führt zum Beispiel +\begin{quote} + |\captionsetup[table]{position=above}| +\end{quote} +dazu, daß alle Tabellenbeschriftungen als \emph{Überschriften} angesehen +werden (zumindest was den Abstand zur Tabelle angeht). +Weil dies eine übliche Einstellung ist, bietet einem \thispackage\ auch +die Optionen |figure|\-|position=|\x\meta{Position} und +|table|\-|position=|\x\meta{Position} als abkürzende Schreibweise. +So ist z.B. +\begin{quote} + |\usepackage[|\ldots|,tableposition=top]{caption}| +\end{quote} +identisch mit +\begin{quote} + |\usepackage[|\ldots|]{caption}|\\ + |\captionsetup[table]{position=top}|\quad. +\end{quote} + +\medskip + +\DANGER +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 +werden, kann es durchaus sein, daß diese ihre eigenen Abstandsregeln +mitbringen. +So befolgen z.B.~die \KOMAScript"=Dokumentenklassen die |skip=| Einstellung; +Abbildungsbeschriftungen werden aber immer als Unterschriften behandelt, +während die Tabellenbeschriftungen von dem Gebrauch der globalen +Optionen |table|\-|captions|\-|above| bzw.\ |table|\-|captions|\-|below| +abhängen. +\See{\Ref{KOMA}} + +Weiterhin kontrollieren manche Pakete, wie etwa das \package{float}-, das +\package{floatrow}- und das \package{supertabular}"=Paket, die Position +ihrer Abstände selber. + +\bigskip + +\begin{Expert*} +Intern wird der Abstand zwischen Beschriftung und Inhalt durch die Länge +|\above|\-|caption|\-|skip| repräsentiert (welche die Implementation von +\LaTeX\ immer über die Beschriftung setzt). +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. +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. +\end{Expert*} + +% --------------------------------------------------------------------------- % + +\subsection{Listen} +\label{lists} + +\DescribeMacro{list=}\NEWfeature{v3.1} +Der Befehl |\caption| erzeugt normalerweise auch einen Eintrag in das +Abbildungs- bzw.~Tabellenverzeichnis. Dies kann durch Angabe eines leeren +optionalen Argumentes unterdrückt werden {\small(siehe \Ref{caption})}, +aber auch durch Angabe der Option +\begin{quote} + |list=no|\quad(oder |list=false| oder |list=off|)\quad.~\footnote{% + Bitte beachten Sie, daß das \package{subfig}"=Paket\cite{subfig} diese + Option nicht unterstützt, stattdessen sind dort ggf.~die Zähler + \texttt{lofdepth} \& \texttt{lotdepth} anzupassen.} +\end{quote} \pagebreak[3] -Beide Abst"ande lassen sich gew"ohnlich mit |\setlength| "andern, aber auch mit den -\thispackage-Optionen +\DescribeMacro{listformat=}\NEWfeature{v3.1} +Mit der Option \nopagebreak[3] -\begin{quote}\begin{tabular}{@{}r@{}ll} - |aboveskip=| & \meta{Abstand nach oben} & und\\ - |belowskip=| & \meta{Abstand nach unten} & .\\ +\begin{quote} + |listformat=|\meta{Listformat} +\end{quote} +\nopagebreak[3] +kann beeinflußt werden, wie die Abbildungs- bzw.~Tabellennummer im +Abbildungs- bzw.~Tabellenverzeichnis erscheint. +Es gibt fünf vordefinierte Listenformate: + +\begin{Options}{\OptionLabel} + \item[empty] + Es wird keine Nummer angegeben. + + \item[simple] + Die Nummer wird (mit Zähler"=Prefix) angegeben. + + \item[parens] + Die Nummer wird (mit Prefix) in Klammern angegeben. + + \item[subsimple] + Wie |simple|, aber ohne Prefix. (Standard) + + \item[subparens] + Wie |parens|, aber ohne Prefix. + + \item[\UserDefined] + Eigene Listenformate können mit |\Declare|\-|Caption|\-|List|\-|Format| + definiert werden. + \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| +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 + \package{subfig}"=Paket gestaltet werden.} + +% --------------------------------------------------------------------------- % + +\subsection{Namen \& Nummerierung} +\label{names}\label{numbering} + +\DescribeMacro{figurename=} +\DescribeMacro{tablename=}\NEWfeature{v3.0l} +Der Name der Abbildungen und Tabellen kann mit den Optionen +\begin{quote}\begin{tabular}{@{}r@{}l@{\quad}l@{}} + |figurename=| & \meta{Name} & und\\ + |tablename=| & \meta{Name} & \\ \end{tabular}\end{quote} +geändert werden, zum Beispiel: +\begin{quote} + |figurename=Abb.| +\end{quote} +Das Sprachpaket \package{babel} setzt die Namen üblicherweise auf +"`Abbildung"' und "`Tabelle"'. -\DescribeMacro{position=} -Die sture Anwendung von |\abovecaptionskip| und |\belowcaptionskip| bei -Beschriftungen birgt einen gro"sen Nachteil: Ist die Beschriftung \emph{"uber} -und nicht \emph{unter} der Abbildung oder Tabelle (wie bei Tabellen durchaus -"ublich), so ist die Vorbelegung dieser beiden Abst"ande nicht mehr sinnvoll, -da hier kein Abstand zwischen der Beschriftung und der Tabelle gesetzt wird. -(Wir erinnern uns: |\belowcaptionskip| ist auf |0pt|, also kein Abstand, -vorbelegt.) - -Man vergleiche: -\begin{Example} - \captionsetup{position=b} - \begin{minipage}[c]{.5\linewidth}% -% \captionsetup{aboveskip=0pt}% - \captionof{table}{Eine Tabelle}% - \centering\begin{tabular}{ll}% - A & B \\% - C & D \\% - \end{tabular}% - \end{minipage}% - \begin{minipage}[c]{.5\linewidth}% - \centering\begin{tabular}{ll}% - A & B \\% - C & D \\% - \end{tabular}% - \captionof{table}{Eine Tabelle}% - \end{minipage}% -\end{Example} +\smallskip\INFO +Wenn Sie das \package{babel}"=Sprachpaket verwenden, laden Sie bitte +\thispackage\ \emph{nach} dem \package{babel}"=Paket. + +\medskip -Mit Hilfe des Parameters |position| kann man jedoch festlegen, wie -\LaTeX\ die Beschriftung behandeln soll, ob als \mbox{\emph{"Uber}schrift} -oder als \mbox{\emph{Unter}schrift}: +\pagebreak[3] +\DescribeMacro{name=}\NEWfeature{v3.1f} +Im Gegensatz zu |figure|\-|name| und |table|\-|name| ändert \begin{quote} - |position=top|\quad(oder |position=above|) + |name=|\meta{name} \end{quote} -gibt an, da"s die Abst"ande so gew"ahlt werden, da"s sie f"ur \mbox{\emph{"Uber}schriften} -sinnvoll gew"ahlt sind und +den Namen der \emph{aktuellen} Umgebung. +Hiermit könnte man z.B.~den Bezeichner "`Abbildung"' in allen +|wrap|\-|figure|"=Umgebungen nach "`Abb."' ändern (während woanders +nach-wie-vor "`Abbildung"' stehen würde): \begin{quote} - |position=bottom|\quad(oder |position=below|) + |\captionsetup[wrapfigure]{name=Abb.}| \end{quote} -gibt an, da"s die Abst"ande so gew"ahlt werden, da"s sie f"ur \mbox{\emph{"Uber}schriften} -sinnvoll gew"ahlt sind. (Dies ist die Standardeinstellung, allerdings nicht f"ur |longtable|s.) -F"ugt man nun ein |\captionsetup{position=top}| in die linke Tabelle vor dem -|\caption| Befehl ein, so ergeben sich im Vergleich zwischen "Uberschrift und -Unterschrift stimmige Abst"ande: -\begin{Example} - \begin{minipage}[c]{.5\linewidth}% - \captionsetup{position=t}% - \captionof{table}{Eine Tabelle}% - \centering\begin{tabular}{ll}% - A & B \\% - C & D \\% - \end{tabular}% - \end{minipage}% - \begin{minipage}[c]{.5\linewidth}% - \centering\begin{tabular}{ll}% - A & B \\% - C & D \\% - \end{tabular}% - \captionsetup{position=b} - \captionof{table}{Eine Tabelle}% - \end{minipage}% -\end{Example} +\medskip + +\pagebreak[3] +\DescribeMacro{listfigurename=} +\DescribeMacro{listtablename=}\NEWfeature{v3.1g} +Analog zu den Optionen |figure|\-|name| und |table|\-|name| kann auch der +Titel der Listen geändert werden. So ändert z.B. +\begin{quote} + |listfigurename=Bilderverzeichnis| +\end{quote} +den Standardtitel "`Abbildungsverzeichnis"' zu "`Bilderverzeichnis"'. + +\bigskip -(Technisch ist dies so realisiert, da"s bei "Uberschriften die Ab\-st"an\-de -|\abovecaptionskip| und |\belowcaptionskip| vertauscht werden, so da"s -|\abovecaptionskip| immer derjenige Abstand ist, der zwischen Tabelle -und Beschriftung zur Anwendung kommt.) +\pagebreak[3] +\DescribeMacro{figurewithin=} +\DescribeMacro{tablewithin=}\NEWfeature{v3.1f} +Wird eine Dokumentenklasse verwendet, die den Gliederungsbefehl |\chapter| +bereitstellt (wie z.B.~\class{report} oder \class{book}), +so wird üblicherweise der Abbildungs- und Tabellenzähler in Abhängigkeit des +Kapitels geführt. +Ansonsten wird der Zähler gewöhnlich fortlaufend erhöht. + +Dies kann über die Optionen +\begin{quote}\begin{tabular}{rl} + |figurewithin=| & \texttt{chapter} \emph{oder} \texttt{section} \emph{oder} \texttt{none}\quad und\\ + |tablewithin=| & \texttt{chapter} \emph{oder} \texttt{section} \emph{oder} \texttt{none}\\ +\end{tabular}\end{quote} +geändert werden. Wird "`|none|"' als Wert angegeben, erfolgt die Zählung stur +fortlaufend, ansonsten wird sie in Abhängigkeit von der angegebenen +Gliederungsebene (also "`|chapter|"' oder "`|section|"') geführt; +so würde z.B.~|figure|\-|within=|\x|section| zur Folge haben, +daß der Abbildungszähler in Abhängigkeit von der |\section| Gliederung geführt +wird. -Sinnvoll l"a"st sich diese Option insbesondere zusammen mit dem optionalen -Parameter bei |\captionsetup| anwenden: \See{auch \Ref{commands}} +\bigskip + +\begin{Expert*} +Der Name und die Nummerierung werden intern durch die Kommandos +|\|\meta{type}|name| \& |\the|\meta{type} gesteuert, z.B.~bei Abbildungen +durch |\figure|\-|name| \& |\the|\-|figure|. +Während die obenstehenden Optionen in der Regel ausreichend sind, +kann es manchmal vonnöten sein, diese zwei Makros direkt umzudefinieren. +So liefert zum Beispiel \begin{quote} - |\captionsetup[table]{position=top}| + |\captionsetup{figurewithin=section}|\\ + |\renewcommand\thefigure{\arabic{section}\alph{figure}}| \end{quote} -bewirkt, da"s bei allen Tabellen die Beschriftung bzgl.~der Abst"ande als -"Uberschrift behandelt wird. -\DescribeMacro{tableposition=}%\NEWfeature{v3.0a} -Da dies eine sehr gebr"auchliche Einstellung ist, -stellt das \thispackage"=Paket diesen Befehl auch als abk"urzende Option f"ur -|\usepackage| zur Verf"ugung: +ein Nummernschema \meta{section}\meta{figure} mit einem numerischen +Abschnittszähler und einem alphanumerischen Abbildungszähler, +wie z.B.~"`|Figure 2b|"'. +\end{Expert*} + +% --------------------------------------------------------------------------- % + +\subsection{Typen} +\label{types} + +\DescribeMacro{type=}\NEWfeature{v3.0d} +Der |\caption| Befehl kann verschiedene Gleitumgebungstypen beschriften, +Abbildungen (|figure|) ebenso wie Tabellen (|table|). +Außerhalb dieser Umgebungen führt die Verwendung von |\caption| jedoch zu +einer Fehlermeldung, weil nicht klar ist, zu welchem Typ die Beschriftung +gehören soll. +In diesen Situationen kann man den Typ manuell mit \begin{quote} - |\usepackage[|\ldots|,tableposition=top]{caption}| + |type=|\meta{Typ} \end{quote} -entspricht +festlegen, so daß |\caption| (und andere Befehle wie |\Continued|\-|Float| +oder |\sub|\-|caption|\-|box| des \package{subcaption}"=Paketes, +oder |\sub|\-|float| des \package{subfig}"=Paketes\cite{subfig}) +das gewünschte Ergebnis liefern können; +z.B.~innerhalb einer nicht-gleitenden Umgebung wie |minipage|: \begin{quote} - |\usepackage[|\ldots|]{caption}|\\ - |\captionsetup[table]{position=top}| + |\noindent\begin{minipage}{\textwidth}|\\ + | \captionsetup{type=figure}|\\ + | \subfloat{|\ldots|}|\\ + | |\ldots\\ + | \caption{|\ldots|}|\\ + |\end{minipage}| \end{quote} +\begin{Expert} +Es existiert auch eine Stern"=Variante dieser Option, |type*=|\meta{Typ}, +die sich unterschiedlich verhält, wenn das +\package{hyperref}"=Paket\cite{hyperref} geladen ist: +Während |type=| einen Hyperlink"=Anker setzt (sofern |hypcap=|\x|true| +gesetzt ist), tut dies |type*=| nicht. +(Siehe auch \Ref{hyperref}\,) +\end{Expert} +\begin{Expert} +\emph{\DefaultNoteText:} Bitte definieren Sie das interne Makro |\@captype| +nicht, wie von manchen Dokumentationen vorgeschlagen wird, selber um, +sondern verwenden Sie stattdessen immer |\caption|\-|setup{type=|\x\ldots|}|. +\end{Expert} + +\medskip + +Eigene Typen können mit |\Declare|\-|Caption|\-|Type| (angeboten von diesem +Paket), |\new|\-|float| (angeboten vom \package{float}"=Paket\cite{float}) +oder |\Declare|\-|New|\-|Float|\-|Type| (angeboten vom +\package{floatrow}"=Paket\cite{floatrow}) definiert werden. + +\medskip + +\DANGER % \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 +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=| +außerhalb einer Box oder Umgebung verwendet wird; daher wird in solchen +Fällen eine Warnung ausgegeben.\footnote{% +Sie erhalten diese Warnung nur dann, wenn Sie \eTeX\ verwenden.} + % --------------------------------------------------------------------------- % -\pagebreak[3] +\clearpage \section{Befehle} -\label{commands} + +\subsection{Setzen von Beschriftungen} +\label{caption} +\label{captionlistentry} \DescribeMacro{\caption} Der Befehl -\nopagebreak[3] \begin{quote} |\caption|\oarg{Kurzform f"ur das Verzeichnis}\marg{Beschriftung} \end{quote} -\nopagebreak[3] -erzeugt eine "Uber- bzw.~Unterschrift innerhalb einer gleitenden Umgebung -wie |figure| oder |table|. Dies ist an sich nichts neues, neu ist allerdings, -da"s kein Eintrag ins Abbildungs- oder Tabellenverzeichnis vorgenommen -wird, wenn eine leere Kurzform angegeben wird, etwa so: +erzeugt eine Über- bzw.~Unterschrift innerhalb einer gleitenden Umgebung +wie |figure| oder |table|. Dies ist an sich nichts neues, +hinzugekommen ist allerdings, daß kein Eintrag ins Abbildungs- oder +Tabellenverzeichnis vorgenommen wird, +wenn eine leere Kurzform angegeben wird, wie etwa hier: \begin{quote} |\caption[]{Dies ist eine Abbildung, die nicht ins|\\ | Abbildungsverzeichnis aufgenommen wird}| \end{quote} +\begin{Expert} +Beachten Sie, daß die \meta{Beschriftung} ein \emph{wanderndes} Argument +ist, solange keine \meta{Kurzform} angegeben ist. Ist hingegen eine +\meta{Kurzform} angegeben, ist stattdessen diese wandernd. +"`\emph{Wanderndes} Argument"' bedeutet, daß dieses Argument auch in die +Datei geschrieben wird, die beim nächsten \LaTeX"=Lauf das Abbildungs- +bzw. Tabellenverzeichnis bereitstellt. +\emph{Wandernde} Argumente dürfen keine \emph{zerbrechliche} Befehle enthalten, +alles muß hier \emph{robust} sein, ansonsten kann das Argument \emph{zerbrechen} +und beim nächsten \LaTeX"=Lauf seltsame Fehlermeldungen hervorrufen. +Einige \emph{zerbrechliche} Befehle können mit |\protect| vor dem +\emph{Zerbrechen} geschützt werden; eigene Definitionen können mit +|\Declare|\-|Robust|\-|Command| anstelle von |\new|\-|command| definiert werden, +um sie \emph{robust} zu machen. + +Ein Beispiel: |\caption{${}^{137}_{\phantom{1}55}$Cs}| wird Fehlermeldungen +zur Folge haben, da |\phantom| \emph{zerbrechlich} ist. +Daher muß in so einem Fall entweder die \meta{Kurzform} bemüht werden +(z.B.~|\caption[${}^|\x|{137}_|\x|{55}$|\x|Cs]|\x|{${}^|\x|{137}_|\x|{\phantom{1}55}$|\x|Cs}|) +oder aber ein |\protect| ergänzt werden, um |\phantom| vor dem \emph{zerbrechen} zu schützen: +|\caption{${}^|\x|{137}_|\x|{|\textcolor{blue}{\cs{protect}}|\phantom{1}55}$|\x|Cs}|. + +Manchmal ist dies allerdings nicht ausreichend. Der Grund ist darin zu finden, +daß der Ein-Zeilen-Test die \meta{Beschriftung} in eine horizontale Box setzt, +um die Breite zu bestimmen. +Manche Umgebungen mögen dies nicht besonders und quittieren es mit einer +Fehlermeldung. +Ein Beispiel: +|\caption{Ein| |Schema.| |\[V_{C}| |\sim| |\left| |\{| |\begin{array}{cc}| +|E_{g}| |&| |\textrm{p-n}| |\\| |e\phi_{B}| |&| |\textrm{M-S}| |\end{array}| +|\right.| |\]}|. +Der Gebrauch des optionalen Argumentes \meta{Kurzform} mittels +|\caption[Ein| |Schema]{|\ldots|}| ist hier nicht ausreichend, es kommt immer +noch zu eine Fehlermeldung. (``\texttt{Missing \$ inserted.}'') +Hier schafft es daher Abhilfe, den Ein-Zeilen-Test mittels +|\caption|\-|setup{single|\-|line|\-|check=|\x|off}| direkt vor dem +Betroffenen |\caption| Befehl auszuschalten. + +Mehr Informationen über \emph{wanderende} Argumente und \emph{zerbrechliche} +\& \emph{robuste} Befehle finden sich in der gängigen \LaTeX"=Literatur, aber +auch hier: +\url{http://www.ctan.org/tex-archive/info/lshort/german/} +und (in englischer Sprache) hier: +\url{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html} +\end{Expert} + +\medskip + +\pagebreak[3] \DescribeMacro{\caption*} -Das \package{longtable}-Paket definiert zus"atzlich zum Befehl |\caption| auch -den Befehl |\caption*|, der eine Beschriftung ohne Bezeichner und ohne Eintrag -ins Tabellenverzeichnis erzeugt. So erzeugt z.B. der Code +Das \package{longtable}"=Paket definiert zusätzlich zum Befehl |\caption| auch +die Stern-Variante |\caption*|, die eine Beschriftung ohne Bezeichner und ohne +Eintrag ins Tabellenverzeichnis erzeugt. So erzeugt z.B. der Code \begin{quote} - |\begin{longtable}{cc}|\\ + |\begin{longtable}{|\ldots|}|\\ | \caption*{Eine Tabelle}\\|\\ - | A & B \\|\\ - | C & D \\|\\ + | |\ldots\\ |\end{longtable}| \end{quote} -diese Tabelle: -\begin{longtable}{cc} - \caption*{Eine Tabelle}\\ - A & B \\ - C & D \\ -\end{longtable} - -\Thispackage\ bietet diesen Mechanismus auch f"ur normale Abbildungs- -und Tabellenbeschriftungen an. Ein Beispiel: +diese Tabelle:\par +\DeleteShortVerb{\|} +\vskip\intextsep +\begin{minipage}{\linewidth} + \captionsetup{type=table,position=t} + \caption*{Eine Tabelle} + \centering + \begin{tabular}{r|rr} + & x & y \\\hline + a & 1 & 2 \\ + b & 3 & 4 \\ + \end{tabular} +\end{minipage} +\vskip\intextsep +\MakeShortVerb{\|} +\Thispackage\ bietet diesen Mechanismus auch für Abbildungs- und +Tabellenbeschriftungen in Gleitumgebungen wie z.B. |table| an: \begin{quote} |\begin{table}|\\ | \caption*{Eine Tabelle}|\\ - | \begin{tabular}{cc}|\\ - | A & B \\|\\ - | C & D \\|\\ - | \end{tabular}|\\ +% | \begin{tabular}{|\ldots|}|\\ +% | |\ldots\\ +% | \end{tabular}|\\ + | |\ldots\\ |\end{table}| \end{quote} +\pagebreak[3] \DescribeMacro{\captionof} \DescribeMacro{\captionof*} Der Befehl |\caption| funktioniert in der Regel nur innerhalb von gleitenden -Umgebungen, manchmal m"ochte man ihn jedoch auch anderweitig anwenden, -etwa um eine Abbildung in eine nicht-gleitende Umgebung wie |minipage| zu -setzen. - -\pagebreak[2] -Hierf"ur stellt \thispackage\ den Befehl +Umgebungen, manchmal möchte man ihn jedoch auch außerhalb anwenden, +etwa um eine Abbildung in eine nicht-gleitende Umgebung wie |mini|\-|page| zu +setzen.\par +Hierfür stellt \thispackage\ den Befehl \begin{quote} |\captionof|\marg{Umgebungstyp}\oarg{Kurzform}\marg{Langform} \end{quote} -zur Verf"ugung. Die Angabe des Umgebungstypen ist hierbei notwendig, damit der -gew"unschte Bezeichner gew"ahlt wird und der Eintrag in das richtige Verzeichnis -vorgenommen wird. Ein Beispiel: +zur Verfügung. Die Angabe des Umgebungstypen ist hierbei notwendig, damit der +gewünschte Bezeichner (wie z.B. "`Abbildung"' oder "`Tabelle"') gewählt wird +und der Eintrag in das richtige Verzeichnis vorgenommen wird. Ein Beispiel: \begin{quote} - |\captionof{figure}{Abbildung}|\\ - |\captionof{table}{Tabelle}| +% |\captionof{figure}{Eine Abbildung}|\\ + |\captionof{table}{Eine Tabelle}| \end{quote} -f"uhrt zu folgendem Ergebnis: +führt zu folgendem Ergebnis: \begin{Example} - \captionof{figure}{Abbildung} - \captionsetup{belowskip=\abovecaptionskip} - \captionof{table}{Tabelle} +% \begingroup +% \captionof{figure}{Eine Abbildung} +% \endgroup + \captionsetup{position=top} +% \begingroup + \captionof{table}{Eine Tabelle} +% \endgroup \end{Example} -Analog zu |\caption*| gibt es auch den Befehl |\captionof*| f"ur Beschriftungen +Analog zu |\caption*| gibt es auch den Befehl |\captionof*| für Beschriftungen ohne Bezeichner und ohne Verzeichniseintrag. \DANGER % \NEWdescription{v3.1} -Beide Befehle, sowohl |\captionof| als auch |\captionof*|, sollten nur -\emph{innerhalb} von Umgebungen (wie |minipage| oder |\parbox|) angewandt werden; -ansonsten hat dies einen \LaTeX"=Fehler zur Folge.\footnote{% -Nur wenn \eTeX\ zum Einsatz kommt. Ansonsten gibt es zwar keine Fehlermeldung, -aber es kann passieren, da"s \LaTeX\ zwischen dem Inhalt und der -Beschreibung einen Seitenumbruch setzt; zum anderen kann es bei Mi"sachtung gar -zu seltsamen Effekten und unerwünschten Formatierungen der folgenden -Abbildungs- und Tabellenbeschriftungen kommen!} +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 +Boxen oder Umgebungen verwendet werden. +\See{\Ref{types}} + +\bigskip + +\pagebreak[3] +\DescribeMacro{\captionlistentry}\NEWfeature{v3.1} +Unter gewissen Umständen kann es nützlich sein, lediglich einen Eintrag +ins Abbildungs- bzw.~Tabellenverzeichnis vorzunehmen. +Dies kann mit +\begin{quote} + |\captionlistentry|\oarg{Umgebungstyp}\marg{Verzeichniseintrag} +\end{quote} +bewerkstelligt werden. + +Ein Beispiel: Es ist recht einfach, eine |long|\-|table| anzulegen, die die +Beschriftungen \emph{über} dem Tabelleninhalt hat, und wo der Listeneintrag +auf die erste Seite der Tabelle verweist: +\begin{quote} + |\begin{longtable}{|\ldots|}|\\ + | \caption{|\ldots|}\\|\\ + |\endfirsthead|\\ + | \caption[]{|\ldots|}\\|\\ + |\endhead|\\ + | |\ldots +\end{quote} +Aber da das \package{longtable}"=Paket keinen |\end|\-|first|\-|foot| Befehl +anbietet, kann dies nicht so einfach auf Beschritungen \emph{unter} dem +Tabelleninhalt übertragen werden. +Stattdessen kann man aber |\caption|\-|list|\-|entry| zum Einsatz bringen: +\begin{quote} + |\begin{longtable}{|\ldots|}|\\ + | \caption[]{|\ldots|}\\|\\ + |\endfoot|\\ + | \captionlistentry{|\ldots|}|\\ + | |\ldots +\end{quote} + +\begin{Annotation*} +Ein weiteres Anwendungsbeispiel findet sich in \Ref{examples}. +\end{Annotation*} + +\begin{Expert} +Es existiert auch eine Stern"=Variante, |\caption|\-|list|\-|entry*|, die +den Umgebungszähler nicht erhöht. +(Innerhalb von |long|\-|table| Umgebungen erhöht allerdings +|\caption|\-|list|\-|entry| niemals den Tabellenzähler. Siehe auch +\Ref{longtable}.) +\end{Expert} + +\begin{Expert} +Bitte beachten Sie, daß \meta{Verzeichniseintrag} ein \emph{wanderndes} +Argument ist, hier also alles \emph{robust} sein muß. +(Siehe auch Erklärung zu |\caption|) +\end{Expert} + +\subsection{Anwenden von Optionen} +\label{captionsetup} \DescribeMacro{\captionsetup} -Den Befehl |\captionsetup| haben wir ja schon im \Ref{usage} kennengelernt, +Den Befehl |\caption|\-|setup| haben wir ja schon im \Ref{usage} kennengelernt, uns dort allerdings die Bedeutung des optionalen Parameters -\meta{Typ} aufgespart. %Dies soll nun nachgeholt werden: - +\meta{Typ} aufgespart. Wir erinnern uns, die Syntax des Befehls lautet \begin{quote} - |\captionsetup|\oarg{Typ}\marg{Optionen} + |\captionsetup|\oarg{Typ}\marg{Optionen}\quad. \end{quote} - -Wird hierbei ein \meta{Typ} angegeben, so werden die Optionen nicht +Wird hier ein \meta{Typ} angegeben, so werden die Optionen nicht unmittelbar umgesetzt, sondern werden lediglich vermerkt und kommen erst dann -zum Einsatz, wenn eine "Uber- bzw.\ Unterschrift innerhalb des passenden -gleitenden Umgebungstyps gesetzt wird. So wirkt sich z.B. die Angabe +zum Einsatz, wenn eine Über- bzw.\ Unterschrift innerhalb der passenden +(gleitenden) Umgebung gesetzt wird. So wirkt sich z.B. die Angabe \begin{quote} |\captionsetup[figure]|\marg{Optionen} \end{quote} -lediglich auf die Unterschriften aus, die innerhalb einer |figure|"=Umgebung +lediglich auf die Unterschriften aus, die innerhalb der Umgebung |figure| gesetzt werden. Ein Beispiel: \begin{quote} |\captionsetup{font=small}|\\ - |\captionsetup[figure]{labelfont=bf}| + |\captionsetup[figure]{labelfont=bf,textfont=it}| \end{quote} -f"uhrt zu Abbildungs- und Tabellenunterschriften der Art: +liefert Abbildungs- und Tabellenunterschriften der Art: \begin{Example} \captionsetup{font=small} - \captionsetup[figure]{labelfont=bf} + \captionsetup[figure]{labelfont=bf,textfont=it} \begingroup \captionof{figure}{Eine Abbildung} \endgroup - \captionsetup{belowskip=\abovecaptionskip} + \captionsetup{position=top} \begingroup \captionof{table}{Eine Tabelle} \endgroup \end{Example} +Wie man sieht, führt das |\caption|\-|setup[figure]{|\ldots|}| dazu, +daß lediglich die Abbildungsunterschriften mit fettem Bezeichner und kursivem +Text gesetzt werden; alle anderen Unter- bzw.\ Überschriften werden jedoch +hiervon nicht beeinflusst. + +Als Umgebungstypen mit Unter- bzw.\ Überschriften gibt es in der Regel nur +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}} + +\begin{Expert} +\NEWfeature{v3.1} +Es existiert auch eine Stern"=Variante von |\caption|\-|setup|: +\begin{quote} + |\captionsetup*|\oarg{Typ}\marg{Optionen} +\end{quote} +Während die Variante ohne Stern ggf.~zu Warnungen führt -- zum Beispiel wenn +die \meta{Optionen} im Verlauf des Dokumentes nicht zum Einsatz kommen +(wie z.B. |\caption|\-|setup[table]{font=|\x|sf}| ohne folgende |table|) -- +ist dies bei der Stern"=Variante nicht der Fall. +\iffalse +Dies kann sich z.B. bei der Entwicklung von generischen Designvorlagen als +hilfreich erweisen. +\fi +\end{Expert} -Wie man sieht, f"uhrt das |\captionsetup[figure]{labelfont=bf}| lediglich dazu, -da"s Abbildungsunterschriften mit fettem Bezeichner gesetzt werden, alle anderen -Unter- bzw.\ "Uberschriften werden hiervon nicht beeinflu"st. +\medskip +\pagebreak[3] \DescribeMacro{\clearcaptionsetup} -Um diese vermerkten, typbezogenen Parameter aus dem Ged"achnis von \LaTeX\ zu -l"oschen, gibt es den Befehl +Um vermerkte, typbezogene Parameter aus dem Gedächnis von \LaTeX\ zu löschen, +gibt es den Befehl \begin{quote} - |\clearcaptionsetup|\marg{Typ}\quad. + |\clearcaptionsetup|\oarg{Option}\marg{Typ}\quad. \end{quote} -|\clearcaptionsetup{figure}| w"urde z.B. die obrige Sonderbehandlung der -Abbildungsunterschriften wieder aufheben: +|\clearcaptionsetup{figure}| würde z.B. die in dem obrigen Beispiel deklarierte +Sonderbehandlung der Abbildungsunterschriften wieder aufheben: +\begin{quote} + |\captionsetup{font=small}|\\ + |\captionsetup[figure]{labelfont=bf,textfont=it}|\\ + \ldots\\ + | \caption{Eine Abbildung}|\\ + \ldots\\ + |\clearcaptionsetup{figure}|\\ + \ldots\\ + | \caption{Eine Abbildung}|\\ + \ldots +\end{quote} \begin{Example} \captionsetup{font=small} + \captionsetup[figure]{labelfont=bf,textfont=it} \begingroup \captionof{figure}{Eine Abbildung} \endgroup - \captionsetup{belowskip=\abovecaptionskip} + \captionsetup{position=top} + \clearcaptionsetup{figure} \begingroup - \captionof{table}{Eine Tabelle} + \captionof{figure}{Eine Abbildung} \endgroup \end{Example} -Als Umgebungstypen mit Unter- bzw.\ "Uberschriften gibt es in der Regel nur -zwei: |figure| und |table|. Wie wir jedoch sp"ater sehen werden, kommen durch die -Verwendung spezieller \LaTeX-Pakete (wie etwa das \package{float}, -\package{longtable} oder \package{sidecap}"=Paket) -ggf.~weitere Typen hinzu, deren Beschriftungen ebenfalls derart individuell -angepasst werden k"onnen. +\pagebreak[3] +\NEWfeature{v3.1} +Wird das optionale Argument \meta{Option} verwendet, werden nur die +Einstellungen entfernt, die diese \meta{Option} betreffen.\footnote{% +Es kann hier nur \emph{eine} Option angegeben werden; sollen mehrere +Einstellungen entfernt werden, muß hierzu +\cs{clear}\-\texttt{caption}\-\texttt{setup} +mehrmals angewandt werden.} +Während in dem obrigen Beispiel nicht nur die Optionen +|labelfont=bf,|\x|textfont=it| +für Abbildungen aufgehoben werden (sondern alle Einstellungen, die +die Abbildungsbeschriftungen betreffen), würde der folgende Code +nur die Einstellung |labelfont=bf| entfernen und alle anderen +Einstellungen für Abbildungen intakt lassen: +\begin{quote} + |\captionsetup{font=small}|\\ + |\captionsetup[figure]{labelfont=bf,textfont=it}|\\ + \ldots\\ + | \caption{Eine Abbildung}|\\ + \ldots\\ + |\clearcaptionsetup[labelfont]{figure}|\\ + \ldots\\ + | \caption{Eine Abbildung}|\\ + \ldots +\end{quote} +\begin{Example} + \captionsetup{font=small} + \captionsetup[figure]{labelfont=bf,textfont=it} + \begingroup + \captionof{figure}{Eine Abbildung} + \endgroup + \captionsetup{position=top} + \clearcaptionsetup[labelfont]{figure} + \begingroup + \captionof{figure}{Eine Abbildung} + \endgroup +\end{Example} +\begin{Expert} +Analog zu |\caption|\-|setup*| gibt es hier ebenfalls eine Stern"=Variante +|\clear|\-|caption|\-|setup*|, die eventuell auftretende Warnungen unterdrückt, +etwa wenn die angegebene \meta{Option} gar nicht für den angegebenen \meta{Typ} +eingestellt war. +\end{Expert} + +\medskip -\subsection{Fortlaufende gleitende Umgebungen} +\pagebreak[3] +\DescribeMacro{\showcaptionsetup} +Für Debug"=Zwecke wird der Befehl +\nopagebreak[3] +\begin{quote} + |\showcaptionsetup|\marg{Typ} +\end{quote} +\nopagebreak[3] +bereitgestellt. Er erzeugt einen Eintrag in der Log"=Datei und zeigt dort +die für den angegebenen \meta{Typ} eingestellten Optionen an. +So gibt einem zum Beispiel +\begin{quote} + |\captionsetup[figure]{labelfont=bf,textfont=it}|\\ + |\showcaptionsetup{figure}| +\end{quote} +die Info: +\begin{quote}\small + |Caption Info: Option list on `figure'|\\ + |Caption Data: {labelfont=bf,textfont=it} on input line 5.| +\end{quote} + +\pagebreak[3] +\subsection{Fortlaufende Gleitumgebungen} \label{ContinuedFloat} \DescribeMacro{\ContinuedFloat} -Manchmal m"ochte man Abbildungen oder Tabellen aufteilen, jedoch ohne den einzelnen -Teilen eine eigene Abbildungs- oder Tabellennummer zu geben. Hierf"ur stellt das -\thispackage-Paket den Befehl +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 \begin{quote} |\ContinuedFloat| \end{quote} -zur Verf"ugung, der gleich als erstes innerhalb der folgenden Teile angewandt -werden sollte. Er verhindert, da"s die Z"ahlung fortgef"uhrt wird; eine Abbildung -oder Tabelle, die ein |\ContinuedFloat| enth"alt, erh"alt also die gleiche Nummer -wie die vorherige Abbildung oder Tabelle. - -Ein Beispiel: +zur Verfügung, der gleich als erstes innerhalb der nächsten (Gleit-)Umgebung(en) +angewandt werden sollte. +Er verhindert, daß die Zählung fortgeführt wird; eine Abbildung oder Tabelle, +die ein |\Continued|\-|Float| enthält, bekommt also die gleiche Nummer +wie die vorherige Abbildung oder Tabelle. Ein Beispiel: \begin{quote} |\begin{table}|\\ - |\caption{Eine Tabelle.}|\\ - \ldots\\ + | \caption{Eine Tabelle}|\\ + | |\ldots\\ |\end{table}|\\ \ldots\\ |\begin{table}\ContinuedFloat|\\ - |\caption{Eine Tabelle. (fortgef"uhrt)}|\\ - \ldots\\ + | \caption{Eine Tabelle (Fortsetzung)}|\\ + | |\ldots\\ |\end{table}| \end{quote} ergibt als Ergebnis: \begin{Example} \captionsetup{type=table,position=b,skip=0pt} - \caption{Eine Tabelle.} + \caption{Eine Tabelle} \centerline{\ldots} \ContinuedFloat - \caption{Eine Tabelle. (fortgef"uhrt)} + \caption{Eine Tabelle (Fortsetzung)} + \centerline{\ldots} \end{Example} +\bigskip + +\NEWfeature{v3.1} +Zusätzlich führt der |\Continued|\-|Float| Befehl auch Einstellungen aus, die +mit dem Typ "`|Continued|\-|Float|"' verknüpft sind. Dies kann zum Beispiel +verwendet werden, um automatisch für fortgesetzte Abbildungen oder Tabellen +auf ein anderes Bezeichner- oder Textformat umzuschalten, wie etwa hier: +\begin{quote} + |\DeclareCaptionLabelFormat{continued}{#1~#2 (Fortsetzung)}|\\ + |\captionsetup[ContinuedFloat]{labelformat=continued}|\\ + \ldots\\ + |\begin{table}\ContinuedFloat|\\ + | \caption{Eine Tabelle}|\\ + | |\ldots\\ + |\end{table}| +\end{quote} +\begin{Example} + \captionsetup{type=table,position=b,skip=0pt} + \captionsetup[ContinuedFloat]{labelformat=continued} + \ContinuedFloat + \caption{Eine Tabelle} + \centerline{\ldots} +\end{Example} +\medskip +\See{\Ref{declare} für die Erläuterung des Befehls + \cs{Declare}\-\texttt{Caption}\-\texttt{Label}\-\texttt{Format}.} + +\bigskip + +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: +\begin{quote} + |\DeclareCaptionLabelFormat{continued}{#1~#2 (Fortsetzung)}|\\ + \ldots\\ + |\begin{longtable}{|\ldots|}|\\ + | \caption{Eine mehrseitige Tabelle}\\|\\ + |\endfirsthead|\\ + | \captionsetup{labelformat=continued}|\\ + | \caption[]{Eine mehrseitige Tabelle}\\|\\ + |\endhead|\\ + | |\ldots\\ + |\end{longtable}| +\end{quote} + % --------------------------------------------------------------------------- % -\pagebreak[4] +\clearpage \section{Eigene Erweiterungen} \label{declare} -Wem die vorhandenen Formate, Trenner, Textausrichtungen, Zeichens"atze und Stile -nicht ausreichen, der hat die M"oglichkeit, sich eigene zu definieren. Hierzu -gibt es eine Reihe von Befehlen, die in dem Vorspann des Dokumentes (das ist der -Teil vor |\begin{document}|) zum Einsatz kommen. +Wem die vorhandenen Formate, Trenner, Textausrichtungen, Zeichensätze und Stile +nicht ausreichen, der hat die Möglichkeit, sich eigene zu definieren. Hierzu +gibt es eine Reihe von Befehlen, die in der Prämbel des Dokumentes (das ist der +Teil zwischen |\document|\-|class| und |\begin{document}|) zum Einsatz kommen. -\pagebreak[2] -\DescribeMacro{\DeclareCaptionFormat} -Eigene Formate k"onnen mit dem Befehl +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\Format} +Eigene Formate können mit dem Befehl \begin{quote} |\DeclareCaptionFormat|\marg{Name}\marg{Code mit \#1, \#2 und \#3} \end{quote} -definiert werden. F"ur \#1 wird sp"ater der Bezeichner, f"ur \#2 der Trenner -und f"ur \#3 der Text eingesetzt. So ist z.B. das Standardformat |plain|, -welches die Beschriftung als gew"ohnlichen Absatz formatiert, folgenderma"sen -in |caption.sty| definiert: +definiert werden. +Für \#1 wird später der Bezeichner, für \#2 der Trenner +und für \#3 der Text eingesetzt. So ist z.B. das Standardformat |plain|, +welches die Beschriftung als gewöhnlichen Absatz formatiert, +in diesem Paket so vordefiniert: \begin{quote} |\DeclareCaptionFormat{plain}{#1#2#3\par}| \end{quote} +\begin{Expert} +Es gibt auch eine Stern"=Variante, |\Declare|\-|Caption|\-|Format*|, die den +Code nicht in \TeX s horizontalem Modus, sondern im vertikalen Modus setzt, +aber die |indention=| Option nicht unterstützt. +\end{Expert} -\DescribeMacro{\DeclareCaptionLabelFormat} -"Ahnlich k"onnen auch eigene Bezeichnerformate definiert werden: +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\LabelFormat} +Ähnlich können auch eigene Bezeichnerformate definiert werden: \begin{quote} |\DeclareCaptionLabelFormat|\marg{Name}\marg{Code mit \#1 und \#2} \end{quote} -Bei den Bezeichnerformaten wird hierbei f"ur \#1 der Name (also z.B. -"`Abbildung"'), f"ur \#2 die Nummer (also z.B. "`12"') eingesetzt. +Bei den Bezeichnerformaten wird hierbei für \#1 der Name (also z.B. +"`Abbildung"'), für \#2 die Nummer (also z.B. "`12"') eingesetzt. +Ein Beispiel: +\begin{quote} + |\DeclareCaptionLabelFormat{bf-parens}{(\textbf{#2})}|\\ + |\captionsetup{labelformat=bf-parens,labelsep=quad}| +\end{quote} +\example*{labelformat=bf-parens,labelsep=quad}{\exampletext} +\pagebreak[3] \DescribeMacro{\bothIfFirst} \DescribeMacro{\bothIfSecond} -Hierbei gibt es eine Besonderheit zu beachten: Wird das Bezeichnerformat -auch in Verbindung mit dem \package{subfig}"=Paket\cite{subfig} verwendet, +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"onnen, stellt das \thispackage"=Paket die +Um dies flexibel handhaben zu können, stellt das \thispackage"=Paket die Befehle \begin{quote} |\bothIfFirst|\marg{Erstes Argument}\marg{Zweites Argument}\quad und\\ |\bothIfSecond|\marg{Erstes Argument}\marg{Zweites Argument} \end{quote} -zur Verf"ugung. |\bothIfFirst| testet, ob das erste Argument leer ist, -|\bothIfSecond|, ob das zweite Argument leer ist. Nur wenn dies nicht der -Fall ist, werden beide Argumente ausgegeben, ansonsten werden beide -unterdr"uckt. +zur Verfügung. +|\bothIfFirst| testet, ob das erste Argument nicht leer ist, +|\bothIfSecond|, ob das zweite Argument nicht leer ist. +Nur wenn dies der Fall ist, werden beide Argumente ausgegeben, +ansonsten werden beide unterdrückt. + +\smallskip +\pagebreak[3] So ist z.B. das Standard"=Bezeichnerformat |simple| nicht, wie man -naiverweise annehmen k"onnte, als +naiverweise annehmen könnte, als \begin{quote} - |\DeclareCaptionLabelFormat{simple}{#1 #2}| + |\DeclareCaptionLabelFormat{simple}{#1~#2}| \end{quote} -definiert, weil dies zu einem st"orendem f"uhrenden Leerzeichen f"uhren w"urde, -wenn \#1 leer ist. Stattdessen findet sich in |caption.sty| folgende -Definition, die sowohl mit |\caption| als auch mit |\subfloat| harmoniert: +definiert, weil dies zu einem störendem führenden Leerzeichen führen würde, +sollte \#1 leer sein. Stattdessen kommt folgende Definition zum Einsatz, +die sowohl mit |\caption| als auch mit |\sub|\-|caption| bzw.~|\sub|\-|float| +harmoniert: \begin{quote} - |\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{~}#2}| + |\DeclareCaptionLabelFormat{simple}%|\\ + | {\bothIfFirst{#1}{~}#2}|\mbox{\quad,} \end{quote} d.h.~das Leerzeichen kommt nur dann zum Einsatz, wenn \#1 nicht leer ist. +\smallskip + \pagebreak[3] -\DescribeMacro{\DeclareCaptionLabelSeparator} +\DescribeMacro{\DeclareCaption-\\TextFormat}\NEWfeature{v3.0l} +Ebenso können eigene Textformate definitiert werden: +\begin{quote} + |\DeclareCaptionTextFormat|\marg{Name}\marg{Code mit \#1} +\end{quote} +An die Stelle von \#1 wird später der Beschriftungstext eingesetzt. + +\bigskip + +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\LabelSeparator} Eigene Trenner werden mit -\nopagebreak[3] \begin{quote} |\DeclareCaptionLabelSeparator|\marg{Name}\marg{Code} \end{quote} -\nopagebreak[3] -definiert. Auch hier wieder als einfaches Beispiel die Definition des -Standard"=Trenners aus |caption.sty|: -\nopagebreak[3] +definiert. Auch hier wieder als einfaches Beispiel eine Definition innerhalb +des \package{caption}"=Paketes selber: \begin{quote} |\DeclareCaptionLabelSeparator{colon}{: }| \end{quote} -\pagebreak[3] +\begin{Expert} +Es gibt auch eine Stern"=Variante, |\Declare|\-|Caption|\-|Label|\-|Separator*|, +die den Code ohne den mit |label|\-|font=| eingestellten Zeichensatz setzt. +Auf diese Art sind z.B. die Trenner |quad|, |new|\-|line| und |en|\-|dash| +vordefiniert. +\end{Expert} + +\bigskip -\DescribeMacro{\DeclareCaptionJustification} -Eigene Textausrichtungen k"onnen mit +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\Justification} +Eigene Textausrichtungen können mit \begin{quote} |\DeclareCaptionJustification|\marg{Name}\marg{Code} \end{quote} -definiert werden. Der \meta{Code} wird dann der Beschriftung vorangestellt, -so f"uhrt z.B. die Verwendung der Ausrichtung +definiert werden. +Der \meta{Code} wird dann der Beschriftung vorangestellt, +so führt z.B. die Verwendung der bereits vordefinierten Ausrichtung \begin{quote} |\DeclareCaptionJustification{raggedright}{\raggedright}| \end{quote} -dazu, da"s alle Zeilen der Beschriftung linksb"undig ausgegeben werden. +dazu, daß alle Zeilen der Beschriftung linksbündig ausgegeben werden. + +\bigskip -\DescribeMacro{\DeclareCaptionFont} -Eigene Zeichensatzoptionen k"onnen mit +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\Font} +Eigene Zeichensatzoptionen können mit \begin{quote} |\DeclareCaptionFont|\marg{Name}\marg{Code} \end{quote} -definiert werden. So definiert z.B. das \thispackage"=Paket die Optionen -|small| und |bf| folgenderma"sen: +definiert werden. +So sind z.B. die Optionen |small| und |bf| folgendermaßen vordefiniert: \begin{quote} - |\DeclareCaptionFont{small}{\small}|\\ - |\DeclareCaptionFont{bf}{\bfseries}| + |\DeclareCaptionFont{small}{\small}|\quad und\\ + |\DeclareCaptionFont{bf}{\bfseries}|\quad. \end{quote} \iffalse -Die Zeilenabst"ande lie"sen sich z.B.~"uber das \package{setspace}"=Paket +Die Zeilenabstände ließen sich z.B.~über das \package{setspace}"=Paket regeln:%\NEWdescription{v3.0h} \begin{quote} |\usepackage{setspace}|\\ - |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{% - \emph{Hinweis:} \cs{singlespacing} kann hier nicht benutzt werden, - da es ein \cs{vskip} Kommando enth"alt.}\\ + |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|~\footnote{% + \emph{\DefaultNoteText:} \cs{singlespacing} kann hier nicht benutzt werden, + da es ein \cs{vskip} Kommando enthält.}\\ |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\ |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\ |\captionsetup{font={onehalfspacing,small},labelfont=bf}| \end{quote} \example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}{\exampletext} \fi -Ein Beispiel, welches etwas Farbe ins Spiel bringt: +Ein Beispiel, welches Farbe ins Spiel bringt: \begin{quote} |\usepackage{color}|\\ |\DeclareCaptionFont{red}{\color{red}}|\\ @@ -1223,51 +2006,141 @@ Aber da \thispackage\ schon die pfiffige Definition \begin{quote} |\DeclareCaptionFont{color}{\color{#1}}| \end{quote} -enthält, kann man das selbe Resultat auch einfach mit +beinhaltet, kann man das selbe Resultat auch einfach mit \begin{quote} |\usepackage{color}|\\ |\captionsetup{labelfont={color=blue,bf},|\\ - | textfont={color=green}}|\quad. + | textfont={color=green}}| \end{quote} erreichen. -\DescribeMacro{\DeclareCaptionStyle} -Zu guter letzt noch die Definition eigener Stile. Stile sind einfach eine -Ansammlung von geeigneten Einstellungen, die unter einem eigenen Namen -zusammengefasst werden und mit der Paketoption |style=|\meta{Name} ausgew"ahlt -werden k"onnen. Sie werden wie folgt definiert: +\medskip + +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\Style} +Eigene Stile werden folgendermaßen definiert: \begin{quote} - |\DeclareCaptionStyle|\marg{Name}\oarg{zus"atzliche Optionen}\marg{Optionen} + |\DeclareCaptionStyle|\marg{Name}\oarg{zusätzliche Optionen}\marg{Optionen} \end{quote} -Hierbei ist zu beachten, da"s die \meta{Optionen} immer auf dem Stil |base| +Stile sind einfach eine Ansammlung von geeigneten Einstellungen, die unter +einem eigenen Namen zusammengefasst werden und mit der Paketoption +|style=|\meta{Name} zum Leben erweckt werden können. + +Hierbei ist zu beachten, daß die so definierten Stile immer auf dem Stil |base| basieren (siehe auch \Ref{style}), es brauchen also nur davon abweichende Optionen angegeben werden. -Sind \meta{zus"atzliche Optionen} angegeben, so kommen diese automatisch -zus"atzlich zum Einsatz, sofern die Beschreibung in eine einzelne Zeile passt -und diese Abfrage nicht mit |singlelinecheck=off| ausgeschaltet wurde. +Sind \meta{zusätzliche Optionen} angegeben, so kommen diese automatisch +zusätzlich zum Einsatz, sofern die Beschreibung in eine einzelne Zeile passt +und diese Abfrage nicht mit |single|\-|line|\-|check=off| ausgeschaltet wurde. -Als Beispiel mu"s mal wieder eine einfache Definition innerhalb dieses Paketes -herhalten, so ist der Stil |base| definiert als +Als Beispiel muß mal wieder eine einfache Definition innerhalb dieses Paketes +herhalten: Der Stil |base| ist vordefiniert als \begin{quote} |\DeclareCaptionStyle{base}%|\\ - | [justification=centering,indention=0pt]{}|\quad. + | [justification=centering,indention=0pt]{}|\quad. \end{quote} +Etwas spannenderes: +\begin{quote} + |\DeclareCaptionStyle{mystyle}%|\\ + | [margin=5mm,justification=centering]%|\\ + | {font=footnotesize,labelfont=sc,margin={10mm,0mm}}|\\ + |\captionsetup{style=mystyle}| +\end{quote} +liefert einem Beschriftungen wie diese hier: +\begin{Example} + \captionsetup{type=figure,style=mystyle,position=b} + \caption{Eine kurze Beschriftung.} + \caption{Eine sehr sehr sehr sehr sehr sehr sehr sehr sehr + sehr sehr sehr sehr sehr sehr sehr sehr sehr + sehr sehr sehr sehr sehr sehr sehr sehr lange Beschriftung.} +\end{Example} + +\bigskip + +\pagebreak[3] +\DescribeMacro{\DeclareCaption-\\ListFormat}\NEWfeature{v3.1} +Eigene Listenformate können mit +\begin{quote} + |\DeclareCaptionListFormat|\marg{Name}\marg{Code mit \#1 und \#2} +\end{quote} +definiert werden. +Im Laufe des Dokumentes wird \#1 dann mit dem Bezeichner-Präfix +(z.B.~|\p@figure|), und \#2 mit der Referenznummer (z.B.~|\thefigure|) ersetzt. + +\bigskip + +\pagebreak[3] +\DescribeMacro{\DeclareCaptionType}\NEWfeature{v3.1f} +Eigene Gleitumgebungen und Umgebungstypen werden mit +\begin{quote} + |\DeclareCaptionType|\oarg{Optionen}\marg{Typ}\oarg{Name}\oarg{Listenname} +\end{quote} +definiert; wobei \meta{Optionen} ein oder mehrere Optionen hiervon sind: +\begin{quote}\begin{tabular}{r@{}l@{\qquad}l} + |fileext=| & \meta{Dateiendung} + & {\small(z.B.~|fileext=lod|)}\\ +% |listname=|\meta{list name}\\ +% |name=|\meta{prosa name}\\ + |placement=| & \meta{Kombination aus \,\purett{htbp}} + & {\small(z.B.~|placement=tbp|)}\\ + |within=| & \meta{Bezugszähler} \emph{oder} \texttt{none}\quad. + & {\small(z.B.~|within=section|)} +\end{tabular}\end{quote} +Werden keine \meta{Optionen} angegeben, so wird "`lo\meta{type}"' als +\meta{Dateiendung} für die Generierung der Liste verwendet, "`|tbp|"' als +Standard"=Positionierung, und "`|chapter|"' bzw.~"'|none|"' als +\meta{Bezugszähler}. +(Wird hingegen "`|none|"' angegeben, wird die neue Umgebung einfach +durchgängig gezählt.) + +Wird kein \meta{Name} angegeben, dann wird der Bezeichner der neuen Umgebung +auf \meta{Typ} gesetzt, allerdings mit einem Großbuchstaben beginnend. +Wird kein \meta{Listenname} angegeben, wird der Listenname auf +"`List of \meta{Name}s"' vorbelegt. +(Diese Vorbelegungen sind also nur für englischsprachige Dokumente geeignet, +bei anderssprachigen Dokumenten sollte man also immer \meta{Name} und +\meta{Listenname} mit angeben.) + +Die dazugehörige Liste wird analog zu |\list|\-|of|\-|figures| und +|\list|\-|of|\-|tables| mit dem Befehl |\list|\-|of|\meta{Typ}|s| gesetzt. +Ist das \package{fltpage}"=Paket geladen, wird automatisch ebenfalls eine +Umgebung namens |FP|\meta{Typ} definiert; ebenso wird ggf.~|sideways|\meta{Typ} +(\package{rotating}"=Paket), |SC|\meta{Type} (\package{sidecap}"=Paket) +und |wrap|\meta{Typ} (\package{wrapfig}"=Paket) definiert. + +\smallskip + +So definiert zum Beispiel +\begin{quote} + |\DeclareCaptionType{diagram}[Diagramm][Diagrammverzeichnis]| +\end{quote} +eine neue gleitende Umgebung namens |diagram|, die Liste wird intern in der +Datei mit der Endung |lodiagram| generiert, der Name (für den Bezeichner) +lautet "`Diagram"', der Listenname "`Diagrammverzeichnis"'. +Die Liste kann mit |\listofdiagrams| gesetzt werden. +Abhängig von den geladenen Paketen werden auch ggf.~die Umgebungen |FPdiagram|, +|sidewaysdiagram|, |SCdiagram| und |wrapdiagram| mitdefiniert. + % --------------------------------------------------------------------------- % -\subsection{Weiterf"uhrende Beispiele} +\PageBreak +\subsection{Weiterführende Beispiele} +\label{examples} + +\subsubsection*{Beispiel 1} %\NEWdescription{v3.1} Möchte man die Bezeichnung (inkl. Trenner wie Doppelpunkt) vom Text mit einem -Zeilenumbruch getrennt haben, so könnte man dies z.B.~so bewerkstelligen: +Zeilenumbruch getrennt haben, so ließe sich das (auch) so bewerkstelligen: \begin{quote} |\DeclareCaptionFormat{myformat}{#1#2\\#3}| \end{quote} -Wählt man anschließend dieses Format mit |\captionsetup{format=myformat}| aus, +Wählt man anschließend dieses Format mit |\caption|\-|setup{format=|\x|myformat}| aus, so erhält man Beschriftungen der Art: %\begin{Example} -% \captionsetup{aboveskip=0pt} +% \captionsetup{skip=0pt} \example{format=myformat1,labelfont=bf}{\exampletext} %\end{Example} Auch einen Einzug könnte man diesem Format mit auf den Weg geben: @@ -1276,7 +2149,7 @@ Auch einen Einzug könnte man diesem Format mit auf den Weg geben: \end{quote} führt zu Beschriftungen wie: %\begin{Example} -% \captionsetup{aboveskip=0pt} +% \captionsetup{skip=0pt} \example{format=myformat1,indention=1cm,labelfont=bf}{\exampletext} %\end{Example} Aber Sie möchten den Einzug nur auf die erste Zeile des Texts anwenden? @@ -1284,68 +2157,1240 @@ Kein Problem, so würde z.B.~die Definition \begin{quote} |\newlength\myindention|\\ |\DeclareCaptionFormat{myformat}%|\\ - | {#1#2\\\hspace*{\myindention}#3}|\\ + | {#1#2\\\hspace*{\myindention}#3}|\\ \ldots\\ |\setlength\myindention{1cm}|\\ |\captionsetup{format=myformat}| \end{quote} zu Beschriftungen dieser Art führen: %\begin{Example} -% \captionsetup{aboveskip=0pt} +% \captionsetup{skip=0pt} \example{format=myformat2,myindention=1cm,labelfont=bf}{\exampletext} %\end{Example} Zu der Länge |\myindention| hätten Sie gerne eine Option, so daß man diesen -Einzug auch z.B.~mit |\captionsetup|\xx|[figure]|\xx|{myindention=|\ldots|}| setzen kann? +Einzug auch z.B.~mit |\caption|\-|setup|\x|[figure]|\x|{myindention=|\ldots|}| setzen kann? Auch dies läßt sich bewerkstelligen, z.B.~folgendermaßen: \begin{quote} |\newlength\myindention|\\ |\DeclareCaptionOption{myindention}%|\\ - | {\setlength\myindention{#1}}|\\ + | {\setlength\myindention{#1}}|\\ |\DeclareCaptionFormat{myformat}%|\\ - | {#1#2\\\hspace\myindention #3}|\\ + | {#1#2\\\hspace*{\myindention} #3}|\\ \ldots\\ |\captionsetup{format=myformat,myindention=1cm}| \end{quote} -\bigskip\pagebreak[3] +\subsubsection*{Beispiel 2} -Ein anderes Beispiel: Die Beschriftungen sollen wie folgt aussehen: +Die Beschriftungen sollen wie folgt aussehen: %\begin{Example} -% \captionsetup{aboveskip=0pt} +% \captionsetup{skip=0pt} \example{format=reverse,labelformat=fullparens,labelsep=fill,labelfont=it}{\exampletext} %\end{Example} \pagebreak[2] -Dies lie"se sich z.B. wie folgt realisieren: +Dies ließe sich beispielsweise wie folgt realisieren: \nopagebreak[3] -{\leftmargini=10pt - \begin{quote} - |\DeclareCaptionFormat{reverse}{#3#2#1}|\\ - |\DeclareCaptionLabelFormat{fullparens}%|\\ - | {(\bothIfFirst{#1}{~}#2)}|\\ - |\DeclareCaptionLabelSeparator{fill}{\hfill}|\\ - |\captionsetup{format=reverse,labelformat=fullparens,|\\ - | labelsep=fill,font=small,labelfont=it}| - \end{quote}} - -\bigskip\pagebreak[3] - -Ein weiteres Beispiel: Der Bezeichner soll in den linken Rand verlagert -werden, so da"s die komplette Absatzbreite der Beschriftung selber zugute kommt: -{\leftmargini=10pt - \begin{quote} - |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\ - |\captionsetup{format=llap,labelsep=quad,singlelinecheck=no}| - \end{quote}} -Das Ergebnis w"aren Beschriftungen wie diese: -%\begin{Example} -% \captionsetup{aboveskip=0pt} - \example{format=llap,labelsep=quad,singlelinecheck=no,margin=0pt}{\exampletext} -%\end{Example} +\begin{quote} + |\DeclareCaptionFormat{reverse}{#3#2#1}|\\ + |\DeclareCaptionLabelFormat{fullparens}%|\\ + | {(\bothIfFirst{#1}{~}#2)}|\\ + |\DeclareCaptionLabelSeparator{fill}{\hfill}|\\ + |\captionsetup{format=reverse,labelformat=fullparens,|\\ + | labelsep=fill,font=small,labelfont=it}| +\end{quote} + +\subsubsection*{Beispiel 3} + +Der Bezeichner soll in den linken Rand verlagert werden, +so daß die komplette Absatzbreite der Beschriftung selber zugute kommt: +\begin{quote} + |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\ + |\captionsetup{format=llap,labelsep=quad,singlelinecheck=no}| +\end{quote} +Das Ergebnis wären Beschriftungen wie diese: +\example{format=llap,labelsep=quad,singlelinecheck=no,margin=0pt}{\exampletext} + +\medskip + +Soll der Einzug in den Rand eine feste Größe sein (z.B.~$2.5$\,cm), +so könnte hierfür eine Kombination aus |\llap| und |\makebox| angewandt werden, +zum Beispiel: +\begin{quote} + |\DeclareCaptionFormat{llapx}%|\\ + | {\llap{\makebox[2.5cm][l]{#1}}#3\par}|\\ + |\captionsetup{format=llapx,singlelinecheck=off}| +\end{quote} +\example{format=llapx,singlelinecheck=off,skip=0pt,margin=0pt}{\exampletext} + +\subsubsection*{Beispiel 4} + +Dieses Beispiel setzt eine Abbildung neben eine Tabelle, aber verwendet eine +einzige, kombinierte Beschriftung für beide. Dies wird durch eine Kombination +aus |\Declare|\-|Caption|\-|Label|\-|Format| und |\caption|\-|list|\-|entry| +realisiert: +\begin{quote} + |\DeclareCaptionLabelFormat{andtable}%|\\ + | {#1~#2 \& \tablename~\thetable}|\\ + \ldots\\ + |\begin{figure}|\\ + | \centering|\\ + | \includegraphics{|\ldots|}%|\\ + | \qquad|\\ + | \begin{tabular}[b]{\ldots}|\\ + | |\ldots\\ + | \end{tabular}|\\ + | \captionlistentry[table]{|\ldots|}|\\ + | \captionsetup{labelformat=andtable}|\\ + | \caption{|\ldots|}|\\ + |\end{figure}| +\end{quote} +\DeleteShortVerb{\|}% +\noindent\begin{minipage}{\linewidth} + \captionsetup{type=figure} + \centering + \includegraphics[width=30pt]{cat}% + \qquad + \begin{tabular}[b]{r|rr} + & x & y \\\hline + a & 1 & 2 \\ + b & 3 & 4 \\ + \end{tabular} + \captionlistentry[table]{A figure and a table with a common caption} + \captionsetup{labelformat=andtable} + \caption{A figure and a table with a common caption~\footnotemark} +\end{minipage} +\footnotetext{Das Katzenbild wurde den Beispielen zum \LaTeX"=Begleiter\cite{TLC2} + entnommen, die Erlaubnis hierzu wurde eingeholt.} +\MakeShortVerb{\|} % --------------------------------------------------------------------------- % -\pagebreak[4] -\section{Unterstützung der Dokumentenklassen} % \& Babel} +\clearpage +%\section{Dokumentenklassen \& Babel-Unterstützung} +%\label{classes} + +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% + +\iffalse + +\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. + +\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. + +\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 +\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. +\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. +\end{Expert} + +\newcommand*\Option{Option} +\newcommand*\defaultvalue{Standard-Belegung (\texttt{default})} +\newcommand*\use{\textit{verwendet}} +\newcommand*\settings{\textit{Einstellungen}} +\newcommand*\nofont{\textit{keiner}} + +\subsection{Standard \LaTeX: article, report und book} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |plain| \\ +|labelformat=| & |simple| \\ +|labelsep=| & |colon| \\ +|justification=| & |justified| \\ +|font=| & \nofont \\ +|labelfont=| & \nofont \\ +|textfont=| & \nofont \\ +\end{tabular} + +\begin{Annotation} +This also applies to document classes derived from them. +%Dies gilt in der Regel auch für abgeleitete Dokumentenklassen. +\end{Annotation} + +\subsection{\AmS: amsart, amsproc und amsbook} +\label{AMS} + +\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} + +\begin{Annotation*} +|\@caption|\-|font| will be set to |\normal|\-|font|, and +|\@caption|\-|head|\-|font| to |\sc|\-|shape| by the \AmS\ document classes. +\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 +|\clear|\-|caption|\-|setup[margin*]{single|\-|line}| +into the preamble of your document, after loading \thispackage. + +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. + +\subsection{beamer} +\label{beamer} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |plain| \\ +|labelformat=| & \textit{nicht nummeriert} \\ +|labelsep=| & |colon| \\ +|justification=| & |raggedright| \\ +|font=| & \use\ \class{beamer} |caption| \settings \\ +|labelfont=| & \use\ \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. + +\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| \\ +|justification=| & |justified| \\ +|font=| & \use\ |\setkomafont{caption}| \settings \\ +|labelfont=| & \use\ |\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. + +\subsection{\NTG: artikel, rapport und boek} +\label{NTG} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |plain| \\ +|labelformat=| & |simple| \\ +|labelsep=| & |colon| \\ +|justification=| & |justified| \\ +|font=| & \nofont \\ +|labelfont=| & \use\ |\CaptionLabelFont| \\ +|textfont=| & \use\ |\CaptionTextFont| \\ +\end{tabular} + +\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} +\label{SMF} + +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 |\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). + +\subsection{thesis} +\label{thesis} + +\begin{tabular}{ll} +\Option & \defaultvalue \\\hline +|format=| & |hang| \\ +|labelformat=| & \textit{like \purett{simple}, but with short name}\\ +|labelsep=| & |colon| \\ +|justification=| & |justified| \\ +|font=| & \nofont \\ +|labelfont=| & \use\ |\captionheaderfont| \\ +|textfont=| & \use\ |\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. + +\subsection{Die französische Babel-Option} +\label{frenchb} + +If you use the \package{frenchb} option of the \package{babel} package +with one of the three standard \LaTeX{} classes (or a one derived from them) +the default |labelsep=| will be set to \cs{CaptionSeparator} (offered by +\package{frenchb}), overriding the default value set by the document class. +So redefining \cs{CaptionSeparator} will still work, unless you don't +select a different |labelsep=| than the default one. + +\INFO* +Please load \thispackage\ \emph{after} the \package{babel} package. +%Bitte laden Sie \thispackage\ \emph{nach} dem \package{babel}"=Paket. + +\subsection{Das frenchle- und frenchpro-Paket} +\label{frenchle} +\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. + +\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. + +% --------------------------------------------------------------------------- % + +\clearpage +\section{Interaktion mit anderen Paketen} +\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: +\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} +\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. + +\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.} +\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|\\ + |(caption) unknown to the caption package.|\\ + |See the caption package documentation for explanation.| +\end{quote} +\endgroup + +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 |\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 the \textsf{hypcap} feature \See{\Ref{hyperref}\,} + \item the sub-caption feature \See{\package{subcaption} package documentation} +\end{itemize} + +\DescribeMacro{compatibility=} +You can override this compatibility mode by specifying the 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.) + +\newcommand\packagedescription[1]{% + \ifvmode\else\par\fi + \nopagebreak + \parbox[b]{\linewidth}{\footnotesize\leftskip=10pt\rightskip=10pt\relax#1}\par + \nopagebreak\smallskip\nopagebreak} + +\PageBreak +\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.} + +Since the \texttt{algorithm} environment is implemented via |\newfloat| +provided by the \package{float} package\cite{float}, please see \Ref{float}. + +\iffalse +\pagebreak[3] +\subsection{algorithm2e} +\label{algorithm2e} +\packagedescription{% +The \package{algorithm2e} package\cite{algorithm2e} offers an environment for +writing algorithms in LaTeX2e.} + +Since the \package{algorithm2e} package does not use some kind of standard +interface for defining its floating environment (e.g.~|\newfloat| of the +\package{float} package) and typesetting its caption, +the \package{algorithm2e} package is \emph{not} supported by \thispackage. + +So if you want to customize the captions using \thispackage, +you have to build a new environment which uses a supported interface regarding +floats (e.g. using the \package{float} or \package{floatrow} package), +and combine this environment with the internal \package{algorithm2e} code. + +As first step you could define a non-floating environment \texttt{algorithmic}, +for example: +\begin{quote} + |\usepackage{algorithm2e}|\\ + |% save the "algorithm" environment from the algorithm2e package|\\ + |\let\ORIGalgorithm\algorithm|\\ + |\let\ORIGendalgorithm\endalgorithm|\\ + |% define the algorithmic environment|\\ % , based on the saved environment + |\newenvironment{algorithmic}%|\\ + | {\renewenvironment{algocf}[1][h]{}{}% pass over floating stuff|\\ + | \ORIGalgorithm}%|\\ + | {\ORIGendalgorithm}|\\ + \ldots +\end{quote} +Having defined this non-floating environment, you could define your own new +floating environment with |\newfloat| of the \package{float} package +(or |\DeclareNewFloatType| of the \package{floatrow} package), +and use the combination of this floating environment and \texttt{algorithmic} +in its body, just like you would do when you use the +\package{algorithm}/\package{algorithmic} package tandem. + +You could even use the \package{algorithm} package for this purpose, for example: +\begin{quote} + \ldots\\ + |% load the algorithm package to re-define the|\\ + |% floating environment "algorithm" and \listofalgorithms|\\ + |\let\listofalgorithms\undefined|\\ + |\usepackage{algorithm}|\\ + \ldots\\ + |% Example usage:|\\ + |\begin{algorithm}|\\ + |\caption{An algorithm}|\\ + |\begin{algorithmic}|\\ + | \SetVline|\\ + | \eIf{cond1}{|\\ + | a line\;|\\ + | }{|\\ + | another line\;|\\ + | }|\\ + |\end{algorithmic}| +\end{quote} +Now you are finally able to customize the float and caption layout like every +other floating environment defined with the \package{float} package\cite{float}, +please see \Ref{float}. + +\begin{Annotation} +An alternative would be using the \package{algorithmicx} package. +\end{Annotation} +\fi + +\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 +|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 +\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}|. + +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 |\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}|. + +\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}. +\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 +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[3] +\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 |float|\-|ing|\-|figure| \& +|float|\-|ing|\-|table| 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|. + +\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|}|. +\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.} + +\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|. + +Furthermore \cs{DeclareCaptionType}\marg{name} will also define +an environment called |FP|\meta{name} which behaves like |FPfigure| and +|FPtable|. + +\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.} + +\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: +\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|.) +\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. + +\pagebreak[3]Please note:\nopagebreak +%Bitte beachten Sie: +\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. +\begin{quote} +|\begin{minipage}{\linewidth}|\\ +| |\ldots\\ +| \captionof{figure}{A figure}|\\ +|\end{minipage}| +\end{quote} +will place the hyperlink anchor at the caption. +(And if |hypcap=|\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.) +\begin{quote} +|\begin{minipage}{\linewidth}|\\ +| \captionsetup{type=figure}|\\ +| |\ldots\\ +| \caption{A figure}|\\ +|\end{minipage}| +\end{quote} +will place the hyperlink anchor at the beginning of the |minipage|, +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|. + +\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. +\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. + +\pagebreak[3] +\subsection{listings} +\label{listings} +\packagedescription{% +The \package{listings} package\cite{listings} typesets programming code.} + +If you want to setup special options for the |lstlinsting| environment +you can use +\begin{quote} + |\captionsetup[lstlisting]|\marg{options}\quad. +\end{quote} + +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}|. + +\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|. + +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|.) + +\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. +\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). +\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}.} + +\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|. + +\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|}|. +\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}.} + +\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|.\par +Furthermore |\piccaption[]{|\ldots|}| produce no entry in the List of Figures, +and |\piccaption*{|\ldots|}| gives an unlabeled \& unnumbered caption. + +\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|}|. +\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.: +\begin{quote} + |\piccaptiontype{table}|\\ + |\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.} + +\iffalse % No, we don't do that +If you want to setup special options for the |side|\-|ways|\-|figure| \& +|side|\-|ways|\-|table| 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 |\rot|\-|caption| will be extended by \thispackage, so +|\rot|\-|caption*| or |\rot|\-|caption|\-|of| can be used analogous to +|\caption| and |\caption|\-|of|. + +\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|. + +\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}} + +\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|. + +\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|. + +\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. +\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|}|. +\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. +\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: + +\pagebreak[3] +\DescribeMacro{margincaption} +The package option +\begin{quote} + |margincaption|\qquad{\small(e.g.~|\usepackage[margincaption]{sidecap}|)} +\end{quote} +causes all side-captions to be placed into the margin. + +\pagebreak[3] +\DescribeMacro{\sidecaptionvpos} +The command +\begin{quote} + |\sidecaptionvpos|\marg{float type}\marg{pos} +\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|'. + +\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.} + +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. + +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 |super|\-|tabular| 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|. + +\begin{Note} +|\Continued|\-|Float| does not work for |super|\-|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. +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| \& +|measured|\-|figure| 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|. + +\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|}|. +\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. +\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}.} + +\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{DeclareCaptionType}\marg{name} will also define +an environment called |wrap|\meta{name} which behaves like |wrapfigure| and +|wraptable|. + +\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|}|. +\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. +\end{Note} + +\else + +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% +%*****************************************************************************% + +\beginTODO + +\section{Dokumentenklassen \& Babel-Unterstützung} \label{classes} %\NEWdescription{v3.1} @@ -1386,8 +3431,8 @@ Sie in einem solchen Fall keinen Support. ohne Optionen bereits das eigentlich von der Dokumentenklasse vorgebene Aussehen der Beschriftungen. Wenn dies für Sie in Ordnung ist, sollten Sie als erstes die Option - |style=base| mittels |\usepackage|\xx|[style=base]|\xx|{caption}| oder - |\captionsetup|\xx|{style=base}| angeben, um \thispackage\ in einen + |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.)} @@ -1416,11 +3461,6 @@ Sie in einem solchen Fall keinen Support. \noindent{\small(\emph{Hinweis:} Dies gilt in der Regel auch für abgeleitete Dokumentenklassen.)} -\subsection{\AmS: amsart, amsproc und amsbook} -\label{AMS} - -\TODO - \subsection{beamer} \label{beamer} @@ -1437,20 +3477,20 @@ Dokumentenklassen.)} \textbf{Von der Klasse angebotene Befehle und Seiteneffekte:}\\ Die Zeichensatz- und Farbeinstellungen können mit -|\setbeamerfont|\xx|{caption}|\xx\marg{options} und -|\setbeamerfont|\xx|{caption name}|\xx\marg{options} vorgenommen werden. +|\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|\xx|{font=|\xx\meta{options}|}| oder -|\captionsetup|\xx|{labelfont=|\xx\meta{options}|}| einstellen.\par +|\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|\x|beamter|\x|template|\xx|{caption}|\xx|[|\meta{template}|]| +|\set|\-|beamter|\-|template|\x|{caption}|\x|[|\meta{template}|]| ausgewählt werden. Da \thispackage\ diesen Mechanismus ersetzt, haben -|\def|\x|beamer|\x|template*|\xx|{caption}|\xx\marg{template code} +|\def|\-|beamer|\-|template*|\x|{caption}|\x\marg{template code} und -|\set|\x|beamer|\x|template|\xx|{caption}|\xx|[|\meta{template}|]| +|\set|\-|beamer|\-|template|\x|{caption}|\x|[|\meta{template}|]| keine Funktion mehr, wenn \thispackage\ verwendet wird. \subsection{\KOMAScript: scrartcl, scrreprt \& scrbook} @@ -1502,55 +3542,6 @@ Beides funktioniert auch weiterhin, zumindest solange kein anderer Zeichensatz mittels der \package{caption}"=Paket"=Optionen |labelfont=| oder |textfont=| festgelegt wird. -\subsection{\SmF: smfart und smfbook} -\label{SMF} - -\TODO - -\subsection{Die französische Babel Option} -\label{frenchb} - -\TODO\iffalse -If you use the \package{frenchb} option of the \package{babel} package -with one of the three standard \LaTeX{} classes (or a one derived from them) -the default |labelsep=| will be set to \cs{CaptionSeparator} (offered by -\package{frenchb}), overriding the default value set by the document class. -So redefining \cs{CaptionSeparator} will still work, unless you don't -select a different |labelsep=| than the default one. -\fi - -\INFO* -Bitte laden Sie \thispackage\ \emph{nach} dem \package{babel}"=Paket. - -\subsection{Das frenchle- und frenchpro-Paket} -\label{frenchpro} - -\TODO\iffalse -If you use the \package{frenchle} or \package{frenchpro} package, -the default |labelsep=| will be set to \cs{captionseparator} (offered by -\package{frenchle/pro}) plus \cs{space}, overriding the default value set -by the document class. -So redefining \cs{captionseparator} will still work, unless you don't -select a different |labelsep=| than the default one. - -Furthermore the default |textfont=| will be set to |textfont=it|, -since this emulates the default setting of |\captionfont| defined by the -\package{frenchle} or \package{frenchpro} package. -%If you redefine |\captionfont| after loading the \package{frenchle} or -%\package{frenchpro} package, this redefinition gets lost. -Please note that the command \cs{captionfont} is used by the -\package{caption} package internally for a different purpose, -so you should not change it (anymore). - -The command \cs{unnumberedcaptions}\marg{figure or table} will still work, -but only unless you don't select a different |labelformat=| than the default -one. -\fi - -\INFO* -Bitte laden Sie \thispackage\ \emph{nach} dem \package{frenchle} -oder \package{frenchpro}"=Paket. - % --------------------------------------------------------------------------- % \pagebreak[4] @@ -1571,21 +3562,6 @@ Tabellenbeschriftungen anbieten, angepasst: Weiterhin arbeiten das \package{floatrow}- und das \package{subfig}"=Paket aktiv mit diesem Paket zusammen und verwenden die |\captionsetup|"=Schnittstelle. -\subsection{float} -\label{float} - -\TODO - -\subsection{floatflt} -\label{floatflt} - -\TODO - -\subsection{fltpage} -\label{fltpage} - -\TODO - \subsection{hyperref} \label{hyperref} @@ -1636,11 +3612,11 @@ hingegen plaziert den Anker an den Anfang der |minipage|. 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, +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 \cs{captionsetup}\csmarg{list=false} zu verwenden, +Daher ist es besser |\caption|\-|setup{list=|\x|false}| zu verwenden, wenn Sie keinen Eintrag in dem Abbildungs- oder Tabellenverzeichnis wünschen. \end{description} @@ -1651,465 +3627,103 @@ Wird das \package{hypcap}"=Paket zusätzlich zum \package{hyperref}"=Paket geladen, so übernimmt es die Kontrolle über die Platzierung der Hyperlink"=Anker. Dies hat den Nebeneffekt, daß die Hyperlink"=Anker innerhalb der Umgebungen -|floatingfigure| (vom \package{floatflt}"=Paket bereitgestellt), -|figwindow| (vom \package{picinpar}"=Paket bereitgestellt), -|parpic| (vom \package{picins}"=Paket bereitgestellt) und -|wrapfigure| (vom \package{wrapfig}"=Paket bereitgestellt) +|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 |\captionsetup{type=|\meta{Type}|}| +Außerdem ist zu beachten, daß dann |\caption|\-|setup{type=|\x\meta{Type}|}| keinen Hyperlink"=Anker mehr setzt, dies muß dann stattdessen mit -|\capstart| (welches vom \package{hypcap}"=Paket angeboten wird) geschehen. - -\subsection{listings} -\label{listings} - -\TODO - -\subsection{longtable} -\label{longtable} - -\TODO - -\subsection{picinpar} -\label{picinpar} - -\TODO - -\subsection{picins} -\label{picins} - -\TODO - -\subsection{rotating} -\label{rotating} - -\TODO - -\subsection{sidecap} -\label{sidecap} - -\TODO - -\subsection{subfigure} -\label{subfigure} - -\TODO +|\cap|\-|start| (welches vom \package{hypcap}"=Paket angeboten wird) geschehen. -\subsection{supertabular} -\label{supertabular} +\endTODO -\TODO - -\subsection{threeparttable} -\label{threeparttable} - -\TODO - -\subsection{wrapfig} -\label{wrapfig} - -\TODO +\fi % --------------------------------------------------------------------------- % -\pagebreak[4] -\section{Kompatibilit"at zu "alteren Versionen} -\label{compatibility} - -\subsection{caption v\texorpdfstring{$1.x$}{1.x}} -\label{caption1} - -Diese Version des \thispackage"=Paketes ist weitgehend kompatibel zu "alteren -Versionen des Paketes; alte, vorhandene Dokumente sollten sich also in der -Regel ohne Probleme weiterhin "ubersetzen lassen. -Jedoch ist zu beachten, da"s eine Mischung aus alten Befehlen und neueren -Optionen bzw.~Befehlen zu unerw"unschten Nebeneffekten f"uhren kann. - -Hier eine kurze "Ubersicht "uber die alten, "uberholten Optionen und ihre -aktuellen Entsprechungen: - -{\small\begin{longtable}{ll} -\package{caption} \version{1.x} & \package{caption} \version{3.x}\\ -\hline -\endhead -|normal| & |format=plain|\\ -|hang| & |format=hang|\\ -|isu| & |format=hang|\\ -|center| & |justification=centering|\\ -|centerlast| & |justification=centerlast|\\ -%|anne| & |justification=centerlast|\\ -|nooneline| & |singlelinecheck=off|\\ -|scriptsize| & |font=scriptsize|\\ -|footnotesize| & |font=footnotesize|\\ -|small| & |font=small|\\ -|normalsize| & |font=normalsize|\\ -|large| & |font=large|\\ -|Large| & |font=Large|\\ -|up| & |labelfont=up|\\ -|it| & |labelfont=it|\\ -|sl| & |labelfont=sl|\\ -|sc| & |labelfont=sc|\\ -|md| & |labelfont=md|\\ -|bf| & |labelfont=bf|\\ -|rm| & |labelfont=rm|\\ -|sf| & |labelfont=sf|\\ -|tt| & |labelfont=tt|\\ -\end{longtable}} - -Neben den Optionen zum Einstellen des Zeichensatzes gab es auch die Befehle -|\captionsize| bzw. |\captionfont| und |\captionlabelfont|, die direkt -mittels |\renewcommand| ver"andert werden konnten. Dieser Mechanismus -wurde durch die Anweisungen -\begin{quote} - |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad und\\ - |\captionsetup{font=|\ldots|,labelfont=|\ldots|}| -\end{quote} -ersetzt. \SeeUserDefined - -Das Setzen eines Randes geschah in \version{1.x} mittels -\begin{quote} - |\setlength{\captionmargin}{|\ldots|}|\quad. -\end{quote} -Dies wurde durch -\begin{quote} - |\captionsetup{margin=|\ldots|}| -\end{quote} -ersetzt. \See{\Ref{margins}} - -Zum Beispiel w"urde -\begin{quote} -|\usepackage[hang,bf]{caption}|\\ -|\renewcommand\captionfont{\small\sffamily}|\\ -|\setlength\captionmargin{10pt}| -\end{quote} -in aktueller Notation -\begin{quote} -|\usepackage[format=hang,labelfont=bf,font={small,sf},|\\ -| margin=10pt]{caption}| -\end{quote} -bzw. -\begin{quote} -|\usepackage{caption}|\\ -|\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\ -| margin=10pt}| -\end{quote} -hei"sen. - -Die etwas exotische Option |ruled|, die eine partielle Anwendung der -eingestellten Parameter bei gleitenden Umgebungen des Typs |ruled| -aktivierte, wird ebenfalls emuliert, hat aber keine direkte -Entsprechung in dieser Version des \package{caption}"=Paketes. -M"ochte man gezielt das Aussehen der Abbildungen des Stils |ruled|, -der durch das \package{float}"=Paket zur Verf"ugung gestellt wird, -ver"andern, so ist dies nun durch -\begin{quote} - |\DeclareCaptionStyle{ruled}{|\ldots|}| -\end{quote} -bzw. -\begin{quote} - |\captionsetup[ruled]{|\ldots|}| -\end{quote} -m"oglich. -\SeeUserDefined[, \Ref{commands} und \Ref{float}] - -\subsection{caption2 v\texorpdfstring{$2.x$}{2.x}} -\label{caption2} - -Die Pakete \package{caption} und seine experimentelle, nun veraltete -Variante \package{caption2} sind vom internen Konzept -her zu unterschiedlich, um hier eine vollst"andige Kompatibilit"at -gew"ahrleisten zu k"onnen. -Daher liegt diesem Paket weiterhin die Datei |caption2.sty| bei, so da"s -"altere Dokumente, die das \package{caption2}"=Paket verwenden, weiterhin -"ubersetzt werden k"onnen. - -Neue Dokumente sollten jedoch auf dem aktuellen \package{caption}"=Paket -aufgesetzt werden. In den meisten F"allen ist es ausreichend, einfach -ggf.~die Anweisung -\begin{quote} - |\usepackage[...]{caption2}| -\end{quote} -durch -\begin{quote} - |\usepackage[...]{caption}| -\end{quote} -zu ersetzen. Einige Optionen und Befehle werden jedoch nicht emuliert, -so da"s sie anschlie"send Fehlermeldungen erhalten k"onnen. -Die folgenden Abs"atze werden Ihnen jedoch bei der Umsetzung dieser -Optionen und Befehle helfen. Sollten dar"uberhinaus noch Fragen oder -Probleme auftreten, so z"ogern Sie bitte nicht, mich diesbez"uglich -per E-Mail zu kontaktieren. - -Zus"atzlich zu den bereits im vorherigen Abschnitt vorgestellten Optionen -werden auch folgende emuliert: - -{\small\begin{longtable}{ll} -\package{caption2} \version{2.x} & \thispackage\ \version{3.x}\\ -\hline -\endhead -|flushleft| & |justification=raggedright|\\ -|flushright| & |justification=raggedleft|\\ -|oneline| & |singlelinecheck=on|\\ -\end{longtable}} - -Das Setzen eines Randes geschah in \version{2.x} mittels -\begin{quote}\leavevmode\hbox{% - |\setcaptionmargin{|\ldots|}| bzw. - |\setcaptionwidth{|\ldots|}|\quad. -}\end{quote} -Dies wurde durch -\begin{quote}\leavevmode\hbox{% - |\captionsetup{margin=|\ldots|}| bzw. - |\captionsetup{width=|\ldots|}| -}\end{quote} -ersetzt. \See{\Ref{margins}} - -Das Setzen des Einzuges wurde in \version{2.x} mit -\begin{quote} - |\captionstyle{indent}|\\ - |\setlength\captionindent{|\ldots|}| -\end{quote} -erledigt, dies geschieht nun mit -\begin{quote} - |\captionsetup{format=plain,indention=|\ldots|}|\quad. -\end{quote} - -Die Sonderbehandlung von einzeiligen Beschriftungen lie"s sich in -\version{2.x} mit |\oneline|\-|captions|\-|false| aus- -bzw. |\oneline|\-|captions|\-|true| wieder einschalten. Dies wurde durch -|\captionsetup{|\xx|singlelinecheck=|\xx|off}| -bzw. -|\captionsetup{|\xx|singlelinecheck=|\xx|on}| -ersetzt. \See{\Ref{justification}} - -Die Befehle -\begin{quote} - |\captionlabeldelim|, |\captionlabelsep|, |\captionstyle|,\\ - |\defcaptionstyle|, |\newcaptionstyle| und |\renewcaptionstyle| -\end{quote} -haben keine direkte Entsprechnung und werden daher durch diese -Version des \package{caption}"=Paketes auch nicht emuliert. -Sie f"uhren also bei der Verwendung %mit diesem \thispackage"=Paket -zu Fehlermeldungen und m"ussen daher zwingend umgesetzt werden. -Die Umsetzung ist von Fall zu Fall verschieden, lesen Sie sich daher bitte -diese Anleitung gr"undlich durch und suchen Sie sich die Optionen bzw.~Befehle -als Ersatz heraus, die Ihren W"unschen entsprechen. - -\iffalse -Als kleine Hilfestellung hier die Beispiele aus der alten Anleitung zum -\package{caption2}"=Paket und deren Umsetzung: - -\newenvironment{OldNew}% - {\begin{minipage}\linewidth - \def\Old{Alt:\begin{quote}}% - \def\New{\end{quote}Neu:\begin{quote}}% - \def\Or{\end{quote}\centerline{-- oder --}\begin{quote}}% - }% - {\end{quote}\end{minipage}} - -\begin{OldNew} -\Old - |\captionstyle{center}| -\New - |\captionsetup{justification=centering}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\captionstyle{indent}|\\ - |\setlength{\captionindent}{1cm}| -\New - |\captionsetup{format=plain,indention=1cm}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\renewcommand\captionfont{\small}|\\ - |\renewcommand\captionlabelfont{\itshape}| -\New - |\captionsetup{font=small,labelfont=it}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\renewcommand\captionfont{\small\itshape}|\\ - |\renewcommand\captionlabelfont{\upshape}| -\New - |\captionsetup{font=small,textfont=it}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\setcaptionwidth{.5\textwidth}| -\New - |\captionsetup{width=.5\textwidth}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\setcaptionmargin{.25\textwidth}| -\New - |\captionsetup{margin=.25\textwidth}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{absatz}{\captionlabel: \exampletext\par}|\\ - |\captionstyle{absatz}| -\New - |\DeclareCaptionFormat{absatz}{#1: #3\par}|\\ - |\captionsetup{format=absatz,singlelinecheck=off}| -\Or - |\captionsetup{format=plain,singlelinecheck=off}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{fancy}{\textsf{\captionlabel}\\\exampletext\par}|\\ - |\captionstyle{fancy}| -\New - |\DeclareCaptionFormat{fancy}{\textsf{#1}\\#3\par}|\\ - |\captionsetup{format=fancy,singlelinecheck=off}| -\Or - |\captionsetup{format=plain,labelfont=sf,labelsep=newline}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{fancy2}{\exampletext\hfill\textit{(\captionlabel)}}|\\ - |\captionstyle{fancy2}| -\New - |\DeclareCaptionFormat{fancy2}{#3\hfill\textit{(#1)}}|\\ - |\captionsetup{format=fancy2,singlelinecheck=off}| -\end{OldNew} - -\hrule - -\begin{OldNew} -\Old - |\newcaptionstyle{mystyle}{%|\\ - | \normalcaptionparams|\\ - | \renewcommand\captionlabelfont{\bfseries}%|\\ - | \renewcommand\captionlabeldelim{.}%|\\ - | \onelinecaptionsfalse|\\ - | \usecaptionstyle{centerlast}}|\\ - |\captionstyle{mystyle}| -\New - |\DeclareCaptionStyle{mystyle}{labelfont=bf,labelsep=period,justification=centerlast}|\\ - |\captionsetup{style=mystyle}| -\end{OldNew} - -\hrule +\clearpage +\section{Weiterführende Dokumente} -\begin{OldNew} -\Old - |\newcaptionstyle{hangandleft}{%|\\ - | \let\oldcaptiontext\exampletext|\\ - | \def\exampletext{\raggedright\oldcaptiontext}%|\\ - | \usecaptionstyle{hang}}|\\ - |\captionstyle{hangandleft}| -\New - |\captionsetup{format=hang,justification=raggedright}| -\end{OldNew} +Folgende, im Internet verfügbare Dokumente möchte ich an dieser Stelle +jedem ans Herz legen: -\hrule +\begin{itemize} +\item + Die \TeX\ FAQ -- "`Frequently Asked Questions"' über \TeX\ und \LaTeX: + \begin{quote}\url{http://faq.tug.org/}\end{quote} -\begin{OldNew} -\Old - |\newcaptionstyle{fancy}{%|\\ - | \usecaptionmargin\captionfont|\\ - | \onelinecaption|\\ - | {{\captionlabelfont\captionlabel\captionlabeldelim}%|\\ - | \captionlabelsep\exampletext}%|\\ - | {{\centering\captionlabelfont\captionlabel\par}%|\\ - | \centerlast\exampletext\par}}|\\ - |\captionstyle{fancy}| -\New - |\DeclareCaptionFormat{fancy}{\centering#1\par\centerlast#3\par}|\\ - |\DeclareCaptionStyle{fancy}|\\ - | [format=plain,justification=centering]|\\ - | {format=fancy}|\\ - |\captionsetup{style=fancy}| -\Or - |\DeclareCaptionFormat{fancy}{#1\par#3\par}|\\ - |\DeclareCaptionStyle{fancy}|\\ - | [format=plain,justification=centering]|\\ - | {format=fancy,justification=centerlast}|\\ - |\captionsetup{style=fancy}| -\end{OldNew} +\iffalse % Völlig veraltet, daher leider keine Empfehlung mehr wert +\item + Die DANTE-FAQ -- Oft gestellte Fragen \& deren Antworten: + \begin{quote}\url{http://www.dante.de/faq/de-tex-faq/}\end{quote} +\fi -\hrule +\item + \emph{"`Hilfe für LaTeX-Einsteiger"'} von Christian Faulhammer: + \begin{quote}\url{http://www.minimalbeispiel.de/}\end{quote} -\begin{OldNew} -\Old - |\renewcaptionstyle{longtable}{\usecaptionstyle{normal}}| -\New - |\captionsetup[longtable]{format=plain}| -\end{OldNew} -\fi +\item + \emph{"`Bilder einfügen in \LaTeX: Ein How-To"'} von Dominik Bischoff + beinhaltet die häufigsten Fragen und Antworten, die im Zusammenhang + mit \LaTeX\ und Abbildungen auftreten: + \begin{quote} + \url{http://dante.ctan.org/info/l2picfaq/german/l2picfaq.pdf} + \end{quote} -Ebenfalls keine Entsprechung hat die \version{2.x}"=Option |ignoreLTcapwidth|. -Deren Verwendung kann in der Regel einfach entfallen, da \thispackage\ den -Wert von |\LTcapwidth| sowieso nicht beachtet, solange er nicht explizit auf -einen anderen Wert als den Standardwert ($=$|4in|) gesetzt wird. -\See{\Ref{longtable}} +\item + \emph{"`Gleitobjekte -- die richtige Schmierung"'} von Axel Reichert + erl"autert den Umgang mit gleitenden Umgebungen und ist hier im Netz + zu finden: + \begin{quote} + \url{ftp://dante.ctan.org/pub/tex/info/german/gleitobjekte/} + \end{quote} -\subsection{caption v\texorpdfstring{$3.0$}{3.0}} -\label{caption3} +\item + \textsf{epslatex} von Keith Reckdahl enth"alt viele n"utzliche Tips im + Zusammenhang mit der Einbindung von Graphiken in \LaTeXe. + Das Dokument ist in Englisch und unter + \begin{quote}\url{ftp://dante.ctan.org/pub/tex/info/epslatex/}\end{quote} + zu finden. +\end{itemize} -%\NEWdescription{v3.1} -\Thispackage\ \version{3.0} hatte keine weiteren Dokumentenklassen -aktiv unterstützt als die drei Standard"=Klassen, die \LaTeX\ selber -mitbringt: |article|, |report| und |book|. -Daher waren die Vorbelegungen der Einstellungsmöglichkeiten fest durch -dieses Paket vorgegeben, sie repräsentierten das Aussehen bei Verwendung -einer dieser Klassen. -Nun aber unterstützt \thispackage\ mehr Dokumentenklasse aktiv, folglich -kann die Vorbelegung nun von der verwendeten Dokumentenklasse abhängen. +% --------------------------------------------------------------------------- % -Ein Beispiel: Während in \version{3.0} die Vorbelegung der Ausrichtung -immer |justification=|\xx|justified| was, ist sie nun immer noch |justified| -wenn eine der drei Standardklassen verwendet wird, aber -|justification=|\xx|raggedright|, wenn die \package{beamer}"=Klasse verwendet -wird. +\pagebreak[3] +\section{Danksagungen} -Möchten sie weiterhin die "`alten"' Vorbelegungen, so können Sie die Option -|style=base| beim Laden des \package{caption}"=Paketes angeben oder später -mittels |\captionsetup|\xx|{style=base}| den alten Grundzustand wieder herstellen. +Von ganzem Herzen danke ich Katja Melzner, +Steven D. Cochran, Frank Mittelbach, Olga Lapko, +David Carlisle, Carsten Heinz und Keith Reckdahl. -Weiterhin prüft die aktuelle Version des \package{caption}"=Paketes automatisch -nach Inkompatibilitäten und gibt ggf.~ eine Warnung diesbezüglich 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 Features geäußert. -Die Kompatibilitätswarnungen sagen auch nicht aus, daß etwas schief gegangen ist, -sondern lediglich, daß etwas schief gehen kann. Sie sollten aber auf jeden Fall, -wenn Sie \thispackage\ trotz einer solchen Warnung einsetzen, die Abbildungs- -und Tabellenbeschriftungen bzgl.~ ihres Aussehens genau im Auge behalten. +Weiterhin möchte ich mich herzlich bei +Harald Harders, +Peter Löffler, +Peng Yu, +Alexander Zimmermann, +Matthias Pospiech, +Jürgen Wieferink, +Christoph Bartoschek, +Uwe Stöhr, +Ralf Stubner, +Geoff Vallis, +Florian Keiler, +Jürgen Göbel, +Uwe Siart, +Sang-Heon Shim, +Henrik Lundell, +David Byers, +William Asquith, +Prof.~Dr.~Dirk Hoffmann, +Frank Martini, +Danie Els +und Markus Kohm +für ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. % --------------------------------------------------------------------------- % -\pagebreak[4] +\clearpage\appendix \section{Alphabetische Referenz} %\newenvironment{Warnings}% @@ -2139,104 +3753,125 @@ und Tabellenbeschriftungen bzgl.~ ihres Aussehens genau im Auge behalten. } \makeatother -\subsection{Befehle} - -\begin{longtable}{lll} -Befehl & & Abschnitt \\ -\hline -\endhead -|\abovecaptionskip| & & \ref{skips} \\ -%|\AtBeginCaption| & & \ref{x} \\ -%|\AtEndCaption| & & \ref{x} \\ -|\belowcaptionskip| & & \ref{skips} \\ -|\caption| & & \ref{commands} \\ -|\caption*| & & \ref{commands} \\ -|\captionof| & & \ref{commands} \\ -|\captionof*| & & \ref{commands} \\ -|\captionsetup| & & \ref{commands} \\ -|\captionsetup*| & & \ref{commands} \\ -|\centerfirst| & & \ref{justification} \\ -|\centerlast| & & \ref{justification} \\ -|\clearcaptionsetup| & & \ref{commands} \\ -|\clearcaptionsetup*| & & \ref{commands} \\ -|\ContinuedFloat| & & \ref{ContinuedFloat} \\ -|\DeclareCaptionFont| & & \ref{declare} \\ -|\DeclareCaptionFormat| & & \ref{declare} \\ -|\DeclareCaptionFormat*| & & \ref{declare} \\ -|\DeclareCaptionJustification| & & \ref{declare} \\ -|\DeclareCaptionLabelFormat| & & \ref{declare} \\ -|\DeclareCaptionLabelSeparator| & & \ref{declare} \\ -|\DeclareCaptionLabelSeparator*| & & \ref{declare} \\ -|\DeclareCaptionListFormat| & & \ref{declare} \\ -|\DeclareCaptionOption| & & \ref{declare} \\ -|\DeclareCaptionStyle| & & \ref{declare} \\ -|\DeclareCaptionSubType| & & \ref{DeclareCaptionType} \\ -|\DeclareCaptionTextFormat| & & \ref{declare} \\ -|\DeclareCaptionType| & & \ref{DeclareCaptionType} \\ -|\showcaptionsetup| & & \ref{commands} \\ -\end{longtable} - -\pagebreak[4] \subsection{Optionen} -\newcommand\preambleoption{ \footnotemark[1]} +\newcommand\preambleoption{~% + \begingroup\def\thefootnote{\fnsymbol{footnote}}% + \footnotemark[2]% + \endgroup} +\newcommand\preambleoptiontext{% + \begingroup\def\thefootnote{\fnsymbol{footnote}}% + \footnotetext[2]{Diese Optionen stehen nur in dem Dokumentenvorspann + (Präambel) zur Verfügung.}% + \endgroup} -\begin{longtable}{lll} -Option & Kurzbeschreibung & Abschnitt \\ +\begin{longtable*}{lll} +Option & Kurzbeschreibung & Abschnitt \\ \hline \endhead |aboveskip| & setzt den Abstand über der Beschriftung & \ref{skips} \\ |belowskip| & setzt den Abstand unter der Beschriftung & \ref{skips} \\ -|compatibility|\preambleoption & erzwingt (Nicht-)Kompatibilität & \ref{classes} \\ -%|config| & & \ref{x} \\ -|figurename| & setzt den Abbildungsnamen & \ref{x} \\ +|compatibility|\preambleoption & erzwingt (Nicht-)Kompatibilität & \ref{compatibility} \\ +%|config| & & \ref{x} \\ +|figurename|\preambleoption & setzt den Abbildungsnamen & \ref{names} \\ |figureposition|\preambleoption & gibt einen Hinweis auf die Position & \ref{skips} \\ -|font| & wählt den Zeichensatz & \ref{fonts} \\ +|figurewithin|\preambleoption & wählt die Zählerebene der Abbildungen & \ref{numbering} \\ +|font|(|+|) & wählt den Zeichensatz & \ref{fonts} \\ |format| & wählt das Format & \ref{formats} \\ -|FPlist| & wohin soll der Listeneintrag einer FPfigure zeigen? & \ref{fltpage} \\ -|FPref| & wohin soll ein |\ref| einer FPfigure zeigen? & \ref{fltpage} \\ +|FPlist| & Wohin soll der Listeneintrag einer FPfigure zeigen? & \ref{fltpage} \\ +|FPref| & Wohin soll ein |\ref| einer FPfigure zeigen? & \ref{fltpage} \\ |hangindent| & setzt den "`hängenden"' Einzug & \ref{margins} \\ |hypcap| & wählt das "`hypcap"' Feature aus & \ref{hyperref} \\ |hypcapspace| & setzt den Abstand über einem Hyperlink & \ref{hyperref} \\ |indention| & setzt den Einzug & \ref{margins} \\ |justification| & wählt die Ausrichtung & \ref{justification} \\ -|labelfont| & wählt den Zeichensatz des Bezeichners & \ref{fonts} \\ +|labelfont|(|+|) & wählt den Zeichensatz des Bezeichners & \ref{fonts} \\ |labelformat| & wählt das Format des Bezeichners & \ref{formats} \\ |labelsep| & wählt den Trenner zw. Bezeichner$+$Text & \ref{formats} \\ -|labelseparator| & wählt den Trenner zw. Bezeichner$+$Text & \ref{formats} \\ -|list| & schaltet die Listeneinträge an bzw. aus & \ref{list} \\ -|listformat| & wählt das Listenformat & \ref{list} \\ +|labelseparator| & -- identisch mit |labelsep| -- & \ref{formats} \\ +|list| & schaltet die Listeneinträge an bzw. aus & \ref{lists} \\ +|listfigurename| & setzt den Namen des Abbildungsverzeichnisses & \ref{names} \\ +|listformat| & wählt das Listenformat & \ref{lists} \\ +|listtablename| & setzt den Namen des Tabellenverzeichnisses & \ref{names} \\ |margin| & setzt den Rand bzw. die Ränder & \ref{margins} \\ |margin*| & setzt den Rand, sofern keine Breite gesetzt ist & \ref{margins} \\ |maxmargin| & setzt den max. zu verwendenen Rand & \ref{margins} \\ |minmargin| & setzt den min. zu verwendenen Rand & \ref{margins} \\ -|oneside| & wählt den einseitigen Modus & \ref{x} \\ -|options| & führt die angegebene Optionsliste aus & \ref{x} \\ +|name| & setzt den Namen der aktuellen Umgebung & \ref{names} \\ +|oneside| & wählt den einseitigen Modus & \ref{margins} \\ +|options| & führt die angegebene Optionsliste aus & \\ |parindent| & setzt den Absatzeinzug & \ref{margins} \\ |parskip| & setzt den Absatzabstand & \ref{margins} \\ |position| & gibt einen Hinweis auf die Position & \ref{skips} \\ -|singlelinecheck| & schaltet die "`Ein-Zeilen-Prüfung"' ein bzw. aus & \ref{justification} \\ +|singlelinecheck| & schaltet die "`Ein-Zeilen-Prüfung"' ein bzw. aus & \ref{justification} \\ %|size| & wählt die Größe des Zeichensatzes & \ref{x} \\ |skip| & setzt den Abstand zwischen Inhalt \& Beschriftung & \ref{skips} \\ |strut| & schaltet die Verwendung von |\strut| ein bzw. aus & \ref{formats} \\ -|style| & wählt einen kompletten Stil aus & \ref{style} \\ -|tablename| & setzt den Tabellennamen & \ref{x} \\ +|style| & wählt einen Stil aus & \ref{style} \\ +%|style*| & wählt einen Stil aus & \ref{style} \\ +|subtype| & setzt den Typ der Unterbeschriftungen & \phantom{t}--~\footnotemark \\ +|tablename|\preambleoption & setzt den Tabellennamen & \ref{names} \\ |tableposition|\preambleoption & gibt einen Hinweis auf die Position & \ref{skips} \\ -|textfont| & wählt den Zeichensatz des Textes & \ref{fonts} \\ +|tablewithin|\preambleoption & wählt die Zählerebene der Tabellen & \ref{numbering} \\ +|textfont|(|+|) & wählt den Zeichensatz des Textes & \ref{fonts} \\ |textformat| & wählt das Format des Textes & \ref{formats} \\ -|twoside| & wählt den zweiseitigen Modus & \ref{x} \\ -|type| & setzt den Typ \& setzt einen Hyperlink-Anker & \ref{x} \\ -|type*| & setzt (nur) den Typ & \ref{x} \\ +|twoside| & wählt den zweiseitigen Modus & \ref{margins} \\ +|type| & setzt den Typ \& setzt ggf.~einen Hyperlink-Anker & \ref{types} \\ +|type*| & setzt (nur) den Typ & \ref{types} \\ |width| & setzt eine feste Breite & \ref{margins} \\ -\end{longtable} -\footnotetext[1]{Diese Optionen stehen nur in dem Dokumentenvorspann (Preamble) - zur Verfügung.} -\nopagebreak\parbox[t]{\linewidth}{\small\emph{Hinweis:} - Veraltete Optionen sind hier nicht gelistet, - diese sind in\\ - \hspace*{1em}\Ref{caption1} und\\ - \hspace*{1em}\Ref{caption2} zu finden.} +\end{longtable*} +\preambleoptiontext +\footnotetext{Die Option \texttt{subtype} ist in der Dokumentation + des \package{subcaption}"=Paketes beschrieben.} + +\nopagebreak\parbox[t]{\linewidth}{% prevent from page break +\begin{Note*} + Veraltete Optionen sind hier nicht gelistet; diese sind in + \Ref{caption1} und + \Ref{caption2} zu finden. +\end{Note*}} -\pagebreak[4] +\pagebreak[3] +\subsection{Befehle} + +\begin{longtable*}{lll} +Befehl & & Abschnitt \\ +\hline +\endhead +|\abovecaptionskip| & & \ref{skips} \\ +%|\AtBeginCaption| & & \ref{hooks} \\ +%|\AtEndCaption| & & \ref{hooks} \\ +|\belowcaptionskip| & & \ref{skips} \\ +|\caption| & & \ref{caption} \\ +|\caption*| & & \ref{caption} \\ +|\captionlistentry| & & \ref{captionlistentry} \\ +|\captionof| & & \ref{caption} \\ +|\captionof*| & & \ref{caption} \\ +|\captionsetup| & & \ref{captionsetup} \\ +|\captionsetup*| & & \ref{captionsetup} \\ +|\centerfirst| & & \ref{justification} \\ +|\centerlast| & & \ref{justification} \\ +|\clearcaptionsetup| & & \ref{captionsetup} \\ +|\clearcaptionsetup*| & & \ref{captionsetup} \\ +|\ContinuedFloat| & & \ref{ContinuedFloat} \\ +|\DeclareCaptionFont| & & \ref{declare} \\ +|\DeclareCaptionFormat| & & \ref{declare} \\ +|\DeclareCaptionFormat*| & & \ref{declare} \\ +|\DeclareCaptionJustification| & & \ref{declare} \\ +|\DeclareCaptionLabelFormat| & & \ref{declare} \\ +|\DeclareCaptionLabelSeparator| & & \ref{declare} \\ +|\DeclareCaptionLabelSeparator*| & & \ref{declare} \\ +|\DeclareCaptionListFormat| & & \ref{declare} \\ +|\DeclareCaptionOption| & & \ref{declare} \\ +|\DeclareCaptionStyle| & & \ref{declare} \\ +|\DeclareCaptionSubType| & & --~\footnotemark \\ +|\DeclareCaptionTextFormat| & & \ref{declare} \\ +|\DeclareCaptionType| & & \ref{declare} \\ +|\showcaptionsetup| & & \ref{captionsetup} \\ +\end{longtable*} +\footnotetext{\cs{DeclareCaptionSubType} ist in der Dokumentation + des \package{subcaption}"=Paketes beschrieben.} + +\clearpage \subsection{Warnungen} \begin{Warnings} @@ -2246,11 +3881,13 @@ Option & Kurzbeschreibung & Abschnitt \\ \Or |\captionsetup{type=...} outside box or environment.| \Or - |\captionsetup{type*=...} or \captionof outside box or environment.| + |\captionsetup{type*=...} or \captionof outside box|\\ + | or environment.| \Description - |\caption|, |\captionof| sowie |\captionsetup{|\xx|type=|\xx\meta{type}|}| - sind nur für die Anwendung innerhalb einer Box, Gruppe oder Umgebung konzipiert. - \par\See{\Ref{commands}} + |\caption|, |\caption|\-|of| sowie |\caption|\-|setup{type=|\x\meta{type}|}| + sind nur für die Anwendung \emph{innerhalb} einer Box, Gruppe oder Umgebung + konzipiert. Außerhalb können unerwünschte Seiteneffekte auftreten. + \par\See{\Ref{types} und \Ref{caption}} \Message |\caption will not be redefined since it's already|\\ @@ -2261,89 +3898,91 @@ Option & Kurzbeschreibung & Abschnitt \\ |\caption| erkannt hat, definiert es |\caption| nicht erneut um, da dies unweigerlich den Verlust der ursprünglichen Erweiterung zur Folge hätte. Daher funktionieren manche Features, wie |\caption*|, - |\ContinuedFloat|, das optionale Argument von |\captionsetup|, + |\Continued|\-|Float|, das optionale Argument von |\caption|\-|setup|, sowie die Optionen |list=| und |hypcap=| nicht mehr; sie werden entweder ignoriert oder arbeiten nicht erwartungsgemäß.\par Wenn Sie an der ursprünglichen Erweiterung nicht interessiert sind und stattdessen den vollen Umfang des \package{caption}"=Paketes verwenden wollen, können Sie es mit der nicht supporteten(!) - Option |compatibility=false| probieren und die Daumen drücken. + Option |compatibility=|\x|false| probieren und die Daumen drücken. (Aber Sie werden die nächste Warnung stattdessen bekommen.) - \par\See{\Ref{classes}} + \par\See{\Ref{classes} und \Ref{compatibility}} \Message |Forced redefinition of \caption since the|\\ |unsupported(!) package option `compatibility=false'|\\ |was given.| \Description - Da Sie so mutig waren, die Option |compatibility=false| zu probieren, + Da Sie so mutig waren, die Option |compatibility=|\x|false| zu probieren, wird \thispackage\ sein bestes geben, um diesen Wunsch zu erfüllen. Aber je nach verwendeter Dokumentenklasse bzw.~Pakete sollten Sie sich - auf nicht"=funktionierende Features oder gar Fehlermeldungen einstellen. + auf Fehlfunktionen oder Fehlermeldungen einstellen. Also bitte die Daumen gedrückt halten! - \par\See{\Ref{classes}} + \par\See{\Ref{compatibility}} \Message |Hyperref support is turned off because hyperref has|\\ |stopped early.| \Description - Wenn das \package{hyperref}"=Paket seinen Dienst einstellt (den Grund hierfür - teilt es Ihnen mit), ist auch die \package{hyperref}"=Unterstützung des - \package{caption}"=Paketes nicht verfügbar. Als Folge werden Sie einige - Warnungen des \package{hyperref}"=Paketes bekommen, ferner werden Hyperlinks + Wenn das \package{hyperref}"=Paket vorzeitig seinen Dienst einstellt + (den Grund hierfür teilt es Ihnen mit), ist auch die + \package{hyperref}"=Unterstützung des \package{caption}"=Paketes nicht + verfügbar. Als Folge werden Sie einige Warnungen des + \package{hyperref}"=Paketes bekommen, ferner werden Hyperlinks auf Abbildungen und Tabellen nicht funktionsfähig sein. - \par\See{\Ref{hyperref}} + \par\See{\Ref{hyperref}\,} \Message |Ignoring optional argument [|\meta{pos}|] of \setcapwidth.| \Description \Thispackage\ bemüht sich, so gut es kann, die \KOMAScript"=Befehle bzgl.~Tabellen und Abbildungen zu emulieren. Aber das optionale Argument - von |\setcapwidth| funktioniert (noch) nicht; wenn Sie es angeben, - wird diese Warnung ausgegeben. + von |\setcapwidth| funktioniert (noch) nicht; wenn Sie es dennoch angeben, + wird daher diese Warnung ausgegeben. \par\See{\Ref{KOMA}} \Message - |Internal Warning: |\meta{Warnungstext}|.| + |Internal Warning: |\meta{warning message}|.| \Description Diese Warnung sollten Sie niemals sehen; entweder verwenden Sie ein Paket, welches |figure| und/oder |table| in einer dem \package{caption}"=Paket - unbekannten Art \& Weise verändert, oder aber es ist ein Bug im + unbekannten Art \& Weise verändert, oder aber es ist ein Fehler im \package{caption}"=Paket. Bitte senden Sie mir einen Fehlerbericht diesbezüglich per E-Mail. Danke! \Message |\label before \caption ignored| \Description - Anders als bei nicht gleitenden Umgebungen wird bei den + Anders als bei den meisten nicht gleitenden Umgebungen wird bei den gleitenden Umgebungen die interne Referenz erst bei Anwendung des Befehls |\caption| erzeugt. Ein |\label| Befehl, der auf diese Abbildung - bzw.~Tabelle verweisen soll, muß daher entweder \emph{nach} |\caption| - oder innerhalb des Argumentes von |\caption| platziert werden. + bzw.~Tabelle verweisen soll, muß daher entweder \emph{nach} oder innerhalb + des Argumentes von |\caption| platziert werden. \Message |Option `|\meta{option}|' was not in list `|\meta{option list}|'.| \Description Wenn Sie versuchen, eine bestimmte Option aus einer Optionsliste zu - entfernen, zum Beispiel mit |\clearcaptionsetup[position]{table}|, + entfernen, zum Beispiel mit |\clear|\-|caption|\-|setup[po|\-|si|\-|tion]{table}|, und die angegebene Option kann nicht in der Liste gefunden werden, so erhalten Sie die obenstehende Warnung. Liegt dies nicht an einem Schreibfehler Ihrerseits und möchten Sie ferner - diese Warnung unterdrücken, so verwenden können Sie hierzu |\clearcaptionsetup*| - anstelle von |\clearcaptionsetup| verwenden. - \par\See{\Ref{commands}} + diese Warnung unterdrücken, so können Sie hierzu + |\clear|\-|caption|\-|setup*| anstelle von |\clear|\-|caption|\-|setup| + verwenden. + \par\See{\Ref{captionsetup}} \Message |Option list `|\meta{option list}|' undefined.| \Description Wenn Sie versuchen, eine bestimmte Option aus einer Optionsliste zu - entfernen, zum Beispiel mit |\clearcaptionsetup[format]{figure}|, + entfernen, zum Beispiel mit |\clear|\-|caption|\-|setup[for|\-|mat]{figure}|, und die angegebene Optionsliste ist (noch) nicht definiert, so erhalten Sie die obenstehende Warnung. Liegt dies nicht an einem Schreibfehler Ihrerseits und möchten Sie ferner - diese Warnung unterdrücken, so verwenden können Sie hierzu |\clearcaptionsetup*| - anstelle von |\clearcaptionsetup| verwenden. - \par\See{\Ref{commands}} + diese Warnung unterdrücken, so können Sie hierzu |\clear|\-|caption|\-|setup*| + anstelle von |\clear|\-|caption|\-|setup| verwenden. + \par\See{\Ref{captionsetup}} \iffalse \Message @@ -2359,10 +3998,10 @@ Option & Kurzbeschreibung & Abschnitt \\ |`ragged2e' package not loaded, therefore|\\ |substituting \raggedright for \RaggedRight.| \Description - Die Option |justification=|\xx|RaggedRight| ist nur dann voll funktionsfähig, + Die Option |justification=|\x|RaggedRight| ist nur dann voll funktionsfähig, wenn Sie das \package{ragged2e}"=Paket auf Ihrem \TeX"=System installiert haben. - Ist dies nicht der Fall, erhalten Sie diese Warnung und |justification=|\xx|RaggedRight| - wird im späteren Verlauf des Dokumentes wie |justification=|\xx|raggedright| + Ist dies nicht der Fall, erhalten Sie diese Warnung und |justification=|\x|RaggedRight| + wird im späteren Verlauf des Dokumentes wie |justification=|\x|raggedright| behandelt werden. \par\See{\Ref{justification}} @@ -2370,8 +4009,8 @@ Option & Kurzbeschreibung & Abschnitt \\ |Obsolete option `ignoreLTcapwidth' ignored.| \Description Die Option |ignoreLTcapwidth| des \package{caption2}"=Paketes wird nicht von - diesem Paket emuliert. In der Regel können Sie aber diese Option ohne Nebeneffekte - einfach entfernen. + diesem Paket emuliert. In der Regel können Sie aber diese Option einfach + ersatzlos entfernen. \par\See{\Ref{caption2} und \Ref{longtable}} \Message @@ -2382,52 +4021,54 @@ Option & Kurzbeschreibung & Abschnitt \\ wenn es tatsächlich benötigt wird. Um dies zu gewährleisten, sind zwei \LaTeX"=Läufe notwendig, daher können Sie beim ersten Durchlauf diese Warnung bekommen. - Im nächsten \LaTeX"=Lauf sollte also diese Warnung verschwunden sein. + Mit dem nächsten \LaTeX"=Lauf sollte also diese Warnung verschwunden sein. \par\See{\Ref{justification}} \Message |Reference on page |\meta{page no.}| undefined.| \Description Ist ein zweiseitiges Dokumentenlayout gewählt, benötigt \thispackage\ zwei - \LaTeX"=Läufe, um die Ränder richtig zuordnen zu können; + \LaTeX"=Läufe, um die Ränder korrekt zuordnen zu können; daher können Sie beim ersten Durchlauf diese Warnung bekommen. - Im nächsten \LaTeX"=Lauf sollte also diese Warnung verschwunden sein. + Mit dem nächsten \LaTeX"=Lauf sollte also diese Warnung verschwunden sein. \par\See{\Ref{margins}} \Message |The caption type was already set to `|\meta{type}|'.| \Description Diese Warnung informiert Sie über vermische \package{caption}"=Optionen. - Wenn Sie z.B.~ein |\captionof|\xx|{table}|\xx|{|\ldots|}| in einer |figure| - Umgebung verwenden, werden beide Optionensätze, sowohl derjenige für |figure| - (mittels |\captionsetup|\xx|[figure]|\xx|{|\ldots|}| angegeben) als auch - derjenige für |table| (mittels |\captionsetup|\xx|[table]|\xx|{|\ldots|}| - angegeben), angewandt. - \par\See{\Ref{commands}} + Wenn Sie z.B.~|\caption|\-|setup{type=|\x|table}| oder + |\caption|\-|of{table}{|\ldots|}| in einer |figure| Umgebung verwenden, + werden beide Optionssätze, sowohl derjenige für |figure| + (mit |\caption|\-|setup[figure]{|\ldots|}| angegeben) als auch + derjenige für |table| (mit |\caption|\-|setup[table]{|\ldots|}| angegeben), + angewandt. + {\small(Diese Warnung kann bei Bedarf durch Verwendung der Stern-Form + |\caption|\-|setup*{type=|\x\ldots|}| unterdrückt werden.)\par} + \par\See{\Ref{captionsetup}} \Message |The option `hypcap=true' will be ignored for this|\\ |particular \caption.| \Description \Thispackage\ hat keinen geeigneten Hyperlink"=Anker für diese Beschriftung - gefunden, daher hat es entschlossen, die Einstellung |hypcap=true| (die per + gefunden, daher hat es entschlossen, die Einstellung |hypcap=|\-|true| (die per Standard gesetzt ist) zu ignorieren. Als Folge werden Hyperlinks zu dieser Abbildung oder Tabelle (etwa über das - Abbildungsverzeichnis, oder selber mit |\ref| oder |\autoref| angelegt) + Abbildungsverzeichnis, oder selber mit |\ref| oder |\auto|\-|ref| angelegt) nicht auf den Beginn der Abbildung oder Tabelle verweisen, sondern stattdessen auf deren Beschriftung.\par - Dies kann z.B.~passieren, wenn eine Beschriftung mittels |\captionof| innerhalb - einer nicht-gleitenden Umgebung gesetzt wird, aber auch, wenn ein Sie ein Paket - in Ihrem Dokument verwenden, welches die Umgebungen |figure| oder |table| - umdefiniert hat, dieses Paket aber dem \package{caption}"=Paket unbekannt - ist.\par + Dies kann zum Beispiel passieren, wenn eine Beschriftung mit |\caption|\-|of| + innerhalb einer nicht-gleitenden Umgebung gesetzt wird, aber auch, wenn ein + Sie ein Paket in Ihrem Dokument verwenden, welches die Umgebungen |figure| + oder |table| umdefiniert hat, dieses Paket aber dem \package{caption}"=Paket + unbekannt ist.\par Ist dies für Sie ok, aber die Warnung stört Sie, können Sie sie - |\captionsetup{|\xx|hypcap=|\xx|false}| direkt vor dem betroffenen |\caption| - oder |\captionof| Befehl platzieren. - Ist dies hingegen nicht für Sie ok, können Sie versuchen, selber an geeigneter - Stelle einen Hyperlink"=Anker mit |\captionsetup{|\xx|type=|\xx\meta{Typ}|}| - zu setzen. - \par\See{\Ref{hyperref}} + |\caption|\-|setup{hyp|\-|cap=|\x|false}| direkt vor dem betroffenen |\caption| + oder |\caption|\-|of| Befehl platzieren. + Ist dies hingegen nicht für Sie ok, können Sie selber an geeigneter Stelle mit + |\caption|\-|setup{type=|\x\meta{float type}|}| einen Hyperlink"=Anker setzen. + \par\See{\Ref{hyperref}\,} \Message |Unsupported document class (or package) detected,|\\ @@ -2435,27 +4076,28 @@ Option & Kurzbeschreibung & Abschnitt \\ \Description Entweder ist die verwendete Dokumentenklasse dem \package{caption}"=Paket unbekannt, oder aber Sie haben ein Paket in Ihrem Dokument eingebunden, - welches ebenfalls das interne Makro |\@makecaption| (was für das Setzen - der Abbildungs- und Tabellenbeschriftungen zuständig ist) umdefiniert. + welches ebenfalls das interne Makro |\@make|\-|caption| (welches intern für + das Setzen der Abbildungs- und Tabellenbeschriftungen zuständig ist) + umdefiniert. Wie-auch-immer, \thispackage\ wird entweder das Design der Beschriftungen in einer ungewollten Art \& Weise verändern, oder aber es wird zu keinem geordneten Verhalten und/oder Fehlermeldungen kommen. Deswegen wird in diesem Falle die Verwendung des \package{caption}"=Paketes nicht empfohlen. - \par\See{\Ref{classes}} + \par\See{\Ref{classes} und \Ref{compatibility}} \Message |Unused \captionsetup[|\meta{type}|].| \Description - Es wurden Optionen mit |\captionsetup[|\meta{Typ}|]| definiert, die im Laufe - des Dokumentes aber nicht zur Anwendung gekommen sind. + Es wurden Optionen mit |\caption|\-|setup[|\meta{Typ}|]| definiert, die im + weiteren Verlauf des Dokumentes aber nicht zur Anwendung gekommen sind. Dies kann zum einen an einem Schreibfehler im Argument \meta{Typ} liegen, aber auch daran, daß ein dem \package{caption}"=Paket unbekanntes Paket - die Umgebungen |figure| und/oder |table| umdefiniert hat, oder auch einfach, - weil Sie die angegebene Umgebung gar nicht im späteren Verlauf Ihres Dokumentes - verwenden.\par - Möchten Sie diese Warnung unterdrücken, so verwenden Sie hierzu - |\caption|\x|setup*| anstelle von |\caption|\x|setup|. - \par\See{\Ref{commands}} + die Umgebungen |figure| und/oder |table| umdefiniert hat, oder auch einfach + daran, daß Sie die angegebene Umgebung gar nicht im späteren Verlauf Ihres + Dokumentes verwenden. + (Möchten Sie diese Warnung unterdrücken, so verwenden Sie + |\caption|\-|setup*| anstelle von |\caption|\-|setup|.) + \par\See{\Ref{captionsetup}} \Message |Usage of the |\meta{package}| package together with the|\\ @@ -2471,7 +4113,7 @@ Option & Kurzbeschreibung & Abschnitt \\ \end{Warnings} -\pagebreak[4] +\PageBreak \subsection{Fehlermeldungen} \begin{Warnings} @@ -2481,44 +4123,45 @@ Option & Kurzbeschreibung & Abschnitt \\ \Or |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 - als optionales Argument bei |\caption| bzw. |\captionof| mit angegeben + Beim Setzen von Beschriftungen, die etwas spezielles wie z.B.~eine Tabelle + enthalten, ist zu beachten, daß immer ein alternativer Listeneintrag als + optionales Argument bei |\caption| bzw. |\caption|\-|of| mit angegeben werden muß, auch wenn Ihr Dokument gar kein Abbildungs- oder Tabellenverzeichnis beeinhaltet. - \par\See{\Ref{commands}, \Ref{list} und \Ref{hyperref}\,} + \par\See{\Ref{caption}, \Ref{lists} und \Ref{hyperref}\,} \Message |\caption outside float.| \Description |\caption| ist (in der Regel) nur für die Anwendung in gleitenden Umgebungen wie |figure| oder |table|, oder für die Anwendung innerhalb - |longtable| konzipiert, ansonsten bekommen Sie obenstehende Fehlermeldung.\par - Um eine Beschriftung innerhalb einer anderen Umgebung zu setzen, verwenden Sie - bitte entweder die Kombination |\captionsetup{|\xx|type=|\xx\meta{type}|}| $+$ - |\caption|, oder aber |\captionof|. - \par\See{\Ref{commands}} + |long|\-|table| oder |wrap|\-|figure| konzipiert, ansonsten bekommen Sie + obenstehende Fehlermeldung. + Um eine Beschriftung innerhalb einer anderen Umgebung zu setzen, verwenden + Sie bitte entweder die Kombination |\caption|\-|setup{type=|\x\meta{type}|}| + $+$ |\caption|, oder aber |\caption|\-|of|. + \par\See{\Ref{caption}} \Message |\ContinuedFloat outside float.| \Description - |\ContinuedFloat| ist nur für die Anwendung innerhalb einer gleitenden - Umgebung wie |figure| oder |table| konzipiert. %oder auch |longtable| + |\Continued|\-|Float| ist nur für die Anwendung innerhalb einer gleitenden + Umgebung wie |figure| oder |table| konzipiert. %oder auch |long|\-|table| Für die Anwendung in einer Box, Gruppe oder nicht-gleitenden Umgebung bietet sich die Kombination - |\captionsetup{|\xx|type=|\xx\meta{Typ}|}| $+$ |\ContinuedFloat| an.\par - |\ContinuedFloat| innerhalb einer |longtable| funktioniert zwar (noch) - nicht, aber vielleicht ist die |longtable*| Umgebung, die eine longtable + |\caption|\-|setup{type=|\x\meta{type}|}| $+$ |\Continued|\-|Float| an.\par + |\Continued|\-|Float| innerhalb einer |long|\-|table| ist nicht möglich, + aber vielleicht ist die |longtable*| Umgebung, die eine longtable ohne Erhöhung des Tabellenzählers setzt, für Sie hilfreich. - \par\See{\Ref{commands} und \Ref{longtable}} + \par\See{\Ref{ContinuedFloat} und \Ref{longtable}} \Message |Continued `|\meta{type}|' after `|\meta{type}|'.| \Description - Z.Z.~ dürfen fortlaufende Abbildungen oder Tabellen nicht von anderen gleitenden - Umgebungen oder einer |longtable| unterbrochen werden, so ist z.B.~ eine Tabelle - zwischen einer Abbildung und einer (mit |\ContinuedFloat|) fortgesetzten Abbildung - nicht möglich. + Fortlaufende Abbildungen oder Tabellen dürfen nicht von anderen + gleitenden Umgebungen (oder einer |long|\-|table|) unterbrochen werden, + so ist z.B.~ eine Tabelle zwischen einer Abbildung und einer + (mit |\Continued|\-|Float|) fortgesetzten Abbildung nicht möglich. \par\See{\Ref{ContinuedFloat}} \Message @@ -2528,7 +4171,8 @@ Option & Kurzbeschreibung & Abschnitt \\ \Description Achten Sie bei der gleichzeitigen Verwendung der Pakete \package{wrapfig} und \package{float} unbedingt auf die richtige Ladereihenfolge und - Anwendung. + Anwendung; das \package{wrapfig}"=Paket sollte unmittelbar nach + dem \package{float}"=Paket geladen werden. \par\See{\Ref{wrapfig}} \Message @@ -2546,28 +4190,36 @@ Option & Kurzbeschreibung & Abschnitt \\ |`|\meta{date}|' of package |\meta{package}|, but only version|\\ |`|\meta{old-date}|' is available.| \Description - Das aktuelle \package{caption}"=Paket kann nicht mit einem solchen, + Das aktuelle \package{caption}"=Paket kann nicht mit einem solch veralteten Paket zusammen betrieben werden. Bitte aktualisieren Sie das betroffene Paket, zumindest auf die - benötigte Version. + angegebene Version. \Message - |Internal Error: |\meta{Fehlertext}|.| + |Internal Error: |\meta{error message}|.| \Description Diesen Fehler sollten Sie niemals sehen. Wenn doch, senden Sie mir bitte einen Fehlerbericht per E-Mail. \Message - |No float type '|\meta{Typ}|' defined.| + |No float type '|\meta{type}|' defined.| \Description - \TODO + Der in |\caption|\-|setup{type=|\x\meta{type}|}|, + |\caption|\-|of|\marg{type}, oder |\Declare|\-|Caption|\-|Sub|\-|Type| + angegebene \meta{type} ist unbekannt. + \meta{type} sollte entweder `\texttt{figure}' oder `\texttt{table}', oder + aber eine mit mit |\Declare|\-|Caption|\-|Type|, |\new|\-|float| + (vom \package{float}"=Paket\cite{float} bereitgestellt) + oder |\Declare|\-|NewFloat|\-|Type| + (vom \package{floatrow}"=Paket\cite{floatrow} bereitgestellt) + definierte Gleitumgebung sein. \Message |Not allowed in longtable* environment.| \Description - Der Befehl |\caption| ist nicht immerhalb einer |longtable*| Umgebung - erlaubt. Verwenden sie entweder |\caption*| für eine Beschriftung ohne - Bezeichner oder benutzen Sie die reguläre |longtable| Umgebung. + Der Befehl |\caption| ist immerhalb 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 |Not available in compatibility mode.| @@ -2582,7 +4234,8 @@ Option & Kurzbeschreibung & Abschnitt \\ |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. + Paket zur Verfügung stellt, kann nur eine einzige Bildbeschriftung gesetzt + werden. \Message |Option clash for package caption.| @@ -2593,21 +4246,22 @@ Option & Kurzbeschreibung & Abschnitt \\ 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. + 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=|\-|false| angeben. \par\See{Dokumentation des \package{subfig}"=Paketes\cite{subfig}} \Message - |Runaway argument?|\\ |Paragraph ended before \caption@makecurrent was complete.| +\Or + |Paragraph ended before \caption@prepareanchor was complete.| \Description Beim Setzen von Beschriftungen, die mehr als aus einem Absatz bestehen, ist zu beachten, daß immer ein alternativer Listeneintrag als optionales - Argument bei |\caption| bzw. |\captionof| mit angegeben werden muß, + Argument bei |\caption| bzw. |\caption|\-|of| mit angegeben werden muß, auch wenn Ihr Dokument gar kein Abbildungs- oder Tabellenverzeichnis beeinhaltet. - \par\See{\Ref{commands}, \Ref{list} und \Ref{hyperref}\,} + \par\See{\Ref{caption}, \Ref{lists} und \Ref{hyperref}\,} \iffalse % was removed in v3.1b \Message @@ -2618,20 +4272,22 @@ Option & Kurzbeschreibung & Abschnitt \\ \Description Achten Sie bei der gleichzeitigen Verwendung der Pakete \package{wrapfig} und \package{float} unbedingt auf die richtige Ladereihenfolge und - Anwendung. Aber vielleicht hat auch ein anderes Paket das + Anwendung; das \package{wrapfig}"=Paket sollte unmittelbar nach + dem \package{float}"=Paket geladen werden. + Aber vielleicht hat auch ein anderes Paket das \package{float}"=Paket in einer für \thispackage\ inkompatiblen Art \& Weise erweitert!? \par\See{\Ref{float} und \Ref{wrapfig}} \fi -\iffalse \Message |Something's wrong--perhaps a missing \caption|\\ |in the last figure or table.| \Description - It seems that you have used a |\subcaption| command without a - corresponding |\caption| command. This is not supported. -\fi + Sie scheinen den Befehl |\sub|\-|caption| (oder einen anderen, + der eine Unter"=Beschriftung setzt) ohne eine zugehörige, + mit |\caption| gesetzte, Beschriftung anzuwenden. + Dies wird nicht unterstützt. \Message |The option `labelsep=|\meta{name}|' does not work|\\ @@ -2641,19 +4297,19 @@ Option & Kurzbeschreibung & Abschnitt \\ |with \setcaphanging (which is set by default).| \Description 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|). + |labelsep=|\x|newline|), kann nicht mit einem Format kombiniert werden, + welches "`hängende"' Beschriftungen liefert (wie etwa |format=|\x|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}} + z.B.~|labelsep=|\x|colon|), oder aber ein anderes Beschriftungsformat + (wie z.B.~|format=|\x|plain|) aus. + \par\See{\Ref{formats} bzw.~\Ref{KOMA}} \Message |The package option `caption=false' is obsolete.|\\ |Please pass this option to the subfig package instead|\\ |and do *not* load the caption package anymore.| \Description - Sie haben die Option |caption=false| angegeben. Diese war früher mal eine + Sie haben die Option |caption=|\-|false| angegeben. Diese war früher mal eine Krücke, um nicht das komplette \package{caption}"=Paket zu laden, sondern nur den für das \package{subfig}"=Paket zwingend benötigten Teil. Dieser Mechanismus ist veraltet und wird nicht mehr angeboten; stattdessen @@ -2694,7 +4350,7 @@ Option & Kurzbeschreibung & Abschnitt \\ \Description Es wurde versucht, ein Listenformat auszuwählen, welches nicht definiert ist. Vielleicht ein Schreibfehler!? - \par\See{\Ref{list}} + \par\See{\Ref{lists}} \Message |Undefined position `|\meta{name}|'.| @@ -2746,87 +4402,488 @@ Option & Kurzbeschreibung & Abschnitt \\ % --------------------------------------------------------------------------- % -\pagebreak[4] -\section{Weiterf"uhrende Dokumente} +\clearpage +\section{Versionshistorie} +\label{history} + +Die Version $1.0$ dieses Paketes wurde im Jahr 1994 veröffentlicht und bot +eine Handvoll Optionen, um das Design der Abbildungs- +bzw.~Tabellenbeschriftungen anzupassen. +Ferner unterstützte diese Version bereits das \package{rotating} und +\package{subfigure}"=Paket. +Version $1.1$ führte die |center|\-|last| Option ein; +in Version $1.2$ kam die Unterstützung des \package{float}"=Paketes hinzu. +Die Version $1.3$ verfeinerte die Koorperation mit dem +\package{subfigure}"=Paket; die Version $1.4$ bot die Option |nooneline| +als Neuheit an. + +Die Version $2.0$ des sog.~\package{caption2}"=Paketes war ein +experimenteller Seitenzweig der regulären Version des +\package{caption}"=Paketes. Er wurde im Jahre 1995 als Beta"=Testversion +öffentlich gemacht, um die Nachfrage nach neuen Features und der +Anpassung an das \package{longtable}"=Paket kurzfristig zu befriedigen. +(Eine Version $2.1$ wurde 2002 als Fehlerbereinigung nachgereicht.) + +Im Jahr 2003 hatte ich dann endlich wieder etwas Zeit gefunden, und so +wurde im Dezember die neue reguläre Version $3.0$ in Zusammenarbeit mit +Frank Mittelbach und Steven Cochran aus der Taufe gehoben, die endlich +den arg vernachlässigten Seitenzweig namens \package{caption2} +überflüssig machte. +Weite Teile des Paketes wurden hierfür neu geschrieben, und auch das +Benutzerinterface wurde gründlich renoviert. +Außerdem kam die Unterstützung der Pakete \package{hyperref}, +\package{hypcap}, \package{listings}, \package{sidecap} und +\package{supertabular} hinzu. + +Während all die vorangegangenen Versionen dafür ausgelegt waren, mit +den \LaTeX"=Standarddokumentenklassen \class{article}, \class{report} und +\class{book} benutzt zu werden, unterstützt die im Jahre 2007 +veröffentlichte Version $3.1$ auch die \AmS, die \KOMAScript, \NTG{} und +\SmF{} Dokumentenklassen, ferner auch die \class{beamer}"=Klasse. +Weiterhin kamen die Unterstützung der französischen Babel"=Option +\package{frenchb} und des französischen Sprachpaketes \package{frenchle} +bzw.~\package{frenchpro} hinzu; +außerdem wurde die Anzahl der unterstützten Pakete um die Pakete +\package{floatflt}, \package{fltpage}, \package{picinpar}, +\package{picins}, \package{setspace}, \package{threeparttable} +und \package{wrapfig} erhöht. +Neue Optionen und Befehle wurden ebenfalls eingeführt, unter anderem +|font+|, |figure|\-|within| \& |table|\-|within|, +|list| \& |list|\-|format|, |max|\-|margin| \& |min|\-|margin|, +|\caption|\-|list|\-|entry|, |\Declare|\-|Caption|\-|List|\-|Format| und +|\Declare|\-|Caption|\-|Type|. +Einen weiteren Gewinn stellt der neu integrierte Kompatibilitätscheck +\see*{\Ref{compatibility}}, das neue "`hypcap"' Feature +\see*{\Ref{hyperref}\,}, und die Unterstützung von Teil"=Beschriftungen +\see*{\package{subcaption}"=Paketdokumentation} dar. -Folgende, im Internet verfügbare Dokumente m"ochte ich an dieser Stelle -jedem ans Herz legen: +% --------------------------------------------------------------------------- % -\begin{itemize} -\item - Die \TeX\ FAQ -- "`Frequently Asked Questions"' über \TeX\ und \LaTeX: - \begin{quote}\url{http://faq.tug.org/}\end{quote} +\clearpage +\section{Kompatibilität zu älteren Versionen} + +\subsection{caption v\texorpdfstring{$1.x$}{1.x}} +\label{caption1} + +Diese Version des \thispackage"=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 +Optionen bzw.~Befehlen zu unerwünschten Nebeneffekten führen kann. + +Hier eine kurze Übersicht über die alten, überholten Optionen und ihre +aktuellen Entsprechungen: + +\begin{center}\small +\begin{tabular}{ll} +\package{caption} \version{1.x} & \package{caption} \version{3.x}\\ +\hline +%\endhead +|normal| & |format=plain|\\ +|hang| & |format=hang|\\ +|isu| & |format=hang|\\ +|center| & |justification=centering|\\ +|centerlast| & |justification=centerlast|\\ +%|anne| & |justification=centerlast|\\ +|nooneline| & |singlelinecheck=off|\\ +|scriptsize| & |font=scriptsize|\\ +|footnotesize| & |font=footnotesize|\\ +|small| & |font=small|\\ +|normalsize| & |font=normalsize|\\ +|large| & |font=large|\\ +|Large| & |font=Large|\\ +|up| & |labelfont=up|\\ +|it| & |labelfont=it|\\ +|sl| & |labelfont=sl|\\ +|sc| & |labelfont=sc|\\ +|md| & |labelfont=md|\\ +|bf| & |labelfont=bf|\\ +|rm| & |labelfont=rm|\\ +|sf| & |labelfont=sf|\\ +|tt| & |labelfont=tt|\\ +\end{tabular} +\end{center} + +Neben den Optionen zum Einstellen des Zeichensatzes gab es auch die Befehle +|\caption|\-|size| bzw.~|\caption|\-|font| und |\caption|\-|label|\-|font|, +die direkt mit |\re|\-|new|\-|command| umdefiniert werden konnten. +Dieser Mechanismus wurde durch die Anweisungen +\begin{quote} + |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad und\\ + |\captionsetup{font=|\ldots|,labelfont=|\ldots|}| +\end{quote} +ersetzt. \SeeUserDefined + +Das Setzen eines Randes geschah in \version{1.x} mit +\begin{quote} + |\setlength{\captionmargin}{|\ldots|}|\quad. +\end{quote} +Dies wurde durch +\begin{quote} + |\captionsetup{margin=|\ldots|}| +\end{quote} +ersetzt. +\See{\Ref{margins}} + +Zum Beispiel wäre +\begin{quote} + |\usepackage[hang,bf]{caption}|\\ + |\renewcommand\captionfont{\small\sffamily}|\\ + |\setlength\captionmargin{10pt}| +\end{quote} +in aktueller Notation +\begin{quote} + |\usepackage[format=hang,labelfont=bf,font={small,sf},|\\ + | margin=10pt]{caption}| +\end{quote} +bzw. +\begin{quote} + |\usepackage{caption}|\\ + |\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\ + | margin=10pt}|\quad. +\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|, +der durch das \package{float}"=Paket zur Verfügung gestellt wird, +verändern, so ist dies nun durch +\begin{quote} + |\DeclareCaptionStyle{ruled}{|\ldots|}| +\end{quote} +bzw. +\begin{quote} + |\captionsetup[ruled]{|\ldots|}| +\end{quote} +möglich. +\SeeUserDefined[, \Ref{captionsetup} und \Ref{float}] + +\subsection{caption2 v\texorpdfstring{$2.x$}{2.x}} +\label{caption2} + +Das Paket \package{caption} und seine experimentelle, nun veraltete +Variante \package{caption2} sind vom internen Konzept +her zu unterschiedlich, um hier eine vollständige Kompatibilität +gewährleisten zu können. +Daher liegt diesem Paket weiterhin die Datei |caption2.sty| bei, so daß +ältere Dokumente, die das \package{caption2}"=Paket verwenden, weiterhin +übersetzt werden können. + +Neue Dokumente sollten jedoch auf dem aktuellen \package{caption}"=Paket +aufgesetzt werden. In den meisten Fällen ist es hierfür ausreichend, +einfach die Anweisung +\begin{quote} + |\usepackage[...]{caption2}| +\end{quote} +durch +\begin{quote} + |\usepackage[...]{caption}| +\end{quote} +zu ersetzen. Einige Optionen und Befehle werden jedoch nicht emuliert, +so daß Sie anschließend Fehlermeldungen erhalten können. +Die folgenden Absätze werden Ihnen jedoch bei der Umsetzung dieser +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: + +\begin{center}\small +\begin{tabular}{ll} +\package{caption2} \version{2.x} & \package{caption} \version{3.x}\\ +\hline +%\endhead +|flushleft| & |justification=raggedright|\\ +|flushright| & |justification=raggedleft|\\ +|oneline| & |singlelinecheck=on|\\ +\end{tabular} +\end{center} + +Das Setzen eines Randes geschah in \version{2.x} mit +\begin{quote}\leavevmode\hbox{% + |\setcaptionmargin{|\ldots|}| bzw. + |\setcaptionwidth{|\ldots|}|\quad. +}\end{quote} +Dies wurde durch +\begin{quote}\leavevmode\hbox{% + |\captionsetup{margin=|\ldots|}| bzw. + |\captionsetup{width=|\ldots|}| +}\end{quote} +ersetzt. \See{\Ref{margins}} + +Das Setzen des Einzuges wurde in \version{2.x} mit +\begin{quote} + |\captionstyle{indent}|\\ + |\setlength\captionindent{|\ldots|}| +\end{quote} +\pagebreak[3] +erledigt, dies geschieht nun stattdessen mit +\nopagebreak[3] +\begin{quote} + |\captionsetup{format=plain,indention=|\ldots|}|\quad. +\end{quote} + +Die Sonderbehandlung von einzeiligen Beschriftungen ließ sich in +\version{2.x} mit |\oneline|\-|captions|\-|false| aus- +bzw.~|\oneline|\-|captions|\-|true| wieder einschalten. +Dies wurde durch +|\caption|\-|setup{|\x|single|\-|line|\-|check=|\x|off}| +bzw. +|\caption|\-|setup{|\x|single|\-|line|\-|check=|\x|on}| +ersetzt. \See{\Ref{justification}} + +Die Befehle +\begin{quote} + |\captionlabeldelim|, |\captionlabelsep|, |\captionstyle|,\\ + |\defcaptionstyle|, |\newcaptionstyle| und |\renewcaptionstyle| +\end{quote} +haben keine direkte Entsprechnung und werden daher durch diese +Version des \package{caption}"=Paketes auch nicht emuliert. +Sie führen also bei der Verwendung zu Fehlermeldungen und müssen daher +zwingend umgesetzt werden. Die Umsetzung ist von Fall zu Fall verschieden, +lesen Sie sich daher bitte diese Anleitung gründlich durch und suchen Sie +sich die Optionen bzw.~Befehle als Ersatz heraus, die Ihren Bedürfnissen +entsprechen. \iffalse -\item - Die DANTE-FAQ -- Oft gestellte Fragen \& deren Antworten: - \begin{quote}\url{http://www.dante.de/faq/de-tex-faq/}\end{quote} +Als kleine Hilfestellung hier die Beispiele aus der alten Anleitung zum +\package{caption2}"=Paket und deren Umsetzung: + +\newenvironment{OldNew}% + {\begin{minipage}\linewidth + \def\Old{Alt:\begin{quote}}% + \def\New{\end{quote}Neu:\begin{quote}}% + \def\Or{\end{quote}\centerline{-- oder --}\begin{quote}}% + }% + {\end{quote}\end{minipage}} + +\begin{OldNew} +\Old + |\captionstyle{center}| +\New + |\captionsetup{justification=centering}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\captionstyle{indent}|\\ + |\setlength{\captionindent}{1cm}| +\New + |\captionsetup{format=plain,indention=1cm}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcommand\captionfont{\small}|\\ + |\renewcommand\captionlabelfont{\itshape}| +\New + |\captionsetup{font=small,labelfont=it}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcommand\captionfont{\small\itshape}|\\ + |\renewcommand\captionlabelfont{\upshape}| +\New + |\captionsetup{font=small,textfont=it}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\setcaptionwidth{.5\textwidth}| +\New + |\captionsetup{width=.5\textwidth}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\setcaptionmargin{.25\textwidth}| +\New + |\captionsetup{margin=.25\textwidth}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{absatz}{\captionlabel: \exampletext\par}|\\ + |\captionstyle{absatz}| +\New + |\DeclareCaptionFormat{absatz}{#1: #3\par}|\\ + |\captionsetup{format=absatz,singlelinecheck=off}| +\Or + |\captionsetup{format=plain,singlelinecheck=off}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy}{\textsf{\captionlabel}\\\exampletext\par}|\\ + |\captionstyle{fancy}| +\New + |\DeclareCaptionFormat{fancy}{\textsf{#1}\\#3\par}|\\ + |\captionsetup{format=fancy,singlelinecheck=off}| +\Or + |\captionsetup{format=plain,labelfont=sf,labelsep=newline}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy2}{\exampletext\hfill\textit{(\captionlabel)}}|\\ + |\captionstyle{fancy2}| +\New + |\DeclareCaptionFormat{fancy2}{#3\hfill\textit{(#1)}}|\\ + |\captionsetup{format=fancy2,singlelinecheck=off}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{mystyle}{%|\\ + | \normalcaptionparams|\\ + | \renewcommand\captionlabelfont{\bfseries}%|\\ + | \renewcommand\captionlabeldelim{.}%|\\ + | \onelinecaptionsfalse|\\ + | \usecaptionstyle{centerlast}}|\\ + |\captionstyle{mystyle}| +\New + |\DeclareCaptionStyle{mystyle}{labelfont=bf,labelsep=period,justification=centerlast}|\\ + |\captionsetup{style=mystyle}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{hangandleft}{%|\\ + | \let\oldcaptiontext\exampletext|\\ + | \def\exampletext{\raggedright\oldcaptiontext}%|\\ + | \usecaptionstyle{hang}}|\\ + |\captionstyle{hangandleft}| +\New + |\captionsetup{format=hang,justification=raggedright}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy}{%|\\ + | \usecaptionmargin\captionfont|\\ + | \onelinecaption|\\ + | {{\captionlabelfont\captionlabel\captionlabeldelim}%|\\ + | \captionlabelsep\exampletext}%|\\ + | {{\centering\captionlabelfont\captionlabel\par}%|\\ + | \centerlast\exampletext\par}}|\\ + |\captionstyle{fancy}| +\New + |\DeclareCaptionFormat{fancy}{\centering#1\par\centerlast#3\par}|\\ + |\DeclareCaptionStyle{fancy}|\\ + | [format=plain,justification=centering]|\\ + | {format=fancy}|\\ + |\captionsetup{style=fancy}| +\Or + |\DeclareCaptionFormat{fancy}{#1\par#3\par}|\\ + |\DeclareCaptionStyle{fancy}|\\ + | [format=plain,justification=centering]|\\ + | {format=fancy,justification=centerlast}|\\ + |\captionsetup{style=fancy}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcaptionstyle{longtable}{\usecaptionstyle{normal}}| +\New + |\captionsetup[longtable]{format=plain}| +\end{OldNew} \fi -\item - \emph{"`Hilfe für LaTeX-Einsteiger"'} von Christian Faulhammer: - \begin{quote}\url{http://www.minimalbeispiel.de/}\end{quote} +Ebenfalls keine Entsprechung hat die Option |ignore|\-|LT|\-|cap|\-|width| +der \version{2.x}. +Deren Verwendung kann in der Regel einfach entfallen, da \thispackage\ den +Wert von |\LT|\-|cap|\-|width| sowieso nicht beachtet, solange er nicht +explizit auf einen anderen Wert als den Standardwert ($=$|4in|) gesetzt wird. +\See{\Ref{longtable}} -\item - \emph{"`Gleitobjekte -- die richtige Schmierung"'} von Axel Reichert - erl"autert den Umgang mit gleitenden Umgebungen und ist hier im Netz - zu finden: - \begin{quote} - \url{ftp://dante.ctan.org/pub/tex/info/german/gleitobjekte/} - \end{quote} +\subsection{caption v\texorpdfstring{$3.0$}{3.0}} +\label{caption3} -\item - \emph{"`Bilder einfügen in \LaTeX: Ein How-To"'} von Dominik Bischoff - beinhaltet die häufigsten Fragen und Antworten, die im Zusammenhang - mit \LaTeX\ und Abbildungen auftreten: - \begin{quote} - \url{http://tug.ctan.org/info/l2picfaq/german/l2picfaq.pdf} - \end{quote} +%\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}. +Daher waren die Vorbelegungen der Einstellungsmöglichkeiten fest durch +dieses Paket vorgegeben, sie repräsentierten das Aussehen bei Verwendung +einer dieser Klassen. +Nun aber unterstützt \thispackage\ mehr Dokumentenklassen aktiv, folglich +kann die Vorbelegung nun von der verwendeten Dokumentenklasse abhängen. -\item - \textsf{epslatex} von Keith Reckdahl enth"alt viele n"utzliche Tips im - Zusammenhang mit der Einbindung von Graphiken in \LaTeXe. - Das Dokument ist in Englisch und unter - \begin{quote}\url{ftp://dante.ctan.org/pub/tex/info/epslatex/}\end{quote} - zu finden. -\end{itemize} +Ein Beispiel: Während in \version{3.0} die Vorbelegung der Ausrichtung +immer |jus|\-|ti|\-|fi|\-|ca|\-|tion=|\x|jus|\-|ti|\-|fied| war, +ist sie nun immer noch |jus|\-|ti|\-|fied| wenn eine der drei Standardklassen +verwendet wird, aber |jus|\-|ti|\-|fi|\-|ca|\-|tion=|\x|ragged|\-|right|, +wenn die \package{beamer}"=Klasse verwendet wird. -% --------------------------------------------------------------------------- % +Möchten sie weiterhin die "`alten"' Vorbelegungen, so können Sie die Option +|style=base| beim Laden des \package{caption}"=Paketes angeben oder später +mit |\caption|\-|setup{style=|\x|base}| den alten Grundzustand wieder +herstellen. -\pagebreak[2] -\section{Danksagungen} +Weiterhin prüft die aktuelle Version des \package{caption}"=Paketes automatisch +nach Inkompatibilitäten und gibt ggf.~ eine Warnung diesbezüglich 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 +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, +wenn Sie \thispackage\ trotz einer solchen Warnung einsetzen, die Abbildungs- +und Tabellenbeschriftungen bzgl.~ihres Aussehens genau im Auge behalten. -Von ganzem Herzen danke ich Katja Melzner, -Steven D. Cochran, Frank Mittelbach, Olga Lapko, -David Carlisle, Carsten Heinz und Keith Reckdahl. +\bigskip -Weiterhin m"ochte ich mich herzlich bei -Harald Harders, -Peter L\"offler, -Peng Yu, -Alexander Zimmermann, -Matthias Pospiech, -J\"urgen Wieferink, -Christoph Bartoschek, -Uwe St\"ohr, -Ralf Stubner, -Geoff Vallis, -Florian Keiler, -J"urgen G"obel, -Uwe Siart, -Sang-Heon Shim, -Henrik Lundell, -David Byers, -William Asquith, -Prof.~Dr.~Dirk Hoffmann, -Frank Martini -und -Danie Els -f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. +\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 +\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 +und laden Sie nicht mehr \thispackage. +%\par\See{\package{subfig}"=Paketdokumentation} +\end{Note*} % --------------------------------------------------------------------------- % -\pagebreak[4] +\iffalse +\TODO: subcaption-Anleitung +\fi + +% --------------------------------------------------------------------------- % + +\clearpage \begin{thebibliography}{99} \bibitem{TLC2} Frank Mittelbach und Michel Goossens:\\ @@ -2835,140 +4892,163 @@ f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. \bibitem{beamer} Till Tantau:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/}% + \href{http://dante.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{algorithms} + Rogério Brito:\\ + \href{http://dante.ctan.org/tex-archive/macros/latex/contrib/algorithms/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/algorithms/algorithms.pdf}% + {\emph{Algorithms}},\\ + June 2, 2006 + +\iffalse + \bibitem{algorithm2e} + Christophe Fiorio:\\ + \href{http://dante.ctan.org/tex-archive/macros/latex/contrib/algorithm2e/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/algorithm2e/algorithm2e.pdf}% + {\emph{algorithm2e.sty -- package for algorithms}},\\ + March 11, 2007 +\fi + \bibitem{float} Anselm Lingnau:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/float/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/}% + \href{http://dante.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}},\\ - 2007/08/24 + 2007/12/24 \bibitem{fltpage} Sebastian Gross:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/}% + \href{http://dante.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}},\\ November 12, 2007 \bibitem{hypcap} Heiko Oberdiek:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/listings/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/required/tools/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/}% + Joachim Bleser and 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 und Leonor Barroca:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}% + Sebastian Rahtz and 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}},\\ 1997/09/26 + \bibitem{setspace} + Erica M. S. Harris \& Geoffrey Tobin:\\ + \href{http://dante.ctan.org/tex-archive/macros/latex/contrib/setspace/}% +% \href{ftp://dante.ctan.org/tex-archive/macros/latex/contrib/setspace/}% + {\emph{LaTeX Document Package ``setspace''}},\\ + 1 December 2000 + \bibitem{sidecap} Rolf Niepraschk \& Hubert G\"a\ss lein:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/}% + Johannes Braams and 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}},\\ 2002/07/19 \bibitem{threeparttable} Donald Arseneau:\\ - \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/misc/}% + \href{http://dante.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{http://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/}% + \href{http://dante.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 |