Tutorial - Common APIs - Internationalisation

[jonathanbossenger]

Topic Description

Internationalization is the process of developing your application in a way that can easily be translated into other languages, which is known as localization. In this tutorial, you will learn why Internationalization is important, and how to implement it in your WordPress plugin or theme.

Related Resources

Links to related content on Learn, HelpHub, DevHub, GitHub Gutenberg Issues, DevNotes, etc.

• Online Workshop
• Documentation

Guidelines

Review the team guidelines

Tutorial Development Checklist

• Vetted by instructional designers for content idea
• Provide feedback of the idea
• Gather links to Support and Developer Docs
• Review any related material on Learn
• Define several SEO keywords to use in the article and where they should be prominently used
• Description and Objectives finalized
• Tutorial created and announced to the team for Q/A review
• Tutorial reviewed and ready to publish
• Tutorial submitted and published to WPTV
• Tutorial published on WPTV
• Tutorial captioned
• Tutorial created on Learn.WordPress.org
• Tutorial post reviewed for grammar, spelling, etc.
• Tutorial published on Learn.WordPress.org
• Tutorial announced to Marketing Team for promotion

[jonathanbossenger]

WIP Script: https://github.com/jonathanbossenger/wp-content/blob/main/tutorials/common-apis-internationalisation.md

[jonathanbossenger]

Video for review:

common-apis-internationalization.mp4

[github-actions]

This content is ready to be reviewed. Please follow the steps listed under Guidelines for reviewing content. Thank you for your contribution! ✨

[justintadlock]

Hi, @jonathanbossenger. I just had a few notes:

00:34 - "118n" should be spelled "i18n" in the slide.

Not sure if it's worth changing, but the official theme directory would require that you use twenty-twenty-three-child for your text domain. The default Twenty* themes are the only exceptions to this rule for legacy reasons.

5:30 - esc_html_e() would be required for the DotOrg theme directory for this in particular, but I understand that you're walking through the basic functions and not diving into the escaping functions.

[jonathanbossenger]

Thanks for the feedback @justintadlock, I especially appreciate the notes from the point of view of the .org theme directory. I'll incorporate them into my tutorial.

[peiraisotta]

Tutorial Review Checklist

Please tick all items you've confirmed:

• Learning outcomes/objectives are clear.

• Technical concepts introduced in the content are accurate.

• The speed of demonstrations are easy to follow.

• The narration audio matches what is shown visually.

• Spelling and grammar are correct.

• Sound quality is consistent throughout the video.

• Brand Usage Guidelines and Promotional Guidelines are being followed.

• Media assets are all in the public domain (CC0).

• At min 0:33 instead of i18n it's written 118n

• "A disclaimer must be added to the content that any brand/product/service mentioned is considered a suggestion and not an endorsement." In this tutorial, 3 translation plugins were used as examples, but there wasn't a clear disclaimer.

• " Technical concepts introduced in the content are accurate." I don't have the technical knowledge to judge this point.

• "Media assets are all in the public domain " I don't understand this point.

• One more thought: I've noticed that in this other tutorial the video ends with a last slide inviting to visit Learn WordPress and here there is not. In my opinion, it would be nice and consistent if all tutorials end in the same/similar way with the same slide.

[jonathanbossenger]

Thanks for the feedback @peiraisotta

In this tutorial, 3 translation plugins were used as examples, but there wasn't a clear disclaimer.
In the past whenever we mention free products in the WordPress plugin or theme repository, this typically isn't required. This guideline is aimed more at folks who might benefit from endorsing a specific product.

Media assets are all in the public domain
This just means that if I'm using any images or videos in the tutorial, they must not be copyright material. As I'm not using any images or videos, this doesn't apply. 😃

it would be nice and consistent if all tutorials end in the same/similar way with the same slide.
That's an interesting point, because generally these videos are hosted/viewed on Learn.WordPress.org, so it always seems weird to me to tell folks to visit a site they are already on 😁 But I will raise it with the team at the next meeting for discussion.

[jonathanbossenger]

https://wordpress.tv/2023/10/27/common-apis-internationalization/