Skip to content

Make a11y string properly localizable#15161

Merged
pinarol merged 5 commits intomasterfrom
fix/string-concatenation
Apr 25, 2019
Merged

Make a11y string properly localizable#15161
pinarol merged 5 commits intomasterfrom
fix/string-concatenation

Conversation

@swissspidy
Copy link
Copy Markdown
Member

@swissspidy swissspidy commented Apr 24, 2019

Description

Fixes the non-localizable code introduced by #15144.

This is a friendly reminder to think about internationalization best practices :-)

Types of changes

Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.

@swissspidy swissspidy added the Internationalization (i18n) Issues or PRs related to internationalization efforts label Apr 24, 2019
@swissspidy swissspidy mentioned this pull request Apr 24, 2019
Merged
5 tasks
etoledom
etoledom reviewed Apr 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@etoledom etoledom left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @swissspidy for helping us with this improvement!

I wanted to ask if it's possible to use _x() instead of __() to be able to send a more accurate context to the translators, letting them know that this string is intended to be used be the Screen Reader engine.

Something like:
_x( 'Heading block. Level %s. Empty.', 'Spoken out loud by the screen reader' )

@swissspidy
Copy link
Copy Markdown
Member Author

swissspidy commented Apr 25, 2019

In WordPress itself we usually use a /* translators: accessibility text */ comment for that. So perhaps just accessibility text as a context in this case.

@etoledom
Copy link
Copy Markdown
Contributor

etoledom commented Apr 25, 2019

just accessibility text as a context in this case

That sounds great! Thank you 🙏

@gziolo gziolo added the Mobile App - i.e. Android or iOS Native mobile impl of the block editor. (Note: used in scripts, ping mobile folks to change) label Apr 25, 2019
@pinarol pinarol self-requested a review April 25, 2019 10:44
@pinarol pinarol self-assigned this Apr 25, 2019
pinarol
pinarol approved these changes Apr 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@pinarol pinarol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this on iOS and it works OK.

Tug
Tug reviewed Apr 25, 2019
View reviewed changes
@pinarol
Copy link
Copy Markdown
Contributor

pinarol commented Apr 25, 2019

hey @Tug 👋 I updated the position of translator comments

Tug
Tug approved these changes Apr 25, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@Tug Tug left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@pinarol pinarol merged commit da09d36 into master Apr 25, 2019
@pinarol pinarol deleted the fix/string-concatenation branch April 25, 2019 13:45
@pinarol pinarol mentioned this pull request Apr 25, 2019
Merged
5 tasks
This was referenced Apr 29, 2019
Merged
Merged
hypest pushed a commit that referenced this pull request May 2, 2019
@swissspidy @hypest
Make a11y string properly localizable (#15161)
f70fceb 
* Make a11y string properly localizable

* Remove extra . after the content

* Add `accessibility text` to the translators comment

* Fix the wrong parameter

* Change the position of translator comments
@youknowriad youknowriad added this to the 5.6 (Gutenberg) milestone May 13, 2019
This was referenced Sep 12, 2024
Open
Open
Open
@AKJUS AKJUS mentioned this pull request Sep 19, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pinarol pinarol pinarol approved these changes

@etoledom etoledom etoledom left review comments

@Tug Tug Tug approved these changes

Assignees

@pinarol pinarol

Labels

Internationalization (i18n) Issues or PRs related to internationalization efforts Mobile App - i.e. Android or iOS Native mobile impl of the block editor. (Note: used in scripts, ping mobile folks to change)

Projects

None yet

Milestone

5.6 (Gutenberg)

Development

Successfully merging this pull request may close these issues.

6 participants

@swissspidy @etoledom @pinarol @Tug @youknowriad @gziolo