In {flexdoc-xml}/integrations/maven/plugin/ directory, depending on your OS, edit either

install.bat / install.command / install.sh

to specify the correct locations of your JDK and Maven installations.

Run that command file.
If everything is correct, the FlexDoc/XML Maven Plugin will be compiled and installed.

To test the plugin, in the same directory depending on your OS, edit either of

test.bat / test.command / test.sh

according to your Java and Maven locations and run it. The generator dialog should appear.

Usage

FlexDoc/XML Maven Plugin processes only three parameters:

<generatorParams>

The array of all command-line
arguments passed to the FlexDoc/XML generator (except those controlled by other two parameters).

Each command-line argument (which is either a
generator option name,
the option value or an input XML file) should be specified with a nested
<param> element in the same order as on the FlexDoc/XML generator
command-line.

<outputFolder>

Specifies the output directory name.

The plugin will convert the specified value into the absolute pathname of the output directory,
which is passed further both to Maven and to FlexDoc/XML Generator (via
-d option).

<outputFile>

Specifies the name of the main output file.

The plugin will pass the specified value directly to FlexDoc/XML Generator (via
-f option).
It will be also converted into the absolute pathname and passed to Maven
(exactly that pathname will be linked from the Maven-generated “Project Reports” page).

The FlexDoc/XML Maven Plugin provides only one goal 'generator',
which launches the FlexDoc/XML Generator.

Since FlexDoc/XML Generator requires a lot of memory
(especially when processing big template applications) and it will be executed by the same JVM as Maven,
you need to ensure that the Maven's JVM maximum memory heap size is large enough.

You can specify this by setting 'MAVEN_OPTS' variable in a Windows command file
that starts the Maven. For example:

MAVEN_OPTS=-Xms256m -Xmx512m

In a Linux shell script file, the same should be specified as the following:

export MAVEN_OPTS="-Xms256m -Xmx512m"

The lack of memory may cause the FlexDoc/XML Generator to slow down very much
(especially, when processing a big template application like XSDDoc)
and lead eventually to java.lang.OutOfMemoryError exception!

According to our tests, allowing 512 Mb heap size on 32-bit Java is OK in most cases
(e.g. running XSDDoc to document large XML schemas).
However, for 64-bit Java (running on 64-bit OS) this amount must be doubled.
So, you should specify -Xmx1024m, instead of -Xmx512m.

Example 1

This example shows how to configure the FlexDoc/XML Maven Plugin in a project POM file
so as to generate using XSDDoc template set the XML schema documentation by
XML Schemas for WSDL 1.1
that would appear on the “Project Reports” page of a Maven-generated project site.

<!--Specifying the data source XML files to be processed.The following files will be loaded directly from Internet by the given URLs.-->

<param>http://schemas.xmlsoap.org/wsdl/</param>

<param>http://schemas.xmlsoap.org/wsdl/soap/</param>

<param>http://schemas.xmlsoap.org/wsdl/http/</param>

<param>http://schemas.xmlsoap.org/wsdl/mime/</param>

</generatorParams>

<!--Specify the output directory name.The plugin will convert it into the absolute pathname of the output directory,which is passed further both to Maven and to FlexDoc/XML Generator (via -d option).-->

<outputFolder>xsddoc</outputFolder>

<!-- For the Maven project-reports page -->

<name>XSDDoc</name>

<description>XML Schemas for WSDL 1.1</description>

</configuration>

</plugin>

</plugins>

</reporting>

...

</project>

This complete working example is included in FlexDoc/XML archive prepared for downloads.

<!--Specifying the FIRST REPORT: "Sales Report".(The name of the <reportSet> element is actualy misleading here.Only one report we can define within this element.)-->

<reportSet>

<!--The <id> element must be always specified and unique!Otherwise, only one report will be generated by the plugin.-->

<id>report</id>

<configuration>

<!-- Specifying command-line parameters for FlexDoc/XML Generator -->

<generatorParams>

<!-- The main template -->

<param>-template</param>

<param>${FDH}/samples/sales/sales.tpl</param>

<!-- The output format -->

<param>-format</param>

<param>HTML</param>

<!-- Suppress showing up the generator GUI -->

<param>-nodialog</param>

<!-- Suppress most of generator's messages -->

<param>-quiet</param>

<!-- The input XML file with the report's data -->

<param>${FDH}/samples/sales/sales.xml</param>

</generatorParams>

<!--Specify the output directory name.The plugin will convert it into the absolute pathname of the report'soutput directory, which will be passed both to Maven and to FlexDoc/XMLGenerator (via -d option).-->

<outputFolder>sales</outputFolder>

<!--Specify the name of the main output file.The plugin will pass it directly to FlexDoc/XML Generator (via -f option).It will be also converted into the absolute pathname and passed to Maven(exactly that pathname will be linked from the project-reports page).-->

<outputFile>report</outputFile>

<!-- For the project-reports page -->

<name>Sales Report</name>

<description>The sales report generated from sales.xml</description>

</configuration>

<!--Specifying the plugin's goal.(It is necessary here. Otherwise, nothing will be generated.)-->

<reports>

<report>generator</report>

</reports>

</reportSet>

<!--Now, we specify the generation of the SECOND REPORT.This will be the XSDDoc (XML schema documentation) generated for the XML schemathat describes the 'sales.xml' file used in the first report. (The 'sales.tpl'template, which actually generates the first report, is based on that schema.)-->

<reportSet>

<!-- The <id> is required and must be unique for each <reportSet> -->

<id>xsddoc</id>

<configuration>

<!-- The FlexDoc/XML Generator's command-line parameters -->

<generatorParams>

<!-- The main template -->

<param>-template</param>

<param>${FDH}/templates/XSDDoc/FramedDoc.tpl</param>

<!-- Pass template parameter: the documentation title -->

<param>-p:docTitle</param>

<param>Sales XML Schema</param>

<!-- Specify the output format -->

<param>-format</param>

<param>HTML</param>

<!-- Show no generator GUI and few messages -->

<param>-nodialog</param>

<param>-quiet</param>

<!--The input XML file to process (i.e. the XML schema to be documented)-->

<param>${FDH}/samples/sales/sales.xsd</param>

</generatorParams>

<!-- Specifying the report's output directory and file -->

<outputFolder>sales</outputFolder>

<outputFile>xsddoc</outputFile>

<!-- For the project-reports page -->

<name>Sales XSDDoc</name>

<description>XML schema for sales.xml</description>

</configuration>

<!-- Specifying the required plugin's goal -->

<reports>

<report>generator</report>

</reports>

</reportSet>

</reportSets>

</plugin>

</plugins>

</reporting>

...

</project>

This complete working example is included in FlexDoc/XML archive prepared for downloads.