diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-05-30 12:00:41 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 12:00:41 +1000 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/reference_glossary.md | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/reference_glossary.md')
| -rw-r--r-- | docs/reference_glossary.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/reference_glossary.md b/docs/reference_glossary.md index 31855606be..cf8c8f0d75 100644 --- a/docs/reference_glossary.md +++ b/docs/reference_glossary.md | |||
| @@ -36,12 +36,12 @@ An alternative keyboard layout developed by Dr. August Dvorak in the 1930's. A s | |||
| 36 | ## Dynamic Macro | 36 | ## Dynamic Macro |
| 37 | A macro which has been recorded on the keyboard and which will be lost when the keyboard is unplugged or the computer rebooted. | 37 | A macro which has been recorded on the keyboard and which will be lost when the keyboard is unplugged or the computer rebooted. |
| 38 | 38 | ||
| 39 | * [Dynamic Macro Documentation](feature_dynamic_macros.md) | 39 | * [Dynamic Macro Documentation](feature_dynamic_macros) |
| 40 | 40 | ||
| 41 | ## Eclipse | 41 | ## Eclipse |
| 42 | An IDE that is popular with many C developers. | 42 | An IDE that is popular with many C developers. |
| 43 | 43 | ||
| 44 | * [Eclipse Setup Instructions](other_eclipse.md) | 44 | * [Eclipse Setup Instructions](other_eclipse) |
| 45 | 45 | ||
| 46 | ## Firmware | 46 | ## Firmware |
| 47 | The software that controls your MCU. | 47 | The software that controls your MCU. |
| @@ -59,7 +59,7 @@ In-system programming, a method of programming an AVR chip using external hardwa | |||
| 59 | An interface for receiving debugging messages from your keyboard. You can view these messages using [QMK Flasher](https://github.com/qmk/qmk_flasher) or [PJRC's hid_listen](https://www.pjrc.com/teensy/hid_listen.html) | 59 | An interface for receiving debugging messages from your keyboard. You can view these messages using [QMK Flasher](https://github.com/qmk/qmk_flasher) or [PJRC's hid_listen](https://www.pjrc.com/teensy/hid_listen.html) |
| 60 | 60 | ||
| 61 | ## Keycode | 61 | ## Keycode |
| 62 | A 2-byte number that represents a particular key. `0x00`-`0xFF` are used for [Basic Keycodes](keycodes_basic.md) while `0x100`-`0xFFFF` are used for [Quantum Keycodes](quantum_keycodes.md). | 62 | A 2-byte number that represents a particular key. `0x00`-`0xFF` are used for [Basic Keycodes](keycodes_basic) while `0x100`-`0xFFFF` are used for [Quantum Keycodes](quantum_keycodes). |
| 63 | 63 | ||
| 64 | ## Key Down | 64 | ## Key Down |
| 65 | An event that happens when a key is pressed down, but is completed before a key is released. | 65 | An event that happens when a key is pressed down, but is completed before a key is released. |
| @@ -76,7 +76,7 @@ An abstraction used to allow a key to serve multiple purposes. The highest activ | |||
| 76 | ## Leader Key | 76 | ## Leader Key |
| 77 | A feature that allows you to tap the leader key followed by a sequence of 1, 2, or 3 keys to activate key presses or other quantum features. | 77 | A feature that allows you to tap the leader key followed by a sequence of 1, 2, or 3 keys to activate key presses or other quantum features. |
| 78 | 78 | ||
| 79 | * [Leader Key Documentation](feature_leader_key.md) | 79 | * [Leader Key Documentation](feature_leader_key) |
| 80 | 80 | ||
| 81 | ## LED | 81 | ## LED |
| 82 | Light Emitting Diode, the most common device used for indicators on a keyboard. | 82 | Light Emitting Diode, the most common device used for indicators on a keyboard. |
| @@ -90,7 +90,7 @@ A wiring pattern of columns and rows that enables the MCU to detect keypresses w | |||
| 90 | ## Macro | 90 | ## Macro |
| 91 | A feature that lets you send multiple keypress events (hid reports) after having pressed only a single key. | 91 | A feature that lets you send multiple keypress events (hid reports) after having pressed only a single key. |
| 92 | 92 | ||
| 93 | * [Macro Documentation](feature_macros.md) | 93 | * [Macro Documentation](feature_macros) |
| 94 | 94 | ||
| 95 | ## MCU | 95 | ## MCU |
| 96 | Microcontrol Unit, the processor that powers your keyboard. | 96 | Microcontrol Unit, the processor that powers your keyboard. |
| @@ -101,7 +101,7 @@ A key that is held down while typing another key to modify the action of that ke | |||
| 101 | ## Mousekeys | 101 | ## Mousekeys |
| 102 | A feature that lets you control your mouse cursor and click from your keyboard. | 102 | A feature that lets you control your mouse cursor and click from your keyboard. |
| 103 | 103 | ||
| 104 | * [Mousekeys Documentation](feature_mouse_keys.md) | 104 | * [Mousekeys Documentation](feature_mouse_keys) |
| 105 | 105 | ||
| 106 | ## N-Key Rollover (NKRO) | 106 | ## N-Key Rollover (NKRO) |
| 107 | A term that applies to keyboards that are capable of reporting any number of key-presses at once. | 107 | A term that applies to keyboards that are capable of reporting any number of key-presses at once. |
| @@ -130,7 +130,7 @@ A 1 byte number that is sent as part of a HID report over USB that represents a | |||
| 130 | ## Space Cadet Shift | 130 | ## Space Cadet Shift |
| 131 | A special set of shift keys which allow you to type various types of braces by tapping the left or right shift one or more times. | 131 | A special set of shift keys which allow you to type various types of braces by tapping the left or right shift one or more times. |
| 132 | 132 | ||
| 133 | * [Space Cadet Shift Documentation](feature_space_cadet.md) | 133 | * [Space Cadet Shift Documentation](feature_space_cadet) |
| 134 | 134 | ||
| 135 | ## Tap | 135 | ## Tap |
| 136 | Pressing and releasing a key. In some situations you will need to distinguish between a key down and a key up event, and Tap always refers to both at once. | 136 | Pressing and releasing a key. In some situations you will need to distinguish between a key down and a key up event, and Tap always refers to both at once. |
| @@ -138,7 +138,7 @@ Pressing and releasing a key. In some situations you will need to distinguish be | |||
| 138 | ## Tap Dance | 138 | ## Tap Dance |
| 139 | A feature that lets you assign multiple keycodes to the same key based on how many times you press it. | 139 | A feature that lets you assign multiple keycodes to the same key based on how many times you press it. |
| 140 | 140 | ||
| 141 | * [Tap Dance Documentation](feature_tap_dance.md) | 141 | * [Tap Dance Documentation](feature_tap_dance) |
| 142 | 142 | ||
| 143 | ## Teensy | 143 | ## Teensy |
| 144 | A low-cost AVR development board that is commonly used for hand-wired builds. A teensy is often chosen despite costing a few dollars more due to its halfkay bootloader, which makes flashing very simple. | 144 | A low-cost AVR development board that is commonly used for hand-wired builds. A teensy is often chosen despite costing a few dollars more due to its halfkay bootloader, which makes flashing very simple. |
| @@ -149,12 +149,12 @@ A generic term for LEDs that light the underside of the board. These LEDs typica | |||
| 149 | ## Unicode | 149 | ## Unicode |
| 150 | In the larger computer world Unicode is a set of encoding schemes for representing characters in any language. As it relates to QMK it means using various OS schemes to send unicode codepoints instead of scancodes. | 150 | In the larger computer world Unicode is a set of encoding schemes for representing characters in any language. As it relates to QMK it means using various OS schemes to send unicode codepoints instead of scancodes. |
| 151 | 151 | ||
| 152 | * [Unicode Documentation](feature_unicode.md) | 152 | * [Unicode Documentation](feature_unicode) |
| 153 | 153 | ||
| 154 | ## Unit Testing | 154 | ## Unit Testing |
| 155 | A framework for running automated tests against QMK. Unit testing helps us be confident that our changes do not break anything. | 155 | A framework for running automated tests against QMK. Unit testing helps us be confident that our changes do not break anything. |
| 156 | 156 | ||
| 157 | * [Unit Testing Documentation](unit_testing.md) | 157 | * [Unit Testing Documentation](unit_testing) |
| 158 | 158 | ||
| 159 | ## USB | 159 | ## USB |
| 160 | Universal Serial Bus, the most common wired interface for a keyboard. | 160 | Universal Serial Bus, the most common wired interface for a keyboard. |
