2018-06-06 13:37:55 -04:00
|
|
|
# Application localization documentation
|
|
|
|
|
|
2019-11-13 04:02:41 -05:00
|
|
|
Source files are in `client/src/locale` and translated files merged from [Weblate](https://weblate.framasoft.org/translate/peertube).
|
2018-06-06 13:37:55 -04:00
|
|
|
|
|
|
|
|
|
2019-11-13 04:02:41 -05:00
|
|
|
## Generation
|
2018-06-06 13:37:55 -04:00
|
|
|
|
2019-11-13 04:02:41 -05:00
|
|
|
Will generate XLIFF base files for Angular (`angular.xlf`) and JSON files for the player (`player.en-US.json`) and the server (`server.en-US.json`).
|
|
|
|
|
Then, it will merge new translation keys into localized Angular files (`angular.fr-FR.xlf` etc).
|
2018-06-06 13:37:55 -04:00
|
|
|
|
2019-11-13 04:02:41 -05:00
|
|
|
**Only generate new translations after a Weblate pull to avoid conflicts**
|
2018-06-06 13:37:55 -04:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ npm run i18n:generate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2019-11-13 04:02:41 -05:00
|
|
|
## Upload on Weblate
|
|
|
|
|
|
|
|
|
|
Nothing to do here, Github will automatically send a webhook to Weblate that will pull changes.
|
2018-06-06 13:37:55 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Pull translation
|
|
|
|
|
|
2019-11-13 04:02:41 -05:00
|
|
|
* First, save translations on Weblate so it commits changes.
|
|
|
|
|
* Then, fetch these commits: `git fetch weblate && git merge weblate/develop`
|
2018-06-06 13:37:55 -04:00
|
|
|
|
2019-05-14 04:21:33 -04:00
|
|
|
|
|
|
|
|
## Support a new language
|
|
|
|
|
|
|
|
|
|
* Add it to [/shared/models/i18n/i18n.ts](/shared/models/i18n/i18n.ts)
|
|
|
|
|
* Add it to [/scripts/build/client.sh](/scripts/build/client.sh)
|
2019-11-13 04:02:41 -05:00
|
|
|
* Add it to [/client/angular.json](/client/angular.json) in `xliffmergeOptions` section, then **pull** and **generate**
|
2019-05-14 04:21:33 -04:00
|
|
|
* Build the application and check the new language correctly works
|
