Make WordPress Core

Opened 7 months ago

Closed 3 weeks ago

#59688 closed enhancement (fixed)

Add descriptions to patterns in bundled themes

Reported by: poena's profile poena Owned by: karmatosed's profile karmatosed
Milestone: 6.6 Priority: normal
Severity: normal Version:
Component: Bundled Theme Keywords: good-first-bug has-patch needs-testing
Focuses: accessibility, docs Cc:

Description

Patterns have a parameter called "Description". The description is used in the WordPress interface, to add context for users that can not see or use the pattern preview. For example users of screen readers.

All patterns without the "Inserter" parameter set to "false" or "no", should use the description parameter (These patterns are hidden in the block inserter and do not use the descriptions).

Patterns in bundled themes that are missing descriptions needs to be updated.
Patterns can be registered using the patterns folder or with register_block_pattern() and both type of patterns should be updated.

Attachments (3)

59688.diff (22.2 KB) - added by StringPiggy 6 months ago.
Diff for twentytwentyfour theme
59688.2.diff (22.1 KB) - added by StringPiggy 6 months ago.
Update descriptions for twentytwentyfour
59688.3.diff (23.8 KB) - added by StringPiggy 6 months ago.
Add descriptions for twentytwentythree

Download all attachments as: .zip

Change History (18)

@StringPiggy
6 months ago

Diff for twentytwentyfour theme

#1 @StringPiggy
6 months ago

  • Keywords has-patch needs-testing added

I tested with VoiceOver, would be awesome if can be tested on other screen readers.

@StringPiggy
6 months ago

Update descriptions for twentytwentyfour

#2 @StringPiggy
6 months ago

For the twentytwentytwo theme, I noticed most of the title of the pattern is already descriptive. Would a description still be needed in this case?

@StringPiggy
6 months ago

Add descriptions for twentytwentythree

#3 @oglekler
6 months ago

  • Focuses docs added

#4 @audrasjb
4 months ago

  • Owner set to audrasjb
  • Status changed from new to reviewing

Self assigning for review

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


4 months ago

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


4 months ago

#7 @huzaifaalmesbah
4 months ago

I checked your patch @StringPiggy, I think combine patch good for test and other tasks. can you update?

#8 @StringPiggy
4 months ago

I think combine patch good for test and other tasks. can you update?

Hi @huzaifaalmesbah, apologies for the confusing, as this is one of my first contributions here.

I might have done it in a misunderstanding way, the 59688.3.diff is a full diff (with changes for twentytwentyfour and twentytwentythree theme).

#9 @huzaifaalmesbah
4 months ago

@StringPiggy Sorry for the confusion. This is my mistake. Now I check your patch 59688.3 this for tt4 and tt3.

#10 @swissspidy
3 months ago

  • Milestone changed from 6.5 to 6.6

Punting as 6.5 beta 1 is today, so no more enhancements.

#11 @karmatosed
5 weeks ago

@poena are you happy with the patch here as you were the original creator of this ticket and I want to be sure we are all aligned before moving into commit here. I also feel we might want to answer questions such as:

For the twentytwentytwo theme, I noticed most of the title of the pattern is already descriptive. Would a description still be needed in this case?

#12 @poena
3 weeks ago

No, if the title is descriptive then a second description is not needed.

The descriptions for the "page" patterns are long, but I don't think it can be helped, after all these patterns have a lot of content.
It would be good with a final review from a native English speaker. :)

#13 @karmatosed
3 weeks ago

@poena let me have a look at those and I think we can probably move to commit if you are happy with descriptions and it reads well - which I feel it will.

#14 @karmatosed
3 weeks ago

  • Owner changed from audrasjb to karmatosed

#15 @karmatosed
3 weeks ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 58111:

Bundled Themes: Add descriptions to patterns.

This adds descriptions to multiple bundled themes. All patterns without the "Inserter" parameter set to "false" or "no", should use the description parameter (These patterns are hidden in the block inserter and do not use the descriptions).

Props poena, StringPiggy, oglekler, audrasjb, huzaifaalmesbah, swisspidy.
Fixes #59688.

Note: See TracTickets for help on using tickets.