WordPress.org

Make WordPress Core

Opened 7 months ago

Closed 3 months ago

Last modified 3 months ago

#44955 closed enhancement (fixed)

Add lang attribute to readme.html

Reported by: audrasjb Owned by: audrasjb
Milestone: 5.1 Priority: normal
Severity: normal Version:
Component: Help/About Keywords: has-patch has-dev-note
Focuses: accessibility Cc:

Description

Consider to add lang attribute to the <html> tag in readme.html. Indeed, this is useful for assistive technologies users. It helps to indicate the primary language of the document.

"Language of HTML documents is indicated using a lang attribute (on the HTML element itself), to indicate the primary language of the document, and on individual elements, to indicate a change in language. It provides an explicit indication to user agents about the language of content, so an appropriate language dictionary can be used and, in the case of screen readers and similar assistive technologies with voice output, the content is pronounced using the correct voice / language library."

Source: https://www.w3.org/TR/2017/REC-html51-20171003/dom.html#the-lang-and-xmllang-attributes

Attachments (1)

44955.diff (316 bytes) - added by audrasjb 7 months ago.
Adds lang attribute to readme.html

Download all attachments as: .zip

Change History (16)

@audrasjb
7 months ago

Adds lang attribute to readme.html

#1 @audrasjb
7 months ago

  • Keywords has-patch added

This ticket was mentioned in Slack in #polyglots by johnbillion. View the logs.


7 months ago

#3 @johnbillion
7 months ago

  • Type changed from defect (bug) to enhancement
  • Version trunk deleted

Locales support a custom (ie. translated) readme.html file via the dist directory in i18n.svn.wordpress.org .

There's not much documentation for this apart from https://make.wordpress.org/polyglots/handbook/translating/packaging-localized-wordpress/automated-release-packages/, but this documentation at least will need to be updated to remind translators to change the lang attribute too. There might be some docs elsewhere but I've yet to find it.

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


7 months ago

#5 @afercia
7 months ago

  • Milestone changed from Awaiting Review to 4.9.9
  • Owner set to audrasjb
  • Status changed from new to assigned

#6 @pento
6 months ago

  • Milestone changed from 4.9.9 to 5.0.1

#7 @pento
4 months ago

  • Milestone changed from 5.0.1 to 5.0.2

#8 @pento
4 months ago

  • Milestone changed from 5.0.2 to 5.0.3

#9 @audrasjb
4 months ago

  • Milestone changed from 5.0.3 to 5.1

Hello,

5.0.3 is going to be released in a couple of weeks.

It doesn't appear this ticket can be handled in the next couple of weeks (see comment:3). Let's address it in 5.1 which is coming in February. Feel free to ask for changing the milestone if you think this issue can be quickly resolved.

Cheers,

Jb

Last edited 4 months ago by audrasjb (previous) (diff)

#10 @pento
3 months ago

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

In 44490:

Help/About: Add a lang attribute to the <html> tag in readme.html

Props audrasjb.
Fixes #44955.

#11 follow-up: @pento
3 months ago

@audrasjb: Could you please check in with the polyglots team, and see what needs to be done to ensure localised packages are aware of this change?

#12 in reply to: ↑ 11 @audrasjb
3 months ago

@pento I'll check it today with the polyglots team, thanks.

This ticket was mentioned in Slack in #polyglots by audrasjb. View the logs.


3 months ago

#14 @desrosj
3 months ago

  • Keywords needs-dev-note added

@audrasjb is working on a dev note for this.

#15 @desrosj
3 months ago

  • Keywords has-dev-note added; needs-dev-note removed
Note: See TracTickets for help on using tickets.