summaryrefslogtreecommitdiff
path: root/docs/feature_advanced_keycodes.md
AgeCommit message (Collapse)Author
2021-02-28[Docs] New section to modifier docs: Checking Modifier State (#10550)precondition
* 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
2020-10-01Doc followup 9942 (#10473)nopunin10did
* Update feature_advanced_keycodes.md * Update mod_tap.md
2020-04-12Add *OPT aliases for *ALT keycodes and macros (#8714)Konstantin Đorđević
2020-03-21[Docs] Update layer documentation (#8371)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-05make sure all our redirects are in orderskullY
2020-03-05Add explicit id tags to externally linked headersskullY
2020-03-05break feature_advanced_keycodes.md up into multiple filesskullY
2020-02-25New feature: PERMISSIVE_HOLD_PER_KEY (#7994)ridingqwerty
* Implement 'PERMISSIVE_HOLD_PER_KEY' * Document 'PERMISSIVE_HOLD_PER_KEY' Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
2020-01-17Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859)ridingqwerty
* 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>
2019-12-08fix instructions for oneshot layer handling on key release (#7554)hmkemppainen
* 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>
2019-11-20fix feature_advanced_keycodes.md's link (#7421)Takeshi ISHII
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) ```
2019-07-01fix typoshela
2019-03-07[Docs] Add Tap Dance example to the docs (#5326)Dusty Pomerleau
* 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
2019-02-21Replace instances of KEYMAP with LAYOUTnoroadsleft
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.
2019-02-15Fix documentation about one shot tap toggleJayesh Vora
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.
2019-02-07Adds a period to the docs.Erez Zukerman
Yes, really. Revolutionary, I know!
2019-02-05Add One Shot Key callbacks (#4697)Thomas Baart
* 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
2019-01-25Add C(), A() and G() to match already existing S() (#4673)fauxpark
2019-01-14Pointed LM Docs at expected keycodes (#4835)Jeremy Bernhardt
* Pointed LM Docs at expected keycodes * Update docs/feature_advanced_keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com>
2019-01-08Tidy up Mod-Tap shortcuts (#4806)fauxpark
2018-12-28Update feature_advanced_keycodes.md (#3672)Kyle Brown
* 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.
2018-12-14Enhance documentation for Tap-Hold functions (#4628)Drashna Jaelre
2018-12-12Add standard definitions for ALGR and KC_ALGR (#4389)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-06Clarify the Mod Tap defines in documentation (#4352)Drashna Jaelre
* 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>
2018-11-06Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)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-10-27Docs: Add references to One Shot functions, and clean up formatting (#4189)Drashna Jaelre
* Docs: Add references to One Shot functions, and clean up formatting * Update PR based on @mechmerlin's recommendations
2018-10-22Add caveats for shifted characters (#4192)Drashna Jaelre
* 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
2018-10-10Specify max layers supported in layer keycodesDrashna Jaelre
2018-10-09Added link to One Shot KeysBrian Choromanski
2018-10-09Added OSL to list of layer togglesBrian Choromanski
2018-08-30Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵fauxpark
(#3799)
2018-08-29Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)fauxpark
* Mask off keycode/layer/mod where possible in LT(), MT(), etc. * Don't need these parentheses * Put back parentheses for order of operations
2018-08-11Dedupe shifted keycodes listingfauxpark
2018-07-26Docs: Clarify "right" -> "right-handed" (#3507)Evan Travers
I couldn't understand this sentence at first owing to the confusion between right meaning "correct," and right meaning "right-handed."
2018-07-15Overhaul to keycode related docsDrashna 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-07-06Add documentation for TAPPING_FORCE_HOLD (#2957) (#3320)Nicolas Schodet
Also improve documentation for related settings.
2018-05-07Fix up info boxes.skullY
2018-04-21Rework layer function docs (#2656)Mike Kozlowski
* Rework layer function docs * Update per PR feedback
2018-03-25Fixes and updates to docs (#2611)Drashna Jaelre
* 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
2018-03-20Add macro for momentarily switching to a layer while some mods are active ↵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-01Add a little aside explaining that shifted keys with mod-tap doesn't work ↵fauxpark
(#2446)
2017-12-09Trim trailing whitespacefauxpark
2017-12-09Format keycode tablesfauxpark
2017-12-09Convert all headings to Title Casefauxpark
2017-12-03update advanced_keycodes; oneshot = sticky/dead keysmmikeww
2017-11-30Fix internal links in docs/ (#2080)Devin J. Pohly
One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names.
2017-11-06333fred layout update (#1971)Fred Silberberg
* Set up tap dance for layers on the lower button. * Refactored code to share in the users directory between my two keyboard layouts. * Small keyboard layout change. * Updated documentation on oneshot usage in macros/tap dance.
2017-10-24Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed
* fix #1313 by documenting more config.h options * Clean up and organize documentation
generated by cgit v1.2.1 (git 2.18.0) at 2024-11-01 23:33:32 +0000