[github/Chocobozzz/PeerTube.git] / support / doc / development / localization.md

# Application localization documentation

Source files are in `client/src/locale/source` and translated files pulled from [Zanata](https://trad.framasoft.org/zanata/iteration/view/peertube/develop/languages/fr?dswid=-1605) in `client/src/locale/target`.

## Generation

Will generate XLIFF files for Angular and escape inner elements in `source` tag because Zanata does not support them.

This script will create `player_en_US.xml` XLIFF file using custom strings (VideoJS plugins) and strings from `videojs_en_US.json` file.

It will also create `server_en_US.xml` and `iso639_en_US.xml` XLIFF file using server strings and custom strings (defined inside the script, we did not find a way to extract them from TypeScript server files).

```
$ npm run i18n:generate
```

## Upload on Zanata

Push source source files (en-US) on Zanata:

```
$ zanata-cli push
```

## Pull translation

Pull XLIFF files from Zanata, and unescape them (so we retrieve inner elements in `source` tag, used by Angular).
A hook converts `player` and `server`, `iso639` translation files to JSON (needed by Video.JS, and our application to have efficient runtime translation).
Then, `iso639` files will be merged in `server` files (so we have only one JSON file to serve server translations).

```
$ zanata-cli pull
```
Commit	Line	Data
157b62b1 C	1	# Application localization documentation
	2
	3	Source files are in `client/src/locale/source` and translated files pulled from [Zanata](https://trad.framasoft.org/zanata/iteration/view/peertube/develop/languages/fr?dswid=-1605) in `client/src/locale/target`.
	4
	5	## Generation
	6
	7	Will generate XLIFF files for Angular and escape inner elements in `source` tag because Zanata does not support them.
	8
	9	This script will create `player_en_US.xml` XLIFF file using custom strings (VideoJS plugins) and strings from `videojs_en_US.json` file.
	10
850c1bf7	11	It will also create `server_en_US.xml` and `iso639_en_US.xml` XLIFF file using server strings and custom strings (defined inside the script, we did not find a way to extract them from TypeScript server files).
157b62b1 C	12
	13	```
	14	$ npm run i18n:generate
	15	```
	16
	17	## Upload on Zanata
	18
	19	Push source source files (en-US) on Zanata:
	20
	21	```
	22	$ zanata-cli push
	23	```
	24
	25	## Pull translation
	26
	27	Pull XLIFF files from Zanata, and unescape them (so we retrieve inner elements in `source` tag, used by Angular).
850c1bf7 C	28	A hook converts `player` and `server`, `iso639` translation files to JSON (needed by Video.JS, and our application to have efficient runtime translation).
850c1bf7 C	29	Then, `iso639` files will be merged in `server` files (so we have only one JSON file to serve server translations).
157b62b1 C	30
	31	```
	32	$ zanata-cli pull
	33	```