group()
Summary
The group()
statement defines a set of rules to be processed together.
Syntax
group(groupName)
group(groupName) using keys
Parameters
groupName
- The unique name of the group, which can be referenced by
use()
statements.
The group()
statement tells Keyman to start a new set of rules. Keyman supports two sorts of groups: key processing groups, and context processing
groups. Key processing groups can include context checking, but context processing groups cannot include key checking. Keyman will use
first the group specified in the begin
statement, and move from there onto other groups.
To tell Keyman that the group should include key processing, you should include the using keys
section of the statement; if that is
left out, the group checks the context only. The keystroke will remain the same during processing; you can have many groups that each use using keys
,
and the keystroke will be the same for all of them. The key section of a rule (including the +
sign) is not valid for context processing groups.
Examples
Example: Using group()
group(main) using keys
group(syllablecheck)
Platforms
The group()
statement can be used in keyboards on all platforms.
Windows | macOS | Linux | Desktop web | Mobile web | iOS | Android |
---|---|---|---|---|---|---|
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
Version history
The group construct was introduced in Keyman 3.0.