summaryrefslogtreecommitdiffstats
path: root/docs/feature_advanced_keycodes.md
Commit message (Collapse)AuthorAgeFilesLines
* Update code example to match description (#20528)Albert Y2023-04-231-1/+1
|
* [Docs] Fix suggested code pattern when a specific mod-mask is required. (#20512)precondition2023-04-201-3/+3
|
* [Doc] Add example to keyboard housekeeping and some minor fixes (#19968)しぐれ2023-03-151-0/+5
| | | | Co-authored-by: jack <0x6a73@protonmail.com>
* [Docs] Extract 'Layer Change Code' and EEPROM (#18174)coliss862022-09-191-1/+1
| | | | | | | | | | | * [Docs] Extract 'Layer Change Code' and EEPROM * adjust wording * Update docs/custom_quantum_functions.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
* Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md ↵Forrest Cahoon2022-05-311-1/+1
| | | | (#17211)
* Additional documentation for GUI mod combo (#13266)Albert Y2021-06-221-18/+21
| | | Co-authored-by: filterpaper <filterpaper@localhost>
* [Docs] New section to modifier docs: Checking Modifier State (#10550)precondition2021-02-281-0/+135
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added new section to docs: Checking Modifier State * Added id anchors to all headers in modifiers docs * Added a Wikipedia link to bitwise operators and... crosslinked to the QMK macro docs. * Added an explanation on the format of mod bitmask * Added .md extension to hyperlinks to macros docs * Corrected mod mask order and changed notation * Documented add_oneshot_mods and del_oneshot_mods * Mentioned modifier checks in the macro docs * Explained strict modifier checking i.e. using `get_mods() & MOD_MASK == MOD_MASK` instead of simply `get_mods() & MOD_MASK` * Added (un)register_mods to the docs * Put left term of comparison in parens
* Doc followup 9942 (#10473)nopunin10did2020-10-011-15/+18
| | | | | * Update feature_advanced_keycodes.md * Update mod_tap.md
* Add *OPT aliases for *ALT keycodes and macros (#8714)Konstantin Đorđević2020-04-121-3/+3
|
* [Docs] Update layer documentation (#8371)Drashna Jaelre2020-03-211-44/+5
| | | | | | | | | | | | | | | | | | | | | | | | * [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
* make sure all our redirects are in orderskullY2020-03-051-0/+16
|
* Add explicit id tags to externally linked headersskullY2020-03-051-3/+3
|
* break feature_advanced_keycodes.md up into multiple filesskullY2020-03-051-327/+6
|
* New feature: PERMISSIVE_HOLD_PER_KEY (#7994)ridingqwerty2020-02-251-0/+19
| | | | | | | | * Implement 'PERMISSIVE_HOLD_PER_KEY' * Document 'PERMISSIVE_HOLD_PER_KEY' Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
* Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859)ridingqwerty2020-01-171-0/+38
| | | | | | | | | | * Implement and document TAPPING_FORCE_HOLD_PER_KEY * Added "record" parameter to "get_tapping_force_hold" * Correct typo -- remove 'IGNORE_' from 'IGNORE_TAPPING_FORCE_HOLD_PER_KEY' Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
* fix instructions for oneshot layer handling on key release (#7554)hmkemppainen2019-12-081-1/+1
| | | | | | | | * fix instructions for oneshot layer handling on key release * use ONESHOT_OTHER_KEY_PRESSED instead of ONESHOT_PRESSED Co-Authored-By: Drashna Jaelre <drashna@live.com>
* fix feature_advanced_keycodes.md's link (#7421)Takeshi ISHII2019-11-201-1/+1
| | | | | | | | | | | docs/feature_advanced_keycodes.md has: ``` [Tap Dance](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) ``` change to: ``` [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) ```
* fix typoshela2019-07-011-8/+8
|
* [Docs] Add Tap Dance example to the docs (#5326)Dusty Pomerleau2019-03-071-1/+1
| | | | | | | | * add a tapdance example for creating advanced mod-tap and layer-tap keys * add optional curly braces to match QMK conventions * change example to use `register_code16()` and tapdance keycodes more closely matching QMK variants
* Replace instances of KEYMAP with LAYOUTnoroadsleft2019-02-211-1/+1
| | | | | | Many instances in the QMK Docs referenced KEYMAP macros, which is outdated terminology. Replaced most instances of KEYMAP with LAYOUT, to reflect the desired usage.
* Fix documentation about one shot tap toggleJayesh Vora2019-02-151-1/+1
| | | Based on conversation with Drashna on Discord, we know that if ONE_SHOT_TAP_TOGGLE is 5, then tapping a one shot mod key 5 times holds the one shot key permanently, but to come out of this, you need to press the same key only once.
* Adds a period to the docs.Erez Zukerman2019-02-071-1/+1
| | | Yes, really. Revolutionary, I know!
* Add One Shot Key callbacks (#4697)Thomas Baart2019-02-051-0/+75
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added callbacks to one shot modifier changes * Altered signature of callback functions * Reordered the callback methods, shortened brief documentation * Added One Shot Modifier callback documentation * First attempt at unit tests * Revert "First attempt at unit tests" This reverts commit 5ec21a782202c0d74cf21cb852bd319f0c8b4842. * Simplified oneshot function implementations * Made clear_oneshot_locked_mods to be conform action_util.h, adhering to the (void) signature * Made used datatypes for oneshot mods consistently unsigned integers * Corrected callback to call clear callback when clear_oneshot_locked_mods is invoked * Simplified oneshot equals statements * Corrected return type and signature of get and set oneshot locked mods * Consolidated one shot callbacks, added initial layer callback version * Fixed non-updating one shot layer variable after timeout or other clear, added code comments * Added better one shot key docs
* Add C(), A() and G() to match already existing S() (#4673)fauxpark2019-01-251-22/+22
|
* Pointed LM Docs at expected keycodes (#4835)Jeremy Bernhardt2019-01-141-1/+1
| | | | | | | | * Pointed LM Docs at expected keycodes * Update docs/feature_advanced_keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com>
* Tidy up Mod-Tap shortcuts (#4806)fauxpark2019-01-081-17/+17
|
* Update feature_advanced_keycodes.md (#3672)Kyle Brown2018-12-281-1/+1
| | | | | | | | | | * Update feature_advanced_keycodes.md Probably a better way to word it, but I've solved this issue on reddit several times, had to solve this for friends, ect. It's something worth being in the docs as it's a common issue, and not always intuitive. I have offered this change as I was told by several people "It was never mentioned in the docs". * Update feature_advanced_keycodes.md Clear up what was meant to be said.
* Enhance documentation for Tap-Hold functions (#4628)Drashna Jaelre2018-12-141-4/+9
|
* Add standard definitions for ALGR and KC_ALGR (#4389)Konstantin Đorđević2018-12-121-2/+2
| | | | | | | | | | | | | | * 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
* Clarify the Mod Tap defines in documentation (#4352)Drashna Jaelre2018-11-061-15/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | * Fix up Mod Tap settings keys * Change link names * permissive hold wordsmith Co-Authored-By: drashna <drashna@live.com> * ignore mod tap wordsmithing Co-Authored-By: drashna <drashna@live.com> * grammar fix Co-Authored-By: drashna <drashna@live.com> * wordsmithing Co-Authored-By: drashna <drashna@live.com> * word smithing Co-Authored-By: drashna <drashna@live.com>
* Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Konstantin Đorđević2018-11-061-1/+0
| | | | | | * Remove ALTG(kc) as it's misleading and is not actually AltGr * Add temporary alias for ALGR in keyboards/planck/keymaps/pevecyan/keymap.c
* Docs: Add references to One Shot functions, and clean up formatting (#4189)Drashna Jaelre2018-10-271-5/+12
| | | | | | * Docs: Add references to One Shot functions, and clean up formatting * Update PR based on @mechmerlin's recommendations
* Add caveats for shifted characters (#4192)Drashna Jaelre2018-10-221-6/+14
| | | | | | | | | | | | | | | | * Add caveats for shifted characters And some formatting and grammar corrections. Closes #1037 * Fix spelling of remote * Fix spelling error * Remote not Remove * Remote not Remove
* Specify max layers supported in layer keycodesDrashna Jaelre2018-10-101-2/+2
|
* Added link to One Shot KeysBrian Choromanski2018-10-091-1/+1
|
* Added OSL to list of layer togglesBrian Choromanski2018-10-091-0/+1
|
* Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵fauxpark2018-08-301-47/+67
| | | | (#3799)
* Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)fauxpark2018-08-291-6/+4
| | | | | | | | * Mask off keycode/layer/mod where possible in LT(), MT(), etc. * Don't need these parentheses * Put back parentheses for order of operations
* Dedupe shifted keycodes listingfauxpark2018-08-111-29/+1
|
* Docs: Clarify "right" -> "right-handed" (#3507)Evan Travers2018-07-261-1/+1
| | | | I couldn't understand this sentence at first owing to the confusion between right meaning "correct," and right meaning "right-handed."
* Overhaul to keycode related docsDrashna Jaelre2018-07-151-0/+6
| | | | | | | | * 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
* Add documentation for TAPPING_FORCE_HOLD (#2957) (#3320)Nicolas Schodet2018-07-061-0/+28
| | | Also improve documentation for related settings.
* Fix up info boxes.skullY2018-05-071-4/+2
|
* Rework layer function docs (#2656)Mike Kozlowski2018-04-211-9/+10
| | | | | | * Rework layer function docs * Update per PR feedback
* Fixes and updates to docs (#2611)Drashna Jaelre2018-03-251-3/+5
| | | | | | | | | | | | | | | | | | | | * Fix advanced keycode headers * Add caveat for OSM over Remote Desktop * Hopefully add better anchors to docs * Add Action code list reference * Formatting of RGB Underglow doc * Add brew update issue on macOS * Revert formatting * Revert RGB doc formatting * Make Config Options doc's sections linkable
* Add macro for momentarily switching to a layer while some mods are active ↵snyman2018-03-201-1/+2
| | | | | | | | | | | | | (#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
* Add a little aside explaining that shifted keys with mod-tap doesn't work ↵fauxpark2018-03-011-1/+7
| | | | (#2446)
* Trim trailing whitespacefauxpark2017-12-091-1/+1
|
* Format keycode tablesfauxpark2017-12-091-23/+23
|
* Convert all headings to Title Casefauxpark2017-12-091-4/+4
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-05 02:14:38 +0000