EPUB 3 Best Practices

Errata for EPUB 3 Best Practices

Submit your own errata for this product.

The errata list is a list of errors and their corrections that were found after the product was released. If the error was corrected in a later version or reprint the date of the correction will be displayed in the column titled "Date Corrected".

The following errata were submitted by our customers and approved as valid errors by the author or editor.

Color key: Serious technical mistake Minor technical mistake Language or formatting error Typo Question Note Update

Version Location Description Submitted By Date submitted Date corrected
Printed, PDF, ePub, Mobi,
Page xx
End of item 2.

The cross reference in "why this book begins by exploring these issues in 'Metadata'" should reference page 1, not page 281.

Note from the Author or Editor:
Link reference needs to be changed to point to the start of the Metadata chapter as noted.

Bill Kasdorf  Apr 28, 2013 
Page xxi
5th technology listed

I believe that this item should read "OpenType and WOFF" rather than "TrueType and WOFF." TTF is not part of the EPUB spec, to the limited degree that I currently understand it (and rightly so!). Indeed, TTF is never again mentioned in the book--rather, the expected combo "OTF and WOFF" do.

Unfortunately, this TTF entry is also indexed, so if I am correct, the entry for TrueType should be removed from page 344, and a new entry added to the OpenType listing on page 341, 1st col., pointing to pagw xxi.

Note from the Author or Editor:
Yes, this is a typo.

The noted reference to TrueType should be changed to OpenType.

Ari Davidow  Nov 21, 2013 
Page N/A"
Chapter 3 MathML section 3rd to last paragraph before SVG

"It’s worth nothing here, too, that the description inside the annotation-xml element is the only place where HTML fragments can appear inside of MathML markup. Although HTML5 technically allows HTML markup to be included inside of mtext elements, EPUB 3 restricts that usage."

Should nothing be noting?

Note from the Author or Editor:
Definitely a typo. Need to change "nothing" to "noting" as suggested.

Tee Jay Zajac  Apr 27, 2016 
Printed, PDF, ePub, Mobi,
Page 7
First paragraph under "Publication Metadata" heading

The parenthetical portion of the sentence reading "Which one is the cover image, and do any of them contain MathML or SVG or scripting (spine itemref properties)?" should read "(manifest item properties)." The main sections on the manifest and spine later in the chapter are correct.

Note from the Author or Editor:
Text needs to be changed as noted.

Bill Kasdorf  Apr 28, 2013 
Page 16
href definition

The href definition makes reference to the informative note in the EPUB specs about limiting URIs to the ASCII character range to avoid any possible problems in EPUB 2 reading systems, but without being explicit about why this restriction exists (it's not generally good practice, only in that one instance).

In Chapter 8, we note that this restriction is a hindrance for i18n IRIs and does not need to be followed, making the advice between chapters seem contradictory.

The href attibute definition should read:

Resource names should be restricted to the ASCII character set when
compatibility with EPUB 2 reading systems is a concern, but see Names in Chapter 8 for more information.

Matt Garrish
Mar 29, 2013 
Printed, PDF, ePub, Mobi,
Page 33
Third paragraph beginning note

The prose about not being able to create inactive links is not valid. It hinged on how to interpret the requirement that the href attribute on <a> tags must point into the publication.

The attribute is not in fact always required to be used, as the rule in the specifications is that unless a requirement is stated HTML5 rules apply.

To create inactive links, you simply omit the href attribute:


Note from the Author or Editor:
To fix, please implement the following changes:

Change the word "more" to "primary" in this sentence that begins the second paragraph on the page:

There’s only one more case left to review: headings.

Next, replace the text starting from the next paragraph that begins "Note that you can use a span..." up to and including the third paragraph on the next page that begins "In either case, the links..." with this text (note this text includes asciidoc markup):

Note that you can use a +span+ only when it’s followed by an ordered list.

The final special pattern we'll look at is inactive links. These are added just like regular links, using +a+ tags, but omit the +href+ attribute. Although not common, you might, for example, include inactive links in a preview of your ebook with a complete table of contents but only a section or two of available content:

<a href="foreword.xhtml">Foreword</a>
<a href="c01.xhtml">Chapter 1: The Great Beyond</a>
<a>Chapter 2: A Fool's Egress</a>


Matt Garrish  Feb 28, 2013 
Page 81
last paragraph

Text on the book

"The override properties are a combination of property and value, as already noted (that is, rendition:orientation-portrait, rendition:orientation-portrait, and rendition:orientation-auto)."

should be changed with "rendition:orientation-landscape" like

"The override properties are a combination of property and value, as already noted (that is, rendition:orientation-portrait, rendition:orientation-landscape, and rendition:orientation-auto)."

Note from the Author or Editor:
Yes, this is obviously a typo.

The first instance of "rendition:orientation-portrait" should be "rendition:orientation-landscape" inside the parentheses.  Apr 07, 2013 
Page 146
2nd line

The example for the manifest entry for remote resources uses the “src” attribute: “src=""”

It should use “href”, as stated in the epub3 specification:

Note from the Author or Editor:
Yes, the attribute in the example is obviously incorrect. The <item> tag examples at the bottom of page 145 and top of 146 should both have had href attributes, not src.

Melanie Griesser  Jul 09, 2014 
Page 213
first paragraph

In the sentence that begins "Inner Mongolia uses vertical writing," I think "from right to left rather than from left to right" should be "from left to right rather than from right to left."

Note from the Author or Editor:
The noted wording change is correct. The sentence should read: "from left to right rather than from right to left" as this is a unique characteristic of Inner Mongolian vertical writing.

Teresa Elsey  Feb 23, 2013 
Printed, PDF, ePub, Mobi,
Page 251
first example

The aria-describedby attribute should be on the img tag, not on the figure.

As a figure may contain multiple components that need to be independently described, the current usage makes it look like there should only be one description for the entire figure.

Matt Garrish
Feb 07, 2014