Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.53 KB

TRANSLATION.md

File metadata and controls

52 lines (33 loc) · 2.53 KB
Raw

Translation

Translation files are found in the following directories:

  • lib/challenges/locales: translation of the challenges
  • locales: translation of the views
  • content/docs.json: translation of the documentation

i18n not released yet

Kano OS is not fully i18n-aware and locales are not installed for end users, yet. You can translate this application, but as of now, users will still see the default English message strings.

Build

Translations are part of the normal build process: when you type npm run build, the translated challenges and docs will be copied in the www directory; and the view templates will be localized by mapping the resources for each language. So it means that all resources (views, challenges and docs translations) are prepared in advance.

Runtime

At runtime, the proper translation will be picked based on the browser language.

How to add a new translation

You need to add the new language in 4 places:

  1. Create lib/challenges/locales/<locale> and copy the whole worlds directory and index.json These are the translations of the challenges, the main content of Make-Art.

  2. Create new .po files for each locale - one from the messages.pot and one from the messages-doc.pot. These are the translations of the views and documentation.

  3. After translation run the po/lang-po-to-json and po/lang-docs-po-to-json to create the necessary json files from the po files.

  4. Add your language to SUPPORTED_LOCALES array in lib/i18n.js

How to make sure your code is i18n-aware

For the challenges, if you create a new challenge in English, there is nothing special to do, it can be translated to other languages by copying the .json file to the other locales directories.

For the views (jade templates), you need to enclose all your strings in ${{ and }}$ as this is the convention used by gulp-html-i18n plugin to find and replace the messages in the view templates. Then, you need to add the new string to the corresponding .json file in the (top-level) locales directory. Let's say you want to add a string "Happy Birthday" to the challenge.jade template; you would write it as follows in the challenge.jade: ${{ challenge.hapy_birthday }}$. Then, you would add an entry to the challenge.json map, like:

{
    ...
    "happy_birthday": "Happy Birthday"
}

Finally, for the documentation, if you add / modify text in content/docs.json the translations will need to be added for other languages, in the same file.

To-Do

Tool to make it easier to add new languages.