A file to aid translators.
[supertux.git] / TRANSLATORS
1
2 - Translation info -
3 http://super-tux.sf.net/
4
5 Last update: June 4, 2004
6
7  == TRANSLATORS ==
8
9 * Translation Hints *
10
11  If there isn't a good translation for some term (ie. fullscreen), you might consider
12 to just keep it. It's better than making the user confused.
13
14  In English, there is only one singular second person mode (You). If your language does
15 have more than one - a personal and impersonal - remember that this is a game, so you
16 should use the personal one. However, if it is possible to ommit it in your language,
17 it might be a good idea.
18
19  Names like SuperTux, Tux, Penny and other game elements should not be translated. If you
20 really think one of these to be a too strange word for your people, first inform us at
21 our mailing list.
22
23  Translating lots of strings can be boring and time consuming, but, in my opinion, it
24 worths when lookins at the results ;-)
25
26 Note: If somewhere in the game, after translating a string, it doesn't look well (bad
27 aligment, overlaps other text...), contact us.
28
29 * Programs to Aid Translation *
30
31  My personal favourite is KBabel (don't forget to fill the configuration regarding your
32 country).
33  I am also aware that (X)Emacs has also a plugin for this effect. I believe Qt also has a
34 translation aid program called QTranslator.
35
36  If you are new to this, the translation file that you should use is the supertux.pot that
37 is inside the po/ root folder. Rename it to your language (ie. Spanish - es.po) and then
38 open it with any program.
39  It is only a plain text file, so you can even use any text editor you want to translate it,
40 but it may be wise to use a specific program for the purpose.
41  After translating the file, add it to LINGUAS (ie. Spanish - es) and run 'make update-po'.
42 Then a binary file will be created. In order to make SuperTux using it, you will have to
43 install it ('make install').
44
45 Note: Currently, only the game itself is translatable. Data files, like levels,
46 credits, story... are not yet translatable.
47
48
49  == DEVELOPERS ==
50
51 * Translatable Strings *
52
53  Output should not be translated, since their purpose is mainly for debugging.
54  However, command description (ie. --help) should obviously be translated. Messages
55 that give the user a solution for a problem, might be translatable, as well.
56
57  Parametars shouldn't also be translatable. It breaks scripting. Besides advanced users,
58 the ones that will make use of this, usually don't like it.
59
60 The SuperTux Team