summaryrefslogtreecommitdiffstats
path: root/docs/feature_advanced_keycodes.md
AgeCommit message (Collapse)AuthorFilesLines
2019-03-07[Docs] Add Tap Dance example to the docs (#5326)Dusty Pomerleau1-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
2019-02-22Replace instances of KEYMAP with LAYOUTnoroadsleft1-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.
2019-02-15Fix documentation about one shot tap toggleJayesh Vora1-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.
2019-02-07Adds a period to the docs.Erez Zukerman1-1/+1
Yes, really. Revolutionary, I know!
2019-02-05Add One Shot Key callbacks (#4697)Thomas Baart1-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
2019-01-25Add C(), A() and G() to match already existing S() (#4673)fauxpark1-22/+22
2019-01-14Pointed LM Docs at expected keycodes (#4835)Jeremy Bernhardt1-1/+1
* Pointed LM Docs at expected keycodes * Update docs/feature_advanced_keycodes.md Co-Authored-By: germ <jeremythegeek@gmail.com>
2019-01-09Tidy up Mod-Tap shortcuts (#4806)fauxpark1-17/+17
2018-12-28Update feature_advanced_keycodes.md (#3672)Kyle Brown1-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.
2018-12-14Enhance documentation for Tap-Hold functions (#4628)Drashna Jaelre1-4/+9
2018-12-12Add standard definitions for ALGR and KC_ALGR (#4389)Konstantin Đorđević1-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
2018-11-06Clarify the Mod Tap defines in documentation (#4352)Drashna Jaelre1-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>
2018-11-06Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Konstantin Đorđević1-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
2018-10-27Docs: Add references to One Shot functions, and clean up formatting (#4189)Drashna Jaelre1-5/+12
* 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 Jaelre1-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
2018-10-10Specify max layers supported in layer keycodesDrashna Jaelre1-2/+2
2018-10-09Added link to One Shot KeysBrian Choromanski1-1/+1
2018-10-09Added OSL to list of layer togglesBrian Choromanski1-0/+1
2018-08-30Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵fauxpark1-47/+67
(#3799)
2018-08-30Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)fauxpark1-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
2018-08-11Dedupe shifted keycodes listingfauxpark1-29/+1
2018-07-27Docs: Clarify "right" -> "right-handed" (#3507)Evan Travers1-1/+1
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 Jaelre1-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
2018-07-06Add documentation for TAPPING_FORCE_HOLD (#2957) (#3320)Nicolas Schodet1-0/+28
Also improve documentation for related settings.
2018-05-08Fix up info boxes.skullY1-4/+2
2018-04-21Rework layer function docs (#2656)Mike Kozlowski1-9/+10
* Rework layer function docs * Update per PR feedback
2018-03-26Fixes and updates to docs (#2611)Drashna Jaelre1-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
2018-03-21Add macro for momentarily switching to a layer while some mods are active ↵snyman1-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
2018-03-01Add a little aside explaining that shifted keys with mod-tap doesn't work ↵fauxpark1-1/+7
(#2446)
2017-12-09Trim trailing whitespacefauxpark1-1/+1
2017-12-09Format keycode tablesfauxpark1-23/+23
2017-12-09Convert all headings to Title Casefauxpark1-4/+4
2017-12-03update advanced_keycodes; oneshot = sticky/dead keysmmikeww1-1/+1
2017-11-30Fix internal links in docs/ (#2080)Devin J. Pohly1-1/+1
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 Silberberg1-0/+4
* 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-25Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed1-0/+165
* fix #1313 by documenting more config.h options * Clean up and organize documentation