aboutsummaryrefslogtreecommitdiff
path: root/doc/translation_process.md
blob: 06ebe711f19161a076f6733b78641f027074f87a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Translations
============

The QT GUI can be easily be translated into other languages. Here's how we
handle those translations.

Files and Folders
-----------------

### bitcoin-qt.pro

This file takes care of generating `.qm` files from `.ts` files. It is mostly
automated.

### src/qt/bitcoin.qrc

This file must be updated whenever a new translation is added. Please note that
files must end with `.qm`, not `.ts`.

    <qresource prefix="/translations">
        <file alias="en">locale/bitcoin_en.qm</file>
        ...
    </qresource>

### src/qt/locale/

This directory contains all translations. Filenames must adhere to this format:

    bitcoin_xx_YY.ts or bitcoin_xx.ts

#### Source file

`src/qt/locale/bitcoin_en.ts` is a treated in a special way. It is used as the
source for all other translations. Whenever a string in the code is change
this file must be updated to reflect those changes. Usually, this can be
accomplished by running `lupdate`

Syncing with transifex
----------------------

We are using http://transifex.net as a frontend for translating the client.

https://www.transifex.net/projects/p/bitcoin/resource/tx/

The "transifex client":http://help.transifex.net/features/client/index.html
will help with fetching new translations from transifex.


### .tx/config

    [main]
    host = https://www.transifex.net

    [bitcoin.tx]
    file_filter = src/qt/locale/bitcoin_<lang>.ts
    source_file = src/qt/locale/bitcoin_en.ts
    source_lang = en

### Fetching new translations

1. `tx pull -a`
2. update `src/qt/bitcoin.qrc`
   `ls src/qt/locale/*ts|xargs -n1 basename|sed 's/\(bitcoin_\(.*\)\).ts/<file alias="\2">locale/\1.qm<\/file>/'`
3. `git add` new translations from `src/qt/locale/`