pyXSLdoc v0.7

see Description

Directories
pyxsldoc	here are the Python files for pyXSLdoc
pyxsldoc/xsl	XSLT stylesheets used by pyXSLdoc to generate the XSLT documentation

pyxsldoc - xsldoc documentation for XSLT stylesheets similar to javadoc

Published under the LGPL, see http://cthedot.de/pyxsldoc/license.html

You need at least Python 2.2, Docutils if you use the (default) reStructuredText comment format and a XSLT processor, currently supported are Pyana and 4suite.

Tested with Python 2.4.1 on Windows XP with Pyana 0.9.2 and Docutils 0.3.10 installed.

Please visit http://cthedot.de/pyxsldoc/ for full details and updates. See also the README.txt and documentation. Use option -h for command line options.

directory structure

xsldoc.py: pyxsldoc start script
./__doc__: pyxsldoc's own xsldocs
./_xsldoc: default target for the resulting documentation (overwrite with option -d)
./_optimized: default target of XSLs after running pyxsldoc with option --removedocs
./pyxsldoc: the pyxsldoc package
./pyxsldoc/xsl: the pyxsldoc XSLT files used for the documentation process

todo

resolve --encoding of ReST files? ReST does have problems with the unicode encoding bytes of a file...?
add short ReST documentation
xsl:import and xsl:include docs?
iso-8859-15 XSLTs do not work??? (Pyana?)
Namespace for pyxsldoc XML?
add support for absolute paths?
add more cmdline options of the standard javadoc?
- header? (right of top nav) header.txt?
- footer? (right of bottom nav or copyright before bottom nav?) footer.txt?
THESE OPTIONS DO NOT WORK YET!

changes

0.7

bugfix in comment.py, thanks to Robert Forkel
transformer now optionally uses Pyana or 4suite, the 4suite support thanks to Robert Forkel again
minor "cosmetic" changes in CSS and XHTML output

0.69.1 050713

checked code and removed unused imports from main script

0.69 050712

bugfix in util.py

return value if no comment was given was wrong
bugfix in xsl/doc.xsl

param anchor links did not work
cmdline option -v --verbose is ignored and always set to True now

040804

tested with docutils 0.3.5, no release

0.68 040717

clean up of stylesheet documentation.
- template summary shows only distinguishing attributes (name, match, mode and priority) and not all params anymore
- template detail view reduced as well and slight font style adjustments
CSS adjusted for hopefully easier reading

0.67 040712

new option --bottom shows the text of this given ReST file below the bottom navigation (useful e.g. for copyright information)

0.66 040709

BUGFIX: params of match templates were not processed until now (detected and fixed by Doron Enav)
BUGFIX: template with match and name attribute did ommit the match part
BUGFIX: IndexError if not doctitle was given...
priority of xsl:template is processed now
slight changes to detail view of templates
added more testcases to XSL files in /examples

0.65 040707

fixed a bug that both the Javadoc @param comment and the comment before the xsl:param elements are shown in the documentation. @param has precedence before the xsl:param comment in -j mode now. (suggestion by Doron Enav)
no "default value" is printed if none is given (suggestion by Doron Enav)

0.64 040701

for ReST version: overview, directory pages and stylesheets pages show short comments for directories, stylesheets and XSLT elements. For these short comments the first paragraph of each comment is used, none if any other element like a header, list or blockquote is the first elements
new option --encoding to specify the encoding of additional ReST documentation files like help.txt overview.txt or directory.txt. (Encoding of XSLT files and comments in these is of course read from the XSLT file itself)
--verbose output prints messages about used doctitle, overview and helpfile ReST files
slight changes to documentation output

0.63 040627

comments will be strip()ped before converted from ReST to XHTML to be able to use inline comments like , until now this always gave a <blockquote> which should occur with intent only very rarely
--windowtitle will be shown as Main Headline on overview page if no doctitle given or found
new option --doctitle, doctitle.txt in ReST format will be shown at the top of overview page
bugfixes and fixed typo in help

0.62 040626

enhanced tree view
enhanced documentation for named templates, parameters will be documented now
index: corrected link to named template parameters
presentation adjustments in CSS stylesheet
bugfixes

0.61 040625

BUGFIX: remove comments (-r) did not work in 0.60...
new option --helpfile=HELP.txt to specify content for help page
new HELP.txt about pyXSLdoc's documentation, shown on the help tab if not overwritten with open --helpfile
removed "deprecated" from navigation as it is not generated anyway
simplified code

0.60 040622

new option -v, --verbose: show status of documentation process in stdout
bugfixes and refactoring
used Pyana.URI in transformer, resolves also the strange xsl:import href which had to be used before
re-added links to imported/included XSLTs. links are assumed to be relative, otherwise the doc internal links will not work.
resolved internal unicode handling, only transformer.py (Pyana) and comment.py (minidom) handle with str objects

0.60b 040618

id and class attributes are filtered out of ReST XHTML to not interfere with pyXSLdocs own CSS classes
added detailed documentation how to comment a XSL package to website

0.54 not released

internal changes:
- transformer.py cleanup and commented

0.53 not released

new option
- --windowtitle: browser window title for the documenation (only text, no tags possible)
moved docutils import in util.py to function that needs it so if you use javadoc style comments only pyXSLdoc still works without having to install docutils.
internal changes:
- deleted unnessessary import of docutils in comment.py
- init param changes (some more, some optional)
- xsldoc version and date info in resulting HTML as comments
- removed index.js file as it is not used anyway

0.52 040601

documentation of xsl:namespace-alias shows prefixes with connected URIs now. (thanks to Jarno Elovirta!)

0.51 040531

links to xsl:import and xsl:include stylesheets may not be right as different XSLT processors handle relative URLs in different ways (Pyana e.g. uses the path relative to the calling application, so in pyxsldoc this is relative to the main xsldoc.py.)
pyXSLdoc assumes paths relative to the importing or including stylesheet as there would be no better way (if you know one, drop me a line, thanks!). so the links on the stylesheet page may be wrong. for the moment these are completely disabled.

0.50 040530

all directories containing XSLT files below given sourcedirs (with options -s or in the given list) will be processed now
new options "-s" and "-o": from given "--sourcepath=SOURCEPATH" or the first given directory a file "overview.txt" will be used on the overview summary. overwriting of this default behaviour possible with option "--overview"
for each directory a "directory.txt" file in ReST format will if present be used for the directory page overview
new option "-c"
uses optparse module for option parsing now

0.43 040524

﻿pyXSLdoc v0.7

﻿pyxsldoc - xsldoc documentation for XSLT stylesheets similar to javadoc

directory structure

todo

changes

pyXSLdoc v0.7

pyxsldoc - xsldoc documentation for XSLT stylesheets similar to javadoc