Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update i18n docs to use make-json command from wp-cli #15303

Merged
merged 2 commits into from
May 12, 2019
Merged

Update i18n docs to use make-json command from wp-cli #15303

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d767a9c
Update i18m docs to use make-json command from wp-cli
mkaz Apr 30, 2019
f5259a7
Apply suggestions from code review
mkaz May 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/designers-developers/developers/internationalization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,31 +176,32 @@ msgid "Hello World"
msgstr "Saltuon mundo"
```

The last step to create the translation file is to convert the `myguten-eo.po` to the JSON format needed. For this, you can use the [po2json utility](https://github.com/mikeedwards/po2json) which you install using npm. It might be easiest to install globally using: `npm install -g po2json`. Once installed, use the following command to convert to JED format:
The last step to create the translation file is to convert the `myguten-eo.po` to the JSON format needed. For this, you can use WP-CLI's [`wp i18n make-json` command](https://developer.wordpress.org/cli/commands/i18n/make-json/), which requires WP-CLI v2.2.0 and later.

```
po2json myguten-eo.po myguten-eo.json -f jed
wp i18n make-json myguten-eo.po --no-purge
```

This will generate the JSON file `myguten-eo.json` which looks like:
This will generate the JSON file `myguten-eo-[md5].json` with the contents:

```json
{
"translation-revision-date": "2019-04-26T13:30:11-07:00",
"generator": "WP-CLI/2.2.0",
"source": "block.js",
"domain": "messages",
"locale_data": {
"messages": {
"": {
"domain": "messages",
"lang": "eo"
"lang": "eo",
"plural-forms": "nplurals=2; plural=(n != 1);"
},
"Scratch Plugin": [
"Scratch kromprogrameto"
],
"Simple Block": [
"Simpla bloko"
"Simpla Bloko"
],
"Hello World": [
"Saltuon mundo"
"Salunton mondo"
]
}
}
Expand All @@ -222,7 +223,7 @@ The final part is to tell WordPress where it can look to find the translation fi

WordPress will check for a file in that path with the format `${domain}-${locale}-${handle}.json` as the source of translations. Alternatively, instead of the registered handle you can use the md5 hash of the relative path of the file, `${domain}-${locale} in the form of ${domain}-${locale}-${md5}.json.`

This example uses the handle, rename the `myguten-eo.json` file to `myguten-eo-myguten-script.json`.
Using `make-json` automatically names the file with the md5 hash, so it is ready as-is. You could rename the file to use the handle instead, in which case the file name would be `myguten-eo-myguten-script.json`.

### Test Translations

Expand Down