62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
Translations
|
|
============
|
|
|
|
How to translate Kanboard to a new language?
|
|
--------------------------------------------
|
|
|
|
- Translations are stored inside the directory `app/Locale`
|
|
- There is sub-directory for each language, by example for the French we have `fr_FR`, Italian `it_IT` etc...
|
|
- A translation is a PHP file that return an Array with a key-value pairs
|
|
- The key is the original text in english and the value is the translation for the corresponding language
|
|
- **French translations are always up to date**
|
|
- Always use the last version (branch master)
|
|
|
|
### Create a new translation:
|
|
|
|
1. Make a new directory: `app/Locale/xx_XX` by example `app/Locale/fr_CA` for French Canadian
|
|
2. Create a new file for the translation: `app/Locale/xx_XX/translations.php`
|
|
3. Use the content of the French locales and replace the values
|
|
4. Inside the file `app/Model/Config.php`, add a new entry for your translation inside the function `getLanguages()`
|
|
5. Check with your local installation of Kanboard if everything is ok
|
|
6. Send a [pull-request with Github](https://help.github.com/articles/using-pull-requests/)
|
|
|
|
How to update an existing translation?
|
|
--------------------------------------
|
|
|
|
1. Open the translation file `app/Locale/xx_XX/translations.php`
|
|
2. Missing translations are commented with `//` and the values are empty, just fill blank and remove the comment
|
|
3. Check with your local installation of Kanboard and send a [pull-request](https://help.github.com/articles/using-pull-requests/)
|
|
|
|
How to add new translated text in the application?
|
|
--------------------------------------------------
|
|
|
|
Translations are displayed with the following functions in the source code:
|
|
|
|
- `t()`: escaped HTML text
|
|
- `e()`: displayed with no escaping
|
|
- `dt()`: date using `strftime()` formats
|
|
|
|
Always use the english version in the source code.
|
|
|
|
How to find missing translations in the applications?
|
|
-----------------------------------------------------
|
|
|
|
From a Unix shell run:
|
|
|
|
```bash
|
|
./scripts/find-strings.sh
|
|
```
|
|
|
|
All missing translations are displayed on the screen. Put that in the french locale and sync other locales (see below).
|
|
|
|
How to synchronize translation files?
|
|
-------------------------------------
|
|
|
|
From a Unix shell run this command:
|
|
|
|
```bash
|
|
./scripts/sync-locales.php
|
|
```
|
|
|
|
The french translation is used a reference for other locales.
|