DocFlex/XML OxygenXML Integration, Version 1.0


Table Of Contents


About OxygenXML Integration

The integration of DocFlex/XML with Oxygen XML is a special add-on to the DocFlex/XML core that allows users to automatically insert the graphics diagrams produced by OxygenXML into the XML schema documentation generated by DocFlex/XML XSDDoc (with the full support of diagram hyperlinks).

The integration works by calling OxygenXML's own documentation generator for the specified XML schemas, by which it generates the XSD diagrams along with some intermediate XML file (containing all the data, image references and hypertext image maps) supposed for further processing. That XML file is analyzed so as to associate the diagram images (and image map links) with particular DSM elements representing XML schema components in templates. That makes the diagrams and their hyperlinks available through Image Controls (as "element images") to be inserted in the output documentation generated by DocFlex/XML.

Since OxygenXML Integration is closely connected with the DocFlex/XML core, all Java classes implementing it are included in the general DocFlex/XML Java library: docflex-xml.jar. However, in order to use it, a separate setup and license are required.

For all details about the OxygenXML Integration, please see: www.filigris.com | DocFlex/XML | Integrations | Oxygen XML.

Content Files

README.html this file
*.bat Windows command files prepared to run DocFlex/XML integrated with OxygenXML:
generator.bat
  • Starts the generator from command line
designer.bat
  • Launches the Template Designer (all OxygenXML-related functions will be active and you can invoke the generator integrated with OxygenXML)
linux/ Linux shell script files prepared to run DocFlex/XML+OxygenXML on Linux:
linux/generator.sh
  • Starts the generator
linux/designer.sh
  • Launches the Template Designer
ant/ Ant example files:
ant/build.xml
  • The Ant build file that demonstrates how to call the unified DocFlex/XML+OxygenXML documentation generator from the Apache Ant so as to generate an XML Schema documentation with diagrams.
ant/make.bat
maven/ A demo project that shows how to configure the unified DocFlex/XML+OxygenXML Maven plugin to generate an XML Schema documentation with diagrams for the reports section of a Maven-generated site:
maven/pom.xml
  • The project POM file
maven/site.bat

Note: These files and directories can be found in 'integrations/OxygenXML/' subdirectory of each edition of DocFlex/XML.

Technical Requirements

Licensing / Processing Modes

Being a complex piece of software that took lots of efforts to develop, the OxygenXML Integration requires a separate licensing. Depending on your license, the integration may work in one of two different modes: full or trial.

Full Mode

The Full Mode is activated in the presence of a Commercial or Academic License for "DocFlex/XML OxygenXML Integration".

This mode allows you to use the integration without any limitations. Once it is enabled, you may think about the integration as yet another part of DocFlex/XML executables.

Anything else will depend on other your licenses.

Trial Mode

The Trial Mode is activated in the presence of a Trial License for "DocFlex/XML OxygenXML Integration". In this mode, the integration will work the same as in the full mode. However, no matter what your other licenses are, the following limitations will be enforced: The trial mode for OxygenXML Integration will not affect your possibility to create/modify templates. This is controlled by your license for DocFlex/XML SDK!

Installation (Windows)

Edit generator.bat and designer.bat as follows:
  1. In 'JAVA_HOME' variable, specify the location of your Java 7, Java 6 or Java 5 installation directory, e.g.:
    set JAVA_HOME=C:\Program Files\Java\jre7
  2. In 'OXYGENXML_HOME' variable, specify the location of OxygenXML installation directory, e.g.:
    set OXYGENXML_HOME=C:\Program Files\Oxygen XML Editor 15
  3. Copy the OxygenXML Integration license file 'docflex-xml-oxygenxml.license', which you receive by e-mail, to the {docflex-xml}\lib directory (near the docflex-xml.jar file).

    Note: The license for OxygenXML Integration may be also included in a combined 'docflex-xml.license' file (along with other licenses), which should be also installed in the same location.

Now, you can start generator.bat to run DocFlex/XML generator integrated with OxygenXML.

For further specific details about setting up OxygenXML Integration, please see: www.filigris.com | DocFlex/XML | Integrations | Oxygen XML

Installation (Linux)

Edit linux/generator.sh and linux/designer.sh as follows:
  1. In 'JAVA_HOME' variable, specify the location of your Java 7, Java 6 or Java 5 installation directory, e.g.:
    JAVA_HOME="/home/user/jdk1.7"
  2. In 'OXYGENXML_HOME' variable, specify the location of OxygenXML installation directory, e.g.:
    OXYGENXML_HOME="/home/user/Oxygen XML Editor 15"
  3. Copy the OxygenXML Integration license file 'docflex-xml-oxygenxml.license', which you receive by e-mail, to the {docflex-xml}/lib directory (near the docflex-xml.jar file).

    Note: The license for OxygenXML Integration may be also included in a combined 'docflex-xml.license' file (along with other licenses), which should be also installed in the same location.

  4. Set a permission to allow executing generator.sh (or designer.sh) as a program.
Now, you can start generator.sh to run DocFlex/XML generator integrated with OxygenXML.

For further specific details about setting up OxygenXML Integration, please see: www.filigris.com | DocFlex/XML | Integrations | Oxygen XML

Running Ant Demo

  1. Edit {docflex-xml}\integrations\OxygenXML\ant\build.xml to specify:

  2. Edit make.bat (in the same directory) to specify the locations of your Java and Ant installations
  3. Run make.bat
For more details about running DocFlex/XML+OxygenXML with Apache Ant, please see:
www.filigris.com | DocFlex/XML | Integrations | Oxygen XML | Generator Setups | Running with Apache Ant

Running Maven Demo

  1. Install DocFlex/XML Maven Plugin.

    Follow the installation instruction found in {docflex-xml}\integrations\maven\plugin\index.html

  2. In {docflex-xml}\integrations\OxygenXML\maven\ directory:

    Edit pom.xml to specify the absolute pathname of your OxygenXML installation directory in the following line:

    <!-- OxygenXML home directory -->
    <OXYGENXML_HOME>C:\Program Files\Oxygen XML Editor 15</OXYGENXML_HOME>
    Edit site.bat to specify the locations of your Java and Maven installations.

  3. Run site.bat
For more details about running DocFlex/XML+OxygenXML with Apache Maven, please see:
www.filigris.com | DocFlex/XML | Integrations | Oxygen XML | Generator Setups | Running with Apache Maven

Getting Help

The most detailed and up-to-date information about the OxygenXML Integration can be found on this page: www.filigris.com | DocFlex/XML | Integrations | Oxygen XML.

If you have any questions, suggestions, etc., please let us know by sending an email to: support@docflex.com or contact@filigris.com


Copyright© 2013 Filigris Works, Leonid Rudy Softwareprodukte.
To contact us, please visit www.filigris.com or e-mail to: contact@filigris.com