translator-guide.html 4.87 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
5
    <title>Wildfire Translator Guide</title>
Matt Tucker's avatar
Matt Tucker committed
6 7 8 9 10
    <link href="style.css" rel="stylesheet" type="text/css">
</head>

<body>

11
<h1>Wildfire Translator Guide</h1>
Matt Tucker's avatar
Matt Tucker committed
12 13 14 15 16 17

<a name="top"></a>

<h2>Introduction</h2>

<p>
18
The Wildfire admin console can be easily translated into other languages. This document
Matt Tucker's avatar
Matt Tucker committed
19 20 21
provides instructions for those that wish to make translations.
</p>
<p>
22
All text in the Wildfire admin console is stored in a resource
Matt Tucker's avatar
Matt Tucker committed
23 24 25
bundle. A resource bundle is a file containing key/value pairs.  Words and phrases are
represented using keys. The correct values are retrieved based on locale settings
(English values are used for English locales, French values for French locales, etc).
Matt Tucker's avatar
Matt Tucker committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
Key/value pairs in the English resource bundle might look like the following:
<pre>
    skin.yes=Yes
    skin.no=No
    skin.topic=Topic
    skin.message=Message
</pre>

The German resource bundle would contain the same keys, but different values:
<br>
<pre>
    skin.yes=<i>Ja</i>
    skin.no=<i>Nein</i>
    skin.topic=<i>Thema</i>
    skin.message=<i>Beitrag</i>
</pre>

Making your own translation involves copying the English resource bundle,
renaming the file, then translating its contents.</p>

<h2>Construct a Resource Bundle</h2>

48 49
<p>To start, make a copy of the default (English) locale file "wildfire_i18n.properties".
It can be found in the <tt>resources\i18n</tt> directory of your Wildfire
Matt Tucker's avatar
Matt Tucker committed
50 51
installation. Note: the files found in <tt>resources\i18n</tt> are copies of the
real resource bundles used by the application (the real resource bundles are contained
52 53
in the wildfire.jar file). Editing the resource files in the <tt>resources\i18n</tt>
directory will not affect your running copy of Wildfire.</p>
Matt Tucker's avatar
Matt Tucker committed
54

Matt Tucker's avatar
Matt Tucker committed
55
<p>Next, you'll need to rename the file to match the locale that you're making a
56
translation for. The syntax of the name is "wildfire_i18n_[lang]_[country].properties".
Matt Tucker's avatar
Matt Tucker committed
57
However, the country code should be used in most cases. For example, the German resource
58
bundle should be named "wildfire_i18n_de.properties" because
Matt Tucker's avatar
Matt Tucker committed
59
"de" is the language code for German. For French, the file would be called
60
"wildfire_i18n_fr.properties". A list of language codes can
Matt Tucker's avatar
Matt Tucker committed
61 62 63 64
be found at:
<a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt"
 target="_new">http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</a>.
 Some locales require a combination of language and country code. For example
65 66
 simplified Chinese would have the name "wildfire_i18n_zh_CN.properties"
 while traditional Chinese would have the name "wildfire_i18n_zh_TW.properties".</p>
Matt Tucker's avatar
Matt Tucker committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

<h2>Translate the Resource Bundle</h2>

<p>Next, use your favorite text editor to translate the English values into
your language. The key names must not be changed.</p>

<p>When translating from English, you may need to use special characters
for your language (for example, Germans use characters like &auml;,
&uuml;, or &szlig;). Unfortunately, all resource bundle files must be saved
in ASCII format which doesn't allow for international characters. We
recommend working on your translation in a text editor
that supports all characters in your language. After finishing your translation,
use the "native2ascii" tool (bundled with Java) to convert international
characters to the ASCII format. To use the native2ascii tool:</p>

<pre>
83
    native2ascii -encoding XXX my_translation.properties wildfire_i18n_YY.properties
Matt Tucker's avatar
Matt Tucker committed
84 85 86 87 88 89 90 91 92 93 94 95 96
                               ^                         ^
                               input file                output file
</pre>

<p>The "-encoding XXX" parameter is optional. If you don't specify it, Java will
use the default encoding value, taken from System property "file.encoding".
If you do specify an encoding (XXX), it must be taken from the first column of
the table of supported encodings in the
<a href="http://java.sun.com/j2se/1.3/docs/guide/intl/encoding.doc.html" target="_new">Supported Encodings</a>
document. For example, if you created your translation using UTF-8 as your encoding and
you are making a Simplified Chinese translation:</p>

<pre>
97
    native2ascii -encoding UTF8 my_translation.properties wildfire_i18n_zh_CN.properties
Matt Tucker's avatar
Matt Tucker committed
98 99 100 101 102
 </pre>

<h2>Testing Your Translation</h2>

<p>To test your translation, copy the translated resource bundle file (example,
103 104
wildfire_i18n_de.properties) to the <tt>lib/</tt> directory of your Wildfire
installation. Make sure Wildfire is stopped and then edit the <tt>conf/wildfire.xml</tt>
Matt Tucker's avatar
Matt Tucker committed
105
file. Set the <tt>locale</tt> property to match your new resource
106
bundle such as "de" or "zh_CN". Start Wildfire and the admin console
Matt Tucker's avatar
Matt Tucker committed
107
should now be using your translation.  If you still see English text you may have
Matt Tucker's avatar
Matt Tucker committed
108
named your bundle incorrectly or used the wrong value for the <tt>locale</tt>
Matt Tucker's avatar
Matt Tucker committed
109 110
property.</p>

111
<p>Once your translation is complete and tested, please submit it to the Wildfire
Matt Tucker's avatar
Matt Tucker committed
112
developers so that others can enjoy it in the next release!</p>
Matt Tucker's avatar
Matt Tucker committed
113 114 115 116 117

<br><br>

</body>
</html>