Skip to content

Changed notes would benefit from parenthetical "(Modifed)" #699

@bruce-usab

Description

@bruce-usab
Contributor

Almost all notes which are not new either (1) use WCAG 2.2 note verbatim or (2) apply word substitution as described.

A very few notes are rewritten. They are substantively the same, just re-written for the context of WCAG2ICT.

In these case, I suggest that instead of "Note 1" such notes should be written as "Note 1 (modified)" similar to how we have things like "Note 3 (Added)".

I raised this issue on the 19 June call, and PR #632 is an example.

Activity

maryjom

maryjom commented on Jun 19, 2025

@maryjom
Contributor

@bruce-usab Thanks for opening this. Assigning to @daniel-montalvo and myself. Daniel will have to do a change to the classes and document build script to allow us to have a "(Modified)" parenthetic available for use. Then I can add the class to those instances where we replaced the note, specifically to SC 4.1.2, and potentially also to the "accessibility supported" definition where we replaced all 5 notes with a single note (currently marked as "Added").

daniel-montalvo

daniel-montalvo commented on Jun 19, 2025

@daniel-montalvo
Contributor

Thanks @bruce-usab @maryjom

I will be putting together a PR for this. IT still would require a little bit of editorial work to identify which notes we want to mark as "modified" and then add the corresponding class, we can decide as we see the PR in-place.

changed the title [-]Changed notes would benefit from parenthetical[/-] [+]Changed notes would benefit from parenthetical "(Modifed)"[/+] on Jun 19, 2025
daniel-montalvo

daniel-montalvo commented on Jun 20, 2025

@daniel-montalvo
Contributor

Hi @bruce-usab @maryjom

See this pr preview

I've added the logic to treat these "modiified" notes as such.

@bruce-usab let me know if that's what you want and then we'll merge the script updates and probably open another issue for the editorial work to determine which notes will be marked as "modified".

bruce-usab

bruce-usab commented on Jun 21, 2025

@bruce-usab
ContributorAuthor

Thank you @daniel-montalvo , yes that is what I am looking for.

I think any notes where we (quite correctly) purged "must" should also get the (modified) tag. Those are the SC related to non-interference, 1.4.2 - Audio Control, 2.1.2 - No Keyboard Trap, 2.3.1 - Three Flashes or Below Threshold, and 2.2.2 - Pause, Stop, Hide.

bruce-usab

bruce-usab commented on Jun 21, 2025

@bruce-usab
ContributorAuthor

A bit off topic, but related to #680 and #682 is that there are a few more non-normative notes which make use of the word "must":

  • Note 2 of 4.1.1 Parsing
  • Note 1 of accessibility supported in glossary
  • Note 2 of web page in glossary
maryjom

maryjom commented on Jul 7, 2025

@maryjom
Contributor

May want to use "Replaced" rather than "Modified" because we only use this in 2 places where we replaced the notes with a significantly rewritten one.

maryjom

maryjom commented on Jul 7, 2025

@maryjom
Contributor

@daniel-montalvo Please check on whether we have a "replaced" tag to use.

6 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

    Participants

    @maryjom@bruce-usab@daniel-montalvo

    Issue actions

      Changed notes would benefit from parenthetical "(Modifed)" · Issue #699 · w3c/wcag2ict