diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/macros.md | 8 | ||||
| -rw-r--r-- | docs/mouse_keys.md | 4 |
2 files changed, 10 insertions, 2 deletions
diff --git a/docs/macros.md b/docs/macros.md index 3d5b05b4ac..6b128541b8 100644 --- a/docs/macros.md +++ b/docs/macros.md @@ -43,7 +43,7 @@ A macro can include the following commands: ## Sending strings -Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string for you instead of having to build a `MACRO()`. Right now it assumes a US keymap with a QWERTY layout, so if you are using something else it may not behave as you expect. +Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string for you instead of having to build a `MACRO()`. For example: @@ -60,6 +60,12 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { }; ``` +By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap: + +``` +#include <sendstring_colemak.h> +``` + ## Mapping a Macro to a key Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard: diff --git a/docs/mouse_keys.md b/docs/mouse_keys.md index e6dfe7bd9e..560bd04705 100644 --- a/docs/mouse_keys.md +++ b/docs/mouse_keys.md @@ -1,5 +1,6 @@ # Mousekeys + Mousekeys is a feature that allows you to emulate a mouse using your keyboard. You can move the pointer around, click up to 5 buttons, and even scroll in all 4 directions. QMK uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys). ## Adding Mousekeys To a Keymap @@ -54,6 +55,7 @@ The default speed for controlling the mouse with the keyboard is intentionaly sl #define MOUSEKEY_WHEEL_TIME_TO_MAX 40 ``` + ### `MOUSEKEY_DELAY` When one of the mouse movement buttons is pressed this setting is used to define the delay between that button press and the mouse cursor moving. Some people find that small movements are impossible if this setting is too low, while settings that are too high feel sluggish. @@ -76,4 +78,4 @@ The top speed for scrolling movements. ### `MOUSEKEY_WHEEL_TIME_TO_MAX` -How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickling your scrolling will accelerate. +How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickling your scrolling will accelerate.
\ No newline at end of file |