summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPascal Getreuer <50221757+getreuer@users.noreply.github.com>2026-01-03 15:00:50 -0800
committerGitHub <noreply@github.com>2026-01-04 07:00:50 +0800
commit31948625020db943f2a5272a43876983c404d814 (patch)
tree8275a43385023ac94d6a3298d496048cb8cc71c7 /docs
parent8c035c2116c0ff2617a6aba996c3b6a9c977e19e (diff)
docs/tap_hold.md fixes: Note that Chordal Hold supports multiple same-side mods and fix heading for Speculative Hold. (#25924)
* Note Chordal Hold supports multiple same-side mods. * Fix "Speculative Hold" heading from H3 -> H2.
Diffstat (limited to 'docs')
-rw-r--r--docs/tap_hold.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/tap_hold.md b/docs/tap_hold.md
index 2aa628c535..3e88a7a5c2 100644
--- a/docs/tap_hold.md
+++ b/docs/tap_hold.md
@@ -604,6 +604,20 @@ Or if the two keys are on opposite hands and the `PERMISSIVE_HOLD` option is
604enabled, this will produce `C` with `SFT_T(KC_A)` settled as held when that 604enabled, this will produce `C` with `SFT_T(KC_A)` settled as held when that
605`KC_C` is released. 605`KC_C` is released.
606 606
607As an exception to the opposite hands rule, Chordal Hold supports combining
608multiple same-side modifiers within the tapping term. This is useful for
609multi-mod hotkeys like Ctrl + Shift + V. For instance with Chordal Hold together
610with either Permissive Hold or Hold On Other Key Press, the following input
611results in Ctrl + Shift + V being sent, supposing `J` and `K` are on the right
612hand side and `V` is on the left hand side:
613
614- `SFT_T(KC_J)` Down
615- `CTL_T(KC_K)` Down
616- `KC_V` Down
617- `KC_V` Up
618- `SFT_T(KC_J)` Up
619- `CTL_T(KC_K)` Up
620
607### Chordal Hold Handedness 621### Chordal Hold Handedness
608 622
609Determining whether keys are on the same or opposite hands involves defining the 623Determining whether keys are on the same or opposite hands involves defining the
@@ -779,7 +793,7 @@ Do not use `MOD_xxx` constants like `MOD_LSFT` or `MOD_RALT`, since they're 5-bi
779 793
780[Auto Shift](features/auto_shift) has its own version of `retro tapping` called `retro shift`. It is extremely similar to `retro tapping`, but holding the key past `AUTO_SHIFT_TIMEOUT` results in the value it sends being shifted. Other configurations also affect it differently; see [here](features/auto_shift#retro-shift) for more information. 794[Auto Shift](features/auto_shift) has its own version of `retro tapping` called `retro shift`. It is extremely similar to `retro tapping`, but holding the key past `AUTO_SHIFT_TIMEOUT` results in the value it sends being shifted. Other configurations also affect it differently; see [here](features/auto_shift#retro-shift) for more information.
781 795
782### Speculative Hold 796## Speculative Hold
783 797
784Speculative Hold makes mod-tap keys more responsive by applying the modifier instantly on keydown, before the tap-hold decision is made. This is especially useful for actions like Shift+Click with a mouse, which can feel laggy with standard mod-taps. 798Speculative Hold makes mod-tap keys more responsive by applying the modifier instantly on keydown, before the tap-hold decision is made. This is especially useful for actions like Shift+Click with a mouse, which can feel laggy with standard mod-taps.
785 799
@@ -820,4 +834,4 @@ Well, it's simple really: customization. But specifically, it depends on how you
820 834
821## Why are there no `*_kb` or `*_user` functions?! 835## Why are there no `*_kb` or `*_user` functions?!
822 836
823Unlike many of the other functions here, there isn't a need (or even reason) to have a quantum- or keyboard-level function. Only user-level functions are useful here, so there is no need to mark them as such. \ No newline at end of file 837Unlike many of the other functions here, there isn't a need (or even reason) to have a quantum- or keyboard-level function. Only user-level functions are useful here, so there is no need to mark them as such.