diff options
author | Zach Burchill <burchill@users.noreply.github.com> | 2017-11-09 16:18:31 -0500 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2017-11-09 16:18:31 -0500 |
commit | e236f1eba19f357e524300959e0127bfe2813de1 (patch) | |
tree | 53436d4b02cdd877c167e440ada5c52994981ccc /docs | |
parent | 847ade44fc648f124801dfffc9dcd69442db6a91 (diff) | |
download | qmk_firmware-e236f1eba19f357e524300959e0127bfe2813de1.tar.gz qmk_firmware-e236f1eba19f357e524300959e0127bfe2813de1.zip |
Fixed some grammar and typos on the docs (#1989)
* fixed grammar and references
* fixed typo
Diffstat (limited to 'docs')
-rw-r--r-- | docs/keymap.md | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/keymap.md b/docs/keymap.md index 2961e0e8d..62130d700 100644 --- a/docs/keymap.md +++ b/docs/keymap.md | |||
@@ -28,14 +28,12 @@ Respective layers can be validated simultaneously. Layers are indexed with 0 to | |||
28 | Sometimes, the action code stored in keymap may be referred as keycode in some documents due to the TMK history. | 28 | Sometimes, the action code stored in keymap may be referred as keycode in some documents due to the TMK history. |
29 | 29 | ||
30 | ### Keymap layer status | 30 | ### Keymap layer status |
31 | Keymap layer has its state in two 32 bit parameters: | 31 | The state of the Keymap layer is determined by two 32 bit parameters: |
32 | 32 | ||
33 | * **`default_layer_state`** indicates a base keymap layer(0-31) which is always valid and to be referred. | 33 | * **`default_layer_state`** indicates a base keymap layer (0-31) which is always valid and to be referred (the default layer). |
34 | * **`layer_state`** () has current on/off status of the layer on its each bit. | 34 | * **`layer_state`** has current on/off status of each layer in its bits. |
35 | 35 | ||
36 | Keymap has its state in two parameter **`default_layer`** indicates a base keymap layer(0-31) which is always valid and to be referred, **`keymap_stat`** is 16bit variable which has current on/off status of layers on its each bit. | 36 | Keymap layer '0' is usually `default_layer`, wither other layers initially off after booting up the firmware, although this can configured differently in `config.h`. It is useful to change `default_layer` when you completely switch a key layout, for example, if you want to switch to Colemak instead of Qwerty. |
37 | Keymap layer '0' is usually `default_layer` and which is the only valid layer and other layers is initially off after boot up firmware, though, you can configured them in `config.h`. | ||
38 | To change `default_layer` will be useful when you switch key layout completely, say you want Colemak instead of Qwerty. | ||
39 | 37 | ||
40 | Initial state of Keymap Change base layout | 38 | Initial state of Keymap Change base layout |
41 | ----------------------- ------------------ | 39 | ----------------------- ------------------ |
@@ -52,7 +50,7 @@ To change `default_layer` will be useful when you switch key layout completely, | |||
52 | `--- default_layer = 0 `--- default_layer = 1 | 50 | `--- default_layer = 0 `--- default_layer = 1 |
53 | layer_state = 0x00000001 layer_state = 0x00000002 | 51 | layer_state = 0x00000001 layer_state = 0x00000002 |
54 | 52 | ||
55 | On the other hand, you shall change `layer_state` to overlay base layer with some layers for feature such as navigation keys, function key(F1-F12), media keys or special actions. | 53 | On the other hand, you can change `layer_state` to overlay the base layer with other layers for features such as navigation keys, function keys (F1-F12), media keys, and/or special actions. |
56 | 54 | ||
57 | Overlay feature layer | 55 | Overlay feature layer |
58 | --------------------- bit|status | 56 | --------------------- bit|status |