LzxdocTool
From OpenLaszlo
download here: lzxdoc.zip
Overview:
OpenLaszlo has fairly sophisticated scripts that build the reference manual for the foundation classes, etc. These scripts spit out very nice output, but they're too heavyweight to use for a project that simply needs internal documentation without live examples and so on.
So we extracted some pieces of these tools and hacked them up a bit to create lzxdoc. We needed this for customer projects, and figured it might be useful to you, the fearless Laszlo developer -- so here it is. Note that lzxdoc is not an official part of the platform and it's not really supported. But we are interested in hearing about how developers use or modify this tool.
lzxdoc is a fairly simple tool that will traverse your LZX source tree and generate HTML documentaiton for the files within, much like Javadoc. It uses a stripped-down version of the documentation syntax seen in LFC files. (Details on LzxdocTool Syntax)It does not support live inline examples, HTML templates, inheritance, and probably a bunch of other stuff.
lzxdoc outputs an HTML file for each .lzx file, and an index.html that lists all of the lzx files, organized by directory.
See the README file for installation instructions, syntax, and usage.
Enjoy!
Scott Evans, Laszlo
--
Note: If you're getting errors related to Python's random or unicode libraries, grab the new zipfile above and check the README for notes regarding the PYTHONCASEOK environment variable.
Note: To run lzxdoc you need to have Python 2.4 (or lower), 4suite for Python 2.4 (or lower) and pyxml for Python 2.4 (or lower). Python 2.5 does not work with lzxdoc!
