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

Jump to bottom
Matt Garrish edited this page Oct 23, 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

Major changes to Publication Manifest since FPWD include:

  • removal of the "canonical manifest" as a json-ld representation and focus on "internal representation";
  • addition/use of "language" and "direction" keywords in the JSON-LD context for expressing the global language and direction of manifest text (also for local overrides) - inLanguage now only identifies the language(s) of the content;
  • clarification of how the base URL for the manifest is obtained;
  • a significant rewrite of the manifest processing algorithm to use the Infra specification language and data types;
  • move of WebIDL representation of the internal representation to an informative appendix;
  • the addition of the alternative property to provide alternative media representations of resources;
  • the addition of the required conformsTo property to identify the profile a manifest conforms to;

A list of all changes to Publication Manifest since FPWD is available at: https://github.com/w3c/pub-manifest/commits/master

Requirements Satisfied

The Publication Manifest specification partially meets the original objective of defining Web Publications. Work on Web Publications was suspended due to a lack of interest at this time from publishers, plus significant differences of opinion in terms of how they are expected to function on the web and in browsers. The group generally agreed on the manifest format for expressing information about publications, so driving Publication Manifest forward puts a stake in the ground for returning to Web Publications, while also enabling the creation of other formats for which there is more interest (audiobooks). Defining a common manifest format also aids in future interoperability, which was another goal of Web Publications. The Publication Manifest format is also largely translatable to and from the EPUB 3 Package Document, so it also provides a potential future pathway for an EPUB 4, another goal of Web Publications.

In terms of the Use Cases and Requirements for Web Publications, Publication Manifest satisfies the following manifest-based requirements:

  • Req 1. Make use of OWP features -
  • Req 2. Horizontal dependencies -
  • Req 4. Identification of publication -
  • Req 5. Identification of resources -
  • Req 6. Metadata -
  • Req 7. Resource discoverability and importance -
  • Req 8. Default reading order -
  • Req 9. Table of contents -
  • Req 13. Alternative media -
  • Req 15. Data resources -

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

Clone this wiki locally