revise caption definition #1703

scottaohara · 2022-03-12T16:40:30Z

This change in the definition is related to the changes in figure and figcaption in HTML AAM: w3c/html-aam#359 and introduces the idea that a caption may contain structured content - and in this PR - aria-details is referenced as a way authors should reference such content if within a caption

Additionally, this PR extends the definition to allow caption to be used for purposes of naming/describing a group or radiogroup, which fills some gaps from the dropped legend role.

NOTE: label and legend are still listed on the wiki page for role parity. Are these still relevant or not?

If these updates are accepted, this would help pave the way to resolve #1696 as well.

💥 Error: 504 Gateway Time-out 💥

PR Preview failed to build. (Last tried on Apr 28, 2022, 11:53 AM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 Spec Generator - Spec Generator is the web service used to build specs that rely on ReSpec.

🔗 Related URL

<html><body><h1>504 Gateway Time-out</h1>
The server didn't respond in time.
</body></html>

If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.

This change in the definition is related to the changes in `figure` and `figcaption` in HTML AAM: w3c/html-aam#359 and introduces the idea that a `caption` may contain structured content - and in this PR - `aria-details` is referenced as a way authors should reference such content if within a `caption` Additionally, this PR extends the definition to allow `caption` to be used for purposes of naming/describing a `group` or `radiogroup`, which fills some gaps from the dropped `legend` role. If these updates are accepted, this would help pave the way to resolve #1696 as well.

scottaohara · 2022-03-12T16:56:50Z

A question I have is if we need the requirements about where the caption should be placed in these different markup patterns? We had done this to mimic HTML's requirements for their similar elements.... but... hindsight I guess... do we actually need to be as prescriptive here? Especially since these are still being associated via IDs, so it's not actually important where the content is actually placed in the DOM. And if we do re-introduce the idea of named by encapsulation, would being this strict actually be necessary?

this pr updates `aria-details` to mention `figure` and `figcaption`. This update is related to HTML AAM's update to the `figure` and `figcaption` elements - w3c/html-aam#359. It is a follow on to my other PR, #1703 which updates the `caption` role and includes information about `aria-details`.

This PR requires #1703 be merged.

charmarkk

I agree, and editorial looks good. Thanks Scott!

index.html

MelSumner

Thank you for working on this.

index.html

pkra · 2022-04-28T07:23:01Z

A question I have is if we need the requirements about where the caption should be placed in these different markup patterns? We had done this to mimic HTML's requirements for their similar elements.... but... hindsight I guess... do we actually need to be as prescriptive here? Especially since these are still being associated via IDs, so it's not actually important where the content is actually placed in the DOM. And if we do re-introduce the idea of named by encapsulation, would being this strict actually be necessary?

I agree that it seems unnecessary but it's also just a SHOULD statement; I feel like authors should not mind automated checkers questioning their decision a little.

index.html

scottaohara · 2022-04-28T12:22:12Z

I feel like authors should not mind automated checkers questioning their decision a little.

i wish this were the case (i truly do and personally I agree with you here), but reality has shown me that developers will argue against legitimate errors that conformance checkers flag. warnings like this, where changing the markup wouldn't really result in a more accessible experience, only fuel their arguments of whether or not a11y checks actually matter :(

@pkra

SHA: 2d2d341 Reason: push, by @pkra Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

pkra · 2022-04-29T07:13:38Z

@scottaohara I wanted to merge as is since this had plenty of review. Could you propose the looser positioning requirements in a new PR?

scottaohara · 2022-04-29T12:08:11Z

Thanks @pkra. have opened an issue to get a quick discussion on the pathway forward there. Can make a PR based on what people think about that.

pkra · 2022-04-29T12:14:37Z

Thanks, Scott!

* include mention of figure/caption this pr updates `aria-details` to mention `figure` and `figcaption`. This update is related to HTML AAM's update to the `figure` and `figcaption` elements - w3c/html-aam#359. It is a follow on to my other PR, #1703 which updates the `caption` role and includes information about `aria-details`. Co-authored-by: Sarah Higley <smhigley@users.noreply.github.com>

* revise caption definition This change in the definition is related to the changes in `figure` and `figcaption` in HTML AAM: w3c/html-aam#359 and introduces the idea that a `caption` may contain structured content - and in this PR - `aria-details` is referenced as a way authors should reference such content if within a `caption` Additionally, this PR extends the definition to allow `caption` to be used for purposes of naming/describing a `group` or `radiogroup`, which fills some gaps from the dropped `legend` role. If these updates are accepted, this would help pave the way to resolve #1696 as well. * add in missing id to first example * fix spacing issues * include additional example

* update figure role This PR requires #1703 be merged. * Update index.html * revisions per sarah's review * further updates to figure def

* revise caption definition This change in the definition is related to the changes in `figure` and `figcaption` in HTML AAM: w3c/html-aam#359 and introduces the idea that a `caption` may contain structured content - and in this PR - `aria-details` is referenced as a way authors should reference such content if within a `caption` Additionally, this PR extends the definition to allow `caption` to be used for purposes of naming/describing a `group` or `radiogroup`, which fills some gaps from the dropped `legend` role. If these updates are accepted, this would help pave the way to resolve #1696 as well. * add in missing id to first example * fix spacing issues * include additional example

* include mention of figure/caption this pr updates `aria-details` to mention `figure` and `figcaption`. This update is related to HTML AAM's update to the `figure` and `figcaption` elements - w3c/html-aam#359. It is a follow on to my other PR, #1703 which updates the `caption` role and includes information about `aria-details`. Co-authored-by: Sarah Higley <smhigley@users.noreply.github.com>

* update figure role This PR requires #1703 be merged. * Update index.html * revisions per sarah's review * further updates to figure def

scottaohara mentioned this pull request Mar 12, 2022

Change figure & figcaption accName computation w3c/html-aam#359

Closed

7 tasks

add in missing id to first example

40056f3

fix spacing issues

753495c

scottaohara mentioned this pull request Mar 12, 2022

include mention of figure/caption #1704

Merged

scottaohara added a commit that referenced this pull request Mar 12, 2022

update figure role

5a14d4d

This PR requires #1703 be merged.

scottaohara mentioned this pull request Mar 12, 2022

update figure role #1705

Merged

jnurthen requested review from MelSumner, chlane and charmarkk March 24, 2022 17:20

charmarkk approved these changes Mar 31, 2022

View reviewed changes

smhigley reviewed Apr 1, 2022

View reviewed changes

index.html Show resolved Hide resolved

index.html Show resolved Hide resolved

include additional example

4af5c88

scottaohara requested a review from smhigley April 4, 2022 15:06

MelSumner approved these changes Apr 27, 2022

View reviewed changes

pkra reviewed Apr 28, 2022

View reviewed changes

index.html Show resolved Hide resolved

scottaohara commented Apr 28, 2022

View reviewed changes

index.html Outdated Show resolved Hide resolved

index.html Outdated Show resolved Hide resolved

index.html Outdated Show resolved Hide resolved

index.html Outdated Show resolved Hide resolved

scottaohara added 4 commits April 28, 2022 07:51

Update index.html

7a58493

Update index.html

cdc2951

Update index.html

b1e44e3

Update index.html

f570537

smhigley approved these changes Apr 29, 2022

View reviewed changes

pkra added this to the ARIA 1.3 milestone Apr 29, 2022

pkra self-assigned this Apr 29, 2022

pkra merged commit 2d2d341 into main Apr 29, 2022

pkra deleted the revise-caption-definition branch April 29, 2022 07:10

github-actions bot added a commit that referenced this pull request Apr 29, 2022

revise caption definition (#1703)

2ffc69a

SHA: 2d2d341 Reason: push, by @pkra Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

scottaohara mentioned this pull request Apr 29, 2022

Further updates to caption role definition #1734

Closed

pkra pushed a commit that referenced this pull request Sep 1, 2022

update figure role (#1705)

c625cb7

* update figure role This PR requires #1703 be merged. * Update index.html * revisions per sarah's review * further updates to figure def

pkra pushed a commit that referenced this pull request Sep 2, 2022

update figure role (#1705)

8220ef3

* update figure role This PR requires #1703 be merged. * Update index.html * revisions per sarah's review * further updates to figure def

jnurthen pushed a commit that referenced this pull request Oct 10, 2023

update figure role (#1705)

6a8de39

* update figure role This PR requires #1703 be merged. * Update index.html * revisions per sarah's review * further updates to figure def

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

revise caption definition #1703

revise caption definition #1703

scottaohara commented Mar 12, 2022 •

edited by pr-preview bot

Loading

scottaohara commented Mar 12, 2022

charmarkk left a comment

MelSumner left a comment

pkra commented Apr 28, 2022 •

edited

Loading

scottaohara commented Apr 28, 2022

pkra commented Apr 29, 2022

scottaohara commented Apr 29, 2022

pkra commented Apr 29, 2022

revise caption definition #1703

revise caption definition #1703

Conversation

scottaohara commented Mar 12, 2022 • edited by pr-preview bot Loading

💥 Error: 504 Gateway Time-out 💥

scottaohara commented Mar 12, 2022

charmarkk left a comment

Choose a reason for hiding this comment

MelSumner left a comment

Choose a reason for hiding this comment

pkra commented Apr 28, 2022 • edited Loading

scottaohara commented Apr 28, 2022

pkra commented Apr 29, 2022

scottaohara commented Apr 29, 2022

pkra commented Apr 29, 2022

scottaohara commented Mar 12, 2022 •

edited by pr-preview bot

Loading

pkra commented Apr 28, 2022 •

edited

Loading