aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnthony <anthonyrichir@users.noreply.github.com>2019-02-05 19:36:26 +0100
committerDrashna Jaelre <drashna@live.com>2019-02-05 10:36:26 -0800
commit5c7a31eae2518b2630f31cf825ecbb08e358ae76 (patch)
tree7fcf0af3fab16fc58f5e386e5c4caf96ec24d187 /docs
parent47051f506fd4888bbb55fa7981cb7b24827f3d1b (diff)
downloadqmk_firmware-5c7a31eae2518b2630f31cf825ecbb08e358ae76.tar.gz
qmk_firmware-5c7a31eae2518b2630f31cf825ecbb08e358ae76.zip
Improvements to Space Cadet Shift (#3856)
* Improvement of Space Cadet Shift by preventing to automatically apply a modifier on the key and allow to override the default modifier. Closes qmk/qmk_firmware#3815 * Improve the use of the DISABLE_SPACE_CADET_MODIFIER flag to avoid unregistering KC_LSFT when equals to LSPO_MOD * change #if to if statement
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_space_cadet_shift.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/feature_space_cadet_shift.md b/docs/feature_space_cadet_shift.md
index bec7cbd3d..427d2a581 100644
--- a/docs/feature_space_cadet_shift.md
+++ b/docs/feature_space_cadet_shift.md
@@ -25,9 +25,13 @@ COMMAND_ENABLE = no
25 25
26By default Space Cadet assumes a US ANSI layout, but if your layout uses different keys for parentheses, you can redefine them in your `config.h`. 26By default Space Cadet assumes a US ANSI layout, but if your layout uses different keys for parentheses, you can redefine them in your `config.h`.
27You can also disable the rollover, allowing you to use the opposite Shift key to cancel the Space Cadet state in the event of an erroneous press, instead of emitting a pair of parentheses when the keys are released. 27You can also disable the rollover, allowing you to use the opposite Shift key to cancel the Space Cadet state in the event of an erroneous press, instead of emitting a pair of parentheses when the keys are released.
28 28Also, by default, the Space Cadet applies modifiers LSPO_MOD and RSPC_MOD to keys defined by LSPO_KEY and RSPC_KEY. You can override this behavior by redefining those variables in your `config.h`. You can also prevent the Space Cadet to apply a modifier by defining DISABLE_SPACE_CADET_MODIFIER in your `config.h`.
29|Define |Default |Description | 29
30|------------------------------|-------------|------------------------------------------------------------| 30|Define |Default |Description |
31|`LSPO_KEY` |`KC_9` |The keycode to send when Left Shift is tapped | 31|------------------------------|-------------|--------------------------------------------------------------------------------|
32|`RSPC_KEY` |`KC_0` |The keycode to send when Right Shift is tapped | 32|`LSPO_KEY` |`KC_9` |The keycode to send when Left Shift is tapped |
33|`DISABLE_SPACE_CADET_ROLLOVER`|*Not defined*|If defined, use the opposite Shift key to cancel Space Cadet| 33|`RSPC_KEY` |`KC_0` |The keycode to send when Right Shift is tapped |
34|`LSPO_MOD` |`KC_LSFT` |The keycode to send when Left Shift is tapped |
35|`RSPC_MOD` |`KC_RSFT` |The keycode to send when Right Shift is tapped |
36|`DISABLE_SPACE_CADET_ROLLOVER`|*Not defined*|If defined, use the opposite Shift key to cancel Space Cadet |
37|`DISABLE_SPACE_CADET_MODIFIER`|*Not defined*|If defined, prevent the Space Cadet to apply a modifier to LSPO_KEY and RSPC_KEY|