format this file in a sane way and correct some information
[supertux.git] / TRANSLATORS
1                         - SuperTux Translation info -
2
3 Last update: June 4, 2004
4
5
6 1. Notes for Translators
7 ~~~~~~~~~~~~~~~~~~~~~~~~
8
9 * If there isn't a good translation for some term (ie. fullscreen), you might
10   consider to just keep it. It's better than making the user confused.
11
12 * In English, there is only one singular second person mode (You). If your
13   language does have more than one - a personal and impersonal - remember that
14   this is a game, so you should use the personal one. However, if it is
15   possible to ommit it in your language, it might be a good idea.
16
17 * Names like SuperTux, Tux, Penny and other game elements should not be
18   translated. If you really think one of these to be a too strange word for
19   your people, first inform us at our mailing list.
20
21 * Translating lots of strings can be boring and time consuming, but, in my
22   opinion, it worths when lookins at the results ;-)
23
24 * If somewhere in the game, after translating a string, it doesn't look well
25   (bad aligment, overlaps other text...), contact us. We might be able to change
26   to code.
27
28 * There are programs that help with translating: KBable and the gettext Emacs
29   plugin can give your productivity a huge boost.
30
31 * Please read gettext documentation on how to start translating.
32    http://www.gnu.org/software/gettext/manual/html_chapter/gettext_5.html#SEC29
33
34 * After translating the file, add it to LINGUAS (ie. Spanish - es) and run
35   'make update-po'.
36
37 * You currently have to install supertux to see the results of the translation.
38
39 * Currently, only the game itself is translatable. Data files, like levels, 
40   credits, story... are not yet translatable (but that is planed for later).
41
42
43
44 2. DEVELOPERS
45 ~~~~~~~~~~~~~
46
47 * Debugging output should not be translated. That is everything that goes to the
48   console except error messages and the usage text of the program.
49
50 * Parametars shouldn't also be translatable.
51