varl/qmk_firmware
1
0
Fork 0
forked from forks/qmk_firmware
Code Pull requests Activity

keycodes.md: hard-code section link id attributes

Browse source
This commit is contained in:
James Young 2020-03-05 15:32:27 -08:00 committed by skullydazed
parent 772bacb770
commit 2939751eb3
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
docs/keycodes.md
View file

@ -4,7 +4,7 @@ When defining a [keymap](keymap.md) each key needs a valid key definition. This
This is a reference only. Each group of keys links to the page documenting their functionality in more detail. This is a reference only. Each group of keys links to the page documenting their functionality in more detail.
## Basic Keycodes ## Basic Keycodes :id=basic-keycodes
See also: [Basic Keycodes](keycodes_basic.md) See also: [Basic Keycodes](keycodes_basic.md)
@ -208,7 +208,7 @@ See also: [Basic Keycodes](keycodes_basic.md)
|`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up | |`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up |
|`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down | |`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down |
## Quantum Keycodes ## Quantum Keycodes :id=quantum-keycodes
See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
@ -218,7 +218,7 @@ See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
|`DEBUG` | |Toggle debug mode | |`DEBUG` | |Toggle debug mode |
|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)| |`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)|
## Audio Keys ## Audio Keys :id=audio-keys
See also: [Audio](feature_audio.md) See also: [Audio](feature_audio.md)
@ -236,7 +236,7 @@ See also: [Audio](feature_audio.md)
|`MU_TOG` | |Toggles Music Mode | |`MU_TOG` | |Toggles Music Mode |
|`MU_MOD` | |Cycles through the music modes | |`MU_MOD` | |Cycles through the music modes |
## Backlighting ## Backlighting :id=backlighting
See also: [Backlighting](feature_backlight.md) See also: [Backlighting](feature_backlight.md)
@ -250,7 +250,7 @@ See also: [Backlighting](feature_backlight.md)
|`BL_DEC` |Decrease the backlight level | |`BL_DEC` |Decrease the backlight level |
|`BL_BRTG`|Toggle backlight breathing | |`BL_BRTG`|Toggle backlight breathing |
## Bootmagic ## Bootmagic :id=bootmagic
See also: [Bootmagic](feature_bootmagic.md) See also: [Bootmagic](feature_bootmagic.md)
@ -286,7 +286,7 @@ See also: [Bootmagic](feature_bootmagic.md)
|`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) | |`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) |
|`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)| |`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)|
## Bluetooth ## Bluetooth :id=bluetooth
See also: [Bluetooth](feature_bluetooth.md) See also: [Bluetooth](feature_bluetooth.md)
@ -296,7 +296,7 @@ See also: [Bluetooth](feature_bluetooth.md)
|`OUT_USB` |USB only | |`OUT_USB` |USB only |
|`OUT_BT` |Bluetooth only | |`OUT_BT` |Bluetooth only |
## Dynamic Macros ## Dynamic Macros :id=dynamic-macros
See also: [Dynamic Macros](feature_dynamic_macros.md) See also: [Dynamic Macros](feature_dynamic_macros.md)
@ -308,7 +308,7 @@ See also: [Dynamic Macros](feature_dynamic_macros.md)
|`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 | |`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 |
|`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.| |`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.|
## Grave Escape ## Grave Escape :id=grave-escape
See also: [Grave Escape](feature_grave_esc.md) See also: [Grave Escape](feature_grave_esc.md)
@ -316,7 +316,7 @@ See also: [Grave Escape](feature_grave_esc.md)
|-----------|---------|------------------------------------------------------------------| |-----------|---------|------------------------------------------------------------------|
|`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held| |`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held|
## Key Lock ## Key Lock :id=key-lock
See also: [Key Lock](feature_key_lock.md) See also: [Key Lock](feature_key_lock.md)
@ -324,7 +324,7 @@ See also: [Key Lock](feature_key_lock.md)
|---------|--------------------------------------------------------------| |---------|--------------------------------------------------------------|
|`KC_LOCK`|Hold down the next key pressed, until the key is pressed again| |`KC_LOCK`|Hold down the next key pressed, until the key is pressed again|
## Layer Switching ## Layer Switching :id=layer-switching
See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
@ -339,7 +339,7 @@ See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-
|`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer | |`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer |
|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on | |`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
## Leader Key ## Leader Key :id=leader-key
See also: [Leader Key](feature_leader_key.md) See also: [Leader Key](feature_leader_key.md)
@ -347,7 +347,7 @@ See also: [Leader Key](feature_leader_key.md)
|---------|------------------------| |---------|------------------------|
|`KC_LEAD`|Begins a leader sequence| |`KC_LEAD`|Begins a leader sequence|
## Mouse Keys ## Mouse Keys :id=mouse-keys
See also: [Mouse Keys](feature_mouse_keys.md) See also: [Mouse Keys](feature_mouse_keys.md)
@ -370,7 +370,7 @@ See also: [Mouse Keys](feature_mouse_keys.md)
|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1|
|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2|
## Modifiers ## Modifiers :id=modifiers
See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys) See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys)
@ -392,7 +392,7 @@ See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys)
|`KC_MEH` | |Left Control, Shift and Alt | |`KC_MEH` | |Left Control, Shift and Alt |
|`KC_HYPR` | |Left Control, Shift, Alt and GUI | |`KC_HYPR` | |Left Control, Shift, Alt and GUI |
## Mod-Tap Keys ## Mod-Tap Keys :id=mod-tap-keys
See also: [Mod-Tap](mod_tap.md) See also: [Mod-Tap](mod_tap.md)
@ -415,7 +415,7 @@ See also: [Mod-Tap](mod_tap.md)
|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped| |`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped|
|`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| |`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
## RGB Lighting ## RGB Lighting :id=rgb-lighting
See also: [RGB Lighting](feature_rgblight.md) See also: [RGB Lighting](feature_rgblight.md)
@ -440,7 +440,7 @@ See also: [RGB Lighting](feature_rgblight.md)
|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode |
|`RGB_MODE_RGBTEST` |`RGB_M_T` |Red,Green,Blue test animation mode | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red,Green,Blue test animation mode |
## RGB Matrix Lighting ## RGB Matrix Lighting :id=rgb-matrix-lighting
See also: [RGB Matrix Lighting](feature_rgb_matrix.md) See also: [RGB Matrix Lighting](feature_rgb_matrix.md)
@ -458,7 +458,7 @@ See also: [RGB Matrix Lighting](feature_rgb_matrix.md)
|`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held| |`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
|`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held| |`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|
## Thermal Printer ## Thermal Printer :id=thermal-printer
See also: [Thermal Printer](feature_thermal_printer.md) See also: [Thermal Printer](feature_thermal_printer.md)
@ -467,7 +467,7 @@ See also: [Thermal Printer](feature_thermal_printer.md)
|`PRINT_ON` |Start printing everything the user types| |`PRINT_ON` |Start printing everything the user types|
|`PRINT_OFF`|Stop printing everything the user types | |`PRINT_OFF`|Stop printing everything the user types |
## US ANSI Shifted Symbols ## US ANSI Shifted Symbols :id=us-ansi-shifted-symbols
See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md) See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md)
@ -495,7 +495,7 @@ See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md)
|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | |`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` |
|`KC_QUESTION` |`KC_QUES` |`?` | |`KC_QUESTION` |`KC_QUES` |`?` |
## One Shot Keys ## One Shot Keys :id=one-shot-keys
See also: [One Shot Keys](one_shot_keys.md) See also: [One Shot Keys](one_shot_keys.md)
@ -504,7 +504,7 @@ See also: [One Shot Keys](one_shot_keys.md)
|`OSM(mod)` |Hold `mod` for one keypress | |`OSM(mod)` |Hold `mod` for one keypress |
|`OSL(layer)`|Switch to `layer` for one keypress| |`OSL(layer)`|Switch to `layer` for one keypress|
## Space Cadet ## Space Cadet :id=space-cadet
See also: [Space Cadet](feature_space_cadet.md) See also: [Space Cadet](feature_space_cadet.md)
@ -518,7 +518,7 @@ See also: [Space Cadet](feature_space_cadet.md)
|`KC_RAPC` |Right Alt when held, `)` when tapped | |`KC_RAPC` |Right Alt when held, `)` when tapped |
|`KC_SFTENT`|Right Shift when held, Enter when tapped| |`KC_SFTENT`|Right Shift when held, Enter when tapped|
## Swap Hands ## Swap Hands :id=swap-hands
See also: [Swap Hands](feature_swap_hands.md) See also: [Swap Hands](feature_swap_hands.md)
@ -532,7 +532,7 @@ See also: [Swap Hands](feature_swap_hands.md)
|`SH_TG` |Toggles swap on and off with every key press. | |`SH_TG` |Toggles swap on and off with every key press. |
|`SH_TT` |Toggles with a tap; momentary when held. | |`SH_TT` |Toggles with a tap; momentary when held. |
## Unicode Support ## Unicode Support :id=unicode-support
See also: [Unicode Support](feature_unicode.md) See also: [Unicode Support](feature_unicode.md)