Epubcheck Versions Save

This is the latest production-ready release of EPUBCheck. It can be used to check conformance to the EPUB 3.3 specification.

This release was made by the DAISY Consortium for W3C. Many thanks to everyone who contributed and reported issues!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:5.1.0.

Features

• update to latest schemas from the Nu HTML Checker (2f6a2c7)
• warn about doc-endnote or doc-biblioentry on list items (5c39157)

Bug Fixes

• dc:source element caused a NullPointerException (c15e4ea), closes #1514
• allow flow content for ins and del XHTML 1.1 elements (EPUB 2.0.1) (d916df0), closes #1522
• incorrect ID refs in toc nav caused a NullPointerException (f7b5dd9), closes #1516
• make CLI return 0 for --version or --help options (49aacb2), closes #1520
• properly set font fields in the JSON report (8575a6b), closes #1519
• properly set the referencedItems field in the JSON report (7804c78)
• properly set the rendition fields in the JSON report (da643e4)
• remove undefined isHTML5 field from the JSON report (00b1d20)
• remove undefined navigationOrder field from the JSON report (39234a6)
• remove undefined script-related fields from the JSON report (1931d73)
• updated list of allowed values for the OPF 2.0.1 role attribute (0573214), closes #1521

This is a maintenance release of EPUBCheck, made by the DAISY Consortium for W3C. Many thanks to everyone who contributed and reported issues!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:5.0.1.

Features

• allow "pageBreakSource" package metadata (incubation) (2332d53), closes #1491
• allow epub:type on SVG renderable elements (6cd9789), closes #1497

Bug Fixes

• allow ARIA headings in EDUPUB (legacy profile) (da4f541), closes #1483
• allow decimal viewport dimensions in fixed-layout (fc5e360), closes #1481
• allow nav items containing multiple images (3c8dab3), closes #1476
• allow remote URLs in HTML "cite" attributes (1b425fd), closes #1495
• allow the 'cover-image' property on WebP images (199da0b), closes #1484
• bad message parameter formatting in CSS-004 and RSC-028 (0f0cece), closes #1480
• do not check fragment identifiers on PDF references (b81a77d), closes #1482
• items were listed twice and/or with null values in the JSON report (b2c5d8c), closes #1475 #1490
• normalize URLs before checking if the resources exist (0323668), closes #1479
• support UNC paths (fix URL/File conversions) (6e5b791), closes #1485

Version 5.0.0 is the first production-ready release to support the latest EPUB 3.3 W3C Candidate Recommendation.

This release was made by the DAISY Consortium for W3C. Many thanks to everyone who contributed and reported issues!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:5.0.0.

See the full change log since v4.2.6.

5.0.0 (2023-01-11)

Features

• "xmp" is no longer a valid package link property (6a3d2a6), closes #1457
• add a dockerfile and readme documentation (d0ed6a4)
• check "data-*" attributes name restrictions (22f5994), closes #1107
• check stylesheets declared in SVG (003234a), closes #1450
• check that non-linear content is reachable (f20993e), closes #1451
• check that the manifest is not self-referencing (2c76420), closes #1453
• disallow epub:type on head and metadata content (bfb7239), closes #1444 #1445
• disallow data URLs in the package document (0175818), closes #1446
• report as a usage when no reference were found to manifest items (09244a4), closes #1452
• report as usage container resources not listed in manifest (f81b423)
• report package link to package document elements (dd00b88)
• update Saxon library to v11.4 (ef2697e), closes #1341
• update viewport meta element requirements (9f75a1d), closes #1401 #1449
• use "audio/ogg; codecs=opus" as the MIME type for OPUS audio (0759a82), closes #1473

Bug Fixes

• allow links to resources embedded in content documents (54b5f1f), closes #1454
• allow unknown alternate style sheet class names (f59743a), closes #989
• report HTML discouraged constructs as "usage" (c8e9f45), closes #1387

5.0.0-beta-3 (2022-11-28)

Features

• allow 1s tolerance for media overlays duration sum check (e64c7c5), closes #1328
• allow NCX documents to declare a doctype (f3e5f67), closes #1329
• better check media overlays styling properties (6a58b8e)
• better parse URL fragment micro syntaxes (bec390e)
• check epub:type restrictions in XHTML and SVG (0fab5c8), closes #1348
• check file name uniqueness wiht Unicode canonical case fold normalization (111e772), closes #1246
• check fragment requirements on overlays links to text content (2091d14), closes #1248 #1301
• check that container-relative URLs have no query (a4fed67)
• check that overlays audio file URLs have no fragments (fdabe66), closes #1251
• check the formal viewport meta tag syntax (01a7758), closes #1214 #1347
• extend proper URL checking to more places (like CSS) (a3c736d)
• improve checking of data URLs (cbc0b2a), closes #1238 #1239
• improve checking of OCF file name characters (b6ac8ea), closes #1240 #1292 #1302
• improve detection of non-UTF-8 file names (5248914), closes #1236
• improve fallback detection check (545b7f7), closes #1304 #1298
• new requirements of package link 'media-type' attribute (3199b81), closes #1307
• no longer check collection role (8eb8492), closes #1350
• remove checks related to deprecated bindings feature (7ca1edf)
• report 'file' URLs as errors (0f6b509), closes #1270
• report empty URL as a schema error instead of HTM-008 (e3d3afe)
• restrict SVG title element to HTML elements (8631b7d), closes #1342
• update checking of the package rendering vocabulary (3086258), closes #1327
• update the reporting of file encoding issues (0d6f927), closes #1245
• warn about non-HTTPS remote resource references (7eb5ff2), closes #1337

Bug Fixes

• consider HTML form elements as scripted content (1bae7f7), closes #1282
• declaring prefixes for default vocabs is an error (035effa), closes #1306
• fix CVE-2021-23792 vulnerability from imageio-jpeg (50b847f), closes #1336
• improve checking of missing SVG link labels, now USAGE (5903626), closes #1353
• OPF-018 was incorrectly reported with inline CSS (c3d767c), closes #1335
• regression that lost line and column numbers in messages (20b5142)
• remove recursion in reading order checks (6cbbefa), closes #1358 #1356
• report fatal XML parsing errors only once as RSC-016 (62d67e7)
• support CSS logical combination pseudo-classes (5635807), closes #1289 #1354

5.0.0-beta-2 (2022-07-08)

Features

• proper handling of URL parsing throughout all checks, based on the URL standard (using the Galimatias library)
• reorganized tests for EPUB 3.3
• allow SVG/MathML doctype declarations (6e44b39), closes #1192 #1114
• allow any file extension (bdee846)
• check discouraged HTML elements (base, rp, embed) (afb28cb), closes #1271
• check Media Overlays total duration consistency (ee9c720), closes #1217
• check that 'page-list' and 'landmarks' nav are flat lists (15825a5), closes #1279
• check that publication resources are not in META-INF (61dbf53), closes #1227
• HTML link element resources do not require fallbacks (8d77b0f), closes #1247
• ignore Nav Doc nav elements with no epub:type (f989588), closes #1222
• loosen restriction on where remote resources can be referenced (73fe57c), closes #1288
• page-list nav does not have to match reading order (d0f12a9), closes #1237
• report reserved string in XHTML custom attribute namespaces (bc86db8), closes #1190
• restrict obfuscation to font core media types (a229edf), closes #1291
• refactored API and internals (39888e2)
• add new Core Media Types (ECMAScript, OPUS, WebP) (166256a), closes #1249 #1189
• allow 'auto' value for the 'dir' attribute of Package Documents (a2e3a77), closes #1220
• allow 'hreflang' attribute on Package Document link elements (e39a801), closes #1219
• allow informative schema checking (reported as new RSC-024 and RSC-025) (a2516f0)
• check that item URLs have no fragment (ec28b59), closes #1250
• do not check conformance of SVG content (ba48aaa)
• enable informative (USAGE) checking of SVG content conformance (b9ddf8f)
• new check (OPF-092) for language tags well-formedness (52ebd80), closes #1221 #702
• update checking of the Package Document 'refines' attribute (72366b4), closes #1226
• update to latest schemas from the Nu HTML Checker (af7a5f7)
• remove "under review" notice for toc nav ordering warning (fe08c59), closes #1194

5.0.0-beta-1 (2022-01-24)

Features

• allow SVG/MathML doctype declarations (6e44b39), closes #1192 #1114
• allow any file extension (bdee846)
• check discouraged HTML elements (base, rp, embed) (afb28cb), closes #1271
• check Media Overlays total duration consistency (ee9c720), closes #1217
• check that 'page-list' and 'landmarks' nav are flat lists (15825a5), closes #1279
• check that publication resources are not in META-INF (61dbf53), closes #1227
• HTML link element resources do not require fallbacks (8d77b0f), closes #1247
• ignore Nav Doc nav elements with no epub:type (f989588), closes #1222
• loosen restriction on where remote resources can be referenced (73fe57c), closes #1288
• page-list nav does not have to match reading order (d0f12a9), closes #1237
• report reserved string in XHTML custom attribute namespaces (bc86db8), closes #1190
• restrict obfuscation to font core media types (a229edf), closes #1291

Minor Changes

• remove "under review" notice for toc nav ordering warning (fe08c59), closes #1194

5.0.0-alpha-1 (2021-11-15)

Runtime

• require Java 8 (9435936)

Features

• refactored API and internals (39888e2)
• add new Core Media Types (ECMAScript, OPUS, WebP) (166256a), closes #1249 #1189
• allow 'auto' value for the 'dir' attribute of Package Documents (a2e3a77), closes #1220
• allow 'hreflang' attribute on Package Document link elements (e39a801), closes #1219
• allow informative schema checking (reported as new RSC-024 and RSC-025) (a2516f0)
• check that item URLs have no fragment (ec28b59), closes #1250
• do not check conformance of SVG content (ba48aaa)
• enable informative (USAGE) checking of SVG content conformance (b9ddf8f)
• new check (OPF-092) for language tags well-formedness (52ebd80), closes #1221 #702
• update checking of the Package Document 'refines' attribute (72366b4), closes #1226
• update to latest schemas from the Nu HTML Checker (af7a5f7)

BREAKING CHANGES

• the required Java runtime environment is now Java 8 or greater

This is the latest preview release of the next major version of EPUBCheck, v5.0.0. This version fully implements the new rules in EPUB 3.3.

We recommend users to effictively test this EPUBCheck version in their production workflow, to get ready for EPUB 3.3! 🚀

Note: This EPUBCheck version is not available in the Maven Central Repository. It is only available (temporarily) as a binary on the GitHub release page.

This release was made by the DAISY Consortium for the W3C. Many thanks to everyone who contributed and reported issues!

Features

• allow 1s tolerance for media overlays duration sum check (e64c7c5), closes #1328
• allow NCX documents to declare a doctype (f3e5f67), closes #1329
• better check media overlays styling properties (6a58b8e)
• better parse URL fragment micro syntaxes (bec390e)
• check epub:type restrictions in XHTML and SVG (0fab5c8), closes #1348
• check file name uniqueness wiht Unicode canonical case fold normalization (111e772), closes #1246
• check fragment requirements on overlays links to text content (2091d14), closes #1248 #1301
• check that container-relative URLs have no query (a4fed67)
• check that overlays audio file URLs have no fragments (fdabe66), closes #1251
• check the formal viewport meta tag syntax (01a7758), closes #1214 #1347
• extend proper URL checking to more places (like CSS) (a3c736d)
• improve checking of data URLs (cbc0b2a), closes #1238 #1239
• improve checking of OCF file name characters (b6ac8ea), closes #1240 #1292 #1302
• improve detection of non-UTF-8 file names (5248914), closes #1236
• improve fallback detection check (545b7f7), closes #1304 #1298
• new requirements of package link 'media-type' attribute (3199b81), closes #1307
• no longer check collection role (8eb8492), closes #1350
• remove checks related to deprecated bindings feature (7ca1edf)
• report 'file' URLs as errors (0f6b509), closes #1270
• report empty URL as a schema error instead of HTM-008 (e3d3afe)
• restrict SVG title element to HTML elements (8631b7d), closes #1342
• update checking of the package rendering vocabulary (3086258), closes #1327
• update the reporting of file encoding issues (0d6f927), closes #1245
• warn about non-HTTPS remote resource references (7eb5ff2), closes #1337

Bug Fixes

• consider HTML form elements as scripted content (1bae7f7), closes #1282
• declaring prefixes for default vocabs is an error (035effa), closes #1306
• fix CVE-2021-23792 vulnerability from imageio-jpeg (50b847f), closes #1336
• improve checking of missing SVG link labels, now USAGE (5903626), closes #1353
• OPF-018 was incorrectly reported with inline CSS (c3d767c), closes #1335
• regression that lost line and column numbers in messages (20b5142)
• remove recursion in reading order checks (6cbbefa), closes #1358 #1356
• report fatal XML parsing errors only once as RSC-016 (62d67e7)
• support CSS logical combination pseudo-classes (5635807), closes #1289 #1354

See also the change log of earlier previews.

v5.0.0-beta-2

• proper handling of URL parsing throughout all checks, based on the URL standard (using the Galimatias library)
• reorganized tests for EPUB 3.3
• allow SVG/MathML doctype declarations (6e44b39), closes #1192 #1114
• allow any file extension (bdee846)
• check discouraged HTML elements (base, rp, embed) (afb28cb), closes #1271
• check Media Overlays total duration consistency (ee9c720), closes #1217
• check that 'page-list' and 'landmarks' nav are flat lists (15825a5), closes #1279
• check that publication resources are not in META-INF (61dbf53), closes #1227
• HTML link element resources do not require fallbacks (8d77b0f), closes #1247
• ignore Nav Doc nav elements with no epub:type (f989588), closes #1222
• loosen restriction on where remote resources can be referenced (73fe57c), closes #1288
• page-list nav does not have to match reading order (d0f12a9), closes #1237
• report reserved string in XHTML custom attribute namespaces (bc86db8), closes #1190
• restrict obfuscation to font core media types (a229edf), closes #1291
• refactored API and internals (39888e2)
• add new Core Media Types (ECMAScript, OPUS, WebP) (166256a), closes #1249 #1189
• allow 'auto' value for the 'dir' attribute of Package Documents (a2e3a77), closes #1220
• allow 'hreflang' attribute on Package Document link elements (e39a801), closes #1219
• allow informative schema checking (reported as new RSC-024 and RSC-025) (a2516f0)
• check that item URLs have no fragment (ec28b59), closes #1250
• do not check conformance of SVG content (ba48aaa)
• enable informative (USAGE) checking of SVG content conformance (b9ddf8f)
• new check (OPF-092) for language tags well-formedness (52ebd80), closes #1221 #702
• update checking of the Package Document 'refines' attribute (72366b4), closes #1226
• update to latest schemas from the Nu HTML Checker (af7a5f7)
• remove "under review" notice for toc nav ordering warning (fe08c59), closes #1194

v5.0.0-beta-1

• allow SVG/MathML doctype declarations (6e44b39), closes #1192 #1114
• allow any file extension (bdee846)
• check discouraged HTML elements (base, rp, embed) (afb28cb), closes #1271
• check Media Overlays total duration consistency (ee9c720), closes #1217
• check that 'page-list' and 'landmarks' nav are flat lists (15825a5), closes #1279
• check that publication resources are not in META-INF (61dbf53), closes #1227
• HTML link element resources do not require fallbacks (8d77b0f), closes #1247
• ignore Nav Doc nav elements with no epub:type (f989588), closes #1222
• loosen restriction on where remote resources can be referenced (73fe57c), closes #1288
• page-list nav does not have to match reading order (d0f12a9), closes #1237
• report reserved string in XHTML custom attribute namespaces (bc86db8), closes #1190
• restrict obfuscation to font core media types (a229edf), closes #1291
• remove "under review" notice for toc nav ordering warning (fe08c59), closes #1194

v5.0.0-alpha-1

• require Java 8 (9435936)
• refactored API and internals (39888e2)
• add new Core Media Types (ECMAScript, OPUS, WebP) (166256a), closes #1249 #1189
• allow 'auto' value for the 'dir' attribute of Package Documents (a2e3a77), closes #1220
• allow 'hreflang' attribute on Package Document link elements (e39a801), closes #1219
• allow informative schema checking (reported as new RSC-024 and RSC-025) (a2516f0)
• check that item URLs have no fragment (ec28b59), closes #1250
• do not check conformance of SVG content (ba48aaa)
• enable informative (USAGE) checking of SVG content conformance (b9ddf8f)
• new check (OPF-092) for language tags well-formedness (52ebd80), closes #1221 #702
• update checking of the Package Document 'refines' attribute (72366b4), closes #1226
• update to latest schemas from the Nu HTML Checker (af7a5f7)

---

ℹ️ Note

EPUBCheck v4.2.6 reverts two checks recently introduced in v4.2.5. Only users who were negatively impacted by these two checks have to update their setup to EPUBCheck v4.2.6. For others, EPUBCheck v4.2.6 will behave exactly like EPUBCheck v4.2.5. We always advise users update to the latest version, but we understand that you may like to avoid the overhead of updating your production systems at shorter intervals.

---

Release Notes

This is a production-ready release of EPUBCheck. It provides complete support for checking conformance to the EPUB 3.2 family of specifications.

Version 4.2.6 is a maintenance release, which reverts two checks recently introduced in v4.2.5. In this newer version:

• the role property can now refine creator, contributor, and publisher properties more than once
• Media Overlays no longer have to match the reading order of the associated Content Documents

Reverting these checks is a proactive adoption of the rules that will be relaxed in EPUB 3.3, as the stricter checks recently introduced were problematic to some users.

This release was made by the DAISY Consortium for the W3C. Many thanks to everyone who contributed and reported issues!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:4.2.6.

Features

• allow multiple roles for creator, contributor, and publisher (#1258) (6c68c61), closes #1230
• do not report Media Overlays ordering mismatch (1cd7d77)

This is a production-ready release of EPUBCheck, which provides complete support for checking conformance to the EPUB 3.2 family of specifications.

Version 4.2.5 is a maintenance release. It adds several new checks for Media Overlays, updates the HTML schemas to the latest version available, and includes various other bug fixes and adjustments (see the detailed list below).

This release was made by the DAISY Consortium for the W3C. Many thanks to everyone who contributed, translated messages, and reported issues!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:4.2.5.

Features

• check playback properties do not have 'refines' attribute (05a6a20)
• check reading order of Media Overlays text elements (e35bd05)
• check references between Media Overlays and Content documents (f49aa84)
• check remote resource usage in Media Overlays (df16ede)
• check required cardinality of meta properties (edcd253), closes #1121
• check that Media Overlays are only defined for XHTML and SVG content documents (5ae1aa9)
• check the epub:textref attribute on Media Overlays body and seq elements (eea1574)
• improve checking of audio clip times in Media Overlays (11b652e)
• report unknown 'epub:type' values in overlays as USAGE only (#1171) (f8a2517)
• update HTML schemas from the HTML Checker (56dcbd1)
• verify 'media:duration' property use valid SMIL clock values (794b7ce), closes #1174

Bug Fixes

• allow empty xml:lang attributes in Package Documents (177af8f), closes #777
• allow the 'glossary' manifest item property (d1727d8), closes #1170
• do not report fragment-only CSS URLs (6fa3312), closes #1198
• do not require the Navigation Document to have an index in an Index Publication (33f2f99), closes #1122
• do not treat escaped elements as hyperlinks in HTM-053 (5949b6c), closes #1182
• remove the user directory only at the start of paths (in messages) (5ee72e7), closes #1181

This is a production-ready release of EPUBCheck, which provides complete support for checking conformance to the EPUB 3.2 family of specifications.

Version 4.2.4 is a patch release to the recently-released version 4.2.3. It brings the HTML schemas in sync with the latest changes to the ARIA in HTML specification. This fixes an issue that caused a couple DPUB ARIA roles (doc-glossary and doc-dedication) to be incorrectly rejected on some HTML elements.

This release was made by the DAISY Consortium, for the W3C. Thanks to everyone who noticed the issue, and to @mattgarrish who quickly submitted pull requests to both EPUBCheck and the HTML checker!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:4.2.4.

Tip: If you are running EPUBCheck on a 32bit JVM and it crashes and reports a StackOverflowError, try to increase the Java Thread Stack Size!

Bug Fixes

• allow 'doc-dedication' role on 'aside' elements (023b783)
• allow 'doc-glossary' role on 'section' elements (12cda43)

This is a production-ready release of EPUBCheck, which provides complete support for checking conformance to the EPUB 3.2 family of specifications.

Version 4.2.3 is a maintenance release; it updates HTML schemas to the latest version, upgrades a couple dependencies to remediate security vulnerabilities, and includes various other bug fixes and adjustments (see the detailed list below).

This release was made by the DAISY Consortium, for the W3C. Many thanks to everyone who contributed!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:4.2.3.

Tip: If you are running EPUBCheck on a 32bit JVM and it crashes and reports a StackOverflowError, try to increase the Java Thread Stack Size!

Features

• update HTML schemas from the HTML Checker (22fa3b1), closes #1111
• downgrade PKG-012 (non-ASCII filenames) to USAGE (f368ee5), closes #1097 (thanks @slonopotamus!)
• downgrade RSC-004 (cannot decrypt resource) to INFO (#1136) (e732068)
• report empty title elements in XHTML Content Documents (#1135) (f115730), closes #1093
• ARIA: allow doc-epigraph on 'section' and doc-cover on 'img' (84a0979)
• update the XML ouput to the new JHOVE schema (0b346fd) (thanks @tledoux!)

Bug Fixes

• avoid OutOfMemoryError when computing image size (929806b) (thanks @DocJM!)
• fail gracefully when running on a non-EPUB file (#1134) (2083f05), closes #1050
• allow 'a11y:certifierCredential' as a link (484786f), closes #1140
• allow foreign namespaces in EPUB 2 SVGs (e3ffc37)

Other Improvements

• improve reporting of invalid URL host parts (d2728ee), closes #1034 #1079
• harmonize quotes usage in messages (#1132) (659ab76), closes #1071
• add an Automatic-Module-Name entry to the jar manifest (ee06724), closes #1128 (thanks @io7m!)
• deps upgrade commons-compress to v1.20 to remediate CVE-2019-12402 (928c26a), closes #1078
• deps upgrade guava to v24.1.1 to remediate CVE-2018-10237 (cec01fe)

This is a production-ready release of EPUBCheck, which provides complete support for checking conformance to the EPUB 3.2 family of specifications.

Version 4.2.2 is a maintenance release which reverts the toc and page-list navigation order check to a mere WARNING (it was previously an ERROR), following the recent EPUB CG discussion. It also includes new translations, notably for Traditional Chinese (thank you @davidmaxlee!).

This release was made by the DAISY Consortium, for the W3C. Many thanks to everyone who contributed!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:4.2.2.

Tip: If you are running EPUBCheck on a 32bit JVM and it crashes and reports a StackOverflowError, try to increase the Java Thread Stack Size!

Features

• revert the spine/toc nav and page-list order check to a WARNING (#1056) (1f6a882), closes #1036

Localization

• complete translation for Traditional Chinese (+ Danish/German/Korean tweaks) (#1058) (64558be), closes #1054

This is a production-ready release of EPUBCheck, which provides complete support for checking conformance to the EPUB 3.2 family of specifications.

Version 4.2.1 is a maintenance release which fixes an issue with the doc-endnote DPUB ARIA role (see details below).

This release was made by the DAISY Consortium, for the W3C. Many thanks to everyone who contributed!

This EPUBCheck version is also available in the Maven Central Repository as org.w3c:epubcheck:4.2.1.

Tip: If you are running EPUBCheck on a 32bit JVM and it crashes and reports a StackOverflowError, try to increase the Java Thread Stack Size!

Bug Fixes

• allow doc-endnote on li children of ol (275fcd1), closes #1041
• update schemas from upstream HTML Checker (4d5a24d)