DocFlex/XML - XSDDoc - Templates
|
This page is incomplete. More content is being prepared...
|
- Overview
- XML Type
- Main Templates
- Subtemplates
- Template Parameters
1. Overview
The “XSDDoc” template set includes two main templates,
which effectively provide two different documentation generators:
- FramedDoc.tpl
- 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):
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:
The 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:
-
init.tpl, which ...
-
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:
-
Further, the template's
root section block
is processed (see on the screenshot):
It does the following:
-
overview-summary.tpl template is called to
generate Overview Summary
page for the whole documentation.
-
all-components-summary.tpl template is called to
generate All Component Summary
page.
-
All namespaces targeted by the XML schemas to be documented are itereated.
For each namespace:
-
namespace-overview.tpl template generates
Namespace Overview page.
-
namespace-frame.tpl template generates
Namespace Components
page.
-
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.
-
All XML schemas (to be documented) are itereated.
For each schema:
-
schema-overview.tpl
template generates the
Schema Overview page.
-
schema-frame.tpl template generates
Schema Components page.
-
all-components-frame.tpl
template is called to generate
All Components page.
-
overview-frame.tpl
template is called to generate the page shown in the
Overview Frame.
-
xmlns-bindings.tpl
template is called to generate the
XML Namespace Bindings page.
-
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:
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:
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.
-
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 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):
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):
...
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:
- [lib]
- [lib/ann]
- [lib/attribute]
- [lib/content]
- [lib/element]
- [lib/groups]
- [lib/images]
- [lib/integrations]
xmlspy.tpl
- [lib/namespace]
- [lib/schema]
- [lib/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
|
- [lib/xml]
|
5. Template Parameters
[this section will be written soon]
Currently see:
DocFlex/XML | XSDDoc | Templates | Parameters
|