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.

XML Schema Documenation in HTML format

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.

The XML Schema Documentation Dialog

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

EventsML-G2 1.1

SportsML-G2 1.1

News Architecture G2 1.3

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

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.

MusicXML

Video Tutorials
" oXygen XML Editor is the premier text editor for XML geeks, and an indispensable tool for O'Reilly's Production group. My team uses oXygen XML Editor for everything from simple XML editing to Schema validation and XSLT transformations. The digital production staff especially loves oXygen's built-in EPUB support, which eliminates a great deal of the grunt work that is usually entailed in editing EPUB files. The more we use oXygen, the more realize what a powerful tool it can be in digital and XML-based workflows."
Adam Witwer
Director of Content and Publishing Operations
O'Reilly Media