diff --git a/pdf/plugin.jelly b/pdf/plugin.jelly
index 9ec2131f..22ac551f 100644
--- a/pdf/plugin.jelly
+++ b/pdf/plugin.jelly
@@ -12,7 +12,6 @@
- This plug-in allows you to generate a PDF version of your project's
- documentation.
-
- There is a known problem with the PDF generation tool (Apache's FOP)
+ This plug-in allows you to generate a PDF version of your project's
+ documentation. There is a known problem with the PDF generation tool (Apache's FOP)
in that it doesn't allow for table structures with automatic column
- widths to be generated. This means that currently, documents with
- tables will be missing content.
-
- Another issue is that the documentation is only the top level of
- the documentation generated.
-
This properties are used by the plugin and can be redifned by the user.
+This properties are used by the plugin and can be redifned by + the user.
| Property name | @@ -16,104 +17,118 @@|||
|---|---|---|---|
| maven.docs.src | Yes | -The source directory for the ${maven.pdf.navigationFile} file and the user xml documentations files. Defaults to ${basedir}/xdocs. |
+ 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 copied fom this directory. Defaults to ${maven.build.dir}/docs/. |
+ 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. |
+ 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/. |
+ 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. |
+ The name of pdf file. Defaults to
+ ${pom.artifactId}.pdf. |
| maven.pdf.confidential | Yes | -Usage not yet implemented. Defaults to false. |
+ 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.companyName | -Yes | -Defaults to ${pom.organization.name}. |
+ Paper type for the generated PDF file. Defaults to
+ A4. |
| maven.pdf.companyIncName | Yes | -Defaults to ${pom.organization.name}. |
+ 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.debug | -Yes | -Debug pdf generation process. Defaults to false. |
- |
| maven.pdf.navigationFile | Yes | -Filename for the navigation file used to generate the PDF. Defaults to navigation.xml. |
+ 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 | -Usage not yet implemented.Defaults to ${pom.organization.name}. |
+ Company name printed on the cover. Defaults to
+ ${pom.organization.name}. |
| maven.pdf.cover.projectName | Yes | -Usage not yet implemented.Defaults to ${pom.name}. |
+ Project name .Defaults to
+ ${pom.name}. |
| maven.pdf.cover.type | Yes | -Usage not yet implemented.Defaults to Project Documentation. |
+ Type of documentation. Defaults to
+ Project Documentation. |
| maven.pdf.cover.version | Yes | -Usage not yet implemented.Defaults to ${pom.currentVersion}. |
+ Project/Document version printed on the cover. Defaults
+ to ${pom.currentVersion}. |
| maven.pdf.cover.date | Yes | Defaults to current day. | |
| maven.pdf.projectLogo | -Yes | -Usage not yet implemented.Defaults to ${pom.url}${pom.logo}. |
- |
| maven.pdf.companyLogo | -Yes | -Usage not yet implemented.Defaults to ${pom.organization.url}${pom.organization.logo}
- |
-