FlexDoc/XML - XSDDoc - Examples

  1. HTML Documentation
  2. RTF Documentation

1. HTML Documentation

These are screenshots of a framed HTML documentation generated directly from http://www.w3.org/2001/XMLSchema.xsd (click to see the real HTML):

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

# Schema / Source URL(s) / Location Processed
XSD files
Generated
HTML files /
diagrams
Gen. time
(with
diagrams)
View
online
Download
(zip)
1 XML Schema for XML Schemas 1.0

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

2 180 / 105 11 sec HTML 2.2 MB
2 XML Schema for XML Schemas 1.1

http://www.w3.org/2012/04/XMLSchema.xsd

2 154 / 118 14 sec HTML 1.1 MB
3 DocBook 4.4

http://www.docbook.org/xsd/4.4/docbook.xsd

7 1353 / 1315

154 sec

HTML 19.3 MB
4 DocBook 5.0

http://www.docbook.org/xsd/5.0/docbook.xsd

3 399 / 364

76 sec

HTML 7.3 MB
5 DITA 1.1

http://docs.oasis-open.org/dita/v1.1/OS/schema/catalog.xml
http://docs.oasis-open.org/dita/v1.1/OS/schema/ditabase.xsd
http://docs.oasis-open.org/dita/v1.1/OS/schema/ditaarch.xsd

25 750 / 627 106 sec HTML 9.7 MB
6 SOAP 1.1

http://schemas.xmlsoap.org/soap/envelope/
http://schemas.xmlsoap.org/soap/encoding/

2 138 / 112 6 sec HTML 630 KB
7 WSDL 1.1

http://schemas.xmlsoap.org/wsdl/
http://schemas.xmlsoap.org/wsdl/soap/
http://schemas.xmlsoap.org/wsdl/soap12/wsdl11soap12.xsd
http://schemas.xmlsoap.org/wsdl/http/
http://schemas.xmlsoap.org/wsdl/mime/

5 133 / 92 7 sec HTML 618 KB
8 WSDL 2.0

http://www.w3.org/2002/ws/desc/ns/wsdl20.xsd
http://www.w3.org/2002/ws/desc/ns/wsdl-instance.xsd
http://www.w3.org/2002/ws/desc/ns/wsdl-extensions.xsd

3 65 / 41

6 sec

HTML 372 KB
12 XHTML 1.1

http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd
http://www.w3.org/MarkUp/SCHEMA/xhtml-copyright-1.xsd

37 562 / 413 61 sec HTML 5.8 MB
14 XSLT 2.0

http://www.w3.org/2007/schema-for-xslt20.xsd

3 268 / 166 19 sec HTML 2.3 MB
15 Apache Maven POM 4.0.0

http://maven.apache.org/xsd/maven-4.0.0.xsd

1 136 / 125 9 sec HTML 1.0 MB

Explanations of Table Columns

Schema
The topic of the XML schema documentation. For example: “DITA 1.1” is the “Darwin Information Typing Architecture (DITA) Version 1.1”
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> elements.
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 elements).
Generated HTML files / diagrams
The total number of generated HTML documents / XSD diagrams (which are PNG graphics files generated by FlexDoc/XML DiagramKit).
Generation time (with diagrams)
The generation time of the whole documentation, including all HTML files and diagrams.

This also includes the time for loading all XML schema files from Internet, directly by the given main schema URLs.

All tests were run on an Intel Core i7-3770 system / 8Gb RAM / Windows 7 64bit / Java SE 1.8.
View online
The result documentation published on this website.
Download (zip)
The zip archive with the same documentation available for free downloads.

2. RTF Documentation

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

Schema XML Schema for XML Schemas
Source URL http://www.w3.org/2001/XMLSchema.xsd
Processed XSD files 2
Generation time (with diagrams) 15 sec (computer: Intel Core i7-3770 based / Windows 7 / Java SE 1.8)
Result RTF 7.5 MB (with diagrams; the content is reduced in comparison with the HTML variant)
Number of pages 360
Download (zip) 2.1 MB (includes both framed HTML and RTF docs)

Below are screenshots of some pages from the result RTF (click to enlarge).

Project Overview, Schema Overviews:

All Component Summary, Namespace Bindings:

Element documentation:

Complex Type documentation:

Simple Type documentation:

Element Group, Global Attribute, Attribute Group 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):