pdf:pdf

Full name:

org.apache.maven.plugins:maven-pdf-plugin:1.0:pdf

Description:

Generates a PDF document for a project.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
implementation String - Identifies the framework to use for pdf generation: either "fo" (default) or "itext".
Default value is: fo.
localRepository ArtifactRepository - The local repository.
outputDirectory File - Output directory where PDF files should be created.
Default value is: ${project.build.directory}/pdf.
siteDirectory File - Directory containing source for apt, fml and xdoc docs.
Default value is: ${basedir}/src/site.
workingDirectory File - Working directory for working files like temp files/resources.
Default value is: ${project.build.directory}/pdf.

Optional Parameters

Name Type Since Description
aggregate boolean - If true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.
Default value is: true.
docDescriptor File - File that contains the DocumentModel of the PDF to generate.
Default value is: src/site/pdf.xml.
locales String - A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
pluginVersion String - (no description)

Parameter Details

aggregate:

If true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.
  • Type: boolean
  • Required: No
  • Default: true

docDescriptor:

File that contains the DocumentModel of the PDF to generate.
  • Type: java.io.File
  • Required: No
  • Default: src/site/pdf.xml

implementation:

Identifies the framework to use for pdf generation: either "fo" (default) or "itext".
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${implementation}
  • Default: fo

localRepository:

The local repository.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: Yes
  • Expression: ${localRepository}

locales:

A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
  • Type: java.lang.String
  • Required: No
  • Expression: ${locales}

outputDirectory:

Output directory where PDF files should be created.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/pdf

pluginVersion:

(no description)
  • Type: java.lang.String
  • Required: No
  • Expression: ${plugin.version}

siteDirectory:

Directory containing source for apt, fml and xdoc docs.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}/src/site

workingDirectory:

Working directory for working files like temp files/resources.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/pdf