aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_advanced_keycodes.md3
-rw-r--r--docs/keycodes.md17
2 files changed, 11 insertions, 9 deletions
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md
index ceee7fad1..f61d78d50 100644
--- a/docs/feature_advanced_keycodes.md
+++ b/docs/feature_advanced_keycodes.md
@@ -25,7 +25,8 @@ These functions allow you to activate layers in various ways.
25* `LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped. 25* `LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped.
26* `TG(layer)` - toggles a layer on or off. 26* `TG(layer)` - toggles a layer on or off.
27* `TO(layer)` - Goes to a layer. This code is special, because it lets you go either up or down the stack -- just goes directly to the layer you want. So while other codes only let you go _up_ the stack (from layer 0 to layer 3, for example), `TO(2)` is going to get you to layer 2, no matter where you activate it from -- even if you're currently on layer 5. This gets activated on keydown (as soon as the key is pressed). 27* `TO(layer)` - Goes to a layer. This code is special, because it lets you go either up or down the stack -- just goes directly to the layer you want. So while other codes only let you go _up_ the stack (from layer 0 to layer 3, for example), `TO(2)` is going to get you to layer 2, no matter where you activate it from -- even if you're currently on layer 5. This gets activated on keydown (as soon as the key is pressed).
28* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, the layer becomes active, and then deactivates when you let go. And if you tap it, the layer simply becomes active (toggles on). It needs 5 taps by default, but you can set it by defining `TAPPING_TOGGLE`, for example, `#define TAPPING_TOGGLE 2` for just two taps. 28* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, the layer becomes active, and then deactivates when you let go. And if you repeatedly tap it, the layer simply becomes active (toggles on). It needs 5 taps by default, but you can set it by defining `TAPPING_TOGGLE`, for example, `#define TAPPING_TOGGLE 2` for just two taps.
29* `LM(layer, mod)` - Momentary switch to *layer* (like MO), but with modifier(s) *mod* active. Only supports layers 0-15 and the left modifiers.
29 30
30# Working with Layers 31# Working with Layers
31 32
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 0f7968e7d..dad645cf0 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -368,14 +368,15 @@ This is a reference only. Each group of keys links to the page documenting their
368 368
369## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers) 369## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers)
370 370
371|Key |Description | 371|Key |Description |
372|---------------|----------------------------------------------------------------------------------| 372|----------------|----------------------------------------------------------------------------------|
373|`LT(layer, kc)`|Turn on `layer` when held, `kc` when tapped | 373|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
374|`TO(layer)` |Turn on `layer` when pressed | 374|`TO(layer)` |Turn on `layer` when pressed |
375|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)| 375|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
376|`DF(layer)` |Set the base (default) layer | 376|`DF(layer)` |Set the base (default) layer |
377|`TG(layer)` |Toggle `layer` on or off | 377|`TG(layer)` |Toggle `layer` on or off |
378|`TT(layer)` |Tap toggle? idk FIXME | 378|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
379|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. |
379 380
380## [One Shot Keys](quantum_keycodes.md#one-shot-keys) 381## [One Shot Keys](quantum_keycodes.md#one-shot-keys)
381 382