summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/caption/caption2.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/caption/caption2.dtx')
-rw-r--r--Master/texmf-dist/source/latex/caption/caption2.dtx106
1 files changed, 42 insertions, 64 deletions
diff --git a/Master/texmf-dist/source/latex/caption/caption2.dtx b/Master/texmf-dist/source/latex/caption/caption2.dtx
index 7ec1096e361..2355c6826fb 100644
--- a/Master/texmf-dist/source/latex/caption/caption2.dtx
+++ b/Master/texmf-dist/source/latex/caption/caption2.dtx
@@ -2,7 +2,7 @@
%
% This is file `caption2.dtx'.
%
-% Copyright (C) 1994-2021 Axel Sommerfeldt (axel.sommerfeldt@f-m.fm)
+% Copyright (C) 1994-2023 Axel Sommerfeldt (axel.sommerfeldt@f-m.fm)
%
% --------------------------------------------------------------------------
%
@@ -36,24 +36,11 @@
% \iffalse
%<*driver>
\NeedsTeXFormat{LaTeX2e}[1994/12/01]
-\ProvidesFile{caption2.drv}[2007/11/28 v2.2 Documentated code of the (obsolete) caption2 package]
-\hbadness=9999 \newcount\hbadness \hfuzz=100pt % Make TeX shut up.
+\ProvidesFile{caption2.drv}[2023/07/10 v2.2 The (obsolete) caption2 package]
%\errorcontextlines=3
%
-\documentclass{ltxdoc}
-\setlength\parindent{0pt}
-\setlength\parskip{\smallskipamount}
-%
-\usepackage{ifpdf}
-\ifpdf
- \usepackage{mathptmx,courier}
- \usepackage[scaled=0.90]{helvet}
-% \addtolength\marginparwidth{15pt}
-\fi
-%
-\usepackage{hypdoc}
-\ifpdf\usepackage{hypdestopt}\fi
-\hypersetup{pdfkeywords={LaTeX, package, caption2},pdfstartpage={},pdfstartview={}}
+\documentclass{captiondoc}
+\hypersetup{pdfkeywords={LaTeX, package, caption2}}
%
\usepackage{caption2}[2008/07/01]
%
@@ -65,25 +52,15 @@
%</driver>
% \fi
%
-% \newcommand*{\purerm}[1]{{\upshape\mdseries\rmfamily #1}}
-% \newcommand*{\puresf}[1]{{\upshape\mdseries\sffamily #1}}
-% \newcommand*{\purett}[1]{{\upshape\mdseries\ttfamily #1}}
-% \let\class\puresf \let\package\puresf
-% \let\env\purett \let\opt\purett
-%
-% \def\thispackage{the \package{caption2} package}
-% \def\Thispackage{The \package{caption2} package}
-%
-% \newcommand*\csmarg[1]{\texttt{\char`\{#1\char`\}}}
-% \newcommand*\csoarg[1]{\texttt{\char`\[#1\char`\]}}
-% \newcommand*\version[2][]{v$#2$}
+% \def\thispackage{the \pkg{caption2} package}
+% \def\Thispackage{The \pkg{caption2} package}
%
% \GetFileInfo{caption2.drv}
% \let\docdate\filedate
% \let\docversion\fileversion
% \GetFileInfo{caption2.sty}
%
-% \title{The (obsolete) \texorpdfstring{\package{caption2} package\thanks{%^^A
+% \title{The (obsolete) \texorpdfstring{\pkg{caption2} package\thanks{%^^A
% This package has version number \docversion.}}%^^A
% {caption2 package}}
% \author{Axel Sommerfeldt\\
@@ -104,46 +81,46 @@
%
% \section*{THIS PACKAGE IS OBSOLETE!}
%
-% The \package{caption2} package used to be an experimental side-version of
-% the regular \package{caption} package. It was made public as beta test version
+% The \pkg{caption2} package used to be an experimental side-version of
+% the regular \pkg{caption} package. It was made public as beta test version
% without documentation in 1995 because of the strong demand for new features and
-% adaptations to other packages like the \package{longtable} and
-% \package{subfigure} one.
+% adaptations to other packages like the \pkg{longtable} and
+% \pkg{subfigure} one.
%
% But within the next years I found no time to reintegrate some of the
-% well-tried features into the regular \package{caption} package. So I
-% decided to release a version $2.1$ of the \package{caption2} package in 2002
+% well-tried features into the regular \pkg{caption} package. So I
+% decided to release a version $2.1$ of the \pkg{caption2} package in 2002
% instead, which included some minor bug fixes and adaptations to the new
-% version $2.1$ of the \package{subfigure} package. Furthermore I started
+% version $2.1$ of the \pkg{subfigure} package. Furthermore I started
% to write a documentation for this package, but unfortunately did not get
% very far with this\ldots
%
% In 2003 I finally found some (more) time, so a new regular release $3.0$
-% of the \package{caption} package could be build in cooperation with
+% of the \pkg{caption} package could be build in cooperation with
% Frank Mittelbach and Steven Cochran.
% It was released in December 2003 and superseded the neglected
-% \package{caption2} package.
+% \pkg{caption2} package.
%
-% {\small (In parallel, Steven Cochran released the \package{subfig} package which
-% superseded the \package{subfigure} package.)}
+% {\small (In parallel, Steven Cochran released the \pkg{subfig} package which
+% superseded the \pkg{subfigure} package.)}
%
% So please don't use this package for new documents. It's old, it's obsolete
% and it starts to begin smell bad!
% Please ignore all hints in books or other documents which try to tell you
-% that the \package{caption2} package should be used instead of the
-% \package{caption} package -- these hints are outdated since December 2003.
+% that the \pkg{caption2} package should be used instead of the
+% \pkg{caption} package -- these hints are outdated since December 2003.
%
% \vfill
% \bigskip
% \pagebreak[4]
%
-% \section*{How to migrate to the regular \package{caption} package?}
+% \section*{How to migrate to the regular \pkg{caption} package?}
%
-% Usually replacing \package{caption2} by \package{caption} is sufficient
-% because the \package{caption} package emulates most of the options and
-% commands offered by the \package{caption2} package.
+% Usually replacing \pkg{caption2} by \pkg{caption} is sufficient
+% because the \pkg{caption} package emulates most of the options and
+% commands offered by the \pkg{caption2} package.
% If you get some errors or wired results afterwards, please take a closer
-% look at the \package{caption} package documentation which will hopefully
+% look at the \pkg{caption} package documentation which will hopefully
% help you clearing these problems. You will also find a section called
% `Compatibility to older versions' there which should help you with the
% migration process.
@@ -151,16 +128,17 @@
%
% \section*{What will happen to this package?}
%
-% The \package{caption2} package is still some kind of supported, that means
-% it will be part of future releases of the \package{caption} package bundle,
+% The \pkg{caption2} package is still some kind of supported, that means
+% it will be part of future releases of the \pkg{caption} package bundle,
% and bugs will still be fixed so existing documents using this package will
% still compile.
% But it will \emph{not} be enhanced in the future.
%
-% This means migrating to the actual \package{caption} package should not be
+% This means migrating to the actual \pkg{caption} package should not be
% necessary for old documents -- they should still compile fine as they are.
-% If not, please don't hesitate to write me an e-mail asking for
-% maintainance.
+% If not, please don't hesitate to write me an e-mail to
+% \href{mailto:axel.sommerfeldt@f-m.fm}{\texttt{axel.sommerfeldt@f-m.fm}}
+% asking for maintainance.
%
% \StopEventually{}
%
@@ -264,7 +242,7 @@
% \end{macro}
%
% \subsection{Check against the regular caption package}
-% \changes{v2.2}{2007/04/06}{Check against regular \package{caption} package added}
+% \changes{v2.2}{2007/04/06}{Check against regular \pkg{caption} package added}
% \changes{v2.2a}{2007/04/11}{Bugfix: Usage of \cs{caption@error} replaced by \cs{PackageError}}
%
% \begin{macrocode}
@@ -292,7 +270,7 @@
% \end{macro}
%
% \begin{macro}{\captionwidth}
-% \changes{v2.2h}{2021/01/19}{Re-added since the \package{caption3} kernel uses \cs{caption@width} now}
+% \changes{v2.2h}{2021/01/19}{Re-added since the \pkg{caption3} kernel uses \cs{caption@width} now}
% \begin{macrocode}
\@ifundefined{captionwidth}
{\let\captionwidth\caption@width}
@@ -311,10 +289,10 @@
% \end{macro}
%
% \begin{macro}{\captionindent}
-% \changes{v2.2b}{2007/08/12}{Re-added since the \package{caption3} kernel uses \cs{caption@indent} now}
+% \changes{v2.2b}{2007/08/12}{Re-added since the \pkg{caption3} kernel uses \cs{caption@indent} now}
% \changes{v2.2g}{2020/12/25}{Will only be defined if it is not defined yet}
% \cs{captionindent} will be used in caption style \texttt{indent} and specifies the indention
-% after the first line. (In \package{caption3} \version{1.1} \cs{captionindent} was renamed to
+% after the first line. (In \pkg{caption3} \version{1.1} \cs{captionindent} was renamed to
% \cs{caption@indent} to improve compatibility to the AMS \& SMF document classes.)
% \begin{macrocode}
\@ifundefined{captionindent}
@@ -363,10 +341,10 @@
% \end{macro}
%
% \begin{macro}{\setcaptionmargin}
-% \changes{v2.2h}{2021/01/19}{Re-added since the \package{caption3} kernel does not define it anymore}
+% \changes{v2.2h}{2021/01/19}{Re-added since the \pkg{caption3} kernel does not define it anymore}
% \begin{macro}{\setcaptionwidth}
-% \changes{v2.2h}{2021/01/19}{Re-added since the \package{caption3} kernel does not define it anymore}
-% User-friendly commands to set the caption margin resp.\ width.
+% \changes{v2.2h}{2021/01/19}{Re-added since the \pkg{caption3} kernel does not define it anymore}
+% User-friendly commands to set the caption margin or width.
% Note that they additionally set the \cs{ifcaptionwidth} flag.
% \begin{macrocode}
\providecommand*\setcaptionmargin{%
@@ -787,8 +765,8 @@
%
% \begin{macro}{\captionof}
% \begin{macro}{\captionof*}
-% \cs{captionof} resp.\ \cs{captionof*} will just set \cs{@captype} and do the normal
-% \cs{caption} resp.\ \cs{caption*}, so we can also typeset captions outside floating
+% \cs{captionof} or \cs{captionof*} will just set \cs{@captype} and do the normal
+% \cs{caption} or \cs{caption*}, so we can also typeset captions outside floating
% environments.
% \changes{v2.1}{2002/02/19}{New commands \cs{captionof} and \cs{captionof*}}
% \begin{macrocode}
@@ -823,7 +801,7 @@
% within \thispackage\ \version{2.0}, so we will offer this, too.)
%
% \cs{captionlabel} and \cs{captiontext} will be set to the caption label
-% resp.\ the caption text.
+% or the caption text.
% (Because \cs{captionlabel} and \cs{captiontext} will be locally defined with
% \cs{def} we do not need to define them here.)
% \begin{macrocode}
@@ -837,7 +815,7 @@
% \begin{macro}{\usecaptionmargin}
% A helper macro for caption style authors:
% It calculates \cs{leftskip} and \cs{rightskip} out of
-% \cs{captionlinewidth} and \cs{captionmargin} resp.\ \cs{captionwidth}.
+% \cs{captionlinewidth} and \cs{captionmargin} or \cs{captionwidth}.
% Also \cs{captionlinewidth} will be corrected to the appropriate value.
% \begin{macrocode}
\newcommand*\usecaptionmargin{%