Skip to content
EPUBCheck · XHTML content documents

EPUBCheck HTM-007: empty ssml:ph pronunciation

Updated:

EPUBCheck HTM-007 is a warning message: “Empty or whitespace-only value of attribute ssml:ph.” An ssml:ph attribute is empty or contains only whitespace. The attribute gives a phonetic pronunciation for text-to-speech, so an empty one gives the speech engine nothing to use.

The official message

Empty or whitespace-only value of attribute ssml:ph.

Default severity
Warning. The EPUB is still valid, but something is likely to cause problems in some reading apps. EPUBCheck exits with 0 unless you pass --failonwarnings.
EPUBCheck version
5.4.0

Typical causes

  • A pronunciation attribute added by a tool or template and never filled in.
  • A value removed by hand while keeping the attribute.

How to fix it

  1. Open the file EPUBCheck names (the message gives the path, line and column) in a text or EPUB editor such as Sigil, or unzip the EPUB and open it there.
  2. Fill in the pronunciation in the alphabet the document declares (ssml:alphabet), or remove the ssml:ph attribute.
  3. If no element uses SSML any more, remove the xmlns:ssml declaration as well.
  4. Rebuild the EPUB and run EPUBCheck again to confirm the message is gone.

When it's not this

This only concerns SSML pronunciation hints; it says nothing about media overlays narration.

Terms used here

Other HTM messages

  • HTM-009 The DOCTYPE provided is obsolete or irregular and can be removed.
  • HTM-004 Irregular DOCTYPE: found "…", expected "…".
  • HTM-010 Namespace "…" is unusual for the prefix "epub".
  • HTM-003 External entities are not allowed in EPUB v3 documents. External entity declaration found: ….
  • HTM-011 Entity is undeclared.
  • HTM-001 Any publication resource that is an XML-based media type must be a valid XML 1.0 document. XML version found: ….

Sources

Message text and severity from EPUBCheck 5.4.0 (W3C, BSD-3-Clause). Explanation by EpubCC.

FAQ

What does EPUBCheck HTM-007 mean?

EPUBCheck HTM-007 is a warning message: “Empty or whitespace-only value of attribute ssml:ph.” An ssml:ph attribute is empty or contains only whitespace. The attribute gives a phonetic pronunciation for text-to-speech, so an empty one gives the speech engine nothing to use.

Is HTM-007 an error?

HTM-007 is reported as warning by default. The EPUB is still valid, but something is likely to cause problems in some reading apps. EPUBCheck exits with 0 unless you pass --failonwarnings.