Products         Customers         News         Downloads         Licensing         Shop    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
Features
Organization
Examples
Templates
FAQ
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Buy
Licensing
Shop
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/XML - XSDDoc - Examples

  1. HTML Documentation
  2. RTF Documentation
  3. Using XHTML in annotations

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 DocFlex/XML RE by various big XML schemas using FramedDoc.tpl template:

#

Schema / Source URL(s) / Location

Processed
XSD files

Generated
HTML files /
diagrams

Gen. time
with/without
diagrams

View
online

Download
(zip)

1

XML Schema for XML Schemas 1.0

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

2

180 / 102

12 sec /
9 sec

HTML

1.7 MB

2

XML Schema for XML Schemas 1.1

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

2

154 / 114

14 sec /
9 sec

HTML

895 KB

3

DocBook 4.4

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

7

1353 / 484

76 sec /
33 sec

HTML

10.1 MB

4

DocBook 5.0

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

3

399 / 362

77 sec /
34 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

725

27 sec

HTML

2.0 MB

6

SOAP 1.1

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

2

138 / 108

8 sec /
5 sec

HTML

440 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 / 88

11 sec /
6 sec

HTML

492 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

8 sec /
6 sec

HTML

279 KB

9

XHTML 1.0 Strict

http://www.w3.org/2002/08/xhtml/xhtml1-strict.xsd

2

150

9 sec

HTML

389 KB

10

XHTML 1.0 Transitional

http://www.w3.org/2002/08/xhtml/xhtml1-transitional.xsd

2

176

10 sec

HTML

483 KB

11

XHTML 1.0 Frameset

http://www.w3.org/2002/08/xhtml/xhtml1-frameset.xsd

2

179

10 sec

HTML

487 KB

12

XHTML 1.1

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

37

552

19 sec

HTML

1.1 MB

13

XMI 2.1

http://www.omg.org/spec/XMI/20071001/07-10-06.xsd

1

47 / 30

6 sec /
4 sec

HTML

183 KB

14

XSLT 2.0

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

3

268 / 162

20 sec /
13 sec

HTML

1.7 MB

15

Apache Maven POM 4.0.0

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

1

136 / 125

11 sec /
8 sec

HTML

559 KB

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:
  1. Loading the XML schemas from Internet by DocFlex/XML generator and primary processing of them.
  2. Launching XMLSpy, opening with it the same XML schemas and having it generate the diagram graphics files, quitting XMLSpy.
  3. 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 have been run on the computer platform: Intel Core i7-3770 system / 8Gb RAM / Windows 7 64bit / Java SE 1.7.

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 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.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 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:

Copyright© 2003-2014 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.