Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

On this page

Keywords by Type

System stores

Header keywords have been replaced by system stores. While header keywords continue to work, they have been deprecated and should be replaced by the corresponding system store.

&Bitmap store, BITMAP statement, BITMAPS statement
An image that appears in the language menu
&CapsOnOnly store, CAPS ON ONLY statement
Manages CAPS LOCK behaviour - pressing Caps Lock key only switches on Caps Lock state
&CapsAlwaysOff store, CAPS ALWAYS OFF statement
Manages CAPS LOCK behaviour - pressing Caps Lock key has no effect
&ShiftFreesCaps store, SHIFT FREES CAPS statement
Manages CAPS LOCK behaviour - pressing Shift key turns off Caps Lock
&Copyright store and COPYRIGHT statement
A copyright message for the keyboard
&EthnologueCode store
The ISO 639-3 (formerly SIL Ethnologue) code for the language (Deprecated)
&Hotkey store and HOTKEY statement
Sets a default activation hotkey for the keyboard
&includecodes store
Reference an external file for named character constants
&keyboardversion store
Specifies the version of the keyboard
&kmw_embedcss store
Specifies an additional library of CSS code to be embedded in a web or touch keyboard
&kmw_embedjs store
Specifies an additional library of Javascript code to be embedded in a web or touch keyboard
&kmw_helpfile store
Specifies the embedded help html file for web keyboards
&kmw_helptext store
Specifies the embedded help text for web keyboards
&kmw_rtl store
Specifies the directionality of text controls for web keyboards
&Language store, LANGUAGE statement
Specifies the system language to install or associate with the keyboard (Deprecated)
LAYOUT statement
Windows system layout for the keyboard (Deprecated)
&layoutfile store
Specifies the JSON format touch keyboard layout filename
&Message store and MESSAGE statement
A message that appears when the keyboard is installed
&mnemoniclayout system store
Sets a keyboard to be mnemonic or positional
&Name store and NAME statement
The name of the keyboard
&OldCharPosMatching store
Turns on the Keyman 5.0 and earlier character position matching (not implemented)
&targets store
Specifies the platforms which the compiler will generate outputs for
&Version store and VERSION statement
The Keyman keyboard version
&VisualKeyboard store
Specifies the .kvk visual keyboard file associated with the keyboard
&windowslanguages store
Specifies a set of Windows language codes to which the keyboard can be associated (Deprecated)

Variable system stores

&baselayout store
Determines the current system hardware keyboard layout
&layer store
Tests or sets the current touch keyboard layer visible on the on screen keyboard
&platform store
Determines the current platform keyboard is operating on

Rule keywords

any() statement
Matches on an array of characters
baselayout() statement
Determines the current system hardware keyboard layout
beep statement
Generates a beep on the speaker (or a flash on web devices)
call() statement
Calls an Input Method Extension
context statement
Outputs the context part of a rule
deadkey(), dk() statement
Matches and generates deadkeys
if() statement
Tests a store or system state for a value
index() statement
Outputs from an array of characters
layer() statement
Sets the current touch keyboard layer visible on the on screen keyboard
notany() statement
Matches anything not in a particular array of characters
nul statement
Forces no output on a rule, or enforces empty context
outs() statement
Outputs an array of characters
platform() statement
Determines the current platform keyboard is operating on
return statement
Stops processing of the current keystroke
reset() statement
Resets a store to its initial value
save() statement
Persists a store value for next edit session
set() statement
Sets a store or system state to a specific value
use() statement
Starts processing in another group

Structural keywords

begin statement
Defines the starting group for the keyboard layout
group() statement
Starts a new group of rules
match rule
A system rule that is fired after another rule is matched in the same group
nomatch rule
A system rule that is fired when no rule is matched in a group
store() statement
Defines an array of characters