DOMForm installation instructions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Dependencies
~~~~~~~~~~~~

Python 2.3 and PyXML 0.8.3 are required (earlier versions may work, but
are untested).  Currently mxTidy is required (I may switch to uTidylib
at some point).  The spidermonkey Python module is required if you
want JavaScript interpretation.


Installation
~~~~~~~~~~~~

To install the package, run the following command:

 python setup.py build

then (with appropriate permissions)

 python setup.py install


Alternatively, just copy the whole DOMForm directory into your Python
path (eg. unix: /usr/local/lib/python2.3/site-packages, Windows:
C:\Python23\Lib\site-packages).  That's all that setup.py does.  Only
copy the DOMForm directory that's inside the distributed tarball / zip
archive, not the entire DOMForm-x.x.x directory!


To run the tests (none of which access the network), run the following
command:

 python test.py

This runs the tests against the source files extracted from the
package.  For help on command line options:

 python test.py --help


If you run the tests on anything other than Linux, please mail me the
output along with details of the system you ran them on.


NO WARRANTY

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Please see the file COPYING for copyright notices and license terms.


John J. Lee <jjl@pobox.com>
June 2003