Validation tool for EPUB
HTML Java CSS Python XSLT JavaScript Other
Clone or download
tofi86 Run Travis Tests also with JDK 10
not sure yet which version is supported by Travis ATM
Latest commit c19b639 May 5, 2018

README.md

Current Release Github All Releases Downloads Build Status


⚠️ We're running out of code maintainers by the end of 2017 and are actively looking for new developers! ⚠️ Are you interested? Please have a look at the Welcome, Contribute or Translate wiki pages. Thank you!


EpubCheck

EpubCheck is a tool to validate EPUB files. It can detect many types of errors in EPUB. OCF container structure, OPF and OPS mark-up, and internal reference consistency are checked. EpubCheck can be run as a standalone command-line tool or used as a Java library.

Downloads

Check the releases page to get the latest distribution.

EpubCheck 4.0.2 is the latest recommended version to validate both EPUB 2 and 3 files.

Documentation

Documentation on how to use EpubCheck, to contribute to the project or to translate messages is available on the EpubCheck wiki.

Technical discussions are held on our public email list. To subscribe to the email list, send an email with subject subscribe to public-epubcheck-request@w3.org. To participate in the discussion, simply send an email to public-epubcheck@w3.org.

Historical archives of discussions prior to October 2017 are stored at the old EpubCheck Google Group. An archive of the email list beginning in October 2017 can be found at https://lists.w3.org/Archives/Public/public-epubcheck/.

Development

The EpubCheck project is coordinated by the W3C EPUB 3 Community Group. The lead developers on this projects are:

There is currently a severe shortage of developers working on the tool, however. The project only has approximately 1/3 FTE in developer time allocated to its maintenance and development through its leads. This is barely enough to handle critical bug fixes, and not nearly enough to undertake the necessary upgrades needed to keep the tool relevant, such as developing support for EPUB 3.1.

If you, or your organization, benefits from the ability to check your EPUB publications against the standards, please consider contributing to the development of this important tool.

For more information on how to get involved, please see the wiki page on contributing.

Credits

Most of the EpubCheck functionality comes from the schema validation tool Jing and schemas that were developed by IDPF and DAISY. Initial EpubCheck development was largely done at Adobe Systems.

Initial (pre 2012) authors and contributors to EpubCheck include:

Peter Sorotokin, Garth Conboy, Markus Gylling, Piotr Kula, Paul Norton, Jessica Hekman, Liza Daly, George Bina, Bogdan Iordache, Ionut-Maxim Margelatu

EpubCheck 4.0 was largely developed by

Regular contributors between 2012 and 2017 include:

Romain Deltour, Tobias Fischer, Markus Gylling, Thomas Ledoux, Masayoshi Takahashi, Satoshi KOJIMA

Many thanks are also extended to the numerous people who have contributed to the evolution of EpubCheck through bug reports and patches.

License

EpubCheck is made available under the terms of the New BSD License


Building EpubCheck

To build epubcheck from the sources you need Java Development Kit (JDK) 1.7 or above and Apache Maven 3.0 or above installed. On Windows, you should build in a git bash shell (see http://github.com help)

You will also need Python to be able to run the BookReporter and related tools.

Build and run tests:

$ mvn install

Will copy .*jar files and packages to target/ folder...