Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PR Request for EPUB 3.3, EPUB Reading Systems 3.3, and EPUB Accessibility 1.1 #496

Closed
iherman opened this issue Apr 3, 2023 · 2 comments
Closed

PR Request for EPUB 3.3, EPUB Reading Systems 3.3, and EPUB Accessibility 1.1 #496

iherman opened this issue Apr 3, 2023 · 2 comments
Assignees
@iherman
Labels
Awaiting Publication Approved by the Director, waiting on publication Entering PR Proposed Recommendation wg:epub wg:pm

Comments

@iherman
Copy link
Member

iherman commented Apr 3, 2023

Document titles, URLs, estimated publication dates

Abstract

Status

Will new features be allowed to be incorporated in the Recommendation?

No.

Link to group's decision to request transition

Changes

Requirements satisfied

Quoting from the main requirements in the WG charter:

[…] the interoperability of EPUB 3 content, and the conformance of EPUB 3 reading systems, remain a serious issue. There is a need for a more rigorous and comprehensive testing of EPUB 3; this may also mean the need for a further clarification of the standard text itself. […] The EPUB 3 Working Group will advance, refine, and clarify the EPUB 3 standard to ensure its relevance as digital publishing continues to evolve, and specify a comprehensive testing environment for EPUB 3.

The WG has:

  • Reviewed, restructured, and updated the former EPUB 3.2 documents and made numerous changes to the texts for clarification, handling possible specification bugs, to make the specifications more precise. Although the change logs show many issues that have been handled (the change logs, together, contain references for over 120 substantial issues, i.e., these do not account for the purely editorial changes) only a handful of those are genuinely new technical features, mostly to answer to internationalization and to security issues.
  • The working group has set up a functional testing environment to contribute to the interoperability of EPUB Reading Systems.
  • The working group has published test results for 18 implementations.

The WG believes that fully satisfied the requirement for the clarifications needed in the specification, as well as establishing a comprehensive testing environment.

Dependencies met (or not)

There were no major dependencies.

Wide Review

Horizontal reviews:

See horizontal review tracker.

The WG discussions were conducted through github issues. The group took over the repository used to develop earlier versions of EPUB, and that meant ≈100 open issues at the time the Working Group started (September 2020); some of those were around for years. During the lifetime of the Working Group ≈499 issues were added, coming both from the wider community and the Working Group itself, with the participation of experts outside the group.

Issues addressed

The change log items listing the substantial changes, i.e.:

include references to the issues that were addressed by those changes.

Formal Objections

None.

Implementation

The exit criteria of the Working Group are described in:

Reports of the testing and implementation results can be found here:

There are numerous EPUB 3 Reading System implementations on the market, some major ones are represented on the Working Group (Google, Apple, Kobo, EDRLab, VitalSource, Colibrio, etc.). We have received testing results from all of these participants, and more. Also, the group has numerous contacts with Publishers, as well as accessibility organizations, who have contributed to the CR testing of, e.g., vocabularies.

Finally, there is a strong cooperation between the Working Group and the developers of EPUBCheck, that already has a beta version of an EPUB 3.3 checker. (This is particularly important, because epubcheck is used by virtually all publishers before releasing a new publication.) You can find results of EPUBCheck testing here: https://w3c.github.io/epub-structural-tests/

Patent disclosures

Additional note on PR Transition

The Working Group's charter has a very strong clause on backwards compatibility:

Any existing valid EPUB 3.2 should remain valid under EPUB 3.X, unless it relies on features discovered to have serious issues (such as a security bug).

What this means that the usual CR approach, whereby if a feature does not get the right number of implementation per the exit criteria must be removed from the specification, cannot be applied in this case. Instead, the WG has introduced a special category called "under-implemented features" to mark those features in the final publication.

Only one feature was found during testing to require this category: https://www.w3.org/TR/epub-33/#attrdef-dir. We have kept this feature in due to its importance for i18n support.

cc @wareid @dauwhe @shiestyle @mattgarrish
@iherman iherman added Entering PR Proposed Recommendation [DO NOT USE] Awaiting Director Deprecated. Use Awaiting Team Verification. labels Apr 3, 2023
@plehegar
Copy link
Member

plehegar commented Apr 7, 2023

Recent TAG: w3ctag/design-reviews#816
Recent PING: w3cping/privacy-request#114

Approved. Nice work on the implementation reports.

@plehegar plehegar assigned iherman and unassigned plehegar Apr 7, 2023
@plehegar plehegar added Awaiting Publication Approved by the Director, waiting on publication and removed [DO NOT USE] Awaiting Director Deprecated. Use Awaiting Team Verification. labels Apr 7, 2023
@iherman
Copy link
Member Author

iherman commented Apr 19, 2023

PR published, see https://www.w3.org/2002/09/wbs/33280/epub-pr/

@iherman iherman closed this as completed Apr 19, 2023
@iherman iherman mentioned this issue May 16, 2023
Closed
@tmichel07 tmichel07 mentioned this issue Aug 29, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iherman iherman

Labels
Awaiting Publication Approved by the Director, waiting on publication Entering PR Proposed Recommendation wg:epub wg:pm
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@iherman @plehegar @w3cbot