Changeset 717 for branches/PublicaMundi_David-devel/docs/services/translation.rst

Timestamp:

Jun 30, 2015, 10:30:52 PM (9 years ago)

Author:

djay

Message:

Move translation into ZOO-Services and add a specific sub-section about Translation support for ZOO-Kernel internal messages.

File:

• branches/PublicaMundi_David-devel/docs/services/translation.rst (moved) (moved from branches/PublicaMundi_David-devel/docs/contribute/translate.rst) (6 diffs)

branches/PublicaMundi_David-devel/docs/services/translation.rst

@@ -1 @@
-.. _contribute_trans:
+.. _service_translation:
 
-Contribute translation
-===============
+Translation Support
+===================
 
-Anybody can take part to the `ZOO-Project <http://zoo-project.org>`__ translation and is welcome to:
+ZOO-Kernel support translating internal messages it emits but it can
+also translate both the metadata informations stored in the ZCFG file
+and the messages emitted by the ZOO-Service itself. This document show
+how to create the files required to handle such a translation process
+for the ZOO-Services.
 
- * Translate ZOO-Services configuration files
-   
- * Translate documentation
-   
 
 ZCFG translation
 --------------------------
 
-First of all, use the following commands from your Services Provider directory in order to extract all the messages to translate from the ZCFG files :
+First of all, use the following commands from your Services Provider
+directory in order to extract all the messages to translate from the
+ZCFG files :
 
   ::
   
       #!/bin/bash
+      mkdir -p locale/{po,.cache}
       for j in cgi-env/*zcfg ; 
         do 
@@ -28 +31 @@
    
 
-Then generate the 'messages.po' file based on the Services Provider source code using the following command :
+Then generate the 'messages.po' file based on the Services Provider
+source code (located in ``service.c`` in this example) using the
+following command:
 
   ::
@@ -35 +40 @@
       xgettext service.c locale/.cache/my_service_string_to_translate.c -o message.po -p locale/po/ -k_ss
 
-Once 'messages.po' is created, use the following command to create the po file for the targeted language for translation. We will use the French language here as an example :
+Once 'messages.po' is created, use the following command to create the
+``.po`` file for the targeted language to translate into. We will use the
+French language here as an example:
 
   ::
@@ -43 +50 @@
       msginit -i messages.po -o zoo_fr_FR.po -l fr
 
-Edit the zoo_fr_FR.po file with your favorite text editor or using one of the following tools :
+Edit the ``zoo_fr_FR.po`` file with your favorite text editor or using
+one of the following tools:
 
  * `poedit <http://www.poedit.net/>`__
@@ -49 +57 @@
  * `transifex <https://www.transifex.net/>`__
  
-Once the zoo_fr_FR.po file is completed, you can generate and install the corresponding *mo* file using the following command : 
+Once the ``zoo_fr_FR.po`` file is completed, you can generate and
+install the corresponding ``.mo`` file using the following command:
 
   ::
@@ -74 +83 @@
       msgcat -o compilation.po $(find ../../ -name fr_FR.utf8.po)
       msgfmt compilation.po -o /usr/share/locale/fr/LC_MESSAGES/zoo-services.mo
-
-
-Documentation translation
---------------------------
-
-Translate the `ZOO-Project <http://zoo-project.org>`__ documentation in your language !
-
-Please refer to the :ref:`<contribute_doc>` section to learn more.