EPUBCheck 3.0 Information

Current version: 3.0b5

About

EpubCheck 3.0 is the continuation of the EpubCheck 1.2 project, upgraded to support validation of EPUB 3.0 content besides the legacy EPUB 2.0.

At the time of this writing, the available build has a graduated from being a development build to being the stable build, recommended for both EPUB 2.0(1) and 3.0 validation.

Besides supporting both EPUB 2 and 3, another new feature added to EpubCheck 3.0 is single file validation. Currently, the following types are supported: OPF/Package Documents, XHTML, SVG, Navigation Documents and Media Overlay documents (the latter two naturally supported only in EPUB 3.0 mode).

EpubCheck 3.0 also supports validation of an unzipped EPUB with the possibility to save the created EPUB archive. Note that if your unzipped input EPUB is found to be invalid, then the created archive will be discarded.

Running

To run the tool you need java (1.5 or above). Any OS should do. Run it from the command line: All detected errors are simply printed to stderr.

basic mode:

java -jar epubcheck-3.0b5.jar file.epub

advanced mode:

java -jar epubcheck-3.0b5.jar file -mode MODE -v VERSION

where MODE must be one of the following:

• opf for package document validation;
• nav for navigation document validation (available only for version 3.0);
• mo for media overlay validation (available only for version 3.0);
• xhtml;
• svg;
• exp for Expanded EPUB validation;

When using -mode exp, one could add an extra flag -save to save the created archive upon validation:

java -jar epubcheck-3.0b5.jar dir -mode exp -save

VERSION must be 2.0 or 3.0. Additional flags:

-help displays a help message;

Note that when validating a single file, only a subset of the available tests is run. Also, when validating a full EPUB, both mode and version are ignored.

Contributing to EpubCheck

If you'd like to contribute to the epubcheck project, then there's some things you'll probably want to do:

• Join the discussion group for epubcheck
• Get the current build
• Document problems under Issues and submit test cases that expose these problems, either as full .epub archives, or as single files.