Apache Maven Plugin Usage
xnsdoc comes with support for Apache Maven 1.x. Support for Apache Maven 2.x will follow soon.
Setup xnsdoc as descibed at Installation as Apache Maven Plugin.
The plugin will document all W3C XML Schema files that are found
in your src folder. As needed, add some of the following xnsdoc properties to your
project.properties file:
| Property | Description |
|---|---|
| maven.xnsdoc.dest | Destination folder of documentation. Default value is |
| maven.xnsdoc.src |
Base source folder of schema files. Default value is |
| maven.xnsdoc.include | Pattern of schema files to include, relative to
property Default value is |
| maven.xnsdoc.exclude | Pattern of schema files to exclude, relative to
property Default value is empty. |
| maven.xnsdoc.header | Pattern of schema files to exclude, relative to
property Default value is empty. |
| maven.xnsdoc.bottom | Pattern of schema files to exclude, relative to
property Default value is empty. |
| maven.xnsdoc.footer | Pattern of schema files to exclude, relative to
property Default value is empty. |
| maven.xnsdoc.summary | Boolean, whether a summary section about success and failure is generated. Default value is |
| maven.xnsdoc.xsd.dest | Destination folder of schema files Default value is |
| maven.xnsdoc.xsd.include | Pattern of schema files to include when copying schema files
to target folder, relative to property Default value is |
| maven.xnsdoc.xsd.exclude | Pattern of schema files to exclude when copying schema files
to target folder, relative to property Default value is empty. |
| maven.xnsdoc.css | filename to optional external CSS file. Default value is empty. |
| maven.xnsdoc.catalogs | list of URIs to XML catalog files. Default value is empty. |
