Report ARIA details role #13649

seanbudd · 2022-04-28T04:52:18Z

Link to issue number:

None

Summary of the issue:

When announcing if an object has details, more information can be provided about the role of the details.
For example, if a comment is tied to a word, "has comment" should be reported instead of "has details".

Description of how this pull request fixes the issue:

Collects the details role.

The attribute details role is determined in a number of cases.

Braille

Use has cmmt to report presence of comment role aria-details target. Discussion

Focus Mode

detailsRole is normalized on the NVDAObject level to a controlType.Role.

Chromium

The IA2 attribute details-roles is used to get the role.

This supports the following roles (code): comment, definition, doc-endnote, doc-footnote. Other roles are given a value of * .

Currently only chromium supports details-roles.
Additionally, doc-endnote and definition are not supported IA2 attributes, and are not supported in NVDA widely.

We limit reporting for all cases by only reporting the fully supported details-roles: doc-footnote, comment

Other roles are reported as "has details".

FireFox

The related details node is fetched using in process injection, and the IAccessible information is retrieved.
The role is determined from the IAccessible role of the related node.

This is slower and provides a wider reporting of roles.

Browse Mode

The detailsRole attribute is added directly to the buffer, either as a descriptive role string or a role integer as a string.

Testing strategy:

The system test cases test the details role for Chrome, using both focus and browse mode.

runsystemtests.bat -t "*aria details*"

Equivalent manual testing was performed using those test cases on both Chrome and FireFox.

Known issues with pull request:

Braille tests will not work as expected as braille only reports details in marked content. #13815

Change log entries:

New features

- Instead of reporting "has details" the purpose of details is included where possible, for example "has comment".

Code Review Checklist:

Pull Request description:
- description is up to date
- change log entries
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
API is compatible with existing add-ons.
Documentation:
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English

source/braille.py

…to ariaDetailsRole

source/aria.py

source/braille.py

tests/system/robot/chromeTests.py

nvdaHelper/vbufBackends/gecko_ia2/gecko_ia2.cpp

nvdaHelper/vbufBackends/gecko_ia2/gecko_ia2.h

nvdaHelper/vbufBase/storage.cpp

nvdaHelper/vbufBase/storage.h

tests/system/robot/chromeTests.py

nvdaHelper/vbufBackends/gecko_ia2/gecko_ia2.cpp

source/NVDAObjects/IAccessible/mozilla.py

nvdaHelper/vbufBase/storage.cpp

source/NVDAObjects/IAccessible/mozilla.py

source/controlTypes/role.py

feerrenrut · 2022-06-29T03:42:33Z

tests/system/robot/chromeTests.py

 				<div id="definition-details-as-role" role="definition">details with role definition</div>
+				<p>
+					<span role="term">definition</span>:
+					<span id="definition-details-as-role" role="definition">details with role definition</span>
+				</p>


These shouldn't both exist (two elements with id="definition-details-as-role".
I'd also like the <dfn> example added. It seems both the role="term" / role="definition" case and the <p> A description for a <dfn>term</dfn> is in this paragraph.</p> case share the similar problem about aria-details pointing to the term rather than the definition. Illustrating this in the tests will be helpful when having the discussion later.

I've added documentation to the test samples and fixed it so we consistently point to the term in cfb74bf

source/braille.py

AppVeyorBot · 2022-06-29T05:02:45Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/pg99t592u0qgp1qd/artifacts/output/nvda_snapshot_pr13649-25712,3437f37d.exe

See test results for failed build of commit 3437f37dd8

AppVeyorBot · 2022-06-29T09:48:25Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/0uatkvio44oh9p0x/artifacts/output/nvda_snapshot_pr13649-25719,99636e1c.exe

See test results for failed build of commit 99636e1cf6

feerrenrut · 2022-06-29T10:16:59Z

Although the test failures look related to this change, similar tests have failed on other recent PR builds. I have started the build again.

seanbudd added 2 commits April 28, 2022 14:09

Report ARIA details role

c22c6cf

split out long details section from fillVBuf

025a5a4

seanbudd requested a review from a team as a code owner April 28, 2022 04:52

seanbudd requested a review from michaelDCurran April 28, 2022 04:52

fixup focus/browse mishap

55df304

seanbudd requested a review from feerrenrut April 28, 2022 05:31

seanbudd commented Apr 28, 2022

View reviewed changes

source/braille.py Outdated Show resolved Hide resolved

seanbudd marked this pull request as draft April 28, 2022 05:57

seanbudd added 6 commits May 2, 2022 10:59

fixup focus/browse mishap

57858df

Merge branch 'ariaDetailsRole' of https://github.com/nvaccess/nvda in…

7848b8f

…to ariaDetailsRole

Merge branch 'master' into ariaDetailsRole

b78ca2d

limit details roles to a supported set

90d4682

Add system tests and improve logging

97ec23e

fix comment braille shorthand

aac8247

This comment was marked as outdated.

Sign in to view

seanbudd added 2 commits May 16, 2022 18:36

remove multi line from expected braille

cdf8c50

add details to table cells in braille

fce274e

This comment was marked as outdated.

Sign in to view

seanbudd marked this pull request as ready for review May 17, 2022 01:15

Make tests pass

c174a55

This comment was marked as outdated.

Sign in to view

fix lint

07e7611

This comment was marked as off-topic.

Sign in to view

feerrenrut suggested changes May 17, 2022

View reviewed changes

seanbudd marked this pull request as draft May 19, 2022 01:38

seanbudd added 2 commits May 23, 2022 13:58

Merge branch 'master' into ariaDetailsRole

b0c90d8

stash

3e9b727

feerrenrut reviewed Jun 13, 2022

View reviewed changes

tests/system/robot/chromeTests.py Outdated Show resolved Hide resolved

tests/system/robot/chromeTests.py Show resolved Hide resolved

seanbudd added 2 commits June 15, 2022 10:41

Merge branch 'master' into ariaDetailsRole

72e397b

improve detailsRole normalization

8b7c5b6

add ref link

c20b979

feerrenrut reviewed Jun 17, 2022

View reviewed changes

tests/system/robot/chromeTests.py Outdated Show resolved Hide resolved

feerrenrut suggested changes Jun 17, 2022

View reviewed changes

nvdaHelper/vbufBackends/gecko_ia2/gecko_ia2.cpp Outdated Show resolved Hide resolved

nvdaHelper/vbufBackends/gecko_ia2/gecko_ia2.cpp Outdated Show resolved Hide resolved

source/NVDAObjects/IAccessible/mozilla.py Show resolved Hide resolved

lukaszgo1 reviewed Jun 17, 2022

View reviewed changes

nvdaHelper/vbufBase/storage.cpp Outdated Show resolved Hide resolved

source/NVDAObjects/IAccessible/mozilla.py Outdated Show resolved Hide resolved

source/controlTypes/role.py Outdated Show resolved Hide resolved

improve docs on supported details-roles

bf4e4b2

seanbudd mentioned this pull request Jun 20, 2022

Report "has details" in braille for non-landmark content #13815

Closed

address review comments

125ea9d

seanbudd requested a review from feerrenrut June 20, 2022 02:02

seanbudd added 2 commits June 28, 2022 14:19

improve controlTypes API documentation

bdf4a90

Merge branch 'master' into ariaDetailsRole

2293fcc

seanbudd added the merge-early Merge Early in a developer cycle label Jun 28, 2022

feerrenrut suggested changes Jun 28, 2022

View reviewed changes

source/controlTypes/role.py Show resolved Hide resolved

seanbudd added 2 commits June 29, 2022 11:00

Add role compatibility tests

0ad0d35

fix up term and definition syntax

55eeb9f

seanbudd requested a review from feerrenrut June 29, 2022 01:09

This comment was marked as off-topic.

Sign in to view

feerrenrut suggested changes Jun 29, 2022

View reviewed changes

fix up definition test

cfb74bf

seanbudd requested a review from feerrenrut June 29, 2022 04:25

improve docs of definition tests

f3ec850

feerrenrut approved these changes Jun 29, 2022

View reviewed changes

seanbudd added 2 commits June 29, 2022 17:14

Merge branch 'master' into ariaDetailsRole

63b84d2

update changes

71673d8

This comment was marked as outdated.

Sign in to view

seanbudd merged commit 2e7a5f0 into master Jun 29, 2022

seanbudd deleted the ariaDetailsRole branch June 29, 2022 23:35

nvaccessAuto added this to the 2022.3 milestone Jun 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report ARIA details role #13649

Report ARIA details role #13649

seanbudd commented Apr 28, 2022 •

edited by feerrenrut

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as off-topic.

This comment was marked as off-topic.

feerrenrut Jun 29, 2022

seanbudd Jun 29, 2022

AppVeyorBot commented Jun 29, 2022

AppVeyorBot commented Jun 29, 2022

feerrenrut commented Jun 29, 2022

This comment was marked as outdated.

Report ARIA details role #13649

Report ARIA details role #13649

Conversation

seanbudd commented Apr 28, 2022 • edited by feerrenrut Loading

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Braille

Focus Mode

Chromium

FireFox

Browse Mode

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as off-topic.

This comment was marked as off-topic.

feerrenrut Jun 29, 2022

Choose a reason for hiding this comment

seanbudd Jun 29, 2022

Choose a reason for hiding this comment

AppVeyorBot commented Jun 29, 2022

AppVeyorBot commented Jun 29, 2022

feerrenrut commented Jun 29, 2022

This comment was marked as outdated.

seanbudd commented Apr 28, 2022 •

edited by feerrenrut

Loading