 DocFlex/XML - XSDDoc - Examples
- HTML Documentation
- RTF Documentation
- Using XHTML in annotations
1. HTML Documentation
In the following table, you can see a number of Javadoc-like framed HTML documentations
generated with DocFlex/XML RE
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 / content model diagrams (which are PNG graphics files
generated by Altova XMLSpy® 2009 via
DocFlex/XML XMLSpy Integration).
-
Generation time with / without diagrams
-
The first is the generation time of the displayed HTML documentation, which includes content model diagrams.
It actually covers the following operations:
-
Loading the XML schemas from Internet by DocFlex/XML
generator and primary processing of them.
-
Launching XMLSpy,
opening with it the same XML schemas and having it generate the diagram graphics files,
quitting XMLSpy.
-
Further processing by DocFlex/XML and generation of the HTML output.
The second is the time needed to generate the same documentation without diagrams
(that is without any involvement of XMLSpy).
All tests were run on the following computer platform:
Intel Core 2 Duo E6600 based system with 2Gb RAM / Windows XP / Java SE 1.6.0_14.
-
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 (with
and without diagrams) |
38 sec / 21 sec (computer: Intel Core 2 Duo E6600 based / Windows XP / Java SE 1.6.0_14) |
Result RTF |
6.6 MB (with diagrams; the content is reduced in comparison with the
HTML
variant)
|
Number of pages |
390 |
Download (zip) |
1.9 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):
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:
|
