Revised translation process doc #5413

pull blakejakopovic wants to merge 1 commits into bitcoin:master from blakejakopovic:revise-transation-doc changing 1 files +79 −57

blakejakopovic commented at 8:08 AM on December 3, 2014: contributor

While becoming more familiar with Bitcoin Core, I came across doc/translation_process.md. I felt it could use a refresh, so I've rewritten it to hopefully make it more clear for first time readers, while also being useful as a reference guide. I've kept all previous information. The new stuff is mostly just reformatting, and adding additional details.

If someone could please review it technically, to catch any mistakes.

Due to the diff being so messy, here is a link to the original for reference and comparison. doc/translation_process.md (to be replaced).
laanwj added the label Docs and Output on Dec 3, 2014
laanwj commented at 8:58 AM on December 3, 2014: member

Thanks, I'll read it in detail later but such substantial updates to docs are very welcome

in doc/translation_process.md:None in a7ac679a7f outdated

  24 | +
  25 | +`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`.
  26 | +
  27 | +To automatically regenerate the `bitcoin_en.ts` file, run the following commands:
  28 | +```sh
  29 | +cd src/qt/

blakejakopovic commented at 1:44 PM on December 4, 2014:

The path has since changed to src/. This needs to be updated.

fanquake commented at 3:10 AM on December 5, 2014: member

You can add the translators mailing list as another point of contact https://groups.google.com/forum/#!forum/bitcoin-translators
blakejakopovic commented at 3:19 AM on December 5, 2014: contributor

I'd also like to add a note about translation files being updated periodically (most likely for pre-releases), and code with new translations not requiring any translation file updates in the PR - mostly as it can complicate merges.
laanwj commented at 9:22 AM on December 5, 2014: member

You can add the translators mailing list as another point of contact https://groups.google.com/forum/#!forum/bitcoin-translators

Yes - note that it is already mentioned in README.md, but repeating it here doesn't hurt.

in doc/translation_process.md:None in a7ac679a7f outdated

   9 | +* The languages manifest file can be found at `src/qt/bitcoin.qrc`
  10 | +* Translation source files are located in `src/qt/locale/`
  11 | +* `.ts` files are generated translation source files
  12 | +* `.qm` files are compiled binary translation files
  13 | +* We use `bitcoin_en.ts` as the translation master file (ie. all other languages use it as a template)
  14 | +* For assistance, seek out *tcatm, seone, Diapolo, wumpus or luke-jr* (via IRC)

laanwj commented at 9:35 AM on December 5, 2014:

I think it would be best to only mention this once under the contact section below , and here refer to that.

laanwj commented at 9:41 AM on December 5, 2014: member

Changes look good to me, ACK, let me know when this is ready for merging.
blakejakopovic commented at 2:16 AM on December 7, 2014: contributor

@laanwj I've updated the doc based on feedback. Should be ok to merge.
fanquake commented at 2:34 AM on December 7, 2014: member

ACK changes. Can you squash your commits?
Revised translation process doc 88eb44d30f
blakejakopovic force-pushed on Dec 7, 2014
laanwj merged this on Dec 19, 2014
laanwj closed this on Dec 19, 2014
laanwj referenced this in commit 87a5270d58 on Dec 19, 2014
blakejakopovic deleted the branch on Dec 20, 2014
laanwj referenced this in commit c6a5ad4819 on Jan 8, 2015
laanwj referenced this in commit d0c97bbe70 on Jan 8, 2015
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#5617 Fix tests after #5413