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

Support aria-description #69

Merged
merged 19 commits into from Nov 28, 2022
Merged

Support aria-description #69

merged 19 commits into from Nov 28, 2022

Conversation

aleventhal
Copy link
Contributor

@aleventhal aleventhal commented Jan 14, 2020

Closes issue #68 and issue #77

Testing whether editing this comment triggers pr-preview.
Yay! It does! 🎉

Editing comment again now to add #mapping_additional_nd_description in-page anchor for preview.


Preview | Diff


Preview | Diff

index.html Outdated Show resolved Hide resolved
Co-Authored-By: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
Copy link
Contributor

@carmacleod carmacleod left a comment

Choose a reason for hiding this comment

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

+1

@aleventhal
Copy link
Contributor Author

@joanmarie what are the next steps for this one?

@joanmarie
Copy link
Contributor

@joanmarie what are the next steps for this one?

Group review, including from @accdc who is taking the lead on this spec.

index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@joanmarie joanmarie left a comment

Choose a reason for hiding this comment

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

Shouldn't there also be a change in the algorithm found in https://w3c.github.io/accname/#mapping_additional_nd_te? Compare with what's there for name computation, in particular: 2B addresses name when there is an aria-labelledby. 2C addresses name when there is aria-label.

@aleventhal
Copy link
Contributor Author

Hi @joanmarie, there should not be a change to the algorithm. When aria-describedby is used, it uses the name algorithm as it stands now to get the text. That algorithm does not consider description markup, it only returns the primary text.

When aria-describedby is not used, then aria-description can be used to set the description. However, aria-description does not affect the recursive algorithm, whether it's used for name or description.

@joanmarie
Copy link
Contributor

Ok.... Though I still think it's odd that the algorithm for computing the name and description lacks any mention of aria-description. If no one else thinks so.... 🤷‍♀️

@aleventhal
Copy link
Contributor Author

Ok.... Though I still think it's odd that the algorithm for computing the name and description lacks any mention of aria-description. If no one else thinks so....

As it stands, we have these 3 headings, which is confusing already:
Accessible Name Computation
Accessible Description Computation (which mentions aria-description)
Accessible Name and Description Computation (reused by the others)

IMO the overlap between these names is kind of confusing already. The last one could be renamed "Primary Text for a Subtree Computation". Then the first two would explain that the Primary Text for a Subtree is used for aria-labelledby and aria-describedby.

But it doesn't make sense to mention aria-description in that Primary Text Computation, because that would change the way aria-description works, which is not desired.

@JAWS-test
Copy link

See also #77

@joanmarie joanmarie requested review from joanmarie and carmacleod and removed request for joanmarie February 27, 2020 18:21
@css-meeting-bot
Copy link
Member

The ARIA Working Group just discussed aria-description.

The full IRC log of that discussion <carmacleod> TOPIC: aria-description
<carmacleod> github: https://github.com//pull/69
<carmacleod> joanie: a bit weird that aria-description is not in Name & Description computation
<jamesn> q+
<carmacleod> aaronlev: confusing to have sections names "Name", "Description", and "Name & Description" - need to have a new name, maybe "Primary Text Computation"
<carmacleod> ack jamesn
<aaronlev> 1. Change third item to be "Primary text computation"
<aaronlev> 2. Change description computation to add all the attributes that might be used
<aaronlev> 3. Change primary text computation to be modeless in terms of what it's being used for
<aaronlev> Item 2 would include add aria-description
<aaronlev> ^ my proposal for 13
<aaronlev> ^ my proposal for 1.3
<carmacleod> jamesn: can we add pr-preview to the accname repo?
<carmacleod> MichaelC: yes - I'll do that
<carmacleod> carmacleod: I think I have a pr for that
<MarkMccarthy> s/^ my proposal for 13
<carmacleod> jamesn: need a preview to look at this
<MarkMccarthy> s/^ my proposal for 13/
<carmacleod> mck: how about using the name "Text Content Computation"? instead of "Primary..."
<carmacleod> aaronlev: I like that name. "Text Content Computation"
<carmacleod> aaronlev: how about if I just expand the current pr to add this?
<carmacleod> zakim, next item
<Zakim> agendum 4. "meter role should have optional aria-valuemin/max with defaults" taken up [from jamesn]
<jamesn> https://github.com/w3c/aria/issues/1123

@carmacleod
Copy link
Contributor

@aleventhal Notes from the meeting bot:

aaronlev: I like that name. "Text Content Computation"
aaronlev: how about if I just expand the current pr to add this?

There was general agreement (not in the notes because the scribe was lagging behind... 😄 ).

aleventhal and others added 5 commits March 3, 2020 10:36
Co-Authored-By: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com>
1. Changes "4.3 Name and Description Computation" to "4.3 Text Content
Computation", to be reused by the "4.1 Name Computation" and
"4.2 Description Computation".
2. Change Text Content Computation to be modeless in terms of what it's being
used for, in other words remove phrases like "if computing accessible name".
3. Change description computation to add all the attributes that might be used,
in precedence order, and format it in an easy-to-read table.
@aleventhal
Copy link
Contributor Author

I think this is is a step in the right direction, but doesn't solve everything.

In the table, I mention all relevant HTML markup, because currently I think the spec dances around HTML markup, yet seems to desperately want to mention it. HTML should be treated as a first class citizen by this spec, maybe even SVG too. Otherwise it's hard to define an order of markup precedence, let alone which markup should be processed. Getting names and descriptions right in HTML is too important to just hand wave around this.

@accdc
Copy link
Contributor

accdc commented Mar 4, 2020

Hi, I think this is a great step in the right direction. Please merge if you will. We will continue working on the rest as well after.

@JAWS-test
Copy link

@aleventhal, many thanks for the comprehensive revision. I think it removes all the ambiguities and errors that were previously contained. In the preview, there is only one problem with the numbering of the list items: instead of letters, numbers are used, so that the references (e.g. "2F.i") no longer work. But maybe this is just a CSS problem of the preview.

The table for description is very good. I just think the first column header is wrong (it should be "precedence" instead of "predence", right?)

@aleventhal
Copy link
Contributor Author

@accdc I'm not authorized to merge, unfortunately. Do you want to authorize me or merge?

@accdc
Copy link
Contributor

accdc commented Sep 8, 2022

I'm never going to be as good with github as others here, so if you or Melanie could help with this I'd appreciate it.

@cookiecrook cookiecrook self-assigned this Sep 29, 2022
@cookiecrook
Copy link
Contributor

From call: Dependent on #433? @scottaohara

cookiecrook and others added 2 commits September 29, 2022 11:58
Committing some diffs from prior review (with editor's and WG's blessing)
@jnurthen jnurthen marked this pull request as draft October 6, 2022 17:46
index.html Outdated Show resolved Hide resolved
@scottaohara scottaohara self-assigned this Oct 27, 2022
Remove specific references to the unique HTML elements from the table.  Replaced these rows with a new row indicating there may be host language features which participating in the description computation, and to look at HTML AAM for the elements which are applicable.
scottaohara added a commit to w3c/html-aam that referenced this pull request Oct 28, 2022
This PR is necessary to fully address the needs of the accName PR - w3c/accname#69

- New language has been added to the introduction of this section, better aligning it with the normative text of accName's new 4.2 section.
- cut down item 1 the text was redundant per the new language added to the introduction of the section.
- Modified each of the section 2 items to align with the accName table column "how to compute description".
- Revised the final item (4) to align with the accName normative text, and the revised introduction of this section, stating that UAs are even expected to return an empty description.
@scottaohara scottaohara marked this pull request as ready for review October 28, 2022 13:51
@mcking65
Copy link

mcking65 commented Nov 3, 2022

Do we intend the aria-description value on an element to be able to be included in its description by a self-reference in the value of aria-describedby?

If so, that does not appear to be supported by the current definition of aria-describedby computation.

If not, we may want to make that constraint more clear. It would make the behavior of aria-describedby slightly different from the behavior of aria-labelledby.

@JAWS-test
Copy link

Do we intend the aria-description value on an element to be able to be included in its description by a self-reference in the value of aria-describedby?

I don't think that makes sense. If elements are referenced by aria-describedby, then their AccName is relevant and not their AccDesc. I.e. the AccName of an element becomes the AccDesc of the element which is referred to by aria-describedby. The AccDesc of an element does not matter (whether via title, aria-description or any other method) if the element is referenced via aria-describedby.

index.html Outdated Show resolved Hide resolved
scottaohara and others added 2 commits November 10, 2022 15:35
Co-authored-by: James Craig <cookiecrook@users.noreply.github.com>
@MelSumner MelSumner removed the Agenda label Nov 28, 2022
@MelSumner MelSumner merged commit 81361ec into main Nov 28, 2022
github-actions bot added a commit that referenced this pull request Nov 28, 2022
SHA: 81361ec
Reason: push, by MelSumner

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.

None yet