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

Update mention of "list" to "list item" in programmatically-determine… #3362

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Aug 25, 2023

closes #3361

updates the term example to mention "list item" instead of "list" to be more accurate to what the intent of that likely was trying to convey.

Additionally, links to the HTML term of 'paragraph', which I would submit could resolve issues such as #2109


Preview | Diff

…d-link-context.html

closes #3361

updates the term example to mention "list item" instead of "list" to be more accurate to what the intent of that likely was trying to convey.

Additionally, links to the HTML term of 'paragraph', which I would submit could resolve issues such as #2109
@alastc alastc added ErratumRaised Potential erratum for a Recommendation WCAG 2.0 Normative labels Aug 30, 2023
Copy link
Contributor

@bruce-usab bruce-usab left a comment

Choose a reason for hiding this comment

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

Thanks for circling back to this detail.

@bruce-usab bruce-usab assigned bruce-usab and unassigned bruce-usab Jan 19, 2024
@scottaohara scottaohara self-assigned this Feb 23, 2024
@bruce-usab
Copy link
Contributor

Discussed on Friday call and status changed to Errata for CFC.

Comment on lines +8 to +9
includes text that is in the same <a href="https://html.spec.whatwg.org/multipage/dom.html#paragraph">paragraph</a>,
list item, or table cell as the link or in a table header cell that is associated with the table cell that contains the link.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think WCAG should link to an evergreen HTML spec. These links can and do change. We shouldn't put ourselves in a position where we have to republish WCAG because WHATWG updated a definition.

Copy link
Contributor

Choose a reason for hiding this comment

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

The link has been stable for 10 years, and if the paragraph in HTML were tweaked, wouldn't we want to use the updated version?

Copy link
Contributor

Choose a reason for hiding this comment

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

The problem isn't the definition changing. It's the link changing. WHATWG makes no guarantee about the location of their definitions never changing. ACT has had to update rules because HTML definitions were moved. It happens. That's an easy fix when this is in an understanding document. Not so much for a normative document. This isn't the first link to WHATWG in WCAG, but the more we do this, the greater the chance of a broken in the spec at some point in the future.

Copy link
Member Author

Choose a reason for hiding this comment

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

the html standard is evergreen. you can point to a snapshot of it, but you'll get a message like this:

This document contains the contents of the standard as of the 9025fb30a05b2275016909bc782925d2855a9a03 commit, and should only be used as a historical reference. This commit may not even have been merged into the main branch.

Do not attempt to implement this version of the standard. Do not reference this version as authoritative in any way. Instead, see https://html.spec.whatwg.org/ for the living standard.

this seems worse to me than linking to the actual specification. more and more w3c specs are also becoming living standards. it seems maybe a conversation between the spec editors to make sure links can remain stable is a potential avenue to consider, rather than not linking to the HTML spec.?

Copy link
Contributor

@mbgower mbgower Nov 5, 2024

Choose a reason for hiding this comment

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

@WilcoFiers the link was added in direct response to #2109.

As you've pointed out, we already have links to the spec elsewhere, and as Alastair points out, this has been stable for 10 years.

In the unlikely event this link changes, the class of change required to fix a broken link is the least impactful editorial change:

No changes to text content
These changes include fixing broken links, style sheets, or invalid markup.

The WCAG 2 Task Force has a plan of an annual republish to incorporate errata (the current CFC is the first of those).

Given all these considerations, can you live with including the link?

Copy link
Contributor

@WilcoFiers WilcoFiers Nov 11, 2024

Choose a reason for hiding this comment

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

No I don't think this works. I for one intend to object to any proposal that would result in having to update the million copies of WCAG annually. I'm not going to count on that for a solution. I think an agreement with WHATWG that certain links will never be changed could work, but such an agreement doesn't exist.

Probably the easiest solution would be for this to link to a W3C page that redirects to WHATWG. If the URL ever changes, updated where the redirect goes. That can be done without any change to WCAG.

Copy link
Contributor

Choose a reason for hiding this comment

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

@WilcoFiers To fix a link we could do an in-place change. This would not result in a change to the date of the document. There would be a note included in the Status section of the doc and the document title would get an addition to note the change. In terms of Process this is not arduous. Given the low likelihood of the WHATWG URI changing would this be acceptable?

Your idea for having a redirect is technically feasible. I would need to check what Webmaster would say about that since it is allowing for a change in a REC document without the change being documented in the document. Basically, in-place change without the Status note.

Copy link
Contributor

Choose a reason for hiding this comment

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

@iadawn Linking to an evergreen spec always comes with the risk of an undocumented change. I think that's okay for an example. I think a redirect is a better solution here, since this note is going to end up being copied, link and all, into other places. With a redirect you prefer those copies from having issues too.

@mbgower mbgower merged commit 3d88e14 into main Nov 19, 2024
@mbgower mbgower deleted the so-3361 branch November 19, 2024 19:59
kfranqueiro pushed a commit that referenced this pull request Dec 18, 2024
#3362)

closes #3361

updates the term example to mention "list item" instead of "list" to be
more accurate to what the intent of that likely was trying to convey.

Additionally, links to the HTML term of 'paragraph', which I would
submit could resolve issues such as #2109

<!--
    This comment and the below content is programmatically generated.
    You may add a comma-separated list of anchors you'd like a
    direct link to below (e.g. #idl-serializers, #idl-sequence):

    Don't remove this comment or modify anything below this line.
    If you don't want a preview generated for this pull request,
    just replace the whole of this comment's content by "no preview"
    and remove what's below.
-->
***
<a href="https://pr-preview.s3.amazonaws.com/w3c/wcag/pull/3362.html"
title="Last updated on Aug 25, 2023, 7:14 PM UTC (44450fb)">Preview</a>
| <a
href="https://pr-preview.s3.amazonaws.com/w3c/wcag/3362/6b2b211...44450fb.html"
title="Last updated on Aug 25, 2023, 7:14 PM UTC (44450fb)">Diff</a>

(cherry picked from commit 3d88e14)
kfranqueiro pushed a commit that referenced this pull request Dec 18, 2024
#3362)

closes #3361

updates the term example to mention "list item" instead of "list" to be
more accurate to what the intent of that likely was trying to convey.

Additionally, links to the HTML term of 'paragraph', which I would
submit could resolve issues such as #2109

<!--
    This comment and the below content is programmatically generated.
    You may add a comma-separated list of anchors you'd like a
    direct link to below (e.g. #idl-serializers, #idl-sequence):

    Don't remove this comment or modify anything below this line.
    If you don't want a preview generated for this pull request,
    just replace the whole of this comment's content by "no preview"
    and remove what's below.
-->
***
<a href="https://pr-preview.s3.amazonaws.com/w3c/wcag/pull/3362.html"
title="Last updated on Aug 25, 2023, 7:14 PM UTC (44450fb)">Preview</a>
| <a
href="https://pr-preview.s3.amazonaws.com/w3c/wcag/3362/6b2b211...44450fb.html"
title="Last updated on Aug 25, 2023, 7:14 PM UTC (44450fb)">Diff</a>

(cherry picked from commit 3d88e14)
kfranqueiro pushed a commit that referenced this pull request Dec 19, 2024
#3362)

closes #3361

updates the term example to mention "list item" instead of "list" to be
more accurate to what the intent of that likely was trying to convey.

Additionally, links to the HTML term of 'paragraph', which I would
submit could resolve issues such as #2109

<!--
    This comment and the below content is programmatically generated.
    You may add a comma-separated list of anchors you'd like a
    direct link to below (e.g. #idl-serializers, #idl-sequence):

    Don't remove this comment or modify anything below this line.
    If you don't want a preview generated for this pull request,
    just replace the whole of this comment's content by "no preview"
    and remove what's below.
-->
***
<a href="https://pr-preview.s3.amazonaws.com/w3c/wcag/pull/3362.html"
title="Last updated on Aug 25, 2023, 7:14 PM UTC (44450fb)">Preview</a>
| <a
href="https://pr-preview.s3.amazonaws.com/w3c/wcag/3362/6b2b211...44450fb.html"
title="Last updated on Aug 25, 2023, 7:14 PM UTC (44450fb)">Diff</a>

(cherry picked from commit 3d88e14)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ErratumRaised Potential erratum for a Recommendation Normative WCAG 2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarity for programmatically determined link context term example
6 participants