diff options
| author | Jules Aguillon | 2024-09-29 22:05:54 +0200 |
|---|---|---|
| committer | Jules Aguillon | 2024-09-29 22:05:54 +0200 |
| commit | 700ec23bd465fa74828ffd6dfbc42dfc81731510 (patch) | |
| tree | 46afeeebc8a543cc55493bbc361ca27f106a2ded /doc | |
| parent | fb93d841a575729de355d0d53cc4f5b7acd09410 (diff) | |
| download | unexpected-keyboard-700ec23bd465fa74828ffd6dfbc42dfc81731510.tar.gz unexpected-keyboard-700ec23bd465fa74828ffd6dfbc42dfc81731510.zip | |
Improve Ctrl key labels for Serbian Cyrillic layout
Add the ':char' syntax for defining character keys with a different
symbol.
This new kind of keys is used to implement Ctrl combinations in the
Serbian Cyrillic layout without showing latin letters while the Ctrl
modifier is activated.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Possible-key-values.md | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/Possible-key-values.md b/doc/Possible-key-values.md index c420f8d..e6a1ddd 100644 --- a/doc/Possible-key-values.md +++ b/doc/Possible-key-values.md @@ -161,8 +161,8 @@ Where `<kind>` is one of the kinds documented below and `<attributes>` is a space separated list of attributes. `<payload>` depends on the `<kind>`. Attributes are: -- `symbol='Sym'` is the symbol to be shown on the keyboard. -- `flags='<flags>'` is a collection of flags that change the behavior of the key. +- `symbol='Sym'` specifies the symbol to be shown on the keyboard. +- `flags='<flags>'` changes the behavior of the key. `<flags>` is a coma separated list of: + `dim`: Make the symbol dimmer. + `small`: Make the symbol smaller. @@ -172,4 +172,18 @@ Attributes are: Defines a key that outputs an arbitrary string. `<payload>` is a string wrapped in single-quotes (`'`), escaping of other single quotes is allowed with `\'`. -For example: `:str symbol='Sym':'Output string'` +For example: +- `:str:'Arbitrary string with a \' inside'` +- `:str symbol='Symbol':'Output string'` + +### Kind `char` + +Defines a key that outputs a single character. `<payload>` is the character to +output, unquoted. +This kind of key can be used to define a character key with a different symbol +on it. `char` keys can be modified by `ctrl` and other modifiers, unlike `str` +keys. + +For example: +- `:char symbol='q':љ`, which is used to implement `ctrl` shortcuts in cyrillic + layouts. |
