-
Notifications
You must be signed in to change notification settings - Fork 10
Publication Manifest to EPUB Mapping
Matt Garrish edited this page Nov 19, 2019
·
35 revisions
This document provides mappings from the Publication Manifest format to EPUB's Package Document.
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| @context/language | package[@xml:lang] | Global manifest/package language declaration. |
| term/language | metadata/meta[@xml:lang] | Local language overrides. |
| inLanguage | dc:language | Language of the publication. |
| @context/direction | package[@dir] | Global manifest/package direction declaration. |
| term/direction | metadata/meta[@dir] | Local direction overrides. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| type | (none) | The type of publication. EPUB does not have an equivalent in the specification, but can be expressed as meta[@property=rdf:type]. |
| conformsTo | dc:type | The profile the publication conforms to. EPUB uses reserved keywords instead of URLs for profiles. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| readingOrder | spine | Default progression through the content. EPUB uses references to the manifest, while the Package Document uses a list of resources. |
| resources | manifest | Identifies the resources of the publication. The EPUB manifest is the complete set of resources, while Pub Manifest uses a union of readingOrder and resources. |
| links | metadata/link | Linked resources. EPUB does not separate the links from the other publication metadata, but the links themselves. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| LinkedResource/rel= accessibility-report | link[@rel=a11y:certifierReport] | Accessibility report for the publication. EPUB use is defined in the Accessibility specification. |
| LinkedResource/rel= contents | item[@properties=nav] | Identifies the document containing the table of contents. EPUB requires all navigation aids in the navigation document, so does not uniquely identify the resources within it. |
| LinkedResource/rel= cover | item[@properties= cover-image] | EPUB only identifies cover images. Pub Manifest allows any resource to be identified as the cover. |
| LinkedResource/rel= pageList | item[@properties=nav] | Identifies the document containing the page list. EPUB requires all navigation aids in the navigation document, so does not uniquely identify the resources within it. |
| LinkedResource/rel= preview | dc:type=preview | A preview for the publication. EPUB use is defined in the Previews specification. EPUB defines entire publications as previews and also embeds previews using collections. |
| LinkedResource/rel= privacy-policy | (none) | Privacy policy for the publication. EPUB does not have an equivalent in the specification, but could be expressed as link[rel=privacy-policy] once registered. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| accessibilityFeature | meta[@property= schema:accessibilityFeature] | Accessibility features of the publication. EPUB use is defined in the Accessibility specification. |
| accessibilityHazard | meta[@property= schema:accessibilityHazard] | Potential hazards from the content. EPUB use is defined in the Accessibility specification. |
| accessibilitySummary | meta[@property= schema:accessibilitySummary] | Human-readable summary of the accessibility. EPUB use is defined in the Accessibility specification. |
| accessMode | meta[@property= schema:accessMode] | Access modes of the content. EPUB use is defined in the Accessibility specification. |
| accessModeSufficient | meta[@property= schema:accessibilityFeature] | Sufficient set(s) of access modes that allow consumption of the content. EPUB use is defined in the Accessibility specification. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| LinkedResource/alternate | item[@fallback] | An alternate format representation of a resource. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| duration | meta[@property= media:duration] | Total duration of the publication. |
| LinkedResource/length | meta[@property= media:duration][@refines=idref] | Duration of a resource. EPUB uses meta tags to associated a duration with a resource, whereas Pub Manifest can express the duration directly with the resource. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| abridged | (none) | Whether the publication is abridged. EPUB does not have an equivalent in the specification, but can be expressed as meta[@property=schema:abridged]. |
| creator (artist, author, etc.) | dc:creator, dc:contributor + meta[@role] | Creators of the publication. EPUB "refines" the DC elements to add roles. |
| datePublished | dc:date | Date the publication was published. |
| dateModified | dcterms:modified | Last modification date of the publication. |
| id | package[@unique-identifier] - dc:identifier | Unique identifier for the publication. |
| name | dc:title | Title of the publication. |
| readingProgression | spine[@page-progression-direction] | The content flow direction. EPUB's use is more specifically tied to the expected rendering (e.g., page loading for fixed layouts). |
| url | (none) | Address of the publication. EPUB does not have an equivalent in the specification, but can be expressed as meta[@property=schema:url]. |
| Publication Manifest | EPUB 3 Package Document | Explanation |
|---|---|---|
| @context/{"prefix":} | package[@prefix] | Ability to define prefixes to import terms from additional vocabularies |
| LinkedResource/rel= describedby | link[rel=record] | Linked metadata records. The "record" relation used by EPUB is not registered with IANA. |
The following table lists features from the EPUB 3 Packages specification that are not supported or a key part of the Publication Manifest specification.
| EPUB 3 Feature | Explanation |
|---|---|
| Package Version | The version number is static across major versions of EPUB so it isn't necessary to replicate or store in the manifest. |
| @refines | The refines attribute is unnecessary in a publication manifest as metadata is not forced to be flattened. It would be possible to combine/flatten structures during translation. |
| Dublin Core Optional Elements |
The following elements do not have a parallel in the Publication Manifest: coverage, description, subject, format, relation, rights, source and subject. All of these can be included in a manifest, however, as the dc prefix is part of the initial context. |
| Linear Content | The publication manifest does not require non-linear content in the reading order, so does not distinguish it. |
| Content Overflow Handling | Indicates whether the author prefers to have overflow content paginated or scrolled. No profiles yet that prove a need for this to be universally handled in the Publication Manifest specification. |
| Fixed Layout Metadata | No profiles yet that prove a need for fixed layouts to be universally handled in the Publication Manifest specification. |
| Collections | Collections are like mini-package documents within the package document. Accommodating them would similarly require a manifest-like set of objects, presumable under a collections property. There seems to be limited to no uptake of collections in EPUB, however, despite a few specifications that use them (e.g., previews, indexes and dictionaries). |