EPUB 3 Overview

2.1 Package Document

Every EPUB Publication is represented by a Package Document. The Package Document specifies all the resources required to render that representation of the content. The Package Document also defines a reading order for linear consumption, and associates metadata and navigation information.

The Package Document defines a layer on top of the traditional structuring of a typical Web site to facilitate the authoring of digital publications. A Web site, for example, embeds references to its resources within its content, which, while a simple and flexible means of identifying resources, makes it difficult to enumerate all the resources required to render it. In addition, there is no standard way for a Web site to define that a sequence of pages make up a larger publication, which is precisely what EPUB's spine element [EPUB-33] does (i.e., it provides an external declarative means to explicitly specify navigation through a collection of documents). Finally, the Package Document defines a standard way to represent metadata globally applicable to a collection of pages.

The Package Document also includes a collection element [EPUB-33], which allows grouping of logically related Publication Resources. This element exists to enable the development of specialized content identification, processing and rendering features, such as the ability to define embedded preview content, or assemble an index or dictionary from its constituent XHTML Content Documents.

The Package Document is specified in the dedicated section of [EPUB-33].

2.2 Navigation

2.3 Metadata

EPUB Publications provide a rich array of options for adding metadata. Each Package Document includes a dedicated metadata section [EPUB-33] for general information about the EPUB Publication, allowing titles, authors, identifiers, and other information about the EPUB Publication to be easily accessed. It also provides the means to attach complete bibliographic records using the link element [EPUB-33].

The Package Document also allows a Unique Identifier to be established for the EPUB Publication using the unique-identifier attribute [EPUB-33].

XHTML Content Documents also include the means of annotating document markup with rich metadata, making them more semantically meaningful and useful both for processing and accessibility purposes. Both RDFa [RDFA-IN-HTML] and Microdata [Microdata] attributes can be used in XHTML Content Documents for that purpose.

2.4 Content Documents

Each EPUB Publication contains one or more EPUB Content Documents, as defined in the dedicated section of [EPUB-33]. These are XHTML or SVG documents that describe the readable content and reference associated media resources (e.g., images, audio, and video clips).

XHTML Content Documents are defined by a profile of [HTML].

2.5 Fixed Layouts

Although EPUB's history is steeped in enabling reflowable content, not all publications lend themselves easily to reflowing. Page-precise layouts are required to meaningfully represent children's books, comics and manga, magazines, and many other content forms.

EPUB 3 includes metadata that allows the creation of fixed-layout XHTML Content Documents [EPUB-33], in addition to existing capabilities for fixed layouts in SVG. This metadata enables the control of the page dimensions [EPUB-33], creating a canvas on which elements can be absolutely positioned.

The metadata does not just flag whether content is to be fixed or reflowed, but also allows EPUB Creators to specify the desired orientation of pages [EPUB-33], when to create synthetic spreads [EPUB-33], and how to position pages [EPUB-33] within those spreads, providing a broad range of control over the presentation of EPUB Publications.

The structure and semantics of EPUB Documents with Fixed Layouts are defined in [EPUB-33].

2.6 Rendering and CSS

A key concept of EPUB is that content presentation adapts to the user, rather than the user having to adapt to a particular presentation of content. HTML was originally designed to support dynamic rendering of structured content, but over time HTML as supported in Web browsers has become focused on the needs of Web applications, and many popular Web sites now have layouts with less flexibility.

EPUB Publications, however, are designed to maximize accessibility for the visually impaired, and Reading Systems typically perform text line layout and pagination on the fly, adapting to the size of the display area, the user's preferred font size, and other environmental factors. This behavior is not guaranteed in EPUB; images, vector graphics, video, and other non-reflowable content might be included, and some Reading Systems might not paginate on the fly, or at all. Nevertheless, supporting dynamic adaptive layout and accessibility has been a primary design consideration throughout the evolution of the EPUB standard.

EPUB Content Documents can reference CSS Style Sheets, allowing EPUB Creators to define the desired rendering properties. EPUB 3 follows support for CSS as defined in the [CSSSnapshot].

EPUB 3 also supports CSS styles that enable both horizontal and vertical layout and both left-to-right and right-to-left writing. Refer to § 3.3 CSS in the Global Language Support section for more information.

2.7 Multimedia

EPUB 3 supports audio and video embedded in XHTML Content Documents via the [HTML] audio and video elements, inheriting all the functionality and features these elements provide. For more information on audio and video formats, refer to the section on core media types [EPUB-33].

Another key multimedia feature in EPUB 3 is the inclusion of Media Overlay Documents [EPUB-33]. When pre-recorded narration is available for an EPUB Publication, Media Overlays provide the ability to synchronize that audio with the text of a Content Document (see also § 4.4 Aural Renditions and Media Overlays).

The structure and semantics of EPUB Documents with Media Overlays are defined in [EPUB-33].

2.8 Fonts

EPUB 3 supports two closely related font formats — OpenType [OpenType] and WOFF [WOFF] [WOFF2] — to accommodate both traditional publishing workflows and emerging Web-based workflows. Word processing programs used to create EPUB Publications are likely to have access only to a collection of installed OpenType fonts, for example, whereas Web-archival EPUB generators will likely only have access to WOFF resources (which cannot be converted to OpenType without undesirable, and potentially unlicensed, stripping of WOFF metadata).

EPUB 3 also supports both obfuscated and regular font resources for both OpenType and WOFF font formats. Support for obfuscated font resources is required to accommodate font licensing restrictions for many commercially available fonts. See the dedicated section on Resource Obfuscation in [EPUB-33] for more details.

2.9 Scripting

EPUB strives to treat content declaratively — as data that can be manipulated, not as programs to be executed — but does support scripting as defined in [HTML] and [SVG2] (refer to the section on Scripting [EPUB-33] for more information).

It is important to note, however, that EPUB 3 does not require scripting support in Reading Systems, and scripting might be disabled for security reasons.

EPUB Creators need to be aware that scripting in an EPUB Publication can create security considerations that are different from scripting within a Web browser. For example, typical same-origin policies are not applicable to content that has been downloaded to a user's local system. Therefore, it is strongly encouraged that scripting be limited to container constrained contexts, as further described in the section on Container-Constrained Scripts [EPUB-33].

In other words, consider limiting scripting to cases where it is essential to the user experience, since it greatly increases the likelihood that content will not be portable across all Reading Systems and creates barriers to accessibility and content reusability.

2.10 Text-to-speech

EPUB 3 provides the following text-to-speech (TTS) facilities for controlling aspects of speech synthesis, such as pronunciation, prosody, and voice characteristics:

Pronunciation Lexicons

The inclusion of generic pronunciation lexicons using the W3C PLS format [PRONUNCIATION-LEXICON] enables EPUB Creators to provide pronunciation rules that apply to the entire EPUB Publication. Refer to Pronunciation Lexicons [EPUB-TTS-10] for more information.

Inline SSML Phonemes

The incorporation of SSML phonemes functionality [SSML] directly into a EPUB Content Document enables fine-grained pronunciation control, taking precedence over default pronunciation rules and/or referenced pronunciation lexicons (as provided by the PLS format mentioned above). Refer to SSML Attributes [EPUB-TTS-10] for more information.

Note that EPUB Creators may also rely on CSS Speech [CSS-SPEECH-1] properties in their style sheet definitions.

The authoring features for improving the voicing of EPUB 3 publication are described in the separate Working Group Note on Text-to-Speech Enhancements [EPUB-TTS-10].

2.11 Container

An EPUB Publication is transported and interchanged as a single file (a "portable document") that contains the Package Documents, all Content Documents, and all other required resources for processing the Publication. The single-file container format for EPUB is based on the widely adopted ZIP format, and an XML document that identifies the location of the Package Document for the Publication in the ZIP archive is located at a pre-defined location within the archive.

This approach provides a clear contract between any creator of an EPUB Publication and any system which consumes such EPUB Publications, as well as a reliable representation that is independent of network transport or file system specifics.

An EPUB Publication's representation as a container file is specified in the dedicated section of [EPUB-33].

3.1 Metadata

EPUB 3 supports alternate representations of all text metadata items in the package metadata section to improve global distribution of EPUB Publications. The alternate-script property [EPUB-33] can be combined with the xml:lang attribute to include and identify alternate script renderings of language-specific metadata.

Using this property, a Japanese EPUB Publication could, for example, include an alternate Roman-script representation of the author's name and/or one or more representations of the title in a Romance language.

Text metadata items may also rely on attributes specifying base direction [EPUB-33] that allow for a finer control of bidirectional texts (e.g., titles that combine Latin and Arabic or Hebrew characters).

Finally, the page-progression-direction attribute allows the content flow direction to be globally specified for all Content Documents to facilitate rendering (see the page-progression-direction [EPUB-33]).

3.2 Content Documents

XHTML Content Documents leverage the HTML directionality features to improve support for bidirectional content rendering: the bdi element allows an instance of directional text to be isolated from the surrounding content, the bdo element allows directionality to be overridden for its child content and the dir attribute allows the directionality of any element to be explicitly set.

XHTML Content Documents also support ruby annotations [HTML] for pronunciation support (which makes them supported in Navigation Document links, as well).

SVG Content Documents support the rendering of bidirectional text, but do not include support for ruby.

3.3 CSS

EPUB 3's support for CSS3 modules enables typography for many different languages and cultures. Some specific enhancements include:

• support for vertical writing, which also provides Reading Systems the ability to allow users to toggle direction;

• better handling of emphasis, such as the inclusion of bōten;

• better control over line breaking, so that breaks can occur at the character level for languages that do not use spaces to delimit new words; and

• better control over hyphenation, to further facilitate line breaking.

3.4 Fonts

EPUB 3 does not require that Reading Systems come with a set of built-in system fonts. As occurs in Web contexts, users in a particular locale might have installed fonts that omit characters required for other locales and Reading Systems might utilize intrinsic fonts or font engines that do not utilize operating system installed fonts. As a result, the text content of an EPUB Publication might not natively render as intended on all Reading Systems.

To address this problem, EPUB 3 supports the embedding of fonts to facilitate the rendering of text content, and this practice is advised to ensure content is rendered as intended. See also § 2.8 Fonts in the Features section for more information.

Support for embedded fonts also ensures that characters and glyphs unique to an EPUB Publication can be embedded for proper display.

3.5 Text-to-speech

EPUB 3's support for PLS documents and SSML attributes increases the pronunciation control that EPUB Creators have over the rendering of any natural language in text-to-speech-enabled Reading Systems. Refer to § 2.10 Text-to-speech in the Features section for more information on these capabilities.

The combination of CSS Speech and inline SSML phonemes also allows fine control over ruby.

3.6 Container

The OCF container format supports UTF-8, allowing for internationalized file and directory naming of content resources.

4.1 Navigation

As noted in § 2.2.2 Navigation Document above, the navigation features represent a universal and flexible navigation system.

The Navigation Document can also be reused in the body of an EPUB Publication by including it in the spine. To avoid the situation in highly structured documents where it might not be desirable to display the complete table of contents to users in the body, the display level can be modified using the [HTML] hidden attribute. This attribute is ignored by Reading Systems when they render the table of contents outside the spine (e.g., in their own specialized views), which avoids minimizing the information that is available.

EPUB Creators are also encouraged to supply additional nav elements if their EPUB Publications contain non-structural points of interest, such as figures, tables, etc., to further enhance access to the content.

4.2 Semantic Markup

[HTML] supports a number of elements that make markup more semantically meaningful (e.g., section, nav, and aside). EPUB Creators are encouraged to use these elements, in conjunction with best practices for authoring well-structured Web content, when creating EPUB XHTML Content Documents. These additions allow content to be better grouped and defined, both for representing the structure of documents and to facilitate their logical navigation. XHTML Content Documents also natively support the inclusion of ARIA role and state attributes and events, including the dedicated [DPUB-ARIA-1.0] roles, enhancing the ability of Assistive Technologies to interact with the content.

EPUB 3 includes the epub:type attribute, which is meant to be functionally equivalent to the W3C Role Attribute [Role-Attribute]. This attribute allows any element in an XHTML Content Document to include additional information about its purpose and meaning within the work, using controlled vocabularies and terms. Refer to the section on Expressing Structural Semantics [EPUB-33] for more information.

4.3 Dynamic Layouts

The design center of EPUB is dynamic layout: content is typically intended to be formatted on the fly rather than being typeset in a paginated manner in advance (i.e., expecting a particular sized "page"). This core capability is useful, for example, for optimizing rendering onto different sized device screens or window sizes, and it facilitates and simplifies content accessibility.

While it is possible to incorporate more highly formatted content in EPUB — for example via bitmap images or SVG graphics, or even use of CSS explicit positioning and/or table elements to achieve particular visual layouts — EPUB Creators are strongly discouraged from utilizing such techniques. They are not reliable in EPUB since many Reading Systems render content in a paginated manner rather than creating a single scrolling Viewport and since each Reading System might define its own pagination algorithm. If these techniques are necessary to convey the content of the publication, consider including fallbacks [EPUB-33] (e.g., for graphic novels).

In general, it is preferable to achieve visual richness by using CSS Style Sheets without absolute sizing or positioning.

4.4 Aural Renditions and Media Overlays

Aural renderings of content are important for accessibility and are a desirable feature for many other users. A baseline to facilitate aural rendering is to utilize semantic HTML designed for dynamic layout. Refer to § 2.10 Text-to-speech for more information on how to use the native facilities that EPUB XHTML Documents include.

Media Overlays [EPUB-33] provide the ability to synchronize the text and audio content of an EPUB Publication. Overlays transcend the accessibility domain in their usefulness: the synchronization of text and audio as a tool for learning to read, for example, being of benefit in many circumstances.

4.5 Fallbacks

Not all formats are accessible in their native format, and not all users prefer to read in the default format provided. EPUB defines a variety of means for providing fallbacks so that alternate renderings can be made available in these cases.

Publication- and content-level fallbacks are defined in the section on Foreign Resources [EPUB-33]. These fallback mechanisms enable the inclusion of Foreign Resources in an EPUB Publication and ensure compatibility of EPUB 3 content across Reading Systems with varying capabilities (e.g., they allow the inclusion of multiple video formats, and the inclusion of XHTML fallbacks to SVG Content Documents for EPUB 2 Reading Systems).

4.6 Scripting

EPUB 3 adopts a progressive enhancement approach for scripted content, whereby scripting is not allowed to interfere with the integrity of the document (i.e., not result in information loss when scripting is not available). Consequently, although documents that do employ scripting can provide fallbacks [EPUB-33] to further facilitate access to their contents, the documents have to be accessible without them.

EPUB Creators should always implement best practices for accessible scripting in Web documents, such as provided in [WAI-ARIA], and reserve the use of scripting for situations in which interactivity is critical to the user experience.