EPUB 3 Structural Semantics Vocabulary (original) (raw)
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 specification was published by theEPUB 3 Community Group. It is not a W3C Standard nor is it on the W3C Standards Track. Please note that under theW3C Community Final Specification Agreement (FSA) other conditions apply. Learn more aboutW3C Community and Business Groups.
This document is subject to change at any time. The terms defined herein will never be removed, but may be deprecated.
This document contains draft terms from the EDUPUB profile.
Any use of terms marked [draft] should be considered experimental.
Deprecated terms are identified by the label [deprecated]. These terms are no longer recommended for use in any context (refer to individual terms for additional restrictions on their use in specific contexts, such as in HTML).
If you wish to make comments regarding this document, please send them topublic-epub3@w3.org (subscribe,archives).
Table of Contents
- 1. About this vocabulary
- 2. Conformance
- 3. Document partitions
- 4. Document divisions
- 5. Document sections and components
- 6. Document navigation
- 7. Document reference sections
- 8. Preliminary sections and components
- 9. Complementary content
- 10. Titles and headings
- 11. Educational content
- 12. Comics
- 13. Notes and annotations
- 14. References
- 15. Document text
- 16. Pagination
- 17. Tables
- 18. Lists
- 19. Figures
- 20. Asides
1. About this vocabulary
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. Authors 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.
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 sections identify IDPF specifications that define or utilize the specified properties.
2. Conformance
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
3. Document partitions
cover
A section that introduces the work, often consisting of a marketing image, the title, author and publisher, and select quotes and reviews.
HTML usage context: section, body
frontmatter
Preliminary material to the main content of a publication, such as tables of contents, dedications, etc.
HTML usage context: section, body
bodymatter
The main content of a publication.
HTML usage context: section, body
backmatter
Ancillary material occurring after the main content of a publication, such as indices, appendices, etc.
HTML usage context: section, body
4. Document divisions
volume
A component of a collection.
HTML usage context: section, body
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.
HTML usage context: section, body
chapter
A major thematic section of content in a work.
HTML usage context: section, body
subchapter [deprecated]
A major sub-division of a chapter.
HTML usage context: section, body
division
A major structural division that may also appear as a substructure of a part (esp. in legislation).
HTML usage context: section, body
5. Document sections and components
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
foreword
An introductory section that precedes the work, typically not written by the author of the work.
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
prologue
An introductory section that sets the background to a work, typically part of the narrative.
HTML usage context: section, grouping content
introduction
A preliminary section that typically introduces the scope or nature of the work.
HTML usage context: section, grouping content
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
conclusion
A concluding section or statement that summarizes the work or wraps up the narrative.
HTML usage context: section, grouping content
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
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
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
6. Document navigation
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
toc-brief [draft]
An abridged version of the table of contents.
HTML usage context: sectioning content
landmarks
A collection of references to well-known/recurring components within the publication
HTML usage context: sectioning content
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
7. Document reference sections
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
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
credits [draft]
A collection of credits.
HTML usage context: sectioning content, grouping content
keywords [draft]
A collection of keywords.
HTML usage context: sectioning content, grouping content
Indexes
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: EPUB Indexes – index property
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: EPUB Indexes – index-headnotes property
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: EPUB Indexes – index-legend property
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: EPUB Indexes – index-group property
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: EPUB Indexes – index-entry-list property
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: EPUB Indexes – index-entry property
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: EPUB Indexes – index-term property
index-editor-note
Editorial note pertaining to a single entry.
Required parent context: index-entry
HTML usage context: flow content
Usage details: EPUB Indexes – index-editor-note property
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: EPUB Indexes – index-locator property
index-locator-list
Collection of sequential locators or locator ranges.
Required parent context: index-entry
HTML usage context: ul
Usage details: EPUB Indexes – index-locator-list property
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: EPUB Indexes – index-locator-range property
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: EPUB Indexes – index-xref-preferred property
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: EPUB Indexes – index-xref-related property
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: EPUB Indexes – index-term-category property
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: EPUB Indexes – index-term-categories property
Glossaries
glossary
A brief dictionary of new, uncommon or specialized terms used in the content.
HTML usage context: dl, sectioning content
glossterm
A glossary term.
Required parent context: glossary
HTML usage context: The glossterm property is implied ondt elements within a dl element marked with the glossary property.
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.
Bibliographies
bibliography
A list of external references cited in the work, which may be to print or digital sources.
HTML usage context: sectioning 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
8. Preliminary sections and components
Preliminary sections and components, typically occuring in the publication frontmatter.
titlepage
The title page of the work.
HTML usage context: section, grouping content
halftitlepage
The half title page of the work.
HTML usage context: section, grouping content
copyright-page
The copyright page of the work.
HTML usage context: section, grouping content
seriespage [draft]
Marketing section used to list related publications.
HTML usage context: section, grouping content
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
imprint
Information relating to the publication or distribution 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
contributors
A list of contributors to 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
errata
A set of corrections discovered after initial publication of the work, sometimes referred to as corrigenda.
HTML usage context: section, aside, 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
revision-history
A record of changes made to a work.
HTML usage context: section, grouping content
9. Complementary 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
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
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
warning [deprecated]
A warning.
HTML usage context: section, grouping content
Replaced by: notice
10. Titles and headings
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.
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: http://purl.org/dc/terms/title
HTML usage context: heading content. This property should only appear once within the document scope.
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.
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.
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
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
bridgehead
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
11. Educational content
Testing
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
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
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
question [draft]
The component of a self-assessment problem that identifies the question to be solved.
HTML usage context: grouping content
practices [draft]
A collection of practices.
HTML usage context: sectioning content
true-false-problem [draft]
A problem with either a true or false answer.
HTML usage context: aside, grouping content
12. Comics
panel
An individual frame, or drawing.
HTML usage context: li
Usage details: EPUB Region-Based Navigation
panel-group
A group of panels (e.g., a strip).
HTML usage context: li
Usage details: EPUB Region-Based Navigation
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
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
sound-area
An area of text in a comic panel that represents a sound.
HTML usage context: li
Usage details: EPUB Region-Based Navigation
13. Notes and annotations
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
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).
Replaced by: footnote, endnote
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).
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).
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
footnotes
A collection of footnotes.
See also: footnote
HTML usage context: sectioning content
endnotes
A collection of notes at the end of a work or a section within it.
See also: endnote
HTML usage context: sectioning content
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
14. References
annoref [deprecated]
A reference to an annotation.
Inherits from: xhv:link
See also: annotation
HTML usage context: a
Replaced by: Open Annotation in EPUB
biblioref [draft]
A reference to a bibliography entry.
Inherits from: xhv:link
HTML usage context: a
glossref [draft]
A reference to a glossary definition.
Inherits from: xhv:link
HTML usage context: a
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
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
15. Document text
Terms for describing components at the phrasing level.
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
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
concluding-sentence
A phrase or sentence serving as a concluding summary of the containing paragraph.
HTML usage context: phrasing content
17. Tables
table
A structure containing data or content laid out in tabular form.
HTML usage context: Not Allowed
Media Overlays usage context: Identifies a seq or par as 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 seq or par as 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 seq or par as an escapable or skippable table cell.
18. Lists
list
A structure that contains an enumeration of related content items.
HTML usage context: Not Allowed
Media Overlays usage context: Identifies a seq or par as 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 seq or par as an escapable or skippable list item.
19. Figures
figure
An illustration, diagram, photo, code listing or similar, referenced from the text of a work, and typically annotated with a title, caption and/or credits.
HTML usage context: Not Allowed
Media Overlays usage context: Identifies a seq or par as an escapable or skippable figure.
20. Asides
aside
Secondary or supplementary content.
HTML usage context: Not Allowed
Media Overlays usage context: Identifies a seq or par as an escapable or skippable aside.