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 **Only generate new translations after a Weblate pull to avoid conflicts**
  12
  13 ```
  14 $ npm run i18n:generate
  15 ```
  16
  17
  18 ## Upload on Weblate
  19
  20 Nothing to do here, Github will automatically send a webhook to Weblate that will pull changes.
  21
  22
  23 ## Pull translation
  24
  25  * First, save translations on Weblate so it commits changes.
  26  * Then, fetch these commits: `git fetch weblate && git merge weblate/develop`
  27
  28
  29 ## Support a new language
  30
  31  * Add it to [/shared/models/i18n/i18n.ts](/shared/models/i18n/i18n.ts)
  32  * Add it to [/scripts/build/client.sh](/scripts/build/client.sh)
  33  * Add it to [/client/angular.json](/client/angular.json) (in multiple sections), then **pull** and **generate**
  34  * Build the application and check the new language correctly works