summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/oberdiek/hypcap.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/oberdiek/hypcap.dtx')
-rw-r--r--Master/texmf-dist/source/latex/oberdiek/hypcap.dtx397
1 files changed, 301 insertions, 96 deletions
diff --git a/Master/texmf-dist/source/latex/oberdiek/hypcap.dtx b/Master/texmf-dist/source/latex/oberdiek/hypcap.dtx
index e43a8755f6c..21ec65d87dc 100644
--- a/Master/texmf-dist/source/latex/oberdiek/hypcap.dtx
+++ b/Master/texmf-dist/source/latex/oberdiek/hypcap.dtx
@@ -1,78 +1,176 @@
% \iffalse meta-comment
%
-% hypcap.dtx
-%
-% This file is part of the package `hypcap' for use with LaTeX2e.
-%
-% Function: Adjusting anchors of captions.
-%
-% Copyright (C) 1999-2001 Heiko Oberdiek.
-%
-% This program may be distributed and/or modified under
-% the conditions of the LaTeX Project Public License,
-% either version 1.2 of this license or (at your option)
-% any later version. The latest version of this license
-% is in
-% http://www.latex-project.org/lppl.txt
-% and version 1.2 or later is part of all distributions
-% of LaTeX version 1999/12/01 or later.
-%
-% Please send error reports and suggestions for improvements to
-% Heiko Oberdiek <oberdiek@uni-freiburg.de>.
-%
-%<*dtx>
-\ProvidesFile{hypcap.dtx}
-%</dtx>
-%<package>\ProvidesPackage{hypcap}
-%<driver>\ProvidesFile{hypcap.drv}
-% \fi
-% \ProvidesFile{hypcap.dtx}
- [2001/08/27 v1.3 Adjusting anchors of captions (HO)]
-%
-% \GetFileInfo{hypcap.dtx}
-% \CheckSum{131}
-%
-%% \CharacterTable
-%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
-%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
-%% Digits \0\1\2\3\4\5\6\7\8\9
-%% Exclamation \! Double quote \" Hash (number) \#
-%% Dollar \$ Percent \% Ampersand \&
-%% Acute accent \' Left paren \( Right paren \)
-%% Asterisk \* Plus \+ Comma \,
-%% Minus \- Point \. Solidus \/
-%% Colon \: Semicolon \; Less than \<
-%% Equals \= Greater than \> Question mark \?
-%% Commercial at \@ Left bracket \[ Backslash \\
-%% Right bracket \] Circumflex \^ Underscore \_
-%% Grave accent \` Left brace \{ Vertical bar \|
-%% Right brace \} Tilde \~}
-%%
-% \iffalse
+% Copyright (C) 1999-2001, 2006 by
+% Heiko Oberdiek <oberdiek@uni-freiburg.de>
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either
+% version 1.3 of this license or (at your option) any later
+% version. The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of
+% LaTeX version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status "maintained".
+%
+% This Current Maintainer of this work is Heiko Oberdiek.
+%
+% This work consists of the main source file hypcap.dtx
+% and the derived files
+% hypcap.sty, hypcap.pdf, hypcap.ins, hypcap.drv.
+%
+% Distribution:
+% CTAN:macros/latex/contrib/oberdiek/hypcap.dtx
+% CTAN:macros/latex/contrib/oberdiek/hypcap.pdf
+%
+% Unpacking:
+% (a) If hypcap.ins is present:
+% tex hypcap.ins
+% (b) Without hypcap.ins:
+% tex hypcap.dtx
+% (c) If you insist on using LaTeX
+% latex \let\install=y\input{hypcap.dtx}
+% (quote the arguments according to the demands of your shell)
+%
+% Documentation:
+% (a) If hypcap.drv is present:
+% latex hypcap.drv
+% (b) Without hypcap.drv:
+% latex hypcap.dtx; ...
+% The class ltxdoc loads the configuration file ltxdoc.cfg
+% if available. Here you can specify further options, e.g.
+% use A4 as paper format:
+% \PassOptionsToClass{a4paper}{article}
+%
+% Programm calls to get the documentation (example):
+% pdflatex hypcap.dtx
+% makeindex -s gind.ist hypcap.idx
+% pdflatex hypcap.dtx
+% makeindex -s gind.ist hypcap.idx
+% pdflatex hypcap.dtx
+%
+% Installation:
+% TDS:tex/latex/oberdiek/hypcap.sty
+% TDS:doc/latex/oberdiek/hypcap.pdf
+% TDS:source/latex/oberdiek/hypcap.dtx
+%
+%<*ignore>
+\begingroup
+ \def\x{LaTeX2e}
+\expandafter\endgroup
+\ifcase 0\ifx\install y1\fi\expandafter
+ \ifx\csname processbatchFile\endcsname\relax\else1\fi
+ \ifx\fmtname\x\else 1\fi\relax
+\else\csname fi\endcsname
+%</ignore>
+%<*install>
+\input docstrip.tex
+\Msg{************************************************************************}
+\Msg{* Installation}
+\Msg{* Package: hypcap 2006/02/20 v1.5 Adjusting anchors of captions (HO)}
+\Msg{************************************************************************}
+
+\keepsilent
+\askforoverwritefalse
+
+\preamble
+
+This is a generated file.
+
+Copyright (C) 1999-2001, 2006 by
+ Heiko Oberdiek <oberdiek@uni-freiburg.de>
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either
+version 1.3 of this license or (at your option) any later
+version. The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3 or later is part of all distributions of
+LaTeX version 2005/12/01 or later.
+
+This work has the LPPL maintenance status "maintained".
+
+This Current Maintainer of this work is Heiko Oberdiek.
+
+This work consists of the main source file hypcap.dtx
+and the derived files
+ hypcap.sty, hypcap.pdf, hypcap.ins, hypcap.drv.
+
+\endpreamble
+
+\generate{%
+ \file{hypcap.ins}{\from{hypcap.dtx}{install}}%
+ \file{hypcap.drv}{\from{hypcap.dtx}{driver}}%
+ \usedir{tex/latex/oberdiek}%
+ \file{hypcap.sty}{\from{hypcap.dtx}{package}}%
+}
+
+\obeyspaces
+\Msg{************************************************************************}
+\Msg{*}
+\Msg{* To finish the installation you have to move the following}
+\Msg{* file into a directory searched by TeX:}
+\Msg{*}
+\Msg{* hypcap.sty}
+\Msg{*}
+\Msg{* To produce the documentation run the file `hypcap.drv'}
+\Msg{* through LaTeX.}
+\Msg{*}
+\Msg{* Happy TeXing!}
+\Msg{*}
+\Msg{************************************************************************}
+
+\endbatchfile
+%</install>
+%<*ignore>
+\fi
+%</ignore>
%<*driver>
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesFile{hypcap.drv}%
+ [2006/02/20 v1.5 Adjusting anchors of captions (HO)]
\documentclass{ltxdoc}
\usepackage{holtxdoc}
\begin{document}
- \DocInput{hypcap.dtx}
+ \DocInput{hypcap.dtx}
\end{document}
%</driver>
% \fi
%
-% \DoNotIndex{\else,\fi,\csname,\endcsname}
-% \DoNotIndex{\def,\edef,\long,\begingroup,\endgroup}
-% \DoNotIndex{\the,\relax,\expandafter}
+% \CheckSum{133}
+%
+% \CharacterTable
+% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
+% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
+% Digits \0\1\2\3\4\5\6\7\8\9
+% Exclamation \! Double quote \" Hash (number) \#
+% Dollar \$ Percent \% Ampersand \&
+% Acute accent \' Left paren \( Right paren \)
+% Asterisk \* Plus \+ Comma \,
+% Minus \- Point \. Solidus \/
+% Colon \: Semicolon \; Less than \<
+% Equals \= Greater than \> Question mark \?
+% Commercial at \@ Left bracket \[ Backslash \\
+% Right bracket \] Circumflex \^ Underscore \_
+% Grave accent \` Left brace \{ Vertical bar \|
+% Right brace \} Tilde \~}
+%
+% \GetFileInfo{hypcap.drv}
+%
+% \title{The \xpackage{hypcap} package}
+% \date{2006/02/20 v1.5}
+% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}}
%
-% \SetupTitle{hyperref, caption, anchor, TeX}
% \maketitle
%
% \begin{abstract}
-% This package tries a solution of the problem with
-% hyperref, that links to floats points below the
-% caption and not at the beginning of the float.
-% Therefore this package divides the task into two
-% part, the link setting with \cmd{\capstart} or
-% automatically at the beginning of a float and
-% the rest in the \cmd{\caption} command.
+% This package tries a solution of the problem with
+% hyperref, that links to floats points below the
+% caption and not at the beginning of the float.
+% Therefore this package divides the task into two
+% part, the link setting with \cs{capstart} or
+% automatically at the beginning of a float and
+% the rest in the \cs{caption} command.
% \end{abstract}
%
% \tableofcontents
@@ -88,18 +186,18 @@
% \subsection{Package options}
% The names of the four float environments |figure|, |figure*|,
% |table|, or |table*| can be used as option. Then the package
-% overloads the environment in order to insert \cmd{\capstart}
+% redefines the environment in order to insert \cmd{\capstart}
% (see below) in the beginning of the environment automatically.
%
-% Option |all| enables the overloading of all four
+% Option |all| enables the redefinitions of all four
% float environments. For other environments see
% the user command \cmd{\hypcapredef}.
%
% \subsection{User commands}
% \begin{description}
% \item[\cmd{\capstart}:]\DescribeMacro{\capstart}
-% First it increments the counter (\cmd{\@captype}). Then it
-% makes an anchor for package \Package{hyperref}.
+% First this command increments the counter (\cmd{\@captype}).
+% Then it makes an anchor for package \Package{hyperref}.
% At last \cmd{\caption} is redefined to remove the
% anchor setting part from \Package{hyperref}'s \cmd{\caption}.
%
@@ -120,10 +218,12 @@
% \end{quote}
% And the \cmd{\caption} command itself can be put in a group.
%
-% The options, described above, safe writing the
-% first \cmd{\capstart} in the float environment.
-% But also there must be a \cmd{\caption} in every
-% environment of this type.
+% With the options, described above, the extra
+% writing of \cmd{\capstart} can be avoided.
+% Consequently, there must be a \cmd{\caption} in every
+% environment of this type, specified by the option.
+% If you want to use more than one \cmd{\caption} in this
+% environment, you have to state \cmd{\capstart} again.
% \item[\cmd{\hypcapspace}:]\DescribeMacro{\hypcapspace}
% Because it looks poor, if the link points exactly at top of
% the figure, there is additional space: \cmd{\hypcapspace},
@@ -150,16 +250,19 @@
% \cmd{\@caption}.
% \end{itemize}
%
-% \Installation
-%
-% \StopEventually{}
+% \StopEventually{
+% }
%
% \section{Implementation}
% \begin{macrocode}
%<*package>
% \end{macrocode}
-% The package identification is done at the top of the |.dtx| file
-% in order to use only one identification string.
+% Package identification.
+% \begin{macrocode}
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{hypcap}%
+ [2006/02/20 v1.5 Adjusting anchors of captions (HO)]
+% \end{macrocode}
%
% For unique command names this package uses |hc@| as prefix
% for internal command names.
@@ -318,28 +421,130 @@
% \begin{macrocode}
%</package>
% \end{macrocode}
-%
-% \StartHistory
-% \HistVersion{1999/02/13 v1.0}
-% \begin{itemize}
-% \item A beginning version.
-% \end{itemize}
-% \HistVersion{2000/08/14 v1.1}
-% \begin{itemize}
-% \item Global assignments of |\if@capstart|
-% in order to allow |\caption| in groups.
-% \item Option |all| added.
-% \end{itemize}
-% \HistVersion{2000/09/07 v1.2}
-% \begin{itemize}
-% \item Package in dtx format.
-% \end{itemize}
-% \HistVersion{2001/08/27 v1.3}
-% \begin{itemize}
-% \item Bug fix with hyperref's pdfmark driver\\
-% (\verb|\leavevmode| in
-% \verb|\hyper@@anchor|/\verb|\pdf@rect|).
-% \end{itemize}
+% \section{Installation}
+%
+% \paragraph{CTAN.} This package is available on
+% CTAN\footnote{\url{ftp://ftp.ctan.org/tex-archive/}}:
+% \begin{description}
+% \item[\CTAN{macros/latex/contrib/oberdiek/hypcap.dtx}] The source file.
+% \item[\CTAN{macros/latex/contrib/oberdiek/hypcap.pdf}] Documentation.
+% \end{description}
+%
+% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
+% \docstrip\ archive. The files are extracted by running the
+% \xfile{.dtx} through \plainTeX:
+% \begin{quote}
+% \verb|tex hypcap.dtx|
+% \end{quote}
+%
+% \paragraph{TDS.} Now the different files must be moved into
+% the different directories in your installation TDS tree
+% (also known as \xfile{texmf} tree):
+% \begin{quote}
+% \sbox0{^^A
+% \begin{tabular}{@{}>{\ttfamily}l@{$\quad\rightarrow\quad$}>{\ttfamily}l@{}}
+% hypcap.sty & tex/latex/oberdiek/hypcap.sty\\
+% hypcap.pdf & doc/latex/oberdiek/hypcap.pdf\\
+% hypcap.dtx & source/latex/oberdiek/hypcap.dtx\\
+% \end{tabular}^^A
+% }%
+% \ifdim\wd0>\linewidth
+% \mbox{}\nobreak\hskip0pt minus\leftmargin
+% \usebox0
+% \nobreak\hskip0pt minus\rightmargin
+% \else
+% \usebox0
+% \fi
+% \end{quote}
+% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip's
+% TDS installing feature, then some files can already be in the right
+% place, see the documentation of \docstrip.
+%
+% \paragraph{Refresh file databases.} If your \TeX~distribution
+% (\teTeX, \mikTeX, \dots) rely on file databases, you must refresh
+% these. For example, \teTeX\ users run \verb|texhash| or
+% \verb|mktexlsr|.
+%
+% \subsection{Some details for the interested}
+%
+% \paragraph{Attached source.}
+%
+% The PDF documentation on CTAN also includes the
+% \xfile{.dtx} source file. It can be extracted by
+% AcrobatReader 6 or higher. Another option is \textsf{pdftk},
+% e.g. unpack the file into the current directory:
+% \begin{quote}
+% \verb|pdftk hypcap.pdf unpack_files output .|
+% \end{quote}
+%
+% \paragraph{Unpacking with \LaTeX.}
+% The \xfile{.dtx} chooses its action depending on the format:
+% \begin{description}
+% \item[\plainTeX:] Run \docstrip\ and extract the files.
+% \item[\LaTeX:] Generate the documentation.
+% \end{description}
+% If you insist on using \LaTeX\ for \docstrip\ (really,
+% \docstrip\ does not need \LaTeX), then inform the autodetect routine
+% about your intension:
+% \begin{quote}
+% \verb|latex \install=y\input{hypcap.dtx}|
+% \end{quote}
+% Do not forget to quote the argument according to the demands
+% of your shell.
+%
+% \paragraph{Generating the documentation.}
+% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
+% the documentation. The process can be configured by the
+% configuration file \xfile{ltxdoc.cfg}. For instance, put this
+% line into this file, if you want to have A4 as paper format:
+% \begin{quote}
+% \verb|\PassOptionsToClass{a4paper}{article}|
+% \end{quote}
+% An example follows how to generate the
+% documentation with pdf\LaTeX:
+% \begin{quote}
+%\begin{verbatim}
+%pdflatex hypcap.dtx
+%makeindex -s gind.ist hypcap.idx
+%pdflatex hypcap.dtx
+%makeindex -s gind.ist hypcap.idx
+%pdflatex hypcap.dtx
+%\end{verbatim}
+% \end{quote}
+%
+% \begin{History}
+% \begin{Version}{1999/02/13 v1.0}
+% \item
+% A beginning version.
+% \end{Version}
+% \begin{Version}{2000/08/14 v1.1}
+% \item
+% Global assignments of \cs{if@capstart}
+% in order to allow \cs{caption} in groups.
+% \item
+% Option \texttt{all} added.
+% \end{Version}
+% \begin{Version}{2000/09/07 v1.2}
+% \item
+% Package in dtx format.
+% \end{Version}
+% \begin{Version}{2001/08/27 v1.3}
+% \item
+% Bug fix with hyperref's pdfmark driver\\
+% (\cs{leavevmode} in
+% \cs{hyper@@anchor}/\cs{pdf@rect}).
+% \end{Version}
+% \begin{Version}{2001/09/06 v1.4}
+% \item
+% Small fixes in the dtx file.
+% \end{Version}
+% \begin{Version}{2006/02/20 v1.5}
+% \item
+% Code is not changed.
+% \item
+% New DTX framework.
+% \end{Version}
+% \end{History}
%
% \PrintIndex
%