diff options
author | Karl Berry <karl@freefriends.org> | 2006-05-31 16:48:45 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2006-05-31 16:48:45 +0000 |
commit | 5183558ea817194c76ec71a3c8310ae6f06f5a69 (patch) | |
tree | 93072135851a0cd8583735dc3807752e76c65f3b /Master/texmf-dist/doc/latex/caption/anleitung.tex | |
parent | 96d66bf64706ae450b1d2f7993ccfbff038c232d (diff) |
caption 3.0j
git-svn-id: svn://tug.org/texlive/trunk@1627 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/caption/anleitung.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/caption/anleitung.tex | 629 |
1 files changed, 522 insertions, 107 deletions
diff --git a/Master/texmf-dist/doc/latex/caption/anleitung.tex b/Master/texmf-dist/doc/latex/caption/anleitung.tex index ac41fbd6758..a18a2dcd358 100644 --- a/Master/texmf-dist/doc/latex/caption/anleitung.tex +++ b/Master/texmf-dist/doc/latex/caption/anleitung.tex @@ -1,7 +1,7 @@ %% %% This is file `anleitung.tex', %% -%% Copyright (C) 1994-2004 Axel Sommerfeldt (caption@sommerfeldt.net) +%% Copyright (C) 1994-2006 Axel Sommerfeldt (caption@sommerfee.de) %% %% -------------------------------------------------------------------------- %% @@ -33,9 +33,10 @@ \newcommand\NEWfeature{\NEW{Neues Feature}} \newcommand\NEWdescription{\NEW{Neue Beschreibung}} -\newcommand\NEW[2]{% - \hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft - #1\\#2}} +\newcommand\NEW[2]{\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}} + +\font\manual=manfnt +\newcommand\DANGER{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{\manual\char127}}}} %%%\usepackage[T1]{fontenc} \ifx\pdfoutput\undefined\else @@ -47,12 +48,23 @@ \fi \usepackage[german]{babel} +\usepackage{color,setspace} -\usepackage{caption}[2004/11/28] %\usepackage{float} -\usepackage{longtable,hyperref} +\usepackage{longtable} %\usepackage[raggedright]{sidecap} +\usepackage{caption}[2005/08/24] +\DeclareCaptionLabelSeparator{endash}{\space\textendash\space} +\usepackage{hyperref} + +\DeclareCaptionFont{singlespacing}{\singlespacing} +\DeclareCaptionFont{onehalfspacing}{\onehalfspacing} +\DeclareCaptionFont{doublespacing}{\doublespacing} +\DeclareCaptionFont{red}{\color{red}} +\DeclareCaptionFont{green}{\color{green}} +\DeclareCaptionFont{blue}{\color{blue}} + \DeclareCaptionLabelSeparator{period-newline}{. \\} \DeclareCaptionStyle{period-newline}[labelsep=period]{labelsep=period-newline} \DeclareCaptionStyle{period-newline2}[labelsep=period,justification=centering]{labelsep=period-newline} @@ -65,12 +77,14 @@ \DeclareRobustCommand{\KOMAScript}{\textsf{K\kern.05em O\kern.05em% M\kern.05em A\kern.1em-\kern.1em Script}} -\newcommand*{\purerm}[1]{{\upshape\mdseries\rmfamily #1}} -\newcommand*{\puresf}[1]{{\upshape\mdseries\sffamily #1}} -\newcommand*{\purett}[1]{{\upshape\mdseries\ttfamily #1}} +\newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}} +\newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}} +\newcommand*\purett[1]{{\upshape\mdseries\ttfamily #1}} \let\package\puresf\def\thispackage{\package{caption}} \let\env\purett \let\opt\purett +\newcommand*\version[1]{$v#1$} + \newenvironment{Options}[1]% {\list{}{\renewcommand{\makelabel}[1]{\texttt{##1}\hfil}% \settowidth{\labelwidth}{\texttt{#1\space}}% @@ -94,11 +108,10 @@ \title{Setzen von Abbildungs- und Tabellenbeschriftungen mit dem \thispackage-Paket\thanks{Dieses Paket hat die Versionsnummer \fileversion, zuletzt ge"andert am \filedate.}} -\author{Axel Sommerfeldt\\\href{mailto:caption@sommerfeldt.net}{\texttt{caption@sommerfeldt.net}}} -\date{26. Juni 2005} +\author{Axel Sommerfeldt\\\href{mailto:caption@sommerfee.de}{\texttt{caption@sommerfee.de}}} +\date{12. Januar 2006} \maketitle - \begin{abstract} Das \thispackage\ Paket bietet einem Mittel und Wege das Erscheinungsbild der Bildunterschriften und Tabellen"uberschriften den eigenen W"unschen @@ -109,13 +122,14 @@ aktuelle Version 3.0 dieses Paketes wurde die Benutzerschnittstelle zusammen mit Steven D. Cochran und Frank Mittelbach komplett "uberarbeitet.} \end{abstract} -%\tableofcontents +\tableofcontents \newcommand\figuretext{% Die auf die Rotationsfrequenz des Innenzylinders normierten Eigenfrequenzen der gefundenen Grundmoden der Taylor"=Str"omung f"ur \mbox{$\eta = 0.5$}. %\\ (Die azimutale Wellenzahl ist mit $m$ bezeichnet.)} +% --------------------------------------------------------------------------- % \section{Einleitung} @@ -131,12 +145,13 @@ zum Beispiel nett, wenn man den Text der Unterschrift etwas kleiner gestalten, extra R"ander festlegen oder den Zeichensatz des Bezeichners dem der Kapitel"uberschriften anpassen k"onnte. So in etwa: -\example{belowskip=\abovecaptionskip,size=small,margin=10pt,labelfont=bf}{\figuretext} +\example{belowskip=\abovecaptionskip,size=small,margin=10pt,labelfont=bf,labelsep=endash}{\figuretext} Mit Hilfe dieses Paketes k"onnen Sie dies leicht bewerkstelligen; es sind viele vorgegebene Parameter einstellbar, Sie k"onnen aber auch eigene Gestaltungsmerkmale einflie"sen lassen. +% --------------------------------------------------------------------------- % \pagebreak[4] \section{Verwendung des Paketes} @@ -191,9 +206,22 @@ beeintr"achtigt werden. (Der optionale Parameter \meta{Typ} wird in Abschnitt \ref{misc}: \textit{"`N"utzliches"'} behandelt.) +% --------------------------------------------------------------------------- % + +\pagebreak[4] \section{Beschreibung der Optionen} + \def\OptionLabel{RaggedRight} +\def\UserDefined{\ldots} +\makeatletter +\newcommand*\Section{\@ifstar{\@Section\relax}{\@Section{Abschnitt}}} +\newcommand*\@Section[3]{#1 \ref{#2}: \textit{"`#3"'}} +\makeatother +\newcommand*\See[1]{{\small (Siehe #1)}} +\newcommand*\SeeUserDefined[1][]{% + \See{\Section{declare}{Eigene Erweiterungen}#1}} +% --------------------------------------------------------------------------- % \subsection{Formatierung} @@ -207,20 +235,25 @@ Mittels der Option |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"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar:%\footnote{Es gibt +%hier wie auch bei vielen anderen Optionen die M"oglichkeit, auch eigene +%Formate, Zeichens"atze etc.\ zu definieren. Wie dies geht wird in Abschnitt +%\ref{declare}: \textit{"`Eigene Erweiterungen"'} dargelegt.} \begin{Options}{\OptionLabel} - \item[default] - Die Beschriftung wird als normaler Abschnitt gesetzt. - (Dies ist das Standardverhalten.) + \item[plain]\NEWdescription{v3.0h} + Die Beschriftung wird als gew"ohnlicher Abschnitt gesetzt. + (Dies ist z.Z.~das Standardverhalten, ab Version $3.1$ des + \package{caption} Paketes wird dies allerdings von der verwendeten + Dokumentenklasse abh"angen.) \item[hang] - Der Text wird so gesetzt, da"s er an dem Bezeichner "`h"angt"', d.h.~der Platz unter - dem Bezeichner und dem Trenner bleibt leer. + Der Text wird so gesetzt, da"s er an dem Bezeichner "`h"angt"', d.h.~der + Platz unter dem Bezeichner und dem Trenner bleibt leer. + + \item[\UserDefined] + Eigene Formate k"onnen mittels |\DeclareCaptionFormat| definiert werden. + \SeeUserDefined \end{Options} \begin{Example} @@ -233,7 +266,7 @@ Abschnitt \ref{declare}: \textit{"`Eigene Erweiterungen"'} dargelegt.} \end{Example} \DescribeMacro{indention=} -Bei beiden Formaten (\texttt{default} und \texttt{hang}) kann der Einzug der Beschriftung +Bei beiden Formaten (\texttt{plain} und \texttt{hang}) kann der Einzug der Beschriftung ab der zweiten Textzeile angepasst werden, dies geschieht mit Hilfe der Option \begin{quote} |indention=|\meta{Einzug}\quad, @@ -244,10 +277,10 @@ Drei Beispiele: \begin{Example} \begin{quote} - |format=default,indention=.5cm| + |format=plain,indention=.5cm| \end{quote} \captionsetup{aboveskip=0pt} - \example{format=default,indention=.5cm}{\figuretext} + \example{format=plain,indention=.5cm}{\figuretext} \end{Example} \begin{Example} @@ -258,7 +291,7 @@ Drei Beispiele: \example{format=hang,indention=-0.5cm}{\figuretext} \end{Example} -\pagebreak[3] +%\pagebreak[3] \DescribeMacro{labelformat=} Mittels der Option \nopagebreak[3] @@ -286,6 +319,10 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: \item[parens] Die Nummer des Bezeichners wird in runde Klammern gesetzt. + + \item[\UserDefined] + Eigene Formate k"onnen mittels |\DeclareCaptionLabelFormat| definiert werden. + \SeeUserDefined \end{Options} \begin{Example} @@ -312,7 +349,7 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: \item[colon] Der Trenner besteht aus einem Doppelpunkt und einem Leerzeichen. - (Dies ist das Standardverhalten.) + (Dies ist z.Z.~das Standardverhalten.) \item[period] Der Trenner besteht aus einem Punkt und einem Leerzeichen. @@ -325,9 +362,16 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: \item[newline] Als Trenner wird ein Zeilenumbruch verwendet. + + \item[endash]\NEWfeature{v3.0h} + Als Trenner wird ein Gedankenstrich verwendet. + + \item[\UserDefined] + Eigene Trenner k"onnen mittels |\DeclareCaptionLabelSeparator| definiert werden. + \SeeUserDefined \end{Options} -Zwei Beispiele: +Drei Beispiele: \begin{Example} \begin{quote} |labelsep=period| @@ -344,8 +388,18 @@ Zwei Beispiele: \example{labelsep=newline,singlelinecheck=false}{\figuretext} \end{Example} +\begin{Example} + \begin{quote} + |labelsep=endash| + \end{quote} + \captionsetup{aboveskip=0pt} + \example{labelsep=endash}{\figuretext} +\end{Example} + +% --------------------------------------------------------------------------- % \subsection{Textausrichtung} +\label{justification} \DescribeMacro{justification=} Mittels der Option @@ -358,7 +412,7 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: \begin{Options}{\OptionLabel} \item[justified] Der Text wird als Blocksatz gesetzt. - (Dies ist das Standardverhalten.) + (Dies ist z.Z.~das Standardverhalten.) \item[centering] Der Text wird zentriert gesetzt. @@ -389,6 +443,10 @@ F"ur \meta{Name} sind folgende M"oglichkeiten verf"ugbar: % \item[RaggedLeft] % Der Text wird rechtsb"undig mit Hilfe des \package{ragged2e}-Paketes gesetzt. + + \item[\UserDefined] + Eigene Ausrichtungen k"onnen mittels |\DeclareCaptionJustification| definiert werden. + \SeeUserDefined \end{Options} Einige Beispiele: @@ -435,9 +493,11 @@ zentriert werden, wenn sie lediglich aus einer einzigen Textzeile bestehen: % Eine lange Beschriftung, die gen"ugend Text enth"alt, um l"anger als % eine einzelne Zeile zu sein.} +\DANGER Diesen Mechanismus "ubernimmt das \thispackage-Paket und ignoriert damit -bei solch kurzen Beschriftungen die mittels der Option |justification=| -eingestellte Textausrichtung. Dieses Verhalten kann jedoch mit der Option +in der Regel bei solch kurzen Beschriftungen die mittels der Option +|justification=| eingestellte Textausrichtung. Dieses Verhalten kann +jedoch mit der Option \begin{quote} |singlelinecheck=|\meta{bool} \end{quote} @@ -458,6 +518,7 @@ Setzt man f"ur \meta{bool} hingegen |true|, |yes|, |on| oder |1| ein, so wird die automatische Zentrierung wieder eingeschaltet. (Standardm"a"sig ist sie eingeschaltet.) +% --------------------------------------------------------------------------- % \subsection{Zeichens"atze} @@ -498,6 +559,10 @@ 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[\UserDefined] + Eigene Zeichensatzoptionen k"onnen mittels |\DeclareCaptionFont| definiert werden. + \SeeUserDefined \end{Options} Wird lediglich eine einzelne Zeichensatzoption ausgew"ahlt, k"onnen die @@ -528,8 +593,10 @@ Beispiele: \example{font=small,labelfont=bf,textfont=it}{\figuretext} \end{Example} +% --------------------------------------------------------------------------- % \subsection{R"ander und Abs"atze} +\label{margins} \DescribeMacro{margin=} \DescribeMacro{width=} @@ -616,6 +683,7 @@ Abs"atzen zeigt sich jedoch der Unterschied: so da"s die Auswirkungen der Optionen deutlich werden.} \end{Example} +% --------------------------------------------------------------------------- % \subsection{Stile} \label{style} @@ -638,12 +706,17 @@ d.h.~die Angabe der Option \end{quote} entspricht den Optionen \begin{quote} - |format=default,labelformat=simple,labelsep=colon,|\\ - |justification=justified,font=default,labelfont=default,|\\ + |format=default,labelformat=default,labelsep=default,|\\ + |justification=default,font=default,labelfont=default,|\\ |textfont=default,margin=0pt,indention=0pt,parindent=0pt|\\ |hangindent=0pt,singlelinecheck=true| \end{quote} +Eigene Stile k"onnen mittels |\DeclareCaptionStyle| definiert werden. +\SeeUserDefined + + +% --------------------------------------------------------------------------- % \subsection{Abst"ande} @@ -734,8 +807,7 @@ und Beschriftung zur Anwendung kommt.) \DescribeMacro{tableposition=} Sinnvoll l"a"st sich diese Option insbesondere zusammen mit dem optionalen -Parameter bei |\captionsetup| anwenden (siehe auch Abschnitt -\ref{misc}: \textit{"`N"utzliches"'}): +Parameter bei |\captionsetup| anwenden: \See{auch \Section{misc}{N"utzliches}} \begin{quote} |\captionsetup[table]{position=top}| \end{quote} @@ -754,8 +826,9 @@ entspricht |\captionsetup[table]{position=top}| \end{quote} +% --------------------------------------------------------------------------- % -\pagebreak[3] +\pagebreak[4] \section{N"utzliches} \label{misc} @@ -801,7 +874,7 @@ und Tabellenbeschriftungen an. Ein Beispiel: | \begin{tabular}{cc}|\\ | A & B \\|\\ | C & D \\|\\ - | \end{longtable}|\\ + | \end{tabular}|\\ |\end{table}| \end{quote} @@ -876,8 +949,8 @@ ergibt als Ergebnis: \end{Example} \DescribeMacro{\captionsetup} -Den Befehl |\captionsetup| haben wir ja schon im Abschnitt -\ref{usage}: \textit{"`Verwendung des Paketes"'} kennengelernt, +Den Befehl |\captionsetup| haben wir ja schon im \Section{usage} +{Verwendung des Paketes} kennengelernt, uns dort allerdings die Bedeutung des optionalen Parameters \meta{Typ} aufgespart. %Dies soll nun nachgeholt werden: @@ -932,12 +1005,14 @@ Abbildungsunterschriften wieder aufheben: 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}"=Paket) +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] +\pagebreak[4] \section{Eigene Erweiterungen} \label{declare} @@ -953,11 +1028,11 @@ Eigene Formate k"onnen mit dem Befehl |\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 |default|, +und f"ur \#3 der Text eingesetzt. So ist z.B. das Standardformat |plain|, welches die Beschriftung als gew"ohnlichen Absatz formatiert, folgenderma"sen in |caption.sty| definiert: \begin{quote} - |\DeclareCaptionFormat{default}{#1#2#3\par}| + |\DeclareCaptionFormat{plain}{#1#2#3\par}| \end{quote} \DescribeMacro{\DeclareCaptionLabelFormat} @@ -1036,6 +1111,25 @@ definiert werden. So definiert z.B. das \thispackage"=Paket die Optionen |\DeclareCaptionFont{small}{\small}|\\ |\DeclareCaptionFont{bf}{\bfseries}| \end{quote} +Die Zeilenabst"ande lie"sen sich z.B.~"uber das \package{setspace}"=Paket +regeln:\NEWdescription{v3.0h} +\begin{quote} + |\usepackage{setspace}|\\ + |\DeclareCaptionFont{singlespacing}{\singlespacing}|\\ + |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\ + |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\ + |\captionsetup{font={onehalfspacing,small},labelfont=bf}| +\end{quote} +\example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}\figuretext +Ein Beispiel welches etwas Farbe ins Spiel bringt: +\begin{quote} + |\usepackage{color}|\\ + |\DeclareCaptionFont{red}{\color{red}}|\\ + |\DeclareCaptionFont{green}{\color{green}}|\\ + |\DeclareCaptionFont{blue}{\color{blue}}|\\ + |\captionsetup{labelfont=blue,textfont=green}| +\end{quote} +\example{labelfont=blue,textfont=green,singlelinecheck=off}\figuretext \DescribeMacro{\DeclareCaptionStyle} Zu guter letzt noch die Definition eigener Stile. Stile sind einfach eine @@ -1046,7 +1140,7 @@ werden k"onnen. Sie werden wie folgt definiert: |\DeclareCaptionStyle|\marg{Name}\oarg{zus"atzliche Optionen}\marg{Optionen} \end{quote} Hierbei ist zu beachten, da"s die \meta{Optionen} immer auf den Standardeinstellungen -basieren (siehe auch Abschnitt \ref{style}: \textit{"`Stile"'}), es brauchen +basieren (siehe auch \Section{style}{Stile}), es brauchen also nur davon abweichende Optionen angegeben werden. Sind \meta{zus"atzliche Optionen} angegeben, so kommen diese automatisch @@ -1058,6 +1152,7 @@ Als Beispiel mu"s mal wieder eine einfache Definition aus diesem Paket herhalten |\DeclareCaptionStyle{default}[justification=centering]{}| \end{quote} +% --------------------------------------------------------------------------- % \subsection{Beispiele} @@ -1109,7 +1204,7 @@ eine geeignete Definition: \caption[]{Eine Abbildung.} \end{Example} -Leicht abgewandelt ergibt sich auch bei l"angeren Beschriftungen eine Zentrierung: +Leicht abgewandelt w"urde sich auch bei l"angeren Beschriftungen eine Zentrierung ergeben: \begin{quote} |\DeclareCaptionStyle{period-newline}%|\\ | [labelsep=period]%|\\ @@ -1155,8 +1250,9 @@ Das Ergebnis w"aren Beschriftungen wie diese: \captionof{figure}[]{\figuretext} \end{Example} +% --------------------------------------------------------------------------- % -\pagebreak[3] +\pagebreak[4] \section{Verwendung mit speziellen Dokumentenklassen} \NEWdescription{v3.0d} @@ -1177,14 +1273,16 @@ der Dokumentenklassen wie |tablecaptionabove| und Befehle wie |\tableformat|, |\setcapindent|, |\setcaphanging|, |\captionstyle| usw.\ ihre Wirkung. -Das \thispackage="Paket sollte zwar auch mit anderen als den oben erw"ahnten +Das \thispackage"=Paket sollte zwar auch mit anderen als den oben erw"ahnten Dokumentenklassen zusammenarbeiten, ist jedoch nicht uneingeschr"ankt empfehlenswert, da es zu unerw"unschten Layout"="Anderungen, sonstigen Nebenwirkungen oder gar Fehlfunktionen kommen kann. (Zuk"unftige Versionen des \thispackage"=Paketes werden allerdings mehr Dokumentenklassen unterst"utzen als dies derzeit der Fall ist.) +% --------------------------------------------------------------------------- % +\pagebreak[4] \section{Interaktion mit anderen Paketen} \label{packages} @@ -1227,8 +1325,10 @@ nur innerhalb des |\usepackage|"=Befehls angegeben werden, also insbesondere N"ahere Informationen zu den einzelnen Paketen entnehmen Sie bitte der dazugeh"origen Anleitung oder dem \LaTeX-Begleiter\cite{companion}. +% --------------------------------------------------------------------------- % \subsection{Das \package{float}-Paket} +\label{float} Ein sehr n"utzliches Feature stellt das \package{float}"=Paket\cite{float} mit dem Platzierungsparameter |[H]| bereit: @@ -1325,8 +1425,10 @@ d.h.~auch bei Umgebungen des Types |plain|, |plaintop| und |boxed| kann ein geeigneter Beschriftungsstil mit gleichem Namen definiert werden, der dann automatisch bei gleitenden Umgebungen dieses Types zum Einsatz kommt. +% --------------------------------------------------------------------------- % \subsection{Das \package{listings}-Paket} +\label{listings} \NEWdescription{v3.0b} Das \package{listings}"=Paket\cite{listings} erlaubt die Einbindung von @@ -1335,22 +1437,31 @@ Quelltexten diverser Programmiersprachen. \textbf{Achtung:} Die Zusammenarbeit klappt erst ab der Version 1.2 des \package{listings}"=Paketes. "Altere Versionen verursachen eine Fehlermeldung! +% --------------------------------------------------------------------------- % \subsection{Das \package{longtable}-Paket} +\label{longtable} Das \package{longtable}"=Paket\cite{longtable} definiert die Umgebung |longtable|, die sich wie eine Tabelle anwenden l"a"st, aber im Gegensatz zu |tabular| Seitenumbr"uche innerhalb der Tabelle gestattet. +% TODO: \DANGER wg. Abstand zur \caption, der für Überschriften ausgelegt ist +% => "tableposition=b" +% --------------------------------------------------------------------------- % + \subsection{Das \package{rotating}-Paket} +\label{rotating} Das \package{rotating}"=Paket\cite{rotating} stellt u.a.~die gleitenden Umgebungen \texttt{sideways\-figure} und \texttt{sideways\-table} bereit, die im Gegensatz zu |figure| und |table| um 90 Grad gedreht werden und immer eine ganze Seite einnehmen. +% --------------------------------------------------------------------------- % \subsection{Das \package{sidecap}-Paket} +\label{sidecap} \NEWdescription{v3.0b} Das \package{sidecap}"=Paket\cite{sidecap} definiert die Umgebungen |SCfigure| @@ -1418,6 +1529,7 @@ geschehen. \fi +% --------------------------------------------------------------------------- % \subsection{Das \package{supertabular}-Paket} @@ -1430,6 +1542,7 @@ Eine ausf"uhrliche Behandlung der Unterschiede zwischen den beiden Paketen \package{longtable} und \package{supertabular} ist im Buch "`Der \LaTeX-Begleiter"' \cite{companion} zu finden. +% --------------------------------------------------------------------------- % \subsection{Bekannte Inkompatibilit"aten} @@ -1438,72 +1551,364 @@ Die Verwendung des \thispackage"=Paketes in Verbindung mit folgenden Paketen ist nicht empfehlenswert, da es zu unerw"unschten Seiteneffekten oder gar Fehlern kommen kann: \begin{quote} -\package{ccaption}, \package{hvfloat}, \package{nonfloat} + \package{ccaption}, \package{ftcap}, \package{hvfloat} und + \package{nonfloat} \end{quote} +% --------------------------------------------------------------------------- % +\pagebreak[4] \section{Kompatibilit"at zu "alteren Versionen} +\label{compatibility} -\subsection{\thispackage\ Version $1.x$} +\subsection{Das \package{caption}-Paket Version $1.x$} Diese Version des \thispackage"=Paketes ist weitgehend kompatibel zu "alteren -Versionen des Paketes; alte 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 nicht unterst"utzt wird -bzw.~zu unerw"unschten Nebeneffekten f"uhren kann. +Versionen des Paketes; alte, vorhandene Dokumente sollten sich also in der +Regel ohne Probleme weiterhin "ubersetzen lassen. (Sollten wider Erwarten +Probleme auftauchen, schreiben sie mir bitte eine E-Mail.) -Hier eine kurze "Ubersicht "uber die alten Optionen und Befehle und durch was -sie in dieser Version des \thispackage"=Paketes ersetzt wurden: +Jedoch ist zu beachten, da"s eine Mischung aus alten Befehlen und neueren +Optionen bzw.~Befehlen zu unerw"unschten Nebeneffekten f"uhren kann. -\begin{small}\begin{longtable}{ll} -\thispackage\ $1.\mathit{x}$ & \thispackage\ $3.\mathit{x}$\\ +Hier eine kurze "Ubersicht "uber die alten, "uberholten Optionen und ihre +aktuellen Entsprechungen: + +{\small\begin{longtable}{ll} +\package{caption} \version{1.x} & \thispackage\ \version{3.x}\\ \hline \endhead -|normal| & |format=default|\\ -|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|\\ -|\setlength{\captionmargin}| & |margin=|\meta{Rand}\\ -|\renewcommand{\captionfont}| & |\DeclareCaptionFont|\\ - & $+$ |\captionsetup{font=|\meta{Name}|}|\\ -|\renewcommand{\captionsize}| & |\DeclareCaptionFont|\\ - & $+$ |\captionsetup{font=|\meta{Name}|}|\\ -|\renewcommand{\captionlabelfont}| & |\DeclareCaptionLabelFont|\\ - & $+$ |\captionsetup{labelfont=|\meta{Name}|}|\\ -\end{longtable}\end{small} - - -\subsection{\package{caption2} Version $2.x$} - -Die Pakete \package{caption} und \package{caption2} sind vom internen Konzept -her zu unterschiedlich, um hier eine Kompatibilit"at gew"ahrleisten zu k"onnen. -Daher liegt diesem Paket weiterhin ein |caption2.sty| bei, so da"s "altere -Dokumente, die |caption2.sty| verwenden, weiterhin "ubersetzt werden k"onnen. +|normal| & |format=plain|\\ +|hang| & |format=hang|\\ +|isu| & |format=hang|\\ +|center| & |justification=centering|\\ +|centerlast| & |justification=centerlast|\\ +%|anne| & |justification=centerlast|\\ +|nooneline| & |singlelinecheck=off|\\ +|scriptsize| & |font=scriptsize|\\ +|footnotesize| & |font=footnotesize|\\ +|small| & |font=small|\\ +|normalsize| & |font=normalsize|\\ +|large| & |font=large|\\ +|Large| & |font=Large|\\ +|up| & |labelfont=up|\\ +|it| & |labelfont=it|\\ +|sl| & |labelfont=sl|\\ +|sc| & |labelfont=sc|\\ +|md| & |labelfont=md|\\ +|bf| & |labelfont=bf|\\ +|rm| & |labelfont=rm|\\ +|sf| & |labelfont=sf|\\ +|tt| & |labelfont=tt|\\ +\end{longtable}} + +Neben den Optionen zum Einstellen des Zeichensatzes gab es auch die Befehle +|\captionsize| bzw. |\captionfont| und |\captionlabelfont|, die direkt +mittels |\renewcommand| ver"andert werden konnten. Dieser Mechanismus +wurde durch die Anweisungen +\begin{quote} + |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad und\\ + |\captionsetup{font=|\ldots|,labelfont=|\ldots|}| +\end{quote} +ersetzt. \SeeUserDefined + +Das Setzen eines Randes geschah in \version{1.x} mittels +\begin{quote} + |\setlength{\captionmargin}{|\ldots|}|\quad. +\end{quote} +Dies wurde durch +\begin{quote} + |\captionsetup{margin=|\ldots|}| +\end{quote} +ersetzt. \See{\Section{margins}{R"ander und Abs"atze}} + +Zum Beispiel w"urde +\begin{quote} +|\usepackage[hang,bf]{caption}|\\ +|\renewcommand\captionfont{\small\sffamily}|\\ +|\setlength\captionmargin{10pt}| +\end{quote} +in aktueller Notation +\begin{quote} +|\usepackage[format=hang,labelfont=bf,font={small,sf},|\\ +| margin=10pt]{caption}| +\end{quote} +bzw. +\begin{quote} +|\usepackage{caption}|\\ +|\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\ +| margin=10pt}| +\end{quote} +hei"sen. + +Die etwas exotische Option |ruled|, die eine partielle Anwendung der +eingestellten Parameter bei gleitenden Umgebungen des Typs |ruled| +aktivierte, wird ebenfalls emuliert, hat aber keine direkte +Entsprechung in dieser Version des \thispackage"=Paketes. +M"ochte man gezielt das Aussehen der Abbildungen des Stils |ruled|, +der durch das \package{float}"=Paket zur Verf"ugung gestellt wird, +ver"andern, so ist dies nun durch +\begin{quote} + |\DeclareCaptionStyle{ruled}{|\ldots|}| +\end{quote} +bzw. +\begin{quote} + |\captionsetup[ruled]{|\ldots|}| +\end{quote} +m"oglich. \SeeUserDefined[ und \Section*{misc}{N"utzliches} sowie + \Section*{float}{Das \package{float}-Paket}] + +\subsection{Das \package{caption2}-Paket Version $2.x$} + +Die Pakete \package{caption} und seine experimentelle, nun veraltete +Variante \package{caption2} sind vom internen Konzept +her zu unterschiedlich, um hier eine vollst"andige Kompatibilit"at +gew"ahrleisten zu k"onnen. +Daher liegt diesem Paket weiterhin die Datei |caption2.sty| bei, so da"s +"altere Dokumente, die das \package{caption2}"=Paket verwenden, weiterhin +"ubersetzt werden k"onnen. + Neue Dokumente sollten jedoch auf dem aktuellen \thispackage"=Paket -aufgesetzt werden, wie es in diesem Dokument beschrieben ist. +aufgesetzt werden. In den meisten F"allen ist es ausreichend, einfach +ggf.~die Anweisung +\begin{quote} + |\usepackage[...]{caption2}| +\end{quote} +durch +\begin{quote} + |\usepackage[...]{caption}| +\end{quote} +zu ersetzen. Einige Optionen und Befehle werden jedoch nicht emuliert, +so da"s sie anschlie"send Fehlermeldungen erhalten k"onnen. +Die folgenden Abs"atze werden Ihnen jedoch bei der Umsetzung dieser +Optionen und Befehle helfen. Sollten dar"uberhinaus noch Fragen oder +Probleme auftreten, so z"ogern Sie bitte nicht, mich diesbez"uglich +per E-Mail zu kontaktieren. + +Zus"atzlich zu den bereits im vorherigen Abschnitt vorgestellten Optionen +werden auch folgende emuliert: + +{\small\begin{longtable}{ll} +\package{caption2} \version{2.x} & \thispackage\ \version{3.x}\\ +\hline +\endhead +|flushleft| & |justification=raggedright|\\ +|flushright| & |justification=raggedleft|\\ +|oneline| & |singlelinecheck=on|\\ +\end{longtable}} + +Das Setzen eines Randes geschah in \version{2.x} mittels +\begin{quote}\leavevmode\hbox{% + |\setcaptionmargin{|\ldots|}| bzw. + |\setcaptionwidth{|\ldots|}|\quad. +}\end{quote} +Dies wurde durch +\begin{quote}\leavevmode\hbox{% + |\captionsetup{margin=|\ldots|}| bzw. + |\captionsetup{width=|\ldots|}| +}\end{quote} +ersetzt. \See{\Section{margins}{R"ander und Abs"atze}} + +Die Sonderbehandlung von einzeiligen Beschriftungen lie"s sich in +\version{2.x} mit |\oneline|\-|captions|\-|false| aus- +bzw. |\oneline|\-|captions|\-|true| wieder einschalten. Dies wurde durch +|\captionsetup{|\discretionary{}{}{}|singlelinecheck=|\discretionary{}{}{}|off}| +bzw. +|\captionsetup{|\discretionary{}{}{}|singlelinecheck=|\discretionary{}{}{}|on}| +ersetzt. \See{\Section{justification}{Textausrichtung}} + +Die Befehle +\begin{quote} + |\captionstyle|, |\captionlabeldelim|, |\captionlabelsep|,\\ + |\captionindent|, |\captionlabelfalse|, |\defcaptionstyle|,\\ + |\newcaptionstyle| und |\renewcaptionstyle| +\end{quote} +haben keine direkte Entsprechnung und werden daher durch diese +Version des \thispackage"=Paketes auch nicht emuliert. +Sie f"uhren also bei der Verwendung %mit diesem \thispackage"=Paket +zu Fehlermeldungen und m"ussen daher zwingend umgesetzt werden. +Die Umsetzung ist von Fall zu Fall verschieden, lesen Sie sich daher bitte +diese Anleitung gr"undlich durch und suchen Sie sich die Optionen bzw.~Befehle +als Ersatz heraus, die Ihren W"unschen entsprechen. +\iffalse +Als kleine Hilfestellung hier die Beispiele aus der alten Anleitung zum +\package{caption2}"=Paket und deren Umsetzung: + +\newenvironment{OldNew}% + {\begin{minipage}\linewidth + \def\Old{Alt:\begin{quote}}% + \def\New{\end{quote}Neu:\begin{quote}}% + \def\Or{\end{quote}\centerline{-- oder --}\begin{quote}}% + }% + {\end{quote}\end{minipage}} + +\begin{OldNew} +\Old + |\captionstyle{center}| +\New + |\captionsetup{justification=centering}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\captionstyle{indent}|\\ + |\setlength{\captionindent}{1cm}| +\New + |\captionsetup{format=plain,indention=1cm}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcommand\captionfont{\small}|\\ + |\renewcommand\captionlabelfont{\itshape}| +\New + |\captionsetup{font=small,labelfont=it}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcommand\captionfont{\small\itshape}|\\ + |\renewcommand\captionlabelfont{\upshape}| +\New + |\captionsetup{font=small,textfont=it}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\setcaptionwidth{.5\textwidth}| +\New + |\captionsetup{width=.5\textwidth}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\setcaptionmargin{.25\textwidth}| +\New + |\captionsetup{margin=.25\textwidth}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{absatz}{\captionlabel: \captiontext\par}|\\ + |\captionstyle{absatz}| +\New + |\DeclareCaptionFormat{absatz}{#1: #3\par}|\\ + |\captionsetup{format=absatz,singlelinecheck=off}| +\Or + |\captionsetup{format=plain,singlelinecheck=off}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy}{\textsf{\captionlabel}\\\captiontext\par}|\\ + |\captionstyle{fancy}| +\New + |\DeclareCaptionFormat{fancy}{\textsf{#1}\\#3\par}|\\ + |\captionsetup{format=fancy,singlelinecheck=off}| +\Or + |\captionsetup{format=plain,labelfont=sf,labelsep=newline}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy2}{\captiontext\hfill\textit{(\captionlabel)}}|\\ + |\captionstyle{fancy2}| +\New + |\DeclareCaptionFormat{fancy2}{#3\hfill\textit{(#1)}}|\\ + |\captionsetup{format=fancy2,singlelinecheck=off}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{mystyle}{%|\\ + | \normalcaptionparams|\\ + | \renewcommand\captionlabelfont{\bfseries}%|\\ + | \renewcommand\captionlabeldelim{.}%|\\ + | \onelinecaptionsfalse|\\ + | \usecaptionstyle{centerlast}}|\\ + |\captionstyle{mystyle}| +\New + |\DeclareCaptionStyle{mystyle}{labelfont=bf,labelsep=period,justification=centerlast}|\\ + |\captionsetup{style=mystyle}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{hangandleft}{%|\\ + | \let\oldcaptiontext\captiontext|\\ + | \def\captiontext{\raggedright\oldcaptiontext}%|\\ + | \usecaptionstyle{hang}}|\\ + |\captionstyle{hangandleft}| +\New + |\captionsetup{format=hang,justification=raggedright}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\newcaptionstyle{fancy}{%|\\ + | \usecaptionmargin\captionfont|\\ + | \onelinecaption|\\ + | {{\captionlabelfont\captionlabel\captionlabeldelim}%|\\ + | \captionlabelsep\captiontext}%|\\ + | {{\centering\captionlabelfont\captionlabel\par}%|\\ + | \centerlast\captiontext\par}}|\\ + |\captionstyle{fancy}| +\New + |\DeclareCaptionFormat{fancy}{\centering#1\par\centerlast#3\par}|\\ + |\DeclareCaptionStyle{fancy}|\\ + | [format=plain,justification=centering]|\\ + | {format=fancy}|\\ + |\captionsetup{style=fancy}| +\Or + |\DeclareCaptionFormat{fancy}{#1\par#3\par}|\\ + |\DeclareCaptionStyle{fancy}|\\ + | [format=plain,justification=centering]|\\ + | {format=fancy,justification=centerlast}|\\ + |\captionsetup{style=fancy}| +\end{OldNew} + +\hrule + +\begin{OldNew} +\Old + |\renewcaptionstyle{longtable}{\usecaptionstyle{normal}}| +\New + |\captionsetup[longtable]{format=plain}| +\end{OldNew} +\fi -% TODO: "Ubersetzungstabelle wie beim Abschnitt "caption 1.x" +Ebenfalls keine Entsprechung hat die \version{2.x}"=Option |ignoreLTcapwidth|. +Deren Verwendung kann in der Regel einfach entfallen, da das +\thispackage"=Paket den Wert von |\LTcapwidth| sowieso nicht beachtet, +solange er nicht explizit auf einen anderen Wert als den Standardwert +gesetzt wird. +\See{\Section{longtable}{Das \package{longtable}"=Paket}} +% --------------------------------------------------------------------------- % -\pagebreak[3] +\pagebreak[4] \section{Weiterf"uhrende Dokumente} Folgende Dokumente m"ochte ich an dieser Stelle jedem ans Herz legen: @@ -1528,16 +1933,19 @@ Folgende Dokumente m"ochte ich an dieser Stelle jedem ans Herz legen: Zusammenhang mit der Einbindung von Graphiken in \LaTeXe. Das Dokument ist unter\nopagebreak \begin{quote} - \url{ftp://ftp.dante.de/pub/tex/info/} + \url{ftp://ftp.dante.de/pub/tex/info/epslatex/} \end{quote} - als \texttt{epslatex.ps} bzw. \texttt{epslatex.pdf} zu finden. + zu finden. \end{itemize} +% --------------------------------------------------------------------------- % +%\pagebreak[3] \section{Danksagungen} -Von ganzem Herzen danke ich Katja Melzner, Steven D. Cochran, Frank Mittelbach, -David Carlisle, Carsten Hinz und Olga Lapko. +Von ganzem Herzen danke ich Katja Melzner, +Steven D. Cochran, Frank Mittelbach, +David Carlisle, Carsten Hinz, Olga Lapko und Keith Reckdahl. Weiterhin m"ochte ich mich herzlich bei Harald Harders, @@ -1547,11 +1955,18 @@ Alexander Zimmermann, Matthias Pospiech, J\"urgen Wieferink, Christoph Bartoschek, -Uwe St\"ohr und -Ralf Stubner +Uwe St\"ohr, +Ralf Stubner, +Geoff Vallis, +Florian Keiler, +J"urgen G"obel +und +Uwe Siart f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. +% --------------------------------------------------------------------------- % +\pagebreak[4] \begin{thebibliography}{9} \bibitem{companion} Frank Mittelbach and Michel Goossens: @@ -1601,7 +2016,7 @@ f"ur ihre Hilfe beim stetigen Verbessern dieses Paketes bedanken. \bibitem{subfig} Steven D. Cochran: \emph{The subfig package}, - 2003/12/01 + 2005/07/05 \bibitem{supertabular} Johannes Braams und Theo Jurriens: |