DocFlex/XML - Overview
- What is DocFlex/XML?
- Key Features
- Technical Requirements
- Functional Entities
- Commercial Licenses
1. What is DocFlex/XML?
DocFlex/XML is a software system for development and execution of high quality documentation/report generators
from any data stored in XML files.
The actual documentation/report generators are programmed in the form of special
using a graphic Template Designer
that represents the templates visually in a form resembling the output they generate.
Further, the templates are interpreted by a
which takes on input the XML files and produces by them the result documentation.
An alternative to XSLT
As a whole, DocFlex/XML system is similar to
The templates play the role of XSLT scripts and the template interpreter is an equivalent of the XSLT processor.
However, XSLT provides no visual designer and XSLT scripts are hard to visualize.
Besides that, DocFlex/XML is a lot more focused on the generation of very complex finished documentation
in various formats (rather than simply transforming one XML into another) and
has many features for that absent in XSLT.
DocFlex/XML works with raw XML files. It uses only
for the initial parsing and processes further everything by itself.
No XSLT processor is used somewhere in background.
Ready documentation generators
DocFlex/XML includes ready-to-use large
(or template sets) that implement some very advanced professional documentation generators in the field of XML:
Finally, DocFlex/XML includes integrations
with other software systems
(e.g. Altova XMLSpy and
Oxygen XML Editor),
which allow you to automatically insert diagrams produced by them into
the documentation generated by DocFlex.
Overall, “DocFlex/XML” is more like an umbrella-name for many different things,
which are hard to cover by a single license suitable for everyone.
Instead, the software is logically broken into separate functional entities,
which are covered by different licenses (either free or sold separately).
2. Key Features
This section is published on a separate page:
DocFlex/XML | Features.
Here is its table of contents:
3. Technical Requirements
Java™ Version 7, 6.x, 5.x or 1.4.x
installed on your system.
(Java 7 may be preferable as it is the fastest!)
Since DocFlex/XML is a pure Java application
(both the Template Designer and
are based entirely on Swing),
it is supposed to work on any operating system where Java2 Runtime Environment can be installed.
Specifically, the DocFlex/XML software available for downloads
includes both MS Windows BAT files and Linux shell script files
to run DocFlex/XML immediately on those operating systems.
We have been also reported that DocFlex was successfully working under Mac OS X.
Additionally, a sample Ant buildfile and Maven Plugin are provided that will allow you
to use DocFlex/XML with both Apache Ant and Maven.
For more details, please see
DocFlex/XML | Integrations.
To parse XML files, DTDs and XML Schemas, DocFlex/XML uses
Apache Xerces2 Java Parser version 2.9.1,
whose binaries are included in the DocFlex/XML archives.
In case of any questions concerning that library, please refer to the Apache Xerces home page:
Heavy template applications (like XSDDoc)
may require considerable computational resources. To run them, you may need a powerful enough computer
(e.g. with Intel Pentium 4 or AMD Athlon processor) and at least 512 MB RAM memory.
Currently, DocFlex/XML software comes in two editions:
Please note that DocFlex/XML software is not licensed according to the editions.
Rather, it is broken into a number logical products,
which are licensed separately according to their major functionality.
DocFlex/XML (Full Edition) - includes all features available in this product line
DocFlex/XML RE - provides the Runtime Environment to run template applications
DocFlex/XML (Full Edition)
The main focus of this edition is to provide a System Development Kit
to design and modify DocFlex/XML templates.
However, it can be equally used to run any existing template applications.
It is the most complete edition of DocFlex/XML software,
which includes all features available in this product line:
This is a reduced edition that can be used as a Runtime Environment to execute
It doesn't include the
and, therefore, provides no possibility to create/modify templates.
Other features are essentially the same as in the full edition:
5. Functional Entities
DocFlex/XML is very complex software
that took many years to develop. So, a single license covering all features cannot be cheap
(let alone free). Moreover, far not everyone even needs everything!
So, we break the whole DocFlex/XML into a number of logical products
(or functional entities)
according to the major functionality implemented.
Some of those products are free, others require separate licensing.
Below is the list of such products along with the details of how they are licensed.
Provides a high-quality GUI to design templates.
This is the only way to create/modify templates.
In effect, the Template Designer
both visualizes the template language and gives you access
to most of DocFlex Technology features.
Template Designer is available only in DocFlex/XML (Full Edition)
and covered by a license for “DocFlex/XML SDK”,
depending on which it may work in one of two modes:
The difference shown in this table:
Feature / Functionality
Possibility to create/modify templates
Template Designer will work without limitations. You can create/modify any templates.
Possibility to execute templates without SDK license
Template Processor (Generator)
Represents the Runtime Environment (RE) to execute template applications.
That functionality (called simply
is available in both editions of DocFlex/XML.
Output generators in HTML, RTF and TXT formats
The support of XML Catalogs
for input XML files
The generator is covered by either
“DocFlex/XML SDK” license,
depending on which it may work in one of three modes:
The differences between those modes are shown in the following table:
DocFlex/XML currently provides two
ready-to-use template applications useful for real tasks.
(One of them, XSDDoc, demonstrates what DocFlex/XML
was actually developed for).
All template applications are available in both editions of DocFlex/XML.
However, each of them is a separate product:
One more big template application is coming: WSDLDoc
Currently, there are four integrations
of DocFlex/XML with other software systems.
All integrations are available in both editions of DocFlex/XML.
However, each of them is considered a separate product:
6. Commercial Licenses
Which Licenses You Need - Use Cases