veraPDF-model-syntax

This project provides domain specific language support for the veraPDF PDF/A and PDF/UA validation model. The DSL is developed with Xtext including spell checking, word completion, syntax colouring and generation of Java interfaces from the model.

CI Status

Pre-requisites

In order to make use of the DSL support you'll require

• Java 11 or 17, which can be downloaded from Oracle, or for Linux users OpenJDK.
• The Eclipse IDE with the Xtext plug-in. If you haven't installed Eclipse then we recommend downloading the Xtext Eclipse distribution.

Installation of DSL Support in Eclipse

To get veraPDF-model support in Eclipse :

1. Download the veraPDF-model-syntax repository, either cloning via Git git clone https://github.com/veraPDF/veraPDF-model-syntax or downloading the latest zip archive from GitHub.

2. Copy the plugins from veraPDF-model-syntax/eclipse_plugins to {eclipse_directory}/dropins. See Equinox/p2/Getting Started for more details.

3. Restart Eclipse.

Your Eclipse installation should now support {formal_syntax_name} with syntax checking and colouring, auto-completion, and generation of Java interfaces from the model classes (should have .mdl extension).

Importing the veraPDF Validation Model

To begin working with the veraPDF model:

1. Download the veraPDF-model repository, either cloning via Git git clone https://github.com/veraPDF/veraPDF-model or downloading the latest zip archive from GitHub.

2. Launch Eclipse and import the model into your Eclipse workspace: File -> Import... -> General -> Existing Projects into Workspace.

The model classes are placed in src/main/java.