Keyboard Support

Contact and Search Homepage

Header bottom

Other versions
Version 7.0


On this page

Keyboard Wizard

TBD: update for version 7 The Keyboard Wizard is the easiest way to create a simple keyboard. There are six steps to creating the keyboard: entering the keyboard details, setting up the basic layout, drawing an icon, creating an on-screen keyboard, editing the source, and compiling and testing the keyboard.

1. Details

This page is used to set up the basic details of the keyboard: the name, Unicode or Legacy Code Page (Unicode is the default and is highly recommended) and brief information on the copyright and keyboard itself.

2. Layout

The Layout tab gives you a simple interface to quickly create a keyboard using a visual representation of a computer keyboard. You can drag and drop characters from the character map to create keyboard layouts. You cannot access most of Keyman's more powerful features from the Layout editor, but it will be useful to get you started on your design.

Each key can have zero or more characters assigned to it. Each key can be assigned a different set of characters for each shift state. You can change the shift state by clicking on the Shift, Ctrl, and Alt keys.

There are two ways to assign characters to the keys:

  • Click on a key, and then type the character's code or the character in quotes into the Character Value field.

  • Select the character from the Character Map and drag and drop it onto the appropriate key. This will set the key to output that character.

  • To add the character to a key with existing characters, hold Ctrl while dropping it onto the key.

Note that any key that does not have a character assigned to it will output what the selected Windows layout specifies.

3. Icon

Here you can create an icon for the keyboard, or import an existing icon to use. This icon is displayed in the taskbar when the keyboard is selected and should be clearly associated with your keyboard or product.

4. On-Screen

The On-Screen Keyboard tab is used to create a layout for the Keyman Desktop On Screen Keyboard. You can import the setup of the Layout tab with the Fill from Layout button if the keyboard source is not too complex to generate the On Screen Keyboard from.

5. Source

The Source Editor is used to add more complex rules or comments to the keyboard source.

6. Compile

After you have finished the keyboard, press Ctrl+S (or choose File, Save) to save.

Compile KeyboardUninstall a keyboard from Keyman Desktop.
Complies the keyboard, checking for errors.Upload to Tavultesoft
Start DebuggingTo share a keyboard with others on the web.
If an error is reported when compiling the debugging process will help isolate the problem.Open Containing Folder
InstallWill open the folder containing the opened keyboard.
Install a keyboard into Keyman Desktop.Add to Project
UninstallAdd the keyboard to an existing project.

You can compile the keyboard for testing and installation by clicking the Compile button, or selecting Keyboard, Compile Keyboard.

To test your keyboard, press View Source, then press F5 to start the debugger or just press F9 to open the test window.

The Keyboard Wizard generates a .kmn Keyman Source File. You can view the source for the keyboard by clicking the View Source button. When you edit the source directly, you can perform many more advanced functions. To learn how to create or edit keyboards using the source, read the tutorial.