Commit Graph

36 Commits

Author SHA1 Message Date
JayceFayne
d02cefe613
implement tap_code16_delay () 2022-07-23 19:21:20 +01:00
Ryan
3ecb0a80af
Feature-ify Send String () 2022-07-02 22:10:08 +10:00
IskandarMa
f52cc210b8
[Docs] feature_macro.md: minor formatting fix () 2022-02-05 08:15:21 +11:00
Tuk Bredsdorff
8fe320baa6
Fix keymap.json macro example () 2022-01-13 21:55:48 +00:00
Albert Y
a88dc08643
[Docs] Note the order of enumerated custom keycodes ()
Co-authored-by: filterpaper <filterpaper@localhost>
2022-01-03 09:07:58 -08:00
Buttenup
db358d171d
Update feature_macros.md ()
* Update feature_macros.md

Added a link to the usage of SAFE_RANGE as this wasn't clear to me when I visited this page in isolation.

* Fix typo

Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-12-27 13:57:09 +11:00
Zach White
08ce0142ba
Macros in JSON keymaps ()
* macros in json keymaps

* add advanced macro support to json

* add a note about escaping macro strings

* add simple examples

* format json

* add support for language specific keymap extras

* switch to dictionaries instead of inline text for macros

* use SS_TAP on the innermost tap keycode

* add the new macro format to the schema

* document the macro limit

* add the json keyword for syntax highlighting

* fix format that vscode screwed up

* Update feature_macros.md

* add tests for macros

* change ding to beep

* add json support for SENDSTRING_BELL

* update doc based on feedback from sigprof

* document host_layout

* remove unused var

* improve carriage return handling

* support tab characters as well

* Update docs/feature_macros.md

Co-authored-by: Nick Brassel <nick@tzarc.org>

* escape backslash characters

* format

* flake8

* Update quantum/quantum_keycodes.h

Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-11-22 11:11:35 -08:00
Ryan
f529580860
Basic keycode overhaul () 2021-11-03 22:22:17 -07:00
precondition
2395069b0b
[Docs] New section to modifier docs: Checking Modifier State ()
* 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
2021-02-28 16:42:17 +11:00
Ryan
3345ce2686
Add tap_code_delay(code, delay) ()
Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-02-17 07:26:52 +11:00
Ryan
415d683ea7
Remove unused action_get_macro() usages in user files () 2021-01-11 01:25:45 -08:00
Chas
3300164065
Typo fix: Useful function -> Useful Functions ()
Thanks!
2020-12-30 01:32:30 +09:00
Ryan
501f2fdef1
Normalise include statements in core code ()
* Normalise include statements in core code

* Missed one
2020-12-11 13:45:24 +11:00
Konstantin Đorđević
02781979d6
[Docs] Improve Unicode documentation () 2020-06-20 21:58:48 +01:00
Konstantin Đorđević
370577e4ed
Add *OPT aliases for *ALT keycodes and macros () 2020-04-12 11:37:55 -07:00
Drashna Jaelre
5117dff6a2
Add Post Processing to process_record ()
* Improve process_record system

Code based on @colinta's

* Rename and better handle functions

* Fix incorrect function call to process_record_user

* Add documentation for post_process_record

* Add both get_event_keycode and get_record_keycode functions

And add some comments about these functions

* Update code format

* Cleanup merge artifacts
2020-03-23 00:29:05 +11:00
Nick Brassel
444fd3b1cc
Add support for delays in send_string. () 2020-02-27 20:38:19 +11:00
Jez Cope
530c997638
Add link to "Useful functions" in macro docs ()
* Add link to "Useful functions" in macro docs

Help people find additional features they can activate within a macro

* Update docs/feature_macros.md

Co-Authored-By: Drashna Jaelre <drashna@live.com>

Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2020-02-23 12:50:11 -08:00
fauxpark
5a6737a778 Send string keycode tweaks () 2019-11-25 23:16:58 -08:00
Jez Cope
9d97e47df4 [Docs] Update Super ALT↯TAB to remove use of unregister_code16 ()
The code as originally listed didn't work for me, but replacing `unregister_code16(LALT(KC_TAB));` with `unregister_code(KC_LALT);` fixes the problem and causes the macro to work as intended.

Thanks to folks on Discord for helping me figure this out.
2019-05-04 09:46:44 -07:00
roguepullrequest
e7e13ebdd7 [Docs] Adding Alt↯Tab example macro () 2019-04-14 11:32:11 -07:00
Drashna Jaelre
c534a4c775 [Docs] Smallish overhaul of the docs ()
* Fix up Common functions doc

* Add to extra commands to flashing doc

* Rearrange and touch up Macros

* Expand Newbs Flashing guide

* Update process_record documentation

* Add git to best practices name in sidebar

* Expand FAQ for build/flashing

* Add deprecated info to functions

* Update docs/feature_macros.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/feature_macros.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/keymap.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/newbs_flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/newbs_flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/custom_quantum_functions.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/faq_build.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/feature_macros.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/keymap.md

Co-Authored-By: drashna <drashna@live.com>

* Fix up Common functions doc

* Make pre-init example accurate

* Update docs/custom_quantum_functions.md

Co-Authored-By: drashna <drashna@live.com>

* Zadig Driver catchall

* Spelling Depriciated

* Completely remove fn_actions section
2019-03-18 14:22:02 -07:00
noroadsleft
384fef72d3 Replace instances of KEYMAP with LAYOUT
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-21 23:19:26 -08:00
Drashna Jaelre
02d44beb44 Fix up tap_code functionality ()
* Add delay in Tap Code to avoid issues

I think a few people have reporting issues with it working properly, and it may be a timing issue.  The 'register_code' uses this sort of delay in some of the functions, and
this is probably why.

Adding the 100ms delay should hopefully fix any issues with it.

* Make tap_code delay configurable

* Update documentation

* Bring tap_code16 inline with changes

* Fix type for tap_code16

Bad copy-paste job

* Just use the value check for the define

* Clarify timing in docs

Co-Authored-By: drashna <drashna@live.com>

* Wordsmithing

Co-Authored-By: drashna <drashna@live.com>
2018-12-14 09:01:58 -08:00
Drashna Jaelre
fb900e2ad1 Fix macro docs to be consistent with keyboard template () 2018-12-11 09:11:35 -08:00
Drashna Jaelre
26f4e7031a Add tap_code function ()
* Add tap_code

* formatting

* Doc clarification

* Rename variable to make more consistent
2018-10-01 20:53:47 -04:00
skullY
303f425c6b Fix up info boxes. 2018-05-07 22:46:26 -07:00
Drashna Jael're
3f1d147529 Add SS_RALT for AltGR usage in macros 2018-03-09 13:15:10 -05:00
Mitchell van Manen
31cae1f1bd Update feature_macros.md ()
break statements are never reached due to the return statement, so unnecessary
2018-03-01 08:05:15 -08:00
fauxpark
bb53635f33 Trim trailing whitespace 2017-12-09 10:46:11 -05:00
fauxpark
af37bb2f78 Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
fauxpark
7b0356d1d4 Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
Gilbert Consellado
7ff96877d2 added SS_LSFT to featured macros 2017-11-20 12:25:42 -05:00
Balz Guenat
858c09f370 add example keymap 2017-11-16 09:39:00 -05:00
Balz Guenat
179d64d33c extend macro docs a bit 2017-11-16 09:39:00 -05:00
skullydazed
67cc5cebc0 Restructure the hardware and feature docs to make things easier to find ()
* fix  by documenting more config.h options

* Clean up and organize documentation
2017-10-24 20:34:28 -07:00