added badguy Nolok_01, as he may appear as the boss of world 1 (still very basic).
[supertux.git] / TRANSLATORS
index 055f7a4..cb1934d 100644 (file)
@@ -2,59 +2,79 @@
 - Translation info -
 http://super-tux.sf.net/
 
-Last update: June 4, 2004
+Last update: June 7, 2004
 
  == TRANSLATORS ==
 
-* Translation Hints *
+1. Notes for Translators
+~~~~~~~~~~~~~~~~~~~~~~~~
 
- If there isn't a good translation for some term (ie. fullscreen), you might consider
-to just keep it. It's better than making the user confused.
+* If there isn't a good translation for some term (ie. fullscreen), you might consider
+  to just keep it. It's better than making the user confused.
 
- In English, there is only one singular second person mode (You). If your language does
-have more than one - a personal and impersonal - remember that this is a game, so you
-should use the personal one. However, if it is possible to ommit it in your language,
-it might be a good idea.
+* In English, there is only one singular second person mode (You). If your language does
+  have more than one - a personal and impersonal - remember that this is a game, so you
+  should use the personal one. And if it is possible to ommit it in your language, it might
+  be a good idea.
 
- Names like SuperTux, Tux, Penny and other game elements should not be translated. If you
-really think one of these to be a too strange word for your people, first inform us at
-our mailing list.
+* Names like SuperTux, Tux, Penny or Nolok should not be translated. If you
+  really think one of these to be a too strange word for your people, first inform us at
+  our mailing list.
+  Minor characters like Mr. Ice Block can (and should) be translated.
 
- Translating lots of strings can be boring and time consuming, but, in my opinion, it
-worths when lookins at the results ;-)
-
-Note: If somewhere in the game, after translating a string, it doesn't look well (bad
-aligment, overlaps other text...), contact us.
-
-* Programs to Aid Translation *
+A couple of notes:
+* If somewhere in the game, after translating a string, it doesn't look well (bad
+  aligment, overlaps other text...), let us know - will be fixed.
 
- My personal favourite is KBabel (don't forget to fill the configuration regarding your
-country).
- I am also aware that (X)Emacs has also a plugin for this effect. I believe Qt also has a
-translation aid program called QTranslator.
+* Currently, only the game itself is translatable. Data files, like levels,
+  credits, story... are not yet translatable.
 
- If you are new to this, the translation file that you should use is the supertux.pot that
-is inside the po/ root folder. Rename it to your language (ie. Spanish - es.po) and then
-open it with any program.
- It is only a plain text file, so you can even use any text editor you want to translate it,
-but it may be wise to use a specific program for the purpose.
- After translating the file, add it to LINGUAS (ie. Spanish - es) and run 'make update-po'.
-Then a binary file will be created. In order to make SuperTux using it, you will have to
-install it ('make install').
+All in all, translating lots of strings can be boring and time consuming, but it
+worths when lookins at the results ;-)
 
-Note: Currently, only the game itself is translatable. Data files, like levels,
-credits, story... are not yet translatable.
+2. Programs to Aid Translation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ KBabel      - a long dated KDE program that has been maturing over the years, and it's
+               really handy by now.
+ poEdit      - a multi-platform po editor (runs under Windows and Unix).
+               URL: http://poedit.sourceforge.net/
+ (X)Emacs    - a commonly used program for translating with the respective plugin.
+ QTranslator - made by Qt, has the advantage of running in several platforms.
+ PO files are written in ASCII and are pretty intuitive, so they can be used by any text
+ editor. But it would be wise to use a program made for that effect. If not possible,
+ use a text editor with highlighting for PO files.
+
+
+ If all of this is new to you, the translation file that you should use is the supertux.pot
+ that is inside the po/ root folder. Rename it to your language (ie. Spanish - es.po) and
+ then open it with an appropriate program.
+ After translating the file, add an entry of your language to the LINGUAS file (ie. Spanish - es)
+ and run 'make update-po'. Then a binary file will be created. In order to make SuperTux using
+ it, you will have to install it ('make install').
+
+ To translate data files, you'll have to use a text editor, since we don't follow any
+ convention. To translate a level's tile, to French, for instance, just do this:
+ (name "Hello World!")
+ (name-fr "Bonjour Monde!")
+ Other data files, like texts in data/, can be translated the same way:
+ (text "Hello World!
+       Bye World!")
+ (text-fr "Bonjour Monde!
+           Au revoir Monde!")
 
 
  == DEVELOPERS ==
 
-* Translatable Strings *
+1. Translatable Strings
+~~~~~~~~~~~~~~~~~~~~~~~
 
  Output should not be translated, since their purpose is mainly for debugging.
  However, command description (ie. --help) should obviously be translated. Messages
-that give the user a solution for a problem, might be translatable, as well.
+ that give the user a solution for a problem, might be translatable, as well.
+
+ Parametars shouldn't also be translatable. It breaks scripting, besides advanced users,
+ the ones that will make use of this, usually don't like it.
 
- Parametars shouldn't also be translatable. It breaks scripting. Besides advanced users,
-the ones that will make use of this, usually don't like it.
 
 The SuperTux Team