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:
   6
   7   * xgettext.pl, that extracts the texts in a template, and which is called by
   8     the script
   9   * tmpl_process3.tmpl, which can do 3 things:
  10       + create a file with all the "translatable strings" in all files in a
  11         directory (& its subdirectories)
  12       + update an existing translation file.
  13       + 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:
  22
  23         ./tmpl_process.pl create -i /home/paul/koha.dev/koha/koha-tmpl/
  24         opac-tmpl/default/en/ -s css_opac_fr_FR.po -r
  25
  26     (In the above example, /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default
  27     /en/ contains the English templates in the "default" theme, and po/
  28     css_opac_fr_FR.po is where you want the generated PO file to appear.)
  29  2. Translate your css_opac_fr_FR.po file using a text editor or a PO file
  30     translation tool.
  31  3. Create your translated templates:
  32
  33         ./tmpl_process.pl install -i /home/paul/koha.dev/koha/koha-tmpl/
  34         opac-tmpl/default/en/ -o /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/
  35         default/fr2/ -s css_opac_fr_FR.po -r
  36
  37     (In the above example, /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/default
  38     /fr2/ is where you want your translated templates to be saved.)
  39  4. Copy images/css files in your new directory (as they are NOT moved by
  40     tmpl_process3.pl install).
  41
  42 If something changes in English version:
  43
  44  1. Update your translation file:
  45
  46         ./tmpl_process.pl update -i /home/paul/koha.dev/koha/koha-tmpl/
  47         opac-tmpl/default/en/ -s po/css_opac_fr_FR.po -r
  48
  49  2. Translate your new css_opac_fr_FR.po file. Look for strings marked as
  50     "fuzzy" and strings that are not translated.
  51  3. Create your translated templates:
  52
  53         ./tmpl_process.pl install -i /home/paul/koha.dev/koha/koha-tmpl/
  54         opac-tmpl/default/en/ -o /home/paul/koha.dev/koha/koha-tmpl/opac-tmpl/
  55         default/fr2/ -s po/css_opac_fr_FR.po -r
  56
  57  4. Copy new images/css files in your new directory if needed
  58
  59 WEAKNESSES
  60 ==========
  61
  62 For a somewhat up-to-date list of weaknesses, please run perldoc xgettext.pl
  63 and perldoc tmpl_process3.pl and read the BUGS sections.
  64
  65 COPYRIGHT
  66 =========
  67
  68   * Paul Poulain (paul.poulain _@_ free.fr) & Jerome Vizcaino (vizcainj _@_
  69     esiee.fr)
  70   * Parts of V3.0 by Ambrose Li (acli _@_ ada.dhs.org)
  71