afiqzudinhadi/zmk
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

docs(codes): Refer to LSHIFT instead of LSHFT

Browse source 
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
This commit is contained in:
Dom H 2021-06-05 22:35:59 +01:00 • committed by Pete Johanson
parent 52ee082692
commit 06a85f944f
7 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/behaviors/hold-tap.md
View file

@ -85,7 +85,7 @@ This example configures a hold-tap that works well for homerow mods:
default_layer {
bindings = <
&hm LCTRL A &hm LGUI S &hm LALT D &hm LSHFT F
&hm LCTRL A &hm LGUI S &hm LALT D &hm LSHIFT F
>;
};
};

4
docs/docs/behaviors/mod-tap.md
View file

@ -19,13 +19,13 @@ The Mod-Tap behavior either acts as a held modifier, or as a tapped keycode.
### Behavior Binding
- Reference: `&mt`
- Parameter #1: The keycode to be sent when activating as a modifier, e.g. `LSHFT`
- Parameter #1: The keycode to be sent when activating as a modifier, e.g. `LSHIFT`
- Parameter #2: The keycode to sent when used as a tap, e.g. `A`, `B`.
Example:
```
&mt LSHFT A
&mt LSHIFT A
```
### Configuration

6
docs/docs/behaviors/sticky-key.md
View file

@ -12,12 +12,12 @@ By default, sticky keys stay pressed for a second if you don't press any other k
### Behavior Binding
- Reference: `&sk`
- Parameter #1: The keycode , e.g. `LSHFT`
- Parameter #1: The keycode , e.g. `LSHIFT`
Example:
```
&sk LSHFT
&sk LSHIFT
```
You can use any keycode that works for `&kp` as parameter to `&sk`:
@ -44,7 +44,7 @@ You can configure a different `release-after-ms` in your keymap:
### Advanced usage
Sticky keys can be combined; if you tap `&sk LCTRL` and then `&sk LSHFT` and then `&kp A`, the output will be ctrl+shift+a.
Sticky keys can be combined; if you tap `&sk LCTRL` and then `&sk LSHIFT` and then `&kp A`, the output will be ctrl+shift+a.
### Comparison to QMK

2
docs/docs/behaviors/sticky-layer.md
View file

@ -38,7 +38,7 @@ You can configure a different `release-after-ms` in your keymap:
### Advanced usage
Sticky layers behave slightly different from sticky keys. They are configured to `quick-release`. This means that the layer is released immediately when another key is pressed. "Normal" sticky keys are not `quick-release`; they are released when the next key is released. This makes it possible to combine sticky layers and sticky keys as such: tap `&sl 1`, tap `&sk LSHFT` on layer 1, tap `&kp A` on base layer to output shift+A.
Sticky layers behave slightly different from sticky keys. They are configured to `quick-release`. This means that the layer is released immediately when another key is pressed. "Normal" sticky keys are not `quick-release`; they are released when the next key is released. This makes it possible to combine sticky layers and sticky keys as such: tap `&sl 1`, tap `&sk LSHIFT` on layer 1, tap `&kp A` on base layer to output shift+A.
### Comparison to QMK