Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand on the differences between Caps Word and Caps Lock #18139

Merged
merged 3 commits into from
Aug 30, 2022
Merged

Expand on the differences between Caps Word and Caps Lock #18139

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c1edcd
Expand on the differences between Caps Word and Caps Lock
precondition Aug 22, 2022
f000c17
Add the equiv default KC_ next to intl alias
precondition Aug 22, 2022
7bfb8f1
It's configurable so it's not a problem
precondition Aug 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions docs/feature_caps_word.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,24 @@ a modern alternative to Caps Lock:

* Letters are capitalized while active, and Caps Word automatically disables
itself at the end of the word. That is, it stops by default once a space or
any key other than `a`--`z`, `0`--`9`, `-`, `_`, delete, or backspace is
pressed. Caps Word also disables itself if the keyboard is idle for 5 seconds.
This is configurable, see below.
any key other than `KC_A`--`KC_Z`, `KC_0`--`KC_9`, `KC_MINS`, `KC_UNDS`,
`KC_DELETE`, or `KC_BACKSPACE` is pressed. Caps Word also disables itself if
the keyboard is idle for 5 seconds. This is configurable, see below.

* To avoid requiring a dedicated key for Caps Word, there is an option
(`BOTH_SHIFTS_TURNS_ON_CAPS_WORD`) to activate Caps Word by simultaneously
pressing both shift keys. See below for other options.

* The implementation does not use the Caps Lock (`KC_CAPS`) keycode. Caps Word
works even if you're remapping Caps Lock at the OS level to Ctrl or something
else, as Emacs and Vim users often do.
else, as Emacs and Vim users often do. As a consequence, Caps Word does not
follow the typical Caps Lock behaviour and may thus act in potentially
unexpected ways, especially when using an *OS* keyboard layout other than US
or UK. For example, Dvorak's <kbd>, <</kbd> key (`DV_COMM` aka `KC_W`) will get shifted
because Caps Word interprets that keycode as the letter 'W' by default, the
Spanish <kbd>Ñ</kbd> key (`ES_NTIL` aka `KC_SCLN`) will not get capitalized because Caps
Word interprets it as the semicolon ';' punctuation character, and the US
hyphen key (`KC_MINS`), while unaffected by Caps Lock, is shifted by Caps Word.


## How do I enable Caps Word :id=how-do-i-enable-caps-word
Expand Down Expand Up @@ -60,7 +67,7 @@ time, since both use the Left Shift + Right Shift key combination."**

Many keyboards enable the [Command feature](feature_command.md), which by
default is also activated using the Left Shift + Right Shift key combination. To
fix this conflict, please disable Command by adding in rules.mk:
fix this conflict, please disable Command by adding in rules.mk:

```make
COMMAND_ENABLE = no
Expand All @@ -81,7 +88,7 @@ by defining `IS_COMMAND()` in config.h:

Caps Word turns off automatically if no keys are pressed for
`CAPS_WORD_IDLE_TIMEOUT` milliseconds. The default is 5000 (5 seconds).
Configure the timeout duration in config.h, for instance
Configure the timeout duration in config.h, for instance

```c
#define CAPS_WORD_IDLE_TIMEOUT 3000 // 3 seconds.
Expand Down