Built by Maven

pdf:pdf

Full name:

org.apache.maven.plugins:maven-pdf-plugin:1.6.2-SNAPSHOT:pdf

Description:

Generates a PDF document for a project documentation usually published as web site (with maven-site-plugin).

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.5.

Required Parameters

Name Type Since Description
<generatedSiteDirectory> File 1.1 Directory containing generated sources for apt, fml and xdoc docs.
Default: ${project.build.directory}/generated-site
<implementation> String - Identifies the framework to use for pdf generation: either "fo" (default) or "itext".
Default: fo
User Property: implementation
<outputDirectory> File - Output directory where PDF files should be created.
Default: ${project.build.directory}/pdf
<siteDirectory> File - Directory containing source for apt, fml and xdoc docs.
Default: ${basedir}/src/site
<workingDirectory> File - Working directory for working files like temp files/resources.
Default: ${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: true
User Property: aggregate
<docDescriptor> File - File that contains the DocumentModel of the PDF to generate.
Default: 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: start
User Property: generateTOC
<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: true
User Property: includeReports
<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.
User Property: locales
<remoteRepositories> List<ArtifactRepository> 1.1 The remote repositories where artifacts are located.
Default: ${project.remoteArtifactRepositories}
<validate> boolean 1.2 Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.
Default: false
User Property: validate

Parameter Details

<aggregate>

If true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.
  • Type: boolean
  • Required: No
  • User Property: 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
  • User Property: 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
  • User Property: 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
  • User Property: 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
  • User Property: 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<org.apache.maven.artifact.repository.ArtifactRepository>
  • Since: 1.1
  • Required: No
  • Default: ${project.remoteArtifactRepositories}

<siteDirectory>

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

<validate>

Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: validate
  • Default: false

<workingDirectory>

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