EDUPUB Structural Semantics

Editor's Draft 27 November 2014

This version:

http://www.idpf.org/epub/profiles/edu/structure/edupub-structure-20141127.html

Latest version:

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

Previous version:

http://www.idpf.org/epub/profiles/edu/structure/edupub-structure-20140528.html

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

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

Status of this Document

This document is an Draft Specification, produced by the IDPF EPUB 3 Working Group, based on an initial member submission by Pearson in December, 2013.

This document may be updated, replaced, or rendered obsolete by other documents at any time. Its contents do not necessarily reflect the consensus of the Working Group.

Table of Contents

1. Overview

1.1 Purpose and Scope

1.2. Terminology

1.3. Conformance Statements

2. About this vocabulary

8. Learning Objectives

fill-in-the-blank-problem

general-problem

match-problem

multiple-choice-problem

11. Titles and Headings

1. Overview

1.1 Purpose and Scope

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

1.2. Terminology

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

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.

2. About this vocabulary

The semantic terms defined in this document are all included in in the EPUB Structural Semantics Vocabulary [StructureVocab] and available for use in the epub:type attribute [ContentDocs301]. This document introduces additional usage requirements and restrictions not defined in the formal definitions in the [StructureVocab].

Content must conform to the usage requirements defined in this document in order for an EPUB Publication to be compliant with the EDUPUB profile.

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

Not all terms available in the EPUB Structural Semantics Vocabulary are included in this profile. This profile does not restrict the use of these terms in EDUPUB-compliant Publications, nor of other custom semantics, but Reading Systems are not expected to recognize or use such terms.

The categorization of terms in this document does not imply usage restrictions; it is provided for ease of reading. For example, terms in the front, body and back matter sections may appear anywhere in an EPUB Publication.

3. Sectioning

3.1 Front Matter

frontmatter

Preliminary material to the main content of a publication, such as tables of contents, dedications, etc.

HTML Usage Context: body

Example

…

</section>
</body>

abstract

A short summary of the principle ideas, concepts and conclusions of the work, or of a section or except within it.

HTML Usage Context: section, grouping content

Example

<h1>The Story of</h1>

<p>John Doe, shares the experiences that led him to begin …</p>

</div>

</header>

acknowledgments

The copyright page of the work.

HTML Usage Context: section, grouping content

Example

<h1 epub:type="title">Acknowledgments</h1>

<p>We wish to thank the following teachers for the use of their classrooms in validating strategies and for their ongoing implementation of the strategies in support of their students.</p>

<ol>

<li><p>Susan McCloskey, K–1 teacher, Viking Elementary School, Fresno, California</p></li>

<li><p>Vince Workmon, fourth-/fifth-grade teacher, Muir Elementary School, Fresno, California</p></li>

…

</ol>

</section>

copyright-page

The copyright page of the work.

HTML Usage Context: section, grouping content

Example

<p>Editorial Director: Sally Yagan</p>

<p>Editor in Chief: Eric Svendsen</p>

<p>Executive Editor: Bob Horan</p>

<p>Director of Editorial Services: Ashley Santora</p>

…

</section>

dedication

An inscription addressed to one or several particular person(s).

HTML Usage Context: section, grouping content

Example

<h1>Dedications</h1>

<p>To Becky, Morgan, and Forrest (B) from Carey Cole</p>

</section>

<p>To Nicole from Steve Fox</p>

</section>

<p>To Lynda from David M. Kroenke</p>

</section>

foreword

An introductory section that precedes the work, typically not written by the work's author.

HTML Usage Context: section, grouping content

Example

<h1>Foreword</h1>

<p>By Beverley Nichols</p>

</header>

<p>These poems are the very essence of the British spirit. …</p>

…

</section>

halftitlepage

The half title page of the work.

HTML Usage Context: section, grouping content

Example

<h1 epub:type="halftitle">Microeconomics</h1>

<p>TENTH EDITION</p>

</section>

introduction

A section in the beginning of the work, typically introducing the reader to the scope or nature of the work's content.

HTML Usage Context: section, grouping content

Example

<p>Everyone has some experience with marketing. Whether or not you have worked in a marketing position in an organization … </p>

<p>Of course, understanding marketing requires much more than simply recalling and becoming aware of everyday experiences. Understanding marketing … </p>

</section>

preface

An introductory section that precedes the work, typically written by the work's author.

HTML Usage Context: section, grouping content

Example

<h1><span epub:type="pagebreak" title="ix" id="pageix"/>Preface</h1>

<p>Microsoft SharePoint is widely used in business and industry. According to J. Nicholas Hoover<a epub:type="noteref" href="A01_CARE0095_00_AIE_FM01.xhtml#ch00_fm06_pre_fn01">1</a>, Microsoft has sold more than 100 million SharePoint licenses … </p>

…

</section>

seriespage

Marketing section used to list related publications.

HTML Usage Context: section, grouping content

Example

<h1>Series Page Section</h1>
<ul>

…

</ul>

</section>

titlepage

The title page of the work.

HTML Usage Context: section, grouping content

Example

<h1>Technology in Action</h1>

…
</section>

3.2 Body Matter

bodymatter

The main content of a publication.

HTML Usage Context: body

Example

<h1 epub:type="title">Part 2 Information Technology</h1>

…

</section>

</body>

chapter

A major structural division of a piece of writing.

HTML Usage Context: section

Example

<h1><span title="173" epub:type="pagebreak" id="page173"/>Chapter 9 Summarizing Research Findings and Other Information</h1>

…

</section>

part

A major structural division of a piece of writing, typically encapsulating a set of related chapters.

HTML Usage Context: section

Example

<h1>Part 2 Information Technology</h1>

<p>The next three chapters address … </p>
<p><a href="#ch04">Chapter 4</a> discusses hardware and software … </p>

<p><a href="M05_KROE7940_03_SE_C05.xhtml#ch05">Chapter 5</a> addresses the data component of information technology… </p>

</section>

…

</section>

</body>

qna

A question and answer section.

HTML Usage Context: section

Example

<h1>Author Q 'n' A</h1>

<dl>

<dt epub:type="question">When did you start writing?</dt>

<dd epub:type="answer">I wrote my first short story …</dd>

…

</dl>

</section>

volume

A component of a collection.

HTML Usage Context: section

Example

<h1>VOLUME I</h1>

<h1>Chapter 1</h1>

…

</section>

3.3 Back Matter

backmatter

Ancillary material occurring after the main content of a publication, such as indices, appendices, etc.

HTML Usage Context: body

Example

<h1>Credits</h1>

…

</section>

</body>

afterword

A closing statement from the author or a person of importance to the story, typically providing insight into how the story came to be written, its significance or related events that have transpired since its timeline.

HTML Usage Context: section

Example

<h1>Afterword</h1>

<p>Not long after the end of this story …</p>

</section>

appendix

Supplemental information.

HTML Usage Context: sectioning content

Example

<h1>Appendix D</h1>

<p>An honest and objective look at yourself can help you to evaluate where you are at present … </p>

<h1>Summarize</h1>

<p>Look at your self-assessments and summarize what you found using the questions that follow.</p>

…

</section>

…

</section>

colophon

A brief description usually located at the end of a publication, describing production notes relevant to the edition.

HTML Usage Context: section

Example

<h1>Note about the type</h1>

<p> This ebooks uses fonts …</p>

</section>

conclusion

An ending section that typically wraps up the work.

HTML Usage Context: section

Example

<h1>Summary</h1>

<p>A central task in feminist scholarship is to expose and dismantle the stereotypes … </p>

<p>The multiplicities of Asian men’s lives indicate that ideologies of manhood and womanhood … </p>

</section>

epigraph

A quotation that is pertinent but not integral to the text.

HTML Usage Context: section

Example

<p>“Would you tell me please, which way I ought to go from here?”</p>

<p>“That depends a good deal on where you want to get to,” said the cat.</p>

</blockquote>

4. Bibliographies

bibliography

A list of works cited.

HTML Usage Context: body, section

Content Model Requirements: must contain one or more descendant elements carrying the biblioentry semantic.

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.

Example

<h1>References</h1>

<ol>

<li epub:type="biblioentry">Board of Governors, National League for Nursing. (2008, May 9). … </li>

<li epub:type="biblioentry">Thede, L. (2008, Aug 18). … </li>

…

</ol>

</section>

biblioentry

An entry in a bibliography.

HTML Usage Context: grouping content

Example

<ol>

<li epub:type="biblioentry">Board of Governors, National League for Nursing. (2008, May 9). … </li>

<li epub:type="biblioentry">Thede, L. (2008, Aug 18). … </li>

…

</ol>

biblioref

A reference to a biblioentry.

HTML Usage Context: a

Example

<p>In other studies, Mayo systematically varied the length and timing of work breaks. Longer breaks, shorter breaks, and more or fewer breaks, all resulted in a steady increase in worker output (<a epub:type="biblioref" href="#x315726C8-71F7-5C19-F90F-8C7E89364B77">Mayo, 1933</a>).</p>

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.

5. Glossaries

glossary

An alphabetical list of terms in a particular domain of knowledge, with the definitions for those terms.

HTML Usage Context: dl, sectioning content

Example

<h1>Glossary of Key Terms and Acronyms</h1>

<dl>

<dd epub:type="glossdef">Americans with Disabilities Act.</dd>

<dt epub:type="glossterm"><dfn>Affirm</dfn></dt>

<dd epub:type="glossdef">When a higher court upholds the opinion of a lower court in an appeal.</dd>

…

</dl>

</section>

glossdef

The definition of a term in a glossary.

HTML Usage Context: dd

When the element on which the property appears a dd element within a dl element marked with the glossary property, then the glossdef property on the given dd element is implied. When the element context is a dd element and no explicit glossterm link is provided, then the term that this glossdef participates in defining is located in the nearest preceding dt element sibling.

Example

<dd epub:type="glossdef">When a higher court upholds the opinion of a lower court in an appeal.</dd>

glossterm

A glossary term.

HTML Usage Context: dt

When the element on which the property appears is a dt element within a dl element marked with the glossary property, then the glossterm property on the given dt element is implied.

Example

<dt epub:type="glossterm"><dfn>Affirm</dfn></dt>

glossref

A reference to a glossary definition.

HTML Usage Context: a

Example

…

6. Indexes

Refer to the EPUB Indexes specification for content structuring requirements.

7. Asides

case-study

A detailed analysis of a specific topic.

HTML Usage Context: sectioning content

Example

<h3>Case Study 2–1 Developing a Safe Schools Plan</h1>

<p>Read the following case study, then answer the questions about it. Finally, read the comments of educators about the safe schools plan.</p>

…

</aside>

help

Information that clarifies or augments the content.

HTML Usage Context: sectioning content, grouping content

Example

<p>The word reads the same way forward or backward.</p>

</aside>

notice

Information that requires special attention, and that must not be skipped or suppressed. Examples include: alert, warning, caution, danger, important.

HTML Usage Context: sectioning content, grouping content

Example

<p>May cause death if temperature is off by 1/1000000 of a degree.</p>

</aside>

pullquote

A quotation from the text that is set off in a distinctive fashion, such as in a larger typeface.

HTML Usage Context: aside

Example

<p>“Whenever two people meet there are six present. There is the man as he sees himself, each as the other person sees him, and each man as he really is.”</p>

</aside>

8. Learning Objectives

learning-objective

An explicit designation or description of a learning objective or a reference to an explicit learning objective.

HTML Usage Context: flow content, phrasing content

HTML Implied Context: li elements on an ol or ul carrying the learning-objectives term.

Example

<li epub:type="learning-objective">Explain concepts central to psychology</li>

learning-objectives

A collection of learning-objectives.

HTML Usage Context: sectioning content, grouping content

Content Model Requirements: must contain one or more learning-objective, either explicit or implied

Example

<h1>Learning Objectives</h1>

</header>

<ol>

<li epub:type="learning-objective">Explain concepts central to psychology</li>

…

</ol>

</section>

learning-outcome

The understanding or ability a student is expected to achieve as a result of a lesson or activity.

HTML Usage Context: flow content

HTML Implied Context: li elements on an ol or ul carrying the learning-outcomes term.

Example

<li epub:type="learning-outcomes">Distinguish between public relations and marketing, identifying the exchange between provider and customer as the distinguishing characteristic of marketing relationships.</li>

learning-outcomes

A collection of outcomes.

HTML Usage Context: sectioning content, grouping content

Content Model Requirements: must contain one or more learning-outcome, either explicit or implied

Example

<h1>Learning Outcomes</h1>

</header>

<p>After studying this chapter you should be able to:</p>

<ol>

<li epub:type="learning-outcome">Define public relations as the management function that builds and maintains relationships between organizations and their publics.</li>

…

</ol>

</section>

learning-resource

A resource provided to enhance learning, or a reference to such a resource.

HTML Usage Context: flow content

HTML Implied Context: li elements on an ol or ul carrying the learning-resources term.

Example

…

learning-resources

A collection of learning-resources.

HTML Usage Context: sectioning content, grouping content

Content Model Requirements: must contain one or more learning-resource, either explicit or implied

Example

…

learning-standard

A formal set of expectations or requirements typically issued by a government or a standards body.

HTML Usage Context: sectioning content, phrasing content

HTML Implied Context: li elements on an ol or ul carrying the learning-standards term.

Example

…

learning-standards

A collections of standards.

HTML Usage Context: sectioning content, grouping content

Content Model Requirements: must contain one or more learning-standard, either explicit or implied

Example

…

9. Testing

answer

The component of a self-assessment problem that provides the answer to the question.

HTML Usage Context: grouping content

HTML Implied Context: li elements on an ol or ul carrying the answers term.

Example

<p epub:type="answer">The riddle refers to time, as it devours all …</p>

</li>

answers

A collection of answers.

HTML Usage Context: sectioning content, grouping content

Content Model Requirements: must contain one or more answer, either explicit or implied

Example

<li id="ans1">Java Enterprise Edition (Java EE).</li>

<li id="ans2">web-server.</li>

<li id="ans3">Faces servlet.</li>

…

</ol>

assessment

A test, quiz, or other activity that helps measure a student's understanding of what is being taught.

HTML Usage Context: aside, grouping content

HTML Implied Context: li elements on an ol or ul carrying the assessments term.

Example

<h1>Learning Activities</h1>

<ol>

<p>Which would be a better description of naive

realism, “seeing is believing” or “believing is

seeing”?</p>

</div>

</li>

…

</ol>

</section>

assessments

A collection of assessments.

HTML Usage Context: sectioning content

Content Model Requirements: must contain one or more assessment, either explicit or implied

Example

<h1>Test Yourself</h1>

<h2>Verbs</h2>

…

</section>

<h2>Words</h2>

…

</section>

feedback

Helpful instruction to the reader based on the result of an assessment.

HTML Usage Context: grouping content, phrasing content

Example

</div>

fill-in-the-blank-problem

A problem that requires the reader to input a text answer to complete a sentence, statement or similar.

HTML Usage Context: aside, grouping content

Content Model Requirements: must contain exactly one descendant question. may contain exactly one descendant answer.

Example

The airplane was landed during the _____.

</div>

The lawyer wrote an angry _____ to the judge.

</div>

general-problem

A problem with a free-form solution.

HTML Usage Context: aside, grouping content

Content Model Requirements: must contain exactly one descendant question. may contain exactly one descendant answer.

Example

Which would be a better description of naive realism,

“seeing is believing” or “believing is seeing”?

</div>

match-problem

A problem that requires the reader to match the contents of one list with the corresponding items in another list.

HTML Usage Context: aside, grouping content

Content Model Requirements: must contain exactly one descendant question. may contain exactly one descendant answer.

Example

<p>Match the items on the left list with the items on the right list</p>

<ol>

<li>The point that, if won, wins the match for a player</li>

<li>The area between the net and the service line</li>

<li>Hitting the ball before it bounces</li>

…

</ol>

<ol>

<li>backswing</li>

<li>center service line</li>

…

</ol>

</div>

multiple-choice-problem

A problem with a set of potential answers to choose from ‒ some, all or none of which may be correct.

HTML Usage Context: aside, grouping content

Content Model Requirements: must contain exactly one descendant question. may contain exactly one descendant answer.

Example

<p epub:type="question">Which New Yorker author also wrote children's books?</p>

<ol>

<li>James Thurber</li>

<li>E.B White</li>

<li>Dorothy Parker</li>

</ol>

</div>

practice

A review exercise or sample.

HTML Usage Context: aside, grouping content

HTML Implied Context: li elements on an ol or ul carrying the practices term.

Example

<h1>Chapter 1</h1>

<ol>

<p epub:type="question">Which would be a better description of naive realism, “seeing is believing” or “believing is seeing”?</p>

</li>

<p epub:type="question">Shakespeare's last play was The Tempest.</p>

</li>

…

</ol>

</section>

practices

A collection of practices.

HTML Usage Context: section

Content Model Requirements: must contain one or more practice, either explicit or implied

Example

<h1>Learning Activities</h1>

<h1>Chapter 1</h1>

…

</section>

<h1>Chapter 2</h1>

…

</section>

…

</section>

question

The component of a self-assessment problem that identifies the question to be solved.

HTML Usage Context: grouping content

Example

<p epub:type="answer">The riddle refers to time, as it devours all …</p>

</li>

true-false-problem

A problem with either a true or false answer.

HTML Usage Context: aside, grouping content

Content Model Requirements: must contain exactly one descendant question. may contain exactly one descendant answer.

Example

<ol>

<p epub:type="question">There will be an increase in the numbers

of both elementary and secondary teachers in each year from 1998

through 2004.

</li>

<p epub:type="question">The number of additional elementary

teachers added each year from 1998 through 2004 will be larger in

the years at the beginning of this time period than in the years

toward the end.</p>

</li>

…

</ol>

10. Notes

footnote

A note appearing at the bottom of a page.

HTML Usage Context: On the aside element when identifying a single footnote, or on descendants of sectioning content when identifying individual footnotes in a group (refer to footnotes and rearnotes).

HTML Implied Context: li elements on an ol or ul carrying the footnotes term.

Example

<a href="#footnoteref01">1</a> The CDA requirements are roughly

equivalent to one year of college.

</aside>

footnotes

A collection of notes appearing at the bottom of a page.

HTML Usage Context: sectioning content

Content Model Requirements: must contain one or more footnote, either explicit or implied.

Example

<p id="fn01" epub:type="footnote"><a href="#fnref01">1</a>. The original

wording of this paragraph suggested the author …</p>

<p id="fn02" epub:type="footnote"><a href="#fnref02">2</a>. Most of this

paragraph was lost to bookworms.</p>

</aside>

noteref

A reference to a note, typically appearing a superscripted symbol in the main body of text.

HTML Usage Context: a

Example

<p>Another important aspect of this book is that it follows an iterative style. In the computing education community, a well-known educational design pattern exists that states that important concepts should be taught early and often.<a epub:type="noteref" href="#endnote1">1</a> … </p>

rearnote

A note appearing in the rear (backmatter) of the work, or at the end of a section.

HTML Usage Context: On the aside element when identifying a single rearnote, or on descendants of sectioning content when identifying individual rearnotes in a group (refer to footnotes and rearnotes).

HTML Implied Context: li elements on an ol or ul carrying the rearnotes term.

Example

<h2>Notes</h2>

…

</section>

rearnotes

A collection of notes appearing at the rear (backmatter) of the work, or at the end of a section.

HTML Usage Context: sectioning content

Content Model Requirements: must contain one or more rearnote, either explicit or implied.

Example

<h2>Notes</h2>

<li id="endnote1"><a href="chap01.xhtml#fnref01">1</a>. A study of

the mentioned species reveals …</li>

<li id="endnote2"><a href="chap01.xhtml#fnref02">2</a>. During an

excavation of the area …</li>

…

</ol>

</section>

11. Linking

referrer

A link back to the starting location in a bidirectional linking relationship.

HTML Usage Context: a

Example

<p>

</a>

The CDA requirements are roughly equivalent to

one year of college.

</p>

</aside>

12. Titles and Headings

label

The text label that precedes a ordinal in a component title (e.g., 'Chapter', 'Part', 'Figure', 'Table').

HTML Usage Context: heading content, li, figcaption

Example

<h1>

<span epub:type="label">Chaper</span>

</h1>

ordinal

An ordinal specifier for a component in a sequence of components (e.g., '1', 'IV', 'B-1').

HTML Usage Context: heading content, li, figcaption, footnote, rearnote

Content Model Requirements: must not contain ordinal descendants, or have ordinal siblings.

Example

…

</ul>

subtitle

An explanatory or alternate title for the work.

HTML Usage Context: heading content, phrasing content descendants of heading content, paragraphs, divs

Example

<h1>Geopolitics</h1>

<p epub:type="subtitle">Mountains as Walls</p>

</header>

…

</section>

title

The primary name of a work, section or component.

HTML Usage Context: heading content, phrasing content descendants of heading content

Example

<h1>

<span epub:type="label">Chaper</span>

<span epub:type="title">Single-Cell Organisms</span>

</h1>

13. Pagination

pagebreak

A (sometimes valued) separator denoting the position before which a break between two contiguous pages occurs in a statically paginated media.

HTML Usage Context: Phrasing and Flow content, where the value of the carrying elements title attribute takes precedence over element content for the purposes of representing the pagebreak value.

Example

14. Keywords

keyword

A key word or phrase.

HTML Usage Context: phrasing content

HTML Implied Context: li elements on an ol or ul carrying the keywords term.

Example

<p>A <b epub:type="keyword">capital gain</b> is realized when … </p>

keywords

A collection of keywords.

HTML Usage Context: sectioning content, grouping content

Content Model Requirements: must contain one or more keyword, either explicit or implied

Example

<h1>Key Terms</h1>

<li>Benefit</li>

<li>Capital</li>

<li>Economic model</li>

</ol>

</section>

15. Credits

credit

An acknowledgement of the source of cited content, or of a contribution to the work.

HTML Usage Context: aside, grouping content

HTML Implied Context: li elements on an ol or ul carrying the credits term.

Example

<p epub:type="credit">Page <a href="C03.xhtml#ch03table01">62</a>, <a href="C03.xhtml#ch03table01">Table 3.1</a> from <cite>“Economic Foundations of Cost-Effectiveness Analysis”</cite> by A. M. Garber and C. E. Phelps, <cite>Journal of Health Economics</cite> 16(1):1–31, 1997. Reprinted by permission of Elsevier Science.</p>