diff options
| author | Ryan <fauxpark@gmail.com> | 2023-01-31 05:37:19 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-30 18:37:19 +0000 |
| commit | 2d843088a26ee639287d16fbd9ca4c35e18f7b8b (patch) | |
| tree | 773ee2c9b7515594683ef9e4cb5755de68bae4e9 /docs | |
| parent | cc9520b7a02ccdc97f79a800de04ff4ea15f2656 (diff) | |
Normalise Swap Hands keycodes (#19720)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_swap_hands.md | 24 | ||||
| -rw-r--r-- | docs/keycodes.md | 20 |
2 files changed, 22 insertions, 22 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 6768020f12..35131884e1 100644 --- a/docs/feature_swap_hands.md +++ b/docs/feature_swap_hands.md @@ -19,18 +19,18 @@ Note that the array indices are reversed same as the matrix and the values are o ## Swap Keycodes -|Key |Description | -|-----------|-------------------------------------------------------------------------| -|`SH_T(key)`|Sends `key` with a tap; momentary swap when held. | -|`SH_ON` |Turns on swapping and leaves it on. | -|`SH_OFF` |Turn off swapping and leaves it off. Good for returning to a known state.| -|`SH_MON` |Swaps hands when pressed, returns to normal when released (momentary). | -|`SH_MOFF` |Momentarily turns off swap. | -|`SH_TG` |Toggles swap on and off with every key press. | -|`SH_TT` |Momentary swap when held, toggles with repeated taps (see below). | -|`SH_OS` |One shot swap hands: toggles while pressed or until next key press. | - -`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md?id=switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`. +|Key |Aliases |Description | +|-----------------------------|---------|----------------------------------------------------| +|`SH_T(kc)` | |Momentary swap when held, `kc` when tapped | +|`QK_SWAP_HANDS_ON` |`SH_ON` |Turn on hand swap | +|`QK_SWAP_HANDS_OFF` |`SH_OFF` |Turn off hand swap | +|`QK_SWAP_HANDS_MOMENTARY_ON` |`SH_MON` |Turn on hand swap while held | +|`QK_SWAP_HANDS_MOMENTARY_OFF`|`SH_MOFF`|Turn off hand swap while held | +|`QK_SWAP_HANDS_TOGGLE` |`SH_TOGG`|Toggle hand swap | +|`QK_SWAP_HANDS_TAP_TOGGLE` |`SH_TT` |Momentary swap when held, toggle when tapped | +|`QK_SWAP_HANDS_ONE_SHOT` |`SH_OS` |Turn on hand swap while held or until next key press| + +`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md?id=switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TOGG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`. ## Encoder Mapping diff --git a/docs/keycodes.md b/docs/keycodes.md index f660c7f526..b3be0847e8 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -819,16 +819,16 @@ See also: [Space Cadet](feature_space_cadet.md) See also: [Swap Hands](feature_swap_hands.md) -|Key |Description | -|-----------|-------------------------------------------------------------------------| -|`SH_T(key)`|Sends `key` with a tap; momentary swap when held. | -|`SH_ON` |Turns on swapping and leaves it on. | -|`SH_OFF` |Turn off swapping and leaves it off. Good for returning to a known state.| -|`SH_MON` |Swaps hands when pressed, returns to normal when released (momentary). | -|`SH_MOFF` |Momentarily turns off swap. | -|`SH_TG` |Toggles swap on and off with every key press. | -|`SH_TT` |Toggles with a tap; momentary when held. | -|`SH_OS` |One shot swap hands: toggle while pressed or until next key press. | +|Key |Aliases |Description | +|-----------------------------|---------|----------------------------------------------------| +|`SH_T(kc)` | |Momentary swap when held, `kc` when tapped | +|`QK_SWAP_HANDS_ON` |`SH_ON` |Turn on hand swap | +|`QK_SWAP_HANDS_OFF` |`SH_OFF` |Turn off hand swap | +|`QK_SWAP_HANDS_MOMENTARY_ON` |`SH_MON` |Turn on hand swap while held | +|`QK_SWAP_HANDS_MOMENTARY_OFF`|`SH_MOFF`|Turn off hand swap while held | +|`QK_SWAP_HANDS_TOGGLE` |`SH_TOGG`|Toggle hand swap | +|`QK_SWAP_HANDS_TAP_TOGGLE` |`SH_TT` |Momentary swap when held, toggle when tapped | +|`QK_SWAP_HANDS_ONE_SHOT` |`SH_OS` |Turn on hand swap while held or until next key press| ## Unicode Support :id=unicode-support |