EPUB 3.3 Reading Systems

Abstract

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 defines the conformance requirements for EPUB® 3 Reading Systems — the user agents that render EPUB Publications.

3. Package Document Processing

3.1 Package Document Conformance

An EPUB Reading System is conformant with this section if meets all of the following criteria:

It MUST honor all presentation logic expressed through the Package Document [EPUB-33] (e.g., the reading order, fallback chains, page progression direction and fixed layouts).
It MUST process the Package Document in conformance with all Reading System conformance constraints expressed in § 3.2 Package Document.
It SHOULD process rendering metadata, as expressed in § 10.2 Package Rendering Metadata.
It MUST process fixed layout metadata, as expressed in § 6.2 Fixed-Layout Properties.
It MUST ignore proprietary metadata properties that pertain to layout expressions if they conflict behaviorally with the property semantics defined in § 6.2 Fixed-Layout Properties.
It MUST NOT use any resources not listed in the Package Document in the processing of the Package (e.g., META-INF files [EPUB-33]).

3.2 Package Document

3.2.1 Metadata

Note

When an element has mandatory text content, that content is referred to as the value of the element in the following requirements.

White Space

Reading Systems MUST trim all leading and trailing white space [XML] from Dublin Core element values before processing.

Unless an individual property explicitly defines a different white space normalization algorithm, Reading Systems MUST trim all leading and trailing white space [XML] from meta element values before further processing them.

The identifier element

To determine whether an identifier conforms to an established system or has been granted by an issuing authority, Reading Systems SHOULD check for an identifier-type property [EPUB-33].

The title element

Reading Systems MUST recognize the first title element in document order as the main title of the EPUB Publication (i.e., the primary one to present to users). This specification does not define how to process additional title elements.

The creator element

When determining display priority, Reading Systems MUST use the document order of creator elements in the metadata section, where the first creator element encountered is the primary creator. If a Reading System exposes creator metadata to the user, it SHOULD include all the creators listed in the metadata section whenever possible (e.g., when not constrained by display considerations).

The meta element

If a Reading System does not recognize the scheme attribute value, it SHOULD treat the value of the element as a string.

Reading Systems SHOULD ignore all meta elements whose property attributes define expressions they do not recognize. A Reading System MUST NOT fail when encountering unknown expressions.

The link element

Retrieval of Remote Resources is OPTIONAL.

Reading System do not have to use or present linked resources, even if they recognize the relationship defined in the rel attribute.

In the case of a linked metadata record [EPUB-33], Reading Systems MUST NOT skip processing the metadata expressed in the Package Document and only use the information expressed in the record. Reading Systems MAY compile metadata from multiple linked records; they do not have to select only one record.

When it comes to resolving discrepancies and conflicts between metadata expressed in the Package Document and in linked metadata records, Reading Systems MUST use the document order of link elements in the Package Document to establish precedence (i.e., metadata in the first linked record encountered has the highest precedence and metadata in the Package Document the lowest, regardless of whether the link elements occur before, within or after the package metadata elements).

Reading Systems MUST ignore any instructions contained in linked resources related to the layout and rendering of the EPUB Publication.

3.2.2 Manifest

The item element

When an href attribute contains a relative IRI, Reading Systems MUST use the IRI of the Package Document as the base when resolving to an absolute IRI.

Reading Systems MAY optimize the rendering depending on the properties set in the properties attribute (e.g., disable a rendering process or use a fallback). Reading Systems MUST ignore all descriptive metadata properties that they do not recognize.

A Reading System that does not support the Media Type of a given Publication Resource MUST traverse the fallback chain until it has identified at least one supported Publication Resource to use in place of the unsupported resource. If the Reading System supports multiple Publication Resources in the fallback chain, it MAY select the resource to use based on specific properties [EPUB-33] of that resource, otherwise it SHOULD honor the Author's preferred fallback order. If a Reading System does not support any resource in the fallback chain, it MUST alert the reader that content could not be displayed.

Manifest Fallbacks

Reading System MAY choose to utilize fallbacks to find the optimal version of a Content Document to render in a given context.

3.2.3 Spine

The spine element

Reading Systems MUST provide a means of rendering the EPUB Publication in the order defined in the spine, which includes: 1) recognizing the first primary itemref as the beginning of the default reading order; and, 2) rendering successive primary items in the order given in the spine.

When the default value is specified, the Reading System can choose the rendering direction. The default value MUST be assumed when the attribute is not specified. In this case, the reading system SHOULD choose a default page-progression-direction value based on the first language element.

Reading Systems MUST ignore the page progression direction defined in pre-paginated XHTML Content Documents. The page-progression-direction attribute defines the flow direction from one fixed-layout page to the next.

The itemref element

When rendering an EPUB Publication, a Reading System MAY either suppress non-linear content so that it does not appear in the default reading order, or ignore the linear attribute to provide users access to the entire content of the EPUB Publication. This specification does not mandate which model Reading Systems have to use. A Reading System MAY also provide the option for users to toggle between the two models.

Reading Systems MUST ignore all metadata properties expressed in the properties attribute that they do not recognize.

3.2.4 Collections

In the context of this specification, support for collections in Reading Systems is OPTIONAL. Reading Systems MUST ignore collection elements that define unrecognized roles.

3.3 Publication Identifiers

Unique Identifiers: Reading Systems MUST NOT depend on the Unique Identifier being unique to one and only one EPUB Publication. Determining whether two EPUB Publications with the same Unique Identifier represent different versions of the same publication, or different publications, might require inspecting other metadata, such as the titles or authors.

4. Content Document Processing

4.1 XHTML Content Documents

4.1.1 XHTML Conformance

A conformant EPUB Reading System has to meet the following criteria for processing XHTML Content Documents:

Unless explicitly defined by this specification as overridden, it MUST process XHTML Content Documents using semantics defined by the [HTML] specification and honor any applicable user agent conformance constraints expressed therein.
It MUST meet all Reading System conformance criteria defined in § 4.1.2 HTML Extensions.
It MUST recognize and adapt behaviorally to the constraints defined in § 4.1.3 HTML Deviations and Constraints.
It MUST meet the Reading System conformance criteria defined in § 4.4.1 Scripting Conformance.
It MUST support visual rendering of XHTML Content Documents as defined in § 4.3.1 CSS Conformance.
It SHOULD recognize embedded ARIA markup and support exposure of any given ARIA roles, states and properties to platform accessibility APIs [WAI-ARIA].

4.1.2 HTML Extensions

4.1.2.1 Structural Semantics

In addition to the requirements in § 9. Expressing Structural Semantics, a Reading System has to process the epub:type attribute as follows in XHTML Content Documents:

It MUST ignore semantics expressed on the [HTML] head element or its descendants.

4.1.2.2 RDFa

EPUB Reading System support for the attribute processing model [RDFA-CORE] is OPTIONAL.

4.1.2.3 Microdata

EPUB Reading System support for the attribute processing model is OPTIONAL, as is the conversion to JSON [Microdata].

4.1.2.4 SSML Attributes

The ssml:ph attribute: Reading Systems that support the SSML Attributes and PLS documents [EPUB-33] MUST honor the defined precedence rules for these two constructs.
The ssml:alphabet attribute: Reading Systems that support the SSML Attributes feature of this specification SHOULD support the IPA alphabet [IPA], as expressed by the value "ipa".

4.1.2.5 Content Switching (Deprecated)

Use of the switch element is deprecated [EPUB-33]. Refer to its definition in [EPUBContentDocs-301] for implementation information.

4.1.2.6 The `epub:trigger` Element (Deprecated)

Use of the trigger element is deprecated [EPUB-33]. Refer to its definition in [EPUBContentDocs-301] for implementation information.

4.1.2.7 Custom Attributes

Vendors MAY introduce functionality not defined in this specification to enhance the rendering of EPUB Publications.

To facilitate this experimentation, vendors MAY define custom attributes for use in XHTML Content Documents provided they are from a foreign namespace, which is defined as a namespace [XML-NAMES] that does not include either of the following domains in its URI's authority component [RFC3986]:

w3.org
idpf.org

Custom attributes, and the behaviors associated with them, MUST NOT alter the integrity of an EPUB Publication.

Note

To facilitate interoperability of custom attributes across Reading Systems, vendors are strongly encouraged to document any extensions they implement in [AttributeExtensions].

4.1.3 HTML Deviations and Constraints

4.1.3.1 MathML

A conformant EPUB Reading System has to meet the following criteria for supporting MathML embedded in XHTML Content Documents:

It MUST be an input-compliant renderer for Presentation MathML, as defined in the [MATHML3] specification.
It MAY support rendering of Content MathML found in annotation-xml elements.
If it has a Viewport, it MUST support visual rendering of Presentation MathML.

Note

EPUB Reading Systems may choose to use third-party libraries such as MathJax to provide MathML rendering.

4.1.3.2 Embedded SVG

Reading Systems MUST process SVG embedded in XHTML Content Documents as defined in § 4.2 SVG Content Documents.

4.1.3.2.1 Embedded SVG and CSS

For the purposes of styling SVG embedded in XHTML Content Documents by reference, Reading Systems MUST NOT apply CSS style rules of the containing document to the referenced SVG document.

For the purposes of styling SVG embedded in XHTML Content Documents by inclusion, Reading Systems MUST apply applicable CSS rules of the containing document to the included SVG elements.

Note

SVG included by reference is processed as a separate document, and can include its own CSS style rules just like an SVG Content Document would. Note that this is consistent with situations where an [HTML] object element references an external [HTML] element.

4.1.3.3 Form Submission

Reading System support for the submission of [HTML] forms is OPTIONAL. A Reading System might, for example, prevent form submissions by limiting access to networking.

4.2 SVG Content Documents

A conformant EPUB Reading System has to meet the following criteria for processing SVG Content Documents and SVG embedded in XHTML Content Documents:

Unless explicitly defined by this specification as overridden, it MUST process SVG Content Documents using semantics defined by the [SVG] specification and honor any applicable user agent conformance constraints expressed therein.
It MUST meet the Reading System conformance criteria defined in § 4.4.1 Scripting Conformance.
If it has a Viewport, it MUST support the visual rendering of SVG using CSS as defined in Styling [SVG], and it SHOULD support all properties defined in the Property Index [SVG]. In the case of embedded SVG, it MUST also conform to the constraints defined in § 4.1.3.2.1 Embedded SVG and CSS.
It SHOULD support user selection and searching of text within SVG elements.
It MUST recognize the value "http://www.idpf.org/2007/ops" of the requiredExtensions attribute as representing the occurrence of XHTML Content Document fragments (e.g., when the attribute is included on the foreignObject element or children of the switch element).

4.3 CSS Style Sheets

4.3.1 CSS Conformance

A conformant EPUB Reading System has to meet the following criteria for processing CSS Style Sheets:

It MUST support the official definition of CSS as described in the [CSSSnapshot].
It SHOULD support all applicable modules in [CSSSnapshot] that have reached at least Candidate Recommendation status [W3CProcess] (and are widely implemented).
It MUST support [TrueType], [OpenType], [WOFF] and [WOFF2] font resources referenced from @font-face rules.
It MUST support all prefixed properties defined in CSS Style Sheets — Prefixed Properties [EPUB-33].
In addition to supporting CSS properties as defined above, its user agent style sheet SHOULD support the [HTML] suggested default rendering.
It SHOULD respect Author CSS and user styles as defined in § 4.3.2 Reading System Overrides.

Reading System developers are encouraged to implement CSS support at the level of major browsers.

4.3.2 Reading System Overrides

EPUB Reading Systems SHOULD apply Author style sheets as written to EPUB Content Documents. If a Reading System allows, users SHOULD be able to override Author style sheets as desired. EPUB Reading Systems SHOULD NOT override Author style sheets unless strictly necessary.

If a Reading System has to override an Author style sheet, it SHOULD do so in a way that preserves the Cascade: through a user agent style sheet, the getOverrideStyle method [DOM-Level-2-Style], or [HTML] style attributes.

Developers of Reading Systems are strongly encouraged to publicly document their user agent style sheets and how they interact with Author style sheets.

4.4 Scripting

4.4.1 Scripting Conformance

A Reading System that supports scripting MUST meet the following criteria:

It SHOULD support container-constrained scripting [EPUB-33] in reflowable EPUB Content Documents.
It SHOULD support spine-level scripting [EPUB-33] in fixed-layout documents [EPUB-33].
It SHOULD support spine-level scripting in reflowable EPUB Content Documents that use the "scrolled-doc" or "scrolled-continuous" [EPUB-33] presentation modes defined by the rendition:flow property. Similarly, if it supports spine-level scripting in reflowable EPUB Content Documents, it MUST implement the "scrolled-doc" presentation mode and SHOULD implement the "scrolled-continuous" presentation mode.
It MAY support scripting in other contexts, but this specification does not address such scripting. As a result, the use of scripting in these contexts might not be consistent across Reading Systems.
It MAY render Scripted Content Documents as an interactive, scripted user agent according to [HTML].
It MUST NOT allow a container-constrained script to modify the DOM of the parent Content Document or other contents in the EPUB Publication and MUST NOT allow it to manipulate the size of its containing rectangle. (Note: Even if a script is not container-constrained, the Reading System MAY impose restrictions on modifications (see also the dom-manipulation feature).)
It MAY place additional limitations on the capabilities provided to scripts during execution (e.g., limiting networking).
It MUST implement the JavaScript navigator extension object epubReadingSystem defined in § A. JavaScript epubReadingSystem Object. It also MUST support the dom-manipulation and layout-change features defined in § A.4.1.2 Features in container-constrained scripting contexts.

A Reading System that does not support scripting MUST meet the following criteria:

It MUST process fallbacks for scripted content as defined in Fallbacks for Scripted Content Documents [EPUB-33].

Note

Reading Systems might render Scripted Content Documents in a manner that disables other EPUB capabilities and/or provides a different rendering and user experience (e.g., by disabling pagination).

Authors choosing to restrict the usage of scripting to the container-constrained model [EPUB-33] will ensure a more consistent user experience between scripted and non-scripted content (e.g., consistent pagination behavior).

Authors are advised to use declarative techniques whenever practical to increase the interoperability, longevity, and accessibility of their EPUB Publications, and avoid the inclusion of scripting whenever practical.

4.4.2 Security Considerations

This section is non-normative.

All EPUB Authors and EPUB Reading System developers have to be aware of the security issues that arise when scripted content is executed by a Reading System. As the underlying scripting model employed by Reading Systems and browsers is the same, the same kinds of issues encountered in Web contexts have to be taken into consideration.

Each Reading System has to establish if the scripts in a particular document are to be trusted or not. It is advised that all scripts be treated as untrusted (and potentially malicious), and that all vectors of attack be examined and protected against. In particular, the following need to be considered:

an attack against the runtime environment (e.g., stealing files from a user's hard drive);
an attack against the Reading System itself (e.g., stealing a list of a user's books or causing unexpected behavior);
an attack of one Content Document against another (e.g., stealing data that originated in a different document);
an attack of an unencrypted script against an encrypted portion of a document (e.g., an injected malicious script extracting protected content);
an attack against the local network (e.g., stealing data from a server behind a firewall).

The following recommendations are provided as a guide to handling untrusted scripts:

Reading Systems need to behave as if a unique domain were allocated to each Content Document, as browser-based security relies heavily on document URLs and domains. Adopting this approach will isolate documents from each other and from other Internet domains, thereby limiting access to external URLs, cookies, DOM storage, etc.

Reading Systems that enable scripting and network access also need to consider including methods to notify the user that network activity is occurring and/or that allow them to disable it.

Note

In practice, Reading Systems might share domains across documents, but they still need to maintain isolation between documents.

If parts of a document are encrypted and parts are not, or if different encryption keys are used for different parts of the document, a unique per-document domain might not provide sufficient protection.
If a Reading System allows persistent data to be stored, that data needs to be treated as sensitive. Scripts might save persistent data through cookies and DOM storage but Reading Systems might block such attempts. Reading Systems that do allow data to be stored have to ensure that it is not made available to other unrelated documents (e.g., ones that could have been spoofed). In particular, checking for a matching document identifier (or similar metadata) is not a valid method to control access to persistent data.

Reading Systems that allow local storage also need to provide methods for users to inspect, disable, or delete that data. The data needs to be destroyed if the corresponding EPUB Publication is deleted.

Note that compliance with these recommendations does not guarantee protection from the possible attacks listed above; developers have to examine each potential vulnerability within the context of their Reading System.

4.4.3 Event Model Considerations

This section is non-normative.

Reading Systems need to follow the DOM Event model as per [HTML] and pass UI events to the scripting environment before performing any default action associated with these events. Reading System implementers need to ensure that scripts cannot disable critical functionality (such as navigation) to constrain the extent to which a potentially malicious script could impact their Reading Systems. As a result, although the scripting environment needs to be able to cancel the default action of any event, some events either might not be passed through or might not be cancelable.

Authors need to take into account the wide variety of possible Reading System implementations when adding scripting functionality to their EPUB Publications (e.g., not all devices have physical keyboards, and in many cases a soft keyboard is activated only for text input elements). Consequently, relying on keyboard events alone is not advised; alternative ways to trigger a desired action always need to be provided.

4.5 Pronunciation Lexicons

Reading Systems with Text-to-Speech (TTS) capabilities SHOULD support PLS documents.

A conformant EPUB Reading System has to meet the following criteria for processing PLS documents:

Reading Systems with Text-to-Speech (TTS) capabilities SHOULD support [PRONUNCIATION-LEXICON].

It MUST process PLS documents as defined in [PRONUNCIATION-LEXICON].

It MUST apply the supplied pronunciation instructions to all text nodes in the current XHTML Content Document whose language [HTML] matches the language for which the pronunciation lexicon is relevant [PRONUNCIATION-LEXICON]. The algorithm for matching language tags is defined in [BCP47].

When a pronunciation rule is specified more than once for a given string target in a given language, it MUST give precedence to the last occurrence of the rule in such a way that any previously-defined pronunciation rule gets overridden.

If it also supports SSML Attributes, it MUST let any pronunciation instructions provided via the ssml:ph attribute take precedence in cases where a grapheme element [PRONUNCIATION-LEXICON] matches a text node of an element that carries the ssml:ph attribute [SSML].

6. Fixed-Layout Documents

6.1 Fixed Layout Conformance

A conformant EPUB Reading System has to meet the following criteria for processing Fixed-Layout Documents:

It SHOULD allocate the full Content Display Area for the document, as defined in § 6.4 Viewport Rendering.
It MUST use the dimensions expressed in the viewport meta tag to render XHTML Content Documents, as defined in § 6.3 HTML Initial Containing Block Dimensions.
It MUST use the dimensions as defined in Expressing the ICB in SVG [EPUB-33] to render SVG Content Documents.

Note

This specification does not define how the initial containing block [CSS2] is placed within the Reading System Content Display Area.

6.2 Fixed-Layout Properties

6.2.1 The `rendition:layout` Property

The default value reflowable MUST be assumed by EPUB Reading Systems as the global value if no meta element carrying this property occurs in the metadata section [EPUB-33].

When the rendition:layout property is set to pre-paginated, Reading Systems MUST NOT include space between the adjacent content slots when rendering Synthetic Spreads.

The rendition:layout property values have the following processing requirements:

reflowable: Reading Systems MAY apply dynamic pagination when rendering.
pre-paginated: Reading Systems MUST produce exactly one page per spine itemref [EPUB-33] when rendering.

6.2.2 The `rendition:orientation` Property

The default value auto MUST be assumed by Reading Systems as the global value if no meta element carrying this property occurs in the metadata section.

Reading Systems that support multiple orientations SHOULD convey the intended orientation to the user unless the given value is auto. The means by which the intent is conveyed is implementation specific.

6.2.3 The `rendition:spread` Property

The default value auto MUST be assumed by Reading Systems as the global value if no meta element carrying this property occurs in the metadata section.

The rendition:spread property values have the following processing requirements:

none: Reading Systems MUST NOT incorporate spine items in a Synthetic Spread.
landscape: Reading Systems SHOULD render a Synthetic Spread for spine items only when the device is in landscape orientation.
portrait (deprecated): Reading Systems SHOULD treat the value "portrait" as a synonym of "both" and create spreads regardless of orientation.
both: Reading Systems SHOULD render a Synthetic Spread regardless of device orientation.
auto: Reading Systems MAY use Synthetic Spreads in specific or all device orientations as part of a Content Display Area utilization optimization process.

6.2.4 The `rendition:page-spread-*` Properties

The rendition:page-spread-left property indicates that the given spine item SHOULD be rendered in the left-hand slot in the spread, and rendition:page-spread-right that it SHOULD be rendered in the right-hand slot. The rendition:page-spread-center property indicates that the synthetic spread mode SHOULD be overridden and a single viewport rendered and positioned at the center of the screen.

The rendition:page-spread-left, rendition:page-spread-right, and rendition:page-spread-center properties apply to both pre-paginated and reflowable content, and they only apply when the Reading System is creating Synthetic Spreads.

The rendition:page-spread-* properties take precedence over whatever value of the page-break-before property [CSSSnapshot] has been set for an XHTML Content Document.

Note

The presence of rendition:page-spread-center does not change the viewport dimensions. It does not indicate that a viewport with the size of the whole spread has to be created. This is important so that the scale factor stays consistent between regular and center-spread pages.

When a reflowable spine item follows a pre-paginated one, the reflowable one SHOULD start on the next page (as defined by the page-progression-direction [EPUB-33]) when it lacks a rendition:page-spread-* property value. If the reflowable spine item has a rendition:page-spread-* specification, it MUST be honored (e.g., by inserting a blank page).

Similarly, when a pre-paginated spine item follows a reflowable one, the pre-paginated one SHOULD start on the next page (as defined by the page-progression-direction) when it lacks a rendition:page-spread-* property value. If the pre-paginated spine item has a rendition:page-spread-* specification, it MUST be honored (e.g., by inserting a blank page).

When a Reading System encounters two spine items that represent a true spread (i.e., two adjacent spine items with the rendition:page-spread-left and rendition:page-spread-right properties), it SHOULD create the spread with no space between the adjacent pages.

6.3 HTML Initial Containing Block Dimensions

In this version of this specification, only the width and height expressions as defined in Expressing in HTML [EPUB-33] MUST be recognized by Reading Systems.

Reading Systems MUST clip XHTML content to the initial containing block (ICB) dimensions declared in the viewport meta tag — content positioned outside of the initial containing block will not be visible. When the ICB aspect ratio does not match the aspect ratio of the Reading System Content Display Area, Reading Systems MAY position the ICB inside the area to accommodate the user interface; in other words, added letter-boxing space MAY appear on either side (or both) of the content.

6.4 Viewport Rendering

When rendering Fixed-Layout Documents, the default intent is that the Content Display Area SHOULD occupy as much of the available Viewport area as possible. Reading Systems SHOULD NOT inject additional content such as border, margins, headers, or footers into the Viewport.

Note

The exposure of Reading System control widgets to the user is implementation-specific and not included in the above behavioral expectations.

7. Open Container Format Processing

7.1 OCF Conformance

An EPUB Reading System has to meet the following criteria:

It MUST process the OCF Abstract Container in conformance with all Reading System conformance constraints expressed in § 7.2 OCF Abstract Container.
It MUST process the OCF ZIP Container in conformance with all Reading System conformance constraints expressed in § 7.3 OCF ZIP Container.
If it has a Viewport, it MUST support deobfuscation of resources as defined in Resource Obfuscation [EPUB-33].

Note

It is not required that an application that processes OCF Containers be a full-fledged EPUB Reading System (e.g., an application might only extract the content of a container or check the validity of the packaged content). In these cases, the rendering requirements for EPUB Reading Systems defined in the referenced sections can be ignored.

7.2 OCF Abstract Container

7.2.1 Relative IRIs for Referencing Other Components

For relative IRI references, Reading Systems MUST determine the Base IRI [RFC3986] according to the relevant language specifications for the given file formats. For example, CSS defines how relative IRI references work in the context of CSS style sheets and property declarations [CSSSnapshot].

Note

Some language specifications reference Requests For Comments [RFC] that preceded [RFC3987], in which case the earlier RFC applies for content in that particular language.

Unlike most language specifications, Reading Systems MUST use the Root Directory of the OCF Abstract Container as the default Base IRI as the Base IRI for all files within the META-INF directory.

7.2.2 File Names

This specification does not specify how a Reading System that is unable to represent OCF File and Path Names would compensate for this incompatibility.

7.2.3 `META-INF` Directory

Container File (container.xml): A Reading System MUST, by default, use the Package Document referenced from first rootfile element to render the EPUB Publication. If the Reading System recognizes a means of selecting from the other available options, it MAY choose a more appropriate Package Document.
Other Files: Reading Systems MUST NOT fail when encountering files in the META-INF directory not listed in Reserved Files [EPUB-33].

7.3 OCF ZIP Container

Reading Systems MUST treat any OCF files that specify that the ZIP file is split across multiple storage media as being in error.
Reading Systems MUST treat any OCF Containers that use compression techniques other than Deflate as being in error.
Reading Systems MUST support the ZIP64 extensions defined as "Version 1".
Reading Systems MUST treat OCF ZIP Containers that use ZIP encryption features as being in error.
It is not a requirement that Reading Systems preserve information from an OCF ZIP Container through load and save operations that are not defined within the OCF Abstract Container; in particular, a Reading System does not have to preserve CRC values, comment fields or fields that hold file system information corresponding to a particular operating system (e.g., External file attributes and Extra field).

The following constraints apply to specific fields in the OCF ZIP Container archive:

Reading Systems MUST treat version needed to extract field values other than 10, 20 or 45 in the local file header table as being in error.
Reading Systems MUST treat compression method field values other than 0 or 8 in the local file header table as being in error.
Reading Systems MUST treat OCF ZIP Containers with an Archive decryption header or an Archive extra data record as being in error.

8. Media Overlays Processing

8.1 Media Overlays Conformance

EPUB Reading System support for Media Overlays is OPTIONAL. A Reading System that supports Media Overlays MUST meet the following criteria:

It MUST support XHTML Content Documents, and it MAY support SVG Content Documents.

It MUST render Media Overlay elements as described in § 8.2.2 Basic Playback.

It MUST allow user navigation while a Media Overlay is being played, as discussed in § 8.2.3.1 Navigation.

It MUST adhere to rules regarding referenced audio and video embedded in the EPUB Content Document, as stated in § 8.2.3.2 Embedded Audio and Video.

Text-to-Speech-capable Reading Systems SHOULD conform to Reading System Text-to-Speech Conformance Requirements [EPUB-33].

It SHOULD offer the skippability and escapability features described in § 8.2.4 Skippability and Escapability.

A Reading System that does not support Media Overlays MUST meet the following criteria:

It MUST ignore both the media-overlay attribute on Manifest item elements and the manifest item elements where the media-type attribute value equals application/smil+xml.

8.2 Playback Behaviors

8.2.1 Loading the Media Overlay

When an EPUB Reading System loads a Package Document, it MUST refer to the Manifest item elements' [EPUB-33] media-overlay attributes to discover the corresponding Media Overlays for EPUB Content Documents. Playback MUST start at the Media Overlay element which corresponds to the desired EPUB Content Document starting point. Note that the start of an EPUB Content Document MAY correspond to an element at the start or in the middle of a Media Overlay. When the Media Overlay Document has finished playing, the Reading System SHOULD load the next EPUB Content Document (as specified in the Package Document spine) and also load its corresponding Media Overlay Document, provided that one is given.

8.2.2 Basic Playback

8.2.2.1 Timing and Synchronization

Reading Systems MUST render immediate children of the body element [EPUB-33] in a sequence. A seq element's [EPUB-33] children MUST be rendered in sequence, and playback completes when the last child has finished playing. A par element's [EPUB-33] children MUST be rendered in parallel (with each starting at the same time), and playback completes when all the children have finished playing. When the body element's last child has finished playing, playback of the Media Overlay Document is done.

8.2.2.2 Rendering Audio

When presented with a Media Overlay audio element [EPUB-33], Reading Systems MUST play the audio resource referenced by the src attribute, starting at the clip offset time given by the clipBegin attribute [EPUB-33] and ending at the clip offset time given by the clipEnd attribute [EPUB-33]. The following rules MUST be observed:

If clipBegin is not specified, its value is assumed to be "0".
If clipEnd is not specified, its value is assumed to be the full duration of the physical media.
If clipEnd exceeds the full duration of the physical media, then its value is assumed to be the full duration of the physical media.

User-controllable audio playback options SHOULD include timescale modification, in which the playback rate is altered without distorting the pitch. The suggested range is half-speed to double-speed.

8.2.2.3 Rendering EPUB Content Document Elements

When presented with a Media Overlay text element [EPUB-33], Reading Systems SHOULD ensure the EPUB Content Document element referenced by the src attribute is visible in the Viewport. During Media Overlays playback, Reading Systems with a Viewport SHOULD add the class names given by the metadata properties active-class and playback-active-class [EPUB-33] to the appropriate elements in the EPUB Content Document. Conversely, the class names SHOULD be removed when the playback state changes, as described in Associating Style Information [EPUB-33].

The active-class and playback-active-class metadata properties are OPTIONAL, and if omitted, Reading System behavior is implementation-specific.

8.2.3 Interacting with the EPUB Content Document

Because the Media Overlay is closely linked to the EPUB Content Document, it is very easy for Reading Systems to locate a position in the EPUB Content Document based on the current position in the Media Overlay playback. If the user pauses synchronized playback and navigates to a different part of the EPUB Publication, synchronized playback MUST resume at that point. For example, if a specific page number in the EPUB Content Document is the desired location, then this same point is located in the Media Overlay and playback started there.

This same approach allows for synchronizing the Media Overlay playback with user selection of a navigation point in the EPUB Navigation Document. The Reading System loads the Media Overlay for that file and finds the correct point for starting playback based on the ID [XML] of the navigation point target.

Note

A Media Overlay Document can be associated directly with a Navigation Document in order to provide synchronized playback of its contents, regardless of whether the XHTML Content Document in which it resides is included in the spine. See EPUB Navigation Document [EPUB-33] for more information.

Note

Media Overlay Document elements can be associated with EPUB Content Document structures such as tables. Reading Systems need to ensure that Media Overlay playback remains synchronized with user navigation of table rows and cells. The Reading System might also play the corresponding table header preceding the contents of the cell.

8.2.3.2 Embedded Audio and Video

An EPUB Content Document with which a Media Overlay is associated MAY itself contain embedded video and audio media, which MAY be pointed to by Media Overlay elements. Unlike text and images, video and audio media have an intrinsic duration. Consequently, when a Reading System renders the synchronization described by a Media Overlay, the default playback behavior of audio and video media embedded within the associated EPUB Content Document MUST be overridden.

Note that the rules below apply only to referenced [HTML] video or audio elements within the associated EPUB Content Document. That is to say, the rules apply to only those elements pointed to by text elements [EPUB-33] within the Media Overlay (i.e., via the src attribute). Embedded media that is not referenced by Media Overlay elements is not subject to these rules.

All referenced audio and video media embedded within an EPUB Content Document MUST have their public playback interface deactivated (typically: play/pause control, time slider, volume level, etc.). This behavior is necessary to avoid interference between the scheduled playback sequence defined by the Media Overlay, and the arbitrary playback behavior due to user interaction or script execution. As a result, when the Reading System is in playback mode, it SHOULD:
- Hide the individual video/audio UI controls from the page, which overrides the default behavior defined by the [HTML] controls attribute.
- Prevent scripts embedded within the EPUB Content Document from invoking the JavaScript audio/video playback API (i.e., authored as part of the default behavior). It is RECOMMENDED that content producers avoid publishing embedded scripts dedicated to controlling the playback of embedded audio/video media. The published Media Overlay can then retain full control of the synchronized presentation without any risk of interference from script-enabled custom behaviors.
All referenced audio and video media embedded within an EPUB Content Document MUST be initialized to their "stopped" state, and be ready to be played from the zero-position within their content stream (possibly displaying the image specified using the [HTML] poster attribute). This requirement overrides the default behavior defined by the [HTML] autoplay attribute.
When an EPUB Content Document element becomes active, the CSS Style Sheet visual highlighting rules apply regardless of the content type referred to by that element's src attribute (e.g., the CSS class name defined by the active-class metadata property [EPUB-33] SHOULD be applied to visible video and audio player controls within the host EPUB Content Document).
In addition to the default behavior of Media Overlay activation for textual fragments and images, audio and video playback MUST be started and stopped according to the duration implied by the authored Media Overlay synchronization (as per the standard [SMIL3] timing model). There are two possible scenarios:
- When a Media Overlay text element has no audio [EPUB-33] sibling within its par [EPUB-33] parent container, the referenced EPUB Content Document audio or video media MUST play until it ends, at which point the text element's lifespan terminates. In this case, the implicit duration of the text element (and by inference, of the parent par container) is that of the referenced audio or video clip.
- When a Media Overlay text element has an audio sibling within its par parent container, the playback duration of the referenced EPUB Content Document audio or video media MUST be constrained by the duration of the audio sibling. In this case, the actual duration of the parent par container is that of the child audio clip, regardless of the duration of the video or audio media pointed to by the text element. This behavior can result in embedded video or audio media ending playback prematurely (before reaching its full duration), or ending before the playback of the parallel Media Overlay audio is finished (in which case the last-played video frame SHOULD remain visible until the parent par container finally ends). This behavior is equivalent of the Media Overlay audio element implicitly carrying the behavior of the [SMIL3] endsync attribute.
  
  Furthermore, Reading Systems SHOULD expose user controls for the volume levels of each independent audio track (i.e., from the audio element of the Media Overlay, and from the embedded audio or video media within the EPUB Content Document), so that audio output can be adjusted to match listeners' requirements. Note that having overlapping audio tracks is typically an authoring-time concern: content producers usually add a layer of audio information over a video track for description purposes. It is RECOMMENDED that overlapping audio situations are carefully examined and dealt with at production stage, as Reading Systems are NOT REQUIRED to handle simultaneous volume levels in any specific way.
When a text element becomes inactive in the Media Overlay, and when it points to embedded video or audio media, that referenced media MUST be reset to its initial "stopped" state, ready to be played from the zero-position within their content stream (possibly displaying the poster image specified using the [HTML] markup).

8.2.3.3 Text-to-Speech

When a Media Overlay text element [EPUB-33] with no audio [EPUB-33] sibling element references text within the target EPUB Content Document, Reading Systems capable of Text-to-Speech (TTS) SHOULD render the referenced text using TTS.

As per Reading System conformance requirements, the speech-related information provided in the target EPUB Content Document SHOULD be used to play the audio stream as part of the Media Overlay rendering. See Reading System Text-to-Speech Conformance Requirements.

The Media Overlay text element's lifespan corresponds to the rendering time of the associated speech synthesis. The implicit duration of the text element (and by inference, of the parent par element) is therefore determined by the execution of the Text-to-Speech engine, and cannot be known at authoring time (factors like speech rate, pauses and other prosody parameters influence the audio output).

8.2.4 Skippability and Escapability

8.2.4.1 Skippability

Reading Systems SHOULD use the semantic information provided by Media Overlay elements' epub:type attribute to determine when to offer users the option of skippable features.

8.2.4.2 Escapability

Reading Systems SHOULD allow escaping of nested structures. Reading Systems MUST determine the start of nested structures by the value of the epub:type attribute and SHOULD offer users the option to skip playback of that structure and resume with whatever content comes after it.

10. Vocabularies

10.1 Vocabulary Association Mechanisms

Reserved Prefixes

Reading Systems MUST resolve all reserved prefixes used in Package Documents using their predefined URIs unless a local prefix is declared. Reading Systems MUST use locally overridden prefixes in the prefix attribute when encountered.

As changes to the reserved prefixes and updates to Reading Systems are not always going happen in synchrony, Reading Systems MUST NOT fail when encountering unrecognized prefixes (i.e., not reserved and not declared using the prefix attribute).

The prefix attribute

If the prefix attribute includes a declaration for a predefined prefix, Reading Systems MUST use the URI mapping defined in the prefix attribute, regardless of whether of it maps to the same URI as the predefined prefix.

The property Data Type

A Reading System MUST use the following rules to create an IRI [RFC3987] from a property:

If the property consists only of a reference, the IRI is obtained by concatenating the IRI stem associated with the default vocabulary [EPUB-33] to the reference.
If the property consists of a prefix and reference, the IRI is obtained by concatenating the IRI stem associated with the prefix to the reference. If no matching prefix has been defined, the property is invalid and MUST be ignored.

The resulting IRI MUST be valid to [RFC3987]. Reading Systems do not have to resolve this IRI, however.

10.2 Package Rendering Metadata

10.2.1 General Properties

10.2.1.1 The `rendition:flow` Property

If a Reading System supports the specified rendering, it SHOULD use that method to handle overflow content, but MAY provide the option for users to override the requested rendering.

The default value auto MUST be assumed by Reading Systems as the global value if no meta element carrying this property occurs in the metadata section [EPUB-33]. Reading Systems MAY support only this default value.

If a Reading Systems supports the rendition:layout property, it MUST ignore the rendition:flow property when it has been set on a spine item that also specifies the rendition:layout value pre-paginated.

The rendition:flow property values have the following processing requirements:

paginated: The Reading System SHOULD dynamically paginate all overflow content.
scrolled-continuous: The Reading System SHOULD render all Content Documents such that overflow content is scrollable, and the EPUB Publication SHOULD be presented as one continuous scroll from spine item to spine item (except where locally overridden [EPUB-33]).
scrolled-doc: The Reading System SHOULD render all Content Documents such that overflow content is scrollable, and each spine item SHOULD be presented as a separate scrollable document.
auto: The Reading System MAY render overflow content using its default method or a user preference, whichever is applicable.

For the rendition:flow-scrolled-continuous property, the scroll direction is defined relative to the block flow direction of the root element of the XHTML Content Document referenced by the itemref element [EPUB-33]. The scroll direction is vertical if the block flow direction is downward (top-to-bottom). It is horizontal if the block flow direction of the root element is rightward (left-to-right) or leftward (right-to-left).

10.2.1.2 The `rendition:align-x-center` Property

When the rendition:align-x-center property is set on a spine item, Reading Systems SHOULD render the content centered horizontally within the Viewport or spread, as applicable. This property does not affect the rendering of the spine item, only the placement of the resulting content box.

For reflowable content, Reading Systems that support this property MUST center each virtual page.

This version of this specification does not define a default rendering behavior when this property is not supported or specified. Reading Systems MAY render spine items by their own design.

A. JavaScript epubReadingSystem Object

A.1 Interface Definition

This specification extends the [HTML] Navigator object as follows.

WebIDL[Exposed=(Window)]
interface EpubReadingSystem {
    [LegacyUnforgeable] readonly attribute DOMString name;
    [LegacyUnforgeable] readonly attribute DOMString version;
    boolean hasFeature(DOMString feature, optional DOMString version);
};

partial interface Navigator {
    [LegacyUnforgeable, SameObject] readonly attribute EpubReadingSystem epubReadingSystem;
};

[WEBIDL] notation.

Note

This specification does not define an epubReadingSystem property extension for the WorkerNavigator object [WebWorkers]. Reading Systems therefore do not have to expose the epubReadingSystem object in the scripting context of Workers, and Authors cannot rely on its presence.

A.2 Description

The Navigator.epubReadingSystem object provides an interface through which a Scripted Content Document can query information about a user's Reading System.

The object exposes properties of the Reading System (its name and version), and provides the hasFeature method which can be invoked to determine the features it supports.

Example 1

Example JavaScript function that displays the name of the current Reading System.

alert("Reading System name: " + navigator.epubReadingSystem.name);

Reading Systems MUST expose the epubReadingSystem object on the navigator object of all loaded Scripted Content Documents, including any nested container-constrained scripting contexts [EPUB-33]. Reading Systems MUST ensure that the epubReadingSystem object is available no later than when the DOMContentLoaded event is triggered [HTML].

Note

Reading systems implementations might create cloned instances of the epubReadingSystem object in Scripted Content Documents for technical feasibility reasons. In such cases, the Reading System has to ensure that the object’s state — as reflected by the values of its properties and methods — is consistently maintained across all copied instances.

A.3 Properties

The following properties MUST be made available for retrieving information about the Reading System.

Name	Description
`name`	Returns a `String` value representing the name of the Reading System (e.g., "`iBooks`", "`Kindle`").
`version`	Returns a `String` value representing the version of the Reading System (e.g., "`1.0`", "`2.1.1`").
`layoutStyle`	Use of the `layoutStyle` property is deprecated [EPUB-33]. Refer to its definition in [EPUBContentDocs-301] for usage information.

A.4 Methods

A.4.1 hasFeature

A.4.1.1 Description

The hasFeature method returns a boolean value indicating whether any version of the specified feature is supported, or undefined if the specified feature is not recognized.

The OPTIONAL version parameter is included for querying custom features that could change in incompatible ways over time. The return value indicates support only for the specified version of the feature.

Authors SHOULD NOT include the version parameter when querying features defined in this specification — these features are considered versionless. If a Reading System supports a feature defined in this specification, it MUST ignore any supplied version parameter and return a true value.

Example 2

Example JavaScript function that displays whether the current Reading System supports scripted manipulation of the DOM.

var feature = "dom-manipulation";

var conformTest = navigator.epubReadingSystem.hasFeature(feature);

alert("Feature " + feature + " supported?: " + conformTest);

A.4.1.2 Features

The following table lists the set of features that Reading Systems that support the epubReadingSystem object MUST recognize (i.e., provide a return value for). Support for these features is OPTIONAL.

Name	Description
`dom-manipulation`	Scripts MAY make structural changes to the document’s DOM (applies to spine-level scripting [EPUB-33] only).
`layout-changes`	Scripts MAY modify attributes and CSS styles that affect content layout (applies to spine-level scripting [EPUB-33] only).
`touch-events`	The device supports touch events, and the Reading System passes touch events to the content.
`mouse-events`	The device supports mouse events, and the Reading System passes mouse events to the content.
`keyboard-events`	The device supports keyboard events, and the Reading System passes keyboard events to the content.
`spine-scripting`	Indicates whether the Reading System supports spine-level scripting [EPUB-33] (e.g., so a container-constrained script [EPUB-33] can determine whether any actions that depend on scripting support in a Top-level Content Document have any chance of success before attempting them).

Additional features MAY be added by Reading System developers, but future versions of this specification might append to this list in ways that could conflict or be incompatible with any such custom additions.

D. References

D.1 Normative references

[BCP47]: Tags for Identifying Languages. A. Phillips; M. Davis. IETF. September 2009. IETF Best Current Practice. URL: https://tools.ietf.org/html/bcp47
[CSS3Speech]: CSS Speech Module. Daniel Weck. W3C. 10 March 2020. W3C Candidate Recommendation. URL: https://www.w3.org/TR/css-speech-1/
[CSSSnapshot]: CSS Snapshot. URL: https://www.w3.org/TR/CSS/
[DOM-Level-2-Style]: Document Object Model (DOM) Level 2 Style Specification. Chris Wilson; Philippe Le Hégaret. W3C. 3 November 2020. W3C Recommendation. URL: https://www.w3.org/TR/DOM-Level-2-Style/
[EPUB-33]: EPUB 3.3. Garth Conboy; Dave Cramer; Marisa DeMeglio; Matt Garrish; Daniel Weck. W3C. URL: https://www.w3.org/TR/epub-33/
[EPUB-A11Y-10]: EPUB Accessibility 1.0. Matt Garrish; George Kerscher; Charles LaPierre; Avneesh Singh. IDPF. 05 January 2017. URL: http://idpf.org/epub/a11y/accessibility-20170105.html
[EPUBContentDocs-301]: EPUB Content Documents 3.0.1. Markus Gylling; William McCoy; Elika J. Etimad; Matt Garrish. IDPF. 26 June 2014. URL: http://idpf.org/epub/301/spec/epub-contentdocs-20140626.html
[EPUBPackages-32]: EPUB Packages 3.2. Matt Garrish; Dave Cramer. EPUB 3 Community Group. 08 May 2019. URL: https://www.w3.org/publishing/epub32/epub-packages.html
[HTML]: HTML Standard. Anne van Kesteren; Domenic Denicola; Ian Hickson; Philip Jägenstedt; Simon Pieters. WHATWG. Living Standard. URL: https://html.spec.whatwg.org/multipage/
[IPA]: IPA Chart. International Phonetic Association. 2005. URL: https://www.internationalphoneticassociation.org/content/full-ipa-chart
[MATHML3]: Mathematical Markup Language (MathML) Version 3.0 2nd Edition. David Carlisle; Patrick D F Ion; Robert R Miner. W3C. 10 April 2014. W3C Recommendation. URL: https://www.w3.org/TR/MathML3/
[Microdata]: HTML Microdata. Charles 'chaals' (McCathie) Nevile; Dan Brickley; Ian Hickson. W3C. 26 April 2018. W3C Working Draft. URL: https://www.w3.org/TR/microdata/
[OpenType]: OpenType specification. Microsoft. URL: http://www.microsoft.com/typography/otspec/default.htm
[PRONUNCIATION-LEXICON]: Pronunciation Lexicon Specification (PLS) Version 1.0. Paolo Baggia. W3C. 14 October 2008. W3C Recommendation. URL: https://www.w3.org/TR/pronunciation-lexicon/
[RDFA-CORE]: RDFa Core 1.1 - Third Edition. Ben Adida; Mark Birbeck; Shane McCarron; Ivan Herman et al. W3C. 17 March 2015. W3C Recommendation. URL: https://www.w3.org/TR/rdfa-core/
[RFC2119]: Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119
[RFC3986]: Uniform Resource Identifier (URI): Generic Syntax. T. Berners-Lee; R. Fielding; L. Masinter. IETF. January 2005. Internet Standard. URL: https://tools.ietf.org/html/rfc3986
[RFC3987]: Internationalized Resource Identifiers (IRIs). M. Duerst; M. Suignard. IETF. January 2005. Proposed Standard. URL: https://tools.ietf.org/html/rfc3987
[RFC8174]: Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words. B. Leiba. IETF. May 2017. Best Current Practice. URL: https://tools.ietf.org/html/rfc8174
[SMIL3]: Synchronized Multimedia Integration Language (SMIL 3.0). Dick Bulterman. W3C. 1 December 2008. W3C Recommendation. URL: https://www.w3.org/TR/SMIL3/
[SSML]: Speech Synthesis Markup Language (SSML) Version 1.1. Daniel Burnett; Zhi Wei Shuang. W3C. 7 September 2010. W3C Recommendation. URL: https://www.w3.org/TR/speech-synthesis11/
[SVG]: SVG. W3C. URL: https://www.w3.org/TR/SVG/
[TrueType]: Apple TrueType Reference Manual. Apple. 2002. URL: https://developer.apple.com/fonts/TrueType-Reference-Manual/
[W3CProcess]: W3C Process Document. URL: https://www.w3.org/Consortium/Process/
[WAI-ARIA]: Accessible Rich Internet Applications (WAI-ARIA) 1.0. James Craig; Michael Cooper et al. W3C. 20 March 2014. W3C Recommendation. URL: https://www.w3.org/TR/wai-aria/
[WEBIDL]: Web IDL. Boris Zbarsky. W3C. 15 December 2016. W3C Editor's Draft. URL: https://heycam.github.io/webidl/
[WOFF]: WOFF File Format 1.0. Jonathan Kew; Tal Leming; Erik van Blokland. W3C. 13 December 2012. W3C Recommendation. URL: https://www.w3.org/TR/WOFF/
[WOFF2]: WOFF File Format 2.0. Vladimir Levantovsky; Raph Levien. W3C. 1 March 2018. W3C Recommendation. URL: https://www.w3.org/TR/WOFF2/
[XML]: Extensible Markup Language (XML) 1.0 (Fifth Edition). Tim Bray; Jean Paoli; Michael Sperberg-McQueen; Eve Maler; François Yergeau et al. W3C. 26 November 2008. W3C Recommendation. URL: https://www.w3.org/TR/xml/
[XML-NAMES]: Namespaces in XML 1.0 (Third Edition). Tim Bray; Dave Hollander; Andrew Layman; Richard Tobin; Henry Thompson et al. W3C. 8 December 2009. W3C Recommendation. URL: https://www.w3.org/TR/xml-names/
[XMLBase]: XML Base (Second Edition). Jonathan Marsh; Richard Tobin. W3C. 28 January 2009. W3C Recommendation. URL: https://www.w3.org/TR/xmlbase/

D.2 Informative references

[AttributeExtensions]: EPUB Custom Attribute Extensions for Content Documents. URL: http://www.idpf.org/epub/extensions/attributes
[CSS2]: CSS 2. W3C. W3C Recommendation. URL: https://www.w3.org/TR/CSS2/
[H264]: H.264 : Advanced video coding for generic audiovisual services. 2017-04-13. URL: https://www.itu.int/ITU-T/recommendations/rec.aspx?rec=13189
[RFC]: Request for Comments. URL: https://www.ietf.org/standards/rfcs/
[RFC6386]: VP8 Data Format and Decoding Guide. J. Bankoski; J. Koleszar; L. Quillio; J. Salonen; P. Wilkins; Y. Xu. IETF. November 2011. Informational. URL: https://tools.ietf.org/html/rfc6386
[WebWorkers]: Web Workers. Ian Hickson. W3C. 24 September 2015. W3C Working Draft. URL: https://www.w3.org/TR/workers/

EPUB 3.3 Reading Systems

W3C First Public Working Draft 12 January 2021

Abstract

Status of This Document

1. Introduction

1.1 Overview

1.2 Conformance

1.3 Relationship to Other Specifications

1.3.1 Relationship to HTML

1.3.2 Relationship to SVG

2. EPUB Publications

3. Package Document Processing

3.1 Package Document Conformance

3.2 Package Document

3.2.1 Metadata

3.2.2 Manifest

3.2.3 Spine

3.2.4 Collections

3.3 Publication Identifiers

4. Content Document Processing

4.1 XHTML Content Documents

4.1.1 XHTML Conformance

4.1.2 HTML Extensions

4.1.2.1 Structural Semantics

4.1.2.2 RDFa

4.1.2.3 Microdata

4.1.2.4 SSML Attributes

4.1.2.5 Content Switching (Deprecated)

4.1.2.6 The epub:trigger Element (Deprecated)

4.1.2.7 Custom Attributes

4.1.3 HTML Deviations and Constraints

4.1.3.1 MathML

4.1.3.2 Embedded SVG

4.1.3.2.1 Embedded SVG and CSS

4.1.3.3 Form Submission

4.2 SVG Content Documents

4.3 CSS Style Sheets

4.3.1 CSS Conformance

4.3.2 Reading System Overrides

4.4 Scripting

4.4.1 Scripting Conformance

4.4.2 Security Considerations

4.4.3 Event Model Considerations

4.5 Pronunciation Lexicons

5. Navigation Document

5.1 Navigation Document Conformance

5.2 The nav Element: Restrictions

6. Fixed-Layout Documents

6.1 Fixed Layout Conformance

6.2 Fixed-Layout Properties

6.2.1 The rendition:layout Property

6.2.2 The rendition:orientation Property

6.2.3 The rendition:spread Property

6.2.4 The rendition:page-spread-* Properties

6.3 HTML Initial Containing Block Dimensions

6.4 Viewport Rendering

7. Open Container Format Processing

7.1 OCF Conformance

7.2 OCF Abstract Container

7.2.1 Relative IRIs for Referencing Other Components

7.2.2 File Names

7.2.3 META-INF Directory

7.3 OCF ZIP Container

8. Media Overlays Processing

8.1 Media Overlays Conformance

8.2 Playback Behaviors

8.2.1 Loading the Media Overlay

8.2.2 Basic Playback

8.2.2.1 Timing and Synchronization

8.2.2.2 Rendering Audio

8.2.2.3 Rendering EPUB Content Document Elements

8.2.3 Interacting with the EPUB Content Document

8.2.3.1 Navigation

8.2.3.2 Embedded Audio and Video

8.2.3.3 Text-to-Speech

8.2.4 Skippability and Escapability

8.2.4.1 Skippability

8.2.4.2 Escapability

9. Expressing Structural Semantics

10. Vocabularies

4.1.2.6 The `epub:trigger` Element (Deprecated)

5.2 The `nav` Element: Restrictions

6.2.1 The `rendition:layout` Property

6.2.2 The `rendition:orientation` Property

6.2.3 The `rendition:spread` Property

6.2.4 The `rendition:page-spread-*` Properties

7.2.3 `META-INF` Directory

10.2.1.1 The `rendition:flow` Property

10.2.1.2 The `rendition:align-x-center` Property