support/doc/development/localization.md

   1 # Application localization documentation
   2
   3 Source files are in `client/src/locale` and translated files merged from [Weblate](https://weblate.framasoft.org/translate/peertube).
   4
   5
   6 ## Generation
   7
   8 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`).
   9 Then, it will merge new translation keys into localized Angular files (`angular.fr-FR.xlf` etc).
  10
  11 ```
  12 $ npm run i18n:update
  13 ```
  14
  15
  16 ## Upload on Weblate
  17
  18 Nothing to do here, Github will automatically send a webhook to Weblate that will pull changes.
  19
  20
  21 ## Pull translation
  22
  23  * First, save translations on Weblate so it commits changes.
  24  * Then, fetch these commits: `git fetch weblate && git merge weblate/develop`
  25
  26
  27 ## Support a new language
  28
  29  * Add it to [/shared/models/i18n/i18n.ts](/shared/models/i18n/i18n.ts)
  30  * Add it to [/scripts/build/client.sh](/scripts/build/client.sh)
  31  * Add it to [/client/angular.json](/client/angular.json)
  32  * Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh)
  33  * Lock [weblate project](https://weblate.framasoft.org/projects/peertube)
  34  * Run `npm run i18n:update`
  35  * Build the application and check the new language correctly works