aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_space_cadet.md10
-rw-r--r--docs/keycodes.md5
-rw-r--r--docs/quantum_keycodes.md7
3 files changed, 16 insertions, 6 deletions
diff --git a/docs/feature_space_cadet.md b/docs/feature_space_cadet.md
index 5c375c518..075578522 100644
--- a/docs/feature_space_cadet.md
+++ b/docs/feature_space_cadet.md
@@ -20,7 +20,7 @@ Firstly, in your keymap, do one of the following:
20|`KC_RCPC` |Right Control when held, `)` when tapped | 20|`KC_RCPC` |Right Control when held, `)` when tapped |
21|`KC_LAPO` |Left Alt when held, `(` when tapped | 21|`KC_LAPO` |Left Alt when held, `(` when tapped |
22|`KC_RAPC` |Right Alt when held, `)` when tapped | 22|`KC_RAPC` |Right Alt when held, `)` when tapped |
23|`KC_SFTENT`|Right Shift when held, `Enter` when tapped | 23|`KC_SFTENT`|Right Shift when held, Enter when tapped |
24 24
25## Caveats 25## Caveats
26 26
@@ -38,10 +38,10 @@ By default Space Cadet assumes a US ANSI layout, but if your layout uses differe
38|----------------|-------------------------------|---------------------------------------------------------------------------------| 38|----------------|-------------------------------|---------------------------------------------------------------------------------|
39|`LSPO_KEYS` |`KC_LSFT, LSPO_MOD, LSPO_KEY` |Send `KC_LSFT` when held, the mod and key defined by `LSPO_MOD` and `LSPO_KEY`. | 39|`LSPO_KEYS` |`KC_LSFT, LSPO_MOD, LSPO_KEY` |Send `KC_LSFT` when held, the mod and key defined by `LSPO_MOD` and `LSPO_KEY`. |
40|`RSPC_KEYS` |`KC_RSFT, RSPC_MOD, RSPC_KEY` |Send `KC_RSFT` when held, the mod and key defined by `RSPC_MOD` and `RSPC_KEY`. | 40|`RSPC_KEYS` |`KC_RSFT, RSPC_MOD, RSPC_KEY` |Send `KC_RSFT` when held, the mod and key defined by `RSPC_MOD` and `RSPC_KEY`. |
41|`LCPO_KEYS` |`KC_LCTL, KC_LCTL, KC_9` |Send `KC_LCTL` when held, the mod `KC_LCTL` with the key `KC_9` when tapped. | 41|`LCPO_KEYS` |`KC_LCTL, KC_LSFT, KC_9` |Send `KC_LCTL` when held, the mod `KC_LSFT` with the key `KC_9` when tapped. |
42|`RCPC_KEYS` |`KC_RCTL, KC_RCTL, KC_0` |Send `KC_RCTL` when held, the mod `KC_RCTL` with the key `KC_0` when tapped. | 42|`RCPC_KEYS` |`KC_RCTL, KC_RSFT, KC_0` |Send `KC_RCTL` when held, the mod `KC_RSFT` with the key `KC_0` when tapped. |
43|`LAPO_KEYS` |`KC_LALT, KC_LALT, KC_9` |Send `KC_LALT` when held, the mod `KC_LALT` with the key `KC_9` when tapped. | 43|`LAPO_KEYS` |`KC_LALT, KC_LSFT, KC_9` |Send `KC_LALT` when held, the mod `KC_LSFT` with the key `KC_9` when tapped. |
44|`RAPC_KEYS` |`KC_RALT, KC_RALT, KC_0` |Send `KC_RALT` when held, the mod `KC_RALT` with the key `KC_0` when tapped. | 44|`RAPC_KEYS` |`KC_RALT, KC_RSFT, KC_0` |Send `KC_RALT` when held, the mod `KC_RSFT` with the key `KC_0` when tapped. |
45|`SFTENT_KEYS` |`KC_RSFT, KC_TRNS, SFTENT_KEY` |Send `KC_RSFT` when held, no mod with the key `SFTENT_KEY` when tapped. | 45|`SFTENT_KEYS` |`KC_RSFT, KC_TRNS, SFTENT_KEY` |Send `KC_RSFT` when held, no mod with the key `SFTENT_KEY` when tapped. |
46 46
47 47
diff --git a/docs/keycodes.md b/docs/keycodes.md
index c0e6aa5c6..e9cfd3425 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -216,6 +216,11 @@ This is a reference only. Each group of keys links to the page documenting their
216|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI| 216|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
217|`KC_LSPO` | |Left Shift when held, `(` when tapped | 217|`KC_LSPO` | |Left Shift when held, `(` when tapped |
218|`KC_RSPC` | |Right Shift when held, `)` when tapped | 218|`KC_RSPC` | |Right Shift when held, `)` when tapped |
219|`KC_LCPO` | |Left Control when held, `(` when tapped |
220|`KC_RCPC` | |Right Control when held, `)` when tapped |
221|`KC_LAPO` | |Left Alt when held, `(` when tapped |
222|`KC_RAPC` | |Right Alt when held, `)` when tapped |
223|`KC_SFTENT` | |Right Shift when held, Enter when tapped |
219|`KC_LEAD` | |The [Leader key](feature_leader_key.md) | 224|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
220|`KC_LOCK` | |The [Lock key](feature_key_lock.md) | 225|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
221|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) | 226|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) |
diff --git a/docs/quantum_keycodes.md b/docs/quantum_keycodes.md
index 90192e632..a2ba34c32 100644
--- a/docs/quantum_keycodes.md
+++ b/docs/quantum_keycodes.md
@@ -1,6 +1,6 @@
1# Quantum Keycodes 1# Quantum Keycodes
2 2
3Quantum keycodes allow for easier customisation of your keymap than the basic ones provide, without having to define custom actions. 3Quantum keycodes allow for easier customization of your keymap than the basic ones provide, without having to define custom actions.
4 4
5All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification. 5All keycodes within quantum are numbers between `0x0000` and `0xFFFF`. Within your `keymap.c` it may look like you have functions and other special cases, but ultimately the C preprocessor will translate those into a single 4 byte integer. QMK has reserved `0x0000` through `0x00FF` for standard keycodes. These are keycodes such as `KC_A`, `KC_1`, and `KC_LCTL`, which are basic keys defined in the USB HID specification.
6 6
@@ -16,6 +16,11 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are
16|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI| 16|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
17|`KC_LSPO` | |Left Shift when held, `(` when tapped | 17|`KC_LSPO` | |Left Shift when held, `(` when tapped |
18|`KC_RSPC` | |Right Shift when held, `)` when tapped | 18|`KC_RSPC` | |Right Shift when held, `)` when tapped |
19|`KC_LCPO` | |Left Control when held, `(` when tapped |
20|`KC_RCPC` | |Right Control when held, `)` when tapped |
21|`KC_LAPO` | |Left Alt when held, `(` when tapped |
22|`KC_RAPC` | |Right Alt when held, `)` when tapped |
23|`KC_SFTENT` | |Right Shift when held, Enter when tapped |
19|`KC_LEAD` | |The [Leader key](feature_leader_key.md) | 24|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
20|`KC_LOCK` | |The [Lock key](feature_key_lock.md) | 25|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
21|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) | 26|`FUNC(n)` |`F(n)` |Call `fn_action(n)` (deprecated) |