summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx')
-rw-r--r--Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx386
1 files changed, 334 insertions, 52 deletions
diff --git a/Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx b/Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx
index a591f297412..911625a2093 100644
--- a/Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx
+++ b/Master/texmf-dist/source/latex/oberdiek/hypdoc.dtx
@@ -67,12 +67,13 @@
\input docstrip.tex
\Msg{************************************************************************}
\Msg{* Installation}
-\Msg{* Package: hypdoc 2007/04/11 v1.5 Hyper extensions for doc.sty (HO)}
+\Msg{* Package: hypdoc 2007/11/12 v1.6 Hyper extensions for doc.sty (HO)}
\Msg{************************************************************************}
\keepsilent
\askforoverwritefalse
+\let\MetaPrefix\relax
\preamble
This is a generated file.
@@ -97,6 +98,7 @@ and the derived files
hypdoc.sty, hypdoc.pdf, hypdoc.ins, hypdoc.drv.
\endpreamble
+\let\MetaPrefix\DoubleperCent
\generate{%
\file{hypdoc.ins}{\from{hypdoc.dtx}{install}}%
@@ -113,6 +115,10 @@ and the derived files
\Msg{*}
\Msg{* hypdoc.sty}
\Msg{*}
+\Msg{* And install the following script file:}
+\Msg{*}
+\Msg{* }
+\Msg{*}
\Msg{* To produce the documentation run the file `hypdoc.drv'}
\Msg{* through LaTeX.}
\Msg{*}
@@ -128,16 +134,16 @@ and the derived files
%<*driver>
\NeedsTeXFormat{LaTeX2e}
\ProvidesFile{hypdoc.drv}%
- [2007/04/11 v1.5 Hyper extensions for doc.sty (HO)]%
+ [2007/11/12 v1.6 Hyper extensions for doc.sty (HO)]%
\documentclass{ltxdoc}
-\usepackage{holtxdoc}[2007/10/21]
+\usepackage{holtxdoc}[2007/11/11]
\begin{document}
\DocInput{hypdoc.dtx}%
\end{document}
%</driver>
% \fi
%
-% \CheckSum{682}
+% \CheckSum{680}
%
% \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
@@ -158,7 +164,7 @@ and the derived files
% \GetFileInfo{hypdoc.drv}
%
% \title{The \xpackage{hypdoc} package}
-% \date{2007/04/11 v1.5}
+% \date{2007/11/12 v1.6}
% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}}
%
% \maketitle
@@ -335,24 +341,36 @@ and the derived files
%<*package>
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{hypdoc}%
- [2007/04/11 v1.5 Hyper extensions for doc.sty (HO)]%
+ [2007/11/12 v1.6 Hyper extensions for doc.sty (HO)]%
% \end{macrocode}
% The package identification is done at the top of the |.dtx| file
% in order to use only one identification string.
%
% For unique command names this package uses |HD@| as prefix
%
-% \begin{macrocode}
+% \subsection{Options}
%
+% \begin{macro}{\ifHD@numbered}
+% \begin{macrocode}
\newif\ifHD@numbered
+% \end{macrocode}
+% \end{macro}
+% \begin{macrocode}
\DeclareOption{numbered}{\HD@numberedtrue}
\ProcessOptions*\relax
-
+% \end{macrocode}
+%
+% \subsection{Package loading}
+%
+% \begin{macrocode}
\RequirePackage{doc}
-
+% \end{macrocode}
+% \begin{macrocode}
\ifx\numexpr\@undefined
\RequirePackage{calc}%
\fi
+% \end{macrocode}
+% \begin{macrocode}
\RequirePackage[%
hyperindex=false,%
pdfusetitle,%
@@ -369,12 +387,20 @@ and the derived files
}},%
}
\RequirePackage{thumbpdf}
-
+% \end{macrocode}
+%
+% \begin{macrocode}
\newcounter{HD@unique}
+% \end{macrocode}
+% \begin{macro}{\theHD@unique}
+% \begin{macrocode}
\renewcommand{\theHD@unique}{%
\number\value{HD@unique}%
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macrocode}
\g@addto@macro\Hy@UseMaketitleInfos{%
\@ifundefined{fileinfo}{}{%
\ifx\@pdfsubject\@empty
@@ -382,7 +408,9 @@ and the derived files
\fi
}%
}
-
+% \end{macrocode}
+%
+% \begin{macrocode}
\pdfstringdefDisableCommands{%
\let\thanks\@gobble
\let\footnote\@gobble
@@ -391,9 +419,12 @@ and the derived files
\let\scshape\@empty
\def\and{and }%
}
-
-%%% Bookmarks
-
+% \end{macrocode}
+%
+% \subsection{Bookmarks}
+%
+% \begin{macro}{\HD@sectionpatch}
+% \begin{macrocode}
\def\HD@sectionpatch{%
\ifHD@numbered
\HD@@sectionpatch{section}%
@@ -402,6 +433,10 @@ and the derived files
\let\Hy@writebookmark\HD@disable@writebookmark
\fi
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@@sectionpatch}
+% \begin{macrocode}
\def\HD@@sectionpatch#1{%
\expandafter\let\csname HDorg@@#1\expandafter\endcsname
\csname #1\endcsname
@@ -409,13 +444,25 @@ and the derived files
\@ifstar{\@nameuse{HDorg@@#1}}{\@nameuse{HDorg@@#1}}%
}%
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@disable@writebookmark}
+% \begin{macrocode}
\def\HD@disable@writebookmark#1#2#3#4#5{}
-
-% A wild guessing of the toclevel. There is the hope, that
-% the macro \verb|#1| starts with a sectioning command.
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\HD@guesstoclevel}
+% A wild guessing of the toclevel. There is the hope, that
+% the macro |#1| starts with a sectioning command.
+% \begin{macrocode}
\def\HD@guesstoclevel#1{%
\expandafter\HD@@guesstoclevel#1\section\HD@end
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@@guesstoclevel}
+% \begin{macrocode}
\def\HD@@guesstoclevel#1#2\HD@end{%
\@ifundefined{toclevel@\expandafter\@gobble\string#1\@empty}{%
1%
@@ -423,12 +470,22 @@ and the derived files
\@nameuse{toclevel@\expandafter\@gobble\string#1\@empty}%
}%
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{tableofcontents}}
+%
+% \begin{macro}{\HDorg@tableofcontents}
+% \begin{macrocode}
\let\HDorg@tableofcontents\tableofcontents
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\tableofcontents}
+% As first section the table of contents shouldn't
+% go into the toc itself. Also a number looks too funny then.
+% Just a bookmark is enough in this case.
+% \begin{macrocode}
\def\tableofcontents{%
- % As first section the table of contents shouldn't
- % go into the toc itself. Also a number looks too funny then.
- % Just a bookmark is enough in this case.
\begingroup
\@ifundefined{c@section}{%
\def\c@section{0}%
@@ -452,22 +509,42 @@ and the derived files
\endgroup
\fi
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{listoffigures}}
+%
+% \begin{macro}{\HDorg@listoffigures}
+% \begin{macrocode}
\let\HDorg@listoffigures\listoffigures
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\listoffigures}
+% \begin{macrocode}
\def\listoffigures{%
\ifHD@numbered
\else
\stepcounter{HD@unique}%
\pdfbookmark[\HD@guesstoclevel{\HDorg@listoffigures}]%
- {\contentsname}{toc\theHd@unique}%
+ {\contentsname}{toc\theHD@unique}%
\fi
\begingroup
\HD@sectionpatch
\HDorg@listoffigures
\endgroup
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{listoftables}}
+%
+% \begin{macro}{\HDorg@listoftables}
+% \begin{macrocode}
\let\HDorg@listoftables\listoftables
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\listoftables}
+% \begin{macrocode}
\def\listoftables{%
\ifHD@numbered
\else
@@ -480,8 +557,18 @@ and the derived files
\HDorg@listoftables
\endgroup
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{thebibliography}}
+%
+% \begin{macro}{\HDorg@thebibliography}
+% \begin{macrocode}
\let\HDorg@thebibliography\thebibliography
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\thebibliography}
+% \begin{macrocode}
\def\thebibliography{%
\ifHD@numbered
\else
@@ -492,8 +579,18 @@ and the derived files
\HD@sectionpatch
\HDorg@thebibliography
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{theindex}}
+%
+% \begin{macro}{\HDorg@theindex}
+% \begin{macrocode}
\let\HDorg@theindex\theindex
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\theindex}
+% \begin{macrocode}
\def\theindex{%
\let\HDorg@index@prologue\index@prologue
\let\HDorg@writebookmark\Hy@writebookmark
@@ -525,14 +622,30 @@ and the derived files
}%
\HDorg@theindex
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HDorg@bfseries}
+% \begin{macrocode}
\let\HDorg@bfseries\bfseries
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@bfseries}
+% \begin{macrocode}
\def\HD@bfseries{\futurelet\HD@hfil\HD@@bfseries}%
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@@bfseries}
+% \begin{macrocode}
\def\HD@@bfseries{%
\HDorg@bfseries
\ifx\HD@hfil\hfil
\expandafter\HD@@@bfseries
\fi
-}%
+}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@@@bfseries}
+% \begin{macrocode}
\def\HD@@@bfseries\hfil#1\hfil{%
\ifx\\#1\\%
\else
@@ -544,9 +657,23 @@ and the derived files
\fi
\hfil#1\hfil
}%
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@margin}
+% \begin{macrocode}
\def\HD@margin{1mm}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{theglossary}}
+%
+% \begin{macro}{\HDorg@theglossary}
+% \begin{macrocode}
\let\HDorg@theglossary\theglossary
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\theglossary}
+% \begin{macrocode}
\def\theglossary{%
\let\HDorg@glossary@prologue\glossary@prologue
\let\HDorg@writebookmark\Hy@writebookmark
@@ -565,17 +692,37 @@ and the derived files
}%
\HDorg@theglossary
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\glossaryname}
+% \begin{macrocode}
\providecommand*{\glossaryname}{Change History}
-
-%%% Index stuff
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{Index}
+%
+% \begin{macrocode}
\newcounter{HD@hypercount}
+% \end{macrocode}
+% \begin{macro}{\HD@helplength}
+% \begin{macrocode}
\newlength{\HD@helplength}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\ifHD@savedest}
+% \begin{macrocode}
\newif\ifHD@savedest
\HD@savedesttrue
+% \end{macrocode}
+% \end{macro}
+% \begin{macrocode}
\AtBeginDocument{%
\HD@savedest@init
}
+% \end{macrocode}
+% \begin{macro}{\HD@savedest@init}
+% \begin{macrocode}
\begingroup
\catcode`\^^M=\active
\@firstofone{\endgroup
@@ -596,17 +743,31 @@ and the derived files
\let\HD@savedest@add\@gobble
\fi
}%
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@savedest@entry}
+% \begin{macrocode}
\def\HD@savedest@entry#1^^M{%
\@namedef{HD.#1}{}%
}%
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@savedest@add}
+% \begin{macrocode}
\def\HD@savedest@add#1{%
\immediate\write\HD@savedest@out{\string~#1}%
}
-
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\ifHD@targetraise}
+% \begin{macrocode}
\newif\ifHD@targetraise
\HD@targetraisetrue
-
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@target}
+% \begin{macrocode}
\def\HD@target{%
\ifHD@targetraise
\ifhmode
@@ -622,6 +783,10 @@ and the derived files
\HD@maketarget
\fi
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@maketarget}
+% \begin{macrocode}
\def\HD@maketarget{%
\stepcounter{HD@hypercount}%
\def\HD@next{%
@@ -635,14 +800,26 @@ and the derived files
\fi
\HD@next
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\CodelineIndex}
+% \begin{macrocode}
\g@addto@macro\CodelineIndex{%
\let\special@index\HD@codeline@wrindex
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\PageIndex}
+% \begin{macrocode}
\g@addto@macro\PageIndex{%
\let\special@index\HD@page@wrindex
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\HD@codeline@wrindex}
+% \begin{macrocode}
\def\HD@codeline@wrindex#1{%
\begingroup
\let\HDorg@encapchar\encapchar
@@ -655,6 +832,10 @@ and the derived files
}%
\endgroup
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\HD@page@wrindex}
+% \begin{macrocode}
\def\HD@page@wrindex#1{%
\begingroup
\let\HDorg@encapchar\encapchar
@@ -665,20 +846,38 @@ and the derived files
\HDorg@index{#1\encapchar\encapchar\@nil}%
\endgroup
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\hdclindex}
+% \begin{macrocode}
\def\hdclindex#1#2#3{%
\csname\ifx\\#2\\relax\else#2\fi\endcsname{%
\hyperlink{HD.#1}{#3}%
\HD@savedest@add{#1}%
}%
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\hdpindex}
+% \begin{macrocode}
\def\hdpindex#1#2{%
\csname\ifx\\#1\\relax\else#1\fi\endcsname{%
\hyperpage{#2}%
}%
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{PrintDescribeMacro}}
+%
+% \begin{macro}{\HDorg@PrintDescribeMacro}
+% \begin{macrocode}
\let\HDorg@PrintDescribeMacro\PrintDescribeMacro
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\PrintDescribeMacro}
+% \begin{macrocode}
\renewcommand\PrintDescribeMacro[1]{%
\begingroup
\let\HDorg@MacroFont\MacroFont
@@ -689,8 +888,18 @@ and the derived files
\HDorg@PrintDescribeMacro{#1}%
\endgroup
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{PrintMacroName}}
+%
+% \begin{macro}{\HDorg@PrintMacroName}
+% \begin{macrocode}
\let\HDorg@PrintMacroName\PrintMacroName
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\PrintMacroName}
+% \begin{macrocode}
\renewcommand\PrintMacroName[1]{%
\begingroup
\let\HDorg@MacroFont\MacroFont
@@ -701,8 +910,18 @@ and the derived files
\HDorg@PrintMacroName{#1}%
\endgroup
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{theCodelineNo}}
+%
+% \begin{macro}{\HDorg@theCodelineNo}
+% \begin{macrocode}
\let\HDorg@theCodelineNo\theCodelineNo
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\theCodelineNo}
+% \begin{macrocode}
\renewcommand*\theCodelineNo{%
\settowidth{\HD@helplength}{\HDorg@theCodelineNo\ }%
\ifdim\HD@helplength<\MacroIndent
@@ -716,11 +935,21 @@ and the derived files
\fi
\HDorg@theCodelineNo
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\HDorg@index}
+% \begin{macrocode}
\AtBeginDocument{%
\let\HDorg@index\index
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{SpecialUsageIndex}}
+%
+% \begin{macro}{\HDorg@SpecialUsageIndex}
+% \begin{macrocode}
\let\HDorg@SpecialUsageIndex\SpecialUsageIndex
\renewcommand*\SpecialUsageIndex[1]{%
\@bsphack
@@ -735,11 +964,23 @@ and the derived files
\endgroup
\@esphack
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{autoindex}}
+%
+% \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
\expandafter\ifx\csname autoindex\endcsname\relax
\else
+% \end{macrocode}
+% \begin{macro}{\HDorg@autoindex}
+% \begin{macrocode}
\let\HDorg@autoindex\autoindex
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\autoindex}
+% \begin{macrocode}
\renewcommand*\autoindex[1]{%
\@bsphack
\begingroup
@@ -754,8 +995,18 @@ and the derived files
\@esphack
}%
\fi
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{SpecialEnvIndex}}
+%
+% \begin{macro}{\HDorg@SpecialEnvIndex}
+% \begin{macrocode}
\let\HDorg@SpecialEnvIndex\SpecialEnvIndex
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\SpecialEnvIndex}
+% \begin{macrocode}
\renewcommand*\SpecialEnvIndex[1]{%
\@bsphack
\begingroup
@@ -768,8 +1019,18 @@ and the derived files
\endgroup
\@esphack
}
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{SortIndex}}
+%
+% \begin{macro}{\HDorg@SortIndex}
+% \begin{macrocode}
\let\HDorg@SortIndex\SortIndex
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\SortIndex}
+% \begin{macrocode}
\renewcommand*{\SortIndex}[2]{%
\@bsphack
\begingroup
@@ -778,11 +1039,18 @@ and the derived files
\endgroup
\@esphack
}
-
-
-%%% glossary stuff
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{@wrglossary}}
+%
+% \begin{macro}{\HDorg@wrglossary}
+% \begin{macrocode}
\let\HDorg@wrglossary\@wrglossary
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\@wrglossary}
+% \begin{macrocode}
\def\@wrglossary#1{%
\let\HDorg@encapchar\encapchar
\def\encapchar##1\encapchar##2\@nil{%
@@ -791,9 +1059,13 @@ and the derived files
}%
\HDorg@wrglossary{#1\encapchar\encapchar\@nil}%
}
-
-%%% \MacroIndent automatically calculated
-
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{\cs{MacroIndent}}
+%
+% \cs{MacroIndent} automatically calculated.
+% \begin{macrocode}
\AtEndDocument{%
\if@filesw
\immediate\write\@auxout{%
@@ -801,6 +1073,9 @@ and the derived files
}%
\fi
}
+% \end{macrocode}
+% \begin{macro}{\HD@SetMacroIndent}
+% \begin{macrocode}
\def\HD@SetMacroIndent#1{%
\begingroup
\value{CodelineNo}=#1\relax
@@ -809,6 +1084,7 @@ and the derived files
\endgroup
}
% \end{macrocode}
+% \end{macro}
%
% \begin{macrocode}
%</package>
@@ -1030,6 +1306,12 @@ and the derived files
% \item
% Line ends sanitized.
% \end{Version}
+% \begin{Version}{2007/11/12 v1.6}
+% \item
+% Bug fix in \cs{listoffigures} (Axel Sommerfeldt).
+% \item
+% Markup added in implementation section.
+% \end{Version}
% \end{History}
%
% \PrintIndex