XML Schema Documentation

Attention: This script is bundled with the all platforms distribution of Oxygen XML Author Eclipse plugin. To run the script, you are required to purchase a special scripting commercial license.

You can generate documentation for XML Schemas from Oxygen XML Author Eclipse plugin by using the Tools > Generate Documentation > XML Schema Documentation main menu action. The settings dialog box has an Export settings option that can be used to export the settings to an XML configuration file. Once the settings are exported, you can use the schemaDocumentation.sh script (found in the scripts subfolder inside Oxygen's installation directory) to generate XML Schema documentation from the command line.

Sample Command-Line Arguments for the Generate XML Schema Documentation Script

sh scripts/schemaDocumentation.sh  schemaFile [-cfg:configFile] [-out:outputFile] 
[-format:<value>] [-xsl:xslFile] [-split:<value>] [-openInBrowser:<value>]

Tip: For some GitHub use case samples of this script, see Oxygen Documentation Template and Oxygen Documentation Action.