| CARVIEW |
EPUB 3 Structural Semantics Vocabulary 1.1
More details about this document
- This version:
- https://www.w3.org/TR/2023/NOTE-epub-ssv-11-20231221/
- Latest published version:
- https://www.w3.org/TR/epub-ssv-11/
- Latest editor's draft:
- https://w3c.github.io/epub-specs/epub33/ssv/
- History:
- https://www.w3.org/standards/history/epub-ssv-11/
- Commit history
- Editors:
- Ivan Herman (W3C)
- Matt Garrish (DAISY Consortium)
- Former editors:
- Tzviya Siegman (John Wiley & Sons)
- Markus Gylling (International Digital Publishing Forum (IDPF))
- Feedback:
- GitHub w3c/epub-specs (pull requests, new issue, open issues)
- public-pm-wg@w3.org with subject line [epub-ssv-11] … message topic … (archives)
- Errata:
- https://w3c.github.io/epub-specs/epub33/errata.html
Copyright © 1999-2023 International Digital Publishing Forum and World Wide Web Consortium. W3C® liability, trademark and permissive document license rules apply.
Abstract
This vocabulary, a part of EPUB® 3, defines a set of properties relating to the description of structural semantics of written works.
Status of This Document
This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.
This document was published by the Publishing Maintenance Working Group as a Group Note using the Note track.
This Group Note is endorsed by the Publishing Maintenance Working Group, but is not endorsed by W3C itself nor its Members.
This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
The W3C Patent Policy does not carry any licensing requirements or commitments on this document.
This document is governed by the 03 November 2023 W3C Process Document.
Structural semantics add additional meaning about the specific structural purpose an HTML (or SVG)
element plays. The epub:type attribute [epub-33] is used to express domain-specific semantics in
EPUB content documents and media overlay documents [epub-33], with the structural
information it carries complementing the underlying vocabulary.
The applied semantics refine the meaning of their containing elements without changing their nature for
assistive technologies, as happens when using the similar role attribute [html]. The attribute
does not enhance the accessibility of the content, in other words, only provides hints about the
purpose.
Semantic metadata enriches content for use in publishing workflows and for author-defined purposes. It also allows reading systems to learn more about the structure and content of a document (e.g., to enable skippability and escapability in media overlay documents).
The [epub-33] specification defines a method for adding structural semantics using the attribute
axis: instead of adding new elements, EPUB creators can append the epub:type
attribute to existing elements to add the desired semantics. This document defines a set of property
values, i.e., a vocabulary, that can be used for that purpose.
While the EPUB Structural Semantics vocabulary is generally host language agnostic, it has been constructed primarily to enable semantic inflection of elements in the HTML vocabulary.
The HTML usage context fields indicate contexts in HTML documents where the given property is considered relevant. EPUB creators may use the properties on HTML markup elements not specifically listed, but must ensure that the semantics they express represent a subset of the carrying element's semantics and do not attach an existing element's meaning to a semantically neutral element.
The DPUB-ARIA role fields indicate the [dpub-aria-1.0] roles that can
alternatively be used with the [html] role attribute to improve accessibility. These
roles may have more restrictive usage contexts, however, so may not be valid wherever the
epub:type attribute [epub-33] is used (e.g., roles are not allowed on the [html] body
element). Refer to [html-aria] for more information about where the roles are allowed.
When processing HTML documents, reading systems may ignore such non-compliant properties, unless their usage context is explicitly overridden or extended by the host specification.
The Usage details field, when present, identifies a specification that defines or utilizes the designated property. Authors are only required to follow these usage details if they are creating content that conforms to the specified specification, or if the rules apply to all EPUB publications. In all other cases, the properties may be used however needed.
- backmatter
-
Ancillary material occurring after the main content of a publication, such as indices, appendices, etc.
- bodymatter
-
The main content of a publication.
- cover
-
A section that introduces the work, often consisting of a marketing image, the title, author, and publisher, and select quotes and reviews.
-
DPUB-ARIA role: doc-cover (only allowed on cover image tag)
- frontmatter
-
Preliminary material to the main content of a publication, such as tables of contents, dedications, etc.
- chapter
-
A major thematic section of content in a work.
-
DPUB-ARIA role: doc-chapter
- division
-
A major structural division that may also appear as a substructure of a part (esp. in legislation).
- subchapter [deprecated]
-
A major sub-division of a chapter.
- part
-
A major structural division in a work that contains a set of related sections dealing with a particular subject, narrative arc, or similar encapsulated theme.
-
DPUB-ARIA role: doc-part
- volume
-
A component of a collection.
Sections and components that typically occur in the publication bodymatter.
- abstract [draft]
-
A short summary of the principle ideas, concepts, and conclusions of the work, or of a section or excerpt within it.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-abstract
- afterword
-
A closing statement from the author or a person of importance, typically providing insight into how the content came to be written, its significance, or related events that have transpired since its timeline.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-afterword
- conclusion
-
A concluding section or statement that summarizes the work or wraps up the narrative.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-conclusion
- epigraph
-
A quotation set at the start of the work or a section that establishes the theme or sets the mood.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-epigraph
- epilogue
-
A concluding section of narrative that wraps up or comments on the actions and events of the work, typically from a future perspective.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-epilogue
- foreword
-
An introductory section that precedes the work, typically not written by the author of the work.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-foreword
- introduction
-
A preliminary section that typically introduces the scope or nature of the work.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-introduction
- preamble
-
A section in the beginning of the work, typically containing introductory and/or explanatory prose regarding the scope or nature of the work's content
-
HTML usage context: section, grouping content
- preface
-
An introductory section that precedes the work, typically written by the author of the work.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-preface
- prologue
-
An introductory section that sets the background to a work, typically part of the narrative.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-prologue
- landmarks
-
A collection of references to well-known/recurring components within the publication
-
HTML usage context: sectioning content
-
Usage details: The
landmarks navElement [epub-33] - loa
-
A listing of audio clips included in the work.
-
HTML usage context: sectioning content
- loi
-
A listing of illustrations included in the work.
-
HTML usage context: sectioning content
- lot
-
A listing of tables included in the work.
-
HTML usage context: sectioning content
- lov
-
A listing of video clips included in the work.
-
HTML usage context: sectioning content
- toc
-
A navigational aid that provides an ordered list of links to the major sectional headings in the content. A table of contents may cover an entire work, or only a smaller section of it.
-
HTML usage context: sectioning content
-
DPUB-ARIA role: doc-toc
-
Usage details: The
toc navElement [epub-33] - toc-brief [draft]
-
An abridged version of the table of contents.
-
HTML usage context: sectioning content
- appendix
-
A section of supplemental information located after the primary content that informs the content but is not central to it.
-
HTML usage context: sectioning content
-
DPUB-ARIA role: doc-appendix
- colophon
-
A short section of production notes particular to the edition (e.g., describing the typeface used), often located at the end of a work.
-
HTML usage context: sectioning content, grouping content
-
DPUB-ARIA role: doc-colophon
- credits [draft]
-
A collection of credits.
-
HTML usage context: sectioning content, grouping content
-
DPUB-ARIA role: doc-credits
- keywords [draft]
-
A collection of keywords.
-
HTML usage context: sectioning content, grouping content
- biblioentry
-
A single reference to an external source in a bibliography. A biblioentry typically provides more detailed information than its reference(s) in the content (e.g., full title, author(s), publisher, publication date, etc.).
-
Required parent context: bibliography
-
HTML usage context: grouping content
-
DPUB-ARIA role: doc-biblioentry (Deprecated)
- bibliography
-
A list of external references cited in the work, which may be to print or digital sources.
-
HTML usage context: sectioning content
-
DPUB-ARIA role: doc-bibliography
- antonym-group
-
A group of terms, each having an opposite or nearly opposite meaning from a headword or idiom.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Antonym Groups [epub-dict-10]
- condensed-entry
-
A condensed dictionary entry designed for constrained lookup viewports.
-
Required parent context: dictentry
-
HTML usage context: aside
-
Usage details: The Condensed Entry [epub-dict-10]
- def
-
The definition of a particular meaning of a headword or idiom.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Definitions [epub-dict-10]
- dictentry
-
A dictionary entry.
-
Required parent context: dictionary
-
HTML usage context: article
-
Usage details: The Dictionary Entry [epub-dict-10]
- dictionary
-
A collection of dictionary entries.
-
Usage details: The Dictionary Container [epub-dict-10]
- etymology
-
An explanation of the historical origin of a headword.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Etymologies [epub-dict-10]
- example
-
An illustration of the usage of a defined term or phrase.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Examples [epub-dict-10]
- gram-info
-
Supplemental grammatical information related to the headword and modifying a part of speech or a particular meaning.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Related Grammatical Information [epub-dict-10]
- idiom
-
A defining instance of a phrase.
-
Required parent context: dictentry or phrase-group
-
HTML usage context: dfn
-
Usage details: Idioms [epub-dict-10]
- part-of-speech
-
The grammatical function of a headword.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: The Dictionary Container [epub-dict-10]
- part-of-speech-list
-
A list of part of speech groups in a dictionary entry.
-
Required ancestor context: dictentry
-
HTML usage context: ol
-
Usage details: Part of Speech Lists [epub-dict-10]
- part-of-speech-group
-
A unit that associates a part of speech with its related sense and phrase groups.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Part of Speech Groups [epub-dict-10]
- phonetic-transcription
-
A phonetic transcription of the pronunciation of a headword or other component of a dictionary entry.
-
HTML usage context: flow content
-
Usage details: Phonetic Transcriptions [epub-dict-10]
- phrase-list
-
A list of phrase groups in a dictionary entry.
-
Required ancestor context: dictentry
-
Usage details: Phrase Lists [epub-dict-10]
- phrase-group
-
A unit for organizing information pertaining to an idiom or example.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Phrase Groups [epub-dict-10]
- sense-list
-
A list of sense groups in a dictionary entry.
-
Required ancestor context: dictentry
-
HTML usage context: ol
-
Usage details: Sense Lists [epub-dict-10]
- sense-group
-
A unit for organizing information pertaining to a particular meaning of a headword or idiom.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Sense Groups [epub-dict-10]
- synonym-group
-
A group of terms, each having identical or similar meaning to a headword or idiom.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Synonym Groups [epub-dict-10]
- tran
-
The translation of a particular meaning of a source language headword, idiom, or example into a target language.
-
Required ancestor context: dictentry
-
HTML usage context: flow content
-
Usage details: Translations [epub-dict-10]
- tran-info
-
Grammatical or usage information related to a translation.
-
Required ancestor context: tran
-
HTML usage context: flow content
-
Usage details: Translation-Related Information [epub-dict-10]
- glossary
-
A brief dictionary of new, uncommon, or specialized terms used in the content.
-
HTML usage context: dl, sectioning content
-
DPUB-ARIA role: doc-glossary
-
Usage details: The Glossary Container [epub-dict-10]
- glossdef
-
The definition of a term in a glossary.
-
Required parent context: glossary
-
HTML usage context: The glossdef property is implied on dd elements within a dl element marked with the glossary property.
-
Usage details: Glossary Terms and Definitions [epub-dict-10]
- glossterm
-
A glossary term.
-
Required parent context: glossary
-
HTML usage context: The glossterm property is implied on dd elements within a dl element marked with the glossary property.
-
Usage details: Glossary Terms and Definitions [epub-dict-10]
- index
-
A navigational aid that provides a detailed list of links to key subjects, names and other important topics covered in the work.
-
HTML usage context: sectioning content, body
-
Usage details: index property [epub-indexes-10]
-
DPUB-ARIA role: doc-index
- index-editor-note
-
Editorial note pertaining to a single entry.
-
Required parent context: index-entry
-
HTML usage context: flow content
-
Usage details: index-editor-note property [epub-indexes-10]
- index-entry
-
One term with any attendant subentries, locators, cross references, and/or editorial note.
-
Required parent context: index-entry-list
-
HTML usage context: li; this property is implied when parent ul is of type index-entry-list (implicit or explicit)
-
Usage details: index-entry property [epub-indexes-10]
- index-entry-list
-
Collection of consecutive main entries or subentries.
-
Required parent context: index-entry , index-group, and index
-
HTML usage context: ul; this property is implied when the ul has an ancestor of index except within index-headnotes
-
Usage details: index-entry-list property [epub-indexes-10]
- index-group
-
Collection of consecutive main entries that share a common characteristic, for example the starting letter of the main entries.
-
Required parent context: index
-
HTML usage context: sectioning content
-
Usage details: index-group property [epub-indexes-10]
- index-headnotes
-
Narrative or other content to assist users in using the index.
-
Required parent context: index
-
HTML usage context: sectioning content, header
-
Usage details: index-headnotes property [epub-indexes-10]
- index-legend
-
List of symbols, abbreviations or special formatting used in the index, and their meanings.
-
Required parent context: index-headnotes
-
HTML usage context: sectioning content, dl
-
Usage details: index-legend property [epub-indexes-10]
- index-locator
-
A reference to an occurrence of the indexed content in the publication.
-
Required parent context: index-entry , index-locator-list , and index-locator-range
-
HTML usage context: a; this property is implied when parent context is index-locator-list or index-locator-range
-
Usage details: index-locator property [epub-indexes-10]
- index-locator-list
-
Collection of sequential locators or locator ranges.
-
Required parent context: index-entry
-
HTML usage context: ul
-
Usage details: index-locator-list property [epub-indexes-10]
- index-locator-range
-
A pair of locators that connects a term to a range of content rather than a single point.
-
Required parent context: index-locator-list and index-entry
-
HTML usage context: flow content
-
Usage details: index-locator-range property [epub-indexes-10]
- index-term
-
Word, phrase, string, glyph, or image representing the indexable content.
-
Required parent context: index-xref-related , index-entry and index-xref-preferred
-
HTML usage context: phrasing content; typically span
-
Usage details: index-term property [epub-indexes-10]
- index-term-categories
-
Wrapper for a list of the term categories belonging to an index.
-
Required parent context: index-xref-related and index-xref-preferred
-
HTML usage context: a
-
Usage details: index-term-categories property [epub-indexes-10]
- index-term-category
-
Word, phrase, string, glyph, or image representing a category of terms in the index.
-
Required parent context: index-xref-related and index-xref-preferred
-
HTML usage context: a
-
Usage details: index-term-category property [epub-indexes-10]
- index-xref-preferred
-
Reference from one term to one or more preferred terms or term categories in an index (analogous to "See xxx").
-
Required parent context: index-entry
-
HTML usage context: flow content
-
Usage details: index-xref-preferred property [epub-indexes-10]
- index-xref-related
-
Reference from one term to one or more related terms or term categories in an index (analogous to "See also xxx").
-
Required parent context: index-entry
-
HTML usage context: flow content
-
Usage details: index-xref-related property [epub-indexes-10]
Preliminary sections and components, typically occurring in the publication frontmatter.
- acknowledgments
-
A section or statement that acknowledges significant contributions by persons, organizations, governments, and other entities to the realization of the work.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-acknowledgments
- contributors
-
A list of contributors to the work.
-
HTML usage context: section, grouping content
- copyright-page
-
The copyright page of the work.
-
HTML usage context: section, grouping content
- dedication
-
An inscription at the front of the work, typically addressed in tribute to one or more persons close to the author.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-dedication
- errata
-
A set of corrections discovered after initial publication of the work, sometimes referred to as corrigenda.
-
HTML usage context: section, aside, grouping content
-
DPUB-ARIA role: doc-errata
- halftitlepage
-
The half title page of the work.
-
HTML usage context: section, grouping content
- imprimatur
-
A formal statement authorizing the publication of the work.
-
HTML usage context: section, grouping content
- imprint
-
Information relating to the publication or distribution of the work.
-
HTML usage context: section, grouping content
- other-credits
-
Acknowledgments of previously published parts of the work, illustration credits, and permission to quote from copyrighted material.
-
HTML usage context: section, grouping content
- revision-history
-
A record of changes made to a work.
-
HTML usage context: section, grouping content
- seriespage [draft]
-
Marketing section used to list related publications.
-
HTML usage context: section, grouping content
- titlepage
-
The title page of the work.
-
HTML usage context: section, grouping content
- case-study [draft]
-
A detailed analysis of a specific topic.
-
Inherits from: xhv:complementary
-
HTML usage context: sectioning content
- help [deprecated]
-
Helpful information that clarifies some aspect of the content or assists in its comprehension.
-
Inherits from: xhv:complementary
-
HTML usage context: aside, phrasing content
-
Replaced by: tip
- marginalia [deprecated]
-
Content, both textual and graphical, that is offset in the margin.
-
Inherits from: xhv:complementary
-
HTML usage context: aside, phrasing content
-
Replaced by: aside
- notice
-
Notifies the user of consequences that might arise from an action or event. Examples include warnings, cautions and dangers.
-
HTML usage context: section, grouping content
-
DPUB-ARIA role: doc-notice
- pullquote [draft]
-
A distinctively placed or highlighted quotation from the current content designed to draw attention to a topic or highlight a key point.
-
Inherits from: xhv:complementary
-
HTML usage context: aside
-
DPUB-ARIA role: doc-pullquote
- sidebar [deprecated]
-
Secondary or supplementary content, typically formatted as an inset or box.
-
Inherits from: xhv:complementary
-
HTML usage context: aside
-
Replaced by: aside
- tip
-
Helpful information that clarifies some aspect of the content or assists in its comprehension.
-
Inherits from: xhv:complementary
-
HTML usage context: aside, phrasing content
-
DPUB-ARIA role: doc-tip
- warning [deprecated]
-
A warning.
-
HTML usage context: section, grouping content
-
Replaced by: notice
- bridgehead [deprecated]
-
A structurally insignificant heading that does not contribute to the hierarchical structure of the work.
-
HTML usage context: flow content, typically p, div or span
- covertitle
-
The title of the work as displayed on the work's cover.
-
Inherits from: title
-
HTML usage context: heading content. This property should only appear once within the document scope.
- fulltitle
-
The full title of the work, either simple, in which case it is identical to title, or compound, in which case it consists of a title and a subtitle.
-
Inherits from: title
-
Same as: https://purl.org/dc/terms/title
-
HTML usage context: heading content. This property should only appear once within the document scope.
- halftitle
-
The title appearing on the first page of a work or immediately before the text.
-
Inherits from: title
-
HTML usage context: heading content. This property should only appear once within the document scope.
- label [draft]
-
The text label that precedes an ordinal in a component title (e.g., 'Chapter', 'Part', 'Figure', 'Table').
-
Inherits from: title
-
HTML usage context: Phrasing content descendants of heading content, li and figcaption
- ordinal [draft]
-
An ordinal specifier for a component in a sequence of components (e.g., '1', 'IV', 'B-1').
-
Inherits from: title
-
HTML usage context: Phrasing content descendants of heading content, li and figcaption
- subtitle
-
An explanatory or alternate title for the work, or a section or component within it.
-
Inherits from: title
-
HTML usage context: heading content, phrasing content descendants of heading content, paragraphs, divs
-
DPUB-ARIA role: doc-subtitle
- title
-
The primary name of a document component, such as a list, table, or figure.
-
HTML usage context: heading content, phrasing content descendants of heading content.
- 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
- learning-objectives [draft]
-
A collection of learning-objectives.
-
HTML usage context: sectioning content, grouping content
- learning-outcome [draft]
-
The understanding or ability a student is expected to achieve as a result of a lesson or activity.
-
HTML usage context: flow content
- learning-outcomes [draft]
-
A collection of learning-outcomes.
-
HTML usage context: sectioning content, grouping content
- learning-resource
-
A resource provided to enhance learning, or a reference to such a resource.
-
HTML usage context: flow content
- learning-resources [draft]
-
A collection of learning-resources.
-
HTML usage context: sectioning content, grouping content
- learning-standard [draft]
-
A formal set of expectations or requirements typically issued by a government or a standards body.
-
HTML usage context: sectioning content, phrasing content
- learning-standards [draft]
-
A collection of learning-standards.
-
HTML usage context: sectioning content, grouping content
- answer [draft]
-
The component of a self-assessment problem that provides the answer to the question.
-
HTML usage context: aside, grouping content
- answers [draft]
-
A collection of answers.
-
HTML usage context: sectioning content, grouping content
- assessment
-
A test, quiz, or other activity that helps measure a student's understanding of what is being taught.
-
HTML usage context: sectioning content
- assessments [draft]
-
A collection of assessments.
-
HTML usage context: sectioning content
- feedback [draft]
-
Instruction to the reader based on the result of an assessment.
-
HTML usage context: grouping content, phrasing content
- fill-in-the-blank-problem [draft]
-
A problem that requires the reader to input a text answer to complete a sentence, statement or similar.
-
HTML usage context: aside, grouping content
- general-problem [draft]
-
A problem with a free-form solution.
-
HTML usage context: aside, grouping content
- match-problem [draft]
-
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
- multiple-choice-problem [draft]
-
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
- practice [draft]
-
A review exercise or sample.
-
See also: practices
-
HTML usage context: aside, grouping content
- practices [draft]
-
A collection of practices.
-
HTML usage context: sectioning content
- qna
-
A section of content structured as a series of questions and answers, such as an interview or list of frequently asked questions.
-
HTML usage context: lists or sectioning content
-
DPUB-ARIA role: doc-qna
- question [draft]
-
The component of a self-assessment problem that identifies the question to be solved.
-
HTML usage context: grouping content
- true-false-problem [draft]
-
A problem with either a true or false answer.
-
HTML usage context: aside, grouping content
- balloon
-
An area in a comic panel that contains the words, spoken or thought, of a character.
-
HTML usage context: li
-
Usage details: EPUB Region-Based Navigation [epub-region-nav-10]
- panel
-
An individual frame, or drawing.
-
HTML usage context: li
-
Usage details: EPUB Region-Based Navigation [epub-region-nav-10]
- panel-group
-
A group of panels (e.g., a strip).
-
HTML usage context: li
-
Usage details: EPUB Region-Based Navigation [epub-region-nav-10]
- sound-area
-
An area of text in a comic panel that represents a sound.
-
HTML usage context: li
-
Usage details: EPUB Region-Based Navigation [epub-region-nav-10]
- text-area
-
An area of text in a comic panel. Used to represent titles, narrative text, character dialogue (inside a balloon or not) and similar.
-
HTML usage context: li
-
Usage details: EPUB Region-Based Navigation [epub-region-nav-10]
- annotation [deprecated]
-
Explanatory information about passages in the work.
-
Inherits from: xhv:complementary
-
HTML usage context: aside, phrasing content
-
Replaced by: Open Annotation in EPUB
- endnote
-
One of a collection of notes that occur at the end of a work, or a section within it, that provides additional context to a referenced passage of text.
-
See also: endnotes
-
HTML usage context: On the aside element when identifying a single endnote, or on descendants of sectioning content when identifying individual endnotes in a group (refer to footnotes and endnotes).
-
DPUB-ARIA role: doc-endnote (Deprecated)
- endnotes
-
A collection of notes at the end of a work or a section within it.
-
See also: endnote
-
HTML usage context: sectioning content
-
DPUB-ARIA role: doc-endnotes
- footnote
-
Ancillary information, such as a citation or commentary, that provides additional context to a referenced passage of text.
-
See also: footnotes
-
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 endnotes).
-
DPUB-ARIA role: doc-footnote
- footnotes
-
A collection of footnotes.
-
See also: footnote
-
HTML usage context: sectioning content
- note [deprecated]
-
A note. This property does not carry spatial positioning semantics, as do the footnote and endnote properties. It can be used to identify footnotes, endnotes, marginal notes, inline notes, and similar when legacy naming conventions are not desired.
-
HTML usage context: On the aside element when identifying a single note, or on descendants of sectioning content when identifying individual notes in a group (refer to footnotes and endnotes).
- rearnote [deprecated]
-
A note appearing in the rear (backmatter) of the work, or at the end of a section.
-
See also: rearnotes
-
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).
-
Replaced by: endnote
- rearnotes [deprecated]
-
A collection of notes appearing at the rear (backmatter) of the work, or at the end of a section.
-
See also: rearnote
-
HTML usage context: sectioning content
-
Replaced by: endnotes
- annoref [deprecated]
-
A reference to an annotation.
-
Inherits from: xhv:link
-
See also: annotation
-
HTML usage context: a
-
Replaced by: Open Annotation in EPUB
- backlink [draft]
-
A link that allows the user to return to a related location in the content (e.g., from a footnote to its reference or from a glossary definition to where a term is used).
-
Inherits from: xhv:link
-
HTML usage context: a
-
DPUB-ARIA role: doc-backlink
- biblioref [draft]
-
A reference to a bibliography entry.
-
Inherits from: xhv:link
-
HTML usage context: a
-
DPUB-ARIA role: doc-biblioref
- glossref [draft]
-
A reference to a glossary definition.
-
Inherits from: xhv:link
-
HTML usage context: a
-
DPUB-ARIA role: doc-glossref
- noteref
-
A reference to a note, typically appearing as a superscripted number or symbol in the main body of text.
-
Inherits from: xhv:link
-
See also: note
-
HTML usage context: a
-
DPUB-ARIA role: doc-noteref
Terms for describing components at the phrasing level.
- concluding-sentence
-
A phrase or sentence serving as a concluding summary of the containing paragraph.
-
HTML usage context: phrasing content
- credit [draft]
-
An acknowledgment of the source of integrated content from third-party sources, such as photos. Typically identifies the creator, copyright, and any restrictions on reuse.
-
HTML usage context: phrasing content
-
DPUB-ARIA role: doc-credit
- keyword
-
A key word or phrase.
-
HTML usage context: phrasing content
- topic-sentence
-
A phrase or sentence serving as an introductory summary of the containing paragraph.
-
HTML usage context: phrasing content
- page-list
-
A navigational aid that provides a list of links to the pagebreaks in the content.
-
HTML usage context: sectioning content
-
DPUB-ARIA role: doc-pagelist
-
Usage details: The
page-list navElement [epub-33] - pagebreak
-
A separator denoting the position before which a break occurs between two contiguous pages in a statically paginated version of the content.
Page break locators are also commonly used to provide static markers in purely digital publications (i.e., where no statically paginated equivalent exists). These markers provide consistent navigation regardless of differences in font and screen size that can otherwise affect the dynamic pagination of the content.
EPUB creators must ensure the name of the page break is an end user-consumable page number that identifies the page that is beginning.
-
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
-
DPUB-ARIA role: doc-pagebreak
- table
-
A structure containing data or content laid out in tabular form.
-
HTML usage context: Not Allowed
-
Media overlays usage context: Identifies a
seqorparas an escapable or skippable table structure. - table-row
-
A row of data or content in a tabular structure.
-
HTML usage context: Not Allowed
-
Media overlays usage context: Identifies a
seqorparas an escapable or skippable table row. - table-cell
-
A single cell of tabular data or content.
-
HTML usage context: Not Allowed
-
Media overlays usage context: Identifies a
seqorparas an escapable or skippable table cell.
- list
-
A structure that contains an enumeration of related content items.
-
HTML usage context: Not Allowed
-
Media overlays usage context: Identifies a
seqorparas an escapable or skippable list structure. - list-item
-
A single item in an enumeration.
-
HTML usage context: Not Allowed
-
Media overlays usage context: Identifies a
seqorparas an escapable or skippable list item.
This section is non-normative.
The following members of the EPUB 3 Working Group contributed to the development of this specification:
- Shadi Abou-Zahra (Amazon)
- Will AWAD (Newgen Knowledgeworks)
- Noel Ray Barron (Apple Inc.)
- Sofia Bautista (Legible Media Inc.)
- Leah Brochu (National Network for Equitable Library Service)
- Matthew C. Chan (House of Anansi Press)
- Yu-Wei Chang (Taiwan Digital Publishing Forum)
- Juan Corona (Legible Media Inc.)
- Dave Cramer (W3C Invited Expert, chair)
- Romain Deltour (DAISY Consortium)
- Marisa DeMeglio (DAISY Consortium)
- Brady Duga (Google LLC)
- Reinaldo Ferraz (NIC.br - Brazilian Network Information Center)
- Symon Flaming (Rakuten Group, Inc.)
- John Foliot (W3C Invited Expert)
- Teenya Franklin (Pearson plc)
- Hadrien Gardeur (EDRLab)
- Matt Garrish (DAISY Consortium)
- Jen Goulden (Crawford Technologies)
- David Hall (Apple Inc.)
- Ivan Herman (W3C, staff contact)
- Tetsu Hoshino (Kodansha, Publishers, Ltd.)
- jasen huang (ByteDance)
- Norikazu Ishizu (Kadokawa Corporation)
- Norihito IYENAGA (Kodansha, Publishers, Ltd.)
- Rick Johnson (VitalSource Technologies)
- Ken Jones (Circular Software)
- Antonio Kamiya (Dentsu Group Inc.)
- Deborah Kaplan (W3C Invited Expert)
- Bill Kasdorf (Book Industry Study Group)
- Hiroshi Kawada (MEDIA DO Co., Ltd.)
- George Kerscher (DAISY Consortium)
- Kazuhito Kidachi (Mitsue-Links Co., Ltd.)
- Masakazu Kitahara (Voyager Japan, Inc.)
- Toshiaki Koike (Voyager Japan, Inc.)
- Ryo Kuroda (ACCESS CO., LTD.)
- Charles LaPierre (Benetech)
- Dan Lazin (Google LLC)
- Philippe Le Hegaret (W3C)
- Laurent Le Meur (EDRLab)
- YuYu Lin (Taiwan Digital Publishing Forum)
- Farrah Little (National Network for Equitable Library Service)
- Victor Lopes (Apple Inc.)
- Karan Malhotra (Newgen Knowledgeworks)
- Makoto Murata (DAISY Consortium)
- Cristina Mussinelli (Fondazione LIA)
- Yoichiro Nagao (Kodansha, Publishers, Ltd.)
- Theresa O'Connor (Apple Inc.)
- Yoshinori Ohmura (SHUEISHA Inc.)
- Rachel Osolen (National Network for Equitable Library Service)
- Gregorio Pellegrino (Fondazione LIA)
- Vijaya Gowri Perumal (Newgen Knowledgeworks)
- Wendy Reid (Rakuten Group, Inc., chair)
- John Roque (Apple Inc.)
- Leonard Rosenthol (Adobe)
- Shinobu Sato (Kadokawa Corporation)
- Ben Schroeter (Pearson plc)
- Daihei Shiohama (MEDIA DO Co., Ltd.)
- Tzviya Siegman (Wiley)
- Avneesh Singh (DAISY Consortium)
- MOTOI SUZUKI (SHUEISHA Inc.)
- Yutaka Suzuki (Kadokawa Corporation)
- Kyrce Swenson (Pearson plc)
- Shinya Takami (Kadokawa Corporation, chair)
- Mateus Teixeira (W. W. Norton & Company)
- Yukio Tomikura (Kodansha, Publishers, Ltd.)
- Aimee Ubbink (Crawford Technologies)
- xinyuan wang (ByteDance)
- Daniel Weck (DAISY Consortium)
- Fuqiao Xue (W3C)
- Evan Yamanishi (W. W. Norton & Company)
- Osamu Yoshiba (Kodansha, Publishers, Ltd.)
- Junichi Yoshii (Kodansha, Publishers, Ltd.)
- Naomi Yoshizawa (W3C)
- Laurence Zaysser (EDRLab)
- [dpub-aria-1.0]
- Digital Publishing WAI-ARIA Module 1.0. Matt Garrish; Tzviya Siegman; Markus Gylling; Shane McCarron. W3C. 14 December 2017. W3C Recommendation. URL: https://www.w3.org/TR/dpub-aria-1.0/
- [epub-33]
- EPUB 3.3. Ivan Herman; Matt Garrish; Dave Cramer. W3C. 25 May 2023. W3C Recommendation. URL: https://www.w3.org/TR/epub-33/
- [epub-dict-10]
- EPUB Dictionaries and Glossaries 1.0. IDPF. 26 August 2015. URL: https://idpf.org/epub/dict
- [epub-indexes-10]
- EPUB Indexes 1.0. IDPF. 26 August 2015. URL: https://idpf.org/epub/idx
- [epub-region-nav-10]
- EPUB Region-Based Navigation 1.0. IDPF. 26 August 2015. URL: https://idpf.org/epub/renditions/region-nav
- [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/
- [html-aria]
- ARIA in HTML. Scott O'Hara; Patrick Lauke. W3C. 13 December 2023. W3C Recommendation. URL: https://www.w3.org/TR/html-aria/