summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/oberdiek/holtxdoc.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/oberdiek/holtxdoc.dtx')
-rw-r--r--Master/texmf-dist/source/latex/oberdiek/holtxdoc.dtx511
1 files changed, 511 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/oberdiek/holtxdoc.dtx b/Master/texmf-dist/source/latex/oberdiek/holtxdoc.dtx
new file mode 100644
index 00000000000..e247d88abe0
--- /dev/null
+++ b/Master/texmf-dist/source/latex/oberdiek/holtxdoc.dtx
@@ -0,0 +1,511 @@
+% \iffalse meta-comment
+%
+% Copyright (C) 1999-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 holtxdoc.dtx
+% and the derived files
+% holtxdoc.sty, holtxdoc.pdf, holtxdoc.ins, holtxdoc.drv.
+%
+% Distribution:
+% CTAN:macros/latex/contrib/oberdiek/holtxdoc.dtx
+% CTAN:macros/latex/contrib/oberdiek/holtxdoc.pdf
+%
+% Unpacking:
+% (a) If holtxdoc.ins is present:
+% tex holtxdoc.ins
+% (b) Without holtxdoc.ins:
+% tex holtxdoc.dtx
+% (c) If you insist on using LaTeX
+% latex \let\install=y\input{holtxdoc.dtx}
+% (quote the arguments according to the demands of your shell)
+%
+% Documentation:
+% (a) If holtxdoc.drv is present:
+% latex holtxdoc.drv
+% (b) Without holtxdoc.drv:
+% latex holtxdoc.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 holtxdoc.dtx
+% makeindex -s gind.ist holtxdoc.idx
+% pdflatex holtxdoc.dtx
+% makeindex -s gind.ist holtxdoc.idx
+% pdflatex holtxdoc.dtx
+%
+% Installation:
+% TDS:tex/latex/oberdiek/holtxdoc.sty
+% TDS:doc/latex/oberdiek/holtxdoc.pdf
+% TDS:source/latex/oberdiek/holtxdoc.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: holtxdoc 2006/06/02 v0.7 Private additional ltxdoc support (HO)}
+\Msg{************************************************************************}
+
+\keepsilent
+\askforoverwritefalse
+
+\preamble
+
+This is a generated file.
+
+Copyright (C) 1999-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 holtxdoc.dtx
+and the derived files
+ holtxdoc.sty, holtxdoc.pdf, holtxdoc.ins, holtxdoc.drv.
+
+\endpreamble
+
+\generate{%
+ \file{holtxdoc.ins}{\from{holtxdoc.dtx}{install}}%
+ \file{holtxdoc.drv}{\from{holtxdoc.dtx}{driver}}%
+ \usedir{tex/latex/oberdiek}%
+ \file{holtxdoc.sty}{\from{holtxdoc.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{* holtxdoc.sty}
+\Msg{*}
+\Msg{* To produce the documentation run the file `holtxdoc.drv'}
+\Msg{* through LaTeX.}
+\Msg{*}
+\Msg{* Happy TeXing!}
+\Msg{*}
+\Msg{************************************************************************}
+
+\endbatchfile
+%</install>
+%<*ignore>
+\fi
+%</ignore>
+%<*driver>
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesFile{holtxdoc.drv}%
+ [2006/06/02 v0.7 Private additional ltxdoc support (HO)]
+\documentclass{ltxdoc}
+\usepackage{holtxdoc}
+\begin{document}
+ \DocInput{holtxdoc.dtx}
+\end{document}
+%</driver>
+% \fi
+%
+% \CheckSum{240}
+%
+% \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{holtxdoc.drv}
+%
+% \title{The \xpackage{holtxdoc} package}
+% \date{2006/06/02 v0.7}
+% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}}
+%
+% \maketitle
+%
+% \begin{abstract}
+% The package is used for the documentation of my packages in
+% DTX format. It contains some private macros and setup for
+% my needs. Thus do not use it. I have separated the part
+% that may be useful for others in package \xpackage{hypdoc}.
+% \end{abstract}
+%
+% \tableofcontents
+%
+% \section{No usage}
+%
+% Caution: \emph{This package is not intended for public use!}
+%
+% It contains the macros and settings to generate the
+% documentation of my packages in \CTAN{macros/latex/contrib/oberdiek/}.
+% Thus the package does not know anything about compatibility. Only
+% my current packages' documentation must compile.
+%
+% Older versions were more interesting, because they contained code
+% to add \xpackage{hyperref}'s features to \LaTeX's \xpackage{doc}
+% system, e.g. bookmarks and index links. I separated this stuff
+% and made a new package \xpackage{hypdoc}.
+%
+% \StopEventually{
+% }
+%
+% \section{Implementation}
+%
+% \begin{macrocode}
+%<*package>
+% \end{macrocode}
+% Package identification.
+% \begin{macrocode}
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{holtxdoc}%
+ [2006/06/02 v0.7 Private additional ltxdoc support (HO)]
+% \end{macrocode}
+%
+% \begin{macrocode}
+\RequirePackage[numbered]{hypdoc}
+\RequirePackage{array}
+% \end{macrocode}
+%
+% \subsection{Help macros}
+%
+% \begin{macrocode}
+\def\hld@info#1{%
+ \PackageInfo{holtxdoc}{#1\@gobble}%
+}
+\def\hld@warn#1{%
+ \PackageWarningNoLine{holtxdoc}{#1}%
+}
+% \end{macrocode}
+%
+% \subsection{History}
+%
+% \begin{macrocode}
+\newcommand*{\StartHistory}{%
+ \section{History}%
+}
+\newcommand*{\HistVersion}[1]{%
+ \subsection*{%
+ \phantomsection
+ \addcontentsline{toc}{subsection}{[#1]}%
+ [#1]%
+ }%
+ \def\HistLabel##1{%
+ \begingroup
+ \edef\x{[#1]}%
+ \let\@currentlabel\x
+ \label{##1}%
+ \endgroup
+ }%
+}
+\newenvironment{History}{%
+ \StartHistory
+ \def\Version##1{%
+ \HistVersion{##1}%
+ \itemize
+ }%
+ \let\endVersion\enditemize
+}{}
+% \end{macrocode}
+%
+% \subsection{Formatting macros}
+%
+% \cs{UrlFoot}\\
+% |#1|: text\\
+% |#2|: url
+% \begin{macrocode}
+\newcommand{\URL}[2]{%
+ #1\footnote{Url: \url{#2}}%
+}
+% \end{macrocode}
+% \cs{NameEmail}\\
+% |#1|: name\\
+% |#2|: email address
+% \begin{macrocode}
+\newcommand*{\NameEmail}[2]{%
+ \expandafter\hld@NameEmail\expandafter{#2}{#1}%
+}
+\def\hld@NameEmail#1#2{%
+ \expandafter\hld@@NameEmail\expandafter{#2}{#1}%
+}
+\def\hld@@NameEmail#1#2{%
+ \ifx\\#1#2\\%
+ \hld@warn{%
+ Command \string\NameEmail\space without name and email%
+ }%
+ \else
+ \ifx\\#1\\%
+ \href{mailto:#2}{\nolinkurl{#2}}%
+ \else
+ #1%
+ \ifx\\#2\\%
+ \else
+ \footnote{%
+ #1's email address: %
+ \href{mailto:#2}{\nolinkurl{#2}}%
+ }%
+ \fi
+ \fi
+ \fi
+}
+% \end{macrocode}
+%
+% \begin{macrocode}
+\newcommand*{\Package}[1]{\texttt{#1}}
+\newcommand*{\File}[1]{\texttt{#1}}
+\newcommand*{\Verb}[1]{\texttt{#1}}
+\newcommand*{\CS}[1]{\texttt{\expandafter\@gobble\string\\#1}}
+% \end{macrocode}
+%
+% \begin{macrocode}
+\newcommand*{\CTAN}[1]{%
+ \href{ftp://ftp.ctan.org/tex-archive/#1}{\nolinkurl{CTAN:#1}}%
+}
+% \end{macrocode}
+% \begin{macrocode}
+\newcommand*{\Newsgroup}[1]{%
+ \href{http://groups.google.com/group/#1}{\nolinkurl{news:#1}}%
+}
+% \end{macrocode}
+%
+% \begin{macrocode}
+\newcommand*{\xpackage}[1]{\textsf{#1}}
+\newcommand*{\xclass}[1]{\textsf{#1}}
+\newcommand*{\xoption}[1]{\textsf{#1}}
+\newcommand*{\xfile}[1]{\texttt{#1}}
+\newcommand*{\xext}[1]{\texttt{.#1}}
+\newcommand*{\xemail}[1]{%
+ \textless\texttt{#1}\textgreater%
+}
+\newcommand*{\xnewsgroup}[1]{\texttt{#1}}
+% \end{macrocode}
+%
+% The following environment |declcs| is derived from
+% environment |decl| of \xfile{ltxguide.cls}:
+% \begin{macrocode}
+\newenvironment{declcs}[1]{%
+ \par
+ \addvspace{4.5ex plus 1ex}%
+ \vskip -\parskip
+ \noindent
+ \hspace{-\leftmargini}%
+ \def\M##1{\texttt{\{}\meta{##1}\texttt{\}}}%
+ \def\*{\unskip\,\texttt{*}}%
+ \begin{tabular}{|l|}%
+ \hline
+ \expandafter\SpecialUsageIndex\csname #1\endcsname
+ \cs{#1}%
+}{%
+ \\%
+ \hline
+ \end{tabular}%
+ \nobreak
+ \par
+ \nobreak
+ \vspace{2.3ex}%
+ \vskip -\parskip
+ \noindent
+ \ignorespacesafterend
+}
+% \end{macrocode}
+%
+% \subsection{Names}
+%
+% \begin{macrocode}
+\providecommand*{\eTeX}{\mbox{$\varepsilon$-\TeX}}
+\providecommand*{\pdfTeX}{pdf\TeX}
+\providecommand*{\pdfLaTeX}{pdf\LaTeX}
+\providecommand*{\teTeX}{te\TeX}
+\providecommand*{\mikTeX}{mik\TeX}
+\providecommand*{\MakeIndex}{\textsl{MakeIndex}}
+\providecommand*{\docstrip}{\textsf{docstrip}}
+\providecommand*{\plainTeX}{\mbox{plain-\TeX}}
+\providecommand*{\VTeX}{V\TeX}
+% \end{macrocode}
+%
+% \subsection{Setup}
+%
+% \subsubsection{Package \xpackage{doc}}
+%
+% \begin{macrocode}
+\CodelineIndex
+\EnableCrossrefs
+\setcounter{IndexColumns}{2}
+% \end{macrocode}
+% \begin{macrocode}
+\DoNotIndex{\begingroup,\endgroup,\bgroup,\egroup}
+\DoNotIndex{\def,\edef,\xdef,\global,\long,\let}
+\DoNotIndex{\expandafter,\noexpand,\string}
+\DoNotIndex{\else,\fi,\or}
+\DoNotIndex{\relax}
+% \end{macrocode}
+%
+% \subsubsection{Page layout}
+% \begin{macrocode}
+\addtolength{\textheight}{\headheight}
+\addtolength{\textheight}{\headsep}
+\setlength{\headheight}{0pt}
+\setlength{\headsep}{0pt}
+% \end{macrocode}
+% \begin{macrocode}
+\addtolength{\topmargin}{-10mm}
+\addtolength{\textheight}{20mm}
+% \end{macrocode}
+% \begin{macrocode}
+%</package>
+% \end{macrocode}
+% \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/holtxdoc.dtx}] The source file.
+% \item[\CTAN{macros/latex/contrib/oberdiek/holtxdoc.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 holtxdoc.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@{}}
+% holtxdoc.sty & tex/latex/oberdiek/holtxdoc.sty\\
+% holtxdoc.pdf & doc/latex/oberdiek/holtxdoc.pdf\\
+% holtxdoc.dtx & source/latex/oberdiek/holtxdoc.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 holtxdoc.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{holtxdoc.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 holtxdoc.dtx
+%makeindex -s gind.ist holtxdoc.idx
+%pdflatex holtxdoc.dtx
+%makeindex -s gind.ist holtxdoc.idx
+%pdflatex holtxdoc.dtx
+%\end{verbatim}
+% \end{quote}
+%
+% \begin{History}
+% \begin{Version}{1999/06/26 v0.3}
+% \item
+% \dots
+% \end{Version}
+% \begin{Version}{2000/08/14 v0.4}
+% \item
+% \dots
+% \end{Version}
+% \begin{Version}{2001/08/27 v0.5}
+% \item
+% \dots
+% \end{Version}
+% \begin{Version}{2001/09/02 v0.6}
+% \item
+% \dots
+% \end{Version}
+% \begin{Version}{2006/06/02 v0.7}
+% \item
+% Major change: most is put into a new package \xpackage{hypdoc}.
+% \end{Version}
+% \end{History}
+%
+% \PrintIndex
+%
+% \Finale
+\endinput