Products         News         Downloads         Licensing         Shop         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Use
Licensing
Shop
Support
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/XML - Overview

  1. What is DocFlex/XML?
  2. Key Features
  3. Technical Requirements
  4. Editions
  5. Functional Entities
  6. Commercial Licenses

1.  What is DocFlex/XML?

DocFlex/XML is a software system for development and execution of high performance documentation/report generators from any data stored in XML files.

Template-driven architecture

The actual documentation/report generators are programmed in the form of special templates 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 template processor, 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 XSLT. 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 Apache Xerces 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 template applications (or template sets) that implement some very advanced professional documentation generators in the field of XML:

Integrations

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.

Licensing

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:
  1. Template-driven architecture
  2. Processing of XML data sources
  3. Formatting
  4. Insertion of images
  5. Hypertext
  6. Output formats
  7. Generator GUI
  8. Ready template applications
  9. Integrations

3.  Technical Requirements

DocFlex/XML requires Java Runtime Environment (JDK or JRE) version 1.4.x - 8.x installed on your system. (The latest Java version may be preferable as it will be the fastest!)

You can freely download Java from the Java Technology web-site: http://www.oracle.com/technetwork/java/

Since DocFlex/XML is a pure Java application (both the Template Designer and Generator GUI are based entirely on Swing), it is supposed to work on any operating system where Java 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: http://xerces.apache.org.

4.  Editions

Currently, the entire DocFlex/XML software comes in the form of a single edition (called simply “DocFlex/XML”), which you can download as a single archive. It includes everything (all features available in this product line): You just need to install the necessary licenses to use those features you need (if they are not free).

DocFlex/XML RE

That was another (lite) edition of DocFlex/XML. It was practically the same as the full one, however without the Template Designer. Now, that edition is discontinued.

Note: If you have a commercial license for DocFlex/XML software and used it with DocFlex/XML RE, now simply install that license with DocFlex/XML (full edition). Everything will work the same!

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 this 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.

Template Designer

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 covered by the “DocFlex/XML SDK” license, depending on which it may work in one of two modes:

  • demo
  • full
The difference shown in this table:

Feature / Functionality

Demo Mode

Full Mode

License type(s) Limited Free License (activated by default) Commercial or Trial License
Possibility to create/modify templates
Possibility to execute templates without SDK license only those created or modified the last time under a Commercial License for DocFlex/XML SDK

Template Processor (Generator)

Represents the Runtime Environment (RE) to execute template applications. This includes:
  • Template Interpreter
  • Output generators in HTML, RTF and TXT formats
  • Generator GUI
  • The support of XML Catalogs for input XML files
That functionality (called simply “generator”) is provided by DocFlex/XML Java library.

The generator is covered by either Free License or “DocFlex/XML SDK” license, depending on which it may work in one of three modes:

  • limited
  • full
  • trial
The differences between those modes are shown in the following table:

Feature / Functionality

Limited Mode

Full Mode

Trial Mode

License type(s) Free License (activated by default) Commercial License for DocFlex/XML SDK Trial License for DocFlex/XML SDK
Execution of any custom templates.

Note: If your custom templates are derived from a template set provided by Filigris Works, their execution will depend also on your license for that template application (see Licensing of Templates).
only those created or modified the last time under a Commercial License for DocFlex/XML SDK distorted output
Execution of templates provides by Filigris Works.

Note: This depends also on your license for that particular template application (see Licensing of Templates).
distorted output
Any number of input XML files
Support of XML Catalogs for input XML files
Generator GUI
Generation of HTML, RTF, TXT (plain text) output
only templates created or modified the last time under a Commercial License for DocFlex/XML SDK
Any number of output files of any size
Possible usage of generated documentation.

Note: This depends also on your licenses for other features used during the generation, e.g. the template set, integrations (see Multiple Licenses).
any usage unlimited for evaluation only

Template Applications

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 included in DocFlex/XML archive. However, each of them is a separate product:

App

Description

License

Allows you to compile any number of generic XML files into a web-ready HTML or printable RTF documentation with the optional inclusion of a namespace binding report that shows which namespace prefixes are bound to which namespace URIs and where.

Although, we place this template set into “Samples” category, we think it might be quite useful anyway. For more details, please see: DocFlex/XML | Sample | XMLDoc
free
Implements a very powerful XML Schema Documentation Generator able to produce both multi-framed Javadoc-like HTML and printable RTF documentation. For more details, please see: DocFlex/XML | XSDDoc.

Note: This is a commercial template application, which requires separate licensing. See also:
separate commercial or trial license
A similar template application that implements even more powerful documentation generator for WSDL, XML schemas (XSD) and all interconnections between them.
separate commercial or trial license

Integrations

Currently, there are four integrations of DocFlex/XML with other software systems. All integrations are supported by the DocFlex/XML Java library. However, each of them is considered a separate product:

System

Integration

Implementation

License

Allows you to run DocFlex/XML generator from your Ant build. For more details, please see: DocFlex/XML | Integrations | Apache Ant
settings in your Ant build file free
Allows you to run DocFlex/XML generator from your Maven build. For more details, please see: DocFlex/XML | Integrations | Apache Maven
Maven plugin (Java open source); settings in your Maven project file free
Allows automatic inserting of graphic diagrams produced by XMLSpy into the documentation generated by XSDDoc/WSDLDoc (with the full support of diagram hyperlinks).

For more details, please see: DocFlex/XML | Integrations | XMLSpy.

This integration is a commercial product, which requires separate licensing. See also:
hardcoded in Java (included in docflex-xml.jar); specifically supported in XSDDoc templates
separate commercial or trial license
Allows automatic inserting of graphic diagrams produced by Oxygen XML Editor into the documentation generated by XSDDoc/WSDLDoc (with the full support of diagram hyperlinks).

For more details, please see: DocFlex/XML | Integrations | Oxygen XML.

This integration is a commercial product, which requires separate licensing. See also:
hardcoded in Java (included in docflex-xml.jar); specifically supported in XSDDoc templates
separate commercial or trial license

6.  Commercial Licenses

License

Description

This license allows you to create/modify templates. It unlocks all features of both:

For instance, if you want to modify the XSDDoc templates, you will need this license (however, it won't cover a possibility to run your modified XSDDoc).

Please note that template applications and integrations are not covered by this license!

See also: Which Licenses You Need - Use Cases
Unlocks all functionality implemented in XSDDoc templates. In particular, you will be able to:
  • Use all parameters controlling XSDDoc templates to customize the generated XML schema documentation within a huge range of possibilities.
  • Use PlainDoc.tpl main template to generate single file HTML or RTF documentation.
  • Format your XML schema annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • Inserting images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • Modify XSDDoc templates as much as you need using Template Designer (provided that you also have a separate DocFlex/XML SDK license).
  • Run any your custom templates derived from XSDDoc.
Covers all functionality implemented in WSDLDoc templates (similar to the XSDDoc license).
Covers XMLSpy Integration. To run it, you are expected already to have Altova XMLSpy installed on your system.

Please note that we do not intervene somehow with the XMLSpy licensing. You must license it from Altova itself!
Covers OxygenXML Integration. To run it, you are expected already to have Oxygen XML Editor installed on your system.

Please note that we do not intervene somehow with the OxygenXML licensing. You must license it by yourself!

Which Licenses You Need - Use Cases

Your goal

The license(s) you need

Covered functionality

XML Schema documentation
  1. DocFlex/XML XSDDoc
  • Generation of XML schema documentation as described at DocFlex/XML | XSDDoc
  • No advertisement text
  • All XSDDoc parameters unlocked
XML Schema documentation + custom style sheet
  1. DocFlex/XML XSDDoc
  2. DocFlex/XML SDK
Custom XML Schema documentation

With XMLSpy diagrams

XML Schema documentation + XMLSpy diagrams
  1. DocFlex/XML XSDDoc
  2. DocFlex/XML XMLSpy Integration
XML Schema documentation + XMLSpy diagrams + custom style sheet
  1. DocFlex/XML XSDDoc
  2. DocFlex/XML XMLSpy Integration
  3. DocFlex/XML SDK
Custom XML Schema documentation + XMLSpy diagrams

With OxygenXML diagrams

XML Schema documentation + OxygenXML diagrams
  1. DocFlex/XML XSDDoc
  2. DocFlex/XML OxygenXML Integration
XML Schema documentation + OxygenXML diagrams + custom style sheet
  1. DocFlex/XML XSDDoc
  2. DocFlex/XML OxygenXML Integration
  3. DocFlex/XML SDK
Custom XML Schema documentation + XMLSpy diagrams

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