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 digital publications, 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.
This is a Candidate Recommendation of Digital Publishing Accessibility API Mappings 1.0 by the Digital Publishing ARIA Taskforce, a joint task force of the Accessible Rich Internet Applications Working Group and the Digital Publishing Interest Group. This is a call for implementations; the Accessible Rich Internet Applications Working Group requests that initial implementations be submitted by 30 June 2017. The Working Group targets 30 June 2017 to complete the testing process and produce the implementation report. A history of changes to Digital Publishing Accessibility API Mappings 1.0 is available in the appendix.
Exit Criteria: The Accessible Rich Internet Applications Working Group intends to exit the Candidate Recommendation stage and submit this document for consideration as a W3C Proposed Recommendation after documenting interoperable implementability of each feature. The expectations and procedure for this are listed in the Exit Criteria appendix.
Comments: The Accessible Rich Internet Applications Working Group primarily seeks feedback relation to implementation of Digital Publishing Accessibility API Mappings, but feedback on any aspect of the specification is accepted. To comment, file an issue in the W3C ARIA GitHub repository. If this is not feasible, send email to public-dpub-aria-comments@w3.org (comment archive). Comments are requested by 30 June 2017. In-progress updates to the document may be viewed in the publicly visible editors' draft.
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.
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]].
This section MUST conform to General rules for exposing WAI-ARIA semantics in [[!CORE-AAM]].
User agents MUST conform to Conflicts between native markup semantics and WAI-ARIA in [[!CORE-AAM]].
User agents MUST conform to Exposing attributes that do not directly map to accessibility API properties in [[!CORE-AAM]].
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.
User agents MUST conform to the Role Mapping General Rules accessibility API computational requirements in [[!CORE-AAM]].
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.
There are a number of roles mappings that are localized. The group needs to look into localizing for non-English languages.
WAI-ARIA Role | MSAA + IAccessible2 Role + Other IAccessible2 Features | UIA Control Type + Other Features | ATK/AT-SPI Role | AXAPI |
---|---|---|---|---|
doc-abstract |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-acknowledgments |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-afterword |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-appendix |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-backlink |
Expose
IAccessible2:
|
|
Expose |
AXRole: AXLink AXSubrole: <nil> AXRoleDescription: 'link'
|
doc-biblioentry |
Expose
IAccessible2: Object attribute |
|
Expose |
AXRole: AXGroup AXSubrole: <nil> AXRoleDescription: 'group'
|
doc-bibliography |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-biblioref |
Expose
IAccessible2:
|
|
Expose |
AXRole: AXLink AXSubrole: <nil> AXRoleDescription: 'link'
|
doc-chapter |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-colophon |
Expose
IAccessible2: Object attribute |
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-conclusion |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-cover |
Expose
IAccessible2: Object attribute |
Control Type is Image
|
expose |
AXRole: AXImage AXSubrole: <nil> AXRoleDescription: 'image'
|
doc-credit |
Expose
IAccessible2: Object attributexml-roles:doc-credit |
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-credits |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-dedication |
Expose
IAccessible2: Object attributexml-roles:doc-dedication |
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-endnote |
Expose
IAccessible2: Object attribute |
|
Expose |
AXRole: AXGroup AXSubrole: <nil> AXRoleDescription: 'group'
|
doc-endnotes |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-epigraph |
Expose
IAccessible2: Object attributexml-roles:doc-epigraph |
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-epilogue |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-errata |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-example |
Expose
IAccessible2: Object attributexml-roles:doc-example |
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-footnote |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-foreword |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-glossary |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-glossref |
Expose
IAccessible2:
|
|
Expose |
AXRole: AXLink AXSubrole: <nil> AXRoleDescription: 'link'
|
doc-index |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkNavigation AXRoleDescription: 'navigation'
|
doc-introduction |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-noteref |
Expose
IAccessible2:
|
|
Expose |
AXRole: AXLink AXSubrole: <nil> AXRoleDescription: 'link'
|
doc-notice |
Expose
IAccessible2: Object attributexml-roles:doc-notice . |
|
Expose |
AXRole: AXGroup AXSubrole: AXDocumentNote AXRoleDescription: 'note'
|
doc-pagebreak |
Expose
IAccessible2: Object attributexml-roles:doc-pagebreak .
|
|
Expose |
AXRole: AXSplitter AXSubrole: <nil> AXRoleDescription: 'splitter'
|
doc-pagelist |
Expose IAccessible2:
|
|
Expose
|
AXRole: AXGroup AXSubrole: AXLandmarkNavigation AXRoleDescription: 'navigation'
|
doc-part |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-preface |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-prologue |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkRegion AXRoleDescription: 'region'
|
doc-pullquote |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-qna |
Expose
IAccessible2: Object attributexml-roles:doc-qna |
|
Expose |
AXRole: AXGroup AXSubrole: AXApplicationGroup AXRoleDescription: 'group'
|
doc-subtitle |
Expose IAccessible2:
|
|
Expose |
AXRole: AXHeading AXSubrole: <nil> AXRoleDescription: 'heading'
|
doc-tip |
Expose
IAccessible2: Object attributexml-roles:doc-tip
|
|
Expose |
AXRole: AXGroup AXSubrole: AXDocumentNote AXRoleDescription: 'note'
|
doc-toc |
Expose IAccessible2:
|
|
Expose |
AXRole: AXGroup AXSubrole: AXLandmarkNavigation AXRoleDescription: 'navigation'
|
[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).
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]].
When computing an accessible name or accessible description, user agents MUST conform to the section titled Text Alternative Computation of the [[!ACCNAME-AAM]] specification.
User agents MUST conform to the Widget Values accessibility API computational requirements in [[!CORE-AAM]].
User agents MUST conform to the Relation accessibility API computational requirements in [[!CORE-AAM]].
User agents MUST conform to the Group Position accessibility API computational requirements in [[!CORE-AAM]].
User agents MUST conform to the Actions accessibility API computational requirements in [[!CORE-AAM]].
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.
User agents MUST conform to the Special Document Handling Procedures in [[!CORE-AAM]].
For this specification to advance to Proposed Recommendation, it has to be shown that mappings defined in this specification are implemented on the target platforms. Consistent with the plan for the Digital Publishing WAI-ARIA Module 1.0 [[dpub-aria-1.0]] (Dpub-ARIA), the requirement is that each role is successfully mapped in at least two implementations and each implementation maps at least 75% of the roles.
doc-index
; remove requirement that roles with no mapping fall back to implicit rolesThe 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.