Mailing List Archive

r19379 - projects/haf/trunk/hildon-input-method-plugins-example
Author: jrocha
Date: 2009-09-21 15:36:55 +0300 (Mon, 21 Sep 2009)
New Revision: 19379

Modified:
projects/haf/trunk/hildon-input-method-plugins-example/ChangeLog
projects/haf/trunk/hildon-input-method-plugins-example/README
Log:
2009-09-21 Joaquim Rocha <jrocha@igalia.com>

* README: Re-wrote the contents using ReStructured Text and corrected a typo.

Modified: projects/haf/trunk/hildon-input-method-plugins-example/ChangeLog
===================================================================
--- projects/haf/trunk/hildon-input-method-plugins-example/ChangeLog 2009-09-21 12:16:30 UTC (rev 19378)
+++ projects/haf/trunk/hildon-input-method-plugins-example/ChangeLog 2009-09-21 12:36:55 UTC (rev 19379)
@@ -3,6 +3,7 @@
* hildon-vkb-example.c: Wrapped declaration with an ifdef to avoid compiler
warnings.
* hildon-im-example-fkb.c: Removed unused function to avoid compiler warnings.
+ * README: Re-wrote the contents using ReStructured Text and corrected a typo.

2009-09-17 Joaquim Rocha <jrocha@igalia.com>


Modified: projects/haf/trunk/hildon-input-method-plugins-example/README
===================================================================
--- projects/haf/trunk/hildon-input-method-plugins-example/README 2009-09-21 12:16:30 UTC (rev 19378)
+++ projects/haf/trunk/hildon-input-method-plugins-example/README 2009-09-21 12:36:55 UTC (rev 19379)
@@ -1,45 +1,70 @@
-Visit http://live.gnome.org/Hildon/HildonInputMethod

+=================================================
+Hildon Input Method Example Plugins README File
+=================================================

-USAGE OF THE PLUGINS BEFORE MAEMO 5
+:Date: 2009-09-21
+:Web site: http://live.gnome.org/Hildon/HildonInputMethod

-After installing, you can activate the plugin like so:
+.. contents::

+Introduction
+=============
+
+The Hildon Input Methods (HIM) Example Plugins is a set of
+plugins created to help developers write their own plugins
+for Hildon Input Methods.
+
+Plugins Usage
+==============
+
+Usage 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"


-USAGE OF THE PLUGINS IN MAEMO 5:
+Usage After 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):
+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
/apps/osso/inputmethod/default-plugins/stylus
/apps/osso/inputmethod/default-plugins/finger

-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.
+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.

-These are the values for the exampel plugins provided by this package, which
-are specified by the HildonIMPluginInfo::name struct field.
+These are the values for the example plugins provided by this
+package, which are specified by the HildonIMPluginInfo::name
+struct field. ::
+
hildon_im_onehand_fkb
hildon_im_example_fkb

-For example:
+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:
+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)
+ /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
+
+*true if the HW keyboard is open, false if it is closed*


-TODO: Add the URL of actual documentation about these gconf keys.
+.. TODO: Add the URL of actual documentation about these gconf keys.

_______________________________________________
maemo-commits mailing list
maemo-commits@maemo.org
https://lists.maemo.org/mailman/listinfo/maemo-commits