README.po-files

   1
   2         PO FAQ
   3
   4    by Ran Rutenberg, Pavel Sanda
   5    February 2007
   6
   7 This file is mainly intended for those who have no or little experience using .po files,
   8 but want to contribute by translating the LyX interface into their native language.
   9
  10 1) WHERE DO I START?
  11
  12 The file you need to edit it an xx.po file where xx stands for your language's two letter
  13 code. German would be for example de.po and Polish pl.po.
  14 For a list of country codes look at:
  15 http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#SEC222
  16 If you want to start from scratch than you should obtain a copy of the lyx.pot file.
  17
  18 2) HOW DO I EDIT PO FILES?
  19
  20 PO files can be edited with every text editor available for your system (e.g. VIM, NotePad etc.).
  21 Yet another option is to use a specialized editor for .po files. You can e.g. use the editors
  22 "poEdit" or "jEdit", Linux users can additionally use e.g. "kbabel". Using these editors usually
  23 makes things easier as they have many tools to assist the translator.
  24
  25 3) WHAT DO I NEED TO TRANSLATE?
  26
  27 If your using a simple text editor you should translate the strings that appear in the msgid line
  28 and write the translation into the msgstr line. Note that a "#, fuzzy" line is just a hint
  29 for translation from compiler - in order to get the translation of the current item working
  30 you have to delete this line. It is recommended that you would take a look at another .po file -
  31 that way you can get an idea of what to do.
  32 If your using a specialized po editor then you will see in it the untranslated strings and a
  33 place to write your translation for them.
  34
  35 4) WHAT SHOULD I DO WITH THE '&', '|', '$, AND '%' CHARACTERS?
  36
  37 '&' stands for underlined characters (shortcut) in dialog boxes.
  38 '|' stands for underlined characters in menus.
  39 '$' and '%' are usually used as handlers for formating or variables to be inserted
  40 into the strings.
  41 So all these chars should be somehow used in your translations, however
  42 you'll have to invent your own working shortcuts for dialog and menu entries
  43 and resolve possible conflicts of the same shortcut chars in one menu...
  44
  45 5) WHAT IS pocheck.pl AND HOW DO I USE IT?
  46
  47 This is a small script located in the "po" directory of the source that helps you find common
  48 errors in your translation. In order to use this script you have to have the script language Perl
  49 installed.
  50
  51 6) HOW CAN I TEST MY TRANSLATION?
  52
  53 In order to test your translation you need to obtain the LyX source (from the SVN) and replace
  54 the existing .po with yours. Afterwards, you should compile and install LyX (check the INSTALL
  55 file for your OS). If you don't install LyX it won't work.
  56 For running LyX with your translation, use the appropriate LANG variable:
  57 In Linux: LANG=xx_CC lyx
  58 In Windows you need to change the lyx.bat file and write: set LANG=xx_CC
  59 xx stands for your language code. CC stands for your country code. So to get for example Czech
  60 the code is "cs_CZ".
  61
  62 7) REFERENCES
  63 For basic idea how the translation works you can look http://en.wikipedia.org/wiki/Gettext
  64 Just for detailed reference you can look at http://www.gnu.org/software/gettext/manual/gettext.html