Support ARIA role='mark' and html mark tag by michaelDCurran · Pull Request #11436 · nvaccess/nvda

michaelDCurran · 2020-07-29T07:00:31Z

Link to issue number:

None.

Summary of the issue:

Content authors can indicate that content is marked (highlighted) by wrapping the content in an html 'mark' tag, or placing role='mark' on any other tag wrapping the content.
NVDA should report the existence of marked text in speech and braille.

Description of how this pull request fixes the issue:

This pr:

Upgrades IAccessible2 to the latest commit, providing the IA2_ROLE_MARK constant.
Added a new MARKED_CONTENT role to NVDA, and map to it from IAccessible2's IA2_ROLE_MARK.
Added a new document formatting option for reporting highlighting.
Braille and speech report the start and end of ROLE_MARKED_CONTENT. In speech it is "marked content blahblahblah out of marked content" and in braile it is "mrkd blahblahblah mrkd end".
In Internet Explorer, added support for ARIA role=mark, and replaced the older support for the html mark tag with one that conforms with the above implementations.

These changes now mean that NVDA will report the existence of marked text in both speech and braille, in Firefox, chrome, Edge (Chromium) and Internet Explorer.

Testing performed:

Using the following test case:
Ensured that NVDA reported the existence of marked text in both speech and braille when report highlight was on, and not when it was off. Tested in Firefox, chrome, Microsoft Edge and Internet Explorer.

Known issues with pull request:

Marked text is now reported by default in web browsers, where as previously, at least in Internet Explorer, you needed to turn on report emphasis. I would argue that marking (highlighting) is extremely important semantically, and should be reported by default, as this is used in many education scenarios including online exams. However, having it under report emphasis along with em and strong would cause many users to want to keep the option off, as those two other tags are used way too much (and sometimes inappropriately) on web pages.
As all browsers have exposed mark as an object rather than a run of text, this has forced NvDA to implement support for it via controlFields rather than formatFields. Thus the presentation is more like a blockquote rather than basic text formatting. Thus, in speech we get "out of marked content" rather than "not marked". I don't believe this is terrible myself.

Change log entry:

new features:

The existence of marked (highlighted) content is reported in both speech and braille in all web browsers.
This can be toggled on and off by a new NVDA Document Formatting option for Highlighting.

…ROLE_MARK constant.

…ighted) content. Have speech and braille report its start and end within rich text if the report emphasis document formatting option is enabled. Map the IAccessible2 MARK role to the NVDA MARK role. This all means that the mark role will be reported in both Firefox and Chrome.

…ML mark tag with Firefox / Chrome.

…tings, on by default, and have marked content be affected by that option rather than report emphasis.

feerrenrut

This probably needs a change to the user guide.

XLTechie · 2020-07-29T16:31:06Z

This will be good, but why "marked content" instead of something shorter like "marked text"?

…

-- Democracy is two wolves and a sheep deciding what to eat for lunch. Liberty is a well-armed sheep contesting the vote.

codeofdusk · 2020-07-29T22:09:53Z

This will be good, but why "marked content" instead of something shorter like "marked text"?

Presumably not just text can be marked.

… (highlighting). UserGuide: mention the braille abbreviation for marked content.

feerrenrut

Thanks @michaelDCurran

codeofdusk · 2020-07-30T13:38:18Z

@feerrenrut Did you intend to merge this or are you waiting for another reviewer?

btman16 · 2020-09-14T18:16:09Z

Hi,

I just installed NVDA 2020.3 beta 1 and while I think it's great that this option exists, I'd like to ask if this can please be off by default?
On certain sites, such as the classic Twitter mobile interface, user names are emphasized as being strong and it creates a lot of extra verbosity. A similar case came up after the release of NVDA 2015.4. At that time, reporting if text was marked as strong or not happened when emphasis reporting was checked in Document Formatting and this option was later disabled by default.

I'm wondering if a similar thing could be done with the marking option?

Thank you very much for your time and I look forward to any input you may have.

Sincerely,

Brandon Tyson

feerrenrut · 2020-09-16T11:54:57Z

Hi @btman16 could you please create a new issue for this?

btman16 · 2020-09-16T23:36:59Z

Hi, Yes, I'd be happy to do a new issue. Would you like it to be a new feature or a bug? Thanks again for your help, Brandon

…

Sent from my iPhone

On Sep 16, 2020, at 7:55 AM, Reef Turner ***@***.***> wrote: Hi @btman16 could you please create a new issue for this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

feerrenrut · 2020-09-17T15:34:40Z

I think this should be described as a feature. However, please do include any example sites where role=mark causes excessive verbosity. Thanks!

btman16 · 2020-09-19T21:49:42Z

Hello, I just created the new issue. I haven't done this before, so I'm not sure whether I should link to the new issue here or do something else. Thanks again for your help, Brandon

…

Sent from my iPhone

On Sep 17, 2020, at 11:34 AM, Reef Turner ***@***.***> wrote: I think this should be described as a feature. However, please do include any example sites where role=mark causes excessive verbosity. Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

feerrenrut · 2020-09-21T13:37:22Z

Thanks @btman16, for reference the issue is #11640.

Prior work: #11436 - Use "highlight" instead of "marked content" for speech. - Use "hlght" instead of "mrkd" for braille 'mark' elements were being reported as "marked content" which is long. Additionally, the standard visual representation (in browsers) of mark is a yellow background, as if the text has been highlighted. Arguably, "highlighted" is a more common phrase in English and more specific to the visual representation in browsers The more general "marked" content could mean many different kinds of markings with varied semantics. With the introduction of "role-description", less common usages of mark can be achieved.

michaelDCurran added 5 commits July 29, 2020 15:23

Upgrade IAccessible2 to commit cbc1f29631780 in order to get the IA2_…

cf78c24

…ROLE_MARK constant.

Fix linting issues

24881b5

Support role=mark in Internet Explorer and standardize support for HT…

9bb9beb

…ML mark tag with Firefox / Chrome.

Add a new 'report highlight' option to NVDA's document formatting set…

d9afc8c

…tings, on by default, and have marked content be affected by that option rather than report emphasis.

michaelDCurran requested a review from feerrenrut July 29, 2020 07:00

This comment has been minimized.

Sign in to view

Address linting issues

f9c5fa1

LeonarddeR reviewed Jul 29, 2020

View reviewed changes

Comment thread source/controlTypes.py

This comment has been minimized.

Sign in to view

feerrenrut suggested changes Jul 29, 2020

View reviewed changes

Comment thread source/gui/settingsDialogs.py Outdated

Gui: rename option in document formatting from Highlighting to Marked…

51dc60e

… (highlighting). UserGuide: mention the braille abbreviation for marked content.

michaelDCurran force-pushed the supportMarkRole branch from 2a02dd6 to 51dc60e Compare July 30, 2020 02:36

feerrenrut previously approved these changes Jul 30, 2020

View reviewed changes

Update what's new

916293f

michaelDCurran dismissed feerrenrut’s stale review via 916293f July 30, 2020 21:53

michaelDCurran merged commit 39606f1 into master Jul 30, 2020

michaelDCurran deleted the supportMarkRole branch July 30, 2020 22:03

nvaccessAuto added this to the 2020.3 milestone Jul 30, 2020

This was referenced Nov 4, 2020

Script to toggle marked (highlighted) text reporting. #11807

Merged

Emphasised text is not reported according to its setting in IE #11808

Closed

This was referenced Nov 5, 2020

Reporting Of Marked (Highlighted) Text Should be Disabled By Default #11640

Closed

Restore the ability to report Emphasis formatting #11813

Merged

feerrenrut mentioned this pull request Oct 4, 2021

Announce highlight instead of marked #12892

Merged

5 tasks

Adriani90 mentioned this pull request Mar 26, 2024

Nvda and mark tag in html5. #4247

Closed

Uh oh!

Conversation

michaelDCurran commented Jul 29, 2020

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

feerrenrut left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

XLTechie commented Jul 29, 2020 via email

Uh oh!

codeofdusk commented Jul 29, 2020 • edited by feerrenrut Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

feerrenrut left a comment

Choose a reason for hiding this comment

Uh oh!

codeofdusk commented Jul 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

btman16 commented Sep 14, 2020

Uh oh!

feerrenrut commented Sep 16, 2020

Uh oh!

btman16 commented Sep 16, 2020 via email

Uh oh!

feerrenrut commented Sep 17, 2020

Uh oh!

btman16 commented Sep 19, 2020 via email

Uh oh!

feerrenrut commented Sep 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

codeofdusk commented Jul 29, 2020 •

edited by feerrenrut

Loading

codeofdusk commented Jul 30, 2020 •

edited

Loading