NicolasVervelle: Subpages

2008-04-05T10:47:16Z

Subpages

New page

1. Download and install [http://www.gnu.org/software/gettext/gettext.html gettext]. Linux users should try to install it using their distributions package management (like rpm, dpkg, apt, ...). Windows user download gettext from http://gnuwin32.sourceforge.net/packages/gettext.htm. Both make sure, that the gettext binaries are in your PATH environment variable.

'''Note for Windows users:''' If you installed the gettext binaries into e.g. {{Directory|C:\Program Files\GnuWin32}}, then you need to add <tt>C:\Program Files\GnuWin32\bin;</tt> to the existing PATH environment variable: {{MenuItem|Control Panel}} → {{MenuItem|System}} → {{MenuItem|Environment Variable}} (Tab Extended) OR run the following command in a windows command shell: <tt>set PATH=%PATH%;C:\Program Files\GnuWin32\bin;.</tt>. Windows XP and Windows 2000 are currently supported.

2. All targets related to internationalisation and localisation issues are part of {{File|build-i18n.xml}}. To create PO-template files, run <tt>ant -f build-i18n.xml update-pot</tt>. All {{File|''LANG''.po}} files (which contain the translation and are maintained by the translator himself) are updated with <tt>ant -f build-i18n.xml update-po</tt>. To create the final message catalogs, run <tt>ant -f build-i18n.xml update-catalog</tt>.

3. To create a translation in your language, go to {{Directory|src/org/jmol/translation/Jmol}} (for the application, respectively {{Directory|src/org/jmol/translation/JmolApplet}} for the applet) and copy {{File|Jmol.pot}} (resp. {{File|JmolApplet.pot}}) to {{File|Jmol-''LANG''.po}} (resp. {{File|JmolApplet-''LANG''.po}}) - <tt>''LANG''</tt> means your language code: e.g. <tt>de</tt> for German, <tt>fr</tt> for French and so on.

4. To begin your translation, open the newly created {{File|Jmol-''LANG''.po}} or {{File|JmolApplet-''LANG''.po}} files with an editor of your choice - '''Windows users be aware, that the editor MUST NOT add any control characters (like e.g. Word does)!.''' There are also specialised editors for this work: e.g. [http://www.poedit.net/ poedit], [http://i18n.kde.org/tools/kbabel/ kbabel], or [http://gtranslator.sourceforge.net/ gtranslator].

5. The opened file will look like this:

# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#

These lines are '''comments'''. Adjust them and add a descritpive title, the right copyright and your name as author. Be aware, that lines beginning with #, or #: have a special meaning and are not normal comments.

#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: jmol-developers@lists.sourceforge.net\n"
"POT-Creation-Date: 2005-06-01 02:02+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

We call this part the '''po-headers'''. The line <tt>#, fuzzy</tt> says, that the headers are outdated. Customise <tt>"Project-Id-Version: PACKAGE VERSION\n"</tt>, <tt>"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"</tt>, <tt>"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"</tt> and maybe <tt>"Language-Team: LANGUAGE <LL@li.org>\n"</tt> (if you don't belong to a language team, then write <tt>none</tt>) and remove the fuzzy comment. In '''every case''' make sure, that <tt>Content-Type</tt> and <tt>Content-Transfer-Encoding</tt> are right (if possible, use <tt>UTF-8</tt>).

If you plan to use [http://www.poedit.net/ poedit] to do the translation, you can add several lines to the headers (replace <tt>LANGUAGE</tt> and <tt>COUNTRY</tt>).

"X-Poedit-Language: LANGUAGE\n"
"X-Poedit-Country: COUNTRY\n"
"X-Poedit-Basepath: ../../../..\n"

Then begin the "real" translation:

#: org/openscience/jmol/app/AboutDialog.java:57
#: org/openscience/jmol/app/GuiMap.java:155
msgid "About Jmol"
msgstr ""

#: org/openscience/jmol/app/AboutDialog.java:67
#: org/openscience/jmol/app/HelpDialog.java:77
#: org/openscience/jmol/app/WhatsNewDialog.java:68
#, java-format
msgid "Unable to find url \"{0}\"."
msgstr ""
[..]

A line or block beginning with <tt>msgid</tt> contains the untranslated (or original) string inside double quotation marks. Above this line, you see the location entries <tt>#: path/to/file.java:line</tt> (where the string can be found in the source) and sometimes some special comments <tt>#, java-format</tt> or <tt>#, fuzzy</tt> or even <tt>#, fuzzy, java-format</tt> (telling you more about the format of a string or the state of a translation) - these lines are added and changed automatically by running <tt>ant -f build-i18n.xml update-po</tt>. Place your translation into the line or block beginning with <tt>msgstr</tt> and inside double quotation marks.

6. After finishing, add your translation ({{File|Jmol-''LANG''.po}}) and {{File|JmolApplet-''LANG''.po}} to Jmol SVN and your language code to property <tt>all.Jmol.languages</tt> and <tt>all.JmolApplet.languages</tt> in {{File|build-i18n.xml}}.

7. At the end of this short howto, we should speak about special situations and a few hints, you should consider:
* double quotation marks inside a string must be escaped with a backslash: <tt>msgstr "... \" ..."</tt>
* single quotation marks must be doubled (two single quotation marks) for Java texts (<tt>#, java-format</tt>)
* <tt>#, fuzzy</tt> means that the translation string is outdated (e.g. the original string changed) - in this situation, check your translation and adjust it if necessary - then you can remove the fuzzy string (e.g. line <tt>#, fuzzy, java-format</tt> becomes <tt>#, java-format</tt>)

Internationalisation/Offline/Details - Revision history

NicolasVervelle: Subpages