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.0) consists of 63 templates.

2. XML Type

...

3. Main Templates

FramedDoc.tpl

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

On the folowing screenshot you can see an example of such a documentation (generated directly from the file: http://www.w3.org/2001/XMLSchema.xsd). Click to view the real HTML:

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

FramedDoc.tpl template is interpreted as follows:

First, the “Template Init Expression” specified in the template properties is processed:
This, in turn, invokes the execution of “Init” stock-section (click on the screenshot to enlarge):

That stock-section calls from itself two subtemplates:
1. init.tpl, which ...
2. xmlspy.tpl, which ...
Further, the template's root section block is processed (see on the screenshot):

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

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

Here is how each frame is used:

Frame

Usage

overviewFrame This is the primary navigation frame, which is loaded only once per a start to display the same document generated by overview-frame.tpl template. It lets the user:

Select one of the general overviews to be shown in the detailFrame frame:

Overview Summary

All Component Summary

XML Namespace Bindings

Switch the listFrame frame to one of the component lists:

All separately documented components

All components belonging to a particular namespace

All components defined in a particular XML schema

listFrame This frame provides the second layer of navigation. It basically shows a list of components associated with the selection in the overviewFrame frame. This may be one of the files generated by the following templates:

all-components-frame.tpl

namespace-frame.tpl

schema-frame.tpl

Clicking on an item in the list will open in the detailFrame frame the corresponding Component Documentation (as well as Namespace Summary or Schema Summary, when clicking on the list heading).

detailFrame This frame is used to display the actual documentation content. This may be one of the documentation main blocks generated by the following templates:

overview-summary.tpl

all-components-summary.tpl

xmlns-bindings.tpl

namespace-summary.tpl

schema-summary.tpl

element.tpl

complexType.tpl

simpleType.tpl

group.tpl

attribute.tpl

attributeGroup.tpl

The HTML frameset file is generated according to the definition specified in the “Frameset Structure” tab of FramedDoc.tpl template 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. (In particular, what you see on the screenshot will return the pathname of the very first document generated by one of the templates specified in the list.)

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

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

PlainDoc.tpl

PlainDoc.tpl main template was designed specifically to generate single-file documentation in all supported output formats (which currently include HTML, RTF and TXT). The RTF output is the most important of them, which delivers an unmatched quality printable RTF documentation.

Here are a few pages of an RTF documentation generated by PlainDoc.tpl (click to enlarge):

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

...

Calls:

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

4. Subtemplates

Subtemplates by directory:

[..]

init.tpl,
overview-frame.tpl,
overview-summary.tpl, all-components-frame.tpl,
all-components-summary.tpl,
about.tpl

[ann]

annotation.tpl, firstSentence.tpl

[attribute]

attribute.tpl,
attributeProfile.tpl,
attributeProfile2.tpl, attributes.tpl,
attributeSummary.tpl

[content]

contentType.tpl,
diagram.tpl,
xmlRep.tpl,
complexContentModel.tpl, simpleContentRep.tpl,
simpleContentDerivation.tpl,
wildcard.tpl,
facet.tpl

[element]

element.tpl,
elementProfile.tpl,
elementProfile2.tpl,
elementBlockAttrInfo.tpl,
elementFinalAttrInfo.tpl, substitutionGroupInfo.tpl,
contentElementList.tpl,
contentElements.tpl,
elementSummary.tpl,
localElementExt.tpl

[groups]

group.tpl,
groupProfile.tpl,
groupProfile2.tpl,
groupSummary.tpl, attributeGroup.tpl,
attributeGroupProfile.tpl,
attributeGroupProfile2.tpl,
attributeGroupSummary.tpl

[images]

[integrations]
xmlspy.tpl

[namespace]

namespace-frame.tpl,
namespace-summary.tpl, namespaceProfile.tpl

[schema]

schema-frame.tpl,
schema-summary.tpl, schemaProfile.tpl

[type]

complexType.tpl,
simpleType.tpl,
typeProfile.tpl,
typeProfile2.tpl,
typeBlockAttrInfo.tpl,
typeFinalAttrInfo.tpl, typeRelatedCompLists.tpl,
typeUsage.tpl,
typeDerivationTree.tpl,
typeDerivationSummary.tpl,
complexTypeSummary.tpl,
simpleTypeSummary.tpl

[xml]

nodeSource.tpl,
sourceNote.tpl, xmlns-bindings.tpl

Subtemplate details: