How to validate EPUB files: EpubCheck overview

EpubCheck is a tool used 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. EpubCheck project is hosted at https://github.com/IDPF/epubcheck.

All releases of EpubCheck are listed at https://github.com/IDPF/epubcheck/releases. You can download the EpubCheck .zip file from this page. There are few third-party apps which offer a graphical user interface (GUI) for EpubCheck. They are listed on the GUI Wiki page.

EpubCheck usage instructions are on the wiki at https://github.com/IDPF/epubcheck/wiki/Running.

You can follow the simple instructions given below to get started on validating your EPUB files:

  • Unzip the downloaded file into a folder on the hard drive e.g. a folder named "epubcheck"
  • Create a folder for the .epub files to be validated e.g. a folder named "test" on C: drive
  • Note that you can open DOS command prompt by typing cmd in the RUN dialog box. Type or paste the following in the command prompt:

    java -jar C:/epubcheck/epubcheck.jar C:/test/name of the .epub file

  • Assuming that you have created folders as suggested above and the name of the .epub file to be validated is "result.epub", the command line will be:

    java -jar C:/epubcheck/epubcheck.jar C:/test/result.epub

  • Press ENTER after typing/pasting this command line. EpubCheck will validate the given file and display error message or "no errors found" message in the command prompt window.

EpubCheck can also create an EPUB file from an archive along with validation. Instructions on running EpubCheck in advanced and extended mode can be found at https://github.com/IDPF/epubcheck/wiki/Running.

DAISYpedia Categories: 


This page was last edited by PVerma on Sunday, September 6, 2015 22:06
Text is available under the terms of the DAISY Consortium Intellectual Property Policy, Licensing, and Working Group Process.