From abb6c7cfcea4c94f2a6846377853dc2c7f9301ec Mon Sep 17 00:00:00 2001 From: Felix Sargent Date: Thu, 16 Dec 2021 13:05:30 -0800 Subject: [PATCH 1/3] Improve 'retro-tap' documentation. --- docs/docs/behaviors/hold-tap.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md index 972df0be..27211c59 100644 --- a/docs/docs/behaviors/hold-tap.md +++ b/docs/docs/behaviors/hold-tap.md @@ -50,13 +50,19 @@ In QMK, unlike ZMK, this functionality is enabled by default, and you turn it of #### `retro-tap` -If retro tap is enabled, the tap behavior is triggered when releasing the hold-tap key if no other key was pressed in the meantime. +If retro tap is enabled, the tap behavior is triggered when releasing the hold-tap key if no other key was pressed in the meantime. The hold key does not activate until another key is pressed, meaning that it cannot be used for mouse events like Shift Click to select from your cursor position to mouse position. -For example, if you press `&mt LEFT_SHIFT A` and then release it without pressing another key, it will output `a`. +For example, if you press `&sh LEFT_SHIFT Z` and then release it without pressing another key, it will output `z`. ``` -&mt { - retro-tap; +sh: shift { + compatible = "zmk,behavior-hold-tap"; + label = "shift mod"; + #binding-cells = <2>; + tapping_term_ms = <100>; + retro-tap; + flavor = "hold-preferred"; + bindings = <&kp>, <&kp>; }; ``` From 161a7846c8b01459444de40d89728975d82be674 Mon Sep 17 00:00:00 2001 From: Felix Sargent Date: Thu, 16 Dec 2021 13:14:04 -0800 Subject: [PATCH 2/3] Update hold-tap.md --- docs/docs/behaviors/hold-tap.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md index 27211c59..ad6eb503 100644 --- a/docs/docs/behaviors/hold-tap.md +++ b/docs/docs/behaviors/hold-tap.md @@ -52,17 +52,21 @@ In QMK, unlike ZMK, this functionality is enabled by default, and you turn it of If retro tap is enabled, the tap behavior is triggered when releasing the hold-tap key if no other key was pressed in the meantime. The hold key does not activate until another key is pressed, meaning that it cannot be used for mouse events like Shift Click to select from your cursor position to mouse position. -For example, if you press `&sh LEFT_SHIFT Z` and then release it without pressing another key, it will output `z`. +For example, if you press `&mt LEFT_SHIFT Z` and then release it without pressing another key, it will output `z`. ``` -sh: shift { +/ { +behaviors { + mt_retro: mt_retro { + retro-tap; compatible = "zmk,behavior-hold-tap"; label = "shift mod"; #binding-cells = <2>; tapping_term_ms = <100>; - retro-tap; flavor = "hold-preferred"; bindings = <&kp>, <&kp>; + }; +}; }; ``` From 3efb6906baaea8bc578f3ab124b8e5ec5d83eb21 Mon Sep 17 00:00:00 2001 From: Felix Sargent Date: Thu, 16 Dec 2021 14:36:33 -0800 Subject: [PATCH 3/3] Update hold-tap.md --- docs/docs/behaviors/hold-tap.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md index ad6eb503..52917688 100644 --- a/docs/docs/behaviors/hold-tap.md +++ b/docs/docs/behaviors/hold-tap.md @@ -52,19 +52,19 @@ In QMK, unlike ZMK, this functionality is enabled by default, and you turn it of If retro tap is enabled, the tap behavior is triggered when releasing the hold-tap key if no other key was pressed in the meantime. The hold key does not activate until another key is pressed, meaning that it cannot be used for mouse events like Shift Click to select from your cursor position to mouse position. -For example, if you press `&mt LEFT_SHIFT Z` and then release it without pressing another key, it will output `z`. +For example, if you press `&mt_retro LEFT_SHIFT Z` and then release it without pressing another key, it will output `z`. ``` / { behaviors { mt_retro: mt_retro { - retro-tap; compatible = "zmk,behavior-hold-tap"; - label = "shift mod"; + label = "mod tap with retro-tap"; #binding-cells = <2>; tapping_term_ms = <100>; flavor = "hold-preferred"; bindings = <&kp>, <&kp>; + retro-tap; }; }; };