diff options
author | Jeremy Cowgar <jeremy@cowgar.com> | 2017-09-18 08:49:45 -0400 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2017-09-18 17:08:18 -0400 |
commit | a89183591c8dc5e7a814c1429a66fdadf58a7b49 (patch) | |
tree | 807ea6635d758f841d1133c7368a88ae0feec360 /docs | |
parent | d0ca713eb4abb14d5709341b8db88a8ad04719ab (diff) | |
download | qmk_firmware-a89183591c8dc5e7a814c1429a66fdadf58a7b49.tar.gz qmk_firmware-a89183591c8dc5e7a814c1429a66fdadf58a7b49.zip |
Fixed a few typos and spelling errors in auto shift feature document
Diffstat (limited to 'docs')
-rw-r--r-- | docs/feature_auto_shift.md | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/docs/feature_auto_shift.md b/docs/feature_auto_shift.md index a054c3652..54052a74d 100644 --- a/docs/feature_auto_shift.md +++ b/docs/feature_auto_shift.md | |||
@@ -1,23 +1,23 @@ | |||
1 | # Auto Shift: Why do we need a shift key? | 1 | # Auto Shift: Why do we need a shift key? |
2 | 2 | ||
3 | Tap a key and you get its character. Tap a key, but hold it *slightly* longer | 3 | Tap a key and you get its character. Tap a key, but hold it *slightly* longer |
4 | and you get its shifted state. Viola! No shift key needeed! | 4 | and you get its shifted state. Viola! No shift key needed! |
5 | 5 | ||
6 | ## Why Auto Shift? | 6 | ## Why Auto Shift? |
7 | 7 | ||
8 | Many people suffer from various forms of RSI. A common cause is stretching your | 8 | Many people suffer from various forms of RSI. A common cause is stretching your |
9 | fingers repeitively long distances. For us on the keyboard, the pinky does that | 9 | fingers repetitively long distances. For us on the keyboard, the pinky does that |
10 | all too often when reaching for the shift key. Auto Shift looks to aliviate that | 10 | all too often when reaching for the shift key. Auto Shift looks to alleviate that |
11 | problem. | 11 | problem. |
12 | 12 | ||
13 | ## How does it work? | 13 | ## How does it work? |
14 | 14 | ||
15 | When you tap a key, it stays depressed for a short period of time before it is | 15 | When you tap a key, it stays depressed for a short period of time before it is |
16 | then released. This depressed time is a different length everyone. Auto Shift | 16 | then released. This depressed time is a different length for everyone. Auto Shift |
17 | defines a constant `AUTO_SHIFT_TIMEOUT` which is typically set to twice your | 17 | defines a constant `AUTO_SHIFT_TIMEOUT` which is typically set to twice your |
18 | normal pressed state time. When you press a key, a timer starts and then stops | 18 | normal pressed state time. When you press a key, a timer starts and then stops |
19 | when you release the key. If the time depressed is greater than or equal to the | 19 | when you release the key. If the time depressed is greater than or equal to the |
20 | `AUTO_SHIFT_TIMEOUT` then a shifted version of the key is emitted. If the time | 20 | `AUTO_SHIFT_TIMEOUT`, then a shifted version of the key is emitted. If the time |
21 | is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted. | 21 | is less than the `AUTO_SHIFT_TIMEOUT` time, then the normal state is emitted. |
22 | 22 | ||
23 | ## Are there limitations to Auto Shift? | 23 | ## Are there limitations to Auto Shift? |
@@ -31,9 +31,9 @@ Yes, unfortunately. | |||
31 | 2. Auto Shift is disabled for any key press that is accompanied by one or more | 31 | 2. Auto Shift is disabled for any key press that is accompanied by one or more |
32 | modifiers. Thus, Ctrl+A that you hold for a really long time is not the same | 32 | modifiers. Thus, Ctrl+A that you hold for a really long time is not the same |
33 | as Ctrl+Shift+A. | 33 | as Ctrl+Shift+A. |
34 | 3. You will have characters that are shifted you did not intend on shifting, and | 34 | 3. You will have characters that are shifted when you did not intend on shifting, and |
35 | other characters you wanted shifted, but were not. This simply comes down to | 35 | other characters you wanted shifted, but were not. This simply comes down to |
36 | practice. As we get in a hurry, we think we might have hit the key long enough | 36 | practice. As we get in a hurry, we think we have hit the key long enough |
37 | for a shifted version, but we did not. On the other hand, we may think we are | 37 | for a shifted version, but we did not. On the other hand, we may think we are |
38 | tapping the keys, but really we have held it for a little longer than | 38 | tapping the keys, but really we have held it for a little longer than |
39 | anticipated. | 39 | anticipated. |
@@ -52,9 +52,9 @@ Then compile and install your new firmware with Auto Key enabled! That's it! | |||
52 | 52 | ||
53 | If desired, there is some configuration that can be done to change the | 53 | If desired, there is some configuration that can be done to change the |
54 | behavior of Auto Shift. This is done by setting various variables the | 54 | behavior of Auto Shift. This is done by setting various variables the |
55 | `config.h` file located in your keymap folder. | 55 | `config.h` file located in your keymap folder. If no `config.h` file exists, you can create one. |
56 | 56 | ||
57 | If no `config.h` file exists, you can create one. A sample is | 57 | A sample is |
58 | 58 | ||
59 | #ifndef CONFIG_USER_H | 59 | #ifndef CONFIG_USER_H |
60 | #define CONFIG_USER_H | 60 | #define CONFIG_USER_H |
@@ -69,10 +69,9 @@ If no `config.h` file exists, you can create one. A sample is | |||
69 | ### AUTO_SHIFT_TIMEOUT (value in ms) | 69 | ### AUTO_SHIFT_TIMEOUT (value in ms) |
70 | 70 | ||
71 | This controls how long you have to hold a key before you get the shifted state. | 71 | This controls how long you have to hold a key before you get the shifted state. |
72 | Obviously, this is different for everyone. For the common person a setting of | 72 | Obviously, this is different for everyone. For the common person, a setting of |
73 | 135 to 150 works great but one should start with a value of at least 175, which | 73 | 135 to 150 works great. However, one should start with a value of at least 175, which |
74 | is the default value. Then work down from there. The idea is to have as short | 74 | is the default value. Then work down from there. The idea is to have the shortest time required to get the shifted state without having false positives. |
75 | of a time required to get the shifted state without having false positives. | ||
76 | 75 | ||
77 | Play with this value until things are perfect. Many find that all will work well | 76 | Play with this value until things are perfect. Many find that all will work well |
78 | at a given value, but one or two keys will still emit the shifted state on | 77 | at a given value, but one or two keys will still emit the shifted state on |
@@ -137,7 +136,7 @@ completely normal and with no intention of shifted keys. | |||
137 | 136 | ||
138 | #### An example run | 137 | #### An example run |
139 | 138 | ||
140 | \'\'\' | 139 | ''' |
141 | hello world. my name is john doe. i am a computer programmer playing with | 140 | hello world. my name is john doe. i am a computer programmer playing with |
142 | keyboards right now. | 141 | keyboards right now. |
143 | 142 | ||
@@ -148,14 +147,14 @@ KEYboArDS RiGHT NOw. | |||
148 | 147 | ||
149 | [PRESS KC_ASUP a few times] | 148 | [PRESS KC_ASUP a few times] |
150 | 149 | ||
151 | hello world. my name is john Doe. i am a computer programmer play with | 150 | hello world. my name is john Doe. i am a computer programmer playing with |
152 | keyboarDs right now. | 151 | keyboarDs right now. |
153 | 152 | ||
154 | [PRESS KC_ASRP] | 153 | [PRESS KC_ASRP] |
155 | 154 | ||
156 | 115 | 155 | 115 |
157 | \'\'\' | 156 | ''' |
158 | 157 | ||
159 | The keyboard typed `115` which represents your current `AUTO_SHIFT_TIMEOUT` | 158 | The keyboard typed `115` which represents your current `AUTO_SHIFT_TIMEOUT` |
160 | value. You are now set! Practice on the *D* key a little bit that showed up | 159 | value. You are now set! Practice on the *D* key a little bit that showed up |
161 | in the testing and you'll be golden. | 160 | in the testing and you'll be golden. \ No newline at end of file |