Menu
CTAN
Comprehensive TeX Archive Network
Cover Upload Browse

Direc­tory tex-archive/macros/latex/contrib/dox

				  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:

Files

Name Size Date Notes
NEWS 1197 2010-12-16 05:24
README 1936 2010-12-16 05:24
dox.dtx 24883 2010-12-16 05:24
dox.el 1879 2010-12-16 05:24
dox.ins 1613 2010-12-16 05:24
dox.pdf 153099 2010-12-16 05:24

Down­load the con­tents of this pack­age in one zip archive (135.1k).

dox – Ex­tend the doc pack­age

The doc pack­age pro­vides LaTeX de­vel­op­ers with means to de­scribe the us­age and the def­i­ni­tion of new macros and en­vi­ron­ments. How­ever, there is no sim­ple way to ex­tend this func­tion­al­ity to other items (op­tions or coun­ters, for in­stance). The DoX pack­age is de­signed to cir­cum­vent this lim­i­ta­tion.

Pack­age De­tailsdox
Ver­sion2.2
Li­censeThe LaTeX Project Public Li­cense
Copy­right2009 Di­dier Verna
Main­tainerDi­dier Verna
Con­tained inTeXlive as dox
MikTeX as dox
Topics macros and tools for prepar­ing doc­u­men­ta­tion
Guest Book Sitemap Contact