summaryrefslogtreecommitdiff
path: root/docs/feature_stenography.md
AgeCommit message (Collapse)Author
2022-06-23Refactor steno and add `STENO_PROTOCOL = [all|txbolt|geminipr]` (#17065)precondition
* Refactor steno into STENO_ENABLE_[ALL|GEMINI|BOLT] * Update stenography documentation * STENO_ENABLE_TXBOLT → STENO_ENABLE_BOLT TXBOLT is a better name but BOLT is more consistent with the pre-existing TX Bolt related constants, which all drop the "TX " prefix * Comments * STENO_ENABLE_[GEMINI|BOLT|ALL] → STENO_PROTOCOL = [geminipr|txbolt|all] * Add note on lacking V-USB support * Clear chord at the end of the switch(mode){send_steno_chord} block * Return true if NOEVENT * update_chord_xxx → add_xxx_key_to_chord * Enable the defines for all the protocols if STENO_PROTOCOL = all * Mention how to use `steno_set_mode` * Set the default steno protocol to "all" This is done so that existing keymaps invoking `steno_set_mode` don't all suddenly break * Add data driver equivalents for stenography feature * Document format of serial steno packets (Thanks dnaq) * Add missing comma
2022-05-20[Docs] Update Steno Keycode Table (#17155)Kyle McCreery
2021-11-17Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-17Call steno_set_mode inside eeconfig_init_user in the doc (#15176)Alexis Jeandeau
2021-10-19Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-10-20[DOCS] Fix the STENO_COMBINEDMAP table (#14883)precondition
2021-09-14[Docs] Clean up some code block languages (#14434)Ryan
2021-08-18Steno combinedkeys (#12538)freqmod
* Add support for steno keys that press adjacent keys simultaniously * Add some docs for steno combined keys
2021-01-30[Docs] Use HTTPS for images and links where possible (#11695)Ryan
2020-12-28Ensure single newline at EOF for core files (#11310)Ryan
2020-07-11fix typo (#9695)shela
2020-03-15[Docs] Random Fixes (#8340)James Young
* fix CLI section links in the Summary * fix heading in Pointing Device doc * fix headings in PS/2 Mouse Support doc * add explicit section ids to I2C Master Driver doc * reformat GPIO Controls table Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.) Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function. * migrate changes from I2C Master Driver doc to Japanese translation * add explicit anchors to I2C Master Driver docs * fix code block language markers The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work. Good: ```c Bad: ```C * restore Japanese I2C Master Driver doc to current master Can't update the internal tracking references accurately until the changes to the English doc are committed to master. * add explicit anchors to edited files * change ChibiOS/ARM to ARM/ChibiOS Because ARM/ATSAM is also a thing that exists. * fix code block language markers again Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase. * add section anchors to cli.md * restore table formatting on GPIO Control doc * remove changes to _summary.md
2020-03-14Update link for Learn Plover google site (#8410)Andy Jack
2018-04-07Improve state/chord handling and clean up namespaceSeebs
Some values that can never, ever, change were held in local variables, rather than in PROGMEM. Fixed. Change "pressed" to a signed int so the test for < 0 makes sense, and to avoid possible weird failure modes in the case where a key release comes in when pressed is already zero. (Shouldn't happen, sure, but computers are weird.) A lot of things in process_steno had external linkage for no particular reason. They've been marked static. Stuff still builds. Distinguish between currently-held keys and keys that have been held, and expose these values through a nicely-named API so other code could, say, check on the current set of steno chording in order to make displays. Also in passing fix up the "state" value having external linkage so it could clash with other people's variable declarations. The API also provides hooks for key processing and steno chord events, so you can monitor those events without having to run in matrix_scan_user and recheck the values directly. Also document these. There is no path through processing a key that doesn't end with a return false, so the nested return foo() are gone and we just return false.
2017-12-09Fix some of the more obvious typosfauxpark
2017-10-29Fixed various feature linksJeremy Cowgar