2ccad46e26
* update modtap to holdtap
* Update links
* Revert "Update links"
This reverts commit 8d0cda7c5a.
* updated docs links
update links in docs
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* rename modtap.md to holdtap.md
* Update Getting_Started.md
* Update main.py
* Update modtap.py
* Update modtap.py and add notice
* Update docs/en/porting_to_kmk.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/handwiring.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/contributing.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/contributing.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/ble_hid.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/Getting_Started.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Update docs/en/kmkpython_vs_circuitpython.md
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
* Rename modtap.md to holdtap.md
* fixup
---------
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
27 lines
1.0 KiB
Markdown
27 lines
1.0 KiB
Markdown
# CapsWord
|
|
The CapsWord module functions similar to caps lock but will deactivate automatically when its encounters a key that breaks the word or after inactivity timeout.
|
|
By default it will not deactivate CapsWord on numbers, alphabets, underscore, modifiers, minus, backspace and other keys like HoldTap, Layers, etc.
|
|
Add it to your keyboard's modules list with:
|
|
|
|
```python
|
|
from kmk.modules.capsword import CapsWord
|
|
# default inactivity timeout is 8s
|
|
caps_word=CapsWord()
|
|
# change inactivity timeout
|
|
# caps_word=CapsWord(timeout=5000)
|
|
# for no inactivity timeout
|
|
# caps_word=CapsWord(timeout=0)
|
|
# add additional ignored keys
|
|
# caps_word.keys_ignored.append(KC.COMMA)
|
|
keyboard.modules.append(caps_word)
|
|
keyboard.keymap = [
|
|
[
|
|
KC.CW,
|
|
],
|
|
]
|
|
```
|
|
## Keycodes
|
|
|
|
|Key |Aliases |Description |
|
|
|-----------------------|--------------------|-----------------------------------------------|
|
|
|`KC.CW` |`KC.CAPSWORD` |Enables/disables CapsWord | |