Built by Maven

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
pdf:aggregate Forks pdf goal then aggregates PDF content from all modules in the reactor.
pdf:help Display help information on maven-pdf-plugin.
Call mvn pdf:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
pdf:pdf Generates a PDF document for a project documentation usually published as web site (with maven-site-plugin).

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.2.5
JDK 1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 1.6.0 to 1.6.1 3.2.5 8
1.5.1 3.1.1 8
1.4 2.2.1 6
1.3 2.2.1 5
1.2 2.0.9 5
from 1.0 to 1.1 2.0.6 1.4

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-pdf-plugin</artifactId>
          <version>1.6.2-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-pdf-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"