README.localization

   1
   2         Localization/Translation FAQ
   3
   4     by Ran Rutenberg, Pavel Sanda, Michael Gerz
   5
   6     February 2007
   7
   8 This file is mainly intended for those who have no or little experience using
   9 .po files, but want to contribute by translating the LyX interface into their
  10 native language.
  11
  12
  13 1) WHERE DO I START?
  14
  15 The file you need to edit it an xx.po file where xx stands for your language's
  16 two letter code. German would be for example de.po and Polish pl.po. For a list
  17 of languages codes look at:
  18
  19   http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#Language-Codes
  20
  21 If you want to start from scratch then you should obtain a copy of the lyx.pot
  22 and name it after your language. German would be for example de.po and Polish
  23 pl.po. This file is generated in the "po" directory of the source tree during
  24 the compilation.
  25
  26
  27 2) HOW DO I EDIT PO FILES?
  28
  29 PO files can be edited with every text editor available for your system (e.g.
  30 VIM, NotePad etc.). Yet another option is to use a specialized editor for .po
  31 files. You can e.g. use the editors "poEdit" or "jEdit", Linux users can
  32 additionally use e.g. "kbabel". Using these editors usually makes things easier
  33 as they have many tools to assist the translator.
  34
  35
  36 3) WHAT DO I NEED TO TRANSLATE?
  37
  38 If you are using a simple text editor you should translate the strings that
  39 appear in the msgid line and write the translation into the msgstr line. Note
  40 that a "#, fuzzy" line is just a hint for translation from compiler - in order
  41 to get the translation of the current item working you have to delete this
  42 line. It is recommended that you would take a look at another .po file - that
  43 way you can get an idea of what to do. If you are using a specialized po editor
  44 then you will see in it the untranslated strings and a place to write your
  45 translation for them.
  46
  47
  48 4) WHAT SHOULD I DO WITH THE '&', '|', '$, '%' AND [[]] CHARACTERS?
  49
  50 '&' stands for underlined characters (shortcut) in dialog boxes.
  51 '|' stands for underlined characters in menus.
  52
  53 These chars should be somehow used in your translations, however you'll have to
  54 invent your own working shortcuts for dialog and menu entries and resolve
  55 possible conflicts of the same shortcut chars in one menu...
  56
  57 Note also that there are already used global shortcuts (such as p k x c m) and
  58 you should avoid to use these characters for first-level menu shortcuts.
  59
  60 '$' and '%' are usually used as handlers for formatting or variables to be
  61 inserted into the strings. Character sequences like %1$s or %1$d MUST also
  62 appear in your translations! Please take them exactly as they are or you may
  63 experience crashes when running LyX.
  64
  65 [[Context]] is used to distinguish otherwise identical strings, which could
  66 have different translation dependent on the Context. [[Context]] appears only
  67 in msgid string and should not be repeated in the translated version.
  68
  69
  70 5) WHAT IS pocheck.pl AND HOW DO I USE IT?
  71
  72 This is a small script located in the "po" directory of the source that helps
  73 you find common errors in your translation. In order to use this script you have
  74 to have the script language Perl installed.
  75
  76
  77 6) HOW CAN I TEST MY TRANSLATION?
  78
  79 In order to test your translation you need to obtain the LyX sources (from the
  80 SVN repository) and replace the existing .po with yours. Afterwards, you should
  81 compile and install LyX (check the INSTALL file for your OS). If you don't
  82 install LyX it won't work. In order to run LyX with your translation, use the
  83 appropriate LANG variable:
  84
  85   On Linux: LANG=xx_CC lyx
  86   On Windows, you need to change the lyx.bat file and write: set LANG=xx_CC
  87
  88 xx stands for your language code. CC stands for your country code. So to get,
  89 e.g., Czech, the code is "cs_CZ".
  90
  91 The most comfortable way to see your updated translation while editing, is
  92 running (in linux):
  93 1. "make xx.gmo" in the po directory to compile updated xx.po translation
  94 2. "make install" in root lyx tree to copy xx.gmo into the appropriate location
  95    (or do it by hand...)
  96
  97 For advanced users - if you want to remerge your files against current source
  98 files run make update-po.
  99
 100
 101 7) HOW TO CONTRIBUTE MY WORK?
 102
 103 You can manually use diff utility to make patch; usually the most comfortable
 104 way is to run something like (after you edit xx.po):
 105
 106         svn diff xx.po > xx.po.patch
 107
 108 This file should be sent to po-updates@lyx.org.
 109
 110 Also you can check http://www.lyx.org/trac/browser/lyx-devel/trunk to track
 111 changes or watch updates.
 112
 113
 114 8) REFERENCES
 115
 116 For some basic idea on how the translation works, you can look at
 117
 118   http://en.wikipedia.org/wiki/Gettext
 119
 120 For detailed reference (including full list of country and language codes),
 121 have a look at
 122
 123   http://www.gnu.org/software/gettext/manual/gettext.html
 124
 125
 126 Consider subscribing to the documentation list at lyx-docs@lists.lyx.org (rather
 127 silent one) or developer's mailing list lyx-devel@lists.lyx.org (high volume).