summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dox
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-09-21 22:39:03 +0000
committerKarl Berry <karl@freefriends.org>2009-09-21 22:39:03 +0000
commit97748b815092e16107c3fbfbe08795cff718a5fa (patch)
tree832f306d645e13209f2450c05ee9e1c5ea42ab7e /Master/texmf-dist/doc/latex/dox
parent88d26d8a8079d7b343841bb875a83f89cb27e050 (diff)
dox 2.0 (21sep09)
git-svn-id: svn://tug.org/texlive/trunk@15409 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/dox')
-rw-r--r--Master/texmf-dist/doc/latex/dox/NEWS13
-rw-r--r--Master/texmf-dist/doc/latex/dox/README38
-rw-r--r--Master/texmf-dist/doc/latex/dox/THANKS0
-rw-r--r--Master/texmf-dist/doc/latex/dox/dox.el6
-rw-r--r--Master/texmf-dist/doc/latex/dox/dox.pdfbin112661 -> 114170 bytes
-rw-r--r--Master/texmf-dist/doc/latex/dox/header.inc2
6 files changed, 42 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/dox/NEWS b/Master/texmf-dist/doc/latex/dox/NEWS
index b7f27cb159b..bdd77517df2 100644
--- a/Master/texmf-dist/doc/latex/dox/NEWS
+++ b/Master/texmf-dist/doc/latex/dox/NEWS
@@ -17,6 +17,19 @@ version 1999/06/01 or later.
DoX consists of the files listed in the file `README'.
+* Version 2.0
+=============
+** Optional argument to \doxitem
+idxtype option to change the item's index type
+
+** Optional argument to \Describe<Item> and the <Item> environment
+noprint option to avoid marginal printing
+noindex option to avoid item indexing
+
+** Extend \DescribeMacro, \DescribeEnv and their corresponding environments
+with the same features
+
+
* Version 1.0
=============
** First public version
diff --git a/Master/texmf-dist/doc/latex/dox/README b/Master/texmf-dist/doc/latex/dox/README
index 5356e7a7b6d..a856f77065d 100644
--- a/Master/texmf-dist/doc/latex/dox/README
+++ b/Master/texmf-dist/doc/latex/dox/README
@@ -18,7 +18,6 @@ DoX consists of the following files:
- README (this file)
- NEWS
-- THANKS
- dox.ins
- dox.dtx
- dox.el
@@ -28,31 +27,42 @@ DoX consists of the following files:
=============
The doc package provides LaTeX developers with means to describe the usage and
-the definition of new macros and environments. However, there is no simple way
-to extend this functionality to other items (options or counters for
-instance). The DoX package is designed to circumvent this limitation. DoX also
-comes with support for AUC-TeX.
+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
==============
- To install the package, please follow these steps:
+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
+[pdf]latex dox.dtx
+[pdf]latex dox.dtx
+
+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]
-- Run LaTeX on the file `dox.ins' to create the style file `dox.sty'.
-- Run LaTeX on the file `dox.dtx' to create the documentation.
-- Install these files anywhere you see fit.
+If you're an AUC-TeX user, you may also install the file 'dox.el' in a
+suitable AUC-TeX style directory.
- If you're an AUC-TeX user, you can also install the file `dox.el' in
-a suitable AUC-TeX style directory.
Have fun!
--
-Didier Verna, didier@lrde.epita.fr, http://www.lrde.epita.fr/~didier
+Didier Verna <didier@lrde.epita.fr>
-EPITA / LRDE, 14-16 rue Voltaire Tel.+33 (0)1 44 08 01 85
-94276 Le Kremlin-Bicêtre, France Fax.+33 (0)1 53 14 59 22
+Sientific site: http://www.lrde.epita.fr/~didier
+Music (Jazz) site: http://www.didierverna.com
diff --git a/Master/texmf-dist/doc/latex/dox/THANKS b/Master/texmf-dist/doc/latex/dox/THANKS
deleted file mode 100644
index e69de29bb2d..00000000000
--- a/Master/texmf-dist/doc/latex/dox/THANKS
+++ /dev/null
diff --git a/Master/texmf-dist/doc/latex/dox/dox.el b/Master/texmf-dist/doc/latex/dox/dox.el
index b233a1e47a9..ca6496fb870 100644
--- a/Master/texmf-dist/doc/latex/dox/dox.el
+++ b/Master/texmf-dist/doc/latex/dox/dox.el
@@ -5,7 +5,7 @@
;; Author: Didier Verna <didier@lrde.epita.fr>
;; Maintainer: Didier Verna <didier@lrde.epita.fr>
;; Created: Fri Sep 11 11:24:16 2009
-;; Last Revision: Fri Sep 11 11:26:28 2009
+;; Last Revision: Sat Sep 19 09:54:43 2009
;; Keywords: tex abbrev data
@@ -33,7 +33,9 @@
(TeX-add-style-hook "dox"
(function
(lambda ()
- (TeX-add-symbols '("doxitem" "Functions name" "singular" "plural")))))
+ (TeX-add-symbols
+ '("doxitem" [ "Options" ]
+ "Function name" "Environment name" "Index category name")))))
diff --git a/Master/texmf-dist/doc/latex/dox/dox.pdf b/Master/texmf-dist/doc/latex/dox/dox.pdf
index 47907177c4b..ecc1d727932 100644
--- a/Master/texmf-dist/doc/latex/dox/dox.pdf
+++ b/Master/texmf-dist/doc/latex/dox/dox.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/dox/header.inc b/Master/texmf-dist/doc/latex/dox/header.inc
index 155b3aa1de6..163ed9c6f68 100644
--- a/Master/texmf-dist/doc/latex/dox/header.inc
+++ b/Master/texmf-dist/doc/latex/dox/header.inc
@@ -37,7 +37,7 @@
%% Right bracket \] Circumflex \^ Underscore \_
%% Grave accent \` Left brace \{ Vertical bar \|
%% Right brace \} Tilde \~}
-\ProvidesPackage{dox}[2009/09/11 v1.0 Extensions to the doc package]
+\ProvidesPackage{dox}[2009/09/21 v2.0 Extensions to the doc package]
\endinput
%%