Keyman Keyboard Language Reference

---

any() statement

Matches on an array of characters

&baselayout store

Determines the current system hardware keyboard layout

baselayout() statement

Determines the current system hardware keyboard layout

beep statement

Generates a beep on the speaker (or a flash on web devices)

begin statement

Defines the starting group for the keyboard layout

&Bitmap store

An image that appears in the language menu

call() statement

Calls an Input Method Extension

&CapsAlwaysOff store

Manages CAPS LOCK behaviour - pressing Caps Lock key has no effect

&CapsOnOnly store

Manages CAPS LOCK behaviour - pressing Caps Lock key only switches on Caps Lock state

&CasedKeys store

Defines a range of virtual keys affected by Caps Lock

context statement

Outputs the context part of a rule

&Copyright store

A copyright message for the keyboard

deadkey(), dk() statement

Matches and generates deadkeys

&displayMap store

Specifies a mapping file for on screen keyboard display data

group() statement

Starts a new group of rules

&Hotkey store

Sets a default activation hotkey for the keyboard

&includecodes store

Reference an external file for named character constants

if() statement

Tests a store or system state for a value

index() statement

Outputs from an array of characters

&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

&layer store

Tests or sets the current touch keyboard layer visible on the on screen keyboard

layer() statement

Sets the current touch keyboard layer visible on the on screen keyboard

&layoutfile store

Specifies the JSON format touch keyboard layout filename

match rule

A system rule that is fired after another rule is matched in the same group

&Message store

A message that appears when the keyboard is installed

&mnemoniclayout store

Sets a keyboard to be mnemonic or positional

&Name store

The name of the keyboard

&newLayer store

Reports on which layer the current touch keyboard has recently changed to in a PostContext process

nomatch rule

A system rule that is fired when no rule is matched in a group

notany() statement

Matches anything not in a particular array of characters

nul statement

Forces no output on a rule, or enforces empty context

&OldCharPosMatching store

Turns on the Keyman 5.0 and earlier character position matching (not implemented)

&oldLayer store

Reports on which layer the current touch keyboard has recently changed from in a PostContext process

outs() statement

Outputs an array of characters

&platform store

Determines the current platform keyboard is operating on

platform() statement

Determines the current platform keyboard is operating on

reset() statement

Resets a store to its initial value

return statement

Stops processing of the current keystroke

save() statement

Persists a store value for next edit session

set() statement

Sets a store or system state to a specific value

&ShiftFreesCaps store

Manages CAPS LOCK behaviour - pressing Shift key turns off Caps Lock

store() statement

Defines an array of characters

&targets store

Specifies the platforms which the compiler will generate outputs for

use() statement

Starts processing in another group

&Version store

The Keyman keyboard version

&VisualKeyboard store

Specifies the .kvks visual keyboard file associated with the keyboard

Deprecations

BITMAP statement, BITMAPS statement

Deprecated

CAPS ALWAYS OFF statement

Deprecated

CAPS ON ONLY statement

Deprecated

COPYRIGHT statement

Deprecated

&EthnologueCode store

Deprecated

HOTKEY statement

Deprecated

&Language store, LANGUAGE statement

Deprecated

LAYOUT statement

Deprecated

MESSAGE statement

Deprecated

NAME statement

Deprecated

SHIFT FREES CAPS statement

Deprecated

VERSION statement

Deprecated

&windowslanguages store

Deprecated

See also

• Keywords by type
• Keyman keyboard language guide