diff options
| author | lokher <lokher@gmail.com> | 2022-12-06 17:04:10 +0800 |
|---|---|---|
| committer | lokher <lokher@gmail.com> | 2022-12-06 17:04:10 +0800 |
| commit | 27fc28fd2ff52e079a5bc58d6aaea4c752420615 (patch) | |
| tree | 7ac943fb1ba4f430a7220efd18f66f6a77205c30 /docs/feature_caps_word.md | |
| parent | e736133392fe6427cfb995da0787337189828272 (diff) | |
| parent | 2709b6ed616f8012ff4cfd3ee69a822a8d188351 (diff) | |
Merge upstream master
Diffstat (limited to 'docs/feature_caps_word.md')
| -rw-r--r-- | docs/feature_caps_word.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/feature_caps_word.md b/docs/feature_caps_word.md index 283f0f5288..c58d1a56e2 100644 --- a/docs/feature_caps_word.md +++ b/docs/feature_caps_word.md @@ -4,7 +4,10 @@ It is often useful to type a single word in all capitals, for instance abbreviations like "QMK", or in code, identifiers like `KC_SPC`. "Caps Word" is a modern alternative to Caps Lock: -* Letters are capitalized while active, and Caps Word automatically disables +* While active, letters are capitalized and `-` becomes `_`. The `_` makes it easier + to type constant names (eg 'PROGRAM\_CONSTANTS'). + +* 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 `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 @@ -39,8 +42,8 @@ CAPS_WORD_ENABLE = yes Next, use one the following methods to activate Caps Word: -* **Activate by pressing a key**: Use the `CAPS_WORD` keycode (short - alias `CAPSWRD`) in your keymap. +* **Activate by pressing a key**: Use the `QK_CAPS_WORD_TOGGLE` keycode (short + alias `CW_TOGG`) in your keymap. * **Activate by pressing Left Shift + Right Shift**: Add `#define BOTH_SHIFTS_TURNS_ON_CAPS_WORD` to config.h. You may also need to disable or |