veraPDF-library

Definitive PDF/A Validation

Licensing

The veraPDF PDF/A Validation Library is dual-licensed, see:

• GPLv3+
• MPLv2+

CI Status

• Travis-CI: master

• Travis-CI: integration

• OPF Jenkins: release-0.4

• OPF Jenkins: integration

Pre-requisites

In order to run the applications or use the GUI you'll need:

• Java 7, which can be downloaded from Oracle, or for Linux users OpenJDK.

If you want to build the code from source you'll also require:

• Maven v3+

Building and Running the veraPDF-library

Building from source

1. Download the veraPDF-library repository, either:

git clone https://github.com/veraPDF/veraPDF-library

or download the latest tar archive or zip equivalent from GitHub.

2. Move to the downloaded project directory, e.g.

cd veraPDF-library

3. Build and install using Maven:

mvn clean install -P clone-test-resources

Running the command line validation application

1. Move to the build directory for the command line interface application, e.g.:

cd {project directory}/cli/target

2. Run the compiled command line application:

java -jar vera-cli-1.0-SNAPSHOT-jar-with-dependencies.jar verapdf --validate --input "{path to input pdf file}" --profile "{path to validation profile}" --output "{path to saved report}"

Building & obtaining the veraPDF-library-GUI zip package

The latest release of the GUI zip package is available from our release download area, using this link. The latest development build can be downloaded from our development download directory via this link.

If you've built the project from source then the GUI application is available in the VeraPDF Library GUI gui sub-module. The example commands are linux based:

1. Move to the build directory for the command line interface application, e.g.:

cd {project directory}/gui/target

2. Locate the built zip package, e.g.:

ls veraPDF-library-GUI-*.zip

Unpacking & using the GUI package

Again the example commands assume the user is linux based and use a specific 0.4.9 version number, you will quite possibly download another version.

1. Unzip the archive to a location that can be used for installation, e.g.

unzip veraPDF-library-GUI-0.4.9.zip -d /home/username

2. The scripts to run the GUI application are located under install-directory/bin:

• Mac or Linux users can run: VeraPDF validation GUI
• Windows users should run: VeraPDF validation GUI.bat

3. In order to perform validation you'll need to load a validation profile. Currently the GUI package comes with a copy of our PDF/A-1b validation profile. This is located under the install/unzip directory:

install-directory/resources/veraPDF-validation-profiles-integration/PDF_A/PDFA-1B.xml

The zip package contains the latest versions, at the time of packaging, of the following resources:

• the staging branch of the veraPDF-corpus project;
• the integration branch of the veraPDF-validation-profiles project; and
• the integration branch of the veraPDF-model project.