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 application programming interfaces (APIs). It is intended for e-book 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 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] and the Accessible Name and Description: Computation and API Mappings 1.1 (ACCNAME-AAM) [ACCNAME-AAM] 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 http://www.w3.org/TR/.

This document was published by the Protocols and Formats Working Group as an Editor's Draft. If you wish to make comments regarding this document, please send them to public-pfwg-comments@w3.org (subscribe, archives). All comments are welcome.

Publication as an Editor's 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 September 2015 W3C Process Document.

Table of Contents §

1. Introduction §

This section is non-normative.

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.

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

Accessibility Subtree

An accessible object in the accessibility tree and its descendants in that tree. It does not include objects which have relationships other than parent-child in that tree. For example, it does not include objects linked via aria-flowto unless those objects are also descendants in the accessibility tree.

Accessibility Tree

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.

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.

Accessible object

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.

Activation behavior

The action taken when an event, typically initiated by users through an input device, causes an element to fulfill a defined role. The role may be defined for that element by the host language, or by author-defined variables, or both. The role for any given element may be a generic action, or may be unique to that element. For example, the activation behavior of an HTML or SVG <a> element shall be to cause the user agent to traverse the link specified in the href attribute, with the further optional parameter of specifying the browsing context for the traversal (such as the current window or tab, a named window, or a new window); the activation behavior of an HTML <input> element with the type attribute value submit shall be to send the values of the form elements to an author-defined IRI by the author-defined HTTP method.

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.

Desktop focus event

Event from/to the host operating system via the accessibility API, notifying of a change of input focus.

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.

Expose

Translated to platform-specific accessibility APIs as defined in the WAI-ARIA User Agent Implementation Guide. [WAI-ARIA-IMPLEMENTATION]

Graphical Document

A document containing graphic representations with user-navigable parts. Charts, maps, diagrams, blueprints, and dashboards are examples of graphical documents. A graphical document is composed using any combination of symbols, images, text, and graphic primitives (shapes such as circles, points, lines, paths, rectangles, etc).

Hidden

Indicates that the element is not visible or perceivable to any user. An element is considered hidden if it or any one of its ancestor elements is not rendered or explicitly hidden.

Informative

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

Keyboard Accessible

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

Landmark

A type of region on a page to which the user may want quick access. Content in such a region is different from that of other regions on the page and relevant to a specific user purpose, such as navigating, searching, perusing the primary content, etc.

Live Region

Live regions are perceivable regions of a web page that are typically updated as a result of an external event when user focus may be elsewhere. These regions are not always updated as result of a user interaction. This practice has become commonplace with the growing use of Ajax. Examples of live regions include a chat log, stock ticker, or a sport scoring section that updates periodically to reflect game statistics. Since these asynchronous areas are expected to update outside the user's area of focus, assistive technologies such as screen readers have either been unaware of their existence or unable to process them for the user. WAI-ARIA has provided a collection of properties that allow the author to identify these live regions and how to process them: aria-live, aria-relevant, aria-atomic, and aria-busy. Pre-defined live region roles are listed in the Choosing Between Special Case Live Regions ([WAI-ARIA-PRACTICES], Section 5.3).

Primary Content Element

An implementing host language's primary content element, such as the body element in HTML.

Managed State

Accessibility API state that is controlled by the user agent, such as focus and selection. These are contrasted with "unmanaged states" that are typically controlled by the author. Nevertheless, authors can override some managed states, such as aria-posinset and aria-setsize. Many managed states have corresponding CSS pseudo-classes, such as :focus, and pseudo-elements, such as ::selection, that are also updated by the user agent.

Nemeth Braille

The Nemeth Braille Code for Mathematics is a braille code for encoding mathematical and scientific notation. See Nemeth Braille on Wikipedia.

Node

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.

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

A description of the characteristics of classes and how they relate to each other.

Operable

Usable by users in ways they can control. References in this document relate to WCAG 2.0 Principle 2: Content must be operable [WCAG20]. See Keyboard Accessible.

Owned Element

An 'owned element' is any DOM descendant of the element, any element specified as a child via aria-owns, or any DOM descendant of the owned child.

Owning Element

An 'owning element' is any DOM ancestor of the element, or any element with an aria-owns attribute which references the ID of the element.

Perceivable

Presentable to users in ways they can sense. References in this document relate to WCAG 2.0 Principle 1: Content must be perceivable [WCAG20].

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.

Relationship

A connection between two distinct things. Relationships may be of various types to indicate which object labels another, controls another, etc.

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.

Root WAI-ARIA node

The primary element containing non-metadata content. In many languages, this is the document element but in HTML, it is the <body>.

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.

Sub-document

Any document created from a <frame>, <iframe> or similar mechanism. A sub-document may contain a document, an application or any widget such as a calendar pulled in from another server. In the accessibility tree there are two accessible objects for this situation—one represents the <frame>/<iframe> element in the parent document, which parents a single accessible object child representing the spawned document contents.

Target Element

An element specified in a WAI-ARIA relation. For example, in <div aria-controls=”elem1”>, where “elem1” is the ID for the target element.

Taxonomy

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.

Text node

Type of DOM node that represents the textual content of an attribute or an element. A Text node has no child nodes.

Understandable

Presentable to users in ways they can construct an appropriate meaning. References in this document relate to WCAG 2.0 Principle 3: Information and the operation of user interface must be understandable [WCAG20].

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.

Valid IDREF

A reference to a target element in the same document that has a matching ID

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

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

4. Mapping WAI-ARIA to Accessibility APIs §

4.1 General rules for exposing WAI-ARIA semantics §

This section MUST conform to General rules for exposing WAI-ARIA semantics in [CORE-AAM].

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

User agents MUST conform to Conflicts between native markup semantics and WAI-ARIA in [CORE-AAM].

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

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

7.1 General Rules §

User agents MUST conform to the Role Mapping General Rules accessibility API computational requirements in [CORE-AAM].

7.2 Role Mapping Table §

Editor's 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 roles in digital publishing map to platform accessibility APIs based on their native host language semantics and when WAI-ARIA roles are applied. This section refers directly to the Core Accessibility API Mappings specification.

Editor's Note

It is unclear whether the roles: doc-glossref, doc-biblioref, doc-locator, doc-noteref will all stay in the specification as these are all forms of links. One possible solution is to use @rel however that does not exist in SVG and currently thre are no platform accessibility API mappings for @rel. Additionally the cognitive accssibility task force has a need to add semantics to links as well. Consequently, the existing of these roles and/or their accessibility API mappings is still an issue to be addressed.

Editor's Note

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

Editor's Note

There are a number of Mac OSX subroles that need to be addressed and they are currently marked as TBD.

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[Note 1]
doc-abstract

ROLE_SYSTEM_GROUPING

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

  • Expose as text string 'doc-abstract' in AriaRole.
  • Control type/role is 'abstract'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'abstract'
doc-acknowledgments

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

  • Expose as text string 'doc-acknowledgments' in AriaRole.
  • Control type/role is 'acknowledgements'

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'acknolwedgements'
doc-afterword

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

  • Expose as text string 'doc-afterword' in AriaRole.
  • Control type/role is 'afterword'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'afterword'
doc-appendix

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

  • Expose as text string 'doc-appendix' in AriaRole.
  • Control type/role is 'appendix'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'appendix'
doc-biblioentry

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

  • Expose as text string 'doc-biblioentry' in AriaRole.
  • Control type/role is 'bibliography entry'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'bibliography entry'
doc-bibliography

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

  • Expose as text string 'doc-bibliography' in AriaRole.
  • Control type/role is 'bibliography'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'bibliography'
doc-biblioref

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

ROLE_SYSTEM_LINK + STATE_LINKED

Also, expose STATE_LINKED on all descendants

IAccessible2: Use AccessibleHypertext interface
  • Expose as text string 'doc-biblioref' in AriaRole.
  • Control type/role is 'bibliography references'.

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

AXRole: AXLink
AXSubrole: nil
AXRoleDescription: 'bibliography reference'
doc-chapter

IAccessible2: Object attribute xml-roles:chapter.

  • Expose as text string 'doc-chapter' in AriaRole.
  • Control type/role is 'chapter'.

Expose ROLE_LANDMARK and object attribute xml-roles:chapter.

AXRole: AXGroup
d AXSubrole: ? TBD
AXRoleDescription: 'chapter'
doc-colophon

ROLE_SYSTEM_GROUPING

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

  • Expose as text string 'doc-colophon' in AriaRole.
  • Control type/role is 'colophon'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'colophon'
doc-conclusion

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

  • Expose as text string 'doc-conclusion' in AriaRole.
  • Control type/role is 'conclusion'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'conclusion'
doc-cover

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

  • Expose as text string 'doc-cover' in AriaRole.
  • Control type/role is 'cover'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'cover'
doc-credit

ROLE_SYSTEM_GROUPING

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

  • Expose as text string 'doc-credit' in AriaRole.
  • Control type/role is 'credit'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'credit'
doc-cover

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

  • Expose as text string 'doc-credits' in AriaRole.
  • Control type/role is 'credits'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'credits'
doc-dedication

ROLE_SYSTEM_GROUPING

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

  • Expose as text string 'doc-dedication' in AriaRole.
  • Control type/role is 'dedication'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'dedication'
doc-epigraph

ROLE_SYSTEM_GROUPING

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

  • Expose as text string 'doc-epigraph' in AriaRole.
  • Control type/role is 'epigraph'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'epigraph'
doc-epilogue

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

  • Expose as text string 'doc-epilogue' in AriaRole.
  • Control type/role is 'epilogue'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'epilogue'
doc-errata

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

  • Expose as text string 'doc-errata' in AriaRole.
  • Control type/role is 'errata'. Localized Control Type is based on AriaRole.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'errata'
doc-example

ROLE_SYSTEM_GROUPING

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

  • Expose as text string 'doc-example' in AriaRole.
  • Control type/role is 'example'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'example'
doc-footnote

ROLE_SYSTEM_GROUPING

IA2_ROLE_FOOTNOTE
  • Expose as text string 'doc-footnote' in AriaRole.
  • Control type/role is 'footnote'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'footnote'
doc-footnotes

IAccessible2: Object attribute xml-roles:doc-footnotes.
  • Expose as text string 'doc-footnotes' in AriaRole.
  • Control type/role is 'footnotes'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'footnotes'
doc-foreward

IAccessible2: Object attribute xml-roles:doc-foreward.
  • Expose as text string 'doc-foreward' in AriaRole.
  • Control type/role is 'foreward'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'foreward'
doc-glossary

IAccessible2: Object attribute xml-roles:doc-glossary.
  • Expose as text string 'glossary' in AriaRole.
  • Control type/role is 'glossary'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'glossary'
doc-glossref

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

ROLE_SYSTEM_LINK + STATE_LINKED

Also, expose STATE_LINKED on all descendants

IAccessible2: Use AccessibleHypertext interface
  • Expose as text string 'doc-glossref' in AriaRole.
  • Control type/role is 'glossary reference'.

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

AXRole: AXLink
AXSubrole: nil
AXRoleDescription: 'glossary reference'
doc-index

IAccessible2: Object attribute xml-roles:doc-index.
  • Expose as text string 'doc-index' in AriaRole.
  • Control type/role is 'index'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'index'
doc-introduction

IAccessible2: Object attribute xml-roles:doc-indroduction.
  • Expose as text string 'doc-introduction' in AriaRole.
  • Control type/role is 'introduction'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'introduction'
doc-locator

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

ROLE_SYSTEM_LINK + STATE_LINKED

Also, expose STATE_LINKED on all descendants

IAccessible2: Use AccessibleHypertext interface
  • Expose as text string 'doc-locator' in AriaRole.
  • Control type/role is 'locator HyperLink'.

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

AXRole: AXLink
AXSubrole: nil
AXRoleDescription: 'backward reference'
doc-noteref

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

ROLE_SYSTEM_LINK + STATE_LINKED

Also, expose STATE_LINKED on all descendants

IAccessible2: Use AccessibleHypertext interface
  • Expose as text string 'doc-noteref' in AriaRole.
  • Control type/role is 'note reference'.

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

AXRole: AXLink
AXSubrole: nil
AXRoleDescription: 'note reference'
doc-notice

IAccessible2: Object attribute xml-roles:doc-notice.
  • Expose as text string 'doc-notice' in AriaRole.
  • Control type/role is 'notice'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'notice'
doc-pagebreak

IAccessible2: Object attribute xml-roles:doc-pagebreak.
  • Expose as text string 'doc-pagebreak' in AriaRole.
  • Control type/role is 'pagebreak'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'page break'
doc-pagelist

IAccessible2: Object attribute xml-roles:navigation.
  • Expose as text string 'doc-pagelist' in AriaRole.
  • Control type/role is 'page list'.

Expose ROLE_LANDMARK and object attribute xml-roles:navigation.

AXRole: AXGroup
AXSubrole: ? AXLandmarkNavigation
AXRoleDescription: 'page list'
doc-part

IAccessible2: Object attribute xml-roles:doc-part.
  • Expose as text string 'doc-part' in AriaRole.
  • Control type/role is 'part'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'part'
doc-preface

IAccessible2: Object attribute xml-roles:doc-preface.
  • Expose as text string 'doc-preface' in AriaRole.
  • Control type/role is preface.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'preface'
doc-preface

IAccessible2: Object attribute xml-roles:doc-prologue.
  • Expose as text string 'doc-prologue' in AriaRole.
  • Control type/role is 'prologue'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'prologue'
doc-pullquote

IAccessible2: Object attribute xml-roles:doc-pullquote.
  • Expose as text string 'doc-pullquote' in AriaRole.
  • Control type/role is 'pullquote'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'pullquote'
doc-qna

ROLE_SYSTEM_GROUPING

IAccessible2: Object attribute xml-roles:doc-qna.
  • Expose as text string 'doc-qna' in AriaRole.
  • Control type/role is 'questions and answers'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'questions and answers'
doc-subtitle

IAccessible2: Object attribute xml-roles:doc-subtitle.
  • Expose as text string 'doc-subtitle' in AriaRole.
  • Control type/role is 'subtitle'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'subtitle'
doc-tip

IAccessible2: Object attribute xml-roles:doc-tip.
  • Expose as text string 'doc-tip' in AriaRole.
  • Control type/role is 'tip'.

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

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'tip'
doc-title

IAccessible2: Object attribute xml-roles:doc-title.
  • Expose as text string 'doc-title' in AriaRole.
  • Control type/role is 'title'.

Expose ROLE_PANEL and object attribute xml-roles:doc-title.

AXRole: AXGroup
AXSubrole: ? TBD
AXRoleDescription: 'title'
doc-toc Expose as navigation role as specified in the [CORE-AAM]. Expose as navigation role as specified in the [CORE-AAM]. Expose as navigation role as specified in the [CORE-AAM]. Expose as navigation role as specified in the [CORE-AAM].
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).

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

9. Special Processing Requiring Additional Computation §

9.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] specification with the following modifications for the host language:

  1. Replace step 2D with the following:
    Otherwise, if performing a text alternative computation for an accessible name and the current node's provides a descendant <title> element, return the title text alternative as a flat string, unless the element is marked as presentational (role="presentation" or role="none"). If performing a text alternative computation for an accessible description, and the current node provides a descendant <desc> return the description text alternative an accessible description computation attribute as presentational (role="presentation" or role="none").
  2. In step 2F skip step iii of Text Alternative Computation

9.2 Widget Values §

User agents MUST conform to the Widget Values accessibility API computational requirements in [CORE-AAM].

9.3 Relations §

User agents MUST conform to the Relation accessibility API computational requirements in [CORE-AAM].

9.4 Group Position §

User agents MUST conform to the Group Position accessibility API computational requirements in [CORE-AAM].

10. Actions §

User agents MUST conform to the Actions accessibility API computational requirements in [CORE-AAM].

11. 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] Events mappings.

12. Special Document Handling Procedures §

User agents MUST conform to the Special Document Handling Procedures in [CORE-AAM].

A. Appendices §

A.1 References §

This section is informative.

Placeholder for references

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 PFWG at the time of publication §

  • Michiel Bijl (Invited Expert)
  • Christy Blew (University of Illinois at Urbana-Champaign)
  • David Bolter (Mozilla Foundation)
  • Michael Cooper (W3C/MIT)
  • James Craig (Apple Inc.)
  • Joanmarie Diggs (Igalia)
  • Fred Esch (IBM Corporation)
  • Steve Faulkner (The Paciello Group)
  • John Foliot (Invited Expert)
  • Bryan Garaventa (SSB BART Group)
  • Matt Garrish (DAISY Consortium)
  • Billy Gregory (The Paciello Group)
  • Karl Groves (The Paciello Group)
  • Jon Gunderson (University of Illinois at Urbana-Champaign)
  • Markus Gylling (DAISY Consortium)
  • Markku Hakkinen (Educational Testing Service)
  • Katie Haritos-Shea (Knowbility)
  • Susann Keohane (IBM Corporation)
  • Matthew King (Facebook)
  • Jason Kiss (Department of Internal Affairs, New Zealand Government)
  • Jamie Knight (British Broadcasting Corporation)
  • JaEun Jemma Ku (University of Illinois at Urbana-Champaign)
  • Shane McCarron (Invited Expert, Aptest)
  • Charles McCathie Nevile (Yandex)
  • Mary Jo Mueller (IBM Corporation)
  • James Nurthen (Oracle Corporation)
  • Ian Pouncey (The Paciello Group, LLC)
  • Mark Sadecki (Invited Expert)
  • Janina Sajka (Invited Expert, The Linux Foundation)
  • Joseph Scheuhammer (Invited Expert, Inclusive Design Research Centre, OCAD University)
  • Stefan Schnabel (SAP AG)
  • Richard Schwerdtfeger (IBM Corporation)
  • Lisa Seeman (Invited Expert)
  • Tzviya Siegman (Wiley)
  • Cynthia Shelly (Microsoft Corporation)
  • Alexander Surkov (Mozilla Foundation)
  • Léonie Watson (The Paciello Group)
  • Jason White (Educational Testing Service)
  • Gottfried Zimmermann (Invited Expert, Access Technologies Group)

A.2.2 Other ARIA contributors, commenters, and previously active PFWG participants §

  • Shadi Abou-Zahra (W3C)
  • Jim Allan (TSB)
  • Jonny Axelsson (Opera Software)
  • David Baron (Mozilla Foundation)
  • Art Barstow (Nokia Corporation)
  • Simon Bates
  • Chris Blouch (AOL)
  • Judy Brewer (W3C/MIT)
  • Mark Birbeck (Sidewinder Labs)
  • Sally Cain (Royal National Institute of Blind People (RNIB))
  • Gerardo Capiel (Benetech)
  • Ben Caldwell (Trace)
  • Sofia Celic-Li
  • Jaesik Chang (Samsung Electronics Co., Ltd.)
  • Alex Qiang Chen (University of Manchester)
  • Charles Chen (Google, Inc.)
  • Christian Cohrs
  • Deborah Dahl
  • Erik Dahlström (Opera Software)
  • Dimitar Denev (Frauenhofer Gesellschaft)
  • Micah Dubinko (Invited Expert)
  • Mandana Eibegger
  • Beth Epperson (Websense)
  • Donald Evans (AOL)
  • Chris Fleizach (Apple Inc.)
  • Kelly Ford (Microsoft Corporation)
  • Geoff Freed (Invited Expert, NCAM)
  • Christopher Gallelo (Microsoft Corporation)
  • Birkir Gunnarsson (Deque Systems, Inc.)
  • Kentarou Fukuda (IBM Corporation)
  • Bryan Garaventa
  • Guido Geloso
  • Ali Ghassemi
  • Becky Gibson (IBM)
  • Alfred S. Gilman
  • Andres Gonzalez (Adobe Systems Inc.)
  • Scott González (JQuery Foundation)
  • James Graham
  • Georgios Grigoriadis (SAP AG)
  • Jeff Grimes (Oracle)
  • Loretta Guarino Reid (Google, Inc.)
  • Barbara Hartel
  • James Hawkins (Google, Inc.)
  • Benjamin Hawkes-Lewis
  • Sean Hayes (Microsoft Corporation)
  • Mona Heath (University of Illinois at Urbana-Champaign)
  • Jan Heck
  • Shawn Henry
  • Tina Homboe
  • John Hrvatin (Microsoft Corporation)
  • Takahiro Inada
  • Masayasu Ishikawa (W3C)
  • Jim Jewitt
  • Kenny Johar (Microsoft Corporation)
  • Shilpi Kapoor (BarrierBreak Technologies)
  • Masahiko Kaneko (Microsoft Corporation)
  • Marjolein Katsma
  • George Kerscher (International Digital Publishing Forum)
  • Jason Kiss (New Zealand Government)
  • Todd Kloots
  • Johannes Koch
  • Sam Kuper
  • Earl Johnson (Sun)
  • Jael Kurz
  • Rajesh Lal (Nokia Corporation)
  • Diego La Monica (International Webmasters Association / HTML Writers Guild (IWA-HWG))
  • Aaron Leventhal (IBM Corporation)
  • Gez Lemon (International Webmasters Association / HTML Writers Guild (IWA-HWG))
  • Alex Li (SAP)
  • Chris Lilley
  • Thomas Logan (HiSoftware Inc.)
  • William Loughborough (Invited Expert)
  • Linda Mao (Microsoft)
  • David MacDonald (Invited Expert, CanAdapt Solutions Inc.)
  • Carolyn MacLeod
  • Anders Markussen (Opera Software)
  • Krzysztof Maczyński
  • Matthew May (Adobe Systems Inc.)
  • Dominic Mazzoni (Google, Inc.)
  • Alexandre Morgaut (4D)
  • Ann Navarro (Invited Expert)
  • Joshue O Connor (Invited Expert, CFIT)
  • Artur Ortega (Microsoft Corporation)
  • Sailesh Panchang (Deque)
  • Lisa Pappas (Society for Technical Communication (STC))
  • Marta Pawlowlska (Samsung Electronics Co., Ltd.)
  • Dave Pawson (RNIB)
  • Steven Pemberton (CWI Amsterdam)
  • Simon Pieters (Opera Software)
  • Jean-Bernard Piot (4D)
  • David Poehlman, Simon Pieters (Opera Software)
  • Sarah Pulis (Media Access Australia)
  • T.V. Raman (Google, Inc.)
  • Jan Richards
  • Gregory Rosmaita (Invited Expert)
  • Tony Ross (Microsoft Corporation)
  • Alex Russell (Dojo Foundation) (
  • Mark Sadecki (Invited Expert)
  • Mario Sánchez Prada (Samsung Electronics Co., Ltd. and Gnome Foundation)
  • Martin Schaus (SAP AG)
  • Doug Schepers (W3C)
  • Matthias Schmitt
  • Marc Silbey (Microsoft Corporation)
  • Leif Halvard Sili
  • Henri Sivonen (Mozilla)
  • Michael Smith (W3C)
  • Andi Snow-Weaver (IBM Corporation)
  • Ville Skyttä
  • Henny Swan (BBC)
  • Neil Soiffer (Design Science)
  • Vitaly Sourikov
  • Mike Squillace (IBM)
  • Maciej Stachowiak (Apple Inc.)
  • Christophe Strobbe
  • Suzanne Taylor (Pearson plc)
  • Terrill Thompson
  • David Todd
  • Gregg Vanderheiden (Invited Expert, Trace)
  • Anne van Kesteren
  • Wen He (Tencent)
  • Wu Wei (W3C / RITT)
  • Ryan Williams (Oracle)
  • Tom Wlodkowski
  • Sam White (Apple Inc.)
  • Marco Zehe (Mozilla Foundation)

A.2.3 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 §

[ACCNAME-AAM]
Joseph Scheuhammer; Michael Cooper; Andi Snow-Weaver; Aaron Leventhal et al. Accessible Name and Description: Computation and API Mappings 1.1. W3C Working Draft. URL: http://www.w3.org/TR/accname-aam-1.1/
[CORE-AAM]
Joseph Scheuhammer; Michael Cooper; Andi Snow-Weaver; Aaron Leventhal et al. Core Accessibility API Mappings 1.1. W3C Working Draft. URL: http://www.w3.org/TR/core-aam-1.1/
[dpub-aria-1.0]
Matt Garrish; Tzviya Siegman; Markus Gylling; Shane McCarron. Digital Publishing WAI-ARIA Module 1.0. 19 November 2015. W3C Working Draft. URL: http://www.w3.org/TR/dpub-aria-1.0/

B.2 Informative references §

[AT-SPI]
Assistive Technology Service Provider Interface. URL: https://developer.gnome.org/libatspi/stable/
[ATK]
ATK - Accessibility Toolkit. URL: https://developer.gnome.org/atk/stable/
[AXAPI]
The Mac OS X Accessibility Protocol Mac OS 10.10. URL: https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Protocols/NSAccessibility_Protocol/index.html
[IAccessible2]
IAccessible2. URL: http://www.linuxfoundation.org/collaborate/workgroups/accessibility/iaccessible2
[MSAA]
Microsoft Active Accessibility (MSAA) 2.0. URL: https://msdn.microsoft.com/en-us/library/ms697707.aspx
[UI-AUTOMATION]
UI Automation. URL: https://msdn.microsoft.com/en-us/library/ee684009%28v=vs.85%29.aspx
[UIA-EXPRESS]
The IAccessibleEx Interface. URL: https://msdn.microsoft.com/en-us/library/windows/desktop/dd561898%28v=vs.85%29.aspx
[WAI-ARIA-IMPLEMENTATION]
Joseph Scheuhammer; Michael Cooper. WAI-ARIA 1.0 User Agent Implementation Guide. 20 March 2014. W3C Recommendation. URL: http://www.w3.org/TR/wai-aria-implementation/
[WAI-ARIA-PRACTICES]
Joseph Scheuhammer; Michael Cooper. WAI-ARIA 1.0 Authoring Practices. 7 March 2013. W3C Working Draft. URL: http://www.w3.org/TR/wai-aria-practices/
[WCAG20]
Ben Caldwell; Michael Cooper; Loretta Guarino Reid; Gregg Vanderheiden et al. Web Content Accessibility Guidelines (WCAG) 2.0. 11 December 2008. W3C Recommendation. URL: http://www.w3.org/TR/WCAG20/