com.github.rmannibucau:pdf-helper-maven-plugin

Sonatype helps open source projects to set up Maven repositories on https://oss.sonatype.org/

Categories

Categories

Maven Build Tools PDF Data
GroupId

GroupId

com.github.rmannibucau
ArtifactId

ArtifactId

pdf-helper-maven-plugin
Last Version

Last Version

0.1
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

Sonatype helps open source projects to set up Maven repositories on https://oss.sonatype.org/
Source Code Management

Source Code Management

https://github.com/rmannibucau/pdf-helper-maven-plugin

Download pdf-helper-maven-plugin

How to add to project

<plugin>
    <groupId>com.github.rmannibucau</groupId>
    <artifactId>pdf-helper-maven-plugin</artifactId>
    <version>0.1</version>
</plugin>

Dependencies

compile (4)

Group / Artifact Type Version
org.apache.maven : maven-plugin-api jar 3.2.3
org.apache.maven : maven-core jar 3.2.3
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.3
org.apache.pdfbox : pdfbox jar 1.8.8

test (4)

Group / Artifact Type Version
junit : junit jar 4.12
org.apache.maven.plugin-testing : maven-plugin-testing-harness jar 3.2.0
org.apache.maven : maven-compat jar 3.2.3
org.eclipse.aether : aether-api jar 1.0.1.v20141111

Project Modules

There are no modules declared in this project.

Goal

Be able to merge PDFs together (aggregation) easily.

Note
it uses PDFBox behind the scene.

Usage

Note
all parameters are optional.
<plugin>
  <groupId>com.github.rmannibucau</groupId>
  <artifactId>pdf-helper-maven-plugin</artifactId>
  <version>1.0-SNAPSHOT</version>
  <executions>
    <execution>
      <id>pdf-all-in-one</id>
      <phase>generate-resources</phase> <!-- default is package -->
      <goals>
        <goal>merge</goal>
      </goals>
      <configuration>
        <pdfs>
          <pdf>
            <location>foo/bar/pdf1.pdf</location>
            <title>Title 1</title>
            <titleSize>45</titleSize>
            <titleFont>Helvetica</titleFont>
            <description>Desc 1</description>
            <descriptionSize>15</descriptionSize>
            <descriptionFont>Helvetica-Bold</descriptionFont>
          </pdf>
          <pdf>
            <location>${project.build.directory}/generated-docs/pdf2.pdf</location>
            <title>Title 2</title>
          </pdf>
        </pdfs>
        <mavenPdfs>
          <pdf>
            <location>com.foo:bar:1.0:pdf</location>
            <title>Title 1</title>
            <description>Desc 1</description>
          </pdf>
        </mavenPdfs>
        <outputDir>${project.build.directory}/pdf</outputDir>
        <outputName>all-in-one</outputName>
        <attach>true</attach>
        <classifier /> <!-- classifier of the generated attached pdf -->
        <skip>false</skip>
      </configuration>
    </execution>
  </executions>
</plugin>
Note
If a title or a description is specified, the PDF will be prefixed by a "title" page.

Versions

Version
0.1