PeerTube/support/doc/development/localization.md

36 lines
1.2 KiB
Markdown
Raw Normal View History

2018-06-06 19:37:55 +02:00
# Application localization documentation
2019-11-13 10:02:41 +01:00
Source files are in `client/src/locale` and translated files merged from [Weblate](https://weblate.framasoft.org/translate/peertube).
2018-06-06 19:37:55 +02:00
2019-11-13 10:02:41 +01:00
## Generation
2018-06-06 19:37:55 +02:00
2019-11-13 10:02:41 +01: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 19:37:55 +02:00
```
$ npm run i18n:update
2018-06-06 19:37:55 +02:00
```
2019-11-13 10:02:41 +01:00
## Upload on Weblate
Nothing to do here, Github will automatically send a webhook to Weblate that will pull changes.
2018-06-06 19:37:55 +02:00
## Pull translation
2019-11-13 10:02:41 +01:00
* First, save translations on Weblate so it commits changes.
* Then, fetch these commits: `git fetch weblate && git merge weblate/develop`
2018-06-06 19:37:55 +02: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)
2021-11-15 15:54:23 +01:00
* Add it to [/client/angular.json](/client/angular.json)
2021-11-15 15:57:46 +01:00
* Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh)
* Lock [weblate project](https://weblate.framasoft.org/projects/peertube)
* Run `npm run i18n:update`
* Build the application and check the new language correctly works