Copyright © 1999-2019 International Digital Publishing Forum™ and W3C® (MIT, ERCIM, Keio, Beihang)
EPUB is a registered trademark of the International Digital Publishing Forum.
EPUB® 3 defines a distribution and interchange format for digital publications and documents. The EPUB format provides a means of representing, packaging and encoding structured and semantically enhanced Web content — including HTML, CSS, SVG and other resources — for distribution in a single-file container. This specification represents the second major revision of the standard.
EPUB 3 has been widely adopted as the format for digital books (ebooks), and this revision continues to increase the format's capabilities in order to better support a wider range of publication requirements, including complex layouts, rich media and interactivity, and global typography features. The expectation is that the EPUB 3 format will be utilized for a broad range of content, including books, magazines and educational, professional and scientific publications.
EPUB 3 is modular in nature: it consists of a family of specifications that define the core features and functionality of the standard. This specification represents the primary entry point to standard, but the specifications listed in Specifications are all a part of EPUB 3. An index to key concepts and definitions defined across these specifications is provided at the end of this specification.
The informative [EPUB3Overview] provides a general introduction to EPUB 3. A list of technical changes from the previous revision is also available in the informative [EPUB32Changes].
This specification was published by the EPUB 3 Community Group. It is not a W3C Standard nor is it on the W3C Standards Track. Please note that under the W3C Community Final Specification Agreement (FSA) other conditions apply. Learn more about W3C Community and Business Groups.
If you wish to make comments regarding this document, please send them to public-epub3@w3.org (subscribe, archives).
The EPUB 3 standard is modular in nature, with core features and functionality defined across a family of sub-specifications.
This specification represents the top-most specification in the family. It includes the conformance requirements for both EPUB Publications (the product of the standard) and EPUB Reading Systems (the applications that consume EPUB Publications and present their content to users).
The other specifications that comprise EPUB 3 are as follows:
EPUB Packages [Packages32] — defines requirements for each Rendition of the content.
EPUB Content Documents [ContentDocs32] — defines profiles of XHTML, SVG and CSS for use in the context of EPUB Publications.
EPUB Media Overlays [MediaOverlays32] — defines a format and a processing model for synchronization of text and audio.
EPUB Open Container Format (OCF) [OCF32] — defines a file format and processing model for encapsulating a set of related resources into a single-file (ZIP) EPUB Container.
EPUB Accessibility [EPUBAccessibility] — defines accessibility conformance and discovery requirements for EPUB Publications.
These specifications represent the formal list recognized as belonging to EPUB 3, and that contain functionality referenced as part of the standard. New functionality is also added periodically through the development of extension specifications. Features and functionality defined outside of core revisions to the standard, while not formally recognized in this specification, are nonetheless available for use by Authors and Reading System developers.
This section is non-normative.
This section reviews the organization of the EPUB specifications through the central product they define: the EPUB Publication.
An EPUB Publication consists of one or more Renditions of its content, each of which is represented by what is called an EPUB Package. An EPUB Package consists of all the resources needed to render the content. The key file among these is the Package Document, which includes all the metadata used by Reading Systems to present the EPUB Publication to the user (e.g., the title and author for display in a bookshelf, as well rendering metadata such as whether content has a fixed layout or can be reflowed). It also provides a complete manifest of resources, and includes a spine that lists the sequence to render documents in as a user progresses through the content.
An EPUB Package also include another key file called the EPUB Navigation Document. This document provides critical navigation capabilities, such as the table of contents, that allow users to quickly and easily navigate the content.
The requirements for EPUB Packages are defined in [Packages32].
The EPUB Publication's resources are bundled for distribution in a ZIP-based archive with the file
extension .epub. As conformant ZIP archives, EPUB Publications can be unzipped by many
software programs, simplifying both their production and consumption.
The container format not only provides a means of determining that the zipped content represents an
EPUB Publication (the mimetype file), but also provides a universally-named directory
of informative resources (/META-INF). Key among these resources is the
container.xml file, which directs Reading Systems to the available Package
Documents.
The container format is defined in [OCF32].
The following example visually represents the structure of the EPUB format.
The structure and containment of an EPUB Publication is only one half of the format, the other half being the content that gets presented to users. This content is built on the Open Web Platform and comes in two flavours: XHTML and SVG. Called EPUB Content Documents, these documents typically reference many additional resources required for their proper rendering, such as images, audio and video clips, scripts and style sheets.
Detailed information about the rules and requirements for the production of EPUB Content Documents is provided in [ContentDocs32], and accessibility requirements are defined in [EPUBAccessibility].
Media Overlay Documents complement EPUB Content Documents. They provide declarative markup for synchronizing the text in EPUB Content Documents with prerecorded audio. The result is the ability to create a read-aloud experience where text is highlighted as it is narrated. Media Overlay Documents are defined in [MediaOverlays32].
While conceptually simple, an EPUB Publication is more than just a collection of HTML pages and dependent assets in a ZIP package as presented here. Additional information about the primary features and functionality that EPUB Publications provide to enhance the reading experience is available from the referenced specifications, and a more general introduction to the features of EPUB 3 is provided in the informative [EPUB3Overview].
The following terms are specific to EPUB 3. They are capitalized wherever used.
Only the first instance of a term in a section is linked to its definition.
The person(s) or organization responsible for the creation of an EPUB Publication. The Author is not necessarily the creator of the content.
The area within the Viewport dedicated to the display of EPUB Content Documents. The Content Display Area excludes any borders, margins, headers, footers or other decoration a EPUB Reading System might inject into the Viewport.
In the case of synthetic spreads, the Viewport contains two Content Display Areas.
A Publication Resource that does not require the provision of a fallback (cf. Foreign Resource).
The ZIP-based packaging and distribution format for EPUB Publications defined in OCF ZIP Container [OCF32].
A Publication Resource with an XHTML or SVG media type that contains all or part of the content of an EPUB Publication (i.e., the textual, visual and/or audio content). These resources have to conform to their respective XHTML or SVG definitions to be used in the spine or be referenced from another EPUB Content Document.
An EPUB Content Document is a Core Media Type Resource, so can be included in the EPUB Publication without the provision of fallbacks.
A specialization of the XHTML Content Document that contains human- and machine-readable global navigation information. The EPUB Navigation Document conforms to the constraints expressed in EPUB Navigation Document [Packages32].
A logical document entity consisting of a set of interrelated resources representing one Rendition of an EPUB Publication, as defined by a Package Document.
A collection of one or more Renditions that conform to this specification, packaged in an EPUB Container.
An EPUB Publication typically represents a single intellectual or artistic work, but this specification does not circumscribe the nature of the content.
A system that processes EPUB Publications for presentation to a user in a manner conformant with this specification.
An EPUB Content Document directly referenced from the spine that has been
designated pre-paginated in the Package Document, as defined in The rendition:layout Property
[Packages32].
The dimensions to use for rendering Fixed-Layout Documents are defined in Fixed Layouts [ContentDocs32].
A Publication Resource that is not a Core Media Type Resource. Foreign Resources are subject to the fallback requirements defined in Foreign Resources.
A resource that is located inside the EPUB Container.
Refer to Publication Resource Locations for media type specific rules for resource locations.
A list of all Publication Resources that constitute the given Rendition of a EPUB Publication.
Refer to manifest [Packages32] for more information.
An XML document that associates the XHTML Content Document with pre-recorded audio narration in order to provide a synchronized playback experience, as defined in [MediaOverlays32].
A Publication Resource that describes one Rendition of an EPUB Publication, as defined in Package Document [Packages32]. The Package Document carries meta information about the Rendition, provides a manifest of resources and defines the default reading order.
A resource that contains content or instructions that contribute to the logic and rendering of at least one Rendition of an EPUB Publication. In the absence of this resource, the EPUB Publication might not render as intended by the Author. Examples of Publication Resources include a Rendition's Package Document, EPUB Content Document, CSS Style Sheets, audio, video, images, embedded fonts and scripts.
With the exception of the Package Document itself, the Publication Resources necessary to render a Rendition are listed in that Rendition's manifest [Packages32] and bundled in the EPUB Container file (unless specified otherwise in Publication Resource Locations).
Examples of resources that are not Publication Resources include those identified by the
Package Document link [Packages32] element
and those identified in outbound hyperlinks that resolve to Remote Resources (e.g.,
referenced from the href attribute of an [HTML] a element).
The Release Identifier allows any instance of an EPUB Publication to be compared against another to determine if they are identical, different versions, or unrelated.
Refer to Release Identifier [Packages32] for more information.
A resource that is located outside of the EPUB Container, typically, but not necessarily, online.
Refer to Publication Resource Locations for media type specific rules for resource locations.
One rendering of the content of an EPUB Publication, as expressed by an EPUB Package.
An EPUB Content Document that includes scripting or an XHTML Content Document that contains [HTML] forms.
Refer to Scripting [ContentDocs32] for more information.
An ordered list of Publication Resources, typically EPUB Content Documents [Packages32], representing the default reading order of the given Rendition of an EPUB Publication.
Refer to spine [Packages32] for more information.
An EPUB Content Document that conforms to the constraints expressed in SVG Content Documents [ContentDocs32].
The rendering of two adjacent pages simultaneously on a device screen.
The rendering of the textual content of an EPUB Publication as artificial human speech using a synthesized voice.
An EPUB Content Document referenced from the spine, whether directly or via a fallback chain [Packages32].
The Unique Identifier is the primary identifier for an EPUB Publication, as identified
by the unique-identifier attribute [Packages32]. The Unique Identifier
can be shared by one or more Renditions of the same EPUB Publication.
Significant revision, abridgement, etc. of the content requires a new Unique Identifier.
The region of an EPUB Reading System in which an EPUB Publication is rendered visually to a user.
An EPUB Content Document that conforms to the profile of [HTML] defined in XHTML Content Documents [ContentDocs32].
XHTML Content Documents use the XHTML syntax defined in [HTML].
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The key words MAY, MUST, MUST NOT, RECOMMENDED, SHOULD, and SHOULD NOT are to be interpreted as described in [RFC2119].
An EPUB Publication MUST meet all of the following criteria:
It MUST include one or more EPUB Packages, each of which MUST conform to the requirements defined in [Packages32].
It SHOULD conform to the accessibility requirements defined in [EPUBAccessibility].
All Publication Resources MUST adhere to the constraints for Core Media Type and Foreign Resources and be located as per Publication Resource Locations.
It MUST be packaged in a EPUB Container as defined in [OCF32].
An EPUB Reading System MUST meet all of the following criteria:
It MUST process the EPUB Container as defined in [OCF32].
It MUST process EPUB Packages as defined in [Packages32].
It MAY support an arbitrary set of Foreign Resource types, and MUST process fallbacks for unsupported Foreign Resources as defined in Foreign Resources if not.
It SHOULD support remote resources, as defined in Resource Locations.
It MUST process XHTML Content Document as defined in XHTML Content Documents — Reading System Conformance [ContentDocs32].
It MUST process SVG Content Documents as defined in SVG Content Documents — Reading System Conformance [ContentDocs32].
If it has a Viewport, it MUST support visual rendering of XHTML Content Documents as defined in CSS Style Sheets — Reading System Conformance [ContentDocs32].
If it has a Viewport, it MUST support the image Core Media Type Resources.
If it has the capability to render pre-recorded audio, it MUST support the audio Core Media Type Resources and SHOULD support Media Overlays [MediaOverlays32].
If it supports Text-to-Speech (TTS) rendering, it SHOULD support Pronunciation Lexicons [ContentDocs32], [CSS3Speech] and SSML attributes [ContentDocs32] in XHTML Content Documents.
It is recommended that Reading Systems support at least one of the H.264 [H264] and VP8 [RFC6386] video codecs, but this is not a conformance requirement – a Reading System might support other video codecs, or none at all. Authors and Reading System developers need to take into consideration factors such as breadth of adoption, video playback quality, and technology usage royalty requirements when making a choice to include or implement video in either format, or both.
It SHOULD meet the accessibility requirements for Reading Systems in [EPUBAccessibility].
It MUST attempt to process any given rendition of an EPUB
Publication whose Package Document version attribute is less than
"3.0".
EPUB Publications with older version numbers will not always render exactly as intended unless processed according to their respective specifications. Reading Systems SHOULD support such EPUB Publications as defined by those specifications.
It SHOULD attempt to process any given Rendition of an EPUB
Publication whose Package Document version attribute is greater than
"3.0".
It MUST be a conformant non-validating processor [XML].
It MUST be a conformant processor as defined in [XML-NAMES].
It MUST be a conformant application as defined by [XMLBase]. Note: [HTML] and [SVG] are removing support for [XMLBase]. Authors are advised to avoid using this feature.
A conforming Reading System is not necessarily a single dedicated program or device, but might exist as a distributed system.
Each Rendition of an EPUB Publication typically consists of many Publication Resources. These resources are divided into two categories: those that can be included without fallbacks (Core Media Type Resources) and those that cannot (Foreign Resources).
Authors are free to use both types of resources to construct their EPUB Publications, but need to be aware that some Reading Systems might not render the Foreign Resources they use.
As EPUB Publications are designed to be fully consumable on any compliant Reading System, a system of fallbacks is necessary to ensure that the use of Foreign Resources does not impact on the ability of the user to consume the content. This section lists the set of Core Media Type Resources and identifies fallback mechanisms that can be used to satisfy the consumability requirement.
Publication Resources that conform to the following MIME media type [RFC2046] specifications can be included in an EPUB Publication without fallbacks.
The columns in the following table represent the following information:
Media Type—The MIME media type [RFC2046] used to represent the given Publication Resource in the manifest [Packages32].
If more than one media type is listed, the first one is the preferred media type. The preferred media type is strongly encouraged for all new EPUB Publications.
| Media Type | Content Type Definition | Applies to |
|---|---|---|
| Images | ||
image/gif
|
[GIF] | GIF Images |
image/jpeg
|
[JPEG] | JPEG Images |
image/png
|
[PNG] | PNG Images |
image/svg+xml
|
SVG Content Documents [ContentDocs32] | SVG documents |
| Audio | ||
audio/mpeg |
[MP3] | MP3 audio |
audio/mp4
|
[MPEG4-Audio], [MP4] | AAC LC audio using MP4 container |
| Video | ||
| EPUB 3 allows any video codecs to be included without fallbacks, although none are technically considered Core Media Type Resources. Refer to the note in EPUB Publications — Reading System Conformance for informative recommendations on support for video codecs in EPUB Publications. | ||
| Style | ||
text/css
|
CSS Style Sheets [ContentDocs32] | CSS Style Sheets. |
| Fonts | ||
| EPUB 3 allows any font resource to be included without a fallback, as CSS already defines fallback rules for fonts. Refer to EPUB Content Documents for support requirements in EPUB Publications. | ||
font/ttfapplication/font-sfnt
|
[TrueType] | TrueType fonts |
font/otfapplication/font-sfntapplication/vnd.ms-opentype
|
[OpenType] | OpenType fonts |
font/woffapplication/font-woff
|
[WOFF] | WOFF fonts |
font/woff2
|
[WOFF2] | WOFF2 fonts |
| Other | ||
application/xhtml+xml
|
XHTML Content Documents [ContentDocs32] | XHTML Content Documents that use the XHTML syntax [HTML]. |
application/javascripttext/javascript
|
[RFC4329] | Scripts. |
application/x-dtbncx+xml
|
[OPF2] | The legacy NCX. |
application/smil+xml
|
[MediaOverlays32] | EPUB Media Overlay documents |
application/pls+xml
|
[PRONUNCIATION-LEXICON] | Text-to-Speech (TTS) Pronunciation lexicons |
Foreign Resources MAY be included in an EPUB Publication without
a fallback provided they are not referenced from spine itemref elements [Packages32] or directly rendered in their
native format in EPUB Content Documents (e.g., via [HTML] embedded content and
[SVG] image and
foreignObject elements).
This exception allows Authors to include resources in the EPUB Container that are not for use by EPUB Reading Systems. The primary case for this exception is to allow data files to travel with an EPUB Publication, whether for use by scripts in its constituent EPUB Content Documents or for use by external applications (e.g., a scientific journal might include a data set with instructions on how to extract it from the EPUB Container).
When a Foreign Resource is included in the spine or directly rendered in its native format in an EPUB Content Document, a fallback Core Media Type Resource MUST be included. Fallbacks take one of the two following forms:
intrinsic fallback mechanisms provided by the format (e.g., ability to provide more than one media type or to display an alternate embedded message when a media type cannot be rendered);
Manifest fallbacks are a feature of the Package Document that create fallback chains to
Core Media Type Resources. They are used to create fallbacks for Foreign Resources in the spine [Packages32] and when intrinsic
fallback capabilities are not available (e.g., for the [HTML] img element).
Refer to the [HTML] and [SVG] specifications for the intrinsic fallback capabilities their elements provide.
All Publication Resources MUST be located in the EPUB Container, with the following exceptions:
Audio resources MAY be located outside the EPUB Container.
Video resources MAY be located outside the EPUB Container.
Resources retrieved by scripts MAY be located outside the EPUB Container.
Font resources MAY be located outside the EPUB Container.
Authors are encouraged to locate audio, video and script resources inside the EPUB Container whenever feasible to allow users access to the entire presentation regardless of connectivity status.
The rules in this section for Publication Resource locations apply regardless of whether the given resource is a Core Media Type Resource or a Foreign Resource.
The inclusion of Remote Resources in an EPUB Publication is indicated via the remote-resources property on the
manifest
item element [Packages32].
Any Publication Resource that is an XML-Based Media Type MUST meet the following constraints:
It MUST be a conformant XML 1.0 Document as defined in Conformance of Documents [XML-NAMES].
External identifiers MUST NOT appear in the document type declaration [XML].
It MUST NOT make use of XInclude [XInclude].
It MUST be encoded in UTF-8 or UTF-16 [Unicode].
The above constraints apply regardless of whether the given Publication Resource is a Core Media Type Resource or a Foreign Resource.
This specification and its siblings contain certain features that are no longer recommended for use or that are only retained for legacy support reasons. This section defines the meanings of the designations attached to these features and the support expectations for such features.
A deprecated feature is one that is no longer recommended for use in this version of the specification. Deprecated features typically have had limited or no support in Reading Systems and/or usage in EPUB Publications. If a feature is marked as deprecated, the following hold true:
Authors are strongly RECOMMENDED not to use the feature in their EPUB Publications.
Reading Systems MAY support the feature.
Developers are advised to consider the unlikelihood of encountering content with deprecated features before adding new support for them.
Validation tools SHOULD alert Authors that inclusion of the feature is deprecated when encountered in an EPUB Publication.
A legacy feature is one that is retained only for authoring content that is compatible with versions of EPUB prior to 3.0. If a feature is marked as legacy, the following hold true:
Authors MAY include the legacy feature for compatibility purposes.
Reading Systems MUST NOT support the legacy feature in content that conforms to this version of EPUB.
Validation tools SHOULD NOT alert Authors about the presence of legacy features in an EPUB Publication, as their inclusion is valid for backwards compatibility. Validation tools MUST alert Authors if a legacy feature does not conform to its definition or otherwise breaks a usage requirement.
This section is non-normative.
This index identifies where key concepts are defined in EPUB 3, including element, attribute and property definitions.
content dimensions [ContentDocs32]
SVG initial containing block (viewBox)
XHTML initial containing block (viewport meta)
Media Overlays Documents [MediaOverlays32]
semantic inflection (epub:type)
OCF abstract container [OCF32]
media type identification (mimetype)
obfuscation (was font obfuscation)
fixed layout properties — see also fixed layouts
dcterms:modified property (last modified date)
contexts (container-constrained and spine-level)
vocabularies
XHTML Content Documents [ContentDocs32]
discouraged
constructs (rp and embed)
RDFa and microdata (semantic enrichment)
This section is non-normative.
EPUB 3 is developed by the W3C's EPUB 3 Community Group in coordination with the Publishing Business Group.
The EPUB 3.2 revision was led by:
In addition to the editors, this version of EPUB would not have been possible without significant contributions from:
Special thanks go to the former members of the International Digital Publishing Forum, particularly Markus Gylling and Bill McCoy, without whom EPUB would not have become a reality.
This version is outdated!For the latest version, please refer to https://www.w3.org/TR/epub/ and https://www.w3.org/TR/epub-rs/.