aboutsummaryrefslogtreecommitdiffstats
path: root/docs/keycodes.md
AgeCommit message (Collapse)Author
2020-06-09Add OS compatibility matrix for basic keycodes (#8557)Gravatar Ryan
2020-05-14One shot support for swap hands (#8590)Gravatar Zsolt Parragi
This commits add the SH_OS keycode, which works similarly to one shot layers: * while pressed, the keyboard is swapped * if no keys were pressed while it was pressed, the next key press is swapped SH_OS also supports chaining with one shot layers: OSL(x) + SH_OS + key interprets the key press on the oneshot layer. The ONESHOT_TIMEOUT setting used by one shot keys and layers is also used by oneshot swap hands. In the above chaining scenario the timeout of the oneshot layer is reset when swap hands is activated. Resolves #2682
2020-04-12Add *OPT aliases for *ALT keycodes and macros (#8714)Gravatar Konstantin Đorđević
2020-03-31Rename UC_OSX (and related constants) to UC_MAC (#8589)Gravatar Konstantin Đorđević
* Rename UC_OSX (and related constants) to UC_MAC * Update UNICODE_SONG_OSX references to UNICODE_SONG_MAC * Update UC_M_OS references to UC_M_MA * Add UC_OSX alias for backwards compatibility * Add deprecation warning for UC_OSX to Unicode docs * Add UC_M_OS alias for backwards compatibility * Update newly found UC_M_OS and UNICODE_SONG_OSX references * Add legacy UNICODE_MODE_OSX alias, revert changes to user keymaps * Add legacy UNICODE_SONG_OSX alias, revert changes to user keymaps * Replace removed sounds in Unicode song doc examples
2020-03-21[Docs] Update layer documentation (#8371)Gravatar Drashna Jaelre
* [Docs] Update layer documentation * Add layer_state_cmp functions * Fix cut/copy/paste issue * Add id tags * Apply noroads corrections * Move Layers section to separate document * Fix ID tag for layers * Use better name for summary/side bar * Fix feature page linkage As well as a small spell error close by * Remove paper analogy for now
2020-03-05keycodes.md: hard-code section link id attributesGravatar James Young
2020-03-05keycodes.md: don't use section headings as linksGravatar James Young
It prevents the Table of Contents from parsing that heading.
2020-03-05Add explicit id tags to externally linked headersGravatar skullY
2020-03-05remove some unnecessary external linksGravatar James Young
Also clean up some trailing whitespace.
2020-02-07Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093)Gravatar fauxpark
2020-01-14Move Space Cadet keycodes to their own section in keycode reference (#7889)Gravatar fauxpark
2019-12-05Add short aliases for Magic keycodes (#7541)Gravatar fauxpark
* Add short alias for `MAGIC_TOGGLE_NKRO` * Add aliases for the other Bootmagic keycodes * Replace long form in default keymaps
2019-11-28Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484)Gravatar Manna Harbour
* Add shift-to-invert to remaining directional RGB_* keycode pairs RGB_MODE_FORWARD / RGB_MODE_REVERSE invert their functions when shift is held. This change adds the same capabilities to the remaining directional RGB_* keycode pairs. This improves consistency and provides full RGB control in a keymap containing only one keycode from each pair. * remove redundant variable * fix typo * Fix more typos Flyspell is on now I swear!
2019-11-04[Core] Convert Dynamic Macro to a Core Feature (#5948)Gravatar Drashna Jaelre
* Convert Dynamic Macro to a Core Feature This imports the code from Dynamic Macro into the core code, and handles it, as such. This deprecates the old method but does not remove it, for legacy support. This way, no existing user files need to be touched. Additionally, this reorganizes the documentation to better reflect the changes. Also, it adds user hooks to the feature so users can customize the existing functionality. Based heavily on and closes #2976 * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Cleanup based on feedback * Add short-form keycodes and document them - add short-form keycodes to quantum/quantum_keycodes.h - document the new aliases in docs/feature_dynamic_macros.md * Add Dynamic Macros section and keycodes to docs/keycodes.md * Make anti-nesting optional * Add documentation for DYNAMIC_MACRO_NO_NESTING option * Fix Merge artifacts * Fix formatting typo in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Remove DYNAMIC_MACRO_RANGE as it's not needed * Fix includes and layer var type
2019-10-30Remove obsolete note about media keys in MacOS (#6631)Gravatar Steve Purcell
* Remove obsolete note about media keys in MacOS KC_MNXT and KC_MPRV work fine on MacOS, so this note is obsolete. * Document behaviour of MEDIA_FAST_FORWARD/MEDIA_REWIND codes on MacOS * Small typo fix, and make OS-dependent keycode claim less absolute * Update docs/keycodes_basic.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-10-26Backslash-escape pipe character in keycode lists (#7157)Gravatar fauxpark
2019-09-24ARM split - Add bootmagic/magic keycodes for setting handedness (#6545)Gravatar Joel Challis
* Add docs on bootmagic/magic keycodes for setting handedness * Clang format fixes * Maintain backwards compatibility * Maintain backwards compatibility
2019-08-21Added keycodes for swapping and unswapping the Control and OS keys (#6110)Gravatar Stephen Wanhella
* Add MAGIC_SWAP_CONTROL_LGUI and MAGIC_UNSWAP_CONTROL_LGUI keycodes Key codes to swap and unswap the control and windows/cmd keys * Fix issues with pull request #6110 Renamed swap/unswap lctl and lgui key codes, added key codes to swap/unswap rctl and rgui, and moved new bool inside keycode_config.h struct to the end * Move new keycodes to the end of the enum (#6110) * add cases for swapped control and OS keys to mod_config (#6110) * Add new keycodes to feature_bootmagic.md (#6110) * Add R+L swap codes to keep in parity with AG_* codes * Extend Magic range check to include new magic codes * Update audio docs * Combine 2 byte ranges into 1 word for EECONFG Fix names for Keymap config EEPROM * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_bootmagic.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-06-24[Docs] Reword confusing description of `TO(layer)` (#6174)Gravatar lf
* Reword confusing description of `TO(layer)` * Update docs/keycodes.md Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-05-25Document MT keycode in keycodes.mdGravatar fauxpark
2019-05-11Added check for event pressed to clear space cadet (#5839)Gravatar XScorpion2
* Added check for pressed to clear space cadet * Found some docs to update * Update docs/quantum_keycodes.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Changes from PR
2019-05-03New keycode macro (XP) for shifted character pairs using UNICODEMAP + bug ↵Gravatar Konstantin Đorđević
fixes and improvements (#4803) * Expose unicode_saved_mods * Add UNICODEMAP shift pair functionality and XS keycode * Add XS to keycode reference documentation * Pick pair index based on both Shift and Caps Lock state * Add XS to Unicode feature docs * Clean up process_unicode* headers * Extract unicode_map index calculation into function * Pick pair index as XOR rather than OR of Shift and Caps states * unicode_input_start() has to be called before the unicode_map index is calculated * Replace unicodemap_input_error() with more generic unicode_input_cancel() * Replace register+tap+unregister with tap_code16(LCTL(LSFT(KC_U))) * UNICODE_OSX_KEY → UNICODE_KEY_OSX, UNICODE_WINC_KEY → UNICODE_KEY_WINC * Make keycode range checks more robust * Fix keycode range checks for different input modes * Add UNICODE_KEY_LNX, update docs * QK_UNICODEMAP_SHIFT → QK_UNICODEMAP_PAIR * XS → XP, update docs * Tweak Unicode docs * Use recently added MOD_MASK_SHIFT and IS_HOST_LED_ON helpers * Update Unicode table in docs/keycodes.md * Update Unicode docs per review comments * Replace references to Mac OS X with macOS in Unicode docs * As of v0.9.0, WinCompose supports all possible code points * Expand descriptions in XP docs * Update keycode table and cycling docs * Further expand cycling docs
2019-01-25Add C(), A() and G() to match already existing S() (#4673)Gravatar fauxpark
2019-01-25Adding documentation for the LM layer modifier. (#3617)Gravatar Dave Brown
* Adding documentation for the LM layer modifier. This will hopefully clear up some of the confusion around adding this layer modifier. I struggled with this a bit as well at first. * Removing duplicate table. * Changed section title to `Changing Layers` * Retain name
2019-01-17Add new brightness aliases to keycodes_basic.mdGravatar fauxpark
2019-01-17MacOS Brightness Alias (#4836)Gravatar Jeremy Bernhardt
* Added aliases for OSX brightness * Updated docs for alises * Moved aliases, added docs to Brightness section * Update docs/keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com> * Update docs/keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com> * Update keycode.h * Update keycode.h * Update keycodes.md * Update docs/keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com>
2019-01-08Tidy up Mod-Tap shortcuts (#4806)Gravatar fauxpark
2019-01-07Improve consistency in UNICODEMAP code and docs, update ↵Gravatar Konstantin Đorđević
docs/understanding_qmk (#4774) * Remove unused UNICODE(n) macro, update docs * Add note about max length of unicode_map to docs * QK_UNICODE_MAP → QK_UNICODEMAP * Refactor process_unicode_map * process_unicode_map → process_unicodemap This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself. * Update references and ordering in docs/understanding_qmk * Add additional note to docs/understanding_qmk * &unicode_map[index] → unicode_map + index This avoids the issue of the compiler sometimes complaining about the array index being out of range * Update docs/getting_started_make_guide * Update method sections in docs/feature_unicode
2018-12-14Docs: Clarify audio keycodes (#4620)Gravatar Drashna Jaelre
* Clarify audio keycodes * Spelling errors Co-Authored-By: drashna <drashna@live.com> * Spacing in md Co-Authored-By: drashna <drashna@live.com> * Fix midi link too * Wordsmithing
2018-12-14Docs: Remove duplicate layer block in keycodes.md (#4621)Gravatar Drashna Jaelre
* Docs: Remove duplicate layer block in keycodes.md Reorder and add OSL * remove glitch Co-Authored-By: drashna <drashna@live.com>
2018-12-12Add standard definitions for ALGR and KC_ALGR (#4389)Gravatar Konstantin Đorđević
* Add standard ALGR defition, remove (re)definitions from language files * Use ALGR(kc) consistently in ALTGR(kc) aliases * Non-Nordic keymaps should not use NO_ALGR * Add standard KC_ALGR definition * Update docs with ALGR and KC_ALGR * Update SS_ALGR and ALGR_T aliases
2018-11-28Add Extrakey support for Brightness up/down (#4477)Gravatar Giuseppe Rota
2018-11-23Add EEPROM_RESET keycode to keycodes.md doc (#4473)Gravatar noroadsleft
2018-11-14Fixed Unicode Support heading (#4425)Gravatar James Osborn
Previously, Unicode Support heading appeared as the last row in the Swap Hands table.
2018-11-13Docs: Fix descriptions of KC_INT1 and KC_INT3Gravatar KOBAYASHI Daisuke
2018-11-06Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Gravatar Konstantin Đorđević
* Remove ALTG(kc) as it's misleading and is not actually AltGr * Add temporary alias for ALGR in keyboards/planck/keymaps/pevecyan/keymap.c
2018-09-17Create AG_TOGG code to toggle Alt/Gui swap.Gravatar Joe Wasson
2018-08-30Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵Gravatar fauxpark
(#3799)
2018-08-11Dedupe shifted keycodes listingGravatar fauxpark
2018-08-04More improvements to keycode docs (#3567)Gravatar fauxpark
* Reorder keycode list docs according to HID usage * Add missing keycodes/descriptions/aliases
2018-07-26Docs: Fixed the link to the advanced keycodes wiki (#3505)Gravatar Bruno Fagundez
2018-07-15Overhaul to keycode related docsGravatar Drashna Jaelre
* Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section
2018-06-28Clean up SEND_STRING keycodes and add media keys (#3214)Gravatar fauxpark
* Clean up SEND_STRING keycodes and add media keys * Remove stray define * Add missing SEND_STRING keycodes for completeness Also, add KC_EJCT to the keycode references
2018-06-04Add rgblight mode 35 (R,G,B test mode) (#3114)Gravatar Takeshi ISHII
* add rgblight mode 35 (RGB cyclic mode) into quantum/rgblight.c * Update docs, add rgblight mode 35(RGB cyclic) * rename RGBCYCLIC to RGBTEST
2018-05-22 Update documentation for rgb matrix (#3023)Gravatar yiancar
* Update documentation for rgb matrix - Updated keycodes.md to include RGB matrix keycodes + necessary link
2018-03-20Add macro for momentarily switching to a layer while some mods are active ↵Gravatar snyman
(#2460) * Macro for a momentary layer switch with mods Passes through to the existing ACTION_LAYER_MODS macro, albeit with more limited options due to lack of space in the quantum_keycodes enum. * Add documentation for LM layer-mod macro * Clean up Tap Toggle documentation
2018-03-16Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.Gravatar fauxpark
2018-03-16Add keycodes for swap-hands feature.Gravatar Joe Wasson
2018-02-28Fixed typo of 'confid.h' to 'config.h' (#2448)Gravatar Brian Choromanski
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs
2018-01-12Remove reference to BL_x in keycodes.md, and add BL_BRTGGravatar fauxpark
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-12-27 10:42:00 +0000