dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 443
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2012-01-23 07:19:30 +0200
message:
  Added a chapter on i18n/localization.
added:
  src/docbkx/en/dhis2_localization_guide.xml
  src/docbkx/en/resources/images/i18n/
  src/docbkx/en/resources/images/i18n/i18n_tool_main_window.png
  src/docbkx/en/resources/images/i18n/i18n_tool_select_locale.PNG
  src/docbkx/en/resources/images/i18n/i18n_tool_start_translating.PNG
  src/docbkx/en/resources/images/i18n/i18n_tool_startup.PNG
  src/docbkx/en/resources/images/i18n/i18n_web_portal_settings.PNG
  src/docbkx/en/resources/images/i18n/i18n_web_portal_translate.PNG
modified:
  src/docbkx/en/dhis2_implementation_guide_en.xml


--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs

Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription

=== modified file 'src/docbkx/en/dhis2_implementation_guide_en.xml'
--- src/docbkx/en/dhis2_implementation_guide_en.xml	2012-01-20 07:34:34 +0000
+++ src/docbkx/en/dhis2_implementation_guide_en.xml	2012-01-23 05:19:30 +0000
@@ -1,8 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; 
 [
-  <!ENTITY version '2.X'>
-  <!ENTITY title 'DHIS2 Implementation Guide'>
+    <!ENTITY title 'DHIS2 Implementation Guide'>
  ]>
 <book>
  <title>&title;</title>

=== added file 'src/docbkx/en/dhis2_localization_guide.xml'
--- src/docbkx/en/dhis2_localization_guide.xml	1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_localization_guide.xml	2012-01-23 05:19:30 +0000
@@ -0,0 +1,77 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. -->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
+<chapter>
+  <title>Localization concepts</title>
+  <para>Localization involves the adaptation of an application to another location. Translation of the user interface elements, messages, layout, date and time formats, currency and other aspects must be considered.  DHIS2 supports internationalization (i18n) of the user interface through the use of Java property strings. Each element in the user interface has been assigned a specific key, which is linked to a value.</para>
+  <para> As an example, consider the following key/value pairs.</para>
+  <programlisting>org_unit_tree=Organisation Unit Tree
+error_occurred=An error has occurred.</programlisting>
+  <para>In French the same key/value pairs would appear as follows</para>
+  <programlisting>org_unit_tree=Arborescence des unités d&apos;organisation
+error_occurred=Une erreur s&apos;est produite</programlisting>
+  <para>Note that the keys (before the = symbol) are the same in both examples, but the values (after the = ) symbol are in each of the respective languages. Each of these key/value pairs would need to be translated from the original language (English) to the destination language (e.g. French). When the user specifies French for the user interface language, all of the strings would then appear in French instead of the default language (English). Any strings which have not been translated, would appear in English. </para>
+  <para>There are a number of different mechanisms to begin to localize DHIS2, two of which will be discussed in the next sections. The web portal is a quite useful tool for collaborative translations by multiple people, however an on-line connection is required in order to utilize this resource. A special tool, the DHIS i18n Resource Editor, has been developed specifically to facilitate the translation of the application from one language to another and can be used off-line once a copy of the DHIS2 source code has been obtained.</para>
+  <section>
+    <title>Using the DHIS2 translation server</title>
+    <para>A web-based portal solution has been setup in order to facilitate the translation of DHIS2 into multiple languages. Simply direct your browser to http://translate.dhis2.net/ and register for an account by providing a username, email address and password. The server will send you a confirmation email which you can use to activate your account. Once you have activated your account, simply press the &quot;Log in&quot; link from the main portal page, and provide your username and password. </para>
+    <para>The first time you login, you should select your settings, by clicking &quot;My account-&gt;Settings&quot;. Here you can select your interface language, the projects which you wish to work on,  and the languages which you will translate into. Be sure to press &quot;Save&quot; when have finished making your changes. </para>
+    <para>To start translating, be sure you have logged in, and then press the &quot;Home&quot; link in the upper-right hand corner. Select a project (e.g. DHIS2) and then click on the language which you wish to translate. The number of words which need to be translated will be displayed under the &quot;Summary&quot; field. Click on one of the modules (e.g. dhis-2) and the keep drilling down through the folders to find a module which needs translation, (e.g. dhis-web-&gt;dhis-web-caseentry). Now click on the &quot;Summary&quot; text which will say something like &quot;194 words need attention&quot;. You will be directed to the key/value pair which requires translation. </para>
+    <screenshot>
+      <mediaobject>
+        <imageobject>
+          <imagedata align="center" width="80%" fileref="resources/images/i18n/i18n_web_portal_translate.PNG"/>
+        </imageobject>
+      </mediaobject>
+    </screenshot>
+    <para>In this case, we need to translate the phrase &quot;Name-based&quot; from English to French. Enter the translation in the window just below the reference phrase.. If you are unsure if the translation is correct or needs review, you can mark it as &quot;Fuzzy&quot;. Once you have completed the translation, just press &quot;Submit&quot;. Your translations will be incorporated into the source code on a regular basis by the development team. </para>
+  </section>
+  <section>
+    <title>DHIS2 i18n tool</title>
+    <orderedlist>
+      <listitem>
+        <para>Press &quot;Browse&quot; when the application starts and select the path of your local copy of the DHIS2 source code tree followed by OK. </para>
+        <screenshot>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="resources/images/i18n/i18n_tool_startup.PNG" align="center" width="30%"/>
+            </imageobject>
+          </mediaobject>
+        </screenshot>
+      </listitem>
+      <listitem>
+        <para>Next, select the destination locale which you will translate strings into.</para>
+        <screenshot>
+          <mediaobject>
+            <imageobject>
+              <imagedata align="center" fileref="resources/images/i18n/i18n_tool_select_locale.PNG" width="30%"/>
+            </imageobject>
+          </mediaobject>
+        </screenshot>
+      </listitem>
+      <listitem>
+        <para>Select one of the modules from the left hand side to translate, e.g. dhis-web-caseentry.</para>
+        <screenshot>
+          <mediaobject>
+            <imageobject>
+              <imagedata align="center" width="80%" fileref="resources/images/i18n/i18n_tool_main_window.png"/>
+            </imageobject>
+          </mediaobject>
+        </screenshot>
+        <para>Once you have selected a module, click on a particular key from the left-hand pane. A reference value for the key will be displayed in the lower right-hand pane, and the translation value will be displayed in the upper right-hand pane. If the value does not exist, simply add the translation there. </para>
+      </listitem>
+      <listitem>
+        <para>Once you have finished translating, be sure to press the &quot;Save&quot; button. </para>
+      </listitem>
+    </orderedlist>
+  </section>
+  <section>
+    <title>Things to keep in mind.</title>
+    <simplelist>
+      <member>There are a number of strings such as &quot;yyyy-MM-dd&quot; which are used for date/time formatting in the application. In general, these should not be altered, but there can be situations when they need to be localized. Consult this <ulink url="http://docs.oracle.com/javase/tutorial/i18n/format/simpleDateFormat.html";>site</ulink> for more information</member>
+      <member>It is not necessary to translate a string from the orginal language (English) if the translated string is the same. You can simply leave it blank. By default, DHIS2 will use English values for all strings which have not been translated. </member>
+      <member>All translated strings must be entered in UTF-8 format. If you are using the translation portal, be sure your browser settings are set to UTF-8 when translating. </member>
+      <member>Some special variables (e.g. {0} ) used curly brackets. This denotes a variable which will be replaced by a number or other value by the application. You must place this variable notation in the correct position. </member>
+    </simplelist>
+  </section>
+</chapter>

=== added directory 'src/docbkx/en/resources/images/i18n'
=== added file 'src/docbkx/en/resources/images/i18n/i18n_tool_main_window.png'
Binary files src/docbkx/en/resources/images/i18n/i18n_tool_main_window.png	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/i18n/i18n_tool_main_window.png	2012-01-23 05:19:30 +0000 differ
=== added file 'src/docbkx/en/resources/images/i18n/i18n_tool_select_locale.PNG'
Binary files src/docbkx/en/resources/images/i18n/i18n_tool_select_locale.PNG	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/i18n/i18n_tool_select_locale.PNG	2012-01-23 05:19:30 +0000 differ
=== added file 'src/docbkx/en/resources/images/i18n/i18n_tool_start_translating.PNG'
Binary files src/docbkx/en/resources/images/i18n/i18n_tool_start_translating.PNG	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/i18n/i18n_tool_start_translating.PNG	2012-01-23 05:19:30 +0000 differ
=== added file 'src/docbkx/en/resources/images/i18n/i18n_tool_startup.PNG'
Binary files src/docbkx/en/resources/images/i18n/i18n_tool_startup.PNG	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/i18n/i18n_tool_startup.PNG	2012-01-23 05:19:30 +0000 differ
=== added file 'src/docbkx/en/resources/images/i18n/i18n_web_portal_settings.PNG'
Binary files src/docbkx/en/resources/images/i18n/i18n_web_portal_settings.PNG	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/i18n/i18n_web_portal_settings.PNG	2012-01-23 05:19:30 +0000 differ
=== added file 'src/docbkx/en/resources/images/i18n/i18n_web_portal_translate.PNG'
Binary files src/docbkx/en/resources/images/i18n/i18n_web_portal_translate.PNG	1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/i18n/i18n_web_portal_translate.PNG	2012-01-23 05:19:30 +0000 differ