26 April 2016
This document is subject to change at any time. The terms defined herein will never be removed, but may be deprecated.
Any use of the terms marked [DRAFT] should be considered experimental.
Deprecated term are identified by the label [DEPRECATED]. These terms are no longer recommended for use.
Terms without a label are considered stable.
Requests for additions, modifications and clarifications must be made through the EPUB 3 Issue Tracker.
This document defines relationships and properties for use with the EPUB® Package Document
link element
[Packages3].
Terms with meanings specific to EPUB 3.1 are capitalized in this document. A complete list of these terms and definitions is provided in [EPUB3].
Only the first instance of a term in a section is linked to its definition.
The following typographic conventions are used in this specification:
markupAll markup (elements, attributes, properties), code (JavaScript, pseudo-code), machine processable values (string, characters, media types) and file names are in red monospace font.
markupLinks to markup and code definitions are underlined and in red monospace font.
http://www.idpf.org/URIs are in navy blue monospace font.
Hyperlinks are underlined and in blue.
Normative and informative references are enclosed in square brackets.
Terms defined in the Terminology are in capital case.
Links to term definitions have a dotted blue underline.
Normative element, attribute and property definitions are in blue boxes.
Informative markup examples are in light gray boxes.
Informative notes are in green boxes with a "Note" header.
Informative cautionary note are in red boxes with a "Caution" header.
The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in [RFC2119].
All examples are informative.
The following values can be used in the link element rel
attribute to establish the relationship of the resource referenced in the href
attribute
[Packages3].
| Name: | acquire |
| Description: | The acquire relationship is used with EPUB Previews to identify where the full version of the EPUB Publication can be acquired. |
| Cardinality: |
Zero or more
|
| Example: |
<link rel="acquire"
href="http://example.org/book/9781448103706" media-type="text/html"/>
|
| Name: | alternate |
| Description: | The alternate relationship
identifies an alternative representation of the Package Document, when used in the
Package Document metadata, or the object represented by a
collection. |
| Cardinality: |
Zero or more
|
| Example: |
<link rel="alternate"
href="http://example.org/package.json" media-type="application/json-ld"/>
|
| Name: | marc21xml-record |
Use of the marc21xml-record relationship is deprecated. It is replaced
by the record relationship with the
media-type attribute
[Packages3] value
"application/marcxml+xml". |
|
| Name: | mods-record |
Use of the mods-record relationship is deprecated. It is replaced by the
record relationship with the media-type attribute
[Packages3] value "application/mods+xml". |
|
| Name: | onix-record |
Use of the onix-record relationship is deprecated. It is replaced by the
record relationship with the properties
attribute
[Packages3] value onix. |
|
| Name: | record |
| Description: |
Indicates that the referenced resource is a metadata record. The media type of the record must be identified in the If the type of record cannot be identified from the media type, an identifier property can be assigned in the |
| Cardinality: |
Zero or more
|
| Example: |
<link rel="record" href="book/52.atom"
media-type="application/atom+xml;type=entry;profile=opds-catalog"/>
|
| Name: | xml-signature |
| Description: |
The xml-signature relationship indicates the referenced resource contains an XML Signature [XML DSIG Core] for the EPUB Publication. The |
| Cardinality: |
Zero or more
|
| Example: |
<link rel="xml-signature"
href="../META-INF/signatures.xml#MAI-Signature"/>
|
| Name: | xmp-record |
Use of the xmp-record relationship is deprecated. It is replaced by the
record relationship with the properties
attribute value xmp. |
|
The following values can be used in the link element rel
attribute
[Packages3] to establish the type of record a referenced resource represents.
These values are provided for record formats that cannot be uniquely identified by their media type.
| Name: | onix |
| Description: | The onix property indicates the referenced resource is an ONIX record [ONIX]. |
| Cardinality: |
Zero or one
|
| Example: |
<link rel="record" href="pub/meta/nor-wood-onix.xml"
media-type="application/xml" properties="onix"/>
|
| Name: | xmp |
| Description: | The xmp property indicates the referenced resource is an XMP record [XMP]. |
| Cardinality: |
Zero or one
|
| Example: |
<link rel="record" href="pub/meta/nor-wood-xmp.xml
media-type="application/xml" properties="xmp"/>
|
[EPUB3] EPUB 3 .
[MODS] ONIX for Books .
[OCF3] Open Container Format 3 .
[Packages3] EPUB Packages 3 .
[RFC2119] Key words for use in RFCs to Indicate Requirement Levels (RFC 2119) . March 1997.
[XML DSIG Core] XML-Signature Syntax and Processing Version 1.1 . 3 March 2011.