Changes between Version 7 and Version 8 of TranslationSystem

Timestamp:

Nov 29, 2016, 1:12:14 AM (8 years ago)

Author:

Christian Beer

Comment:

--

TranslationSystem

@@ -4 +4 @@
 
  * Generate "templates" (.pot files) containing translatable strings from the BOINC source code.
- * Commit updated template(s).
+ * Commit updated template(s) and upload to Transifex.
  * Volunteers translate the strings on Transifex.
- * Updated translations are automatically committed to the BOINC Git repo on GitHub.
+ * Updated translations are downloaded to the BOINC Git repo on !GitHub.
  * Deploy the new translations.
 
 BOINC is divided into the following components, each with its own template file:
 
- ||= Component =||= directory =||= Template file =||= Command =||
- || BOINC web site || doc/ || BOINC-Web.pot || build_po.php ||
- || Project web site || html/user/ || BOINC-Project-Generic.pot || html/ops/build_po_boinc.php ||
- || Client || client/ || BOINC-Client.pot || build_po ||
- || Manager || clientgui/ || BOINC-Manager.pot || build_po ||
- || Mac installer || mac_installer/ || BOINC-Setup.pot || build_po ||
- || Android GUI || android/ || BOINC-Android.pot || a2po export -v ||
+ ||= Component =||= directory =||= Template file =||= Language files =||
+ || BOINC web site || doc/ || locale/templates/BOINC-Web.pot || locale/<lang>/BOINC-Web.po ||
+ || Project web site || html/user/ || locale/templates/BOINC-Project-Generic.pot || html/languages/translations/<lang>.po ||
+ || Client || client/ || locale/templates/BOINC-Client.pot || locale/<lang>/BOINC-Client.po ||
+ || Manager || clientgui/ || locale/templates/BOINC-Manager.pot || locale/<lang>/BOINC-Manager.po ||
+ || Mac installer || mac_installer/ || locale/templates/BOINC-Setup.pot || locale/<lang>/BOINC-Setup.po ||
+ || Android GUI || android/ || android/BOINC/res/values/strings.xml || android/BOINC/res/values-<lang>/strings.xml ||
 
-All template files are stored in '''locale/templates/''' in the BOINC repo.
-The translations for language X are stored in '''locale/X/'''.
+In order to update templates or translations one needs to have write permissions in the BOINC github repository and be a maintainer on the BOINC Transifex project. The tools '''xgettext, tx and pocompile''' (Debian packages: gettext, transifex-client, translate-toolkit) need to be installed to do the updates.
+Android uses different language codes for regional languages so there is an additional mapping configured in '''.tx/config'''.
 
 == Software releases ==
@@ -33 +33 @@
 == Template generation ==
 
-If a faulty template file is committed to the BOINC repo and picked up by Pootle,
-all existing translations will be lost.
-Therefore manual validation is used.
+New templates are needed if translatable strings change in source code. The script '''locale/update_templates.sh''' generates the templates (except Drupal and Android), commits them to the repository and pushes them to Transifex. You can check the template generation by using the '''-t''' testmode switch. Transifex has a Translation Memory so pushing a faulty template does not remove existing translations. Just push a fixed template and translations will be recovered.
 
-The process is as follows:
+Templates for Android and Drupal need to be committed and pushed to Transifex (use '''tx push -s''') separately.
 
- * Templates are updated as needed, Rom and/or David generate a new template file.
-    If it's valid, they move it to '''locale/templates''' and commit it.
+Projects can create templates for their project specific website using '''html/ops/build_po.php''' and send it to Transifex for translation too.
 
 == Translation ==
 
-Translation is handled via the Transifex web portal.  Using the TransifexGithub bridge software,
-templates and completed translations are kept in sync between Transifex and Github.
+New translations need to be downloaded from Transifex and committed into the BOINC Github repository using '''locale/update_translations.sh'''. Translations are only downloaded if they are 100% complete and already present in the repository. New translations need to be downloaded using '''tx pull -a'''.
+
+This workflow currently does not delete outdated translation files from the git repository! 
 
 == Deployment ==
@@ -64 +62 @@
 === Project web sites ===
 
+There is currently no detailed workflow how to deploy project specific translations. But one needs to adapt '''.tx/config''' and '''locale/update_translations.sh''' accordingly to download project-specific translations to '''html/languages/project_specific_translations/''' and compile them together using '''html/ops/update_translations.php'''.
 
+The Drupal website contains an admin function to directly download translations from Transifex (for Drupal generic and project-specific parts).