CTAN
Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/dox

README.md

ABOUT DOX

Copy­right (C) 2009, 2010, 2017 Di­dier Verna

Author: Di­dier Verna <di­dier@di­dierverna.net>

This file is part of DoX.

DoX may be dis­tributed and/or mod­i­fied un­der the con­di­tions of the Project Public Li­cense, ei­ther ver­sion 1.3 of this li­cense or (at your op­tion) any later ver­sion. The lat­est ver­sion of this li­cense is in http://www.la­tex-project.org/lppl.txt and ver­sion 1.3 or later is part of all dis­tri­bu­tions of ver­sion 2005/12/01 or later.

DoX con­sists of the fol­low­ing files:

  • README.md (this file)
  • NEWS
  • dox.ins
  • dox.dtx
  • dox.el
  • THANKS

De­scrip­tion

The Doc pack­age pro­vides de­vel­op­ers with means to de­scribe the us­age and the def­i­ni­tion of new com­mands 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). DoX is de­signed to cir­cum­vent this lim­i­ta­tion, and pro­vides some im­prove­ments over the ex­ist­ing func­tion­al­ity as well. Dox also comes with sup­port for AUC-.

DoX home­page: http://www.lrde.epita.fr/~di­dier/soft­ware/la­tex.php#dox

In­stal­la­tion

If you are build­ing DoX from the tar­ball, you need to ex­e­cute the fol­low­ing steps in or­der to ex­tract the nec­es­sary files:

[pdf]latex dox.ins
[pdf]latex dox.dtx
[pdf]latex dox.dtx

After that, you need to in­stall the gen­er­ated doc­u­men­ta­tion and style file to a lo­ca­tion where can find them. For a TDS-com­pli­ant lay­out, the fol­low­ing lo­ca­tions are sug­gested:

[TEXMF]/tex/latex/dox/dox.sty
[TEXMF]/doc/latex/dox/dox.[pdf|dvi]

If you're an AUC- user, you may also in­stall the file dox.el in a suit­able AUC- style di­rec­tory.

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

dox – Ex­tend the doc pack­age

The doc pack­age pro­vides 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­agedox
Ver­sion2.3
Li­cense The Project Public Li­cense 1.3
Copy­right2009,2010,2017 Di­dier Verna
Main­tainerDi­dier Verna
Con­tained inTeX Live as dox
MiKTeX as dox
Topics macros and tools for prepar­ing doc­u­men­ta­tion
...
Guest Book Sitemap Contact Contact Author