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

Change markers: add New visual style and remove unnecessary "text semantics" #1481

Merged
merged 5 commits into from
Nov 19, 2024

Conversation

patrickhlauke
Copy link
Member

@patrickhlauke patrickhlauke commented Oct 17, 2020

In WCAG 2.1 there's one change marker for the third note in "Full pages" https://www.w3.org/TR/WCAG21/#cc2 - this currently looks odd/just like an awkward start of the sentence.

WCAG 2.1 third note in 'Full pages', with 'New' at the start of the paragraph looking like it's just part of the sentence

In WCAG 2.2, there's a few more change markers, and these use JavaScript to add "text semantics", wrapping them in square brackets. but these don't - to my mind at least - add anything useful ... they're not read out by default by AT unless you go character by character, and as they just live in their own little paragraph, they don't really need to delimit start/end of anything and are just as understandable without the square brackets.

one of WCAG 2.2's '[New]' change markers

This PR adds a more visually explicit style, and removes the square brackets

WCAG 2.1 third note in 'Full pages', with 'New' at the start of the paragraph, now styled as bold white text on a red box with slightly rounded corners, like a tag/badge

one of WCAG 2.2's 'New' change markers, styled as bold white text on a red box with slightly rounded corners, and without the square brackets around the word

Make it more visually obvious
Not convinced this adds any majorly useful semantics - not read out by AT by default unless you go character by character, and it's not really needed to delimit the change marker which sits in its own little paragraph (i.e. it's not delimiting start/end of a whole section that's changed, or similar)
@patrickhlauke patrickhlauke requested a review from alastc October 17, 2020 11:56
Base automatically changed from master to main March 5, 2021 20:42
@mbgower mbgower added Normative ErratumRaised Potential erratum for a Recommendation and removed Editorial labels Apr 26, 2024
@mbgower
Copy link
Contributor

mbgower commented Apr 26, 2024

I have added an erratum label to this, since despite the fact it is a non-normative change, it is in the TR and therefore will be recorded on the errata page.

@mbgower
Copy link
Contributor

mbgower commented Apr 29, 2024

The "New" was removed from the third note of 5.2.2 Full pages in the September 2023 publish, as shown in this screenshot.
image

It is captured in the errata and change log:

In 5.2.2 Full pages, the third note began with "New" which has been removed.

@mbgower
Copy link
Contributor

mbgower commented Apr 29, 2024

The use of "[New]" now appears in only one location in the September 2023 version of 2.1, immediately under the heading
https://www.w3.org/TR/WCAG21/#input-modalities:

image

It appears in two contexts in the 2.2 TR:

  • each of the nine new Success Criteria
  • each of the six new definitions

Note that the location of this "New" text varies between the definition and the SCs (as well as from where it appears in the 2.1 screenshot above). It immediately follows the level information for the SC:
image
For the definition, it appears underneath the definition term, where it is indented
image

The CSS styling appears to qualify as a level 1 w3c class of change ("No changes to text content: These changes include fixing broken links, style sheets, or invalid markup."), and can be immediately pushed once it meets WG approval.

@patrickhlauke
Copy link
Member Author

Thanks for checking @mbgower

@mbgower
Copy link
Contributor

mbgower commented Apr 29, 2024

@patrickhlauke I just wanted to confirm with you that all 3 different positions of the New 'tag' are supported by your change, and that it can handle both the single occurrence in 2.1 and the 15 additional in 2.2?

@patrickhlauke
Copy link
Member Author

@mbgower yes, the changes in this PR do support them

Lone one in 2.1

screenshot of the single case in 2.1

One of the ones from 2.2

screenshot of one of the 'new' markers in 2.2

@mbgower mbgower changed the title Change markers: add visual style and remove unnecessary "text semantics" Change markers: add New visual style and remove unnecessary "text semantics" Apr 30, 2024
@GrahamTheDevRel
Copy link

GrahamTheDevRel commented May 7, 2024

If we want to meet AAA standards, we could change the red colour to #B50000 - this would meet AAA contrast requirements at all text sizes.

@patrickhlauke
Copy link
Member Author

If we want to meet AAA standards, we could change the red colour to #B50000 - this would meet AAA contrast requirements at all text sizes.

Done.

Preview image:

Success Criterion 2.4.11 Focus Not Obscured (Minimum) (Level AA) New, with the 'New' in white on dark red

@patrickhlauke
Copy link
Member Author

@alastc just checking, what's the status of this?

@iadawn
Copy link
Contributor

iadawn commented Oct 30, 2024

I am slightly averse to using red to highlight something that is new. In the design components for WAI (admittedly not TR space), red is use for a deprecated message. Yellow is used for all other messages. We don't have anything specifically for 'new' - might be worth us thinking about that.

@patrickhlauke
Copy link
Member Author

patrickhlauke commented Oct 30, 2024

Not set on the red. Could use a W3C-blue (#005a9c) for instance

screenshot of the "new" next to 2.4.11, as a blue pill with white text

Copy link

netlify bot commented Oct 30, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit b92fd14
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/67225606afdd2d00087b0415
😎 Deploy Preview https://deploy-preview-1481--wcag2.netlify.app
📱 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 site configuration.

@mbgower mbgower merged commit c050bcc into main Nov 19, 2024
5 checks passed
@mbgower mbgower deleted the patrickhlauke-css-change-tweak branch November 19, 2024 19:58
@iadawn
Copy link
Contributor

iadawn commented Nov 20, 2024

@mbgower NO (sorry, my British 'slightly averse' is really 'I don't like this at all'). Red is not to be used for marking 'new' content. Whilst it is visually salient it is used much more frequently for alerts and errors.

@patrickhlauke
Copy link
Member Author

should i do a follow-up using the blue? i actually agree it might look more appropriate #1481 (comment)

@iadawn
Copy link
Contributor

iadawn commented Nov 20, 2024

That would be great @patrickhlauke. The WAI color palette might give you some other ideas. As long as it is not red ;)

patrickhlauke added a commit that referenced this pull request Nov 20, 2024
@patrickhlauke
Copy link
Member Author

@iadawn #4145

kfranqueiro pushed a commit that referenced this pull request Nov 22, 2024
kfranqueiro pushed a commit that referenced this pull request Dec 18, 2024
…antics" (#1481)

In WCAG 2.1 there's one change marker for the third note in "Full pages"
https://www.w3.org/TR/WCAG21/#cc2 - this currently looks odd/just like
an awkward start of the sentence.

> ![WCAG 2.1 third note in 'Full pages', with 'New' at the start of the
paragraph looking like it's just part of the
sentence](https://user-images.githubusercontent.com/895831/96334873-e2599980-106b-11eb-9d28-775789405927.png)

In WCAG 2.2, there's a few more change markers, and these use JavaScript
to add "text semantics", wrapping them in square brackets. but these
don't - to my mind at least - add anything useful ... they're not read
out by default by AT unless you go character by character, and as they
just live in their own little paragraph, they don't really need to
delimit start/end of anything and are just as understandable without the
square brackets.

> ![one of WCAG 2.2's '[New]' change
markers](https://user-images.githubusercontent.com/895831/96336427-9ca2ce00-1077-11eb-8ca2-f3db0f24bf22.png)

**This PR adds a more visually explicit style, and removes the square
brackets**

![WCAG 2.1 third note in 'Full pages', with 'New' at the start of the
paragraph, now styled as bold white text on a red box with slightly
rounded corners, like a
tag/badge](https://user-images.githubusercontent.com/895831/96336449-c78d2200-1077-11eb-8b8b-47c50ac601a5.png)

![one of WCAG 2.2's 'New' change markers, styled as bold white text on a
red box with slightly rounded corners, and without the square brackets
around the
word](https://user-images.githubusercontent.com/895831/96336471-fefbce80-1077-11eb-8683-00639fc6e18c.png)

(cherry picked from commit c050bcc)
kfranqueiro pushed a commit that referenced this pull request Dec 18, 2024
Instead of the original red - see
#1481 (comment)

(cherry picked from commit 104b82b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants