Mark strings for screen readers

[pavelevap]

Sometimes there are "hidden" strings which are for screen readers, but translators have to search for context to find the real meaning. Maybe we could mark all these strings somehow (comment for translators or context) to make it easier?

I can create patch if you think that it is a good idea (and we can also discuss best solution before: comment or context).

[SergeyBiryukov]

A translator comment sounds like a good idea.

[ocean90]

A translator comment might be helpful, yes.

@swissspidy proposed that this should be added to the handbook (​https://make.wordpress.org/core/handbook/best-practices/internationalization/) and considered for future strings. I tend to agree with that. Any suggestions for a comment?

[Chouby]

A translator comment looks more adapted than context for me. May be useful to add this to ​https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/ to extend the practice to plugins (the same for themes).

[swissspidy]

Replying to ocean90:

A translator comment might be helpful, yes.

@swissspidy proposed that this should be added to the handbook (​https://make.wordpress.org/core/handbook/best-practices/internationalization/) and considered for future strings. I tend to agree with that. Any suggestions for a comment?

What about simply using screen reader text or maybe only visible to screen readers? assistive text for screen readers?

[ocean90]

Replying to swissspidy:

What about simply using screen reader text or maybe only visible to screen readers? assistive text for screen readers?

We already have a few "accessibility text" comments for aria-label placeholders.

[SergeyBiryukov]

Related BuddyPress ticket: ​#BuddyPress6951

[mercime]

First batch of translator comments for accessibility text

[mercime]

Second batch of translator comments for accessibility text

[mercime]

wp-admin - refreshed translator comments

[mercime]

wp-includes - refreshed translator comments

[mercime]

wp-content - refreshed translator comments

[mercime]

Refreshed patches are attached and re-organized as follows for your review:

• 29748-wp-admin.patch
• 29748-wp-includes.patch
• 29748-wp-content.patch

[jipmoors]

Just adding "accessibility text" doesn't really complete clarifying the context for the strings. Especially for "Page" which I saw as a pagination use.

[afercia]

Replying to jipmoors:

Just adding "accessibility text" doesn't really complete clarifying the context for the strings. Especially for "Page" which I saw as a pagination use.

Yep maybe the text could be improved a bit. What translators really need to know? I'd say:

1. it's hidden text, not visible in the UI so better they don't waste time trying to find the place where this text is displayed because... well, it is not displayed at all
2. it is used to expand short labels and sentences to give more context or add feedback where otherwise the feedback is only visual

Anyone able to summarise all this in a very short sentence? :)

[afercia]

Strings used to expand UI controls text and strings used for wp.a11y.speak() messages are a bit different in their scope, but I'd rather keep things simple and use something like hidden accessibility text. Any thoughts welcome!

[SergeyBiryukov]

Replying to afercia:

I'd rather keep things simple and use something like hidden accessibility text.

Seems good to me.