In the following table, you can see a number of Javadoc-like framed HTML documentations generated by various big XML schemas using FramedDoc.tpl template:

Explanations of Table Columns

Schema: The topic of the XML schema documentation. For example: “MathML 2.0” is the “Mathematical Markup Language (MathML) Version 2.0 (Second Edition)”
Source URL(s) / Location: The locations of the initial source XML schema definition (XSD) files specified directly to the generator. Any other XSD files processed during the generation have been picked by the generator automatically while processing <xs:import>, <xs:include> and <xs:redefine> directives.
Processed XSD files: The total number of XSD files processed during the entire generation (including both those specified directly on the command line and loaded automatically by the generator while processing the importing directives).
Generation time: The total generation time (including the time of loading the schemas from Internet) on the following computer platform: Intel Core 2 Duo E6600 based system / Windows XP / Java SE 1.6.0_02.
All examples have been generated with DocFlex/XML (Kit), version 1.6.8 (coming soon).
Generated HTML files: The total number of generated HTML documents.
View online: The result documentation published on this website.
Download (zip): The zip archive with the same documentation prepared for free downloads.

2. RTF Documentation

This is a single-file RTF documentation generated by “XMLSchema.xsd” schema using PlainDoc.tpl template:

Schema

XML Schema for XML Schemas

Source URL

http://www.w3.org/2001/XMLSchema.xsd

Processed XSD files

2

Generation time

15 seconds (computer: Intel Core 2 Duo E6600 based / Windows XP / Java SE 1.6.0_02)

Result RTF

3.6 MB (the content is reduced comparing to the HTML variant)

Number of pages

254

Download (zip)

668 KB (includes both framed HTML and RTF docs)

The following screenshots show pages of the result RTF (click on the picture to see the real size page preview).

Overview, namespace & schema summaries:

Element documentation:

Type documentation:

The following picture shows a similar RTF documentaton generated under Linux and open with OpenOffice.org Writer (click to see the full-size screenshot):

3. Using XHTML in annotations

The following example demonstrates what can be achieved by using XHTML markup and images in your XML schema annotations.

Framed HTML

Click on the screenshot to see an HTML documentation generated with the FramedDoc.tpl template:

RTF Demo

Click on the screenshots to see the real size MS Word page previews of an RTF documentation generated with the PlainDoc.tpl template: