Products         Services         Customers         News         Downloads         Licensing         Shop    

 DocFlex Technology

About
Key Features
Data Processing
Formatting
Templates / Template Designer
Documentation

 DocFlex/XML

About
Documentation
Samples
XSDDoc
Features
Organization
Examples
Templates
Subtemplates
Parameters
FAQ
Integrations
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 - Templates

  1. Overview
  2. XML Type
  3. Main Templates
  4. Subtemplates
  5. Template Parameters

1.  Overview

The “XSDDoc” template set includes two main templates, which effectively provide two different documentation generators:
  1. FramedDoc.tpl
  2. PlainDoc.tpl
Besides main templates, there are many other templates (called subtemplates) that are used internally. Those subtemplates work as procedures invoked from the main templates as well as from each other. The entire “XSDDoc” template set (version 2.2.1) consists of 63 templates.

2.  XML Type

[this section will be written soon]

3.  Main Templates

FramedDoc.tpl

FramedDoc.tpl is a main template designed to generate multi-file (Javadoc-like) framed HTML documentation by any number of XML schema files.

Here is how this template looks when open in the Template Designer (click to enlarge):

FramedDoc.tpl
On the following screenshot you can see an example of the documentation generated with FramedDoc.tpl (directly from the file: http://www.w3.org/2001/XMLSchema.xsd). Click to view the real HTML:
Framed HTML documentation
The FramedDoc.tpl template is interpreted as follows:
  1. First, the “Template Init Expression” specified in the template properties is processed:

    FramedDoc.tpl - Template Init/Finish Expressions

  2. This, in turn, invokes the execution of “Init” stock-section (click on the screenshot to enlarge):

    FramedDoc.tpl - “Init” stock-section

    That stock-section calls from itself two subtemplates:
    1. init.tpl, which ...
    2. xmlspy.tpl, which is a part of the XMLSpy Integration. This template is called only when the XMLSpy Integration is installed and enabled. See also:

  3. Further, the template's root section block is processed (see on the screenshot):

    FramedDoc.tpl

    It does the following:
    1. overview-summary.tpl template is called to generate Overview Summary page for the whole documentation.
    2. all-components-summary.tpl template is called to generate All Component Summary page.
    3. All namespaces targeted by the XML schemas to be documented are itereated.
      For each namespace:
      1. namespace-overview.tpl template generates Namespace Overview page.
      2. namespace-frame.tpl template generates Namespace Components page.
      3. For all global components and local element components (to be documented separately) that belong to the namespace the following templates are called (depending on the component type): to generate the corresponding Component Documentation files.
    4. All XML schemas (to be documented) are itereated.
      For each schema:
      1. schema-overview.tpl template generates the Schema Overview page.
      2. schema-frame.tpl template generates Schema Components page.
    5. all-components-frame.tpl template is called to generate All Components page.
    6. overview-frame.tpl template is called to generate the page shown in the Overview Frame.
    7. xmlns-bindings.tpl template is called to generate the XML Namespace Bindings page.

  4. At this point, all document files have been generated. What is left is the HTML frameset file (normally named 'index.html'). That file starts the whole documentation to display particular HTML documents in three frame windows:

    Frameset Diagram Click to see frame details Click to see frame details Click to see frame details Click to view a framed HTML documentation

    For further details about the usage of each frame, see: Documentation Organization | Framed HTML Documentation | Frameset Structure.

    The frameset file is generated according to the definition specified in the “Frameset Structure” tab of the FramedDoc.tpl properties dialog:

    FramedDoc.tpl - Frameset Definition

    The expression specified in the “Source Expression” field (on the right panel) should return the pathname (or URL) of a document to be initially loaded in the given frame.

  5. As soon as everything has been generated, the “Template Finish Expression” (see above) is processed, which invokes the execution of “Finish” stock-section (click on the screenshot to enlarge):

    FramedDoc.tpl - “Finish” stock-section

    Currently, all it does is removing the temporary files produced by XMLSpy (when XMLSpy Integration is enabled).

PlainDoc.tpl

PlainDoc.tpl is a main template designed specifically to generate single file documentation in all supported output formats (which currently include HTML, RTF and TXT).

Here is how this template looks when open in the Template Designer (click to see the full screenshot):

PlainDoc.tpl
The RTF output it generates is the most important. It delivers an unmatched quality printable RTF documentation. Here are a few pages of such a documentation generated with PlainDoc.tpl (click to enlarge):
RTF documentation: Overview Summary RTF documentation: Element Detail RTF documentation: Schema Overview
...

Calls:

about.tpl, all-components-summary.tpl, attribute.tpl, attributeGroup.tpl, complexType.tpl, element.tpl, group.tpl, init.tpl, localElementExt.tpl, namespace-overview.tpl, overview-summary.tpl, schema-overview.tpl, simpleType.tpl, xmlns-bindings.tpl, xmlspy.tpl

4.  Subtemplates

[this section is incomplete]

Subtemplates by directory:

5.  Template Parameters

[this section will be written soon]

Currently see: DocFlex/XML | XSDDoc | Templates | Parameters

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