EPUB 3 EDUPUB Profile

Initial Editors Draft 20140205

This version:

http://www.idpf.org/epub/profiles/edu/spec/edupub-20140205.html

Latest version:

http://www.idpf.org/epub/profiles/edu/spec

Previous version:

N/A

Copyright © 2014 International Digital Publishing Forum™

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

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

Editors

David Stroup (Pearson)

Markus Gylling (IDPF)

Matt Garrish (Invited Expert)

... TODO

Authors

David Stroup (Pearson)

... TODO

Status of this Document

This is an editors draft, produced by the IDPF EPUB 3 working group, based on an initial member submission by Pearson in December, 2013. The contents herein do not yet necessarily reflect the consensus of the Working Group. This document may be updated, replaced, or rendered obsolete by other documents at any time.

Open issues in this draft

This section will be removed when this document leaves draft status.  Open issues in this draft include the following:

• …

Table of Contents

1. Overview

1.1. Purpose and Scope

1.2. Terminology

1.3. Conformance Statements

1. Packaging and Distribution

1.1 Package Document Properties

1.1.1 Profile Identification

1.1.2 Accessibility metadata

1.2 Resource Properties

1.2.1 Folder Structure

1.2.2 File Naming

1.2.3 XHTML Content Documents

1.2.3.1 spine

1.2.3.2 Reflowability, Fixed Layout and Multiple Renditions

1.2.3.3 Chunking

1.2.4 Image formats

2. XHTML Content Documents

2.1 Introduction

2.2 Content Conformance

2.3 Sectioning

2.3.1 Document Outline

2.3.2 Front matter

2.3.3 Half title

2.3.4 Series title

2.3.5 Title page

2.3.6 Copyright page

2.3.7 Acknowledgments

2.3.8 Dedication

2.3.9 Foreword

2.3.10 Preface

2.3.11 Introduction

2.3.12 Body matter

2.3.13 Volume

2.3.14 Parts

2.3.15 Chapters

2.3.15.1 Subchapters

2.3.16 Practices

2.3.17 Back matter

2.3.18 Afterword

2.3.19 Conclusion

2.3.20 Colophon

2.3.21 Appendixes

2.3.22 Bibliography

2.3.22.1 Entries

2.3.22.2 References

2.3.23 Index

2.4 Block

2.5 Flow

2.6 Pagination

2.7 Numbering

2.8 Audio

2.9 Video

2.x Widgets

2.x Assessments

3. EPUB Navigation Documents

3.1 Table of contents

3.2 Brief table of contents

3.3 List of Illustrations and Tables

3.4 Page list

4. Assessments, Outcomes and Analytics

Appendix A. Baseline CSS

References

Normative References

Informative References

1. Overview

1.1. Purpose and Scope

This section is informative

Digital content in education has the potential to significantly improve learning outcomes, as it can better support accessibility, adapt to individual learning modes, increase engagement and experiential learning through interactivity, provide immediate assessments and analytics, and increase social connectivity. It also has the potential to reduce costs for all educational publishers.

But to achieve these goals, and reach the broadest possible audience, educational content has to be usable across many different devices from a single source. It also has to predictably render where data connectivity may be intermittent and slow.

Finding a common publishing framework is therefore vital, as fragmentation of formats leads to redundant effort, reduced time to market and unpredictable behaviors in reading systems, among other negatives. Quality of content also often suffers by being constrained to the capabilities of the least capable format. Economies-of-scale, whether universal toolsets or reading systems, also only can be achieved through the standardization of production and distribution.

EPUB 3 is a natural fit as the format for digital educational content, as it has already been widely adopted as a next-generation standard for ebooks, including textbooks. EPUB leverages the Open Web Platform to deliver engaging, interactive, media-enhanced reading experiences, both online and offline. It also provides sufficient structure to enable interoperability, allowing publishers to create content assets once that are distributable to multiple channels.

The EDUPUB profile defined in this document represents the effort of the IDPF educational community to adapt the functionality of the EPUB 3 format to the unique structural and semantic requirements of educational publishing.

A publication conformant to this profile is a valid EPUB Publication, but the reverse case is not always true, as EDUPUB tailors the EPUB 3 specification in the following ways:

• It adds semantics for common educational publishing components and structures.

• It defines requirements for the production and inclusion of image and rich media.
• It defines how to include content that may be created external to the narrative text workflow, such as interactives and assessment (e.g., QTI).
• It implements common educational accessibility features for compliance with educational standards.

The common core format defined in this document provides the predictable basis upon which devices and workflows can be defined, as competition is better focused on the quality of content than stifled through fragmentation caused by competing formats.

1.2. Terminology

Please refer to the EPUB Specifications for definitions of EPUB-specific terminology used in this document.

term

Term definition

1.3. Conformance Statements

The keywords must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in [RFC2119].

All sections of this specification are normative except for examples, or except for sections identified by the informative status label "This section is informative". The application of informative status to sections and appendices applies to all child content and subsections they may contain.

1. Packaging and Distribution

1.1 Package Document Properties

[This section contains requirements for OPF]

1.1.1 Profile Identification

An EPUB Publication conforming to this specification must be identified as such in the package metadata of each of its Renditions by including a dc:type element [Publications301] with the value "edupub".

The following example shows an EPUB Publication identified as edupub-conformant.

1.1.2 Accessibility metadata

TODO should we require some basic accessibility metadata?

1.2 Resource Properties

1.2.1 Folder Structure

Resources within the EPUB Container must be stored in the EPUB Container according to the requirements defined in 2.2 File and Directory Structure of [OCF301].

1.2.2 File Naming

Files within the EPUB Container must adhere to the naming conventions defined in 2.4 File Names of [OCF301].

In addition, it is recommended that all XHTML Content Documents use the extension ".xhtml".

1.2.3 XHTML Content Documents

1.2.3.1 spine

TODO require XHTML content documents in the spine?

1.2.3.2 Reflowability, Fixed Layout and Multiple Renditions

TODO need to decide if there are any restrictions on reflow vs fxl, as well as md. 

1.2.3.3 Chunking

This specification does not require a specific method of chunking content for distribution. It is recommended that chapters be split at the first (A-Head) section, however.

1.2.4 Image formats

Although any core media type image format defined in 5.1 Core Media Types of [Publications301] may be used in an EPUB Publication, the following guidelines are recommended:

• Use the colorspace sRGB [sRGB] for digital media
• Use [PNG] or [SVG] format for

• line art/vector images
• image fallbacks for math equations and tables
• bitmap images containing text

• Use [JPEG] format with 80% quality for photography and all other bitmap images
• Do not exceed 2000 pixels on the longest dimension for block-level art

2. XHTML Content Documents

2.1 Introduction

This section is informative

The EDUPUB profile uses XHTML Content Documents for representing both reflowable and fixed-layout EPUB Publications.

The semantics detailed in this section, and their representative content models, provide markup consistency for production and processing of conformant content.

2.2 Content Conformance

Excepted where noted below, publishers are strongly recommended to represent all publication structures using the markup and semantics defined in this profile.

To reduce production complexity, some semantics are implied on [HTML5] elements depending on the context in which they are used. Implied semantics are listed…

TODO: add a section with a table of elements and implied semantics

2.3 Sectioning

2.3.1 Document Outline

The section element must be used to group sections of related content.

The heading element for each section must reflect the nesting of the section element within the document hierarchy. For example, a top-level section will have an h1 heading, child sections of it will have h2 headings, and so on.

The application of headings must reflect the hierarchy regardless of how the content has been chunked for distribution (i.e., it is not necessary that the first section in each file begin with an h1).

When the document hierarchy exceeds six levels of nesting, re-use the h6 element for the seventh nesting level and deeper. Although this flattened structure will impact movement by heading for users of assistive technologies (AT), at this time there is no alternative. Avoid deep nesting of content, if possible.

Avoid using heading elements where the heading does not reflect the document hierarchy, as this use will also impact on movement by AT users (e.g., inside figure captions). If you have to include a heading, it must be one heading rank lower than the section that contains it.

When nesting aside elements with headings inside a section, the heading rank also must start one level lower than the containing section (e.g., if the section has an h3 heading, the aside will start with an h4 heading).

2.3.2 Front matter

2.3.3 Half title

2.3.4 Series title

2.3.5 Title page

2.3.6 Copyright page

2.3.7 Acknowledgments

2.3.8 Dedication

2.3.9 Foreword

2.3.10 Preface

2.3.11 Introduction

2.3.12 Body matter

2.3.13 Volume

2.3.14 Parts

2.3.15 Chapters

2.3.15.1 Subchapters

2.3.16 Practices

2.3.17 Back matter

2.3.18 Afterword

2.3.19 Conclusion

2.3.20 Colophon

2.3.21 Appendixes

2.3.22 Bibliography

A bibliography should be structured as an ordered list of bibliographic entries. Each entry in the bibliography must carry a biblioentry semantic.

Use [HTML5] section elements to organize a bibliography into logical sections (e.g., by alphabetic heading, chapter or special category). If the section does not have a heading, use the aria-label attribute to assign one for consumption by assistive technologies.

2.3.22.1 Entries

2.3.22.2 References

All in-text references to bibliographic sources must be identified using biblioref semantic.

A bibliography may also contain a list of suggested readings, but these types of bibliographies typically do not contain in-text references.

2.3.23 Index

For a complete guide to indexes, refer to the IDPF Indexes Specification [IDX].

2.4 Block

2.5 Flow

2.6 Pagination

If page markers are included in an EPUB Publication, a page-list nav [ContentDocs301] must be included in the EPUB Navigation Document. See 3.3 Page list for more information.

2.7 Numbering

2.8 Audio

Audio content must be provided in MP3 format.

TODO ogg

2.9 Video

Video content must be provided in MP4 or WebM format to comply with this profile. Video content may be provided in other formats provided an MP4 or WebM version is also available.

2.x Widgets

TODO waiting for EDUPUB taskforce

2.x Assessments

TODO waiting for EDUPUB taskforce

3. EPUB Navigation Documents

3.1 Table of contents

A toc nav [ContentDocs301] with links to the full document hierarchy must be included in every EPUB Publication conformant to this profile.

3.2 Brief table of contents

A brief table of contents represents a shortened version of the toc nav element [ContentDocs301], typically where sub-levels of the document hierarchy have been removed for clarity.

The toc-brief nav inherits the structural production requirements of the toc nav. Nesting of link lists is allowed, as there are no requirements on how much or little of the document hierarchy to include in the brief the table of contents.

The inclusion of a brief table of contents is optional, but only one toc-brief nav is allowed in the EPUB Navigation Document when present.

The addition of a brief table of contents to the EPUB Navigation Document does not alter the requirement to include a full table of contents in the toc nav.

The toc-brief semantic may be used within the content of an EPUB Publication (e.g., at the start of each chapter), in which case the production requirements for use in the EPUB Navigation Document do not apply.

3.3 List of Illustrations and Tables

EPUB Publications conformant to this profile should provide lists of illustrations (figures) and tables in the EPUB Navigation Document when such structures are included.

A figure list is identified by adding the "loi" semantic to a nav element; a table list by the "lot" semantic.

3.4 Page list

If print pagination markers are retained in the EPUB Publication, a page-list nav [ContentDocs301] must be included in the EPUB Navigation Document.

Likewise, if the EPUB Publication is statically paginated through the use of fixed layout pages, a page-list nav must be included, even if no print equivalent exists.

4. Assessments, Outcomes and Analytics

TODO determine outline and integration with subgroups

Appendix A. Baseline CSS

This appendix is informative.

TODO add list of recognized @class values

TODO add link to baseline css file

References

Normative References

[ContentDocs301] EPUB Content Documents 3.0.1

[HTML5] HTML5: A vocabulary and associated APIs for HTML and XHTML.

[IDX] EPUB Indexes 1.0.

[JPEG] JPEG Standard (JPEG ISO/IEC 10918-1 ITU-T Recommendation T.81) .

[OCF301] Open Container Format 3.0.1.

[PNG] Portable Network Graphics (PNG) Specification (Second Edition) . David Duce. 10 November 2003.

[Publications301] EPUB Publications 3.0.1.

[sRGB] IEC 61966-2-1:1999 Multimedia systems and equipment. Colour measurement and management.Colour management. Default RGB colour space. sRGB

[StructureVocab] EPUB 3 Structural Semantics Vocabulary .

[SVG] Scalable Vector Graphics (SVG) 1.1 (Second Edition) . Erik Dahlström, et al. 09 June 2011.

Informative References

TODO tutorial document