 DocFlex/XML - XMLDoc - XML File Documentor
|
Please note, “XMLDoc” described here is basically an example of using
DocFlex/XML.
It is neither a root of this technology nor a separate product.
If you actually need a tool to program generation of some documentation
from the data stored in some XML files, please look at
DocFlex/XML.
It may be exactly what you need!
But notice, no tool (or whatever technology) is possible that will produce
any kind of documentation from any kind of XML files
without programming at all!
|
Overview
The “XML File Documentor” (or “XMLDoc”) set of templates
compiles any number of generic XML files into a nice looking web-ready HTML or printable
RTF documentation with the optional inclusion of a namespace binding report.
It may also serve as an example of a very simple and, at the same time,
practically useful application of DocFlex/XML.
See Templates
to learn how it works.
The set includes two main templates (i.e. those to be specified directly
in the generator dialog
or on the command line
with -template
option):
-
PlainDoc.tpl template
can be used to generate single file documentation in any output format supported by DocFlex.
See RTF demo and Plain HTML demo.
-
FramedDoc.tpl
template is a variant of the same but designed to generate a framed HTML documentation.
See Framed HTML demo.
Besides those main templates, there are few sub-templates, which are called internally from the
both main ones. See Templates
for more details.
Examples
The following XML file demo documentation has been generated from three XSL files
(XSL is a subset of XML that encodes XSLT scripts)
found in Apache Ant software package.
We have chosen those files simply because we use Apache Ant itself (without learning
much what those XSLT scripts do).
You can download the whole demo documentation shown on this page by clicking on the file link:
xmldoc-demo.zip
(25 Kb).
RTF demo
The following pages are from an RTF document generated with
PlainDoc.tpl template
(click on the screenshot to see the real size page preview):
Plain HTML demo
This is actually the same document as RTF above generated with
PlainDoc.tpl template,
however, now it is in HTML format (click on the screenshot to see the real HTML):
Framed HTML demo
The following is a framed HTML variant generated with
FramedDoc.tpl template
(click on the screenshot to see the real HTML):
| 
