diff --git a/dpub-aam/.gitattributes b/dpub-aam/.gitattributes new file mode 100644 index 000000000..e5237fb0f --- /dev/null +++ b/dpub-aam/.gitattributes @@ -0,0 +1,12 @@ +# Ensure all text files do not accidentally become a CRLF file. +# Agreed upon during 5 August 2015 PF Editors concall. +# To override or prevent this behavior see the following sections. +* text eol=lf + +# Files that will always have CRLF line endings. Example: +# my-special-spec.html eol=crlf + +# Ensure non-text files don't get accidentally swept up by above. +*.png binary +*.jpg binary +*.zargo binary diff --git a/dpub-aam/.gitignore b/dpub-aam/.gitignore new file mode 100644 index 000000000..ead8624e4 --- /dev/null +++ b/dpub-aam/.gitignore @@ -0,0 +1,219 @@ +################# +## Eclipse +################# + +*.pydevproject +.project +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + + +################# +## Visual Studio +################# + +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. + +# User-specific files +*.suo +*.user +*.sln.docstates + +# Build results + +[Dd]ebug/ +[Rr]elease/ +x64/ +build/ +[Bb]in/ +[Oo]bj/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +*_i.c +*_p.c +*.ilk +*.meta +*.obj +*.pch +*.pdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.log +*.scc + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opensdf +*.sdf +*.cachefile + +# Visual Studio profiler +*.psess +*.vsp +*.vspx + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# NCrunch +*.ncrunch* +.*crunch*.local.xml + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.Publish.xml +*.pubxml + +# NuGet Packages Directory +## TODO: If you have NuGet Package Restore enabled, uncomment the next line +#packages/ + +# Windows Azure Build Output +csx +*.build.csdef + +# Windows Store app package directory +AppPackages/ + +# Others +sql/ +*.Cache +ClientBin/ +[Ss]tyle[Cc]op.* +~$* +*~ +*.dbmdl +*.[Pp]ublish.xml +*.pfx +*.publishsettings + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file to a newer +# Visual Studio version. Backup files are not needed, because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm + +# SQL Server files +App_Data/*.mdf +App_Data/*.ldf + +############# +## Windows detritus +############# + +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Mac crap +.DS_Store + + +############# +## Python +############# + +<<<<<<< HEAD +*.py[co] +======= +*.py[cod] +>>>>>>> a51b9db2d4ebd2968f49781325ba3e4741f0127f + +# Packages +*.egg +*.egg-info +dist/ +build/ +eggs/ +parts/ +var/ +sdist/ +develop-eggs/ +.installed.cfg + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox + +#Translations +*.mo + +#Mr Developer +.mr.developer.cfg diff --git a/dpub-aam/index.html b/dpub-aam/index.html new file mode 100644 index 000000000..438630b78 --- /dev/null +++ b/dpub-aam/index.html @@ -0,0 +1,2841 @@ + + + + Digital Publishing Accessibility API Mappings 1.1 + + + + + + + + + +
+

The Digital Publishing Accessibility API Mappings (DPub-AAM) defines how [=user agents=] map the Digital + Publishing WAI-ARIA Module [[dpub-aria-1.1]] 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 primary change since the First Public Working Draft was to update the Mac AX API mappings to add the + AXCustomContent fields for announcing roles. Feedback on any aspect of the specification is + encouraged. A list of all substantive changes is available in the change + log.

+
+
+

Introduction

+ +

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-1.1]] and the Accessible Name and Description: Computation + 1.2 [[ACCNAME-1.2]] 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.

+
+
+ +
+

RFC-2119 Keywords

+ +

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.

+
+ +
+

Normative and Informative Sections

+ +

The indication whether a section is normative or non-normative (informative) applies to the entire + section including sub-sections.

+ +

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.

+
+ +
+

Roles deprecated in DPUB-ARIA

+ +

The DPUB-ARIA specification [[dpub-aria-1.1]] lists some roles as deprecated. Although this means + authors are encouraged not to use these roles, it is expected that the roles could still be used in + legacy content. Therefore, it is important that user agents continue to map these roles to + accessibility APIs, and doing so is part of conformance to this specification. When future versions + of the DPUB-ARIA specification change such roles from deprecated to removed, they will be removed + from the mappings as well and user agents will no longer be asked to continue support for those + roles.

+
+
+
+

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

+
+
+

Mapping WAI-ARIA to accessibility APIs

+ +
+

General rules for exposing WAI-ARIA + semantics

+ +

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

+
+
+
+

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

+
+
+

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

+
+
+

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.

+ +
+

General Rules

+ +

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

+
+ +
+

Role Mapping Tables

+ +

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.

+ +
+

doc-abstract

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-abstract +
Computed Roledoc-abstract
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_SECTION
    • +
  • Object attribute xml-roles:doc-abstract.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'abstract'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "abstract" }
    • +
+
+
+ +
+

doc-acknowledgments

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-acknowledgments +
Computed Roledoc-acknowledgments
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-acknowledgments.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'acknowledgements'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'acknowledgements'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "acknowledgements" + }
    • +
+
+
+ +
+

doc-afterword

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-afterword +
Computed Roledoc-afterword
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-afterword.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'afterword'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'afterword'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "afterword" }
    • +
+
+
+ +
+

doc-appendix

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-appendix +
Computed Roledoc-appendix
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-appendix.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'appendix'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'appendix'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "appendix" }
    • +
+
+
+ + + +
+

doc-biblioentry

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-biblioentry +
Computed Roledoc-biblioentry
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

ROLE_SYSTEM_LISTITEM + + STATE_SYSTEM_READONLY +

+

IAccessible2:

+

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

+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'biblioentry'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-bibliography

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-bibliography +
Computed Roledoc-bibliography
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-bibliography.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'bibliography'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'biblography'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "bibliography" }
    • +
+
+
+ +
+

doc-biblioref

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-biblioref +
Computed Roledoc-biblioref
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose
    +
  • ROLE_SYSTEM_LINK + STATE_LINKED
    • +
  • STATE_LINKED on all descendants
    • +
+

IAccessible2:

+
    +
  • Object attribute xml-roles:doc-biblioref.
    • +
  • AccessibleHypertext interface
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'biblioref'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXLink
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'link'
    • +
  • AXCustomContent: { label: "type", value: "bibliography" }
    • +
+
+
+ +
+

doc-chapter

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-chapter +
Computed Roledoc-chapter
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-chapter.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'chapter'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'chapter'
    • +
+
ATK/AT-SPI + Role +

Expose ROLE_LANDMARK and object attribute + xml-roles:chapter. +

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkChapter
    • +
  • AXRoleDescription: 'chapter'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-colophon

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-colophon +
Computed Roledoc-colophon
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_SECTION

+

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

+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'colophon'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "colophon" }
    • +
+
+
+ +
+

doc-conclusion

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-conclusion +
Computed Roledoc-conclusion
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-conclusion.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'conclusion'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'conclusion'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "conclusion" }
    • +
+
+
+ +
+

doc-cover

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-cover +
Computed Roledoc-cover
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

ROLE_SYSTEM_GRAPHIC

+

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

+
UIA Control Type + Other + Features + Control Type is Image +
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXImage
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'cover image'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-credit

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-credit +
Computed Roledoc-credit
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_SECTION

+

IAccessible2:

Object attribute + xml-roles:doc-credit +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'credit'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-credits

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-credits +
Computed Roledoc-credits
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-credits.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'credits'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'credits'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "credits" }
    • +
+
+
+ +
+

doc-dedication

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-dedication +
Computed Roledoc-dedication
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_SECTION

+

IAccessible2:

Object attribute + xml-roles:doc-dedication +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'dedication'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "dedication" }
    • +
+
+
+ +
+

doc-endnote

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-endnote +
Computed Roledoc-endnote
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

ROLE_SYSTEM_LISTITEM + + STATE_SYSTEM_READONLY +

+

IAccessible2:

+

Object attribute xml-roles:doc-endnote.

+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'endnote'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-endnotes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-endnotes +
Computed Roledoc-endnotes
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-endnotes.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'endnotes'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'endnotes'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "end notes" }
    • +
+
+
+ +
+

doc-epigraph

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-epigraph +
Computed Roledoc-epigraph
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_SECTION

+

IAccessible2:

Object attribute + xml-roles:doc-epigraph +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'epigraph'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "epigraph" }
    • +
+
+
+ +
+

doc-epilogue

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-epilogue +
Computed Roledoc-epilogue
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-epilogue.
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'epilogue'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'epilogue'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "epilog" }
    • +
+
+
+ +
+

doc-errata

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-errata +
Computed Roledoc-errata
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-errata
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'errata'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'errata'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "errata" }
    • +
+
+
+ +
+

doc-example

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-example +
Computed Roledoc-example
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_SECTION

+

IAccessible2:

Object attribute + xml-roles:doc-example +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'example'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "example" }
    • +
+
+
+ +
+

doc-footnote

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-footnote +
Computed Roledoc-footnote
MSAA + IAccessible2 Role + Other IAccessible2 Features +

Expose IAccessible2:

+
    +
  • IA2_ROLE_FOOTNOTE
    • +
  • Object attribute: xml-roles:doc-footnote
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'footnote'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "footnote" }
    • +
+
+
+ +
+

doc-foreword

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-foreword +
Computed Roledoc-foreword
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-foreword
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'foreword'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'foreword'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "foreword" }
    • +
+
+
+ +
+

doc-glossary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-glossary +
Computed Roledoc-glossary
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-glossary +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'glossary'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'glossary'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "glossary" }
    • +
+
+
+ +
+

doc-glossref

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-glossref +
Computed Roledoc-glossref
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose
    +
  • ROLE_SYSTEM_LINK + STATE_LINKED
    • +
  • STATE_LINKED on all descendants
    • +
+

IAccessible2:

+
    +
  • Object attribute xml-roles:doc-glossref.
    • +
  • AccessibleHypertext interface
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'glossref'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXLink
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'link'
    • +
  • AXCustomContent: { label: "type", value: "glossary" }
    • +
+
+
+ +
+

doc-index

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-index +
Computed Roledoc-index
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-index +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'index'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'index'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkNavigation
    • +
  • AXRoleDescription: 'navigation'
    • +
  • AXCustomContent: { label: "type", value: "index" }
    • +
+
+
+ +
+

doc-introduction

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-introduction +
Computed Roledoc-introduction
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-introduction +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'introduction'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'introduction'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "introduction" }
    • +
+
+
+ +
+

doc-noteref

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-noteref +
Computed Roledoc-noteref
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose
    +
  • ROLE_SYSTEM_LINK + STATE_LINKED
    • +
  • STATE_LINKED on all descendants
    • +
+

IAccessible2:

+
    +
  • Object attribute xml-roles:doc-noteref.
    • +
  • AccessibleHypertext interface
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'noteref'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXLink
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'link'
    • +
  • AXCustomContent: { label: "type", value: "note" }
    • +
+
+
+ +
+

doc-notice

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-notice +
Computed Roledoc-notice
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_NOTE

+

IAccessible2:

Object attribute xml-roles:doc-notice. +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'notice'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXDocumentNote
    • +
  • AXRoleDescription: 'note'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-pagebreak

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-pagebreak +
Computed Roledoc-pagebreak
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

ROLE_SYSTEM_SEPARATOR

+

IAccessible2:

Object attribute xml-roles:doc-pagebreak. +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'pagebreak'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXSplitter
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'splitter'
    • +
  • AXCustomContent: { label: "type", value: "page break" }
    • +
+
+
+ + + +
+

doc-pageheader

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-pageheader +
Computed Roledoc-pageheader
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_HEADER
    • +
  • Object attribute xml-roles:doc-pageheader +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Control Pattern: Annotation
    • +
  • Annotation.AnnotationTypeId: Header
    • +
+
ATK/AT-SPI + Role + Expose

ROLE_HEADER and object attribute + xml-roles:doc-pageheader. +

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: <nil>
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "header" }
    • +
+
+
+ +
+

doc-pagelist

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-pagelist +
Computed Roledoc-pagelist
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-pagelist +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'pagelist'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'pagelist'
    • +
+
ATK/AT-SPI + Role + Expose

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkNavigation
    • +
  • AXRoleDescription: 'navigation'
    • +
  • AXCustomContent: { label: "type", value: "page list" }
    • +
+
+
+ +
+

doc-part

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-part +
Computed Roledoc-part
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-part +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'part'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'part'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "part" }
    • +
+
+
+ +
+

doc-preface

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-preface +
Computed Roledoc-preface
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARKi
    • +
  • Object attribute xml-roles:doc-preface +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'preface'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'preface'
    • +
+
ATK/AT-SPI + Role +

Expose ROLE_LANDMARK and object attribute + xml-roles:doc-preface. +

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "preface" }
    • +
+
+
+ +
+

doc-prologue

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-prologue +
Computed Roledoc-prologue
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-prologue +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'prologue'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'prologue'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkRegion
    • +
  • AXRoleDescription: 'region'
    • +
  • AXCustomContent: { label: "type", value: "prolog" }
    • +
+
+
+ +
+

doc-pullquote

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-pullquote +
Computed Roledoc-pullquote
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_SECTION
    • +
  • Object attribute xml-roles:doc-pullquote +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'pullquote'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "pull quote" }
    • +
+
+
+ +
+

doc-qna

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-qna +
Computed Roledoc-qna
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_SECTION

+

IAccessible2:

Object attribute + xml-roles:doc-qna +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'qna'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXApplicationGroup
    • +
  • AXRoleDescription: 'group'
    • +
  • AXCustomContent: { label: "type", value: "Q&A" }
    • +
+
+
+ +
+

doc-subtitle

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-subtitle +
Computed Roledoc-subtitle
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_HEADING
    • +
  • Object attribute xml-roles:doc-subtitle
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'subtitle'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXHeading
    • +
  • AXSubrole: AXSubtitle
    • +
  • AXRoleDescription: 'subtitle'
    • +
  • AXCustomContent: {}
    • +
+
+
+ +
+

doc-tip

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-tip +
Computed Roledoc-tip
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose

IA2_ROLE_NOTE

+

IAccessible2:

Object attribute xml-roles:doc-tip +
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'tip'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXDocumentNote
    • +
  • AXRoleDescription: 'note'
    • +
  • AXCustomContent: { label: "type", value: "tip" }
    • +
+
+
+ +
+

doc-toc

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
DPUB-ARIA Specification + doc-toc +
Computed Roledoc-toc
MSAA + IAccessible2 Role + Other IAccessible2 Features + Expose IAccessible2:
    +
  • IA2_ROLE_LANDMARK
    • +
  • Object attribute xml-roles:doc-toc +
    • +
+
UIA Control Type + Other + Features +
    +
  • Control Type is Text
    • +
  • Localized Control Type is 'toc'
    • +
  • Landmark Type is Custom
    • +
  • Localized Landmark Type is 'toc'
    • +
+
ATK/AT-SPI + Role +

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

+
Mac AX API +
    +
  • AXRole: AXGroup
    • +
  • AXSubrole: AXLandmarkNavigation
    • +
  • AXRoleDescription: 'navigation'
    • +
  • AXCustomContent: { label: "type", value: "table of contents" + }
    • +
+
+
+
+
+
+

Translatable Values

+ +

The HTML specification states that other specifications can define translatable attributes [[html]]. The language and + directionality of each attribute value is the same as the language and + directionality of the element [[html]].

+ +

To be understandable by assistive technology users, the following role mapping values + intended for human consumption should be translated when a page is localized:

+ + +
+
+

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

+
+
+

Special Processing Requiring Additional Computation

+ +
+

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

+
+ +
+

Relations

+ +

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

+
+ +
+

Group Position

+ +

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

+
+
+
+

Actions

+ +

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

+
+
+

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.

+
+
+

Security Considerations

+ +

This specification introduces no new security considerations.

+
+
+

Privacy Considerations

+ +

In accordance with Web Platform + Design Principles, this specification provides no programatic interface to determine if + information is being used by assistive technologies. However, this specification does allow an author to + present different information to users of assistive technologies from the information available to users + who do not use assistive technologies. This is possible using many features of the DPUB-ARIA + specification, just as this is possible using many other parts of the web technology stack. This content + disparity could be abused to perform active + fingerprinting of users of assistive technologies.

+
+
+

Appendices

+ +
+

Change Log

+ +
+

Substantive changes since the First Public Working Draft

+ +
    +
  • 01-Dec-2023: Removed the mappings that implied doc-biblioentry and doc-endnote on listitem + descendants doc-bibliograph and doc-endnotes, respectively.
    • +
  • 10-Jan-2023: Added section on translatable values.
    • +
  • 04-Jan-2023: Fixed incorrect doc-pagebreak role mentioned in ATK/AT-SPI mapping for + doc-preface.
    • +
  • 04-Jan-2023: Updated Mac AX API mappings to add AXCustomContent fields.
    • +
+
+ +
+

Other substantive changes since Digital Publishing Accessibility API Mappings 1.0

+
    +
  • 20-Sep-2021: Added mappings for doc-pageheader and doc-pagefooter roles.
    • +
+
+
+ +
+

Acknowledgments

+ +

The following people contributed to the development of this document:

+ + + +
+
+
+ +