doc/translation_process.md

   1 Translations
   2 ============
   3
   4 The Qt GUI can be easily translated into other languages. Here's how we
   5 handle those translations.
   6
   7 Files and Folders
   8 -----------------
   9
  10 ### bitcoin-qt.pro
  11
  12 This file takes care of generating `.qm` files from `.ts` files. It is mostly
  13 automated.
  14
  15 ### src/qt/bitcoin.qrc
  16
  17 This file must be updated whenever a new translation is added. Please note that
  18 files must end with `.qm`, not `.ts`.
  19
  20     <qresource prefix="/translations">
  21         <file alias="en">locale/bitcoin_en.qm</file>
  22         ...
  23     </qresource>
  24
  25 ### src/qt/locale/
  26
  27 This directory contains all translations. Filenames must adhere to this format:
  28
  29     bitcoin_xx_YY.ts or bitcoin_xx.ts
  30
  31 #### Source file
  32
  33 `src/qt/locale/bitcoin_en.ts` is treated in a special way. It is used as the
  34 source for all other translations. Whenever a string in the code is changed
  35 this file must be updated to reflect those changes. Usually, this can be
  36 accomplished by running `lupdate`.
  37
  38 Syncing with transifex
  39 ----------------------
  40
  41 We are using http://transifex.net as a frontend for translating the client.
  42
  43 https://www.transifex.net/projects/p/bitcoin/resource/tx/
  44
  45 The "transifex client" (see: http://help.transifex.net/features/client/)
  46 will help with fetching new translations from transifex. Use the following
  47 config to be able to connect with the client.
  48
  49 ### .tx/config
  50
  51     [main]
  52     host = https://www.transifex.net
  53
  54     [bitcoin.tx]
  55     file_filter = src/qt/locale/bitcoin_<lang>.ts
  56     source_file = src/qt/locale/bitcoin_en.ts
  57     source_lang = en
  58
  59 ### Fetching new translations
  60
  61 1. `tx pull -a`
  62 2. update `src/qt/bitcoin.qrc`
  63 3. `git add` new translations from `src/qt/locale/`