From 06a85f944f4d3b6520b4af7819a2831d40ff502b Mon Sep 17 00:00:00 2001
From: Dom H <dom@hxy.io>
Date: Sat, 5 Jun 2021 22:35:59 +0100
Subject: [PATCH] docs(codes): Refer to LSHIFT instead of LSHFT
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
---
docs/docs/behaviors/hold-tap.md | 2 +-
docs/docs/behaviors/mod-tap.md | 4 ++--
docs/docs/behaviors/sticky-key.md | 6 +++---
docs/docs/behaviors/sticky-layer.md | 2 +-
docs/docs/features/keymaps.md | 4 ++--
docs/docs/keymap-example-file.md | 6 +++---
docs/docs/keymap-example.md | 6 +++---
7 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md
index e1627c7a..de4bf81f 100644
--- a/docs/docs/behaviors/hold-tap.md
+++ b/docs/docs/behaviors/hold-tap.md
@@ -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
>;
};
};
diff --git a/docs/docs/behaviors/mod-tap.md b/docs/docs/behaviors/mod-tap.md
index 32380920..f29f739b 100644
--- a/docs/docs/behaviors/mod-tap.md
+++ b/docs/docs/behaviors/mod-tap.md
@@ -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
diff --git a/docs/docs/behaviors/sticky-key.md b/docs/docs/behaviors/sticky-key.md
index 3f7eb511..e7085763 100644
--- a/docs/docs/behaviors/sticky-key.md
+++ b/docs/docs/behaviors/sticky-key.md
@@ -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
diff --git a/docs/docs/behaviors/sticky-layer.md b/docs/docs/behaviors/sticky-layer.md
index d7c794d0..ac341f77 100644
--- a/docs/docs/behaviors/sticky-layer.md
+++ b/docs/docs/behaviors/sticky-layer.md
@@ -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
diff --git a/docs/docs/features/keymaps.md b/docs/docs/features/keymaps.md
index de1f24ac..538d589b 100644
--- a/docs/docs/features/keymaps.md
+++ b/docs/docs/features/keymaps.md
@@ -70,7 +70,7 @@ In this case, the `A` is actually a define for the raw HID keycode, to make keym
For example of a binding that uses two parameters, you can see how "mod-tap" (`mt`) is bound:
```
-&mt LSHFT D
+&mt LSHIFT D
```
Here, the first parameter is the set of modifiers that should be used for the "hold" behavior, and the second
@@ -94,7 +94,7 @@ The top two lines of most keymaps should include:
The first defines the nodes for all the available behaviors in ZMK, which will be referenced in the behavior bindings. This is how bindings like `&kp` can reference the key press behavior defined with an anchor name of `kp`.
-The second include brings in the defines for all the keycodes (e.g. `A`, `N1`, `C_PLAY`) and the modifiers (e.g. `LSHFT`) used for various behavior bindings.
+The second include brings in the defines for all the keycodes (e.g. `A`, `N1`, `C_PLAY`) and the modifiers (e.g. `LSHIFT`) used for various behavior bindings.
### Root devicetree Node
diff --git a/docs/docs/keymap-example-file.md b/docs/docs/keymap-example-file.md
index 5cb9b2f4..4f92444a 100644
--- a/docs/docs/keymap-example-file.md
+++ b/docs/docs/keymap-example-file.md
@@ -13,9 +13,9 @@
// | SHIFT | Z | X | C | V | B | CTRL+A | CTRL+C | | CTRL+V | CTRL+X | N | M | , | . | / | R CTRL |
// | GUI | DEL | RETURN | SPACE | ESCAPE | | RETURN | SPACE | TAB | BSPC | R ALT |
bindings = <
- &kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH
- &kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE
- &kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp LC(A) &kp LC(C) &kp LC(V) &kp LC(X) &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL
+ &kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH
+ &kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE
+ &kp LSHIFT &kp Z &kp X &kp C &kp V &kp B &kp LC(A) &kp LC(C) &kp LC(V) &kp LC(X) &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL
&kp LGUI &kp DEL &kp RET &kp SPACE &kp ESC &kp RET &kp SPACE &kp TAB &kp BSPC &kp RALT
>;
diff --git a/docs/docs/keymap-example.md b/docs/docs/keymap-example.md
index c6e81d22..bfef94e1 100644
--- a/docs/docs/keymap-example.md
+++ b/docs/docs/keymap-example.md
@@ -9,9 +9,9 @@
// | SHIFT | Z | X | C | V | B | CTRL+A | CTRL+C | | CTRL+V | CTRL+X | N | M | , | . | / | R CTRL |
// | GUI | DEL | RETURN | SPACE | ESCAPE | | RETURN | SPACE | TAB | BSPC | R ALT |
bindings = <
- &kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH
- &kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE
- &kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp LC(A) &kp LC(C) &kp LC(V) &kp LC(X) &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL
+ &kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH
+ &kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE
+ &kp LSHIFT &kp Z &kp X &kp C &kp V &kp B &kp LC(A) &kp LC(C) &kp LC(V) &kp LC(X) &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL
&kp LGUI &kp DEL &kp RET &kp SPACE &kp ESC &kp RET &kp SPACE &kp TAB &kp BSPC &kp RALT
>;