Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

[Publishing WG] CR Transition for pub manifest and audiobooks

Matt Garrish edited this page Oct 22, 2019 · 30 revisions

Document title, URLs, estimated publication date

Abstract

Status

Link to group's decision to request transition

[TODO: eg minutes, CfC in GitHub, email]

Changes

[TODO: focus on substantive changes]

Requirements Satisfied

[TODO: references to requirements]

Dependencies Met (or not)

JSON-LD 1.1 (on the @direction keyword usage)

Wide Review

Practically all the work happened on GitHub, see the separate section on issues below. This included comments from outside of the Working Group.

Horizontal Reviews

Issues Addressed

  • Publication Manifest:

    Note: the Publication Manifest document was originally developed within a larger framework called "Web Publications". That line of work has been paused, but the manifest part of the document was re-used as the starting basis for Publication Manifest. The issues for Web Publications listed below are only for completeness, because they (partially) contributed to the development of the Publication Manifest (the relevant open issues were transferred to the pub-manifest repository):

  • Audiobooks:

Formal Objections

None.

Implementation

Testing Strategy for Publication Manifest and Audiobooks

Interested implementers for Publication Manifest and Audiobooks will be provided with a test suite using the Web Platform tests model. These specifications will be testing all MUST and SHOULD statements, and for Audiobooks, there will be additional manual User Agent Behaviour tests. The Working Group will provide details for implementers on how to run the tests and assistance with any issues encountered. Implementers should log issues against the Github projects for visibility.

As Publication Manifest is largely a vocabulary of terms, a comparison of the vocabulary to the structures and metadata of the EPUB 3 Package Document will also be carried out. This comparison is intended to show that there is already real-world precedent in publishing for the information included in the manifest, and a pathway for translating EPUB content (and vice versa).

Additionally, implementations will need to show that they are capable of ingesting and transforming a manifest into an internal representation using the algorithm defined in the Publication Manifest document. These transforms ensure that any authoring conveniences used in the authored manifest are normalized and sanitized, and result in a predictable data structure.

Exit Criteria

Publication Manifest and Audiobooks must have at least 2 passing tests for each feature in the specifications. For the Audiobooks User Agent Behaviours tests, all implementations should meet all of the behaviour requirements that are applicable to them.

Patent Disclosures

See https://www.w3.org/2004/01/pp-impl/100074/status