ANN: pyXSLdoc 0.62
c.
csad7@t-online.de
Sat, 26 Jun 2004 00:22:26 +0200
what is it
----------
An application to produce documentation for XSLT files in XHTML format,
similar to what javadoc does for Java files.
changes since the last release
------------------------------
* new options
-v, --verbose
show more detailed information while generarating the documentation
--helpfile
show the information of a ReST .txt file on the help page.
Default is ``./HELP.txt``.
--windowtitle
browser window title for the documenation
* documentation of xsl:namespace-alias shows prefixes with connected
URIs now. (thanks to Jarno Elovirta)
* parameters of named templates are commented now and properly linked
from index page
* id and class attributes are filtered out of ReST XHTML to not
interfere with pyXSLdocs own CSS classes
* removed unused "deprecated" tab from navigation
* updated to Pyana 0.9, should still work with Pyana 0.8 though
* code documentation, refactoring and simplification (not all though ;)
* lots of bugfixes and small changes
see http://cthedot.de/pyxsldoc/README.txt for a complete list of changes
license
-------
pyXSLdoc is published under the LGPL.
download
--------
download pyXSLdoc v0.62 - 040626 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.9 only)
* Docutils (tested with Docutils 0.3 only)
usage
-----
Copy the XSLT files to document in a directory below pyXSLdoc (you could
also give the complete path to your files but that would end up like
that in the documentation). Then start the documentation process with
>python xsldoc.py DIRNAMES FILENAMES [options]
DIRNAMES
directories with XSLT files to document,e.g. dir1 dir2
All directories and XSLT files below a given directory will be
processed, so you can just use your XSLT package main directory name
(new from v0.50).
FILENAMES
single XSLT files to document, e.g. file1.xsl path/file2.xsl
options
~~~~~~~
-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
-oOVERVIEW, --overview=OVERVIEW
show the information of this ReST .txt file on the overview page
--helpfile=HELPFILE
show the information of this ReST .txt file on the help page.
Default is "./HELP.txt".
--windowtitle=WINDOWTITLE
browser window title for the documentation, text only, no tags
-r, --removedocs
remove all comments from given XSLTs and save results in
COMMENTSTRIPPEDPATH. present files will be OVERWRITTEN!
-cCOMMENTSTRIPPEDPATH, --commentstrippedpath=COMMENTSTRIPPEDPATH
path where XSLTs will be saved after removing of all docs. Only
used when option "-r" is given. Default directory is ./_optimized.
-v, --verbose
show more detailed information while generating the documentation
thanks for the interest.
any comment is appreciated
christof hoeke http://cthedot.de
<P><A HREF="http://cthedot.de/pyxsldoc/">pyXSLdoc 0.62</A> - generate
XSLT documentations (26-Jun-04)