epub-conform

This is the start of an EPUB 2 test suite. The more recent EPUB 3 work can be found at: https://github.com/mgylling/epub-testsuite

epub-conform is a test suite that may be used to validate the conformance of EPUB Reading Systems.

EPUB, an IDPF standard, enables the creation and transport of reflowable digital books and other types of content as single-file digital publications that are interoperable between disparate EPUB-compliant reading devices and applications. EPUB encompasses a content container standard (Open Container Format – OCF), a packaging standard (Open Packaging Format – OPF), and a content markup standard (Open Publication Structure – OPS).

News

The test suite is in an early phase of development. Version 1.0.4 may now be checked out from the subversion repository. The tests are stored with a directory structure reflecting the structure within an EPUB. You will also find Perl-based scripts to compile these tests into EPUB form. For your convenience, a zip file containing the compiled EPUBs is available for download.

Some tests of the dir="rtl" attribute and direction:rtl CSS property have been incorporated, and a few bugs have been fixed.

Documentation

Until we have more formal documentation, please see the README files that are available in each of the major directories.

Here's an overview:

LicenseInfo/ contains the license that covers the scripts and tests.

Tests/ consists of a number subdirectories. The upper levels represent a hierarchical breakdown of the test types, e.g., generic HTML, OEB-specific markup, CSS, etc. The lower levels correspond exactly to the internal directory structure of an EPUB. Each test set is represented by a directory that contains a file named "mimetype". Scripts are made available to convert ("implode") test directories into a corresponding EPUB file.

Scripts/ contains two Perl scripts that can be run on pretty much any platform that has an info-zip-compatible zip program (a Windows-compatible zip.exe can be found here, as well).

• implode.pl converts the current directory (which must be the top of a test directory, evidenced by the presence of a "mimetype" file) into an EPUB. That EPUB file will be placed at the path specified as a required argument to the script.

• implodeall.pl traverses a directory, locating all test subdirectories and converting them into EPUB files. If invoked with no argument, traversal begins at the current directory. Otherwise, it begins at the specified directory. The EPUB file is stored in the parent directory of each test. In other words, when it finds ...

Tests/css2.1/s10.2/t0905-c5525-fltwidth-00-c-g/mimetype

...implodeall.pl will implode it, resulting in the creation/replacement of

Tests/css2.1/s10.2/t0905-c5525-fltwidth-00-c-g.epub

Once you have checked out a copy of epub-conform, you can generate all EPUBs by cd'ing to Scripts and running

perl implodeall.pl ../Tests

Acknowledgment

This test suite has been adapted from various test suites provided by W3C, namely the CSS Test Suites and the HTML4 Test Suite. We very much appreciate their work. Needless to say, we are following the BSD license provisions they have specified.

Authors

• The IDPF EPUB Maintenance Working Group.