Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 3 KB

relationships.md

File metadata and controls

32 lines (24 loc) · 3 KB

Link Relations

The Readium Web Publication Manifest specification and its extensions currently define and/or use the following link relations:

Relation Definition Reference
alternate Designates a substitute for the link's context HTML5
contents Refers to a table of contents HTML4
cover Refers to a publication's cover Readium Web Publication Manifest
manifest Links to a manifest Web App Manifest
search Refers to a URI or templated URI that will perform a search HTML5
self Conveys an identifier for the link's context Atom Syndication Format

In addition to these relations, any term define in the IANA link registry can also be used.

Extensions must either be registered on this repo or rely on URIs.

OPDS 2.0

While OPDS 2.0 itself is not an extension of the Readium Web Publication Manifest, it shares the same abstract model and syntax.

For this reason, it feels relevant to list the link relations introduced by OPDS as well.

Relation Definition Reference
http://opds-spec.org/acquisition Fallback acquisition relation when no other relation is a good fit to express the nature of the transaction. OPDS 1.2
http://opds-spec.org/acquisition/open-access Indicates that a publication is freely accessible without any requirement, including authentication. OPDS 1.2
http://opds-spec.org/acquisition/borrow Indicates that a publication can be borrowed for a limited period of time. OPDS 1.2
http://opds-spec.org/acquisition/buy Indicates that a publication can be purchased for a given price. OPDS 1.2
http://opds-spec.org/acquisition/sample Indicates that a sub-set of the full publication is freely accessible at a given URI, without any prior requirement. OPDS 1.2
preview Indicates that a sub-set of the full publication is freely accessible at a given URI, without any prior requirement. RFC 6903
http://opds-spec.org/acquisition/subscribe Indicates that a publication be subscribed to, usually as part of a purchase and for a limited period of time. OPDS 1.2