doc/keymap.md

   1 Keymap framework - how to define your keymap
   2 ============================================
   3 ***NOTE: This is not final version, may be inconsistent with source code and changed occasionally for a while.***
   4
   5 ## 0. Keymap and layers
   6 **Keymap** is comprised of multiple layers of key layout, you can define **16** layers at most.
   7 **Layer** is an array of **keycodes** to define **actions** on each physical keys.
   8 respective layers can be validated simultaneously. Layers are indexed with 0 to 15 and higher layer has precedence.
   9
  10     Keymap with 16 Layers               Layer: array of Keycodes
  11     ---------------------               ------------------------
  12           stack of layers               content of layer
  13            ____________ precedence               _______________________
  14           /           / | high                  / ESC / F1  / F2  / F3   ....
  15       15 /___________// |                      /-----/-----/-----/-----
  16       14 /___________// |                     / TAB /     /     /      ....
  17       13 /___________/_ |                    /-----/-----/-----/-----
  18        :  / : : : : : / |                   /LCtrl/     /     /      ....
  19        3 /___________// |               :  /  :     :     :     :
  20        2 /___________// |               2 `--------------------------
  21        1 /___________// |               1 `--------------------------
  22        0 /___________/  V low           0 `--------------------------
  23
  24
  25 ### 0.1 Keymap status
  26 Keymap has its state in two parameters:
  27 **`default_layer`** indicates a base keymap layer(0-15) 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.
  28
  29 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`.
  30 To change `default_layer` will be useful when you want to switch key layout completely, say you use Colmak instead of Qwerty.
  31
  32     Initial state of Keymap         Change base layout
  33     -----------------------         ------------------
  34
  35       15                              15
  36       14                              14
  37       13                              13
  38        :                               :
  39        3                               3   ____________
  40        2   ____________                2  /           /
  41        1  /           /             ,->1 /___________/
  42     ,->0 /___________/              |  0
  43     |                               |
  44     `--- default_layer = 0          `--- default_layer = 1
  45          keymap_stat   = 0x0001          keymap_stat   = 0x0002
  46
  47
  48 On the other hand, you shall change `keymap_state` to overlay base layer with some layers for feature such as navigation keys, function key(F1-F12), media keys or special actions.
  49
  50     Overlay feature layer
  51     ---------------------      bit|status
  52            ____________        ---+------
  53       15  /           /        15 |   0
  54       14 /___________// -----> 14 |   1
  55       13 /___________/  -----> 13 |   1
  56        :                        : |
  57        3   ____________         3 |   0
  58        2  /           /         2 |   0
  59     ,->1 /___________/  ----->  1 |   1
  60     |  0                        0 |   0
  61     |                                 |
  62     `--- default_layer = 1            |
  63          keymap_stat   = 0x6002 <-----'
  64
  65
  66 ### 0.2 Layer Precedence and Transparency
  67 Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred.
  68
  69 You can place `KC_TRNS` on overlay layer changes just part of layout to fall back on lower or base layer.
  70 Key with `KC_TRANS` doen't has its own keycode and refers to lower valid layers for keycode, instead.
  71 See example below.
  72
  73
  74 ### 0.3 Keymap Example
  75 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.
  76
  77 This is a keymap example for [HHKB](http://en.wikipedia.org/wiki/Happy_Hacking_Keyboard) keyboard.
  78 This example has three layers, 'Qwerty' as base layer, 'Cursor' and  'Mousekey'.
  79 In this example,
  80
  81  `Fn0` is a **momentary layer switching** key, you can use keys on Cursor layer while holding the key.
  82
  83  `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.
  84
  85  `Fn2` is a **toggle layer switch** key, you can stay switched layer after releasing the key unlike momentary switching.
  86
  87 You can find other keymap definitions in file `keymap.c` located on project directories.
  88
  89     static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  90         /* 0: Qwerty
  91          * ,-----------------------------------------------------------.
  92          * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  93          * |-----------------------------------------------------------|
  94          * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  95          * |-----------------------------------------------------------|
  96          * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn1|  '|Enter   |
  97          * |-----------------------------------------------------------|
  98          * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn0|
  99          * `-----------------------------------------------------------'
 100          *       |Gui|Alt  |Space                  |Alt  |Fn2|
 101          *       `-------------------------------------------'
 102          */
 103         KEYMAP(ESC, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSLS,GRV, \
 104                TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSPC, \
 105                LCTL,A,   S,   D,   F,   G,   H,   J,   K,   L,   FN1, QUOT,ENT, \
 106                LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, SLSH,RSFT,FN0, \
 107                     LGUI,LALT,          SPC,                RALT,FN2),
 108         /* 1: Cursor(HHKB mode)
 109          * ,-----------------------------------------------------------.
 110          * |Pwr| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 111          * |-----------------------------------------------------------|
 112          * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
 113          * |-----------------------------------------------------------|
 114          * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
 115          * |-----------------------------------------------------------|
 116          * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |   |
 117          * `-----------------------------------------------------------'
 118          *      |Gui |Alt  |Space                  |Alt  |Gui|
 119          *      `--------------------------------------------'
 120          */
 121         KEYMAP(PWR, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 122                CAPS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,PSCR,SLCK,PAUS,UP,  TRNS,BSPC, \
 123                LCTL,VOLD,VOLU,MUTE,TRNS,TRNS,PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
 124                LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,PPLS,PMNS,END, PGDN,DOWN,RSFT,TRNS, \
 125                     LGUI,LALT,          SPC,                RALT,RGUI),
 126         /* 2: Mousekey
 127          * ,-----------------------------------------------------------.
 128          * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 129          * |-----------------------------------------------------------|
 130          * |Tab  |   |   |   |   |   |MwL|MwD|MwU|MwR|   |   |   |Backs|
 131          * |-----------------------------------------------------------|
 132          * |Contro|   |   |   |   |   |McL|McD|McU|McR|   |   |Return  |
 133          * |-----------------------------------------------------------|
 134          * |Shift   |   |   |   |   |Mb3|Mb2|Mb1|Mb4|Mb5|   |Shift |   |
 135          * `-----------------------------------------------------------'
 136          *      |Gui |Alt  |Mb1                    |Alt  |   |
 137          *      `--------------------------------------------'
 138          * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 139          */
 140         KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 141                TAB, TRNS,TRNS,TRNS,TRNS,TRNS,WH_L,WH_D,WH_U,WH_R,TRNS,TRNS,TRNS,BSPC, \
 142                LCTL,TRNS,ACL0,ACL1,ACL2,TRNS,MS_L,MS_D,MS_U,MS_R,TRNS,QUOT,ENT, \
 143                LSFT,TRNS,TRNS,TRNS,TRNS,BTN3,BTN2,BTN1,BTN4,BTN5,SLSH,RSFT,TRNS, \
 144                     LGUI,LALT,          BTN1,               RALT,TRNS),
 145     };
 146
 147     static const uint16_t PROGMEM fn_actions[] = {
 148         ACTION_KEYMAP_MOMENTARY(1),                  // FN0
 149         ACTION_KEYMAP_TAP_KEY(2, KC_SCLN),           // FN1
 150         ACTION_KEYMAP_TOGGLE(2),                     // FN2
 151     };
 152
 153
 154
 155
 156 ## 1. Keycode
 157 See [`common/keycode.h`](../common/keycode.h) or keycode table below for the detail. Keycode is internal **8bit code** to inidicate action performed on key in keymap. Keycode has `KC_` prefixed symbol respectively. Most of keycodes like `KC_A` have simple action registers key to host on press and unregister on release, while some of other keycodes has some special actions like `Fn` keys, Media contorl keys, System control keys and Mousekeys.
 158
 159  ***In `KEYMAP()` macro you should omit prefix part `KC_` of keycode to keep keymap compact.*** For example, just use `A` instead you place `KC_A` in `KEYMAP()`. Some keycodes has 4-letter **short name** in addition to descriptive name, you'll prefer short one in `KEYMAP()`.
 160
 161 ### 1.0 Other key
 162 - `KC_NO` for no aciton
 163 - `KC_TRNS` for layer transparency (See above)
 164
 165 ### 1.1 Normal key
 166 - `KC_A` to `KC_Z`, `KC_1` to `KC_0` for alpha numeric key
 167 - `KC_MINS`, `KC_EQL`, `KC_GRV`, `KC_RBRC`, `KC_LBRC`, `KC_COMM`, `KC_DOT`, `KC_BSLS`, `KC_SLSH`, `KC_SCLN`, `KC_QUOT`
 168 - `KC_ESC`, `KC_TAB`, `KC_SPC`, `KC_BSPC`, `KC_ENT`, `KC_DEL`, `KC_INS`
 169 - `KC_UP`, `KC_DOWN`, `KC_RGHT`, `KC_LEFT`, `KC_PGUP`, `KC_PGDN`, `KC_HOME`, `KC_END`
 170 - `KC_CAPS`, `KC_NLCK`, `KC_SLCK`, `KC_PSCR`, `KC_PAUS`, `KC_APP`, `KC_F1` to `KC_F24`
 171 - `KC_P1` to `KC_P0`, `KC_PDOT`, `KC_PCMM`, `KC_PSLS`, `KC_PAST`, `KC_PMNS`, `KC_PPLS`, `KC_PEQL`, `KC_PENT` for keypad.
 172
 173 ### 1.2 Modifier
 174 There are 8 modifiers which has discrimination between left and right.
 175
 176 - `KC_LCTL` and `KC_RCTL` for Control
 177 - `KC_LSFT` and `KC_RSFT` for Shift
 178 - `KC_LALT` and `KC_RALT` for Alt
 179 - `KC_LGUI` and `KC_RGUI` for Windows key or Command key in Mac
 180
 181 ### 1.3 Mousekey
 182 - `KC_MS_U`, `KC_MS_D`, `KC_MS_L`, `KC_MS_R` for mouse cursor
 183 - `KC_WH_U`, `KC_WH_D`, `KC_WH_L`, `KC_WH_R` for mouse wheel
 184 - `KC_BTN1`, `KC_BTN2`, `KC_BTN3`, `KC_BTN4`, `KC_BTN5` for mouse buttons
 185
 186 ### 1.4 System & Media key
 187 - `KC_PWR`, `KC_SLEP`, `KC_WAKE` for Power, Sleep, Wake
 188 - `KC_MUTE`, `KC_VOLU`, `KC_VOLD` for audio volume control
 189 - `KC_MNXT`, `KC_MPRV`, `KC_MSTP`, `KC_MPLY`, `KC_MSEL` for media control
 190 - `KC_MAIL`, `KC_CALC`, `KC_MYCM` for application launch
 191 - `KC_WSCH`, `KC_WHOM`, `KC_WBAK`, `KC_WFWD`, `KC_WSTP`, `KC_WREF`, `KC_WFAV` for web browser operation
 192
 193 ### 1.5 Fn key
 194 `KC_FNnn` are keycodes for `Fn` key which not given any actions at the beginning unlike most of keycodes has its own inborn action. To use these keycodes in `KEYMAP` you need to assign action you want at first. Action of `Fn` key is defined in `fn_actions[]` and its index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` keyocde indicates the action defined in first element of the array. ***32 `Fn` keys can be defined at most.***
 195
 196 ### 1.6 Keycode Table
 197  See keycode table in [`doc/keycode.txt`](./keycode.txt) for description of keycodes.
 198
 199  In regard to implementation side most of keycodes are identical with [HID usage][HID_usage](pdf) sent to host for real and some virtual keycodes are defined to support special actions.
 200 [HID_usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf
 201
 202
 203
 204 ## 2. Action
 205 See [`common/action.h`](../common/action.h). Action is a **16bit code** and defines function to perform on events of a key like press, release, holding and tapping.
 206
 207 Most of keys just register 8bit scancode to host, but to support other complex features needs 16bit extended action codes internally. However, using 16bit action codes in keymap results in double size in memory against using jsut keycodes. To avoid this waste 8bit keycodes are used in `KEYMAP` instead of action codes.
 208
 209 ***You can just use keycodes of `Normal key`, `Modifier`, `Mousekey` and `System & Media key` in keymap*** to indicate corresponding actions instead of using action codes. While ***to use other special actions you should use keycode of `Fn` key defined in `fn_actions[]`.***
 210
 211 Usually action codes are needed only when you want to use layer switching, or
 212
 213 ### 2.1 Key action
 214 This is a simple action that registers scancodes(HID usage in fact) to host on press event of key and unregister on release.
 215
 216 #### 2.1.1 Normal key and Modifier
 217 This action usually won't be used expressly because you can use keycodes in `KEYMAP()` instead.
 218 You can define `Key` action on *'A'* key and *'left shift'* modifier with:
 219
 220     ACTION_KEY(KC_A)
 221     ACTION_KEY(KC_LSHIFT)
 222
 223 #### 2.1.2 Key with modifiers
 224 This action is comprised of strokes of modifiers and a key. `Macro` action is needed if you want more complex key strokes.
 225 Say you want to assign a key to `Shift + 1` to get charactor *'!'* or `Alt + Tab` to switch application windows.
 226
 227     ACTION_LMOD_KEY(KC_LSHIFT, KC_1)
 228     ACTION_LMOD_KEY(KC_LALT, KC_TAB)
 229
 230 Or `Alt,Shift + Tab` can be defined. `ACTION_LMODS_KEY()` requires **4-bit modifier state** and a **keycode** as arguments. See `keycode.h` for `MOD_BIT()` macro.
 231
 232     ACTION_LMODS_KEY((MOD_BIT(KC_LALT) | MOD_BIT(KC_LSHIFT)), KC_TAB)
 233
 234
 235
 236 ### 2.2 Layer Action
 237 These actions operate layers of keymap.
 238
 239 Parameters:
 240 - layer: 0-15
 241 - on: { press | release | both }
 242
 243
 244 #### 2.2.0 Default Layer
 245 `default_layer` is layer which always is valid and referred to when actions is not defined on other layers.
 246
 247 ##### Return to Default Layer
 248 Turns on only `default layer` with clearing other all layers.
 249
 250     ACTION_DEFAULT_LAYER
 251
 252 ##### Set Default Layer
 253 Sets 'default layer' to layer and turn it on.
 254
 255     ACTION_DEFAULT_LAYER_SET_TO(layer)
 256     ACTION_DEFAULT_LAYER_SET(layer, on)
 257
 258
 259 #### 2.2.1 Keymap
 260 These actions operate layer status of keymap.
 261
 262 ##### Momentary Switch
 263 Turns on layer momentary while holding, in other words turn on when key is pressed and off when released.
 264
 265     ACTION_KEYMAP_MOMENTARY(layer)
 266
 267
 268 ##### Toggle Switch
 269 Turns on layer on first type and turns off on next.
 270
 271     ACTION_KEYMAP_TOGGLE(layer)
 272
 273
 274 ##### Momentary Switch with tap key
 275 Turns on layer momentary while holding but registers key on tap.
 276
 277     ACTION_KEYMAP_TAP_KEY(layer, key)
 278
 279
 280 ##### Momentary Switch with tap toggle
 281 Turns on layer momentary while holding but toggles it with serial taps.
 282
 283     ACTION_KEYMAP_TAP_TOGGLE(layer)
 284
 285
 286 ##### Invert layer
 287 Inverts current layer state. If the layer is on it becomes off with this action.
 288
 289     ACTION_KEYMAP_INV(layer, on)
 290
 291
 292 ##### Turn On layer
 293 Turns on layer state.
 294
 295     ACTION_KEYMAP_ON(layer, on)
 296
 297 Turns on layer state on press and turn off on release. This is identical to **'Switch to layer'** action.
 298
 299     ACTION_KEYMAP_ON_OFF(layer)
 300
 301
 302 ##### Turn Off layer
 303 Turns off layer state.
 304
 305     ACTION_KEYMAP_OFF(layer, on)
 306
 307
 308 ##### Set layer
 309 Turn on layer only.
 310 `keymap_stat = (1<<layer) [layer: 0-15]`
 311
 312     ACTION_KEYMAP_SET(layer, on)
 313
 314 Turns on layer only and clear all layer on release..
 315
 316     ACTION_KEYMAP_SET_CLEAR(layer)
 317
 318
 319 #### 2.2.2 Overlay
 320 ***TBD***
 321
 322 In addition to actions of `Keymap` above these actions are also available.
 323
 324 ##### Invert 4bit layer states
 325 Invert 4bits out of 16bits of overlay status on both press and release.
 326 `overlay_stat = (overlay_stat ^ bits<<(shift*4)) [bits: 0-15, shift: 0-3]`
 327
 328     ACTION_OVERLAY_INV4(bits, shift)
 329
 330
 331
 332 ### 2.3 Macro action
 333 ***TBD***
 334
 335 `Macro` action indicates complex key strokes.
 336
 337     MACRO( MD(LSHIFT), D(D), END )
 338     MACRO( U(D), MU(LSHIFT), END )
 339     MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END )
 340
 341 #### 2.3.1 Normal mode
 342 - **I()**   change interavl of stroke.
 343 - **D()**   press key
 344 - **U()**   release key
 345 - **T()**   type key(press and release)
 346 - **W()**   wait
 347 - **MD()**  modifier down
 348 - **MU()**  modifier up
 349 - **END**   end mark
 350
 351 #### 2.3.2 Extended mode
 352
 353 ***TODO: sample impl***
 354 See `keyboard/hhkb/keymap.c` for sample.
 355
 356
 357 ### 2.4 Function action
 358 ***TBD***
 359
 360 There are two type of action, normal `Function` and tappable `Function`.
 361 These actions call user defined function with `id`, `opt`, and key event information as arguments.
 362
 363 #### 2.4.1 Function
 364 To define normal `Function` action in keymap use this.
 365
 366     ACTION_FUNCTION(id, opt)
 367
 368 #### 2.4.2 Function with tap
 369 To define tappable `Function` action in keymap use this.
 370
 371     ACTION_FUNCTION_TAP(id, opt)
 372
 373 #### 2.4.3 Implement user function
 374 `Function` actions can be defined freely with C by user in callback function:
 375
 376     void keymap_call_function(keyrecord_t *event, uint8_t id, uint8_t opt)
 377
 378 This C function is called every time key is operated, argument `id` selects action to be performed and `opt` can be used for option. Functon `id` can be 0-255 and `opt` can be 0-15.
 379
 380  `keyrecord_t` is comprised of key event and tap count. `keyevent_t` indicates which and when key is pressed or released. From `tap_count` you can know tap state, 0 means no tap. These information will be used in user function to decide how action of key is performed.
 381
 382     typedef struct {
 383         keyevent_t  event;
 384         uint8_t     tap_count;
 385     } keyrecord_t;
 386
 387     typedef struct {
 388         key_t    key;
 389         bool     pressed;
 390         uint16_t time;
 391     } keyevent_t;
 392
 393     typedef struct {
 394         uint8_t col;
 395         uint8_t row;
 396     } key_t;
 397
 398 ***TODO: sample impl***
 399 See `keyboard/hhkb/keymap.c` for sample.
 400
 401
 402
 403
 404
 405 ## 4. Layer switching Example
 406 There are some ways to switch layer with 'Layer' actions.
 407
 408 ### 4.1 Momentary switching
 409 Momentary switching changes layer only while holding Fn key.
 410
 411 This action makes 'Layer 1' active(valid) on key press event and inactive on release event. Namely you can overlay a layer on base layer temporarily with this.
 412
 413     ACTION_KEYMAP_MOMENTARY(1)
 414
 415
 416 After switch actions of destination layer are perfomed.
 417 ***Thus you shall need to place action to come back on destination layer***, or you will be stuck in destination layer without way to get back. Usually you need to palce same action or 'KC_TRNS` on destination layer to get back.
 418
 419
 420 ### 4.2 Toggle switching
 421 Toggle switching changes layer after press then release. With this you can keep staying on the layer until you press the key again to return.
 422
 423 This is toggle action of 'Layer 2'.
 424
 425     ACTION_KEYMAP_TOGGLE(2)
 426
 427
 428
 429 ### 4.3 Momentary switching with Tap key
 430 These actions switch layer only while holding `Fn` key and register key on tap. **Tap** means to press and release key quickly.
 431
 432     ACTION_KEYMAP_TAP_KEY(2, KC_SCLN)
 433
 434 With this you can place layer switching function on normal key like ';' without losing its original key register function.
 435
 436
 437
 438 ### 4.4 Momentary switching with Tap Toggle
 439 This switches layer only while holding `Fn` key and toggle layer after several taps. **Tap** means to press and release key quickly.
 440
 441     ACTION_KEYMAP_TAP_TOGGLE(1)
 442
 443 Number of taps can be defined with `TAPPING_TOGGLE` in `config.h`, `5` by default.
 444
 445
 446
 447 ## Tapping
 448 Tapping is to press and release key quickly. Tapping speed is determined with setting of `TAPPING_TERM`, which can be defined in `config.h`, 200ms by default.
 449
 450 ### Tap Key
 451 This is feature to assign normal key action and modifier including `Fn` to just one physical key. This is a kind of [Dual role modifier][dual_role]. It works as modifier or `Fn` when holding a key but registers normal key when tapping.
 452
 453 Action for modifier with tap key.
 454
 455     ACTION_LMODS_TAP_KEY(mods, key)
 456
 457 Action for `Fn` with tap key.
 458
 459     ACTION_KEYMAP_TAP_KEY(layer, key)
 460
 461 [dual_role]: http://en.wikipedia.org/wiki/Modifier_key#Dual-role_modifier_keys
 462
 463
 464 ### Tap Toggle
 465 This is feature to assign both toggle layer and momentary switch layer action to just one physical key. It works as mementary switch when holding a key but toggle switch when tapping.
 466
 467     ACTION_KEYMAP_TAP_TOGGLE(layer)
 468
 469
 470 ### One Shot Modifier
 471 This adds oneshot feature to modifier key. 'One Shot Modifier' is one time modifier which has effect only on following one alpha key.
 472 It works as normal modifier key when holding but oneshot modifier when tapping.
 473
 474     ACTION_LMODS_ONESHOT(mods)
 475
 476 Say you want to type 'The', you have to push and hold Shift before type 't' then release Shift before type 'h' and 'e' or you'll get 'THe'. With One Shot Modifier you can tap Shift then type 't', 'h' and 'e' normally, you don't need to holding Shift key properly  here.
 477
 478
 479
 480
 481 ## Legacy Keymap
 482 This was used in prior version and still works due to legacy support code in `common/keymap.c`. Legacy keymap doesn't support many of features that new keymap offers.
 483
 484 In comparison with new keymap how to define Fn key is different. It uses two arrays `fn_layer[]` and `fn_keycode[]`. The index of arrays corresponds with postfix number of `Fn` key. Array `fn_layer[]` indicates destination layer to switch and `fn_keycode[]` has keycodes to send when tapping `Fn` key.
 485
 486 In following setting example, `Fn0`, `Fn1` and `Fn2` switch layer to 1, 2 and 2 respectively. `Fn2` registers `Space` key when tap while `Fn0` and `Fn1` doesn't send any key.
 487
 488     static const uint8_t PROGMEM fn_layer[] = {
 489         1,              // Fn0
 490         2,              // Fn1
 491         2,              // Fn2
 492     };
 493
 494     static const uint8_t PROGMEM fn_keycode[] = {
 495         KC_NO,          // Fn0
 496         KC_NO,          // Fn1
 497         KC_SPC,         // Fn2
 498     };
 499
 500
 501 ## Terminology
 502 - keymap
 503 - layer
 504 - layout
 505 - key
 506 - keycode
 507 - scancode
 508 - action
 509 - layer transparency
 510 - layer precedence
 511 - register
 512 - tap
 513 - Fn key