Copyright © 2015 W3C® (MIT, ERCIM, Keio, Beihang). W3C liability, trademark and document use rules apply.
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 section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.
This is a First Public Working Draft of Digital Publishing WAI-ARIA Module 1.0 by the Digital Publishing ARIA Taskforce, a joint task force of the Protocols and Formats Working Group and the Digital Publishing Interest Group. It is a module that extends WAI-ARIA 1.1 [WAI-ARIA] to define roles specific to the needs of digital e-book publications. These roles add semantics to describe features common to digital publications that are not provided by base languages like HTML, to facilitate automated processing and accessibility support.
Feedback on any aspect of the specification is accepted. For this publication, the Digital Publishing ARIA Task Force particularly seeks feedback on the following questions:
To comment, file an issue in the W3C ARIA GitHub repository, using the "dpub" label in the issue. If this is not feasible, send email to public-dpub-aria-comments@w3.org (comment archive). Comments are requested by 11 September 2015. In-progress updates to the document may be viewed in the publicly visible editors' draft.
Publication as a First Public Working Draft does not imply endorsement by the W3C Membership. 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.
This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
This document is governed by the 1 August 2014 W3C Process Document.
This section is non-normative.
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 heading role on 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].
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.
The key words MUST and SHOULD are to be interpreted as described in [RFC2119].
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 is non-normative.
While some terms are defined in place, the following definitions are used throughout this document.
Operating systems and other platforms provide a set of interfaces that expose information about objects and events to assistive technologies. Assistive technologies use these interfaces to get information about and interact with those widgets. Examples of accessibility APIs are Microsoft Active Accessibility [MSAA], Microsoft User Interface Automation [UI-AUTOMATION], MSAA with UIA Express [UIA-EXPRESS], the Mac OS X Accessibility Protocol [AXAPI], the Linux/Unix Accessibility Toolkit [ATK] and Assistive Technology Service Provider Interface [AT-SPI], and IAccessible2 [IAccessible2].
Tree of accessible objects that represents the structure of the user interface (UI). Each node in the accessibility tree represents an element in the UI as exposed through the accessibility API; for example, a push button, a check box, or container.
An accessible description provides additional information, related to an interface element, that complements the accessible name. The accessible description might or might not be visually perceivable.
The accessible name is the name of a user interface element. Each platform accessibility API provides the accessible name property. The value of the accessible name may be derived from a visible (e.g., the visible text on a button) or invisible (e.g., the text alternative that describes an icon) property of the user interface element. See related accessible description.
A simple use for the accessible name property may be illustrated by an "OK" button. The text "OK" is the accessible name. When the button receives focus, assistive technologies may concatenate the platform's role description with the accessible name. For example, a screen reader may speak "push-button OK" or "OK button". The order of concatenation and specifics of the role description (e.g., "button", "push-button", "clickable button") are determined by platform accessibility APIs or assistive technologies.
A node in the accessibility tree of a platform accessibility API. Accessible objects expose various states, properties, and events for use by assistive technologies. In the context of markup languages (e.g., HTML and SVG) in general, and of WAI-ARIA in particular, markup elements and their attributes are represented as accessible objects.
Hardware and/or software that:
This definition may differ from that used in other documents.
Examples of assistive technologies that are important in the context of this document include the following:
In this specification, attribute is used as it is in markup languages. Attributes are structural features added to elements to provide information about the states and properties of the object represented by the element.
A set of instance objects that share similar characteristics.
In this specification, element is used as it is in markup languages. Elements are the structural elements in markup language that contains the data profile for objects.
A programmatic message used to communicate discrete changes in the state of an object to other objects in a computational system. User input to a web page is commonly mediated through abstract events that describe the interaction and can provide notice of changes to the state of a document object. In some programming languages, events are more commonly known as notifications.
Content provided for information purposes and not required for conformance. Content required for conformance is referred to as normative.
Accessible to the user using a keyboard or assistive technologies that mimic keyboard input, such as a sip and puff tube. References in this document relate to WCAG 2.0 Guideline 2.1: Make all functionality available from a keyboard [WCAG20].
Basic type of object in the DOM tree or accessibility tree. DOM nodes are further specified as Element or Text nodes, among other types. The nodes of an accessibility tree are accessible objects.
Required for conformance. By contrast, content identified as informative or "non-normative" is not required for conformance.
In the context of user interfaces, an item in the perceptual user experience, represented in markup languages by one or more elements, and rendered by user agents.
In the context of programming, the instantiation of one or more classes and interfaces which define the general characteristics of similar objects. An object in an accessibility API may represent one or more DOM objects. Accessibility APIs have defined interfaces that are distinct from DOM interfaces.A description of the characteristics of classes and how they relate to each other.
Presentable to users in ways they can sense. References in this document relate to WCAG 2.0 Principle 1: Content must be perceivable [WCAG20].
Attributes that are essential to the nature of a given object, or that represent a data value associated with the object. A change of a property may significantly impact the meaning or presentation of an object. Certain properties (for example, aria-multiline) are less likely to change than states, but note that the frequency of change difference is not a rule. A few properties, such as aria-activedescendant, aria-valuenow, and aria-valuetext are expected to change often. See clarification of states versus properties.
Main indicator of type. This semantic association allows tools to present and support interaction with the object in a manner that is consistent with user expectations about other objects of that type.
The meaning of something as understood by a human, defined in a way that computers can process a representation of an object, such as elements and attributes, and reliably represent the object in a way that various humans will achieve a mutually consistent understanding of the object.
A state is a dynamic property expressing characteristics of an object that may change in response to user action or automated processes. States do not affect the essential nature of the object, but represent data associated with the object or user interaction possibilities. See clarification of states versus properties.
A hierarchical definition of how the characteristics of various classes relate to each other, in which classes inherit the properties of superclasses in the hierarchy. A taxonomy can comprise part of the formal definition of an ontology.
Type of DOM node that represents the textual content of an attribute or an element. A Text node has no child nodes.
Any software that retrieves, renders and facilitates end user interaction with Web content. This definition may differ from that used in other documents.
Discrete user interface object with which the user can interact. Widgets range from simple objects that have one value or operation (e.g., check boxes and menu items), to complex objects that contain many managed sub-objects (e.g., trees and grids).
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.
dpub-abstract (role)§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 |
|---|---|
| Superclass Role: | region |
| Related Concepts: | EPUB abstract [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-afterword (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB afterword [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-appendix (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB appendix [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-biblioentry (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 |
|---|---|
| Superclass Role: | listitem |
| Related Concepts: | EPUB biblioentry [EPUB-SSV] |
| Required Context Role: | dpub-bibliography |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | True |
dpub-bibliography (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 |
|---|---|
| Superclass Role: | |
| Related Concepts: | EPUB bibliography [EPUB-SSV] |
| Required Owned Elements: | dpub-biblioentry |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-biblioref (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 |
|---|---|
| Superclass Role: | link |
| Related Concepts: | EPUB biblioref [EPUB-SSV] |
| Inherited States and Properties: | |
| Name From: | author content |
| Accessible Name Required: | True |
dpub-chapter (role)§A major thematic section of content in a work.
<body role="dpub-chapter"> <h1>Chapter 1. Loomings.</h1> … </body>
| Characteristic | Value |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB chapter [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-cover (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 |
|---|---|
| Superclass Role: | none |
| Related Concepts: | EPUB cover [EPUB-SSV] |
| Name From: | author |
| Accessible Name Required: | False |
dpub-epilogue (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB epilogue [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-footnote (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 |
|---|---|
| Superclass Role: | section |
| Related Concepts: | EPUB footnote [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
dpub-footnotes (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB footnotes [EPUB-SSV] |
| Required Owned Elements: | dpub-footnote |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-foreword (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB foreword [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-glossary (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB glossary [EPUB-SSV] |
| Required Owned Elements: | dpub-glossdef, dpub-glossterm |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
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?
dpub-glossdef (role)§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 |
|---|---|
| Superclass Role: | definition |
| Related Concepts: | EPUB glossdef [EPUB-SSV] |
| Required Context Role: | dpub-glossary |
| Inherited States and Properties: |
|
| Name From: | author |
dpub-glossref (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 |
|---|---|
| Superclass Role: | link |
| Related Concepts: | EPUB glossref [EPUB-SSV] |
| Inherited States and Properties: | |
| Name From: | author content |
| Accessible Name Required: | True |
We dont say that the the glossref links necessarily be activatable (at all times or at all); is inheriting from role=link still ok?
dpub-glossterm (role)§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 |
|---|---|
| Superclass Role: | term (cf. issue 657) |
| Related Concepts: | EPUB glossterm [EPUB-SSV] |
| Required Context Role: | dpub-glossary |
| Name From: | content |
dpub-index (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 |
|---|---|
| Superclass Role: | |
| Related Concepts: | EPUB index [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-locator (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 |
|---|---|
| Superclass Role: | link |
| Related Concepts: | EPUB referrer [EPUB-SSV] |
| Inherited States and Properties: | |
| Name From: | author content |
| Accessible Name Required: | True |
dpub-noteref (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 |
|---|---|
| Superclass Role: | link |
| Related Concepts: | EPUB noteref [EPUB-SSV] |
| Inherited States and Properties: | |
| Name From: | author content |
| Accessible Name Required: | True |
dpub-notice (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 |
|---|---|
| Superclass Role: | region |
| Related Concepts: | EPUB notice [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-pagebreak (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 |
|---|---|
| Superclass Role: | separator |
| Related Concepts: | EPUB pagebreak [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | content |
| Accessible Name Required: | True |
| Children Presentational: | True |
dpub-pagelist (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 |
|---|---|
| Superclass Role: | navigation |
| Related Concepts: | EPUB page-list [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-part (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 |
|---|---|
| Superclass Role: | section |
| Related Concepts: | EPUB part [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | True |
dpub-preface (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB preface [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-prologue (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 |
|---|---|
| Superclass Role: | landmark |
| Related Concepts: | EPUB prologue [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-pullquote (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 |
|---|---|
| Superclass Role: | none |
| Related Concepts: | EPUB pullquote [EPUB-SSV] |
| Name From: | author |
| Accessible Name Required: | False |
dpub-qna (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 |
|---|---|
| Superclass Role: | region |
| Related Concepts: | EPUB qna [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-subtitle (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 |
|---|---|
| Superclass Role: | sectionhead |
| Related Concepts: | EPUB subtitle [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
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).
dpub-tip (role)§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 |
|---|---|
| Superclass Role: | note |
| Related Concepts: | EPUB help [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
dpub-title (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 |
|---|---|
| Superclass Role: | sectionhead |
| Related Concepts: | EPUB title [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
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).
dpub-toc (role)§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 |
|---|---|
| Superclass Role: | navigation |
| Related Concepts: | EPUB toc [EPUB-SSV] |
| Inherited States and Properties: |
|
| Name From: | author |
| Accessible Name Required: | False |
It may be desirable to provide information here about how e-book document formats and readers will incorporate and process the roles.
This section is non-normative.
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.
This section is non-normative.
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
This section is non-normative.
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.