WARNING: This document is OBSOLETE.

The EPUB Manifest Properties Vocabulary is now an appendix of the EPUB 3 Specification.

EPUB Manifest Properties Vocabulary

23 January 2017

Document history

Editors

Markus Gylling, International Digital Publishing Forum (IDPF)

Matt Garrish, Invited Expert

Copyright © 2010-2016 International Digital Publishing Forum™

All rights reserved. This work is protected under Title 17 of the United States Code. Reproduction and dissemination of this work with changes is prohibited except with the written permission of the International Digital Publishing Forum (IDPF).

EPUB is a registered trademark of the International Digital Publishing Forum.

Status of this Document

This document is subject to change at any time. The terms defined herein will never be removed, but may be deprecated.

Any use of terms marked [draft] should be considered experimental.

Deprecated term are identified by the label [deprecated]. These terms are no longer recommended for use.

Requests for additions, modifications and clarifications can be made through the Issue Tracker. Pull requests are also welcome.

Refer to the IDPF Issue Reporting Guidelines for more information about the change request process.

  1 Overview

  1.1 About this Vocabulary

This section is informative

This vocabulary defines a set of properties for describing various features of the Package Document [Packages3].

The properties in this vocabulary are usable in the various Package Document attributes that accept the property datatype [Packages3], and are grouped by the element and attribute that they can be used in.

  1.2 Referencing

Properties without a prefix are referenceable using the base IRI http://idpf.org/epub/vocab/package/#.

  1.3 Terminology

Terms with meanings specific to EPUB 3 are capitalized in this document (e.g., "Author", "Reading System"). 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.

  1.4 Conformance Statements

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 sections of this specification are normative except where identified by the informative status label "This section is informative". The application of informative status to sections and appendices applies to all child content and subsections they may contain.

All examples in this specification are informative.

  2 Manifest item Properties

The following tables define properties for use in the manifest item element [Packages3] properties attribute [Packages3].

The Applies to field indicates which Publication Resource type(s) the given property may be specified on, the Cardinality field indicates the number of times the property must appear within the Package Document scope, and the Usage field indicates usage conditions.

  2.1 cover-image

Name: cover-image
Description: The cover-image property identifies the described Publication Resource as the cover image for the Publication.
Applies to: All raster and vector image types [EPUB3]
Cardinality: Zero or one
Usage: Optional.

  2.2 mathml

Name: mathml
Description: The mathml property indicates that the described Publication Resource contains one or more instances of MathML markup.
Applies to: EPUB Content Documents
Cardinality: Zero or more
Usage: Must be set if and only if the criterion specified in the description is met.

  2.3 nav

  2.4 remote-resources

Name: remote-resources
Description:

The remote-resources property indicates that the described Publication Resource contains one or more internal references to other Publication Resources that are located outside of the EPUB Container.

Refer to Publication Resource Locations [EPUB3] for more information.
Applies to: All Publication Resources with the capability of internal referencing (e.g., XHTML Content Documents, SVG Content Documents, CSS Style Sheets and Media Overlay Documents).
Cardinality: Zero or more
Usage: Must be set if and only if the criterion specified in the description is met.

  2.5 scripted

Name: scripted
Description: The scripted property indicates that the described Publication Resource is a Scripted Content Document (i.e., contains scripted content and/or HTML form elements).
Applies to: EPUB Content Documents
Cardinality: Zero or more
Usage: Must be set if and only if the criterion specified in the description is met.

  2.6 svg

Name: svg
Description:

The svg property indicates that the described Publication Resource embeds one or more instances of SVG markup.

This property must be set when SVG markup is included directly in the resource and may be set when the SVG is referenced from the resource (e.g., from an [HTML] img, object or iframe element).
Applies to: XHTML Content Documents; the value is implied for SVG Content Documents.
Cardinality: Zero or more
Usage: Must be set if and only if the criterion specified in the description is met.

  2.7 Usage

The mathml, remote-resources and scripted properties must be specified whenever the resource referenced by an item matches their respective definitions. These properties do not apply recursively to content included into a resource (e.g., via the HTML iframe element). For example, if a non-scripted XHTML Content Document embeds a scripted Content Document, only the embedded document's manifest item properties attribute will have the scripted value.

  2.8 Examples

The following example shows a manifest item element [Packages3] that represents the EPUB Navigation Document.

<item properties="nav" id="c1" href="c1.xhtml" media-type="application/xhtml+xml" />

The following example shows a manifest item element that represents the cover image.

<item properties="cover-image" id="ci" href="cover.svg" media-type="image/svg+xml" />

The following example shows a manifest item element representing a Scripted Content Document that also contains embedded MathML.

<item properties="scripted mathml" id="c2" href="c2.xhtml" media-type="application/xhtml+xml" />

  References

Normative References

[EPUB3] EPUB 3.

[HTML] HTML.

[Packages3] EPUB Packages 3.