TRANSLATORS

   1
   2 - Translation info -
   3 http://super-tux.sf.net/
   4
   5 Last update: June 7, 2004
   6
   7  == TRANSLATORS ==
   8
   9 1. Notes for Translators
  10 ~~~~~~~~~~~~~~~~~~~~~~~~
  11
  12 * If there isn't a good translation for some term (ie. fullscreen), you might consider
  13   to just keep it. It's better than making the user confused.
  14
  15 * In English, there is only one singular second person mode (You). If your language does
  16   have more than one - a personal and impersonal - remember that this is a game, so you
  17   should use the personal one. And if it is possible to ommit it in your language, it might
  18   be a good idea.
  19
  20 * Names like SuperTux, Tux, Penny or Nolok should not be translated. If you
  21   really think one of these to be a too strange word for your people, first inform us at
  22   our mailing list.
  23   Minor characters like Mr. Ice Block can (and should) be translated.
  24
  25 A couple of notes:
  26 * If somewhere in the game, after translating a string, it doesn't look well (bad
  27   aligment, overlaps other text...), let us know - will be fixed.
  28
  29 * Currently, only the game itself is translatable. Data files, like levels,
  30   credits, story... are not yet translatable.
  31
  32 All in all, translating lots of strings can be boring and time consuming, but it
  33 worths when lookins at the results ;-)
  34
  35 2. Programs to Aid Translation
  36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37
  38  KBabel      - a long dated KDE program that has been maturing over the years, and it's
  39                really handy by now.
  40  poEdit      - a multi-platform po editor (runs under Windows and Unix).
  41                URL: http://poedit.sourceforge.net/
  42  (X)Emacs    - a commonly used program for translating with the respective plugin.
  43  QTranslator - made by Qt, has the advantage of running in several platforms.
  44  PO files are written in ASCII and are pretty intuitive, so they can be used by any text
  45  editor. But it would be wise to use a program made for that effect. If not possible,
  46  use a text editor with highlighting for PO files.
  47
  48
  49  If all of this is new to you, the translation file that you should use is the supertux.pot
  50  that is inside the po/ root folder. Rename it to your language (ie. Spanish - es.po) and
  51  then open it with an appropriate program.
  52  After translating the file, add an entry of your language to the LINGUAS file (ie. Spanish - es)
  53  and run 'make update-po'. Then a binary file will be created. In order to make SuperTux using
  54  it, you will have to install it ('make install').
  55
  56  To translate data files, you'll have to use a text editor, since we don't follow any
  57  convention. To translate a level's tile, to French, for instance, just do this:
  58  (name "Hello World!")
  59  (name-fr "Bonjour Monde!")
  60  Other data files, like texts in data/, can be translated the same way:
  61  (text "Hello World!
  62        Bye World!")
  63  (text-fr "Bonjour Monde!
  64            Au revoir Monde!")
  65
  66
  67  == DEVELOPERS ==
  68
  69 1. Translatable Strings
  70 ~~~~~~~~~~~~~~~~~~~~~~~
  71
  72  Output should not be translated, since their purpose is mainly for debugging.
  73  However, command description (ie. --help) should obviously be translated. Messages
  74  that give the user a solution for a problem, might be translatable, as well.
  75
  76  Parametars shouldn't also be translatable. It breaks scripting, besides advanced users,
  77  the ones that will make use of this, usually don't like it.
  78
  79
  80 The SuperTux Team