EPUBCheck v4.2.0-rc

This is a release candidate of the forthcoming EPUBCheck v4.2.0, which provides support for checking conformance to EPUB 3.2. This version is intended to be used for testing and preparing the update in production workflows.

EPUBCheck v4.2.0-rc features complete support for the EPUB 3.2 family of specification. The changes since the last beta release include support for remote fonts, remote resources in scripts, checking the reading order in the Navigation Document, extended support to HTML’s picture element and srcset attribute, as well as various other bug fixes and small improvements (see details below).

Two new localizations have been added: Danish (thanks @MyDK!) and Traditional Chinese (thanks @bobbytung!).

This release was made by the DAISY Consortium, for the W3C. Many thanks to everyone who contributed, especially to @mattgarrish for all the pull request reviews, and to the translators team!

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

Features

• allow fonts to be remote resources (4d5a5a9), closes #871 #672
• allow remote resources in scripted content (1c90ae9), closes #869
• check duplicate IDs in the OCF encryption file (cab45e6), closes #306
• check image sources in picture and srcset (11bf628), closes #781
• check that toc & page-list nav are in reading order (8ba384f), closes #888
• disallow remote links in toc/landmarks/page-list nav (dd0805f), closes #890
• report use of non-preferred Core Media Types (ab13779), closes #873

Bug Fixes

• allow epub:type on all HTML elements (2cafe64), closes #986
• allow ARIA role doc-glossary on section elements (0d9462f), closes #997
• allow images to point to SVG fragments (18afa9d), closes #987
• ignore SVG view fragments when checking cross refs (50b29f1), closes #987
• localize singular/plurals variants in summary (93b700f), closes #958
• parse CSS custom properties (0036e93), closes #790
• report all epub:type value checks as USAGE (f248483), closes #1009
• report duplicate landmarks nav entries as ERROR (d7be97c), closes #298
• revert FXL SVG rules to EPUB 3.0.1’s logic (ced3c15)
• revert the deprecation of display-seq (f81d8b8), closes #990
• script data blocks don’t need to be declared (05e5ac2)
• support ARIA global attributes in SVG (56ebcd8), closes #846

Localization

• new localization: Danish (28ef69b, 40f7b64)
• new localization: Chinese (Taiwan) (46195ad)
• update localized messages for German (40f7b64)
• update localized messages for Italian (d954ae7, 864282a)

Note: the new messages introduced in v4.2.0 are not localized yet.

EPUBCheck v4.2.0-beta

This is a public test release of the forthcoming EPUBCheck v4.2.0, which will provide support for checking conformance to EPUB 3.2.

EPUBCheck v4.2.0-beta features updates to the various EPUB vocabularies (for epub:type and Package Document properties), support for new Core Media Types, as well as various other bug fixes and small improvements (see details below).

Note: Starting from this release, EPUBCheck is distributed to the Maven Central Repository under the org.w3c group ID, instead of the older org.idpf group ID.

This release was made by the DAISY Consortium, for the W3C. Many thanks to everyone who contributed, especially to @murata2makoto for the schema reviews!

EPUBCheck 4.2.0-beta is a test release of EPUBCheck, to be used for testing and bug reporting only!

Features

• add application/javascript as core media type (f4566b6), closes #874
• add new MO-only aside epub:type value (4404fff)
• allow the Compression element in the encryption file (ed6f1c4), closes #904
• basic schema support for HTML custom elements (356fac0), closes #932
• implement Structure Semantics Vocab changes for EPUB 3.2 (3454da5), closes #531 #903 #962 #963
• improve wording of message OPF-025 (cecaa76), closes #959
• remove epubsc from reserved prefixes (02397ec), closes #875
• report CSS absolute/fixed positioning as USAGE (672ac6d), closes #889
• set reported 3.x version to "3.2" (9965c19), closes #943
• support new rules related to FXL SVG sizing (17f5eee), closes #902
• suppress a couple irrelevant USAGE reports (b342db2)
• update Jing (schema processor) to v20181222 (cfca41b)
• update Package vocabularies and link element checks (99f882a), closes #883 #884 #885 #886 #887
• update recognized font Core Media types (ac2f1bd), closes #872 #339
• update the HTML schemas to the latest Nu HTML Checker version (8d3c77e)

Bug Fixes

• allow foreign namespaces in SVG content documents (ca29c89), closes #491
• do not restrict ID refs to non-colon names (365e6e6), closes #783
• improve RelaxNG datatypes of date/time/duration attributes (ef5b94c), closes #775
• parse boolean/enumerated HTML attributes as case-insensitive (5b3533a), closes #941

EPUBCheck 4.1.1

This is a maintenance release of EPUBCheck, the conformance validator for EPUB publications. It mostly consists of bug fixes and updated localized messages.

EPUBCheck 4.1.1 is the latest production-ready release of EPUBCheck.

This release was made by the DAISY Consortium, for the W3C.

Many thanks to the various people who contributed to this release, notably the team of translators including Elisa Molinari, Emiliano Molina, Gregorio Pellegrino, Masayoshi Takahashi, Merijn de Haen, Thiago de Oliveira Pereira, Vincent Gros, Woongyoung Park… and especially Tobias Fischer, who has been coordinating the translation contributions!

Note: This release is part of the 4.1.x stable stream, which checks conformance to the EPUB 3.0.1 family of specifications. It does not include support for the newer EPUB 3.2 specifications. For a preview of EPUB 3.2 conformance checking, feel free to try the latest release in the 4.2.x beta stream (currently v4.2.0-alpha-1)!

Features

• update localized messages for several languages (116e61b)

Bug Fixes

• switch item property doesn't apply to svg:switch (91b84ad), closes #857
• better check remote resources (85b5f77), closes #852
• better support the EPUB Accessibility Vocabulary (8a9cf63), closes #810
• consider all video/* as video media types (27ad571)
• do not check entity references in comment or CDATA (#949) (4307542), closes #800
• do not report CSS 'font-size: 0' as an error (4e17714), closes #922
• keep on processing after failing to read GIFs (2a244e7)
• messages of missing/incorrect locale cannot be translated (91fac12)
• resolve relative URIs against their base (d42ccd6), closes #527
• valid JPEG files were considered 'corrupted' (c4a2cfa), closes #850
• wrong report of duplicate landmarks in Nav Doc (#942) (e06a552), closes #926

EPUBCheck 4.2.0-alpha-1

This is the first preview release of EPUBCheck v4.2.0 (alpha 1), which provides initial and limited support for checking conformance to EPUB 3.2.

EPUBCheck 4.2.0-alpha-1 is an alpha release of EPUBCheck, to be used for testing and bug reporting only.

It mostly consists in updates to the schemas for Package Documents and Content Documents. EPUBCheck now uses the latest schemas from the Nu Html Checker, which are kept up-to-date with latest changes in the HTML standard.

This release was made by the DAISY Consortium, for the W3C.

Note: This is alpha software! This release does not yet implement full support for all the changes in the EPUB 3.2 specifications.

Bug Fixes

• check MathML and XHTML content in epub:switch (976b9f6), closes #835
• messages of missing/incorrect locale cannot be translated (91fac12)

Features

• add 'authority' and 'term' as valid package metadata properties (2fe66cd)
• allow missing alttext or annotation-xml on MathML (e7bdbd2), closes #897
• deprecate epub:trigger and epub:switch (08123b2), closes #894 #895
• report aria-describedat as an ERROR (b4a9e7c), closes #896
• update the Package Document schema for EPUB 3.2 (1f12512), closes #883 #882 #881 #880 #879 #878 #877 #876
• update XHTML, SVG and MathML schemas (47d4926), closes #892 #779 #896 #893 #448
• API: deprecate EpubChecker#processEpubFile (3ed77fe)

EPUBCheck 4.1.0

This is a maintenance release of EPUBCheck, the conformance validator for EPUB publications. It includes various improvements and bug fixes that have been contributed over the past two years.

This release was made by the DAISY Consortium, for the W3C.

Many thanks to the various people who contributed to this release, including @bitsgalore, @kalaspuffar, @kamorrissey, @matthew-macgregor, @mkraetke, @murata2makoto, @takahashim, @tledoux… and especially Tobias Fischer (@tofi86), who has been the primary project maintainer after v4.0.2 and before the DAISY Consortium took over the maintenance role in October 2018!

Note: this release does not yet implement support for the newer EPUB 3.2 specifications.

Bug Fixes

• silence a Saxon warning (Schematron XSLT) (5045d78b), closes #859
• fix path resolution in EpubNCXCheck (ctc package) (f572a861)
• handle IllegalStateException in NCX checker (25336894), closes #666
• check that the mimetype file is uncompressed (6764e250), closes #303
• fix wrong exit message for single file validation (68af5a9a), closes #740
• allow ARIA role attributes in SVG (49412e05), closes #769
• allow empty xml:lang attributes (392c2f68), closes #777
• handle no src uri in fonts, correct embedded font boolean in the XML output (a26f9c13), closes #773
• fix issues with landmarks checks ACC-008 (74d0bdd1), closes #457, #734
• fix focus issue when using EPUBCheck in a GUI app (cd63a166), closes #665
• fix incorrect warning ACC_011 (5e6a69af), closes #680
• make the type attribute optional on SVG style elements (275f6b6a), closes #688
• exit with error when directory is not found in expanded mode (e42d189c), closes #525
• fix a NullPointerException when checking an empty meta rendition element in OPF (42d75297), closes #727
• fix DefaultReportImpl to avoid duplicate path info in message locations (9321355b), closes #729
• fix broken OPF_060 and OPF_061 message format (9f0e7d12), closes #658
• fix broken OPF_060 and OPF_061 checks for duplicate ZIP entries (05e96f40), closes #728

Features

• allow the configuration of EPUBCheck’s locale (9b249956), closes #650, #498
• report invalid dc:identifier UUIDs validation (as WARNING) (48800a04), closes #853
• change --version and -version command line options to output EPUBCheck version (e498c61d), closes #743
• check files with extensions other than .epub (1b67e046), closes #490
• report file:// URL as INFO (8f7a2b7d), closes #289
• improve messages for OPF-058 and OPF-059 (5e33645e), closes #804
• enable NCX_001 check also for EPUB 3 when an NCX file is present (9715c352)
• report non-matching identifiers in OPF and NCX as an error again (515682dc)
• improved css font size validation (25c0b372), closes #529
• issue a WARNING when landmarks anchors are not unique (557308ef), closes #493
• issue a WARNING when guide/reference elements are not unique (25f28c01), closes #493
• partial update of OPF 2.0 RelaxNG schema to latest version (changing datatype text to anyURI for href attributes) (251aa936), closes #725
• display error/warning count in EPUBCheck results (b7babedf), closes #655
• add file path info in uri attributes of the XML report (c958c117), closes #540
• update the XHTML 1.1 RelaxNG schema to latest version (4c6fb49a)
• update the OPF20 RNG schema in sync with official schema to validate empty guide elements (6540b03d)
• report an ERROR when @clipBegin equals @clipEnd in SMIL Media Overlays (00716768), closes #568
• improve Nav Doc validation (d32de854), closes #763, #759
• update the NCX RelaxNG schema to add fixed list of pageTarget type values (b2c9e939), closes #761
• improve URL checks (a44a596b), closes #708
• rephrase messages RSC-005, RSC-016, RSC-017 (5ef44973)
• add JHove XSD schema declaration in XML output (e55039c9), closes #736
• add detailed resource info in RSC-008 messages (5f5ef7b7), closes #720
• add detailed resource info in RSC-007 messages (71a76ee4), closes #475

Maintenance

• change the project name to 'EPUBCheck' (dfd7fd27)
• update the minimum source code compatibility to Java 1.7 (9b249956)
• update the Saxon dependency to v9.8 (bf10f380)
• update the Apache commons-compress dependency to v1.18 (e7dfedd8)
• update the Google Guava dependency to v24.0 (befd9fc3)
• update the continuous integration build matrix, now testing from Java 7 up to Java 11 (fb84b23c)
• various translation updates (39a9a093, 6e3a8b41)

EpubCheck 4.0.2

EpubCheck 4.0.2 is a maintenance release of the EPUB conformance checker.

Important security fix

This version includes a fix for a critical security vulnerability (CVE-2016-9487) which may, under some circumstances, enable a remote attacker to access arbitrary files on the system where EpubCheck is running.

All users should update to EpubCheck 4.0.2 as soon as possible.

Special thanks to Craig Arendt for having identified the vulnerability and disclosed it privately to EpubCheck's team 👍 .

Enhancements

• #673 – Enhanced XML report output:
  • #486 – @subMessage and @severity attributes on <message> element
  • #517 – Include list of all resources + media types
  • #670 – Fix illegal characters in XML output
• #657 – New method Archive.createArchive(File) to specify file paths when using this in 3rd party tools

Bug fixes

• Fix for critical vulnerability CVE-2016-9487
• #689 – Fix for unclosed ImageInputStreams on image file validation
• #678 – Clarify ACC-009 message: 'alt' -> 'alttext' attribute
• #686 – Make BitmapChecker.ImageHeuristics a public object
• #711 – Bugfix for false positive error messages due to locale settings

See the details in the list of issues closed since the last public release.

EpubCheck 4.0.1

EpubCheck 4.0.1 is a maintenance release of the EPUB conformance checker.

• Fixes a few issues that caused EpubCheck to erroneously report warnings or errors when checking valid EPUBs.
• Deprecates the aria-describedat attribute (now removed from ARIA 1.1)
• Includes updated localization of error messages in Dutch, French, German, Japanese, and Spanish. Many thanks to the translators: @Cuadratin, @takahashim, @vincent-gros, Merijn de Haen and especially to @tofi86 who also coordinated these contributions!

See details in the list of issues closed since the last public release.

EpubCheck 4.0.0

EpubCheck 4.0.0 is a stable release introducing conformance checking of EPUB Publications against the following specifications:

• EPUB 3.0.1
• EPUB Dictionaries and Glossaries 1.0
• EPUB Indexes 1.0
• EPUB Multiple-Rendition Publications 1.0
• EPUB Previews 1.0
• EPUB Region-Based Navigation 1.0

It also provides an early implementation of checks for the following draft specifications:

• EPUB 3 EDUPUB Profile
• EPUB Distributable Objects 1.0
• EPUB Scriptable Components Packaging and Integration 1.0

See also the complete list of issues closed since the last public release.

EpubCheck 4.0.0-alpha11

Changes since alpha 10:

• Remove excessive warning messages (#445, #444, #438, #441, #407, #379, #376)
• Add EDUPUB draft epub:type properties as a "staging" set included in the default vocabulary (#439)
• Do not consider the rendition vocabulary as part of the default vocabulary, but just as known vocabulary with a reserved prefix (#451, #437)
• Fix EDUPUB heading rules (#440)
• Collection link elements no longer cause false-negatives by being considered as duplicate of manifest entries. (#452, #443)
• Check that XHTML Content Document file names have the .xhtml extension (#454, #447)
• Removed dependency to proprietary deprecated GIFStreamMetadata java class (#417)

EpubCheck 4.0.0-alpha10

Pre-release of v4.0 that brings support for EPUB 3.0.1 and initial support for the EDUPUB profile.

Changes related to EPUB 3.0.1

• Package files (OPF)
  • new collection element
  • multiple dc:type elements are now allowed
  • multiple dc:source elements has now allowed
  • allow "record" as value of link rel attribute (requires media-type set)
  • new belongs-to-collection and collection-type metadata properties
  • new media:playback-active-class metadata property
  • new source-of metadata property
  • new rendition:* metadata properties
  • new reserved prefix schema for schema.org vocabularies
  • improved prefix declaration parsing
• XHTML Content Documents
  • RDFa and Microdata attributes are now allowed and checked for correctness
  • improved prefix declaration parsing
  • improved checking of epub:type attribute values
  • allows custom (namespaced) attributes on any element
  • new triggers ev:defaultAction, ev:phase and ev:propagate
  • new attribute aria-describedat
• SVG Content Documents
  • the epub:type attribute is now allowed on any element
• Structural semantics vocabulary
  • new term assessment
  • new term learning-objective
  • new term learning-resource
  • new term loa
  • new term lov
  • new term qna
  • new term revision-history

Changes related to EDUPUB

• Identification of EDUPUB content from the dc:type edupub
• Custom OPF checks for EDUPUB metadata rules
• Support for ditributable-object and manifest collections
• checks for epub:type semantics
• checks for headings-related rules

Changes to the internal EpubCheck's internals:

• Early parsing of dc:type in the OPFData object
• Possibility to set multiple XMLValidator (i.e. schemas) in most checkers
• Revamped prefix attribute parsing
• New API for representing vocabularies and property-datatype values.