misc/translator/translator_doc.txt

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