[maemo-commits] [maemo-commits] r19332 - projects/haf/trunk/hildon-input-method-plugins-example

[From: subversion at stage.maemo.org]

Author: femorandeira
Date: 2009-09-10 17:36:50 +0300 (Thu, 10 Sep 2009)
New Revision: 19332

Modified:
   projects/haf/trunk/hildon-input-method-plugins-example/README
Log:
Explained the goal of project and how it works in the README.

Modified: projects/haf/trunk/hildon-input-method-plugins-example/README
===================================================================
--- projects/haf/trunk/hildon-input-method-plugins-example/README	2009-09-10 14:33:37 UTC (rev 19331)
+++ projects/haf/trunk/hildon-input-method-plugins-example/README	2009-09-10 14:36:50 UTC (rev 19332)
@@ -1,19 +1,40 @@
 Visit http://live.gnome.org/Hildon/HildonInputMethod
 
+
+USAGE OF THE PLUGINS BEFORE MAEMO 5
+
 After installing, you can activate the plugin like so:
+
   gconftool-2 --type string --set /apps/osso/inputmethod/input_method_plugin "himExample_vkb"
 
-Or this might be the new way with Maemo Fremantle:
-  gconftool-2 --type bool --set /apps/osso/inputmethod/use_finger_kb true
-  gconftool-2 --type string --set /apps/osso/inputmethod/default-plugins/finger "himExample_vkb"
-(See also
+
+USAGE OF THE PLUGINS IN MAEMO 5:
+
+The example plugins can be tested by modifying the value of the following
+GConf keys, which indicate the preferred plugin to be used for each trigger
+(keyboard, finger or stylus):
+
   /apps/osso/inputmethod/default-plugins/hw-keyboard
-and
   /apps/osso/inputmethod/default-plugins/stylus
-)
+  /apps/osso/inputmethod/default-plugins/finger
 
-And these might be helpful:
-  gconftool-2 -t bool -s /apps/osso/inputmethod/have-internal-keyboard true
-  gconftool-2 --type bool --set /system/osso/af/slide-open false
+The default values are "hildon_keyboard_assistant" for the keyboard and
+"hildon_western_fkb" for finger and stylus. Note that the finger/stylus
+detection might not work.
 
+For example:
+
+  gconftool-2 --type bool --set /apps/osso/inputmethod/use_finger_kb true
+  gconftool-2 --type string --set /apps/osso/inputmethod/default-plugins/finger "hildon_im_example_fkb"
+
+The following keys might be interesting for simulating the behaviour of a real
+device within a Scratchbox environment:
+
+  /apps/osso/inputmethod/have-internal-keyboard
+    true if the device has a HW keyboard, false if not (default: true)
+
+  /system/osso/af/slide-open
+    true if the HW keyboard is open, false if it is closed
+
+
 TODO: Add the URL of actual documentation about these gconf keys.