Apache Maven 1.x has reached its end of life, and is no longer supported. For more information, see the announcement. Users are encouraged to migrate to the current version of Apache Maven.

Maven PDF Plug-in

This plug-in allows you to generate a PDF version of your project's documentation.

To enable PDF generation add the following to your maven.xml

<postGoal name="site">
  <attainGoal name="pdf"/>
</postGoal>

You can also add the PDF generation to your project.xml like this : 

<reports>
  <report>maven-pdf-plugin</report>
<reports>

The links to the pdf file in the reports page and in the reports menu are correct only if the xdoc plugin 1.10 or above is used.

Take a look at goals, properties and the FAQ to see how to customize it.

Known issues

  • 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. Widths are uniformly distributed.
  • Due to several problems, it is actually impossible to reference the same file in different items in navigation.xml. You must define another navigation file (using the property "maven.pdf.navigationFile") which you'll use only with the PDF plug-in. This navigation cannot define several items with the same href.
  • Identical id attributes within one document will lead to a build failure.
  • Contrary to the xdoc plugin, the pdf plugin does not generate anchors from section or subsection names. If you want to reference a section or subsection you have to use the optional id tag.
  • Other issues are available in Jira.