Siobhan 1:28 pm on October 15, 2013

Hey hey Polyglotters I have a question from…

Hey hey Polyglotters!

I have a question from the docs team. Should all code examples in the codex and other official WP documentation be internationalized? There’s a strong case for it as many people just cut and paste code examples and then we end up with untranslatable stringsString A string is a translatable part of the software. A translation consists of a multitude of localized strings..

Anyhow, please let me know if you have any comments here, or please come to our chat on Thursday October 17th at 16:00 UTC in #wordpress-sfd

Thanks!

Marko Heijnen 1:31 pm on October 15, 2013

They should but the problem is that most developers don’t understand what those functions really do.
This also reminds me that I still need to revert a change on https://codex.wordpress.org/Function_Reference/register_post_type.
- Chantal Coolsma 1:31 pm on October 15, 2013
  
  Agree
- Siobhan 1:32 pm on October 15, 2013
  
  Out of curiosity, which change are you reverting and why?
  - toscho 1:34 pm on October 15, 2013
    
    This edit reverted the translation of custom post typeCustom Post Type WordPress can hold and display many different types of content. A single item of such a content is generally called a post, although post is also a specific post type. Custom Post Types gives your site the ability to have templated posts, to simplify the concept. stringsString A string is a translatable part of the software. A translation consists of a multitude of localized strings..
Andrew Nacin 1:44 pm on October 15, 2013
The two primary issues with internationalizing code examples is:
- It increases the barrier to entry, as any understanding of any code example requires one to understand internationalizationInternationalization Internationalization (sometimes shortened to I18N , meaning “I - eighteen letters -N”) is the process of planning and implementing products and services so that they can easily be adapted to specific local languages and cultures, a process called localization. This is the process of making software translatable. Information about Internationalization for developers can be found in the Developer’s handbooks., which in most situations is not a requirement for their simplistic, non-distributed, English-only usage.
- Just using the internationalization function doesn’t internationalize the code. They still need to have a proper text domain and actually load that text domain, and be using this code in a pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party or theme they are going to release through WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/, or otherwise work with translators. Using the proper functions is “nice” but it is arguably a disservice.
- Remkus de Vries 1:52 pm on October 15, 2013
  
  As much as I would like to disagree I do agree with your valid points. However, when displaying generic code it would be nice to have a default link to the Codex entry about internationalizationInternationalization Internationalization (sometimes shortened to I18N , meaning “I - eighteen letters -N”) is the process of planning and implementing products and services so that they can easily be adapted to specific local languages and cultures, a process called localization. This is the process of making software translatable. Information about Internationalization for developers can be found in the Developer’s handbooks..
- toscho 2:34 pm on October 15, 2013
  
  I have to support the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party Multilingual Press, and one common request is the translation of Custom Post TypeCustom Post Type WordPress can hold and display many different types of content. A single item of such a content is generally called a post, although post is also a specific post type. Custom Post Types gives your site the ability to have templated posts, to simplify the concept./TaxonomyTaxonomy A taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. properties. But this is the responsibility of the authors, not of our plugin. Unfortunately, most (new) developers just copy and paste Codex examples.
  
  All I can say to these authors right now is: Please ignore the Codex, the examples are wrong for distributed code. This is not good.
  
  It wouldn’t raise the barrier too much to create correct examples. We could use the stringString A string is a translatable part of the software. A translation consists of a multitude of localized strings. insert_your_textdomain as text domain and add a link to the example. But the code should be translatable from the start.
Xavier Borderie 2:21 pm on October 15, 2013

No, because of what Andrew said.

That being said, every code sample with stringsString A string is a translatable part of the software. A translation consists of a multitude of localized strings. should have a line at the bottom saying, more or less, “Code is simplified for readability reasons. Product code should have all the strings internationalized“.
- Xavier Borderie 2:21 pm on October 15, 2013
  
  Ahem, “Production code”.
- swissspidy 2:31 pm on October 15, 2013
  
  Agree with that that one. It just should be obvious enough to not miss it.
- Naoko Takano 2:39 am on October 16, 2013
  
  This sounds like a good compromise.
Stefano Aglietti 5:20 pm on October 15, 2013

No, the scope of code in codex page is to acts as a tutorial, for italian pages i’m usually translate comments and sometimes variable names if the meanings of them need to be render in italian. Adding I18NInternationalization Internationalization (sometimes shortened to I18N , meaning “I - eighteen letters -N”) is the process of planning and implementing products and services so that they can easily be adapted to specific local languages and cultures, a process called localization. This is the process of making software translatable. Information about Internationalization for developers can be found in the Developer’s handbooks. is as Andrew says mor bad than good and fragment of code need to be tedomained too ecc. Like the Xavier’s idea to add a note at the end of code fragments
- Marko Heijnen 10:20 am on October 18, 2013
  
  If the scope of codex is to act as a tutorial. Shouldn’t it do I18NInternationalization Internationalization (sometimes shortened to I18N , meaning “I - eighteen letters -N”) is the process of planning and implementing products and services so that they can easily be adapted to specific local languages and cultures, a process called localization. This is the process of making software translatable. Information about Internationalization for developers can be found in the Developer’s handbooks. then too. Otherwise the tutorial isn’t complete. Codex is to learn things what you need and I18N is a must to do things good.
  - Siobhan 11:29 am on October 18, 2013
    
    Although there are pages of the Codex that function as tutorials, overall it is a reference – i.e. it’s for looking for specific things that you need to know. The handbooks will be more of a tutorial and i18nInternationalization Internationalization (sometimes shortened to I18N , meaning “I - eighteen letters -N”) is the process of planning and implementing products and services so that they can easily be adapted to specific local languages and cultures, a process called localization. This is the process of making software translatable. Information about Internationalization for developers can be found in the Developer’s handbooks. are being built into it.
Ulrich 8:42 pm on October 15, 2013
The reasons why the stringsString A string is a translatable part of the software. A translation consists of a multitude of localized strings. should be internationalized.
- Most examples will be copied and pasted
- InternationalizationInternationalization Internationalization (sometimes shortened to I18N , meaning “I - eighteen letters -N”) is the process of planning and implementing products and services so that they can easily be adapted to specific local languages and cultures, a process called localization. This is the process of making software translatable. Information about Internationalization for developers can be found in the Developer’s handbooks. is an important part the code.
- It is a hassle to internationalize all strings at a later stage, loading the text domain later is relatively easy.
- This is where developers come in contact with internationalization
- They only need to understand it once and they will understand every snippet.
Developers need to understand php before they can use functions so they need to understand internationalize before they use strings.

I know this should be discussed somewhere else but this also raises the question about the escape and sanitization functions in code examples.
Nashwan Doaqan 10:08 am on October 16, 2013

I vote for “No”, I agree with @Andrew Nacin and @Xavier Borderie comments.

Translate WordPress

Weekly Meetings

Posting here

Hey hey Polyglotters I have a question from…

Translate WordPress

Weekly Meetings

Posting here

Share this: