FlexDoc/XML - XSDDoc - Examples
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):
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 have been run on an Intel Core i7-3770 system / 8Gb RAM / Windows 10 64bit / Java 16. - 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) | 20 sec (computer: Intel Core i7-3770 based / Windows 10 / Java 16) |
Result RTF | 8.1 MB (with diagrams; the content is reduced in comparison with the HTML variant) |
Number of pages | 380 |
Download (zip) | 2.7 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 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):