Add "Updating translations with Launchpad" dev docs
authorDan Scott <dscott@laurentian.ca>
Thu, 3 May 2012 19:33:51 +0000 (15:33 -0400)
committerDan Scott <dscott@laurentian.ca>
Thu, 3 May 2012 19:33:51 +0000 (15:33 -0400)
Not 100% sure if this is where we want to keep developer process
documentation, but as I already have it in AsciiDoc we might as well
give it a try.

Signed-off-by: Dan Scott <dscott@laurentian.ca>

development/updating_translations_launchpad.txt [new file with mode: 0644]
root.txt

diff --git a/development/updating_translations_launchpad.txt b/development/updating_translations_launchpad.txt
new file mode 100644 (file)
index 0000000..dc57f34
--- /dev/null
@@ -0,0 +1,54 @@
+Updating translations using Launchpad
+=====================================
+
+This document describes how to update the translations in an Evergreen branch
+by pulling them from Launchpad, as well as update the files to be translated
+in Launchpad by updating the POT files in the Evergreen master branch.
+
+Prerequisites
+-------------
+You must install all of the Python prerequisites required for building
+translations, per
+http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n
+
+* https://bitbucket.org/izi/polib/wiki/Home[polib]
+* http://translate.sourceforge.net[translate-toolkit]
+* http://pypi.python.org/pypi/python-Levenshtein/[levenshtein]
+* http://pypi.python.org/pypi/setuptools[setuptools]
+* http://pypi.python.org/pypi/simplejson/[simplejson]
+* http://lxml.de/[lxml]
+
+Updating the translations
+-------------------------
+
+. Check out the latest translations from Launchpad by branching the Bazaar
+repository:
++
+[source,bash]
+------------------------------------------------------------------------------
+bzr branch lp:~denials/evergreen/translation-export
+------------------------------------------------------------------------------
++
+This creates a directory called "translation-export".
++
+. Ensure you have an updated Evergreen release branch.
+. Run the `build/i18n/scripts/update_pofiles` script to copy the translations
+  into the right place and avoid any updates that are purely metadata (dates
+  generated, etc).
+. Commit the lot! And backport to whatever release branches need the updates.
+. Build updated POT files:
++
+[source,bash]
+------------------------------------------------------------------------------
+cd build/i18n
+make newpot
+------------------------------------------------------------------------------
++
+This will extract all of the strings from the latest version of the files in
+Evergreen.
++
+. (This part needs automation): Then, via the magic of `git diff` and `git add`,
+go through all of the changed files and determine which ones actually have
+string changes. Recommended approach is to re-run `git diff` after each
+`git add`.
+. Commit the updated POT files and backport to the pertinent release branches.
index d7671a9..f7cc349 100644 (file)
--- a/root.txt
+++ b/root.txt
@@ -221,9 +221,15 @@ Developer Resources
 Introduction\r
 ------------\r
 \r
+Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen.  \r
 \r
+// Push titles down one level.\r
+:leveloffset: 1\r
 \r
-Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen.  \r
+include::development/updating_translations_launchpad.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
 \r
 [appendix]\r
 \r