<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY author1 "Oracle">
<!ENTITY author2 "IIIMF dev team">
<!ENTITY publisher "Oracle and/or its affiliates">
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY appversion "1.0.1">
<!ENTITY manrevision "1.0.1">
<!ENTITY date "January 2007">
<!ENTITY app "<application>iiim-properties</application>">
<!ENTITY appname "Input Method Preference Editor">
<!ENTITY langselect "Language Selection">
<!ENTITY triggerkey "Trigger Key">
<!ENTITY defaultengine "Default Engine">
<!ENTITY imswitcher "Input Method Switcher">
]>
<!--
Maintained by the IIIMF dev team
http://www.openi18n.org
-->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
<articleinfo>
<title>&appname;</title>
<subtitle>&appname; Panel Application Manual V&manrevision;</subtitle>\
<copyright>
<year>2007, 2011</year>
<holder>&publisher;</holder>
</copyright>
&legal;
<!-- This file contains link to license for the documentation (GNU FDL), and
other legal stuff such as "NO WARRANTY" statement. Please do not change
any of this. -->
<authorgroup>
<author>
<firstname>&author1;</firstname>
<surname>&author2;</surname>
<affiliation>
<orgname>&publisher;</orgname>
</affiliation>
</author>
</authorgroup>
<revhistory>
<revision>
<revnumber>&appname; Manual V&manrevision;</revnumber>
<date>&date;</date>
<revdescription>
<para role="author">&author1; &author2;</para>
<para role="publisher">&publisher;</para>
</revdescription>
</revision>
</revhistory>
<releaseinfo> This manual describes version &appversion; of the &appname;.
</releaseinfo>
</articleinfo>
<indexterm>
<primary>&appname;</primary>
</indexterm>
<!-- ============================================= -->
<sect1 id="intro">
<title>Introduction</title>
<para>&appname; enables you to specify various properties regarding Input Method like status window behavior, language selection list content or trigger keys for Input Method activation/deactivation.</para>
<note>
<para>This tool targets mainly UTF-8 environment applications. So some features does not make sence in non UTF-8 regacy locales.</para>
</note>
</sect1>
<!-- ============================================= -->
<sect1 id="getting-started">
<title>Getting Started</title>
<sect2>
<title>To Start &appname;</title>
<para>You can start &appname; in the following ways:</para>
<variablelist>
<varlistentry>
<term>Menu (&imswitcher;)</term>
<listitem>
<para>Click <link linkend="imswitcher">&imswitcher;</link> with right mouse button, then choose <guibutton>Preference</guibutton>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Menu (JDS)</term>
<listitem>
<para>Click JDS main menu, then choose <guimenuitem>Input Methods</guimenuitem> under <guimenuitem>Preferences</guimenuitem></para>
</listitem>
</varlistentry>
<varlistentry>
<term>CDE workspace menu</term>
<listitem>
<para>Click workspace with right mouse button, then choose <menuchoice><guimenu>Tool</guimenu>
<guisubmenu>Input Method Preference</guisubmenu></menuchoice></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Command line</term>
<listitem>
<para>Execute the following command: <userinput>iiim-properties</userinput></para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>When You Start &appname;</title>
<para>When you start &appname;, the following window is displayed.</para>
<figure id="general">
<title>&appname;</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/general.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &appname;.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>&appname; window contains the following elements:</para>
<variablelist>
<varlistentry>
<term><guilabel>Tabs</guilabel></term>
<para>Top four tabs separate preference categories.</para>
<listitem>
<itemizedlist>
<listitem>
<para><guilabel>General</guilabel></para>
<para>Contains basic preferences.</para>
</listitem>
<listitem>
<para><guilabel>Languages / Scripts</guilabel></para>
<para>Contains language selection list preference.</para>
</listitem>
<listitem>
<para><guilabel>&triggerkey;s</guilabel></para>
<para>Contains activate/deactivate key preference.</para>
</listitem>
<listitem>
<para><guilabel>Keyboard</guilabel></para>
<para>Contains physical keyboard layout selection for EMEA keyboard layout switching Language Engine</para>
</listitem>
<listitem>
<para><guilabel>Misc</guilabel></para>
<para>Contains other preferences.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Edit area</guilabel></term>
<listitem>
<para>The edit area contains preference items for each categories.</para>
</listitem>The contents of this area is changed according to tab selecton.
</varlistentry>
<varlistentry>
<term><guilabel>Button area</guilabel></term>
<listitem>
<itemizedlist>
<listitem>
<para><guilabel>Help button:</guilabel></para>
<para>To display this online document.</para>
</listitem>
<listitem>
<para><guilabel>Cancel button:</guilabel></para>
<para>To close &appname; without appling any edited preferences.</para>
</listitem>
<listitem>
<para><guilabel>Apply button:</guilabel></para>
<para>To apply edited preferences without closing &appname;.</para>
</listitem>
<listitem>
<para><guilabel>OK button:</guilabel></para>
<para>To apply edited preferences and close &appname;.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<!-- ============================================= -->
<sect1 id="usage">
<title>Usage</title>
<para>To start preference editing, click one of the category tabs which contain the objective item.</para>
<sect2 id="page-general">
<title>General</title>
<figure id="general-2">
<title>General Tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/general.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>General Tab</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>The following preferences can be selected in General tab.</para>
<sect3>
<title>Enable Input Method</title>
<para>To use or not use 'Input Method'. If this option is deselected, then Input Method is not activated with <link linkend="trigger-keys">&triggerkey;</link> or <link linkend="language-selection">&langselect;</link>.</para>
</sect3>
<sect3 id="status-and-switcher-placement">
<title>Input Method status and switcher placement</title>
<para>This preference selects where Input Method status string and &langselect; menu are displayed.</para>
<sect4>
<title>Follow desktop default</title>
<para>"Use Input Method Switcher application" option is applied to JDS, and "Attach to each application" option is applied to CDE environment. See below for these options.</para>
</sect4>
<sect4>
<title>Use Input Method Switcher application</title>
<para><link linkend="imswitcher">&imswitcher;</link> application is used. If Notification Area (Tray Area) is available such as GNOME panel, <link linkend="imswitcher">&imswitcher;</link> is hosted on the area. Otherwise such as CDE, it appears as a standalone GUI application.</para>
</sect4>
<sect4>
<title>Attach to each application</title>
<para>Input Method status is displayed at left bottom corner of each application.</para>
<note><para>&langselect; menu is not available for GNOME applications with this option.</para></note>
</sect4>
<sect4>
<title>None</title>
<para>Neither Input Method status nor &langselect; menu are displayed.</para>
</sect4>
</sect3>
<sect3>
<title>Synchronize Input Method activation for all applications</title>
<para>If this option is selected, then all of application's Input Method activation are synchronized. It means Input Method activation/deactivation on one application will activate/deactivate all of application's Input Method.</para>
</sect3>
<sect3>
<title>When the language is switched</title>
<sect4 id="apply-to-all-lang">
<title>The language is applied to all applications</title>
<para>If this option is selected, the <link linkend="language-selection">&langselect;</link> will be applied to all applications, otherwise the <link linkend="language-selection">&langselect;</link> will be applied to current application only.</para>
</sect4>
<sect4>
<title>Input Method is activated</title>
<para>If this option is selected, then <link linkend="language-selection">&langselect;</link> will cause Input Method activation, otherwise Input Method On/Off status will not be changed.</para>
</sect4>
<sect4>
<title>Set the last selection as default language</title>
<para>If this option is selected, then the last <link linkend="language-selection">&langselect;</link> will be saved as the default language. This setting will be persisted in user's configuration, and will continue to take effect on next login no-matter what locale is chosen. If <link linkend="apply-to-all-lang">The language is applied to all applications</link> option is not enabled, the existing input contexts will not be impacted.</para>
</sect4>
</sect3>
</sect2>
<sect2 id="page-lang">
<title>Languages / Scripts</title>
<figure id="language">
<title>Languages / Scripts Tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/lang.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Languages / Scripts Tab</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>This tab area is used to specify languages which are listed in the <link linkend="language-selection">&langselect;</link> menu. And also used to specify language engines if plural engines for one language are available on the system.</para>
<note>
<para>If you will use language/script which has the keyboard icon <inlinemediaobject>
<imageobject>
<imagedata fileref="figures/kbd-icon.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows icon for keyboard layout switching.</phrase>
</textobject>
</inlinemediaobject> at right of its name, please see <link linkend="page-keyboard"> Keyboard Tab</link>, too.</para>
</note>
<sect3>
<title>To remove languages from language selection menu</title>
<para>The default language switching menu may contain languages which user will never use. In that case, user can remove non interest languages from language switching menu with the following steps:</para>
<orderedlist>
<listitem>
<para>Click non use language in upper right list</para>
</listitem>
<listitem>
<para>Click "Remove" button at left side of that list</para>
</listitem>
<listitem>
<para>Click "Apply" (without closing dialog window) or "OK" (which closes dialog window)</para>
</listitem>
</orderedlist>
</sect3>
<sect3>
<title>To add languages to &langselect; menu</title>
<para>If <link linkend="language-selection">&langselect;</link> menu does not contain user's desired language and the system has that language Input Method, then user can add that language with the following steps:</para>
<orderedlist>
<listitem>
<para>Click "Adding Language" in the upper left list</para>
</listitem>
<listitem>
<para>Click "Add" button on the right side of that list</para>
</listitem>
<listitem>
<para>Click "Apply" (not closing dialog window) or "OK" (which closes dialog window)</para>
</listitem>
</orderedlist>
</sect3>
<sect3>
<title>To change default language engine in case plural engines are available for one language</title>
<para>When a user clicks the language in the upper right list, "Languages/Scripts to input", available engines for that language are listed in the lower left list "Available Engines".</para>
<para>If plural engines are listed in that list, the default engine is indicated at the top of the lower right list "Language Engine to use".</para>
<para>There are three ways to select <link linkend="default-engine">&defaultengine;</link> for the language if plural engines are available for one language.</para>
<sect4>
<title>Select language engine if <link linkend="apply-to-all-lang">The language is applied to all applications</link> <guilabel>when the language is switched</guilabel> mode</title>
<para>In this case, the language engine which is selected by <link linkend="language-selection">&langselect;</link> will be the default engine for that language automatically without the interaction of the &appname;.</para>
</sect4>
<sect4>
<title>Remove unused language engine from list</title>
<para>If the user will never use a specific language engine, then the user can remove it from "language switching menu" with the following steps:</para>
<orderedlist>
<listitem>
<para>Click on the language which the user want to configure engines in upper right list "Languages/Scripts to input".</para>
</listitem>
<listitem>
<para>Click on the language engine which the user does not use in lower right list "Language Engine to use".</para>
</listitem>
<listitem>
<para>Click "Remove" button at the left side of the selected language engine.</para>
</listitem>
<listitem>
<para>Click "Apply" (without closing dialog window) or "OK" (which closes dialog window)</para>
</listitem>
</orderedlist>
<para>Then remaining engine(s) will always be used for the language. Removed engines will no longer be shown in the <link linkend="language-selection">&langselect;</link> menu.</para>
<para>The user can put removed engines back with the following steps:</para>
<orderedlist>
<listitem>
<para>Click the language the which user want to configure engines in the upper right list "Languages/Scripts to input".</para>
</listitem>
<listitem>
<para>Click the language engine which the user want to use again in lower left list "Available Engines".</para>
</listitem>
<listitem>
<para>Click "Add" button at the right side of selected language engine.</para>
</listitem>
<listitem>
<para>Click "Apply" (without closing dialog window) or "OK" (which closes dialog window)</para>
</listitem>
</orderedlist>
</sect4>
<sect4>
<title>Reorder the language engine to use as the default</title>
<para>If the user will be using plural language engines for one language, but want to change the default one, then the user can specify using the following steps:</para>
<orderedlist>
<listitem>
<para>Click the language which the user want to configure engines in the upper right list "Language/Scripts to input".</para>
</listitem>
<listitem>
<para>Reorder the contents of the lower right list "Language Engine to use" with the "Up" and "Down" button at the left side of the list and put the desired engine at the top of the list.</para>
</listitem>
<listitem>
<para>Click "Apply" (without closing dialog window) or "OK" (which closes the dialog window)</para>
</listitem>
</orderedlist>
<para>The engine which is at the top of the list will be the <link linkend="default-engine">&defaultengine;</link>. The <link linkend="language-selection">&langselect;</link> menu will still show non-default engines so that the user can select them at will.</para>
</sect4>
</sect3>
</sect2>
<sect2 id="page-trigger">
<title>&triggerkey;s</title>
<figure id="trigger">
<title>&triggerkey;s Tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/trigger.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&triggerkey;s Tab</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>Input Method trigger keys can be configured in this tab area.</para>
<para>The user can add keys which will act as Input Method activate/deactivate keys using the following steps:</para>
<orderedlist>
<listitem>
<para>Click "Add..." button</para>
</listitem>
<listitem>
<para>Type key on the popped up dialog "Hotkey Configuration"</para>
<figure id="hkc">
<title>Hotkey Configuration</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/hkc.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Hotkey Configuration</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
</listitem>
<listitem>
<para>Click "Add" button in the "Hotkey Configuration" dialog.</para>
</listitem>
<listitem>
<para>Click "Apply" (without closing dialog window) or "OK" (which closes dialog window)</para>
</listitem>
</orderedlist>
<note>
<para>Default definition of trigger kyes are locale dependent. The below is the table of default trigger keys definition.
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Locale</para>
</entry>
<entry colname="COLSPEC1">
<para>Trigger keys</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry><para>Asian (zh_CN, zh_TW, ja, ko)</para></entry>
<entry><para>Henkan_Mode, Alt+Henkan_Mode, Hangle (if these three are not available on the keyboard, then Ctrl+space)</para></entry>
</row>
<row valign="top">
<entry><para>Cyrillic (ru, bg, mk, sr, ua)</para></entry>
<entry><para>Shift_L+Control_L</para></entry>
</row>
<row valign="top">
<entry><para>Others</para></entry>
<entry><para>Shift_L+Alt_L</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
"Ctrl" represents both of left and right Control keys, and Control_L reprerents only left side of Control key.
</para>
</note>
<note>
<para>Not all keys (key comibnation) can be used as trigger/hot keys. Some keys (likd Esc, F1) which is used for other purposes can not be used for Input Method trigger keys. And some applications take certain hot keys prior to Input Method, so such keys also do not take effect as trigger keys on only such applications. For example, Ctrl+* can not be used for gedit, nor Alt+* for gnome-terminal. At the result, user needs to press Shift_L before Alt_L on gnome-terminal to trigger Input Method with Shift_L+Alt_L.</para>
</note>
<note>
<para>This can be applied to UTF-8 locale applications or GNOME applications only. The trigger keys for CDE application which runs in non UTF-8 locale can not be configured.</para>
</note>
<note>
<para>The same key (or key combination) can not be used for <link linkend="trigger-keys">&triggerkey;</link>, hotkeys for <link linkend="language-choice-window">Language Choice Window</link> and <link linkend="cycle-languages">Cycle Language/Script</link>. "Hotkey Configuration" dialog will reject to select that key if it is already specified other purposes.</para>
</note>
<para>If the trigger key list contains keys which the user does not want to use for activate/deactivate, then they can be removed with the following steps:</para>
<orderedlist>
<listitem>
<para>Click on the string representation of the key in the list</para>
</listitem>
<listitem>
<para>Click "Remove" button</para>
</listitem>
<listitem>
<para>Click "Apply" (without closing dialog window) or "OK" (which closes dialog window)</para>
</listitem>
</orderedlist>
</sect2>
<sect2 id="page-keyboard">
<title>Keyboard</title>
<figure id="keyboard">
<title>Keyboard</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/keyboard.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Keyboard Tab</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>Physical Keyboard layout type should be selected here.</para>
<note><para>This information is needed for keyboard layout emulation type of Input Method such as 'French', 'Germany' or 'Arabic' (which is shown with keyboard icon <inlinemediaobject>
<imageobject>
<imagedata fileref="figures/kbd-icon.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows icon for keyboard layout switching.</phrase>
</textobject>
</inlinemediaobject> in the list of <link linkend="page-lang">Language / Scripts Tab</link>). If you do not use such Input Method, you do not need to care about this tab.</para></note>
<sect3>
<title>Use autodetect(does not work in remote environment)</title>
<para>If this option is selected, your physical keyboard layout will be detected automatically. You can confirm what layout is auto-detected in <guilabel>Physical Keyboard Layout</guilabel> list. If the detected layout is not correct (this may happen when you use remote environment like SunRay), you need to de-select this option and select correct layout manually in <guilabel>Physical Keyboard Layout</guilabel> list.</para>
</sect3>
</sect2>
<sect2 id="page-misc">
<title>Misc</title>
<figure id="misc">
<title>Misc Tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/misc.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Misc Tab</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>The following preferences can be selected in the Misc tab.</para>
<sect3 id="language-choice-window">
<title>Enable Language/Script choice window using Hotkey</title>
<para>If this is selected, the language switching window pops up with the list of keys. The hotkey list can be configured with the same way as the <link linkend="page-trigger">&triggerkey;</link> list.</para>
</sect3>
<sect3 id="cycle-languages">
<title>Enable Cycle Languages/Scripts by Hotkey</title>
<para>If this is selected, language switching can be done using the hotkeys listed in the list. The hostkey list can be configured in the same way as the <link linkend="page-trigger">&triggerkey;</link> list.</para>
</sect3>
</sect2>
</sect1>
<!-- ============================================= -->
<sect1 id="teminology">
<title>Terminology</title>
<sect2 id="language-selection">
<title>&langselect;</title>
<para>The "language selection" is a method to switch input language. &langselect; menu is popped up by clicking mouse left button on &imswitcher; or Input Method status area attached to each application.</para>
<figure id="langmenu">
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/langmenu.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Language menu</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
<sect2 id="trigger-keys">
<title>&triggerkey;</title>
<para>A trigger key is a key or a key plus some modifiers (Shift, Ctrl or Alt) which activates the Input Method. Users can use Input Method after typing the trigger keys and switching back to the direct keyboard input using the trigger keys.</para>
</sect2>
<sect2 id="default-engine">
<title>&defaultengine;</title>
<para>The default engine is the module which is activated with the trigger keys. Some languages have plural engines but the default engine is one.</para>
</sect2>
<sect2 id="imswitcher">
<title>&imswitcher;</title>
<para>&imswitcher; (iiim-panel) is the application for the input language switching and the Input Method status displaying. This application is put in Notification Area in gnome panel and if there is no Notification Area like CDE environment, then it runs as standalone application with window manager title. Please see <link linkend="status-and-switcher-placement">Input Method status and switcher placement</link> section about how &imswitcher; appears on the desktop. The language menu which pops up with click of the left mouse button can be configured with &appname;. Configuring the list is described in <link linkend="page-lang">Language / Scripts tab explanation</link>.</para>
</sect2>
</sect1>
</article>