Features/Onscreen Keyboard: Difference between revisions

(3 intermediate revisions by 2 users not shown)

Line 1:

<noinclude>~~{{TOCright}}~~

[[Category:Feature Page Incomplete]]

[[Category:Feature|~~<Feature Name>~~]]

[[Category:Feature|Onscreen Keyboard]]

</noinclude>

Line 16:

* Targeted release: N/A

* Last updated: 06/29/2010

* Percentage of completion: 10%

* Percentage of completion: 5%

== Detailed Description ==

With OLPC announcing the XO-3 tablet, and with hardware like the [http://thejoojoo.com/ JooJoo tablet], Sugar should become better suited for touch-based, physical keyboard-less devices. The on-screen keyboard feature aims to provide one such functionality.

On-screen keyboards are also important for certain accessibility related contexts, but use cases like that are better handled by specialized software like [[Features/~~Accessibility_virtualkeyboard~~]].

On-screen keyboards are also important for certain accessibility related contexts, but use cases like that are better handled by specialized software like [[Features/Accessibility virtual keyboard]].

=== Software ===

Line 33:

== Scope ==

* Work needed for fvkbd

** While the fvkbd binary is good enough for initial prototyping, for tighter integration in the future, it may be useful to utilize the libfvkbd library and implement the keyboard as a part of the sugar-shell itself.

** The current version of fvkbd handles all non-primary layouts as "temporary" layouts, which mean that once a key is clicked, the keyboard state goes back to the primary layout. This makes it unusable for multiple keyboard layouts. I have [http://bugzilla.moblin.org/show_bug.cgi?id=10508 proposed a patch]. The maintainer suggests an alternate way to do this, and I think his idea makes sense (though there is no patch for it yet).

** The number of layouts for fvkbd is quite low, and it is not possible to do a 1:1 transition from XKB to fvkbd layouts. I have made an [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/olpc-single-es.xml.gz experimental Spanish layout], along with a [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/olpc-dual-bn.xml dual layout] with English and Bengali (it requires a patched fvkbd, and the patch can be obtained from the [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/olpc-single-es.xml.gz bug] mentioned above).

* Work needed in Sugar

** It is still not clear on how to best integrate the keyboard into Sugar. The most easy and obvious approach is using a [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/keyboard.py device icon] in the frame, but it would be useful to have the keyboard pop-out automatically when an editable widget has focus. See the discussion on GTK+ modules below.

** One major drawback of an on-screen keyboard is that in its current design, it blocks out a part of the Sugar UI. There's no immediate answer on how to handle this problem.

** Starting up the keyboard process is currently done in the prototypes using [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/sugar-session sugar-session]. However, it may be useful to have this capability as a Sugar service, so that the keyboard can be invoked by activities as and when required.

* Work needed elsewhere

** GTK+ module to handle focus-in/out events

*** A GTK+ module which would automatically invoke/close the keyboard when the user focuses into/out of an editable widget would probably be a good addition.However, while standard GTK+ widgets such as GtkTextView, etc can be easily identified as being editable, widgets such as those used by Write (Abiword) and Browse would be difficult to detect. Moreover, for activities like Etoys and Scratch, which do not use GTK+ at all, one would need to use some other approach.

*** Code for a proof of concept GTK+ module which tries to detect focus-in events on common editable widgets can be [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/on-screen.c downloaded]. Usage and compilation instructions are in the comments.

==UI Design==

~~''Does the feature have~~ a ~~direct impact on the work flow~~, ~~or does it need a UI? Link here mockups, or add detailed descriptions~~.''

Following is a screenshot of fvkbd in Sugar, using an experimental Spanish layout:

[[Image:Sugar-ES-Onscreen-KBD.png]]

A screencast is also [http://dev.laptop.org/~sayamindu/sugar_vkbd_multi.ogv available].

== How To Test ==

{{:{{PAGENAME}}/Testing}}

== User Experience ==

~~''If this feature is noticeable by its target audience, how will their experiences change as a result? Describe what they will see or notice.''~~

TODO

== Dependencies ==

~~''What other packages (RPMs) depend on this package? Are there changes outside~~ the ~~developers' control on which completion of this feature depends? In other words~~, ~~does your feature depend on completion of another feature owned by someone else or that you would need~~ to ~~coordinate~~, ~~which might cause you to be unable to finish on time? Other upstream projects like Python?''~~

FVKBD is the only external dependency at the moment. It needs to support multi-lingual situations correctly.

Other dependencies may include a GTK+ module, a device icon extension to invoke the keyboard, etc.

== Contingency Plan ==

~~''If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "~~None necessary, revert to previous release behaviour.~~" Or it might not. If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''~~

None necessary, revert to previous release behaviour.

== Documentation ==

''Is there upstream documentation on this feature, or notes you have written yourself? Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''

None

== Release Notes ==

''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the release team and shipped with the release.''

TODO

== Comments and Discussion ==

* See [[{{TALKPAGENAME}}|discussion tab for this feature]] ~~~~

* See [[{{TALKPAGENAME}}|discussion tab for this feature]]

@@ Line 1: / Line 1: @@
-<noinclude>{{TOCright}}
+<noinclude>
 [[Category:Feature Page Incomplete]]
-[[Category:Feature|<Feature Name>]]
+[[Category:Feature|Onscreen Keyboard]]
 </noinclude>
@@ Line 16: / Line 16: @@
 * Targeted release: N/A
 * Last updated: 06/29/2010
-* Percentage of completion: 10%
+* Percentage of completion: 5%
 == Detailed Description ==
 With OLPC announcing the XO-3 tablet, and with hardware like the [http://thejoojoo.com/ JooJoo tablet], Sugar should become better suited for touch-based, physical keyboard-less devices. The on-screen keyboard feature aims to provide one such functionality.
-On-screen keyboards are also important for certain accessibility related contexts, but use cases like that are better handled by specialized software like [[Features/Accessibility_virtualkeyboard]].
+On-screen keyboards are also important for certain accessibility related contexts, but use cases like that are better handled by specialized software like [[Features/Accessibility virtual keyboard]].
 === Software ===
@@ Line 33: / Line 33: @@
 == Scope ==
+* Work needed for fvkbd
+** While the fvkbd binary is good enough for initial prototyping, for tighter integration in the future, it may be useful to utilize the libfvkbd library and implement the keyboard as a part of the sugar-shell itself.
+** The current version of fvkbd handles all non-primary layouts as "temporary" layouts, which mean that once a key is clicked, the keyboard state goes back to the primary layout. This makes it unusable for multiple keyboard layouts. I have [http://bugzilla.moblin.org/show_bug.cgi?id=10508 proposed a patch]. The maintainer suggests an alternate way to do this, and I think his idea makes sense (though there is no patch for it yet).
+** The number of layouts for fvkbd is quite low, and it is not possible to do a 1:1 transition from XKB to fvkbd layouts. I have made an [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/olpc-single-es.xml.gz experimental Spanish layout], along with a [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/olpc-dual-bn.xml dual layout] with English and Bengali (it requires a patched fvkbd, and the patch can be obtained from the [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/olpc-single-es.xml.gz bug] mentioned above).
+* Work needed in Sugar
+** It is still not clear on how to best integrate the keyboard into Sugar. The most easy and obvious approach is using a [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/keyboard.py device icon] in the frame, but it would be useful to have the keyboard pop-out automatically when an editable widget has focus. See the discussion on GTK+ modules below.
+** One major drawback of an on-screen keyboard is that in its current design, it blocks out a part of the Sugar UI. There's no immediate answer on how to handle this problem.
+** Starting up the keyboard process is currently done in the prototypes using [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/sugar-session sugar-session]. However, it may be useful to have this capability as a Sugar service, so that the keyboard can be invoked by activities as and when required.
+* Work needed elsewhere
+** GTK+ module to handle focus-in/out events
+*** A GTK+ module which would automatically invoke/close the keyboard when the user focuses into/out of an editable widget would probably be a good addition.However, while standard GTK+ widgets such as GtkTextView, etc can be easily identified as being editable, widgets such as those used by Write (Abiword) and Browse would be difficult to detect. Moreover, for activities like Etoys and Scratch, which do not use GTK+ at all, one would need to use some other approach.
+*** Code for a proof of concept GTK+ module which tries to detect focus-in events on common editable widgets can be [http://dev.laptop.org/~sayamindu/sugar-vkbd-test/on-screen.c downloaded]. Usage and compilation instructions are in the comments.
 ==UI Design==
-''Does the feature have a direct impact on the work flow, or does it need a UI? Link here mockups, or add detailed descriptions.''
+Following is a screenshot of fvkbd in Sugar, using an experimental Spanish layout:
+[[Image:Sugar-ES-Onscreen-KBD.png]]
+A screencast is also [http://dev.laptop.org/~sayamindu/sugar_vkbd_multi.ogv available].
 == How To Test ==
 {{:{{PAGENAME}}/Testing}}
 == User Experience ==
-''If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice.''
+TODO
 == Dependencies ==
-''What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, does your feature depend on completion of another feature owned by someone else or that you would need to coordinate, which might cause you to be unable to finish on time?  Other upstream projects like Python?''
+FVKBD is the only external dependency at the moment. It needs to support multi-lingual situations correctly.
+Other dependencies may include a GTK+ module, a device icon extension to invoke the keyboard, etc.
 == Contingency Plan ==
-''If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If your feature is not completed in time, we want to assure others that other parts of Sugar will not be in jeopardy.''
+None necessary, revert to previous release behaviour.
 == Documentation ==
-''Is there upstream documentation on this feature, or notes you have written yourself?  Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''
+None
 == Release Notes ==
-''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.''
+TODO
 == Comments and Discussion ==
-* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
+* See [[{{TALKPAGENAME}}|discussion tab for this feature]]