README.md 1.77 KB
Newer Older
Régis Behmo's avatar
Régis Behmo committed
1
2
3
4
# Open edX i18n

This project contains dumps of the translation/localization files from [Transifex](https://www.transifex.com/open-edx/) for the Open edX project. It allows you to download internationalization (i18n) files without a Transifex account.

5
The content of this project is of little use in itself. In particular, it is used in [Tutor](https://github.com/regisb/tutor) to package i18n files into the [Open edX Docker image](https://hub.docker.com/r/regis/openedx/).
Régis Behmo's avatar
Régis Behmo committed
6

7
When required, .po files were patched to fix compilation issues.
Régis Behmo's avatar
Régis Behmo committed
8
9
10
11
12
13
14
15

# Requirements

- [Docker](https://docs.docker.com/engine/installation/)
- `make`

# Usage

16
If you are feeling really confident, you can try to update translations in one go:
Régis Behmo's avatar
Régis Behmo committed
17
18
19

    make all

20
21
Note that you will need a [Transifex API token](https://www.transifex.com/user/settings/api/) to download translations.

22
23
24
25
26
27
28
29
30
31
In case some errors prevent compilation, go to the next section.

# Fixing errors

Errors only need to be fixed once, after that it is possible to save diff files for subsequent downloads.

Prepare for fixing:

    make fix

32
Apply currently known fix.
33
34
35

    make patch

36
37
38
39
The above might not work if changes were made in Transifex. In that case, remove the failing hunks from the diff files, run the following command and try from the step above again until all patches are successfully applied.

    make prepatch

40
Detect remaining errors by running:
41
42

    make validate
Régis Behmo's avatar
Régis Behmo committed
43

44
45
You will then have to fix the errors manually in each file. It is recommended to also fix them in Transifex.

46
47
48
49
50
After all errors have been fixed, you should save the patches generated.

    make diff

You may then resume the processing.
51
52

    make compile
Régis Behmo's avatar
Régis Behmo committed
53
54
55
56

# License

This code and all translation files are licensed under the terms of the [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html).