diff options
| -rw-r--r-- | docs/feature_advanced_keycodes.md | 33 | ||||
| -rw-r--r-- | docs/mod_tap.md | 35 |
2 files changed, 37 insertions, 31 deletions
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md index b8664074a..745308b29 100644 --- a/docs/feature_advanced_keycodes.md +++ b/docs/feature_advanced_keycodes.md | |||
| @@ -2,21 +2,24 @@ | |||
| 2 | 2 | ||
| 3 | These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent. | 3 | These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent. |
| 4 | 4 | ||
| 5 | |Key |Aliases |Description | | 5 | |Key |Aliases |Description | |
| 6 | |----------|-------------------------------|----------------------------------------------------| | 6 | |----------|-------------------------------|------------------------------------------------------| |
| 7 | |`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` | | 7 | |`LCTL(kc)`|`C(kc)` |Hold Left Control and press `kc` | |
| 8 | |`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` | | 8 | |`LSFT(kc)`|`S(kc)` |Hold Left Shift and press `kc` | |
| 9 | |`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` | | 9 | |`LALT(kc)`|`A(kc)`, `LOPT(kc)` |Hold Left Alt and press `kc` | |
| 10 | |`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` | | 10 | |`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc` | |
| 11 | |`RCTL(kc)`| |Hold Right Control and press `kc` | | 11 | |`RCTL(kc)`| |Hold Right Control and press `kc` | |
| 12 | |`RSFT(kc)`| |Hold Right Shift and press `kc` | | 12 | |`RSFT(kc)`| |Hold Right Shift and press `kc` | |
| 13 | |`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` | | 13 | |`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)` |Hold Right Alt and press `kc` | |
| 14 | |`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` | | 14 | |`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)` |Hold Right GUI and press `kc` | |
| 15 | |`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` | | 15 | |`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)` |Hold Left Shift and GUI and press `kc` | |
| 16 | |`LCA(kc)` | |Hold Left Control and Alt and press `kc` | | 16 | |`LCA(kc)` | |Hold Left Control and Alt and press `kc` | |
| 17 | |`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` | | 17 | |`LSA(kc)` | |Hold Left Shift and Left Alt and press `kc` | |
| 18 | |`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` | | 18 | |`RSA(kc)` |`SAGR(kc)` |Hold Right Shift and Right Alt (AltGr) and press `kc` | |
| 19 | |`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc`| | 19 | |`RCS(kc)` | |Hold Right Control and Right Shift and press `kc` | |
| 20 | |`LCAG(kc)`| |Hold Left Control, Alt and GUI and press `kc` | | ||
| 21 | |`MEH(kc)` | |Hold Left Control, Shift and Alt and press `kc` | | ||
| 22 | |`HYPR(kc)`| |Hold Left Control, Shift, Alt and GUI and press `kc` | | ||
| 20 | 23 | ||
| 21 | You can also chain them, for example `LCTL(LALT(KC_DEL))` or `C(A(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress. | 24 | You can also chain them, for example `LCTL(LALT(KC_DEL))` or `C(A(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress. |
| 22 | 25 | ||
diff --git a/docs/mod_tap.md b/docs/mod_tap.md index ced0beba9..1217b47f9 100644 --- a/docs/mod_tap.md +++ b/docs/mod_tap.md | |||
| @@ -27,22 +27,25 @@ This key would activate Left Control and Left Shift when held, and send Escape w | |||
| 27 | 27 | ||
| 28 | For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap: | 28 | For convenience, QMK includes some Mod-Tap shortcuts to make common combinations more compact in your keymap: |
| 29 | 29 | ||
| 30 | |Key |Aliases |Description | | 30 | |Key |Aliases |Description | |
| 31 | |------------|-----------------------------------------------------------------|-------------------------------------------------------| | 31 | |------------|-----------------------------------------------------------------|--------------------------------------------------------------| |
| 32 | |`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped | | 32 | |`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped | |
| 33 | |`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped | | 33 | |`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped | |
| 34 | |`LALT_T(kc)`|`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped | | 34 | |`LALT_T(kc)`|`LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)` |Left Alt when held, `kc` when tapped | |
| 35 | |`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped | | 35 | |`LGUI_T(kc)`|`LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)`|Left GUI when held, `kc` when tapped | |
| 36 | |`RCTL_T(kc)`| |Right Control when held, `kc` when tapped | | 36 | |`RCTL_T(kc)`| |Right Control when held, `kc` when tapped | |
| 37 | |`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped | | 37 | |`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped | |
| 38 | |`RALT_T(kc)`|`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped | | 38 | |`RALT_T(kc)`|`ROPT_T(kc)`, `ALGR_T(kc)` |Right Alt when held, `kc` when tapped | |
| 39 | |`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped | | 39 | |`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped | |
| 40 | |`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped | | 40 | |`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped | |
| 41 | |`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped | | 41 | |`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped | |
| 42 | |`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped | | 42 | |`LSA_T(kc)` | |Left Shift and Alt when held, `kc` when tapped | |
| 43 | |`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped | | 43 | |`RSA_T(kc)` |`SAGR_T(kc)` |Right Shift and Right Alt (AltGr) when held, `kc` when tapped | |
| 44 | |`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped | | 44 | |`RCS_T(kc)` | |Right Control and Right Shift when held, `kc` when tapped | |
| 45 | |`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped| | 45 | |`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped | |
| 46 | |`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped | | ||
| 47 | |`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped | | ||
| 48 | |`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped | | ||
| 46 | |`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| | 49 | |`HYPR_T(kc)`|`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| |
| 47 | 50 | ||
| 48 | ## Caveats | 51 | ## Caveats |
