Skip to content

Latest commit

 

History

History

locales

README.md

Narrative language files

Valhalla supports localized instructions in multiple languages for both textual and verbal phrases. All localized text is managed in JSON files in the locales directory. We rely on external contributors to provide translations of these phrases to other languages.

Contributing translations

The recommended way to contribute translations is on Transifex. If you prefer you may also skip Transifex and edit the language files directly.

Translating on Transifex (Recommended)

Follow these steps to start contributing a translation:

  1. Sign up for a free account at https://www.transifex.com/.
  2. Navigate to https://www.transifex.com/explore/projects/ and search for the Valhalla Phrases project.
  3. Submit a request to join the team for the languages you know. You may also request a new language if yours does not appear in the list.
  4. Wait for an email with an invitation to start translating.
  5. From the dashboard, navigate to the Translate page for your chosen language.
  6. Select the en-US.json source file to translate from.
  7. Before you start translating make sure to filter out any phrases with the notranslate tag. Apply this filter by selecting Tag > Doesn't contain tag > notranslate.
  8. For more information on how to use Transifex, check out the getting started guide.

Once a language is 100% translated, the project maintainers will be notified and we will make a PR with your updates. Thank you for your contribution!

Translating language files directly (Advanced)

Follow these instructions if you prefer to edit the JSON files directly without Transifex.

How to contribute a new narrative language file

  1. Copy the en-US.json to <NEW_LANGUAGE_TAG>.json Using IETF BCP 47 as reference - the typical format for the <NEW_LANGUAGE_TAG> is: <ISO 639 two-letter language code>-<ISO 3166 two-letter country code> Czech/Czech Republic example: cs-CZ

  2. Update the posix_locale value in your new file. The character encoding must be UTF-8. The typical format is: <ISO 639 two-letter language code>_<ISO 3166 two-letter country code>.UTF-8 Czech/Czech Republic posix_locale example: cs_CZ.UTF-8

  3. Update the aliases array in your new file. A typical alias entry is the ISO 639 two-letter language code without the ISO 3166 two-letter country code. The alias entry must be unique across language files. Czech aliases entry example: cs

  4. Do not translate the JSON keys or phrase tags. An example using the ramp instruction: Alt text

  5. Please translate the JSON values. As needed, reorder the phrase words and tags - the tags must remain in the phrase. An example using the ramp instruction: Alt text

  6. Run make check to verify the tests pass OR move on to step#7 and we can help verify.

  7. Submit a pull request for review. Thank you!

Adding new instruction strings

  1. First add the new strings in en-US.json. The JSON keys are used by narrative_builder to select the instruction template string.

  2. Sync the new strings to each new narrative language file by running ./merge-en.sh. This will copy the new English strings to each new language.

  3. Update the English strings in each language file.

Instruction descriptions

TODO

Tag descriptions

TODO