Actual doc/report generators are created in the form of special templates, which are designed using a graphic Template Designer basing on the datatype information obtained from DTD or XSD (W3C XML Schema) files that describe the particular XML-file data source. All formatting is specified in templates independently of any destination output formats. A template set (called "template application") is interpreted by the template interpreter / output generator, which makes the result XML doc/report generator work. The output format is selected only before generation and may be any of the currently supported by the DocFlex core. For further details, see Documentation | About DocFlex/XML.
"DocFlex/XML (Full Edition)" is the most complete edition of DocFlex/XML software, which includes all features available in this product line:
NOTE: This is a commercial template application that requires separate licensing. See also: Licensing of Templates | Commercial Template Applications and Multiple Licenses.
System | Integration |
---|---|
Apache Ant |
Allows you to run DocFlex/XML generator from your Ant build.
For more details, see
Documentation | Integrations | Apache Ant
and the example {docflex-xml}/integrations/ant/build.xml file.
|
Apache Maven |
Allows you to run DocFlex/XML generator from your Maven build.
For more details, see
{docflex-xml}/integrations/maven/index.html ,
Documentation | Integrations | Apache Maven.
|
XMLSpy |
Allows you to insert automatically the graphics diagrams produced by
Altova XMLSpy
into the XML schema documentation generated by DocFlex/XML XSDDoc
(with full support of diagram hyperlinks).
NOTE: This integration is not covered by the "DocFlex/XML SDK" license and requires separate licensing!
For more information, see:
{docflex-xml}/integrations/XMLSpy/README.html ,
Documentation | Integrations | XMLSpy,
Multiple Licenses.
|
Oxygen XML |
A similar integration (as with XMLSpy), but now the provider of diagrams is
Oxygen XML Editor.
NOTE: This integration is not covered by the "DocFlex/XML SDK" license and requires separate licensing!
For more information, see:
{docflex-xml}/integrations/OxygenXML/README.html ,
Documentation | Integrations | Oxygen XML,
Multiple Licenses.
|
LICENSE.html
|
DocFlex Software License |
README.html
|
this file |
CHANGES.html
|
change log of DocFlex/XML |
doc/
|
DocFlex/XML & Technology Documentation – an HTML copy of all descriptions/documentation published on the product web-site (on the moment of the release). It may be useful when you cannot access the online pages or they changed too much since this release. |
*.bat
|
Files prepared for Windows Installation: |
designer.bat
|
|
generator.bat
|
|
update_templates.bat
|
|
linux/
|
Files prepared for Linux Installation: |
linux/designer.sh
|
|
linux/generator.sh
|
|
linux/update_templates.sh
|
|
linux/docflex.config
|
|
lib/
|
Runtime Environment: |
lib/docflex-xml.jar
|
|
lib/docflex.config
|
|
lib/xml-apis.jar
|
|
lib/resources/
|
Runtime Environment Resources: |
lib/resources/catalog.xml
|
|
lib/resources/http_www_w3_org/
|
|
config/
|
Configuration files (created and updated dynamically): |
config/designer.config
|
|
config/generator.config
|
|
templates/
|
bundled template applications |
templates/XMLDoc/
|
The "XML File Documentor" (XMLDoc) template set: |
templates/XMLDoc/PlainDoc.tpl
|
|
templates/XMLDoc/FramedDoc.tpl
|
|
templates/XMLDoc/xmldoc.xmltype
|
|
templates/XSDDoc/
|
The "XML Schema Documentation Generator" (XSDDoc) template set.
For more details, see:
{docflex-xml}/templates/XSDDoc/README.html
|
samples/
|
Demo samples: |
samples/sales/
|
|
samples/personal/
|
|
samples/HumanEvolution/
|
|
integrations/
|
The support files for integrations of DocFlex/XML with other software systems |
integrations/ant/
|
Ant example files: |
integrations/ant/build.xml
|
|
integrations/ant/make.bat
|
|
integrations/ant/make.sh
|
|
integrations/maven/
|
Maven plugin for DocFlex/XML.
For more details, see:
{docflex-xml}/integrations/maven/index.html
|
integrations/XMLSpy/
|
Contains files related to
XMLSpy Integration.
For more details, see:
{docflex-xml}/integrations/XMLSpy/README.html
|
integrations/OxygenXML/
|
Contains files related to
OxygenXML Integration.
For more details, see:
{docflex-xml}/integrations/OxygenXML/README.html
|
You can freely download Java from the Java Technology web-site: http://www.oracle.com/technetwork/java/ (formerly http://java.sun.com).
DocFlex/XML is a pure Java application. The Template Designer GUI is implemented entirely using Swing. Therefore, everything is supposed to work on any operating system where Java2 Runtime Environment can be installed.
Specifically, the software includes both MS Windows BAT files and Linux shell script files to run DocFlex/XML immediately on those operating systems. See Windows Installation and Linux Installation respectively.
We have been also reported that DocFlex/XML worked successfully under Mac OS X.
To parse XML files, DTDs and XML Schemas, DocFlex/XML uses Apache Xerces2 Java Parser version 2.9.1. In the case of any questions concerning this library, please refer to the Apache Xerces home page: http://xerces.apache.org.
To generate XML schema documentation (for big and middle sized XML schemas) using XSDDoc template set, you may need a powerful enough computer (e.g. with Intel Pentium 4 or AMD Athlon processor) and at least 512 MB RAM memory.
Note: | If you have a license for "XSDDoc" template application, you will be able to run it also in full mode even without a special license for DocFlex/XML SDK itself. |
Note: | To use XSDDoc without limitations, a separate license for it is required. |
However, you may use or further modify your trial templates once you have installed a Commercial or Academic License for DocFlex/XML SDK.
In addition, the Commercial License will allow you to clear your templates created/modified in trial mode from the limitation on execution by the reduced edition. To do this, you should resave the templates with the Template Designer after installing the new license.
You can use update_templates.bat
to upgrade all your templates at once in batch mode.
For more details, see the Template Designer command line options
(you can use also '-?'
argument in designer.bat
).
*.bat
files in DocFlex/XML root directory
to specify the JAVA_HOME
variable according to the location of
Java 7, Java 6, Java 5 or Java 1.4.x installed on your system.
DFH
variable to the absolute pathname
of the DocFlex/XML installation directory (e.g. set DFH=C:\docflex-xml-1.9.0
).
'docflex-xml.license'
, which you receive by e-mail,
to lib
directory. This file should be always near the docflex-xml.jar
file!
designer.bat
to launch Template Designer
or generator.bat
to run the template applications or samples.
*.sh
shell script files contained in linux
subdirectory to specify the JAVA_HOME
variable according to the location of
Java 7, Java 6, Java 5 or Java 1.4.x installed on your system.
For each shell script file, edit its "Permission" properties to allow it to be executed by Linux.
'docflex-xml.license'
, which you receive by e-mail,
to lib
directory. This file should be always near the docflex-xml.jar
file!
designer.sh
or generator.sh
!
generator.bat
. You will see the generator dialog.
XMLDoc.tpl
template.
Each XML file can be specified either by local path name or by URL. In the case of a URL, the generator will try to download such a file directly from the Internet. When multiple XML files are specified, make sure that each pathname or URL is enclosed in double quotes.
{docflex-xml}/templates/XSDDoc/README.html
| Running XSDDoc,
Documentation | XSDDoc
designer.bat
)
Sample | XML File | Template |
---|---|---|
Sales Report |
samples/sales/sales.xml
|
samples/sales/sales.tpl
|
Alternative to XSLT |
samples/personal/personal.xml
|
samples/personal/personal.tpl
|
XML Schema of Human Evolution |
samples/HumanEvolution/HumanEvolution.xsd
|
Run with both templates/XSDDoc/FramedDoc.tpl (HTML output)
and templates/XSDDoc/PlainDoc.tpl (RTF output).
This will look fun!
|
We are always happy to hear any questions, suggestions, comments, etc.
about this software.
Please, e-mail us to: support@docflex.com or
contact@filigris.com
{docflex-xml}/CHANGES.html