DocFlex/XML XSDDoc, Version 2.8.0


Table Of Contents


What is XSDDoc?

"DocFlex/XML XSDDoc" is a commercial template application of DocFlex/XML that implements a high quality XML Schema Documentation Generator, which you can use to generate by any W3C XML schemas the following types of documentation: The XSDDoc template set is bundled with both editions of DocFlex/XML:
  1. DocFlex/XML (Full Edition) - includes all features available in DocFlex/XML software
  2. DocFlex/XML RE - the free Runtime Environment to run template applications
It is found in 'templates/XSDDoc/' subdirectory of each edition.

As being a commercial product, XSDDoc requires separate licensing. According to your license, it can work in one of three modes: limited, full or trial. For more details, please see Licensing / Processing Modes.

Content Files

The following files power XSDDoc (or are related to it):

README.html this file
CHANGES.html change log of XSDDoc templates
FramedDoc.tpl The main template to generate framed HTML documentation.
PlainDoc.tpl The main template to generate single-file documentation (in HTML or RTF format).
help/ The descriptions of parameters of both main templates; used by the Parameter Inspector.
lib/ The directory containing all subtemplates (and icon files) that power the XSDDoc template application.
xsddoc.xmltype The configuration file that defines the 'xsddoc' XML type, on which all XSDDoc templates are based.

Note: All files and directories are located in 'templates/XSDDoc/' subdirectory of each edition of DocFlex/XML.

Technical Requirements

Since XSDDoc is just a set of templates (which are plain-text files), to be executed it always requires the template interpreter / output generator included in one of the editions of DocFlex/XML.

Please note, some general functionality used in a given version of XSDDoc templates may be available only since a specific version of DocFlex/XML. In particular, the XSDDoc version 2.8.0 requires DocFlex/XML version 1.9.0 or later.

Licensing / Processing Modes

XSDDoc is a commercial template application developed by FILIGRIS WORKS. It is a subject of separate licensing.

Depending on your license for "DocFlex/XML XSDDoc", the template set may work (be interpreted) in one of the three different modes: limited, full or trial.

Note:   These are the processing modes of only the XSDDoc template application -- not the particular edition of DocFlex/XML (SDK or RE), which has its own processing mode(s). For more details, please see: http://www.filigris.com/buy/licensing_pricing.php | Commercial Template Applications

Limited Mode

The Limited Mode is covered by the Limited Free License, which is activated by default when no other licenses for "DocFlex/XML XSDDoc" template application have been found.

In this mode, you can:

The limitations:

Full Mode

The Full Mode is activated in the presence of a Commercial or Academic License for "DocFlex/XML XSDDoc" template application. This mode enables you: So, the Full Mode unlocks all functionality of this XML schema documentation generator (both implemented within the XSDDoc templates and supported by the DocFlex/XML template iterpretor / output generators). No other licenses will be needed for this!

What is more, you can also modify/customize the XSDDoc templates themselves (so as to add the functionality not implemented by us, change the generated content, look & feel and so on). For doing this, you will need an additional license for "DocFlex/XML SDK", which covers the Template Designer.

See also: http://www.filigris.com/buy/licensing_pricing.php | Multiple Licenses

Trial Mode

The Trial Mode is activated in the presence of a Trial License for "DocFlex/XML XSDDoc" template application. In this mode, the templates are processed the same as in the full mode. However, there are following limitations:

Installation

Since XSDDoc is just a set of templates (which are plain text files), for its execution it always requires the template interpreter provided by DocFlex/XML (and is rather depend on its version). Because of this, XSDDoc is bundled with both editions of DocFlex/XML:
  1. DocFlex/XML (Full Edition)
  2. DocFlex/XML RE
You do not need to download and install XSDDoc separately!

It will be already pre-installed in the 'templates/XSDDoc/' directory of the main product.

(In the future, when other commercial templates applications will be developed, we may provide them as separately downloadable add-ons. However, now it is just an early stage of such a development.)

The only thing you may need to install specifically is the 'docflex-xml-xsddoc2.license' file, which contains your license for "DocFlex/XML XSDDoc" template application. You receive that file by e-mail. It should be stored in the 'templates/XSDDoc/' directory along with the FramedDoc.tpl and PlainDoc.tpl main templates (i.e. those called the first by the generator). After that, the 'XSDDoc/' directory will contain everything needed to run XSDDoc.

Note: The "DocFlex/XML XSDDoc" license may be also included in a combined 'docflex-xml.license' file (along with other licenses), which should be installed in the 'lib' directory of your DocFlex/XML installation (near docflex-xml.jar). The 'docflex-xml-xsddoc2.license' file may be also installed there.

Actually, the "DocFlex/XML XSDDoc" template application is completely autonomous. You can copy/move (or rename) the 'XSDDoc/' directory to any other location and run the XSDDoc templates directly from there. This may be particularly useful when you want to modify something in the original templates and derive your own version of XSDDoc.

Running XSDDoc

To generate XML Schema documentation, please follow these steps:
  1. Run generator.bat (found in the root directory of your DocFlex/XML (Full Edition) or DocFlex/XML RE installation). You will see the generator dialog.

    While processing XSDDoc templates for big XML schemas, the generator may be particularly hungry for memory. Lack of memory may considerably increase the generation time! To avoid this, make sure the maximum heap size available for JVM is 512Mb or even more (e.g. Java option -Xmx512m sets the maximum heap size to 512Mb). Note also that on 64-bit OS (running 64-bit Java), that amount should be doubled! So, on Windows 7 64-bit you should specify -Xmx1024m.

  2. In "Template" field, select FramedDoc.tpl template.

    You can choose this template from 'templates/XSDDoc' directory using File Chooser.

  3. In "XML File(s)" field, specify one or many XSD files from which you want to generate the XML schema documentation.

    Each XML file can be specified either by local path name or by URL (e.g. http://www.w3.org/2001/XMLSchema.xsd). In the case of a URL, the generator will try to download such a file directly from the Internet.

    When multiple XML files are specified, make sure that each pathname or URL is enclosed in double quotes.

  4. In "Output format" field, select HTML format.

    The FramedDoc.tpl template is a frameset template which can generate only HTML output!

  5. Click "Run" button to start generator.

    Once all source XML Schema files are loaded, the generator enters into the estimation phase. Lots of heavy processing is being done during that, however, you will see only "Scanning data source, please wait..." message on the progress bar. On large XML schemas this phase may take some time. Please wait! After that, the generator will pass into the generation phase. The progress bar will show what's being generated.

    You can stop the generator at any time during any phase by clicking "Cancel" button.

Getting Help

The most detailed and up-to-date information about the DocFlex/XML XSDDoc can be found on the product homepage: www.filigris.com | DocFlex/XML | XSDDoc.

We are always happy to hear any questions, suggestions, comments, etc. about this product.
Please, e-mail us to: support@docflex.com or contact@filigris.com

Change Log

Please see: {docflex-xml}/templates/XSDDoc/CHANGES.html


Copyright© 2005-2013 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.