This properties are used by the plugin and can be redefined by the user.
| Property name | Optional? | Description |
|---|---|---|
| maven.docs.src | Yes | The source directory for the
${maven.pdf.navigationFile} file and the user
xml documentations files. Defaults to
${basedir}/xdocs. |
| maven.docs.dest | Yes | The destination directory for PDF documentation. Images
are also copied from this directory. Defaults to
${maven.build.dir}/docs/. |
| maven.docs.outputencoding | Yes | The output encoding of the generated documentation.
Defaults to ISO-8859-1. |
| maven.gen.docs | Yes | The directory for generated xdocs. Defaults to
${maven.build.dir}/generated-xdocs/. |
| maven.pdf.pdfName | Yes | The name of pdf file. Defaults to
${pom.artifactId}.pdf. |
| maven.pdf.confidential | Yes | Add a confidential text to the footer of each page.
Defaults to false. |
| maven.pdf.paperType | Yes | Paper type for the generated PDF file. Defaults to
A4. |
| maven.pdf.companyIncName | Yes | The company name printed on each page footer beside the copyrigths.
Defaults to ${pom.organization.name}. |
| maven.pdf.copyrightYear | Yes | Defaults to ${pom.inceptionYear}. |
| maven.pdf.debug | Yes | Debug the pdf generation process. Defaults to
false. |
| maven.pdf.imageDpi | Yes | Defaults to 150. |
| maven.pdf.navigationFile | Yes | Filename for the navigation file used to generate the
PDF. Defaults to navigation.xml. |
| maven.pdf.projectLogo | Yes | Project logo URL (or relative path). Defaults to
${pom.url}${pom.logo}. |
| maven.pdf.companyLogo | Yes | Company logo URL (or relative path). Defaults to
${pom.organization.url}${pom.organization.logo}
|
| maven.pdf.cover.projectCompany | Yes | Company name printed on the cover. Defaults to
${pom.organization.name}. |
| maven.pdf.cover.projectName | Yes | Project name .Defaults to
${pom.name}. |
| maven.pdf.cover.type | Yes | Type of documentation. Defaults to
Project Documentation. |
| maven.pdf.cover.version | Yes | Project/Document version printed on the cover. Defaults
to ${pom.currentVersion}. |
| maven.pdf.cover.date | Yes | Defaults to current day. |