Accessibility of web content requires semantic information about widgets, structures and behaviors in order to allow assistive technologies to convey appropriate information to persons with disabilities. This specification defines a [[WAI-ARIA]] module encompassing an ontology of roles, states and properties specific to the digital publishing industry. These semantics are designed to allow an author to convey user interface behaviors and structural information to assistive technologies and to enable semantic navigation, styling and interactive features used by readers. It is expected this will complement [[HTML5]].
This document is part of the WAI-ARIA suite described in the WAI-ARIA Overview.
This draft is being published to solicit feedback on all aspects of the proposed vocabulary. Feedback from publishers across the publishing spectrum is encouraged, in particular from members of the International Digital Publishing Forum (IDPF) on whose structural semantics vocabulary this work is based.
Implementation of this vocabulary in content or user agents is discouraged at this time, as the vocabulary is subject to change depending on the outcome of this initial review.
WAI-ARIA is a technical specification that defines a common host language semantic accessibility API and framework that enables web browsers to map the accessibility semantics in web content to platform-specific accessibility APIs. This enables web content to be interoperable with platform assistive technologies similar to native platform applications without platform dependencies.
This specification is a modular extension of WAI-ARIA designed for the digital publishing industry. The goals of this specification include:
The roles defined in this specification are derived from the EPUB Structural Semantics Vocabulary.
For a more detailed explanation of WAI-ARIA please refer to the WAI-ARIA Introduction and how it applies to Rich Internet Application Accessibility.
This specification defines a module of WAI-ARIA for digital publishing, including roles, states, properties and values. It impacts several audiences:
Each conformance requirement indicates the audience to which it applies.
Although this specification is applicable to the above audiences, it is not specifically targeted to, nor is it intended to be the sole source of information for, any of these audiences. In the future, additional documents will be created to assist authors in applying these WAI-ARIA semantics for the publishing industry and to define how the information in this document is mapped to platform accessibility APIs.
This module builds on the general User Agent support princinples defined in [[WAI-ARIA]] by also providing the ability for user agents to enhance the general user interface presented to readers.
The Digital Publishing WAI-ARIA module follows the model for co-evolution of WAI-ARIA and host languages defined in [[WAI-ARIA]]. It is intended to augment semantics in supporting languages like [[HTML5]], [[SVG2]] and EPUB, or to be used as an accessibility enhancement technology in other markup-based languages that do not explicitly include support for ARIA. It clarifies semantics to assistive technologies when authors create new types of objects, via style and script, that are not yet directly supported by the language of the page, because the invention of new types of objects is faster than standardized support for them appears in web languages.
It is not appropriate to create objects with style and script when the host language provides a semantic element for that type of objects. While WAI-ARIA can improve the accessibility of these objects, accessibility is best provided by allowing the user agent to handle the object natively. For example, it is not better to use a div
element than it is to use a native heading element, such as an h1
.
It is expected that, over time, host languages will evolve to provide semantics for objects that currently can only be declared with this specification. This is natural and desirable, as one goal of WAI-ARIA is to help stimulate the emergence of more semantic and accessible markup. When native semantics for a given feature become available, it is appropriate for authors to use the native feature and stop using this module for that feature. Legacy content may continue to use the Digital Publishing WAI-ARIA module, however, so the need for user agents to support it remains.
While specific features of this module may lose importance over time, the general possibility of the Digital Publishing WAI-ARIA module to add semantics to web pages or open web based standards, such as EPUB, is expected to be a persistent need. Host languages may not implement all the semantics this module provides, and various host languages may implement different subsets of the features. New types of objects are continually being developed, and one goal of this specification is to provide a way to make such objects accessible, because authoring practices often advance faster than host language standards. In this way, this module and host languages both evolve together but at different rates.
Some host languages exist to create semantics for features other than the user interface. For example, SVG expresses the semantics behind production of graphical objects, not of user interface components that those objects may represent. Host languages such as these might, by design, not provide native semantics that map to this specification's features. In these cases, the Digital Publishing WAI-ARIA module could be adopted as a long-term approach to add semantic information to these host languages.
Programmatic access to accessibility semantics is essential for assistive technologies. For more information, refer to the Assistive Technologies section in [[WAI-ARIA]].
This specification indicates whether a section is normative or informative. Classifying a section as normative or informative applies to the entire section. A statement "This section is normative" or "This section is informative" applies to all sub-sections of that section.
Normative sections provide requirements that authors, user agents and assistive technologies MUST follow for an implementation to conform to this specification.
Informative sections provide information useful to understanding the specification. Such sections may contain examples of recommended practice, but it is not required to follow such recommendations in order to conform to this specification.
This section defines additions to the WAI-ARIA role taxonomy and describes the characteristics and properties of all roles. See ARIA Roles for descriptions of the fields provided by this module.
Below is an alphabetical list of WAI-ARIA roles to be used by rich internet application authors.
Placeholder for compact list of roles
A short summary of the principle ideas, concepts and conclusions of the work, or of a section or excerpt within it.
<section role="dpub-abstract" aria-label="Abstract"> <p>Accessibility of web content requires semantic information about widgets, structures, and behaviors …</p> </section>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB abstract [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
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.
<body role="dpub-afterword"> <hi>Afterword: Why I Wrote This Book</h1> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB afterword [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A section of supplemental information located after the primary content that informs the content but is not central to it.
<section role="dpub-appendix"> <h1>Appendix A. Historical Timeline</h1> … </section>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB appendix [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
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.).
<section role="dpub-bibliography"> <h1>Cited Works</h1> <p role="dpub-biblioentry" id="b8cab5dd-bc24-459c-9858-7afa9da69b64"> John Steinbeck, The Grapes of Wrath (New York: The Viking Press, 1939) </p> … </section>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB biblioentry [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A list of external references cited in the work, which may be to print or digital sources.
<section role="dpub-bibliography"> <h1>Select Bibliography</h1> <ul> … </ul> </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: |
|
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB bibliography [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A reference to a bibliography entry.
<p> As <a role="dpub-biblioref" href="#b8cab5dd-bc24-459c-9858-7afa9da69b64">Steinbeck</a> says in his great novel … </p>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB biblioref [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author content |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A major thematic section of content in a work.
<body role="dpub-chapter"> <h1>Chapter 1. Loomings.</h1> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB chapter [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A section that introduces the work, often consisting of a marketing image, the title, author and publisher, and select quotes and reviews.
<body role="dpub-cover"> <img src="coverimage.jpg" alt="A Room of One's Own by Virginia Woolf"/> </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB cover [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A concluding section of narrative that wraps up or comments on the actions and events of the work, typically from a future perspective.
<body role="dpub-epilogue"> <header> <h1>Epilogue</h1> <p>SPOKEN BY PROSPERO</p> </header> <p>Now my charms are all o'erthrown, …</p> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB epilogue [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
Ancillary information, such as a citation or commentary, that provides additional context to a referenced passage of text.
<aside id="6baa07af" role="dpub-footnote"> Additional results of this study and similar studies can be found at … </aside>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB footnote [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A collection of footnotes.
<section role="dpub-footnotes"> <p id="6baa07af" role="dpub-footnote">Additional results of this study can be found at … </p> <p id="7b2c0555" role="dpub-footnote">…</p> … </section>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB footnotes [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
An introductory section that precedes the work, typically not written by the author of the work.
<body role="dpub-foreword"> <h1>Foreword</h1> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB foreword [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A brief dictionary of new, uncommon or specialized terms used in the content.
<dl role="dpub-glossary"> … <dt id="bcc0f155" role="dpub-glossterm">Credit default swap</dt> <dd role="dpub-glossdef"> A credit default swap effectively insures against default by a borrower. <dd> … </dl>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB glossary [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
For HTML usage context, we would like to say that if the glossary role is carried by a dl
element, the glossterm and glossdef roles are implied on its dt and dd children respectively (cf. http://www.idpf.org/epub/dict/#sec-2.3). Host language-specific implication patterns are not specified in this document though, right?
The definition of a term in a glossary.
It is anticipated that this role will not be necessary once both term and definition roles are available in WAI-ARIA 1.1.
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB glossdef [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A reference to a glossary definition.
<p> This is indicated in the cost of a <a href="#bcc0f155" role="dpub-glossref">credit default swap</a> … </p>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB glossref [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author content |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
We dont say that the the glossref links necessarily be activatable (at all times or at all); is inheriting from role=link still ok?
A glossary term.
It is anticipated that this role will not be necessary once both term and definition roles are available in WAI-ARIA 1.1.
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | term (cf. issue 657) |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB glossterm [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | content |
Accessible Name Required: | |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A navigational aid that provides a detailed list of links to key subjects, names and other important topics covered in the work.
<section role="dpub-index"> <h1>Index</h1> <section> <h2>A</h2> <ul> <li>A/B testing, <a href="chapter03.xhtml#page230">230</a></li> … </ul> </section> … <body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: |
|
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB index [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A link that allows the user to jump to a related location in the content (e.g., from a footnote to its reference, from an index entry to where the topic is discussed, or from a glossary definition to where the term is used).
The name and definition for this end of what are typically bidirectional linking relationships are still under consideration. The role might change or be removed in a future update.
<aside id="fn01" role="dpub-footnote"> <a role="dpub-locator" href="#fnref01">1.</a> Additional results of this study and similar studies can be found at … </aside>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB referrer [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author content |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A reference to a footnote, typically appearing as a superscripted number or symbol in the main body of text.
<p> … as studies have shown.<a id="fnref01" role="dpub-noteref">[1]</a>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB noteref [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author content |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
Notifies the user of consequences that might arise from an action or event. Examples include warnings, cautions and dangers.
<section role="dpub-notice"> <img src="warning.png" alt="warning icon"> <p>Just because you can include a font doesn’t mean you should. Think carefully about readability. Also, be respectful of intellectual property. There are many excellent free open source fonts available.</p> </section>
Authors SHOULD include a label when the notice needs to be navigable to.
<div role="dpub-notice" aria-label="Explosion Risk"> <p><em>Danger!</em> Mixing reactive materials may cause an explosion.</p> </div>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB notice [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A separator denoting the position before which a break occurs between two contiguous pages in a statically paginated version of the content.
<span id="pg04" role="dpub-pagebreak" title="4"/>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB pagebreak [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | content |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | True |
Inherits Presentational: | |
Implicit Value for Role: |
A navigational aid that provides a list of links to the pagebreaks in the content.
<nav role="dpub-pagelist"> <ol> <li><a href="chapter.xhtml#Page_1">1</a></li> <li><a href="chapter.xhtml#Page_2">2</a></li> … </ol> </nav>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB page-list [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
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.
<body role="dpub-part"> <h1>Part One</h1> <section role="dpub-chapter"> <h2>Chapter 1</h2> … </section> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB part [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | True |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
An introductory section that precedes the work, typically written by the author of the work.
<body role="dpub-preface"> <h1>Introduction:A Guide to the Galaxy</h1> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB preface [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
An introductory section that sets the background to a work, typically part of the narrative.
<body role="dpub-prologue"> <header> <h1>Prologue</h1> <p>Chorus</p> </header> <p>Two households, both alike in dignity, …</p> … </body>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB prologue [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A distinctively placed or highlighted quotation from the current content designed to draw attention to a topic or highlight a key point.
<aside role="dpub-pullquote"> Better habits pave the way to growth, and growth leads to greater happiness. </aside>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB pullquote [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
A section of content structured as a series of questions and answers, such as an interview or list of frequently asked questions.
<section role="dpub-qna"> <h2>Interview with the Author</h2> <dl> <dt>Q: When did you begin writing this book?</dt> <dd>A: I first got the idea …</dt> … </dl> </section>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB qna [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
An explanatory or alternate title for the work, or a section or component within it.
<header> <h1>Chapter 2 The Battle</h1> <p role="dpub-subtitle">Once more unto the breach</p> </header>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB subtitle [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
It is not clear if sectionhead is the correct superclass for this role, as a subtitle is not a structural heading.
There is also a publishing case for identifying the subtitle text within a ranked heading (e.g., to differentiate when both title and subtitle are merged).
Helpful information that clarifies some aspect of the content or assists in its comprehension.
<aside role="dpub-tip> <h3>Tip</h3> <p>You can assign a variable a new value that is the result of an expression involving its previous value.</p> </aside>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB help [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
The primary name of a document component, such as a list, table or figure.
<figure> <img src="foo.jpg" alt="meaningful content"> <figcaption> <p role="dpub-title">Figure 1. A molecular diagram</p> <p>A covalent bond forms …</p> </figcaption> </figure>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB title [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
It is not clear if sectionhead is the correct superclass for this role, as a title is not a structural heading.
There is also a publishing case for identifying the title text within a ranked heading (e.g., to differentiate when both title and subtitle are merged).
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.
<nav role="dpub-toc"> <h1>Contents</h1> <ol> <li><a href="preface_001.xhtml">Original Transcriber’s Notes:</a></li> <li><a href="introduction_001.xhtml">ETYMOLOGY.</a></li> <li><a href="epigraph_001.xhtml">EXTRACTS (Supplied by a Sub-Sub-Librarian).</a></li> <li><a href="chapter_001.xhtml">Chapter 1. Loomings.</a></li> … </ol> </nav>
Characteristic | Value |
---|---|
Is Abstract: | |
Superclass Role: | |
Subclass Roles: | |
Base Concept: | |
Related Concepts: | EPUB toc [[EPUB-SSV]] |
Required Context Role: | |
Required Owned Elements: | |
Required States and Properties: | |
Supported States and Properties: | |
Inherited States and Properties: | |
Name From: | author |
Accessible Name Required: | False |
Inherits Name Required: | |
Children Presentational: | |
Inherits Presentational: | |
Implicit Value for Role: |
It may be desirable to provide information here about how e-book document formats and readers will incorporate and process the roles.
The HTML Working Group has incorporated the WAI-ARIA attributes into HTML 5. Official support for WAI-ARIA in HTML is provided in that specification.
Validation support for the roles defined in this module will be added once the specification reaches recommendation.
For information on incorporating WAI-ARIA into other grammars, refer to Appendix A of [[WAI-ARIA]]
Review whether any additional schemata are necessary for this module.
The following table provides a quick reference to the supported states and properties for all WAI-ARIA roles that may be used in markup.
In addition to the states and properties shown in the table, the following global states and properties are supported on all roles.
Placeholder for global states and properties
Placeholder for quick reference table
The following people contributed to the development of this document.
The group would like to thank all members of the DAISY and EPUB 3 working groups who developed the structural semantics vocabulary from which this module was drawn, with special thanks to Sanders Kleinfeld for his assistance analyzing the initial set of semantics for inclusion.
This publication has been funded in part with Federal funds from the U.S. Department of Education, National Institute on Disability, Independent Living, and Rehabilitation Research (NIDILRR) under contract number ED-OSE-10-C-0067. The content of this publication does not necessarily reflect the views or policies of the U.S. Department of Education, nor does mention of trade names, commercial products, or organizations imply endorsement by the U.S. Government.