diff options
| author | Ryan <fauxpark@gmail.com> | 2022-01-22 14:34:15 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-22 03:34:15 +0000 |
| commit | b45a037c7edcd9c1cfadceb69ed51e7d42aa58c1 (patch) | |
| tree | 7a7b03c394c5d28a9ae7765254e5bcf86e02217f /docs | |
| parent | c7f477bc59e4124a791f0be195aaad9f21def161 (diff) | |
Rename some Quantum keycodes (#15968)
* Rename some Quantum keycodes * Tweak EEPROM clear and debug keycode short aliases
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_grave_esc.md | 10 | ||||
| -rw-r--r-- | docs/keycodes.md | 16 | ||||
| -rw-r--r-- | docs/quantum_keycodes.md | 10 |
3 files changed, 18 insertions, 18 deletions
diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md index f135b1dede..09d098ee4e 100644 --- a/docs/feature_grave_esc.md +++ b/docs/feature_grave_esc.md @@ -4,17 +4,17 @@ If you're using a 60% keyboard, or any other layout with no F-row, you will have ## Usage -Replace the `KC_GRV` key in your keymap (usually to the left of the `1` key) with `KC_GESC`. Most of the time this key will output `KC_ESC` when pressed. However, when Shift or GUI are held down it will output `KC_GRV` instead. +Replace the `KC_GRV` key in your keymap (usually to the left of the `1` key) with `QK_GESC`. Most of the time this key will output `KC_ESC` when pressed. However, when Shift or GUI are held down it will output `KC_GRV` instead. ## What Your OS Sees -If Mary presses GESC on her keyboard, the OS will see an KC_ESC character. Now if Mary holds Shift down and presses GESC it will output `~`, or a shifted backtick. Now if she holds GUI/CMD/WIN, it will output a simple <code>`</code> character. +If Mary presses `QK_GESC` on her keyboard, the OS will see an KC_ESC character. Now if Mary holds Shift down and presses `QK_GESC` it will output `~`, or a shifted backtick. Now if she holds GUI/CMD/WIN, it will output a simple <code>`</code> character. ## Keycodes -|Key |Aliases |Description | -|---------|-----------|------------------------------------------------------------------| -|`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| +|Key |Aliases |Description | +|-----------------|---------|------------------------------------------------------------------| +|`QK_GRAVE_ESCAPE`|`QK_GESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| ### Caveats diff --git a/docs/keycodes.md b/docs/keycodes.md index dba530fc79..58ce43d309 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -219,11 +219,11 @@ See also: [Basic Keycodes](keycodes_basic.md) See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) -|Key |Aliases |Description | -|--------------|---------|-------------------------------------------------------| -|`RESET` | |Put the keyboard into bootloader mode for flashing | -|`DEBUG` | |Toggle debug mode | -|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)| +|Key |Aliases |Description | +|-----------------|---------|-------------------------------------------------------| +|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing | +|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode | +|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)| ## Audio Keys :id=audio-keys @@ -283,9 +283,9 @@ See also: [Dynamic Macros](feature_dynamic_macros.md) See also: [Grave Escape](feature_grave_esc.md) -|Key |Aliases |Description | -|-----------|---------|------------------------------------------------------------------| -|`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| +|Key |Aliases |Description | +|-----------------|---------|------------------------------------------------------------------| +|`QK_GRAVE_ESCAPE`|`QK_GESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| ## Key Lock :id=key-lock diff --git a/docs/quantum_keycodes.md b/docs/quantum_keycodes.md index 7ebad2c1ee..8e29e05886 100644 --- a/docs/quantum_keycodes.md +++ b/docs/quantum_keycodes.md @@ -8,8 +8,8 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are ## QMK Keycodes :id=qmk-keycodes -|Key |Aliases |Description | -|--------------|---------|-------------------------------------------------------| -|`RESET` | |Put the keyboard into bootloader mode for flashing | -|`DEBUG` | |Toggle debug mode | -|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)| +|Key |Aliases |Description | +|-----------------|---------|-------------------------------------------------------| +|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing | +|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode | +|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)| |