Warning:
This wiki has been archived and is now read-only.
DPUBVocabulary
From Digital Publishing Interest Group
Proposed DPUB Vocabulary
These terms are a subset of terms listed in the EPUB 3 Structural Semantic Vocabulary (http://www.idpf.org/epub/vocab/structure).
| Term | Definition | HTML Usage | EPUB Category | Notes | Revised Definition | Parent Role |
|---|---|---|---|---|---|---|
| biblioentry | An entry in a bibliography. | grouping content | bibliographies | 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.). | listitem ? | |
| bibliography | A list of works cited | sectioning content | bibliographies | A list of external references cited in the work, which may be to print or digital sources | list? | |
| help | Information that clarifies or augments the content | aside, phrasing content | complementary content | revision needed | complementary | |
| notice | Information that requires special attention, and that must not be skipped or suppressed. Examples include: alert, warning, caution, danger, important | section, grouping content | complementary content | this may clash with the "note" role already in (http://www.w3.org/TR/wai-aria/roles#note), Consider renaming to avoid confusion | Information that requires special attention from the user. Examples include: alert, warning, caution, danger, important | alert |
| pullquote | A quotation from the text that is set off in a distinctive fashion, such as in a larger typeface. | aside | complementary content | A distinctively placed or highlighted quotation from the current content designed to draw attention to a topic or highlight a key point. | presentation | |
| chapter | A major structural division of a piece of writing. | section, body | document divisions | already in (http://www.w3.org/1999/xhtml/vocab) | A major thematic section of content in a work. | section |
| part | A major structural division of a piece of writing, typically encapsulating a set of related chapters | section, body | document divisions | A major structural division in a published work that contains a set of related sections dealing with a particular subject, narrative arc or similar encapsulated theme. | section | |
| landmarks | A collection of references to well-known/recurring components within the publication | sectioning content | document navigation | A navigational aid that consists of a list of links to significant points of interest in the content. | directory / navigation | |
| toc | A table of contents, typically appearing in the work's frontmatter, or at the beginning of a section. | sectioning content | document navigation | already in (http://www.w3.org/1999/xhtml/vocab#contents) | 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. | directory |
| cover | The publication's cover(s), jacket information, etc. | section, body | document partitions | revision needed | contentinfo | |
| appendix | Supplemental information. | sectioning content | document reference section | already in (http://www.w3.org/1999/xhtml/vocab#appendix) | A section of supplemental information located after the primary content that informs the content but is not central to it. | complementary |
| abstract | A short summary of the principle ideas, concepts and conclusions of the work, or of a section or excerpt within it. | section, grouping content | document sections | contentinfo | ||
| 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. | section, grouping content | document sections | 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. | section | |
| epilogue | A concluding section that is typically written from a later point in time than the main story, although still part of the narrative | section, grouping content | document sections | A concluding section of narrative that wraps up or comments on the actions and events of the work, typically from a future perspective. | section | |
| foreword | An introductory section that precedes the work, typically not written by the work's author. | section, grouping content | document sections | section | ||
| preface | An introductory section that precedes the work, typically written by the work's author. | section, grouping content | document sections | section | ||
| prologue | An introductory section that sets the background to a story, typically part of the narrative. | section, grouping content | document sections | An introductory section that sets the background to a work, typically part of the narrative. | section | |
| learning-objective | An explicit designation or description of a learning objective or a reference to an explicit learning objective | flow content, phrasing content | educational content | revision needed | ??? might need a new abstract role | |
| learning-outcome | The understanding or ability a student is expected to achieve as a result of a lesson or activity. | flow content | educational content | The understanding or ability a user is expected to achieve as a result of a lesson or activity. | ??? | |
| glossary | An alphabetical list of terms in a particular domain of knowledge, with the definitions for those terms. | dl, sectioning content | glossaries | already in (http://www.w3.org/1999/xhtml/vocab) | A brief dictionary of new, uncommon or specialized terms used in the content. | section |
| glossdef | The definition of a term in a glossary. | 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. | glossaries | how do we resolve this with the existence of dd? | dd / definition | |
| glossterm | A glossary term. | 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. | glossaries | how do we resolve this with the existence of dt and dfn? | dt ? | |
| index | A detailed list, usually arranged alphabetically, of the specific information in a publication | sectioning content, body | indexes | already in (http://www.w3.org/1999/xhtml/vocab) | A navigation aid that provides a detailed list of links to key subjects, names and other important topics covered in the work. | directory |
| footnote | A note appearing at the bottom of a page | On the aside element when identifying a single footnote. (Note: EPUB has specified value for sectioning elements of footnotes. This can be implied by grouping of elements tagged as footnote within sectioning content.) | notes and annotations | ARIA already has note (http://www.w3.org/TR/wai-aria/roles#note) | revision needed (maybe indicate relationship to content?) | coordinate with PF - might be handled already |
| rearnote | A note appearing in the rear (backmatter) of the work, or at the end of a section | On the aside element when identifying a single rearnote, or on descendants of sectioning content (Note: EPUB has specified value for sectioning elements of rearnotes. This can be implied by grouping of elements tagged as rearnote within sectioning content.) | notes and annotations | ARIA already has note (http://www.w3.org/TR/wai-aria/roles#note) | revision needed (maybe indicate relationship to content?) | ??? |
| page-list | A list of references to pagebreaks in a statically paginated media | sectioning content | pagination | A navigation aid that provides a list of links to the pagebreaks in the content. | directory | |
| pagebreak | A (sometimes valued) separator denoting the position before which a break between two contiguous pages occurs in a statically paginated media. | 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 | pagination | A separator denoting the position before which a break occurs between two contiguous pages in a statically paginated version of the content. | separator | |
| biblioref | A reference to a bibliography entry. | a | references | link | ||
| glossref | A reference to a glossary definition. | a | references | link | ||
| noteref | A reference to a note, typically appearing a superscripted symbol in the main body of text. | a | references | link | ||
| referrer (change term? "return") | A link back to the starting location in a bidirectional linking relationship. | a | references | link | ||
| answer | The component of a self-assessment problem that provides the answer to the question. | aside, grouping content | testing | |||
| assessment | A test, quiz, or other activity that helps measure a student's understanding of what is being taught. | sectioning content | testing | A test, quiz, or other activity that helps measure the user's understanding of the content. | section | |
| feedback | Helpful instruction to the reader based on the result of an assessment. | grouping content, phrasing content | testing | Instruction or advice returned to the user based on the result of an interactive experience, such as an assessment. | alert | |
| practice | A review exercise or sample | aside, grouping content | testing | revision needed | ||
| qna | A question and answer section | lists or sectioning content | testing | section | ||
| question | The component of a self-assessment problem that identifies the question to be solved. | grouping content | testing | |||
| subtitle | An explanatory or alternate title for the work. | heading content, phrasing content descendants of heading content,paragraphs, divs | titles and headings | heading | ||
| title | The primary name of a work, section or component. When used in the context of a fulltitle, the primary part of the full title. | heading content, phrasing content descendants of heading content. | titles and headings | The primary name of a work, section or component. | heading |