updated translation process documentation
authorPhilip Kaufmann <phil.kaufmann@t-online.de>
Tue, 20 Mar 2012 14:19:14 +0000 (15:19 +0100)
committerPhilip Kaufmann <phil.kaufmann@t-online.de>
Wed, 21 Mar 2012 17:41:11 +0000 (18:41 +0100)
doc/translation_process.md

index 06ebe71..3ddfc0c 100644 (file)
@@ -1,7 +1,7 @@
 Translations
 ============
 
-The QT GUI can be easily be translated into other languages. Here's how we
+The Qt GUI can be easily translated into other languages. Here's how we
 handle those translations.
 
 Files and Folders
@@ -30,10 +30,14 @@ This directory contains all translations. Filenames must adhere to this format:
 
 #### 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
+`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 code is changed
 this file must be updated to reflect those changes. Usually, this can be
-accomplished by running `lupdate`
+accomplished by running `lupdate` (included in the Qt SDK).
+
+An updated source file should be merged to github and transifex will pick it
+up from there. Afterwards the new strings show up as "Remaining" in transifex
+and can be translated.
 
 Syncing with transifex
 ----------------------
@@ -42,9 +46,9 @@ 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.
-
+The "transifex client" (see: http://help.transifex.net/features/client/)
+will help with fetching new translations from transifex. Use the following
+config to be able to connect with the client.
 
 ### .tx/config
 
@@ -55,11 +59,22 @@ will help with fetching new translations from transifex.
     file_filter = src/qt/locale/bitcoin_<lang>.ts
     source_file = src/qt/locale/bitcoin_en.ts
     source_lang = en
+    
+### .tx/config (for Windows)
+
+    [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
+
+It is also possible to directly download new translations one by one from transifex.
 
 ### Fetching new translations
 
 1. `tx pull -a`
-2. update `src/qt/bitcoin.qrc`
+2. update `src/qt/bitcoin.qrc` manually or via
    `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/`
-