Products         Services         Customers         News         Downloads         Licensing         Shop    

 DocFlex Technology

About
Key Features
Data Processing
Formatting
Templates / Template Designer
Documentation

 DocFlex/XML

About
Documentation
Samples
XMLDoc
XSDDoc
About
Examples
FAQ
Tutorials

 DocFlex/Javadoc

About
Documentation
Templates
Examples
Tutorials

 DocFlex/Together

About
Examples
Basic Templates
Documentation
Tutorials

 Try

Downloads
Registration
Trial License

 Buy

Licensing/Pricing
Shop

 Company

News
Products
Services
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

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

1

XML Schema for XML Schemas

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

2

20 sec

178

HTML

764 KB

2

XML Schemas for Eclipse UML2

http://www.eclipse.org/uml2/
uml2-SDK-xxx.zip/eclipse/plugins/org.eclipse.uml2_2.0.0.jar/model/
ecore.xsd, UML2XMI.xsd, XMI.xsd

3

80 sec

845

HTML

2.8 MB

3

XHTML 1.1

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

36

42 sec

533

HTML

1.4 MB

4

XSLT 2.0

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

3

26 sec

265

HTML

831 KB

5

MathML 2.0

http://www.w3.org/Math/XMLSchema/mathml2/mathml2.xsd

30

44 sec

508

HTML

1.6 MB

6

SOAP 1.1

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

2

8 sec

138

HTML

302 KB

7

SOAP 1.2

http://www.w3.org/2003/05/soap-envelope
http://www.w3.org/2003/05/soap-encoding
http://www.w3.org/2003/05/soap-rpc

4

9 sec

161

HTML

350 KB

8

WSDL 1.1

http://schemas.xmlsoap.org/wsdl/
http://schemas.xmlsoap.org/wsdl/soap/
http://schemas.xmlsoap.org/wsdl/http/
http://schemas.xmlsoap.org/wsdl/mime/

4

9 sec

103

HTML

239 KB

9

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

9 sec

65

HTML

157 KB

10

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

65 sec

725

HTML

2.3 MB

11

Apache Maven POM 4.0.0

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

1

16 sec

135

HTML

386 KB

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

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

Result RTF

4.8 MB (the content is reduced in comparison with the HTML variant)

Number of pages

320

Download (zip)

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

XML Schema for XML Schemas, RTF, p.1 XML Schema for XML Schemas, RTF, p.2 XML Schema for XML Schemas, RTF, p.312

Element documentation:

XML Schema for XML Schemas, RTF, p.18 XML Schema for XML Schemas, RTF, p.40 XML Schema for XML Schemas, RTF, p.41

Type documentation:

XML Schema for XML Schemas, RTF, p.141 XML Schema for XML Schemas, RTF, p.254 XML Schema for XML Schemas, RTF, p.260

Element group, global attribute, attribute group documentation:

XML Schema for XML Schemas, RTF, p.296 XML Schema for XML Schemas, RTF, p.316 XML Schema for XML Schemas, RTF, p.319

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

XML Schema documentation in RTF format open with OpenOffice.org Writer under Linux

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:
Using XHTML in XML Schema annotations (HTML demo)

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:
Using XHTML in XML Schema annotations (RTF demo) Using XHTML in XML Schema annotations (RTF demo) Using XHTML in XML Schema annotations (RTF demo)

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