You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/keymap.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,17 +95,17 @@ Note that ***higher layers have priority in the layer stack***. The firmware sta
95
95
96
96
97
97
### 0.3 Keymap Example
98
-
Keymap is **`keymaps[]`** C array in fact and you can define layers in it with **`KEYMAP()`** C macro and keycodes. To use complex actions you need to define `Fn` keycode in **`fn_actions[]`** array.
98
+
The keymap is defined in the **`keymaps[]`** array, a 2-dimensional array of rows and columns corresponding to positions in the keyboard matrix. But most often the layers are defined using C macros to allow for easier reading and editing of the keymap files. To use complex actions you need to define `Fn` keycodes in the **`fn_actions[]`** array.
99
99
100
-
This is a keymap example for [HHKB](http://en.wikipedia.org/wiki/Happy_Hacking_Keyboard) keyboard.
101
-
This example has three layers, 'Qwerty' as base layer, 'Cursor' and 'Mousekey'.
100
+
This is a keymap example for the [HHKB](http://en.wikipedia.org/wiki/Happy_Hacking_Keyboard) keyboard.
101
+
This example has three layers: the QWERTY base layer, and two overlay layers for cursor and mousekey control, respectively.
102
102
In this example,
103
103
104
-
`Fn0` is a **momentary layer switching** key, you can use keys on Cursor layer while holding the key.
104
+
`Fn0` is a **momentary layer switching** key--you can use keys on the Cursor layer while holding the key.
105
105
106
-
`Fn1` is a momentary layer switching key with tapping feature, you can get semicolon **';'** with taping the key and switch layers while holding the key. The word **'tap'** or **'tapping'** mean to press and release a key quickly.
106
+
`Fn1` is a momentary layer switching key with tapping function--tapping the key as one would normally use it, sends the semicolon **';'** keycode, while holding the key down switches layers.
107
107
108
-
`Fn2` is a **toggle layer switch** key, you can stay switched layer after releasing the key unlike momentary switching.
108
+
`Fn2` is a **toggle layer switch** key--pressing the key toggles the layer on until you press it again.
109
109
110
110
You can find other keymap definitions in file `keymap.c` located on project directories.
0 commit comments