XML Calabash 3.x
This is XML Calabash 3.x, a conformant implementation of XProc 3.1.
XML Calabash implements the standard step library and the additional step libraries: dynamic pipelines (p:run), file steps, OS steps, mail steps, paged media steps, text steps, validation steps, and iXML steps. It also ships with a number of extension steps.
Instructions for installing and running the command line application are in the User Guide. The Reference Guide describes all of the steps and other details.
API docs are available, but at this point, the API should be considered unstable and liable to change in arbitrary ways.
The test report provides some insights into what is expected to work and what is known to be broken.
Quick start
XML Calabash requires Java 11 or later. Everything else is in the distribution.
- Download the latest release. You need
xmlcalabash-3.X.Y.zipwhere "X" and "Y" are the release number (for example, 3.0.0). The other zip files on the release page are extension steps with additional third party dependencies. You have to download them too, if you want to use those steps. - Unzip it somewhere on your local file system.
- Run
java -jar xmlcalabash-app-3.X.Y.jar helpto see a quick list of the options. - Run
java -jar xmlcalabash-app-3.X.Y.jar helloWorld.xplto run the sample pipeline.
There are more complete instructions in the User Guide.
Running the main class
The main class for the command line application is com.xmlcalabash.app.Main.
You can run that class directly, but you’ll have to setup the classpath by hand.
You can find the necessary jar files in the release archive. Dependencies
are discussed in the Reference Guide.
Using with Maven
Maven releases are available Maven Central.
Snapshot releases of current development are available from the snapshot repository.
Reporting issues
Please open issues for any problems you encounter. There are going to be bugs, so it’s probably not you.