Latest revision as of 07:49, 8 July 2010

<<- Return to webOS Patches

Introduction

The Palm Pre lacks a stock Virtual Keyboard, which can come in handy in many situations. Having a virtual keyboard is good for quick text responses/notes without having to stress the slider too much. Although the biggest use for a virtual keyboard on the Palm Pre is landscape mode. The goal of this Patch/Application is to have a fully integrated Virtual Keyboard for the many tasks where it is an inconvenience to use the hardware keyboard.

Operation

Unlike the Palm Symbol keyboard, you do not have to open the Pre's hardware keyboard to get the on-screen keyboard. Double-tapping the gesture area (near the round silver button that lights up) will bring up the on-screen keyboard if you are in a text input field. Tap with two fingers separated or Double-tap quickly. Currently the rendering takes a few seconds, and a 3rd tap will hide/stop the rendering. After you double-tap the blinking cursor should freeze for a few seconds while the keyboard renders. Be patient, future versions will work to minimize the load lag. When the Virtual Keyboard is displayed, a single tap on the gesture area will hide it.

Theme Selector key

The Theme Selector key is the lower left gears key on the default theme. On the remix themes the theme selector key is the lower right blank key. Tapping this brings up a list of installed themes to switch between.

Drag Mode Key

The Keyboard Drag-mode key is the finger key on the lower right side of the keyboard. On the remix themes the drag-mode key is the lower left blank key. Tapping this puts the keyboard into drag-mode, simply drag and drop the keyboard up and down the screen while this key is active.

Installation Procedure

Use the WebOS Internals over the air installer Preware and simply select the software keyboard from the list of available patches and install it. From Preware go to Available Packages -> Patch -> Mojo to find the Virtual Keyboard.

Known Issues

3-second Load Lag
Must highlight the text box that was highlighted when the VKB was drawn in order to single-tap hide
Backspace/Enter does not work in web pages
Lacks Autocorrect
Need configuration/customization application support

Themes and Options

You may wish to add haptic feedback, click sound feedback and/or custom themes. Currently this consists of editing json file(s). For detailed information on themes and options: Virtual Keyboard Configuration

Technical Background, Explanation and History

On an unmodified Pre if you press the "sym" key a scrollable 5x5 keyboard pops up full of alternate characters.

This is controlled by code incorporated into the framework.js. The specific functions there can be seeen in /usr/palm/frameworks/mojo/submissions/<framework_version>/javascripts/widget_charselector.js

with the layout controlled by 3 files in /usr/palm/frameworks/mojo/submissions/<framework_version>/templates/charselector

the actual list of characters that appear on the screen is controlled by /usr/palm/frameworks/mojo/submissions/<framework_version>/resources/en_us/alternatechars_table.json

On 12 August 2009 Webos-internals contributor Eric Gaudet (irc egaudet) announced success at patching the framework.js to accept a new function derived from the charselector widget. This pre-alpha proof of concept on-screen keyboard was made available as a patch. Since that time, the keyboard has been extended to work in search fields, to be installable as an IPKG, and to be themeable.

Note that this requires patching the primary framework of WebOS. This is not an application running on top of WebOS but rather a modification of the operation of the OS itself to render a custom widget.

@@ Line 1: / Line 1: @@
-[[Image: On_Screen_Keyboard.png|thumb|right]]
+{{template:patch}}
-'''Warning.  This is PRE ALPHA testing grade only software.  It may cause your pre to melt into a puddle and dissolve while turning blue.  Use at your own risk!'''
+[[Image: VirtualKeyboard_1.png|thumb|right]]
-[[Image: On_screen_keyboard_2.png|thumb|right]]
+[[Image: VirtualKeyboard_2.png|thumb|right]]
 =Introduction=
-The Palm Pre ships with a very limited on-screen keyboard for inserting symbols.  It works in portrait and landscape, in all apps, in any text field. (It doesn't work in Search fields like email address or url, which has led to difficulties with enhancing it.)  This on screen keyboard has provided a basis for programmers to develop a fully functional on screen keyboard for the Pre.
+[[Image: VirtualKeyboard_3.png|thumb|right]]
+The Palm Pre lacks a stock Virtual Keyboard, which can come in handy in many situations.  Having a virtual keyboard is good for quick text responses/notes without having to stress the slider too much.  Although the biggest use for a virtual keyboard on the Palm Pre is landscape mode.  The goal of this Patch/Application is to have a fully integrated Virtual Keyboard for the many tasks where it is an inconvenience to use the hardware keyboard.
-=Background and Explanation=
-On an unmodified Pre if you press the "sym" key and a scrollable 5x5 keyboard pops up full of alternate characters.
-[[Image: On_screen_keyboard_3.png|thumb|right]]
-[[Image: Messaging_2009-22-08_000708.png|thumb|right]]
-This is controlled by code incorporated into the framework.js.  The specific functions there can be seeen in '''/usr/palm/frameworks/mojo/submissions/191.15/javascripts/widget_charselector.js'''
-with the layout controlled by 3 files in '''/usr/palm/frameworks/mojo/submissions/191.15/templates/charselector'''
-the actual list of characters that appear on the screen is controlled by '''/usr/palm/frameworks/mojo/submissions/191.15/resources/en_us/alternatechars_table.json'''
-At the simplest level then, creating an on-screen keyboard requires editing the alternate characters table json, to add the "regular" charcters to it, and then when you want a keyboard, press SYM and poof, a keyboard. The problem with that is, the alternatechars_table.json is "fragile"  the slightests mis-edit results in the pre entering a continuous book cycle.
-At the next level, the framework's copy of widget_charselector.js needs to be modified to not close the keyboard after each keypress.
-As of 12 August 2009 Webos-internals contributor Eric Gaudet (irc egaudet) announced success at patching the framework.js to accept a new function derived from the charselector widget.  This pre-alpha proof of concept on-screen keyboard is available as a patch.
 =Operation=
-Unlike the Palm Symbol keyboard, you do not have to open the Pre's hardware keyboard to get the on-screen keyboard.  Double-tapping the gesture area (near the round silver button) will bring up the on-screen keyboard if you are in a text field.
+Unlike the Palm Symbol keyboard, you do not have to open the Pre's hardware keyboard to get the on-screen keyboard.  Double-tapping the gesture area (near the round silver button that lights up) will bring up the on-screen keyboard if you are in a text input field. Tap with two fingers separated or Double-tap quickly.  Currently the rendering takes a few seconds, and a 3rd tap will hide/stop the rendering.  After you double-tap the blinking cursor should freeze for a few seconds while the keyboard renders.  Be patient, future versions will work to minimize the load lag.  When the Virtual Keyboard is displayed, a single tap on the gesture area will hide it.
-=Procedure=
-The patch is on Gitorious, please read the following to install the patch: [[Applying_Patches|Applying Patches]]
-The patch should be stored (on Pre) in: /opt/src/modifications/frameworks/add-onscreen-keyboard.patch
-Folow these instructions to install the patch AND the theme images (NOTE: must be root)
-<pre>
-cd /opt/src/modifications/frameworks
-git pull
-sh install_kb
-</pre>
-Double-tap gesture area on Pre while a textfield is highlighted to bring up keyboard.
-Double-tap pageup on your keyboard in Emulator while textfield is highlighted to bring up keyboard.
-=Change Log=
-===8/13/09 - Fixes===
-* Functional backspace, space and enter keys added.
-===8/16/09 - Fixes===
-* Added functional shift and sym capabilities.
-* Added landscape mode resize.
-===8/18/09 - Fixes/Enhancements===
-* Added theme capabilities
-* Changed default theme to use remix2000's images (big thanks!)
-* Added missing symbols
-* Fixed landscape mode to correctly render in landscape if launched from that state.
-Thanks again to remix2000 for the nice keyboard images. Specs will be posted eventually for the images/theme framework once a user-app callable way to switch themes is implemented.
+=== Theme Selector key ===
+[[Image: VirtualKeyboard_4.png|160px|bottom]]<br><br>
+The Theme Selector key is the lower left gears key on the default theme.  On the remix themes the theme selector key is the lower right blank key.  Tapping this brings up a list of installed themes to switch between.<br><br>
-===8/18/09 (evening) - Fixes/Enhancements===
+=== Drag Mode Key ===
-* Increased width of keyboard to span entire screen
+[[Image: VirtualKeyboard_5.png|160px|bottom]]<br><br>
-* Added orange-key functionality
+The Keyboard Drag-mode key is the finger key on the lower right side of the keyboard.  On the remix themes the drag-mode key is the lower left blank key.  Tapping this puts the keyboard into drag-mode, simply drag and drop the keyboard up and down the screen while this key is active.
-* Made keyboard draggable after tapping blank key
-* Added haptic feedback
-===8/21/09 - Fixes/Enhancements===
+=Installation Procedure=
-* Added support for Emulator (pageup will mimic gesture tap, double-tap for keyboard)
+Use the WebOS Internals over the air installer [[Application:Preware|Preware]] and simply select the software keyboard from the list of available patches and install it.  From Preware go to Available Packages -> Patch -> Mojo to find the Virtual Keyboard.
-* Separated themes from palm framework
-* Added customizable options and themes via .json files
-* Shrink keys when "active", i.e. shift, orange, sym...
-* Changed keyboard to come up with double-tap of gesture area (within 600ms)
-* Enabled usage within search fields (messaging/email apps etc...)
-* Changed position calculations to render keyboard as low as possible without covering cursor on initialization
-===8/26/09 - Fixes/Enhancements===
+=Known Issues=
-* Fixed duplication problem in messaging apps
+* 3-second Load Lag
-* Fixed symbols appearing in tasks app.
+* Must highlight the text box that was highlighted when the VKB was drawn in order to single-tap hide
-* Fixed dragger not to interact with scene
+* Backspace/Enter does not work in web pages
-* Modified keyboard to allow scene interactions when touching outside of the keyboard. As long as a tap is inside the keyboard, it should not effect the scene. A tap outside of the keyboard should be passed to the scene controller, and not dismiss the keyboard. Tap the gesture area, enter (submit+dismiss), or anything on the hard keyboard to dismiss virtual keyboard.
+* Lacks Autocorrect
+* Need configuration/customization application support
-=Issues=
+=Themes and Options=
-as of 26 August 2009 the following issues are known:
+You may wish to add haptic feedback, click sound feedback and/or custom themes.  Currently this consists of editing json file(s).  For detailed information on themes and options: [[Virtual Keyboard Configuration]]
-* Auto-Correct is not functional (SmartTextEngine is handled in libWebKitLuna.so, so might need plugin to add this support)
-* Backspace/enter do not work in webview textfields (The textfields in webview seem to be handled by the browser adapter plugin).
-* Sym key re-draws and re-positions the keyboard, should at least not re-position.
-* Clipboard, orange-scroll and shift-highlight do not operate with virtual keyboard
-* There is no way to bring up Global Search without pressing a key on the hard keyboard. One idea is to add a top-bar item in between the app menu and device menu that will launch Global Search with the virtual keyboard displayed. The virtual keyboard already works properly once the Global Search is in the foreground (i.e. after a hard keypress)
-* Explore T9-type, limited-width keyboard options
-* Hide kb when focus changes from text box (e.g. landscape in web browser, text box goes away)
-* Notifications and probably other scene re-sizes do not move the keyboard, however the textfields move and this may put them beneath the virtual keyboard. Keyboard should be able to adjust with the scene.
+=Technical Background, Explanation and History=
+On an unmodified Pre if you press the "sym" key a scrollable 5x5 keyboard pops up full of alternate characters.
-=User configurable options=
+This is controlled by code incorporated into the framework.js.  The specific functions there can be seeen in '''/usr/palm/frameworks/mojo/submissions/<framework_version>/javascripts/widget_charselector.js'''
-There is a config file located at /media/internal/virtual-keyboard/kb_config.json, with the following options:
-* haptic    : <number>  - How long to vibrate upon touch (0 - 100 ms)
-* clickFile : <string>  - Sound file to play upon button click (e.g. click1.wav)
-* theme     : <string>  - Name of keyboard theme to use (remix_classic, remix_glossy, remix_ice)
-=Keyboard Themes=
+with the layout controlled by 3 files in '''/usr/palm/frameworks/mojo/submissions/<framework_version>/templates/charselector'''
-The virtual keyboard layout is a "list" of rows containing 10 "elements" each.  The design allows for the keys to span multiple elements.
-The virtual keyboard will look for themes located at /media/internal/virtual-keyboard/themes/
+the actual list of characters that appear on the screen is controlled by '''/usr/palm/frameworks/mojo/submissions/<framework_version>/resources/en_us/alternatechars_table.json'''
-In this directory there shall exist theme-named directories with the following structure and options:
-theme_config.json is the file that will control what images in this directory should be used and how.  The following keys are accepted:
+On 12 August 2009 Webos-internals contributor Eric Gaudet (irc egaudet) announced success at patching the framework.js to accept a new function derived from the charselector widget.  This pre-alpha proof of concept on-screen keyboard was made available as a patch.   Since that time, the keyboard has been extended to work in search fields, to be installable as an IPKG, and to be themeable.
-* index      : <number> - (required) Key index on keyboard layout {e.g. for default layout, index of q is 0, index of a is 10, index of space is 24}
+''Note that this requires patching the primary framework of WebOS.'' This is not an application running on top of WebOS but rather a modification of the operation of the OS itself to render a custom widget.
-* character  : <string> - Character to display when user hits associated key
-* image      : <string> - Name of image (located in this theme's directory) to display on keyboard for specified index'd key
-* span       : <number> - How many elements the key shall take up (e.g. default is 3 for space bar)

Difference between revisions of "On Screen Keyboard"