Configure KMFL under Balsa - Jaunty/SCIM version

From LSDevLinux
Revision as of 23:08, 11 June 2010 by Mayhewn (talk | contribs) (Categorize)

Jump to: navigation, search

Introduction

This page tells you what you need to do to use KMFL on a BALSA jaunty Prototype.

KMFL (Keyboard Mapping For Linux) lets you to redefine the keyboard to type special characters. It basically does for Linux what Tavultesoft Keyman does for Windows. With the Ubuntu jaunty distribution, KMFL uses SCIM.

These instructions below tell you how to activate an installed keyboard. They also tell you how to install a KMFL keyboard. You can do this for all users on the system, or for a single user. If you install the keyboard for single user, it will be stored and backed up with the user's data. If you install it for all users, it will be stored on the BALSA SD card. If the BALSA SD card is updated with a new version of BALSA, you will need to be re-copy the keyboard files from advisor's directory to /usr/share/scim/kmfl according to the instructions.

These instructions assume that you already have a KMFL/Keyman keyboard source file. A compiled Keyman file for Windows (.kmx or .kmp) will not work. You will need the source file (.kmn). If you need to build your own, a KMFL programmers guide is available here. The Keyman Developer Programmer's Guide may also be useful.

A sample keyboard, the Ghana Unicode Short keyboard comes installed on BALSA. It is described below.

Activating a KMFL Keyboard

Before you can activate a KMFL Keyboard, you must be running an application that will uses the SCIM input method. These instructions use Text Editor as an example.

  1. Activate the SCIM input method
    1. Start the Text Editor.
    2. Right-Click the mouse in the Text Editor and choose Input Methods|SCIM Input Method:
    600px
  2. A small keyboard will appear on the lower taskbar(1):
    600px
  3. Click on the keyboard in the taskbar
  4. Select Other|Your Keyboard. This illustration is calling the sample keyboard:
    File:Activate KMFL keyboard-SCIM.png

Installing a KMFL Keyboard

Before you install a KMFL keyboard, decide whether you want to install the keyboard for a single user or for all users, and follow the pertinent directions below. You will need the keyboard source file and the icon file that it uses - check the line in the .kmn file with store(&BITMAP). Those two files should be in the same directory.

Installing For a Single User

  1. Log into the user's account.
  2. Activate the SCIM input method
    1. Start the Text Editor
    2. Right-Click the mouse in the Text Editor and choose Input Methods|SCIM Input Method:
    600px
  3. A small keyboard will appear on the lower taskbar(1):
    600px
  4. Right-click on it and choose SCIM Setup. The SCIM Setup Menu will appear. Choose the KMFL Menu Item on the left (2) and click Install on the right (3).
    SCIM Setup Dialog.png
  5. An Open File Dialog box will appear. Navigate to the directory with the .kmn file and select it.
  6. When you close and re-open the Text Editor, your keyboard will appear in the list when you activate a KMFL keyboard.

Installing For All Users

  1. Log in as advisor.
  2. Copy the keyboard file (.kmn) and the corresponding icon file (.bmp; .png; jpg) to /home/advisor/
    For the purposes of illustration, we've used the name mykeyboard.kmn for the keyboard file and myicon.bmp for the icon file. Replace those names in commands below with the names of the files you have used.
  3. Run Terminal and enter the following commands:
sudo mkdir -p /usr/share/scim/kmfl/icons
sudo cp ~/mykeyboard.kmn /usr/share/scim/kmfl/
sudo cp ~/myicon.bmp /usr/share/scim/kmfl/icons/

The next time you activate a KMFL keyboard, you will see your icon and keyboard name in the list.

Removing a KMFL keyboard

If the keyboard is for a single user, the SCIM Setup Menu has a Delete button that will uninstall the selected keyboard:

600px

To remove a keyboard installed for all users, run Terminal with the commands below. (For the purposes of illustration, we've used the name mykeyboard.kmn for the keyboard file and myicon.bmp for the icon file. Replace those names in commands below with the names of the files you have used.):

sudo rm /usr/share/scim/kmfl/mykeyboard.kmn
sudo rm /usr/share/scim/kmfl/icons/myicon.bmp

The Installed Sample Keyboard

BALSA comes with a sample KMFL keyboard, Ghana Unicode - Short. It uses the file GhanaUnicodeShort.kmn for the keyboard source file and that file looks for an icon in GhanaUnicodeShort.bmp. It assigns the keys ] } [ { + to the respective characters ɔ Ɔ ɛ Ɛ ŋ Ŋ. A semicolon before of any of the keys produces the original character, for example, typing ;] produces ].