1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
The gmdoc.zip package
is a work of Grzegorz `Natror' Murzynowski,
<natror at o2 dot pl>
1. Copyright 2006 by Grzegorz `Natror' Murzynowski
This program is subject to the LaTeX Project Public License.
See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
for the details of that license.
2. Introduction
This package provides a tool for documenting of (La)TeX
packages, classes etc., i.e., the .sty, .cls
etc. The author just writes the code and adds the commentary
preceded with % sign (or another sign properly declared). No special
environments are necessary.
The package tends to be compatible with the standard doc.sty
package, i.e., the .dtx files are also compilable with
gmdoc (they may need very little adjustment, in some rather
special cases).
The tools are integrated with hyperref.sty's advantages such as
hyperlinking of index entries, of contents entries and
of cross-references.
3. Installation
Just put the gmdoc.sty and gmdocc.cls somewhere in the texmf/tex/latex
branch and also the gmiflink.sty, gmverb.sty and gmiflink.sty files
(available on CTAN in separate packages). Creating a
/texmf/tex/latex/gm directory may be advisable if you consider using
other packages written by me.
Moreover, you should put the gmglo.ist file, a MakeIndex style for the
changes' history, into some texmf/makeindex directory.
Then you should refresh your TeX distribution's files'
database most probably.
4. Contents
The distribution of this package consists of the following six files.
gmdoc.sty
gmdocc.cls
gmglo.ist
README
gmdocDoc.tex
gmdocDoc.pdf
5. Documentation
The last of the above files (the .pdf) is a documentation compiled
from the .sty file by running LaTeX on the gmdocDoc.tex file twice,
then MakeIndex on the gmdoc.idx and gmdoc.glo files, and then LaTeX
on gmdocDoc.tex twice again.
MakeIndex shell commands:
makeindex -r gmdocDoc
makeindex -r -s gmglo.ist -o gmdocDoc.gls gmdocDoc.glo
The -r switch is to forbid MakeIndex make implicit ranges since the
(code line) numbers will be hyperlinks.
The -s switch makes MakeIndex use the style file instead of the
default settings and the -o switch declares the not-default name of
the output file
Compiling of the documentation requires the packages gmdoc.sty
(with the gmdocc.cls class), gmverb.sty, gmutils.sty and also some
standard packages: hyperref.sty, color.sty, geometry.sty,
multicol.sty, lmodern.sty, fontenc.sty that should be installed
on your computer by default.
The gmglo.ist file, a MakeIndex style for the changes' history, is
provided on CTAN in the gmdoc .zip archive and should
be put into some texmf/makeindex directory.
If you have not installed the mwcls classes (available on CTAN and
present in TeX Lives e.g.), the result of your compilation may differ
a bit from the .pdf provided in this .zip archive in formattings: If
you have not installed mwcls, the standard article.cls will be
used.
BONUS: Base drivers
As a bonus and example of doc-compatibility
there are driver files included
(cf. Palestrina, Missa papae Marceli ;-):
source2e_gmdoc.tex
docstrip_gmdoc.tex
doc_gmdoc.tex
oldcomm.sty
gmeometric.sty
These drivers typeset the respective files from the
.../texmf-dist/source/latex/base
directory of TeXLive2005 distribution.
Probably you should redefine the \BasePath macro in them
so that it points that directory on your computer.
|
