Briefly documented alternative input methods (IM character map files) in "Extending..."

This commit is contained in:
William Kendrick 2007-04-26 23:24:17 +00:00
parent d9b1e51ce9
commit 2ead83e107
3 changed files with 110 additions and 0 deletions

View file

@ -67,6 +67,9 @@ $Id$
* Briefly documented translation (gettext PO catalogs) in "Extending..."
* Briefly documented alternative input methods (IM character map files)
in "Extending..."
* Bug Fixes:
----------

View file

@ -571,3 +571,52 @@ Translations
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.
Alternative Input Methods
As of version 0.9.17, Tux Paint's "Text" tool can provide alternative
input methods for some languages. For example, when Tux Paint is running
with a Japanese locale, the right [Alt] can be pressed to change between
Latin, Romanized Hiragana and Katakana modes. This allows native
characters to be entered into the "Text" tool by typing one or more keys
on a keyboard with Latin characters (e.g., a US QWERTY keyboard).
To create an input method for a new locale, create a text file with a
name based on the locale (e.g., "ja" for Japanese), with ".im" as the
extension (e.g., "ja.im").
The ".im" file can have multiple character mapping sections for
different character mapping modes. For example, on a Japanese typing
system, typing [K] [A] in Hiragana mode generates a different Unicode
character than typing [K] [A] in Katakana mode.
Start each character mapping section with the word "section", the follow
it with the mappings, one per line. Each line should contain (separated
by whitespace):
* the Unicode value of the character, in hexadecimal
* the keycode sequence (the ASCII characters that must be entered to
generate the Unicode character)
* a flag (or "-")
Example:
# Hiragana
section
304B ka -
304C ga -
304D ki -
304E gi -
# Katakana
section
30AB ka -
30AC ga -
30AD ki -
30AE gi -
Note: Blank lines will be ignored, as will any text following a "#"
(pound/hash) character -- they can be used to denote comments, as seen
in the example above.
Note: Flags need to be explained here.

View file

@ -740,5 +740,63 @@ effect.</p>
</blockquote>
<h2>Alternative Input Methods</h2>
<blockquote>
<p>As of version 0.9.17, Tux&nbsp;Paint's "Text" tool can provide
alternative input methods for some languages. For example, when
Tux&nbsp;Paint is running with a Japanese locale, the
right&nbsp;<b>[Alt]</b> can be pressed to change between Latin,
Romanized Hiragana and Katakana modes. This allows native characters to
be entered into the "Text" tool by typing one or more keys on a keyboard
with Latin characters (e.g., a US QWERTY keyboard).</p>
<p>To create an input method for a new locale, create a text file
with a name based on the locale (e.g., "<code>ja</code>" for Japanese),
with "<code>.im</code>" as the extension (e.g., "<code>ja.im</code>").</p>
<p>The "<code>.im</code>" file can have multiple character mapping sections
for different character mapping modes. For example, on a Japanese typing
system, typing <b>[K]</b>&nbsp;<b>[A]</b> in Hiragana mode generates a
different Unicode character than typing
<b>[K]</b>&nbsp;<b>[A]</b> in Katakana mode.</p>
<p>Start each character mapping section with the word "<code>section</code>",
the follow it with the mappings, one per line. Each line should
contain (separated by whitespace):</p>
<ul>
<li>the Unicode value of the character, in hexadecimal
<li>the keycode sequence (the ASCII characters that must be entered to
generate the Unicode character)
<li>a flag (or "<code>-</code>")
</ul>
<p>Example:</p>
<blockquote>
<p><code># Hiragana<br>
section<br>
304B &nbsp; ka &nbsp; -<br>
304C &nbsp; ga &nbsp; -<br>
304D &nbsp; ki &nbsp; -<br>
304E &nbsp; gi &nbsp; -<br>
&nbsp;<br>
# Katakana<br>
section<br>
30AB &nbsp; ka &nbsp; -<br>
30AC &nbsp; ga &nbsp; -<br>
30AD &nbsp; ki &nbsp; -<br>
30AE &nbsp; gi &nbsp; -
</code></p>
</blockquote>
<p><i>Note:</i> Blank lines will be ignored, as will any text following
a "<code>#</code>" (pound/hash) character &mdash; they can be used to
denote comments, as seen in the example above.</p>
<p><i>Note:</i> Flags need to be explained here.</p>
</blockquote>
</body></html>