Apache Maven PDF Plugin – pdf:aggregate

pdf:aggregate

Full name:

org.apache.maven.plugins:maven-pdf-plugin:1.6.1:aggregate

Description:

Forks pdf goal then aggregates PDF content from all modules in the reactor.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator plugin.
Requires dependency resolution of artifacts in scope: test.
The goal is thread-safe and supports parallel builds.
Since version: 1.5.
Invokes the execution of this plugin's goal pdf prior to executing itself.

Required Parameters

Name	Type	Since	Description
`<aggregatedOutputDirectory>`	`File`	`1.5`	Output directory where aggregated PDF files should be created. Default value is: `${project.build.directory}/pdf-aggregate`.
`<aggregatedWorkingDirectory>`	`File`	`1.5`	Working directory for aggregated working files like temp files/resources. Default value is: `${project.build.directory}/pdf-aggregate`.
`<generatedSiteDirectory>`	`File`	`1.1`	Directory containing generated sources for apt, fml and xdoc docs. Default value is: `${project.build.directory}/generated-site`.
`<implementation>`	`String`	`1.5`	Identifies the framework to use for pdf generation: either "fo" (default) or "itext". Default value is: `fo`. User property is: `implementation`.
`<outputDirectory>`	`File`	`1.5`	Output directory where PDF files should be created. Default value is: `${project.build.directory}/pdf`.
`<siteDirectory>`	`File`	`1.5`	Directory containing source for apt, fml and xdoc docs. Default value is: `${basedir}/src/site`.
`<workingDirectory>`	`File`	`1.5`	Working directory for working files like temp files/resources. Default value is: `${project.build.directory}/pdf`.

Optional Parameters

Name	Type	Since	Description
`<aggregate>`	`boolean`	`1.5`	If `true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.` Default value is: `true`. User property is: `aggregate`.
`<docDescriptor>`	`File`	`1.5`	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`. User property is: `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 value is: `true`. User property is: `includeReports`.
`<locales>`	`String`	`1.5`	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 is: `locales`.
`<remoteRepositories>`	`List`	`1.1`	The remote repositories where artifacts are located. Default value is: `${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 value is: `false`. User property is: `validate`.

Parameter Details

<aggregate>

If true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.

Type: boolean
Since: 1.5
Required: No
User Property: aggregate
Default: true

<aggregatedOutputDirectory>

Output directory where aggregated PDF files should be created.

Type: java.io.File
Since: 1.5
Required: Yes
Default: ${project.build.directory}/pdf-aggregate

<aggregatedWorkingDirectory>

Working directory for aggregated working files like temp files/resources.

Type: java.io.File
Since: 1.5
Required: Yes
Default: ${project.build.directory}/pdf-aggregate

<docDescriptor>

File that contains the DocumentModel of the PDF to generate.

Type: java.io.File
Since: 1.5
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
Since: 1.5
Required: Yes
User Property: implementation
Default: fo

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
Since: 1.5
Required: No
User Property: locales

<outputDirectory>

Output directory where PDF files should be created.

Type: java.io.File
Since: 1.5
Required: Yes
Default: ${project.build.directory}/pdf

<remoteRepositories>

The remote repositories where artifacts are located.

Type: java.util.List
Since: 1.1
Required: No
Default: ${project.remoteArtifactRepositories}

<siteDirectory>

Directory containing source for apt, fml and xdoc docs.

Type: java.io.File
Since: 1.5
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
Since: 1.5
Required: Yes
Default: ${project.build.directory}/pdf