Skip to content

Review h for references to annotation selector types which need updating following addition of EPUBContentSelector and PageSelector selectors #7803

Open
@robertknight

Description

@robertknight

As part of our overhauled EPUB support in the client, new selector types have been added. See the EPUBContentSelector and PageSelector definitions.

There are some references to the various selector types that the client uses in h:

  • API documentation
  • Web Annotations JSON-LD export

These new selectors are currently just returned in the JSON-LD version of an annotation unchanged, rather than mapped to some part of the Web Annotations spec.

The Web Annotations data model doesn't really have a good equivalent for these selectors. It does have examples of using FragmentSelector to indicate PDF pages and EPUB CFIs, so generating equivalent FragmentSelector(s) is one option. However those don't contain all the information of our selectors (eg. for EPUBContentSelector we include the chapter title and content document URL for added robustness to future content changes), and also has the nuisance of being stringly-typed. On the other hand, these fragment selectors are at least part of published specifications.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions