Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guidance for using aria-description #520

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Add guidance for using aria-description #520

merged 2 commits into from
Nov 21, 2024

Conversation

dginev
Copy link
Contributor

@dginev dginev commented Nov 20, 2024

Closes #493 in favour of aria-description.

This PR was an action item from the WG meeting on Nov 14, 2024. The text and example are completely tentative, rewordings welcome.

Preview at:
https://dginev.github.io/mathml/spec.html#acc_descriptions

Copy link
Contributor

@NSoiffer NSoiffer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text looks good. My only concern, which I don't have a solution for other than maybe using in conjunction with something that provides a tooltip, is a reverse "equal access". A goal of accessibility it to provide equal access to material for people with different impairments. In this case, the description is only provided to people using AT. Unless the description is something that is provided to the sighted person in the content in another manner (such as an arrow what the description is such as the radius of a circle), then it isn't equal access.

@NSoiffer
Copy link
Contributor

@Steve-Noble: you wrote a lot of the text here. Can you take a look at Deyan's suggestion and see if you think this is appropriate?

@dginev
Copy link
Contributor Author

dginev commented Nov 20, 2024

Unless the description is something that is provided to the sighted person in the content in another manner (such as an arrow what the description is such as the radius of a circle), then it isn't equal access.

That is a fair requirement. But I think the Web Platform is a good vehicle to achieve this, right?
CSS+JS can leverage math *[aria-description] selectors to scaffold a (non-standard) tooltip component.

Here is a very primitive example:
https://codepen.io/dginev/pen/OJKYKwN

It occurs to me that intent expressions would also appear to be subject to the equal access requirement. So maybe a shared solution is possible.

@NSoiffer
Copy link
Contributor

Maybe add a sentence or so that says something like 'if aria-description is used, then some technique such as having a tool tip with similar information should be provided for non-screen reader users'.

As I think about this more, it seems backward. Although I was the one to suggest adding this to the appendix, maybe the main reference should be in the maction section. It could get mentioned as means of conveying information to AT that might otherwise only be visually accessible. There would still need to be a brief mention of aria-description in this section. On the other hand, the maction section currently doesn't mention any tooltip-like actions, so maybe mention of using aria-description doesn't make sense there.

An aside: I briefly wondered if the title attribute made sense to include in MathML and quickly found this:

"If you want to hide content from mobile and tablet users as well as assistive tech users and keyboard only users, use the title attribute." — The Paciello Group blog

This is from a page MDN references: Tooltips & Toggletips. That has some brief mentions of aria-describedby usages.

@Steve-Noble
Copy link
Contributor

I would tend to echo Neil's comment. Information that essentially summarizes a mathematical expression should have an equal access method beyond only making it available to a screen reader. I think the general principle is that if the description would also be useful to sighted users, it's better to make it visible on the page in some way and use aria-describedby to reference it instead.

"Since aria-description is not visible to users, it’s sometimes used to give an element a special accessible description for screen reader users only. Consider if the accessible description provided in the aria-description attribute might be useful to any sighted users. If it is, make the description visible on the page and instead use aria-describedby to reference it.

See https://govtnz.github.io/web-a11y-guidance/ka/fundamental-concepts-in-web-a11y/accessible-names-and-descriptions/accessible-descriptions.html#be-careful-with-aria-description

@dginev
Copy link
Contributor Author

dginev commented Nov 20, 2024

@Steve-Noble and @NSoiffer thank you for the feedback.

I have attempted to do a 3-way synthesis with some extra text in 8a19efb, now also in the preview site.

I have tried to stay away from discussing aria-describedby for now, since I am not sure how to best formulate that some ATs may be limited to only a single <math> element. I think the Web Platform allows for full-document id lookup. It even makes me wonder if MathML Core would want to describe ARIA interplay with different scope than MathML Full would. So I'm deferring on that for now.

@NSoiffer
Copy link
Contributor

@Steve-Noble: the problem with aria-described-by, at least for implementations that use MathCAT, is that the id will be outside of the MathML and so MathCAT can't see it and can't present it to screen reader users. At least that's the case with the current MathCAT. Potentially maybe a new callback function or DOM pointer can be introduced in a new call, but I think that's a lot of complication. It's the reason why @dginev went with aria-description.

@NSoiffer
Copy link
Contributor

I like the new text.

@NSoiffer
Copy link
Contributor

Based on the conversation at today's meeting where no one objected to the text, I'm approving this.

@NSoiffer NSoiffer merged commit 980c186 into w3c:main Nov 21, 2024
1 of 3 checks passed
github-actions bot added a commit that referenced this pull request Nov 21, 2024
SHA: 980c186
Reason: push, by NSoiffer

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify property use as descriptions
3 participants