Digital Publishing Accessibility API Mappings

Digital Publishing Accessibility API Mappings

W3C Recommendation  

This version:
https://www.w3.org/TR/2017/REC-dpub-aam-1.0-20171214/
Latest published version:
https://www.w3.org/TR/dpub-aam-1.0/
Latest editor's draft:
https://w3c.github.io/dpub-aam/
Implementation report:
https://w3c.github.io/test-results/dpub-aam/
Previous version:
https://www.w3.org/TR/2017/PR-dpub-aam-1.0-20171102/
Editors:
Richard Schwerdtfeger, Knowbility,
Joanmarie Diggs, Igalia, S.L.,

Please check the errata for any errors or issues reported since publication.

See also translations.

Copyright © 2015-2017 W3C® (MIT, ERCIM, Keio, Beihang). W3C liability, trademark and document use rules apply.

Abstract

The Digital Publishing Accessibility API Mappings (DPub-AAM) defines how user agents map the Digital Publishing WAI-ARIA Module [dpub-aria-1.0] markup to platform accessibility APIs. It is intended for user agent developers responsible for accessibility in their user agent so that they can support the accessibility content produced for digital publishing.

The implementation of this specification in user agents enables authors to produce more accessible e-books, by conveying structural book constructs used by the digital publishing industry to assistive technologies. It does this by extending the Core Accessibility API Mappings 1.1 (CORE-AAM) [core-aam-1.1] and the Accessible Name and Description: Computation and API Mappings 1.1 (ACCNAME-AAM) [accname-aam-1.1] specifications for user agents. It provides Accessibility API Mapping guidance for the roles defined in the Digital Publish WAI-ARIA Module.

The DPub-AAM is part of the WAI-ARIA suite described in the WAI-ARIA Overview.

Status of This Document

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 https://www.w3.org/TR/.

This is the DPub-AAM 1.0 W3C Recommendation by the Accessible Rich Internet Applications Working Group. The Working Group create a DPub-AAM 1.0 Implementation Report to demonstrate that the specification is implementable. A history of changes to Core-AAM 1.1 is available in the appendix.

To comment on this document, file an issue in the W3C dpub-aam GitHub repository. If this is not feasible, send email to public-aria@w3.org (comment archive). Comments received on the DPub-AAM 1.0 Recommendation cannot result in changes to this version of the specification, but may be addressed in errata or future versions of DPub-AAM. The Working Group may not make formal responses to comments but future work undertaken by the Working Group may address comments received on this document. In-progress updates to the document may be viewed in the publicly visible editors' draft.

This document was published by the Accessible Rich Internet Applications Working Group as a Recommendation.

Please see the Working Group's implementation report.

This document has been reviewed by W3C Members, by software developers, and by other W3C groups and interested parties, and is endorsed by the Director as a W3C Recommendation. It is a stable document and may be used as reference material or cited from another document. W3C's role in making the Recommendation is to draw attention to the specification and to promote its widespread deployment. This enhances the functionality and interoperability of the Web.

This document was produced by a group operating under the 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 March 2017 W3C Process Document.

1. Introduction §

This section is non-normative.

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.

The key words MAY, MUST, MUST NOT, OPTIONAL, RECOMMENDED, REQUIRED, SHALL, SHALL NOT, and SHOULD are to be interpreted as described in [RFC2119].

This specification indicates whether a section is normative or informative and the classification 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 user agents must follow for an implementation to conform to this specification. The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in Keywords for use in RFCs to indicate requirement levels [RFC2119]. RFC-2119 keywords are formatted in uppercase and contained in a strong element with class="rfc2119". When the keywords shown above are used, but do not share this format, they do not convey formal information in the RFC 2119 sense, and are merely explanatory, i.e., informative. As much as possible, such usages are avoided in 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.

3. Important Terms §

While some terms are defined in place, the following definitions are used throughout this document.

Accessibility API

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].

Accessible Description

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.

Accessible Name

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.

Assistive Technologies

Hardware and/or software that:

  • relies on services provided by a user agent to retrieve and render Web content
  • works with a user agent or web content itself through the use of APIs, and
  • provides services beyond those offered by the user agent to facilitate user interaction with web content by people with disabilities

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:

  • screen magnifiers, which are used to enlarge and improve the visual readability of rendered text and images;
  • screen readers, which are most-often used to convey information through synthesized speech or a refreshable Braille display;
  • text-to-speech software, which is used to convert text into synthetic speech;
  • speech recognition software, which is used to allow spoken control and dictation;
  • alternate input technologies (including head pointers, on-screen keyboards, single switches, and sip/puff devices), which are used to simulate the keyboard;
  • alternate pointing devices, which are used to simulate mouse pointing and clicking.
Attribute

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.

Class

A set of instance objects that share similar characteristics.

Element

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.

Event

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.

Informative

Content provided for information purposes and not required for conformance. Content required for conformance is referred to as normative.

Normative

Required for conformance. By contrast, content identified as informative or "non-normative" is not required for conformance.

Object

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.
Property

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.

Role

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.

Semantics

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.

State

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.

User Agent

Any software that retrieves, renders and facilitates end user interaction with Web content. This definition may differ from that used in other documents.

Widget

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).

4. Supporting Keyboard Navigation §

Enabling keyboard navigation in web applications is a necessary step toward making accessible web applications possible. Conforming user agents MUST conform to Supporting Keyboard Navigation requirements in [core-aam-1.1].

5. Mapping WAI-ARIA to Accessibility APIs §

5.1 General rules for exposing WAI-ARIA semantics §

This section MUST conform to General rules for exposing WAI-ARIA semantics in [core-aam-1.1].

6. Conflicts between native markup semantics and WAI-ARIA §

User agents MUST conform to Conflicts between native markup semantics and WAI-ARIA in [core-aam-1.1].

7. Exposing attributes that do not directly map to accessibility API properties §

User agents MUST conform to Exposing attributes that do not directly map to accessibility API properties in [core-aam-1.1].

8. Role mapping §

Platform accessibility APIs traditionally have had a finite set of predefined roles that are expected by assistive technologies on that platform and only one or two roles may be exposed. In contrast, WAI-ARIA allows multiple roles to be specified as an ordered set of space-separated valid role tokens. The additional roles are fallback roles similar to the concept of specifying multiple fonts in case the first choice font type is not supported.

8.1 General Rules §

User agents MUST conform to the Role Mapping General Rules accessibility API computational requirements in [core-aam-1.1].

8.2 Role Mapping Table §

Note

Translators: For label text associated with the following table and its toggle buttons, see the mappingTableLabels object in the <head> section of this document.

This section defines how WAI-ARIA digital publishing roles map to platform accessibility APIs. Elements having roles with a prefix value of doc-, that are not listed in this role mapping table, have no normative mappings.

Note

There are a number of roles mappings that are localized. The group needs to look into localizing for non-English languages.

Table describing mapping of WAI-ARIA roles to accessibility APIs.
WAI-ARIA Role MSAA + IAccessible2 Role + Other IAccessible2 Features UIA Control Type + Other Features ATK/AT-SPI Role AXAPI
doc-abstract Expose IAccessible2:
  • IA2_ROLE_SECTION
  • Object attribute xml-roles:doc-abstract.
  • Control Type is Text
  • Localized Control Type is 'abstract'

Expose ROLE_SECTION and object attribute xml-roles:doc-abstract.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-acknowledgments Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-acknowledgments.
  • Control Type is Text
  • Localized Control Type is 'acknowledgements'
  • Landmark Type is Custom
  • Localized Landmark Type is 'acknowledgements'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-acknowledgments.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-afterword Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-afterword.
  • Control Type is Text
  • Localized Control Type is 'afterword'
  • Landmark Type is Custom
  • Localized Landmark Type is 'afterword'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-afterword.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-appendix Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-appendix.
  • Control Type is Text
  • Localized Control Type is 'appendix'
  • Landmark Type is Custom
  • Localized Landmark Type is 'appendix'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-appendix.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-biblioentry Expose

ROLE_SYSTEM_LISTITEM + STATE_SYSTEM_READONLY

IAccessible2:

Object attribute xml-roles:doc-biblioentry.
  • Control Type is Text
  • Localized Control Type is 'biblioentry'

Expose ROLE_LIST_ITEM and object attribute xml-roles:doc-bilioentry.

 AXRole: AXGroup
AXSubrole: <nil>
AXRoleDescription: 'group'
doc-bibliography Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-bibliography.
  • Control Type is Text
  • Localized Control Type is 'bibliography'
  • Landmark Type is Custom
  • Localized Landmark Type is 'biblography'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-bibliography.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-biblioref Expose
  • ROLE_SYSTEM_LINK + STATE_LINKED
  • STATE_LINKED on all descendants

IAccessible2:

  • Object attribute xml-roles:doc-biblioref.
  • AccessibleHypertext interface
  • Control Type is Text
  • Localized Control Type is 'biblioref'

Expose ROLE_LINK and object attribute xml-roles:doc-biblioref.

AXRole: AXLink
AXSubrole: <nil>
AXRoleDescription: 'link'
doc-chapter Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-chapter.
  • Control Type is Text
  • Localized Control Type is 'chapter'
  • Landmark Type is Custom
  • Localized Landmark Type is 'chapter'

Expose ROLE_LANDMARK and object attribute xml-roles:chapter.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-colophon Expose

IA2_ROLE_SECTION

IAccessible2: Object attribute xml-roles:doc-colophon.

  • Control Type is Text
  • Localized Control Type is 'colophon'

Expose ROLE_SECTION and object attribute xml-roles:doc-colophon.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-conclusion Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-conclusion.
  • Control Type is Text
  • Localized Control Type is 'conclusion'
  • Landmark Type is Custom
  • Localized Landmark Type is 'conclusion'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-conclusion.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-cover Expose

ROLE_SYSTEM_GRAPHIC

IAccessible2: Object attribute xml-roles:doc-cover.

Control Type is Image

expose ROLE_IMAGE and object attribute xml-roles:doc-cover.

AXRole: AXImage
AXSubrole: <nil>
AXRoleDescription: 'image'
doc-credit Expose

IA2_ROLE_SECTION

IAccessible2:

Object attribute xml-roles:doc-credit
  • Control Type is Text
  • Localized Control Type is 'credit'

Expose ROLE_SECTION and object attribute xml-roles:doc-credit.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-credits Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-credits.
  • Control Type is Text
  • Localized Control Type is 'credits'
  • Landmark Type is Custom
  • Localized Landmark Type is 'credits'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-credits.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-dedication Expose

IA2_ROLE_SECTION

IAccessible2:

Object attribute xml-roles:doc-dedication
  • Control Type is Text
  • Localized Control Type is 'dedication'

Expose ROLE_SECTION and object attribute xml-roles:doc-dedication.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-endnote Expose

ROLE_SYSTEM_LISTITEM + STATE_SYSTEM_READONLY

IAccessible2:

Object attribute xml-roles:doc-endnote.
  • Control Type is Text
  • Localized Control Type is 'endnote'

Expose ROLE_LIST_ITEM and object attribute xml-roles:doc-endnote.

AXRole: AXGroup
AXSubrole: <nil>
AXRoleDescription: 'group'
doc-endnotes Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-endnotes.
  • Control Type is Text
  • Localized Control Type is 'endnotes'
  • Landmark Type is Custom
  • Localized Landmark Type is 'endnotes'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-endnotes.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-epigraph Expose

IA2_ROLE_SECTION

IAccessible2:

Object attribute xml-roles:doc-epigraph
  • Control Type is Text
  • Localized Control Type is 'epigraph'

Expose ROLE_SECTION and object attribute xml-roles:doc-epigraph.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-epilogue Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-epilogue.
  • Control Type is Text
  • Localized Control Type is 'epilogue'
  • Landmark Type is Custom
  • Localized Landmark Type is 'epilogue'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-epilogue.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-errata Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-errata
  • Control Type is Text
  • Localized Control Type is 'errata'
  • Landmark Type is Custom
  • Localized Landmark Type is 'errata'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-errata.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-example Expose

IA2_ROLE_SECTION

IAccessible2:

Object attribute xml-roles:doc-example
  • Control Type is Text
  • Localized Control Type is 'example'

Expose ROLE_SECTION and object attribute xml-roles:doc-example.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-footnote

Expose IAccessible2:

  • IA2_ROLE_FOOTNOTE
  • Object attribute: xml-roles:doc-footnote
  • Control Type is Text
  • Localized Control Type is 'footnote'

Expose ROLE_FOOTNOTE and object attribute xml-roles:doc-footnote.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-foreword Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-foreword
  • Control Type is Text
  • Localized Control Type is 'foreword'
  • Landmark Type is Custom
  • Localized Landmark Type is 'foreword'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-foreword.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-glossary Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-glossary
  • Control Type is Text
  • Localized Control Type is 'glossary'
  • Landmark Type is Custom
  • Localized Landmark Type is 'glossary'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-glossary.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-glossref Expose
  • ROLE_SYSTEM_LINK + STATE_LINKED
  • STATE_LINKED on all descendants

IAccessible2:

  • Object attribute xml-roles:doc-glossref.
  • AccessibleHypertext interface
  • Control Type is Text
  • Localized Control Type is 'glossref'

Expose ROLE_LINK and object attribute xml-roles:doc-glossref.

AXRole: AXLink
AXSubrole: <nil>
AXRoleDescription: 'link'
doc-index Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-index
  • Control Type is Text
  • Localized Control Type is 'index'
  • Landmark Type is Custom
  • Localized Landmark Type is 'index'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-index.

AXRole: AXGroup
AXSubrole: AXLandmarkNavigation
AXRoleDescription: 'navigation'
doc-introduction Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-introduction
  • Control Type is Text
  • Localized Control Type is 'introduction'
  • Landmark Type is Custom
  • Localized Landmark Type is 'introduction'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-introduction.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-noteref Expose
  • ROLE_SYSTEM_LINK + STATE_LINKED
  • STATE_LINKED on all descendants

IAccessible2:

  • Object attribute xml-roles:doc-noteref.
  • AccessibleHypertext interface
  • Control Type is Text
  • Localized Control Type is 'noteref'

Expose ROLE_LINK and object attribute xml-roles:doc-noteref.

AXRole: AXLink
AXSubrole: <nil>
AXRoleDescription: 'link'
doc-notice Expose

IA2_ROLE_NOTE

IAccessible2:

Object attribute xml-roles:doc-notice.
  • Control Type is Text
  • Localized Control Type is 'notice'

Expose ROLE_COMMENT and object attribute xml-roles:doc-notice.

 AXRole: AXGroup
AXSubrole: AXDocumentNote
AXRoleDescription: 'note'
doc-pagebreak Expose

ROLE_SYSTEM_SEPARATOR

IAccessible2:

Object attribute xml-roles:doc-pagebreak.
  • Control Type is Text
  • Localized Control Type is 'pagebreak'

Expose ROLE_SEPARATOR and object attribute xml-roles:doc-pagebreak.

AXRole: AXSplitter
AXSubrole: <nil>
AXRoleDescription: 'splitter'
doc-pagelist Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-pagelist
  • Control Type is Text
  • Localized Control Type is 'pagelist'
  • Landmark Type is Custom
  • Localized Landmark Type is 'pagelist'
 Expose

ROLE_LANDMARK and object attribute xml-roles:doc-pagelist.

AXRole: AXGroup
AXSubrole: AXLandmarkNavigation
AXRoleDescription: 'navigation'
doc-part Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-part
  • Control Type is Text
  • Localized Control Type is 'part'
  • Landmark Type is Custom
  • Localized Landmark Type is 'part'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-part.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-preface Expose IAccessible2:
  • IA2_ROLE_LANDMARKi
  • Object attribute xml-roles:doc-preface
  • Control Type is Text
  • Localized Control Type is 'preface'
  • Landmark Type is Custom
  • Localized Landmark Type is 'preface'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-pagebreak.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-prologue Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-prologue
  • Control Type is Text
  • Localized Control Type is 'prologue'
  • Landmark Type is Custom
  • Localized Landmark Type is 'prologue'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-prologue.

AXRole: AXGroup
AXSubrole: AXLandmarkRegion
AXRoleDescription: 'region'
doc-pullquote Expose IAccessible2:
  • IA2_ROLE_SECTION
  • Object attribute xml-roles:doc-pullquote
  • Control Type is Text
  • Localized Control Type is 'pullquote'

Expose ROLE_SECTION and object attribute xml-roles:doc-pullquote.

 AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-qna Expose

IA2_ROLE_SECTION

IAccessible2:

Object attribute xml-roles:doc-qna
  • Control Type is Text
  • Localized Control Type is 'qna'

Expose ROLE_SECTION and object attribute xml-roles:doc-qna.

AXRole: AXGroup
AXSubrole: AXApplicationGroup
AXRoleDescription: 'group'
doc-subtitle Expose IAccessible2:
  • IA2_ROLE_HEADING
  • Object attribute xml-roles:doc-subtitle
  • Control Type is Text
  • Localized Control Type is 'subtitle'

Expose ROLE_HEADING and object attribute xml-roles:doc-subtitle.

AXRole: AXHeading
AXSubrole: <nil>
AXRoleDescription: 'heading'
doc-tip Expose

IA2_ROLE_NOTE

IAccessible2:

Object attribute xml-roles:doc-tip
  • Control Type is Text
  • Localized Control Type is 'tip'

Expose ROLE_COMMENT and object attribute xml-roles:doc-tip.

AXRole: AXGroup
AXSubrole: AXDocumentNote
AXRoleDescription: 'note'
doc-toc Expose IAccessible2:
  • IA2_ROLE_LANDMARK
  • Object attribute xml-roles:doc-toc
  • Control Type is Text
  • Localized Control Type is 'toc'
  • Landmark Type is Custom
  • Localized Landmark Type is 'toc'

Expose ROLE_LANDMARK and object attribute xml-roles:doc-toc.

 AXRole: AXGroup
AXSubrole: AXLandmarkNavigation
AXRoleDescription: 'navigation'
Note

[Note 2] This specification does not currently contain guidance for when user agents should fire system alert events. Some guidance may be added to the specification at a later date but it will be a recommendation (should), not a requirement (must).

9. State and Property Mapping §

This section describes how to expose WAI-ARIA states and object properties. User agents MUST conform to the State and Property Mapping accessibility API computational requirements in [core-aam-1.1].

10. Special Processing Requiring Additional Computation §

10.1 Name and Description §

When computing an accessible name or accessible description, user agents MUST conform to the section titled Text Alternative Computation of the [accname-aam-1.1] specification.

10.2 Widget Values §

User agents MUST conform to the Widget Values accessibility API computational requirements in [core-aam-1.1].

10.3 Relations §

User agents MUST conform to the Relation accessibility API computational requirements in [core-aam-1.1].

10.4 Group Position §

User agents MUST conform to the Group Position accessibility API computational requirements in [core-aam-1.1].

11. Actions §

User agents MUST conform to the Actions accessibility API computational requirements in [core-aam-1.1].

12. Events §

User agents fire events for user actions, WAI-ARIA state changes, changes to document content or node visibility, changes in selection, and operation of menus. Conforming user agents MUST support the [core-aam-1.1] Events mappings.

13. Special Document Handling Procedures §

User agents MUST conform to the Special Document Handling Procedures in [core-aam-1.1].

A. Appendices §

A.1 Substantive changes since the last public working draft §

A.2 Acknowledgments §

This section is non-normative.

The following people contributed to the development of this document.

A.2.1 Participants active in the DPUB-ARIA task force at the time of publication §

  • Michael Cooper (W3C Staff)
  • Heather Flanagan (Invited expert)
  • Matt Garrish (DAISY Consortium)
  • Markus Gylling (DAISY Consortium)
  • Ivan Herman (W3C Staff)
  • Deborah Kaplan (Invited expert)
  • George Kerscher (DAISY Consortium)
  • Peter Krautzberger (W3C Invited Experts)
  • Charles LaPierre (Benetech)
  • Shane McCarron (W3C Invited Experts)
  • Janina Sajka (Invited Expert, The Linux Foundation)
  • Richard Schwerdtfeger (Knowbility)
  • Tzviya Siegman (Wiley)

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.

A.2.2 Enabling funders §

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.

B. References §

B.1 Normative references §

[core-aam-1.1]
Core Accessibility API Mappings 1.1. Joanmarie Diggs; Joseph Scheuhammer; Richard Schwerdtfeger; Michael Cooper; Andi Snow-Weaver; Aaron Leventhal. W3C. 14 December 2017. W3C Recommendation. URL: https://www.w3.org/TR/core-aam-1.1/
[dpub-aria-1.0]
Digital Publishing WAI-ARIA Module 1.0. Matt Garrish; Tzviya Siegman; Markus Gylling; Shane McCarron. W3C. 14 December 2017. W3C Recommendation. URL: https://www.w3.org/TR/dpub-aria-1.0/
[RFC2119]
Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

B.2 Informative references §

[accname-aam-1.1]
Accessible Name and Description: Computation and API Mappings 1.1. Joseph Scheuhammer; James Craig; Andi Snow-Weaver; Aaron Leventhal. W3C. 17 March 2016. W3C Working Draft. URL: https://www.w3.org/TR/accname-aam-1.1/
[AT-SPI]
Assistive Technology Service Provider Interface. The GNOME Project. URL: https://developer.gnome.org/libatspi/stable/
[ATK]
ATK - Accessibility Toolkit. The GNOME Project. URL: https://developer.gnome.org/atk/stable/
[AXAPI]
The NSAccessibility Protocol for macOS. Apple, Inc. URL: https://developer.apple.com/documentation/appkit/nsaccessibility
[IAccessible2]
IAccessible2. Linux Foundation. URL: https://www.linuxfoundation.org/collaborate/workgroups/accessibility/iaccessible2
[MSAA]
Microsoft Active Accessibility (MSAA) 2.0. Microsoft Corporation. URL: https://msdn.microsoft.com/en-us/library/ms697707.aspx
[UI-AUTOMATION]
UI Automation. Microsoft Corporation. URL: https://msdn.microsoft.com/en-us/library/ee684009%28v=vs.85%29.aspx
[UIA-EXPRESS]
The IAccessibleEx Interface. Microsoft Corporation. URL: https://msdn.microsoft.com/en-us/library/windows/desktop/dd561898%28v=vs.85%29.aspx
[WCAG20]
Web Content Accessibility Guidelines (WCAG) 2.0. Ben Caldwell; Michael Cooper; Loretta Guarino Reid; Gregg Vanderheiden et al. W3C. 11 December 2008. W3C Recommendation. URL: https://www.w3.org/TR/WCAG20/