% $Id: doc.gid,v 1.2 1994/02/01 20:50:29 schrod Exp $  -*- LaTeX -*-
%----------------------------------------------------------------------


\packageAbstract{doc}
\label{package:doc}


The \package{doc} package supports the documentation of \TeX{} macro
files with \LaTeX{}. It allows to intermix typeset documentation parts
with macro code. This enables the author to create an appropriate
explanation of the code parts, he or she can follow the old advice of
all technical writing courses: ``Say it twice!'' This way the
\package{doc} package brings (part of) the power of the Literate
Programming paradigm to \TeX{} programming: A method of structured
documentation is provided. (No refinements are available, 'though.)

You can create an index of all macros used in your code if
\MakeIndex{} is installed (see also section~\ref{sec:makeindex}). The
\TeX{} program \file{docstrip.tex} allows to strip the documentation
part from the macro file. In addition, it can extract code parts to
different files.

A user manual is available as part of the distribution. During the
installation the file \file{doc.drv} was created. Edit this file and
remove the percent in front of |\OnlyDescription|. Then \LaTeX{} this
file until the labels do not change any more. The resulting \DVI{}
file is the user manual.

No options are supported by this package.

The package uses the files \file{doc.sty}. \file{docstrip.tex} is
part of the \LaTeX{} distribution, but is not installed by default.


\endAbstract


\begin{rcslog}
$Log: doc.gid,v $
\Revision 1.2 1994/02/01 20:50:29 schrod
Changed ``needs file[s] \dots'' to ``uses file[s] \dots'' This seems
(for me) to be better English.

\Revision 1.1 1994/01/31 21:16:01 schrod
Replaced descriptions of style options by package abstracts.

\end{rcslog}


\endinput                               % just in case