XML Schema Documentation

The <oXygen/> XML Schema documentation tool allows you to easily generate full documentation for the XML Schema content models, including comprehensive diagrams, annotations, and cross references.

Multiple Output Formats

It is possible to generate XML Schema documentation in various formats including HTML, PDF and DocBook.

You can find here an HTML sample and a PDF sample of the documentation generated by <oXygen/> XML Editor for a very simple XML Schema.

The documentation for the XSLT 2.0 stylesheets XML Schema can be found here.

For large XML Schemas a "generate chunks" option is available for the HTML format that will output documentation in multiple files. The documentation includes diagrams representing the models for the XML elements, attributes, types, etc.

Support for Imported and Included XML Schemas

The generated documentation includes all the components defined in the imported or included schemas.

Advanced Features

By supporting DocBook output, <oXygen/> allows you to use the generated documentation within customized documentation workflows. A custom format can also be generated by setting an XSLT stylesheet that receives as input an XML file with a known structure defined by a schema that comes with <oXygen/>.

Multi-language Support for Annotations in XML Schema Documentation

Now you can choose a specific language to be used in documentation generated for schemas containing annotations in multiple languages. If no language is selected, all the annotations will be generated having the "xml:lang" attribute set, allowing to perform further filtering using other tools.

Best Look and Performance

The documentation output is carefully designed with a balanced selection of colors and a neat layout.

<oXygen/> XML Editor delivers the best available performance for generating XML schema documentation. Even for the largest XML schemas (thousands of components), <oXygen/> generates the complete documentation within a couple of minutes.

Also Available as Command Line Tool

In case you need to integrate the generation of XML Schemas documentation into a build process, you can invoke this tool directly from the command line.

XML Schema Documentation Examples

NewsML-G2 2.2

XML Schema documentation for the News Item - at the Core conformance level.
XML Schema documentation for the News Item - at the Power conformance level.

EventsML-G2 1.1

XML Schema documentation for the Concept Item - at the Core conformance level.
XML Schema documentation for the Concept Item - at the Power conformance level.
XML Schema documentation for the Knowledge Item - at the Core conformance level.
XML Schema documentation for the Knowledge Item - at the Power conformance level.
XML Schema documentation for the Framework - at the Core conformance level.
XML Schema documentation for the Framework - at the Power conformance level.

SportsML-G2 1.1

XML Schema documentation of all elements and attributes.

News Architecture G2 1.3

These items from the News Architecture G2 version 1.3 are relevant to NewsML-G2 and EventsML-G2:

XML Schema documentation for the Package Item - at the Core conformance level.
XML Schema documentation for the Package Item - at the Power conformance level.
XML Schema documentation for the Concept Item - at the Core conformance level.
XML Schema documentation for the Concept Item - at the Power conformance level.
XML Schema documentation for the Knowledge Item - at the Core conformance level.
XML Schema documentation for the Knowledge Item - at the Power conformance level.
XML Schema documentation for the News Message - at the Core conformance level.
XML Schema documentation for the News Message - at the Power conformance level.

aseXML

aseXML is a standard developed by Australian energy industries to facilitate the exchange of information between participants of the energy industries using XML. The aseXML Standards Working Group (ASWG) is responsible for the development and maintenance of the aseXML standard.