blob: d0816be812813d5129a816435790cf5ea10ad7f7 (
plain)
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
|
ABOUT DOX
Copyright (C) 2009, 2010 Didier Verna
This file is part of DoX.
DoX may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.1
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.1 or later is part of all distributions of LaTeX
version 1999/06/01 or later.
DoX consists of the following files:
- NEWS
- README (this file)
- dox.dtx
- dox.el
- dox.ins
* Description
=============
The doc package provides LaTeX developers with means to describe the usage and
the definition of new commands and environments. However, there is no simple
way to extend this functionality to other items (options or counters for
instance). DoX is designed to circumvent this limitation, and provides some
improvements over the existing functionality as well.
DoX homepage: http://www.lrde.epita.fr/~didier/software/latex.php#dox
* Installation
==============
If you are building DoX from the tarball you need to execute the following
steps in order to extract the necessary files:
[pdf]latex dox.ins -> will create the style file dox.sty
[pdf]latex dox.dtx -> (twice) will create the documentation files dox.pdf or
dox.dvi. Note that dox.pdf is already part of the
distribution.
After that, you need to install the generated documentation and style file to
a location where LaTeX can find them. For a TDS-compliant layout, the
following locations are suggested:
[TEXMF]/tex/latex/dox/dox.sty
[TEXMF]/doc/latex/dox/dox.[pdf|dvi]
If you're an AUC-TeX user, you may also install the file 'dox.el' in a
suitable AUC-TeX style directory.
Have fun!
--
Didier Verna <didier@lrde.epita.fr>
Sientific site: http://www.lrde.epita.fr/~didier
Music (Jazz) site: http://www.didierverna.com
Local Variables:
mode: outline
End:
|
