Validating an EPUB

Validating an EPUB

EPUBCheck is a tool to validate the conformance of EPUB publications against the EPUB specifications. EPUBCheck is open source software, maintained by the DAISY Consortium on behalf of the W3C.

There are 2 scripts available for invoking the EPUBCheck tool. They reside at the following directory location:

ROOTDIR = tang.umdl.umich.edu:/quod-prep/prep/a/acls/hebepub/winterberry

Each script allows for the specification of one or more path arguments. A path argument may be an EPUB file or a directory of an expanded EPUB file.

NOTE: If the path argument is a directory, EPUBCheck will first create a zip file of the directory and assign the directory name adding the extension .epub. If a file with the same name exists, the tool will overwrite the file without any warning.

See the descriptions below for each script:

• epubcheck_list - this script provides a simple interface to the EPUBCheck tool. Below is the script syntax:

  ROOTDIR/script/epubcheck_list <epub_file|epub_dir> [epub_file|epub_dir...]

  The tool is invoked for each path argument specified. The result of the validation is an XML file that is stored in the same directory that contains the specified argument. The name assigned to the result file is the same as the argument with the suffix _log.xml added.

  For example, the following command will validate the EPUB files /my_dir1/my_epub1.epub and /my_dir2/my_epub2.epub. The validation results are stored in the files /my_dir1/my_epub1_log.xml and /my_dir2/my_epub2_log.xml.

  ROOTDIR/script/epubcheck_list /my_dir1/my_epub1.epub /my_dir2/my_epub2.epub

• epubcheck - this script provides the full interface to the EPUBCheck tool. Below is the script syntax:

  ROOTDIR/script/epubcheck <options> <epub_file|epub_dir>

  All options are supported, but only one EPUB file or directory can be specified. See the EPUBCheck Wiki for the command line options and syntax.

  For example, the following command will validate the EPUB file /my_dir1/my_epub1.epub and store the validation results in the file /my_dir1/my_epub1_log.xml.

  ROOTDIR/script/epubcheck -q -o /mydir1/my_epub1_log.xml /my_dir1/my_epub1.epub