Skip to content

Fix note structure in abbreviation definition#4452

Merged
mbgower merged 4 commits intomainfrom
kgf-abbreviation-nested-note
Oct 28, 2025
Merged

Fix note structure in abbreviation definition#4452
mbgower merged 4 commits intomainfrom
kgf-abbreviation-nested-note

Conversation

@kfranqueiro
Copy link
Copy Markdown
Contributor

@kfranqueiro kfranqueiro commented Jun 16, 2025

Fixes #4436.

This fixes the markup for the first top-level note in the abbreviations definition to use a div, so that it can properly wrap the ordered list that is supposed to exist inside of it (as it did in WCAG 2.0).

This also relegates the nested note to an inline annotation in a paragraph (suggested by Alastair), to avoid needing to worry about an unimplemented nesting edge case.

The diff will be easier to view with whitespace ignored (?w=1).

@netlify /guidelines/#dfn-abbreviations

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 16, 2025

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit 30255b7
🔍 Latest deploy log https://app.netlify.com/projects/wcag2/deploys/690131f6e9b617000938f864
😎 Deploy Preview https://deploy-preview-4452--wcag2.netlify.app/guidelines/#dfn-abbreviations
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@mbgower mbgower added ErratumRaised Potential erratum for a Recommendation Non-Normative Informative language in the specification or supporting materials Glossary labels Jun 20, 2025
@mbgower
Copy link
Copy Markdown
Contributor

mbgower commented Jul 15, 2025

@alastc out of an abundance of caution, I am putting this into the quarterly errata column, pending a discussion with you.
We are making no normative change here -- it is all in Notes, and we've established those were properly formatted notes in 2.0.
But since it will be listed in the errata document (according to the table we have in https://github.com/w3c/wcag/wiki/WCAG-2-Task-Force-process#Errata-changes) I think it makes sense to include in the quarterly.

@bruce-usab
Copy link
Copy Markdown
Contributor

bruce-usab commented Jul 18, 2025

@alastc alastc mentioned this pull request Oct 6, 2025
@mbgower mbgower merged commit 172fe84 into main Oct 28, 2025
7 checks passed
@mbgower mbgower deleted the kgf-abbreviation-nested-note branch October 28, 2025 21:14
kfranqueiro added a commit that referenced this pull request Oct 29, 2025
Fixes #4436.

This fixes the markup for the first top-level note in the abbreviations
definition to use a `div`, so that it can properly wrap the ordered list
that is supposed to exist inside of it (as it did in [WCAG
2.0](https://www.w3.org/TR/WCAG20/#abbreviationsdef)).

This also relegates the nested note to an inline annotation in a
paragraph (suggested by Alastair), to avoid needing to worry about an
unimplemented nesting edge case.

The diff will be easier to view with whitespace ignored (`?w=1`).

@netlify /guidelines/#dfn-abbreviations

Co-authored-by: Patrick H. Lauke <redux@splintered.co.uk>
Co-authored-by: Mike Gower <mikegower@gmail.com>
(cherry picked from commit 172fe84)
kfranqueiro added a commit that referenced this pull request Oct 31, 2025
Fixes #4436.

This fixes the markup for the first top-level note in the abbreviations
definition to use a `div`, so that it can properly wrap the ordered list
that is supposed to exist inside of it (as it did in [WCAG
2.0](https://www.w3.org/TR/WCAG20/#abbreviationsdef)).

This also relegates the nested note to an inline annotation in a
paragraph (suggested by Alastair), to avoid needing to worry about an
unimplemented nesting edge case.

The diff will be easier to view with whitespace ignored (`?w=1`).

@netlify /guidelines/#dfn-abbreviations

Co-authored-by: Patrick H. Lauke <redux@splintered.co.uk>
Co-authored-by: Mike Gower <mikegower@gmail.com>
(cherry picked from commit 172fe84)
mbgower added a commit that referenced this pull request Oct 31, 2025
Updates the errata documents for 2.2 and 2.1 to list the 6 new editorial
changes held for the quarterly update.

These are:
- Rewording the normative preamble of Content on Hover or Focus for
clarity ([#4469](#4469))
- Changing occurrences of "e-mail" to "email"
([#4385](#4385))
- Removing use of "must" in section 7 preamble
([#4458](#4458))
- Fixing the markup for the notes in the "abbreviation" definition
([#4452](#4452))
- Changing capitalized occurrences of "Web" and "Success Criteria" to
match the established lower-case style
([#4461](#4461))
- Restyling the boxed links for the Understanding and How to Meet...
documents ([#4590](#4590))

---------

Co-authored-by: Kenneth G. Franqueiro <kfranqueiro@users.noreply.github.com>
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 Glossary Non-Normative Informative language in the specification or supporting materials

4 participants