search

w3c / wcag2ict

WCAG2ICT deliverable of Accessibility Guidelines WG
https://wcag2ict.netlify.app/
Other
18 stars 5 forks source link

4.1.1 Parsing: The WCAG 2.1 version of the SC is not quoted, yet a word substitution is provided for it #424

Open mitchellevan opened 1 month ago

mitchellevan commented 1 month ago

Currently

Here is the simplified structure currently appearing:

Main issue: under "WCAG 2.0 and 2.1 Guidance" it says "This applies directly as written", but there's nothing for "this" to refer to. The WCAG 2.1 version of SC 4.1.1 is not present in the page.

Issue: 4.1.1 in WCAG 2.0 has one note. 4.1.1 in WCAG 2.1 has two notes, which are different from the one in WCAG 2.0. None of these notes appear under "WCAG 2.0 and 2.1 Guidance" in WCAG2ICT, nor are they mentioned in the description of word substitution.

Issue: Everything is under one heading, "4.1.1 Parsing (Obsolete and removed)" which refers only to the WCAG 2.2 version of SC 4.1.1. This heading does not accurately describe the section of content below it. It's confusing (and a failure of WCAG SC 2.4.6 Headings and Labels).

Issue: "WCAG 2.2 Guidance" and "WCAG 2.0 and 2.1 Guidance" function visually as headings but are not marked up as headings.

Issue: Under "WCAG 2.2 Guidance" there is an added "Note 1". Under "WCAG 2.0 and 2.1 Guidance" the note numbering does not restart, but appears as "Note 2... Note 3... Note 4". One could argue this is correct as-is, but to me it feels slightly off.

Proposed

Restructure the section. If it's doesn't blow up the table of contents and the scripts too badly, something like this:

Include a quote of the WCAG 2.1 version of SC 4.1.1 at the appropriate spot in the structure.

In the description of word substitution for WCAG 2.0 and 2.1, say that the Notes for WCAG 2.0 and WCAG 2.1 have been removed. See #434 for an example of how this can be phrased.

maryjom commented 1 month ago

@daniel-montalvo We'll have to work together on this, as some special scripting would be required to fix this as described. It would require a general heading for 4.1.1 Parsing with two sub-headings - one to include the WCAG 2.2 version of 4.1.1 Parsing and one to include the WCAG 2.1 version of 4.1.1 Parsing with both of those headings notated with which version it came from. Since these headings are generated by the scripting, it's a special case from the rest of the includes. Or...we could do this the quick method by copying over the WCAG 2.1 original text into the markdown rather than an include. If we do that, we'll have to verify that the scripting to include WCAG 2.2 version, the note numbering, and the automated heading replacement will work when it's in a heading that's one level deeper.

daniel-montalvo commented 1 month ago

Thanks @maryjom and @mitchellevan

I plan to take a look at this early next week. I'll try first adding a special treatment for WCAG 2.1's 4.1.1 via scripting and if it does not work the nwe can try adding it manually to the markdown, but it would be od.