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.
README.html
|
this file |
*.bat
|
Windows command files prepared to run DocFlex/XML integrated with OxygenXML: |
generator.bat
|
|
designer.bat
|
|
linux/
|
Linux shell script files prepared to run DocFlex/XML+OxygenXML on Linux: |
linux/generator.sh
|
|
linux/designer.sh
|
|
ant/
|
Ant example files: |
ant/build.xml
|
|
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
|
|
maven/site.bat
|
|
Note: These files and directories can be found in 'integrations/OxygenXML/'
subdirectory of each edition of
DocFlex/XML.
Concerning which versions are supported, we have tested this integration starting from Oxygen XML 13. Actually, all comes down to the following:
schemaDocumentation.bat
(or schemaDocumentation.sh
under Linux) is included.
schemaDocumentation.bat
argument.
As long as those things remain the same in future OxygenXML version, the current integration will work with those version as well.
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.
generator.bat
and designer.bat
as follows:
'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
'OXYGENXML_HOME'
variable, specify the location of OxygenXML installation directory, e.g.:
set OXYGENXML_HOME=C:\Program Files\Oxygen XML Editor 15
'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.
|
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
linux/generator.sh
and linux/designer.sh
as follows:
'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"
'OXYGENXML_HOME'
variable, specify the location of OxygenXML installation directory, e.g.:
OXYGENXML_HOME="/home/user/Oxygen XML Editor 15"
'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.
|
generator.sh
(or designer.sh
) as a program.
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
{docflex-xml}\integrations\OxygenXML\ant\build.xml
to specify:
'OXYGENXML_HOME'
property set the location of OxygenXML installation directory.
make.bat
(in the same directory) to specify the locations of your Java and Ant installations
make.bat
Follow the installation instruction found in {docflex-xml}\integrations\maven\plugin\index.html
{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.
site.bat
If you have any questions, suggestions, etc., please let us know by sending an email to: support@docflex.com or contact@filigris.com