README.I18N

   1 Quick Guide for new translations
   2 --------------------------------
   3
   4 If you would like to translate Geany into another language, have a look at the
   5 language statistics page at [1] first to see if your desired language already
   6 exists. If it already exists, please read the "Notes for updating translations"
   7 section. Otherwise, get the Git version of Geany, change to the po directory and
   8 start the new translation with:
   9
  10 $ msginit -l ll_CC -o ll.po -i geany.pot
  11
  12 Fill in ll with the language code and CC with the country code. For example, to
  13 translate Geany into Italian you would type:
  14
  15 $ msginit -l it_IT -o it.po -i geany.pot
  16
  17 This will create a file it.po. This file can be opened with a text editor
  18 (e.g. Geany ;-)) or a graphical program like PoEdit [2]. There are also several
  19 other GUI programs for working on translations.
  20
  21 You don't need to modify the file po/LINGUAS, it is regenerated automatically on
  22 the next build.
  23
  24 When you have finished editing the file, check the file with:
  25
  26 $ msgfmt -c --check-accelerators=_ it.po
  27
  28 Please ensure you also translate the mnemonic letters (strings containing a
  29 "_" before a letter, also called "accelerators" on some platforms/toolkits).
  30 When the user wishes to activate a menu item using their keyboard, they will
  31 use this letter to pick an item from the menu.
  32
  33 Here are a few notes on picking which letter to use:
  34
  35 * Always follow platform/toolkit conventions (for example "t" for "Cut") even
  36 if they don't necessarily seem obvious.
  37 * Try to choose the first letter of the command name, where this is the most
  38 appropriate letter (for example "S" for "Save"), assuming it's not already
  39 used in the same menu.
  40 * Try not to use the same character more than once in the same menu as this
  41 will cause the user to have to press the mnemonic's key multiple times to
  42 select the correct menu item.
  43 * If there is no letter in the text that can easily be entered from a keyboard
  44 then choose another character that can be, and put it in parenthesis after the
  45 translated text.
  46 * Try not to change which letter is used whenever possible as it is not
  47 user-configurable and users may have become accustomed to using the existing
  48 mnemonic key.
  49
  50 You can also use intl_stats.sh, e.g. by running the following command in the top
  51 source directory of Geany:
  52
  53 $ po/intl_stats.sh -a it
  54
  55 This will print some information about the Italian translation and checks for
  56 menu accelerators.
  57
  58 When you have finished your work - which doesn't mean you finished the
  59 translation, you will not have to work alone - send the file to the translation
  60 mailing list [3] or directly to Frank Lanitz [4] and he will add the translation
  61 to Geany then.
  62
  63 It is a good idea to let any translator and Frank know before you start or while
  64 translating, because they can give you hints on translating and Frank can ensure
  65 that a translation is not already in progress.
  66
  67
  68 Notes for updating translations
  69 -------------------------------
  70
  71 If you want to update an existing translation, please contact the translation
  72 mailing list [3] and/or Frank Lanitz [4] directly. He is supervising all
  73 translation issues and will contact the maintainer of the translation you want
  74 to update to avoid any conflicts.
  75
  76 Some translation statistics can be found at:
  77 https://i18n.geany.org/
  78
  79
  80 I18n mailing list
  81 -----------------
  82
  83 There is also a mailing list dedicated to translation issues. Please visit
  84 https://www.geany.org/Support/MailingList#geany-i18 for more information.
  85
  86
  87 [1] https://i18n.geany.org/
  88 [2] https://www.poedit.net/
  89 [3] https://www.geany.org/support/mailing-lists/#geany-i18n
  90 [4] Frank Lanitz <frank(at)frank(dot)uvena(dot)de>