diff options
author | Drashna Jaelre <drashna@live.com> | 2019-11-03 09:52:01 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-11-03 09:52:01 -0800 |
commit | e9c44e396d21df990b1d08e8b4c30e288797dffe (patch) | |
tree | db2d0ac705fb1896553ae43bbd572a99ab270b1e /docs/feature_auto_shift.md | |
parent | 38353688f2cf2d077a0e16b9a3f2b054fffc74c0 (diff) | |
download | qmk_firmware-e9c44e396d21df990b1d08e8b4c30e288797dffe.tar.gz qmk_firmware-e9c44e396d21df990b1d08e8b4c30e288797dffe.zip |
Smallish overhaul of Auto-Shift feature (#6067)
* Fix edge case when using One Shot Layer with Auto Shift, and it not triggering the cleanup
* Remove junk code (no longer used)
* Replace `(un)register_code` calls with `tap_code` where appropriate
* Fixed up Switch check to be more readable (less verbose)
* Simplified modifier check (if it comes back non-zero, there are mods)
* Add additional function calls for autoshift settings
* Made all variables static, since there are function calls to get their status
* Fixed up documentation
* Re-add special characters that were missed
* formatting pass
Diffstat (limited to 'docs/feature_auto_shift.md')
-rw-r--r-- | docs/feature_auto_shift.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/feature_auto_shift.md b/docs/feature_auto_shift.md index 9b4b29624..f0b507bc6 100644 --- a/docs/feature_auto_shift.md +++ b/docs/feature_auto_shift.md | |||
@@ -51,12 +51,15 @@ By default, Auto Shift is disabled for any key press that is accompanied by one | |||
51 | modifiers. Thus, Ctrl+A that you hold for a really long time is not the same | 51 | modifiers. Thus, Ctrl+A that you hold for a really long time is not the same |
52 | as Ctrl+Shift+A. | 52 | as Ctrl+Shift+A. |
53 | 53 | ||
54 | You can re-enable Auto Shift for modifiers by adding another rule to your `rules.mk` | 54 | You can re-enable Auto Shift for modifiers by adding a define to your `config.h` |
55 | 55 | ||
56 | AUTO_SHIFT_MODIFIERS = yes | 56 | ```c |
57 | #define AUTO_SHIFT_MODIFIERS | ||
58 | ``` | ||
57 | 59 | ||
58 | In which case, Ctrl+A held past the `AUTO_SHIFT_TIMEOUT` will be sent as Ctrl+Shift+A | 60 | In which case, Ctrl+A held past the `AUTO_SHIFT_TIMEOUT` will be sent as Ctrl+Shift+A |
59 | 61 | ||
62 | |||
60 | ## Configuring Auto Shift | 63 | ## Configuring Auto Shift |
61 | 64 | ||
62 | If desired, there is some configuration that can be done to change the | 65 | If desired, there is some configuration that can be done to change the |
@@ -65,15 +68,12 @@ behavior of Auto Shift. This is done by setting various variables the | |||
65 | 68 | ||
66 | A sample is | 69 | A sample is |
67 | 70 | ||
68 | #ifndef CONFIG_USER_H | 71 | ```c |
69 | #define CONFIG_USER_H | 72 | #pragma once |
70 | |||
71 | #include "../../config.h" | ||
72 | |||
73 | #define AUTO_SHIFT_TIMEOUT 150 | ||
74 | #define NO_AUTO_SHIFT_SPECIAL | ||
75 | 73 | ||
76 | #endif | 74 | #define AUTO_SHIFT_TIMEOUT 150 |
75 | #define NO_AUTO_SHIFT_SPECIAL | ||
76 | ``` | ||
77 | 77 | ||
78 | ### AUTO_SHIFT_TIMEOUT (Value in ms) | 78 | ### AUTO_SHIFT_TIMEOUT (Value in ms) |
79 | 79 | ||