ANN: pyXSLdoc v0.50

[christof hoeke]

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
------------------------------
* all directories and files *under* a specified sourse directory will be
processed now, so you need no longer specify each directory of a larger 
package
* also overview files in ReST style (directory.txt and overview.txt) are 
processed now
* optparse is used to process the command line options, see -h for all 
new options and option formats
* the target dir or -removedocs which strips off all comments from the 
commented XSLT files may be specified now
* 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


license
-------
   pyXSLdoc is published under the LGPL.


download
--------
   download pyXSLdoc v0.50 - 040530 from http://cthedot.de/pyxsldoc/

pyXSLdoc needs
* Python 2.3 (tested with Python 2.3.4 on Windows XP only)
* Pyana (tested with Pyana 0.8 only)
* Docutils (tested with Docutils 0.3 only) 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 path/file2.xsl
DIRNAMES
     directories with XSLT files to document,e.g. dir1 dir2
     all directories and XSLT files under a given directory will be
     processed. this is new from v0.50

-h, --help
     show this help message and exit

-sSOURCEPATH, --sourcepath=SOURCEPATH
     sourcepath to XSLTs, all XSLT files under this path will be 
documented and SOURCEPATH/overview.txt will be used for the overview. 
You might also simply list all dirs and XSLT files as parameters.

-j, --javadoc, --htmldocs
     process comments in Javadoc style (HTML and @tags), default style 
is reStructuredText (ReST)

-dDOCPATH, --docpath=DOCPATH
     documentation target directory, default is ./_xsldoc
     (ATTENTION: Was option -b in versions upto v0.3x)

-oOVERVIEW, --overview=OVERVIEW
     use this ReST .txt file for the overview page

-r, --removedocs
     remove all comments from given XSLTs and save results in 
COMMENTSTRIPPEDPATH. present files will all be OVERWRITTEN!

-cCOMMENTSTRIPPEDPATH, --commentstrippedpath=COMMENTSTRIPPEDPATH
     path where XSLTs after removing of all docs will be saved, only 
used when option "-r" is given. default is _optimized.


christof hoeke http://cthedot.de


<P><A HREF="http://cthedot.de/pyxsldoc/">pyXSLdoc 0.50</A> - generate 
XSLT documentation (30-May-04)