doc/translation_process.md

   1 Translations
   2 ============
   3
   4 The Bitcoin-Core project has been designed to support multiple localisations. This makes adding new phrases, and completely new languages easily achievable. For managing all application translations, Bitcoin-Core makes use of the Transifex online translation management tool.
   5
   6 ### Helping to translate (using Transifex)
   7 Transifex is setup to monitor the GitHub repo for updates, and when code containing new translations is found, Transifex will process any changes. It may take several hours after a pull-request has been merged, to appear in the Transifex web interface.
   8
   9 Multiple language support is critical in assisting Bitcoin’s global adoption, and growth. One of Bitcoin’s greatest strengths is cross-border money transfers, any help making that easier is greatly appreciated.
  10
  11 See the [Transifex Bitcoin project](https://www.transifex.com/projects/p/bitcoin/) to assist in translations. You should also join the translation mailing list for announcements - see details below.
  12
  13 ### Writing code with translations
  14 We use automated scripts to help extract translations in both Qt, and non-Qt source files. It is rarely necessary to manually edit the files in `src/qt/locale/`. The translation source files must adhere to the following format:
  15 `bitcoin_xx_YY.ts or bitcoin_xx.ts`
  16
  17 `src/qt/locale/bitcoin_en.ts` is treated in a special way. It is used as the source for all other translations. Whenever a string in the source code is changed, this file must be updated to reflect those changes. A custom script is used to extract strings from the non-Qt parts. This script makes use of `gettext`, so make sure that utility is installed (ie, `apt-get install gettext` on Ubuntu/Debian). Once this has been updated, `lupdate` (included in the Qt SDK) is used to update `bitcoin_en.ts`.
  18
  19 To automatically regenerate the `bitcoin_en.ts` file, run the following commands:
  20 ```sh
  21 cd src/
  22 make translate
  23 ```
  24
  25 `contrib/bitcoin-qt.pro` takes care of generating `.qm` (binary compiled) files from `.ts` (source files) files. It’s mostly automated, and you shouldn’t need to worry about it.
  26
  27 **Example Qt translation**
  28 ```cpp
  29 QToolBar *toolbar = addToolBar(tr("Tabs toolbar"));
  30 ```
  31
  32 ### Creating a pull-request
  33 For general PRs, you shouldn’t include any updates to the translation source files. They will be updated periodically, primarily around pre-releases, allowing time for any new phrases to be translated before public releases. This is also important in avoiding translation related merge conflicts.
  34
  35 When an updated source file is merged into the GitHub repo, Transifex will automatically detect it (although it can take several hours). Once processed, the new strings will show up as "Remaining" in the Transifex web interface and are ready for translators.
  36
  37 To create the pull-request, use the following commands:
  38 ```
  39 git add src/qt/bitcoinstrings.cpp src/qt/locale/bitcoin_en.ts
  40 git commit
  41 ```
  42
  43 ### Creating a Transifex account
  44 Visit the [Transifex Signup](https://www.transifex.com/signup/) page to create an account. Take note of your username and password, as they will be required to configure the command-line tool.
  45
  46 You can find the Bitcoin translation project at [https://www.transifex.com/projects/p/bitcoin/](https://www.transifex.com/projects/p/bitcoin/).
  47
  48 ### Installing the Transifex client command-line tool
  49 The client it used to fetch updated translations. If you are having problems, or need more details, see [http://docs.transifex.com/developer/client/setup](http://docs.transifex.com/developer/client/setup)
  50
  51 **For Linux and Mac**
  52
  53 `pip install transifex-client`
  54
  55 Setup your transifex client config as follows. Please *ignore the token field*.
  56
  57 ```ini
  58 nano ~/.transifexrc
  59
  60 [https://www.transifex.com]
  61 hostname = https://www.transifex.com
  62 password = PASSWORD
  63 token =
  64 username = USERNAME
  65 ```
  66
  67 **For Windows**
  68
  69 Please see [http://docs.transifex.com/developer/client/setup#windows](http://docs.transifex.com/developer/client/setup#windows) for details on installation.
  70
  71 The Transifex Bitcoin project config file is included as part of the repo. It can be found at `.tx/config`, however you shouldn’t need change anything.
  72
  73 ### Synchronising translations
  74 To assist in updating translations, we have created a script to help.
  75
  76 1. `python contrib/devtools/update-translations.py`
  77 2. Update `src/qt/bitcoin_locale.qrc` manually or via
  78    `ls src/qt/locale/*ts|xargs -n1 basename|sed 's/\(bitcoin_\(.*\)\).ts/<file alias="\2">locale\/\1.qm<\/file>/'`
  79 3. Update `src/Makefile.qt.include` manually or via
  80    `ls src/qt/locale/*ts|xargs -n1 basename|sed 's/\(bitcoin_\(.*\)\).ts/  qt\/locale\/\1.ts \\/'`
  81 4. `git add` new translations from `src/qt/locale/`
  82
  83 **Do not directly download translations** one by one from the Transifex website, as we do a few post-processing steps before committing the translations.
  84
  85 ### Handling Plurals (in source files)
  86 When new plurals are added to the source file, it's important to do the following steps:
  87
  88 1. Open `bitcoin_en.ts` in Qt Linguist (included in the Qt SDK)
  89 2. Search for `%n`, which will take you to the parts in the translation that use plurals
  90 3. Look for empty `English Translation (Singular)` and `English Translation (Plural)` fields
  91 4. Add the appropriate strings for the singular and plural form of the base string
  92 5. Mark the item as done (via the green arrow symbol in the toolbar)
  93 6. Repeat from step 2, until all singular and plural forms are in the source file
  94 7. Save the source file
  95
  96 ### Translating a new language
  97 To create a new language template, you will need to edit the languages manifest file `src/qt/bitcoin_locale.qrc` and add a new entry. Below is an example of the English language entry.
  98
  99 ```xml
 100 <qresource prefix="/translations">
 101     <file alias="en">locale/bitcoin_en.qm</file>
 102     ...
 103 </qresource>
 104 ```
 105
 106 **Note:** that the language translation file **must end in `.qm`** (the compiled extension), and not `.ts`.
 107
 108 ### Questions and general assistance
 109 The Bitcoin-Core translation maintainers include *tcatm, seone, Diapolo, wumpus and luke-jr*. You can find them, and others, in the Freenode IRC chatroom - `irc.freenode.net #bitcoin-core-dev`.
 110
 111 If you are a translator, you should also subscribe to the mailing list, https://groups.google.com/forum/#!forum/bitcoin-translators. Announcements will be posted during application pre-releases to notify translators to check for updates.