Removing duplicate syspref
[koha.git] / misc / translator / translator_doc.html
index 73e5733..d960e3e 100644 (file)
@@ -3,22 +3,27 @@
 
 <p>
 This transation tool should greatly help Koha translators.
-It's composed of 2&nbsp;scripts:
+It's composed of 2&nbsp;scripts
+(with a number of associated perl module files):
 
-<ul>
+<ol>
 <li>xgettext.pl, that extracts the texts in a template,
-    and which is called by the script
+    and which is called by the script; and
 <li>tmpl_process3.tmpl, which can do 3 things:
-    <ul>
-    <li>create a file with all the "translatable strings" in all files in a directory (& its subdirectories)
-    <li>update an existing translation file.
-    <li>rebuild translated templates from english & translation file.
+    <ol type=a>
+    <li>create a file with all the "translatable strings" in all files in a directory (& its subdirectories),
+    <li>update an existing translation file, and
+    <li>rebuild translated templates from English & translation file.
     </ul>
 </ul>
 <p>
 Call tmpl_process3.pl --help to get a more detailed explanation.
 Some additional explanations are also available by calling
 perldoc tmpl_process3.pl.
+<p>
+<b>Warning:</b> Those scripts relie upon 'gettext' set of tools. On Debian
+it is included in 'gettext' package.
+</p>
 
 <h2>HOW TO TRANSLATE Koha:
 <br>=====================</h2>
@@ -27,20 +32,22 @@ perldoc tmpl_process3.pl.
 <li>Create your translation file
     (assuming your current directory is this directory, i.e., misc/translator):
     <blockquote>
-./tmpl_process.pl create -i ../../koha-tmpl/opac-tmpl/default/en/ -s css_opac_fr_FR.po -r
+./tmpl_process3.pl create -i ../../koha-tmpl/opac-tmpl/default/en/ -s po/css_opac_fr_FR.po -r
     </blockquote>
     <p>(In the above example,
     ../../koha-tmpl/opac-tmpl/default/en/
     contains the English templates in the "default" theme,
     and po/css_opac_fr_FR.po is where you want the generated PO file to appear.
-    The use of relative paths for the English templates is recommended
-    but is not necessary;
-    it makes the resulting PO files somewhat easier to read.)
+    The use of relative paths for the English templates is recommended;
+    it makes the resulting PO files slightly shorter
+    and more usable in a team environment.
+    Absolute paths are certainly fine,
+    and might be better if there is only one translator for your language.)
 <li>Translate your css_opac_fr_FR.po file
     using a text editor or a PO file translation tool.
 <li>Create your translated templates:
     <blockquote>
-./tmpl_process.pl install -i ../../koha-tmpl/opac-tmpl/default/en/ -o /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/fr2/ -s css_opac_fr_FR.po -r
+./tmpl_process3.pl install -i ../../koha-tmpl/opac-tmpl/default/en/ -o /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/fr2/ -s po/css_opac_fr_FR.po -r
     </blockquote>
     <p>
     (In the above example,
@@ -50,17 +57,17 @@ perldoc tmpl_process3.pl.
 </ol>
 
 <p>
-If something changes in English version:
+If something changes in the English version:
 <ol>
 <li>Update your translation file:
     <blockquote>
-./tmpl_process.pl update -i /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/en/ -s po/css_opac_fr_FR.po -r
+./tmpl_process3.pl update -i ../../koha-tmpl/opac-tmpl/default/en/ -s po/css_opac_fr_FR.po -r
     </blockquote>
-<li>Translate your new css_opac_fr_FR.po file.
+<li>Translate your newly updated css_opac_fr_FR.po file.
     Look for strings marked as "fuzzy" and strings that are not translated.
 <li>Create your translated templates:
     <blockquote>
-./tmpl_process.pl install -i /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/en/ -o /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/fr2/ -s po/css_opac_fr_FR.po -r
+./tmpl_process3.pl install -i ../../koha-tmpl/opac-tmpl/default/en/ -o /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/fr2/ -s po/css_opac_fr_FR.po -r
     </blockquote>
 <li>Copy new images/css files in your new directory if needed
 </ol>