misc/translator/translator_doc.html

   1 <h1>TRANSLATION TOOL, V3.0:
   2 <br>======================</h1>
   3
   4 <p>
   5 This transation tool should greatly help Koha translators.
   6 It's composed of 2&nbsp;scripts:
   7
   8 <ul>
   9 <li>xgettext.pl, that extracts the texts in a template,
  10     and which is called by the script
  11 <li>tmpl_process3.tmpl, which can do 3 things:
  12     <ul>
  13     <li>create a file with all the "translatable strings" in all files in a directory (& its subdirectories)
  14     <li>update an existing translation file.
  15     <li>rebuild translated templates from english & translation file.
  16     </ul>
  17 </ul>
  18 <p>
  19 Call tmpl_process3.pl --help to get a more detailed explanation.
  20 Some additional explanations are also available by calling
  21 perldoc tmpl_process3.pl.
  22
  23 <h2>HOW TO TRANSLATE Koha:
  24 <br>=====================</h2>
  25
  26 <ol>
  27 <li>Create your translation file
  28     (assuming your current directory is this directory, i.e., misc/translator):
  29     <blockquote>
  30 ./tmpl_process.pl create -i ../../koha-tmpl/opac-tmpl/default/en/ -s css_opac_fr_FR.po -r
  31     </blockquote>
  32     <p>(In the above example,
  33     ../../koha-tmpl/opac-tmpl/default/en/
  34     contains the English templates in the "default" theme,
  35     and po/css_opac_fr_FR.po is where you want the generated PO file to appear.
  36     The use of relative paths for the English templates is recommended
  37     but is not necessary;
  38     it makes the resulting PO files somewhat easier to read.)
  39 <li>Translate your css_opac_fr_FR.po file
  40     using a text editor or a PO file translation tool.
  41 <li>Create your translated templates:
  42     <blockquote>
  43 ./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
  44     </blockquote>
  45     <p>
  46     (In the above example,
  47     /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/fr2/
  48     is where you want your translated templates to be saved.)
  49 <li>Copy images/css files in your new directory (as they are NOT moved by tmpl_process3.pl install).
  50 </ol>
  51
  52 <p>
  53 If something changes in English version:
  54 <ol>
  55 <li>Update your translation file:
  56     <blockquote>
  57 ./tmpl_process.pl update -i /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default/en/ -s po/css_opac_fr_FR.po -r
  58     </blockquote>
  59 <li>Translate your new css_opac_fr_FR.po file.
  60     Look for strings marked as "fuzzy" and strings that are not translated.
  61 <li>Create your translated templates:
  62     <blockquote>
  63 ./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
  64     </blockquote>
  65 <li>Copy new images/css files in your new directory if needed
  66 </ol>
  67
  68 <h2>WEAKNESSES
  69 <br>==========</h2>
  70 <p>For a somewhat up-to-date list of weaknesses,
  71 please run <code>perldoc xgettext.pl</code>
  72 and <code>perldoc tmpl_process3.pl</code>
  73 and read the BUGS sections.
  74
  75 <h2>COPYRIGHT
  76 <br>=========</h2>
  77 <ul>
  78 <li>Paul Poulain (paul.poulain _@_ free.fr) & Jerome Vizcaino (vizcainj _@_ esiee.fr)
  79 <li>Parts of V3.0 by Ambrose Li (acli _@_ ada.dhs.org)
  80 </ul>