XML Schema Documentation

We've generated documentation using the Oxygen XML Authoring tool. This can be done via the GUI or on the command-line. However this is a commercial product and a license is required. A script exists to generate the documentation in the GeodesyML/tools/documentation/generatedoco.sh. The conditions for its use are:

1. Run on a machine with a licensed copy of OxygenML on it
2. Run from tools/documentation directory
3. No arguments are required
4. Currently only Mac and Linux is supported. For Windows an equivalent DOS script (or Powershell) needs to be written.
5. This script will generate the documentation to the tools/documentation/doc directory and will upload it to the GeodesyML github pages site at https://geoscienceaustralia.github.io/GeodesyML.

Options

I found that all options can be selected except for the Generate Index > Include resource hierarchy, which when used causes an out of memory error for a large schema hierarchy like GeodesyML.

##GUI https://www.oxygenxml.com/doc/versions/17.1/ug-editor/index.html#topics/documentation-XML-Schema.html

In summary:

1. Tools > Generate Documentation > XML Schema Documentation
2. Choose the geodesyML
3. In the settings tab select all options except for Generate Index > Include resource hierarchy

Command-Line

https://www.oxygenxml.com/doc/versions/17.1/ug-editor/index.html#topics/documentation-XML-Schema-command-line.html

To generate the documentation on GitHub project

Generate the documentation through OxygenXML - this will be done to the schemas directory along side the xsd

1. cd ../doc/oxygen-generated
2. find . -name "*xsd" -exec rm {} ;
3. mv geodesyML.html index.html
4. git init
5. git add *
6. git ci -m "Update oxygen-generated schema documenation with diagrams"
7. git push --force [email protected]:GeoscienceAustralia/GeodesyML.git master:gh-pages