Documentation

E-book QC

Check the following to confirm the quality of an e-book.

General Checks

Validation

Use the ePub Validator tool in the Digital Hub.

EPubs can also be validated using the IDPF online validator or a locally installed version of EpubCheck.

Check for common validation errors such as: dead or incorrect links; images or files in the package but not declared in the manifest section of the OPF file—every ePub directory should contain only the files necessary for the ePub.

Use the CSS Lint online validator or another validation method to confirm that there are no errors.

Device Review

Review in the following devices and apps: Chrome Readium; iPad; Nook; Kindle

Table of Contents

Styles

Do a page-by-page review.

Are those styles defined correctly in the CSS?

Page Breaks

Irregular page breaks may be due to the automatic division of oversized files.

To ensure proper layout on an iPad, each section that should start on a new page should be in its own HTML file. Scribe’s default standard is to optimize all ePubs for the iPad.

For an ePub to meet the requirements for Apple’s iBooks Store, no individual HTML file can be larger than 300KB.

Heads

Lists

If not, identify which list classes are not displaying properly and locate them in the CSS to look for possible causes.

Tables

Examples: Border vs. no border; do columns have appropriate proportions?

Tables with more than four columns might not render well on reading devices and might be cut off. Search the HTML files for tags, if necessary, to locate all tables.

Notes

URLs

If found, the link should either be corrected or commented out.

Cross-References

Examples: “See [chapter, figure, map, etc.]”

Indexes

Foreign Characters

Check for any instances of combining unicode.

Check for images replacing characters (e.g., images of Hebrew text).

Ellipses

Device Navigation Items (NCX/toc.xhtml)

Note: toc.xhtml supercedes NCX in Epub 3.

Image Checks

Cover

Unless otherwise specified, the cover image should be a maximum of 1800 pixels on its largest side (and should never have any side smaller than 500 pixels).

The image dimensions should not be in the HTML.

A max-height percent should be specified in the CSS to constrain the default display size (this is currently in the default CSS).

Dimensions

If figure images are larger than 600 pixels in either dimension, a max-height or max-width percent should be specified (inline or in the CSS) to constrain the default display size.

3. Color Format

Quality

Metadata Checks

Digital Hub Project Information

All available information should be present in the Hub record‘s Project Information tab.

This includes the following: Title, Publisher, BISAC Subject Codes, Print and E-book ISBNs, Creators and Contributors, and Extended Metadata (Additional Descriptive Data and Additional Titles).

Navigation File Entries

They should usually be “Cover,” “Title Page,” and “Copyright Page.”

File-As Name

eISBN

Other Metadata

ePub3 Checks

Page List

Landmarks

It should contain at least “cover,” “toc” (table of contents), and “bodymatter” (to indicate where the main content begins).

Kindle (.mobi) Checks

Build a .mobi file (using the Digital Hub or Kindle Previewer), even if not required for the project, to confirm that there are no conversion issues. There should be no errors or warnings during the build process (other than warnings about embedded fonts, which can usually be ignored).

Cover and TOC Buttons

Build errors (e.g., if the cover is not correctly identified) can result in a grayed-out button in the previewer.

Example: <a href=""\>Text <a href=""\>note</a\></a\>)

These will show as errors when building a .mobi file and will result in nonfunctioning links.

Centering

This is necessary for proper display in a Kindle viewer.

Styles

Do a page-by-page review.

Final Check

The .scml file is the archival file for the project, so it must match the content of the e-book.