EPUBCheck v5.0.0

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