Installing the Software

A-1 Installing the Software

The software is available at http://gxparse.sourceforge.net/.

A-1.1 Software Files

...

A-1.2 Software Source

...

A-1.3 Software Build

Ant 1.6.1 or later is required to build the software. The source file archive(s) should be downloaded and expanded into a file structure, but no binaries are required if you are doing a complete build.

A-1.3.1 Directory Structure

The software directory structure is shown below. A full build, complete with documentation, can be done by changing to the gxparse/admin directory and issuing the command:

    ant ship
        

A list of other build targets can be obtained by issuing the command:

    ant -projecthelp
        

The build directory tree is shown below.

    gxparse         base directory for all build files
    |
    +== admin       files and tools used for builds, record-keeping
    |
    +== java
    |   |
    |   +== src     application source code
    |   |
    |   +== junit   junit source code and other files
    |
    +== docbook
    |   |
    |   +== gxparse     XML source for documentation
    |   |
    |   +== spec        docbook specifications (DTDs etc.)
    |   |
    |   +== tool        tools for working with docbook
    |
    +== bld
    |   |
    |   +== cls         application class directory
    |   |
    |   +== devel       javadoc for GXPARSE developers
    |   |
    |   +== doc         javadoc for API users
    |   |
    |   +== man         documentation produced from XML source
    |   |
    |   +== junit       output from Junit tests
        |   |
        |   +== cls     Junit class files
        |   |
        |   +== html    HTML output from Junit tests
        |
        +== ship        files to be delivered
        |
        +== web         HTML files for web pages
            |
            +== doc     User javadoc modified for web pages

The main build file, gxparse/admin/build.xml, runs a number of secondary build files, all named as properties in the main build file. Some of the secondary build files may run other build files, in which case the other build files will be in a descendant of the directory that contains the secondary build files. The secondary build files can be run as self-contained builds, instead of running them from the main build file. However, the secondary build files do not take account of dependencies upon each other. For example, the Junit build file does nothing to ensure that the API classes are up to date.