From 7b0356d1d49da6574570e110f61f95692afdb3d0 Mon Sep 17 00:00:00 2001 From: fauxpark Date: Sat, 9 Dec 2017 16:36:32 +1100 Subject: Convert all headings to Title Case --- docs/keymap.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/keymap.md') diff --git a/docs/keymap.md b/docs/keymap.md index 092ea8678..96d4563c0 100644 --- a/docs/keymap.md +++ b/docs/keymap.md @@ -3,7 +3,7 @@ QMK keymaps are defined inside a C source file. The data structure is an array of arrays. The outer array is a list of layer arrays while the inner layer array is a list of keys. Most keyboards define a `KEYMAP()` macro to help you create this array of arrays. -## Keymap and layers +## Keymap and Layers In QMK, **`const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]`** holds multiple **layers** of keymap information in **16 bit** data holding the **action code**. You can define **32 layers** at most. For trivial key definitions, the higher 8 bits of the **action code** are all 0 and the lower 8 bits holds the USB HID usage code generated by the key as **keycode**. @@ -27,7 +27,7 @@ Respective layers can be validated simultaneously. Layers are indexed with 0 to Sometimes, the action code stored in keymap may be referred as keycode in some documents due to the TMK history. -### Keymap layer status +### Keymap Layer Status The state of the Keymap layer is determined by two 32 bit parameters: * **`default_layer_state`** indicates a base keymap layer (0-31) which is always valid and to be referred (the default layer). @@ -75,7 +75,7 @@ Note that ***higher layer has higher priority on stack of layers***, namely firm You can place `KC_TRANS` on overlay layer changes just part of layout to fall back on lower or base layer. Key with `KC_TRANS` (`KC_TRNS` and `_______` are the alias) doesn't has its own keycode and refers to lower valid layers for keycode, instead. -## Anatomy Of A `keymap.c` +## Anatomy of a `keymap.c` For this example we will walk through an [older version of the default Clueboard 66% keymap](https://github.com/qmk/qmk_firmware/blob/ca01d94005f67ec4fa9528353481faa622d949ae/keyboards/clueboard/keymaps/default/keymap.c). You'll find it helpful to open that file in another browser window so you can look at everything in context. -- cgit v1.2.3-24-g4f1b