-# Auto Shift: Why do we need a shift key?
+# Auto Shift: Why Do We Need a Shift Key?
Tap a key and you get its character. Tap a key, but hold it *slightly* longer
-and you get its shifted state. Viola! No shift key needed!
+and you get its shifted state. VoilĂ ! No shift key needed!
## Why Auto Shift?
all too often when reaching for the shift key. Auto Shift looks to alleviate that
problem.
-## How does it work?
+## How Does It Work?
When you tap a key, it stays depressed for a short period of time before it is
then released. This depressed time is a different length for everyone. Auto Shift
`AUTO_SHIFT_TIMEOUT`, then a shifted version of the key is emitted. If the time
is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted.
-## Are there limitations to Auto Shift?
+## Are There Limitations to Auto Shift?
Yes, unfortunately.
characters, you could press and hold the 'a' key for a second or two. This no
longer works with Auto Shift because it is timing your depressed time instead
of emitting a depressed key state to your operating system.
-2. Auto Shift is disabled for any key press that is accompanied by one or more
- modifiers. Thus, Ctrl+A that you hold for a really long time is not the same
- as Ctrl+Shift+A.
-3. You will have characters that are shifted when you did not intend on shifting, and
+2. You will have characters that are shifted when you did not intend on shifting, and
other characters you wanted shifted, but were not. This simply comes down to
practice. As we get in a hurry, we think we have hit the key long enough
for a shifted version, but we did not. On the other hand, we may think we are
tapping the keys, but really we have held it for a little longer than
anticipated.
-## How do I enable Auto Shift?
+## How Do I Enable Auto Shift?
Add to your `rules.mk` in the keymap folder:
- AUTO_SHIFT_ENABLE = YES
+ AUTO_SHIFT_ENABLE = yes
If no `rules.mk` exists, you can create one.
Then compile and install your new firmware with Auto Key enabled! That's it!
+## Modifiers
+
+By default, Auto Shift is disabled for any key press that is accompanied by one or more
+modifiers. Thus, Ctrl+A that you hold for a really long time is not the same
+as Ctrl+Shift+A.
+
+You can re-enable Auto Shift for modifiers by adding another rule to your `rules.mk`
+
+ AUTO_SHIFT_MODIFIERS = yes
+
+In which case, Ctrl+A held past the `AUTO_SHIFT_TIMEOUT` will be sent as Ctrl+Shift+A
+
## Configuring Auto Shift
If desired, there is some configuration that can be done to change the
#endif
-### AUTO_SHIFT_TIMEOUT (value in ms)
+### AUTO_SHIFT_TIMEOUT (Value in ms)
This controls how long you have to hold a key before you get the shifted state.
Obviously, this is different for everyone. For the common person, a setting of
Play with this value until things are perfect. Many find that all will work well
at a given value, but one or two keys will still emit the shifted state on
-occassion. This is simply due to habit and holding some keys a little longer
+occasion. This is simply due to habit and holding some keys a little longer
than others. Once you find this value, work on tapping your problem keys a little
quicker than normal and you will be set.
### NO_AUTO_SHIFT_SPECIAL (simple define)
-Do not Auto Shift special keys, which include -_, =+, [{, ]}, ;:, '", ,<, .>,
+Do not Auto Shift special keys, which include -\_, =+, [{, ]}, ;:, '", ,<, .>,
and /?
### NO_AUTO_SHIFT_NUMERIC (simple define)
## Using Auto Shift Setup
-This will enable you to define three keys temporailiy to increase, decrease and report your `AUTO_SHIFT_TIMEOUT`.
+This will enable you to define three keys temporarily to increase, decrease and report your `AUTO_SHIFT_TIMEOUT`.
### Setup
| KC_ASDN | Lower the Auto Shift timeout variable (down) |
| KC_ASUP | Raise the Auto Shift timeout variable (up) |
| KC_ASRP | Report your current Auto Shift timeout value |
+| KC_ASON | Turns on the Auto Shift Function |
+| KC_ASOFF | Turns off the Auto Shift Function |
+| KC_ASTG | Toggles the state of the Auto Shift feature |
Compile and upload your new firmware.
9. Remove the key bindings `KC_ASDN`, `KC_ASUP` and `KC_ASRP`.
10. Compile and upload your new firmware.
-#### An example run
+#### An Example Run
-'''
-hello world. my name is john doe. i am a computer programmer playing with
-keyboards right now.
+ hello world. my name is john doe. i am a computer programmer playing with
+ keyboards right now.
-[PRESS KC_ASDN quite a few times]
+ [PRESS KC_ASDN quite a few times]
-heLLo woRLd. mY nAMe is JOHn dOE. i AM A compUTeR proGRaMMER PlAYiNG witH
-KEYboArDS RiGHT NOw.
+ heLLo woRLd. mY nAMe is JOHn dOE. i AM A compUTeR proGRaMMER PlAYiNG witH
+ KEYboArDS RiGHT NOw.
-[PRESS KC_ASUP a few times]
+ [PRESS KC_ASUP a few times]
-hello world. my name is john Doe. i am a computer programmer playing with
-keyboarDs right now.
+ hello world. my name is john Doe. i am a computer programmer playing with
+ keyboarDs right now.
-[PRESS KC_ASRP]
+ [PRESS KC_ASRP]
-115
-'''
+ 115
The keyboard typed `115` which represents your current `AUTO_SHIFT_TIMEOUT`
value. You are now set! Practice on the *D* key a little bit that showed up
-in the testing and you'll be golden.
\ No newline at end of file
+in the testing and you'll be golden.