haskal
/
jiti-meet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates translation readme.

This commit is contained in:
damencho 2016-10-24 14:42:23 -05:00
parent 547f96c0c1
commit 076f7a82de
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lang/readme.md
View File

@ -1,20 +1,20 @@
Jitsi Meet Translation Jitsi Meet Translation
========================== ==========================
Jitsi Meet uses [i18next](http://i18next.com) library for translation. Jitsi Meet uses [i18next](http://i18next.com) library for translation.
i18next uses separate json files for each language. i18next uses separate json files for each language.
Translating Jitsi Meet Translating Jitsi Meet
====================== ======================
The translation of Jitsi Meet is integrated with Pootle. You can translate Jitsi Meet via our Pootle user interface on The translation of Jitsi Meet is integrated with Pootle. You can translate Jitsi Meet via our Pootle user interface on
[http://translate.jitsi.org](http://translate.jitsi.org). [http://translate.jitsi.org](http://translate.jitsi.org).
**WARNING: Please don't create or edit manually the language files! Please use our Pootle user interface!** **WARNING: Please don't create or edit manually the language files! Please use our Pootle user interface!**
Development Development
=========== ===========
If you want to add new functionality for Jitsi Meet and you have texts that need to be translated please use our translation module. If you want to add new functionality for Jitsi Meet and you have texts that need to be translated please use our translation module.
It is located in modules/translation. You must add key and value in main.json file in English for each translatable text. It is located in modules/translation. You must add key and value in main.json file in English for each translatable text.
Than you can use the key to get the translated text for the current language. Than you can use the key to get the translated text for the current language.
**WARNING: Please don't change the other language files except main.json! They must be updated and translated via our Pootle user interface!** **WARNING: Please don't change the other language files except main.json! They must be updated and translated via our Pootle user interface!**
@ -36,21 +36,19 @@ You can add translatable text in the HTML:
``` ```
APP.translation.generateTranslationHTML("dialog.OK") // returns <span data-i18n="dialog.OK">OK</span> APP.translation.generateTranslationHTML("dialog.OK") // returns <span data-i18n="dialog.OK">OK</span>
``` ```
The value in the options parameter will be added in data-i18n-options attribute of the element. The value in the options parameter will be added in data-i18n-options attribute of the element.
**Note:** If you dynamically add HTML elements don't forget to call APP.translation.translateElement(jquery_selector) to translate the text initially. **Note:** If you dynamically add HTML elements don't forget to call APP.translation.translateElement(jquery_selector) to translate the text initially.
* **via Javascript string** - call APP.translation.translateString(key, options). You can use that method to get the translated string in Javascript and then attach it in the HTML.
``` ```
APP.translation.translateString("dialog.OK") // returns the value for the key of the current language file. "OK" for example. APP.translation.translateString("dialog.OK") // returns the value for the key of the current language file. "OK" for example.
``` ```
For the available values of ``options`` parameter for the above methods of translation module see [i18next documentation](http://i18next.com/pages/doc_features). For the available values of ``options`` parameter for the above methods of translation module see [i18next documentation](http://i18next.com/pages/doc_features).
**Note:** It is useful to add attributes in the HTML for persistent HTML elements because when the language is changed the text will be automatically translated. **Note:** It is useful to add attributes in the HTML for persistent HTML elements because when the language is changed the text will be automatically translated.
Otherwise you should call ``APP.translation.translateString`` and manually change the text every time the language is changed.