pdf:pdf

Full name:

org.apache.maven.plugins:maven-pdf-plugin:1.1: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
generatedSiteDirectory File 1.1 Directory containing generated sources for apt, fml and xdoc docs.
Default value is: ${project.build.directory}/generated-site.
implementation String - Identifies the framework to use for pdf generation: either "fo" (default) or "itext".
Default value is: fo.
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.
generateTOC String 1.1 Generate a TOC (Table Of Content) for all items defined in the <toc/> element from the document descriptor.
Possible values are: 'none', 'start' and 'end'.
Default value is: start.
includeReports boolean 1.1 If true, generate all Maven reports defined in ${project.reporting} and append them as a new entry in the TOC (Table Of Contents). Note: Including the report generation could fail the PDF generation or increase the build time.
Default value is: true.
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.
remoteRepositories List 1.1 The remote repositories where artifacts are located.

Parameter Details

aggregate:

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

docDescriptor:

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

generateTOC:

Generate a TOC (Table Of Content) for all items defined in the <toc/> element from the document descriptor.
Possible values are: 'none', 'start' and 'end'.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${generateTOC}
  • Default: start

generatedSiteDirectory:

Directory containing generated sources for apt, fml and xdoc docs.
  • Type: java.io.File
  • Since: 1.1
  • Required: Yes
  • Default: ${project.build.directory}/generated-site

implementation:

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

includeReports:

If true, generate all Maven reports defined in ${project.reporting} and append them as a new entry in the TOC (Table Of Contents). Note: Including the report generation could fail the PDF generation or increase the build time.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Expression: ${includeReports}
  • Default: true

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

remoteRepositories:

The remote repositories where artifacts are located.
  • Type: java.util.List
  • Since: 1.1
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

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