This utility generates documentation for an Orchestra file that can be view in any web browser. The output of the generator may be used locally or from a web server.
To run the documentation generator, enter this command line:
java -jar docgen-1.2.0-RC3-SNAPSHOT-jar-with-dependencies <filename> [output-dir]
As the first argument, enter the name of an Orchestra file to document. The second argument is output directory, which defaults to "doc".
When generation completes, open index.html in a browser to view the documentation. There is no other run-time requirement.
The input file must conform to the Orchestra XML Schema. Violations will make the document generator fail with parsing exceptions.
Since the metadata section is viewable in generated documentation, be sure to populate it in the Orchestra file with important identification. In particular, the "title" element should be populated; it is presented by the generator as the title of the documentation.