ANN: pyXSLdoc v0.43
c.
csad7@t-online.de
Mon, 24 May 2004 22:16:13 +0200
what is it
----------
An application to produce documentation for XSLT files in XHTML
format, similar to what javadoc does for Java files.
Relying on and processing XML comments is generally not the best idea
but for the purpose of this tool it seems the easiest, most natural and
comfortable way. Even if the XML comments should not be processed (an
XML parser might just ignore them), pyXSLdoc should at least give a
helpful outline for a set of XSLT stylesheets.
changes since the last release
------------------------------
* more XSLT elements are documented now, top level elements should be
all documented now
* new option --removedocs which simple filters all comment nodes out of
give XSLT stylesheets
* comments may be written in reStructuredText format, this is also the
default expected format from v0.4
* HTML in Javadoc style comments is processed now (at least some basic
HTML elements, thanks to Doron Enav for the XSLT templates), use option
--htmldocs to change comment processing from ReST to Javadoc style
* lots of bugfixes and small changes
see http://cthedot.de/pyxsldoc/README.txt for a complete list of changes
todo
----
* ReST processing is very simple at the moment, may be resolved and
enhanced in a future version
* overview of complete directories will be coming soon
license
-------
pyXSLdoc is published under the LGPL.
download
--------
download pyXSLdoc v0.43 - 040524 from http://cthedot.de/pyxsldoc/
pyXSLdoc needs
* Pyana (tested with Pyana 0.8)
* Docutils (tested with Docutils 0.3) for ReST comments
not neccessary if you use Javadoc style comments
usage
-----
Easiest is to copy the XSLT files to document in a directory below
pyxsldoc. Then start the documentation process with
python xsldoc.py FILENAMES DIRNAMES
[-d DOCTARGETDIR -h --htmldocs --removedocs]
FILENAMES
XSLT files to document, e.g. file1.xsl file2.xsl
DIRNAMES
directories with XSLT files to document,e.g. dir1 dir2
-d DOCTARGETDIR
directory where the docs are written to, default is ./_xsldoc
(ATTENTION: Use option -b for versions upto v0.3x)
-h
show the help
--htmldocs
comments in XSLT files are in Javadoc style (HTML and @tags)
reStructuredText is the default comment format if this option is not
given
--removedocs
remove all comments from given XSLT files and save results to
./_optimized
christof hoeke http://cthedot.de
<P><A HREF="http://cthedot.de/pyxsldoc/">pyXSLdoc 0.43</A> - generate
XSLT documentation (23-May-04)