diff --git a/docs/CHANGES.txt b/docs/CHANGES.txt index d9f22d807..a12167318 100644 --- a/docs/CHANGES.txt +++ b/docs/CHANGES.txt @@ -55,6 +55,7 @@ $Id$ * Discussed SVG Stamps in "Extending Tux Paint." * Created an "SVG.txt" document, covering SVG software. + FIXME: Not done yet? * Mentioned descriptive sounds (e.g., "stamp_desc_ll.ogg") in "Extending..." @@ -64,6 +65,9 @@ $Id$ * Example tuxpaint.conf has been updated to include newer options. + * Briefly documented translation (gettext PO catalogs) in "Extending..." + + * Bug Fixes: ---------- * Tux the Penguin sound effects were not working; fixed. diff --git a/docs/EXTENDING.txt b/docs/EXTENDING.txt index 45bf342a6..55318aa49 100644 --- a/docs/EXTENDING.txt +++ b/docs/EXTENDING.txt @@ -2,13 +2,13 @@ version 0.9.17 Extending Tux Paint - Copyright 2002-2006 by Bill Kendrick and others + Copyright 2002-2007 by Bill Kendrick and others New Breed Software bill@newbreedsoftware.com http://www.tuxpaint.org/ - June 14, 2002 - October 26, 2006 + June 14, 2002 - April 26, 2007 -------------------------------------------------------------------------- @@ -521,3 +521,53 @@ Fonts to affect the drawing even after Tux Paint has been quit, or another picture loaded or started. (In other words, if you base a drawing on a 'starter' image, it will always be affected by it.) + +Translations + + Tux Paint supports numerous languages, thanks to use of the "gettext" + localization library. (See OPTIONS for how to change locales in + Tux Paint.) + + To translate Tux Paint to a new language, copy the translation template + file, "tuxpaint.pot" (found in Tux Paint's source code, in the folder + "src/po/"). Rename the copy as a ".po" file, with an appropriate name + for the locale you're translating to (e.g., "es.po" for Spanish; or + "pt_br.po" for Brazilian Portuguese, versus "pt.po" or "pt_pt.po" for + Portuguese spoken in Portugal.) + + Open the newly-created ".po" file -- you can edit in a plain text + edtior, such as Emacs, Pico or VI on Linux, or NotePad on Windows. The + original English text used in Tux Paint is listed in lines starting with + "msgid". Enter your translations of each of these pieces of text in the + empty "msgstr" lines directly below the corresponding "msgid" lines. + (Note: Do not remove the quotes.) + + Example: + + msgid "Smudge" + msgstr "Manchar" + + msgid "Click and move to draw large bricks." + msgstr "Haz clic y arrastra para dibujar ladrillos grandes." + + A graphical tool, called poEdit (http://www.poedit.net/), is available + for Linux, Windows and Mac OS X. + + Note: It is best to always work off of the latest Tux Paint text catalog + template ("tuxpaint.pot"), since new text is added, and old text is + occasionally changed. The text catalog for the upcoming, unreleased + version of Tux Paint can be found in Tux Paint's CVS repository (see: + http://www.tuxpaint.org/download/source/cvs/), and on the Tux Paint + website at http://www.tuxpaint.org/help/po/. + + To edit an existing translation, download the latest ".po" file for that + language, and edit it as described above. + + You may send new or edited translation files to Bill Kendrick, lead + developer of Tux Paint, at: bill@newbreedsoftware.com, or post them to + the "tuxpaint-i18n" mailing list (see: http://www.tuxpaint.org/lists/). + + Alternatively, if you have an account with SourceForge.net, you can + request to be added to the "tuxpaint" project and receive write-access + to the CVS source code repository so that you may commit your changes + directly. diff --git a/docs/html/EXTENDING.html b/docs/html/EXTENDING.html index beb1ffd3d..dd778d05f 100644 --- a/docs/html/EXTENDING.html +++ b/docs/html/EXTENDING.html @@ -17,13 +17,13 @@ version
Extending Tux Paint -

Copyright 2002-2006 by Bill Kendrick and others
+

Copyright 2002-2007 by Bill Kendrick and others
New Breed Software

bill@newbreedsoftware.com
http://www.tuxpaint.org/

-

June 14, 2002 - October 26, 2006

+

June 14, 2002 - April 26, 2007

@@ -676,5 +676,69 @@ effect.


+

Translations

+
+

Tux Paint supports numerous languages, thanks to use of the + "gettext" localization library. (See OPTIONS + for how to change locales in Tux Paint.)

+ +

To translate Tux Paint to a new language, copy the translation + template file, "tuxpaint.pot" (found in Tux Paint's + source code, in the folder "src/po/"). Rename the copy as a + ".po" file, with an appropriate name for the locale you're + translating to (e.g., "es.po" for Spanish; or + "pt_br.po" for Brazilian Portuguese, versus + "pt.po" or "pt_pt.po" for Portuguese spoken in + Portugal.)

+ +

Open the newly-created ".po" file — you can edit + in a plain text edtior, such as Emacs, Pico or VI on Linux, or + NotePad on Windows. The original English text used in Tux Paint + is listed in lines starting with "msgid". Enter your + translations of each of these pieces of text in the empty + "msgstr" lines directly below the corresponding + "msgid" lines. (Note: Do not remove the quotes.)

+ +

Example:

+ +
+

msgid "Smudge"
+ msgstr "Manchar"
+  
+ msgid "Click and move to draw large bricks."
+ msgstr "Haz clic y arrastra para dibujar ladrillos grandes." +

+
+ +

A graphical tool, called poEdit + (http://www.poedit.net/), is available + for Linux, Windows and Mac OS X.

+ +

Note: It is best to always work off of the latest + Tux Paint text catalog template ("tuxpaint.pot"), + since new text is added, and old text is occasionally changed. + The text catalog for the upcoming, unreleased version of Tux Paint + can be found in Tux Paint's CVS repository + (see: http://www.tuxpaint.org/download/source/cvs/), + and on the Tux Paint website at + http://www.tuxpaint.org/help/po/.

+ +

To edit an existing translation, download the latest ".po" + file for that language, and edit it as described above.

+ +

You may send new or edited translation files to Bill Kendrick, + lead developer of Tux Paint, at: + bill@newbreedsoftware.com, + or post them to the "tuxpaint-i18n" mailing list + (see: http://www.tuxpaint.org/lists/).

+ +

Alternatively, if you have an account with + SourceForge.net, you can request + to be added to the "tuxpaint" project and receive write-access + to the CVS source code repository so that you may commit your changes + directly.

+ +
+