aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_stenography.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_stenography.md')
-rw-r--r--docs/feature_stenography.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/docs/feature_stenography.md b/docs/feature_stenography.md
index 4d7374a03..099993f85 100644
--- a/docs/feature_stenography.md
+++ b/docs/feature_stenography.md
@@ -1,16 +1,16 @@
1# Stenography in QMK 1# Stenography in QMK :id=stenography-in-qmk
2 2
3[Stenography](https://en.wikipedia.org/wiki/Stenotype) is a method of writing most often used by court reports, closed-captioning, and real-time transcription for the deaf. In stenography words are chorded syllable by syllable with a mixture of spelling, phonetic, and shortcut (briefs) strokes. Professional stenographers can reach 200-300 WPM without any of the strain usually found in standard typing and with far fewer errors (>99.9% accuracy). 3[Stenography](https://en.wikipedia.org/wiki/Stenotype) is a method of writing most often used by court reports, closed-captioning, and real-time transcription for the deaf. In stenography words are chorded syllable by syllable with a mixture of spelling, phonetic, and shortcut (briefs) strokes. Professional stenographers can reach 200-300 WPM without any of the strain usually found in standard typing and with far fewer errors (>99.9% accuracy).
4 4
5The [Open Steno Project](http://www.openstenoproject.org/) has built an open-source program called Plover that provides real-time translation of steno strokes into words and commands. It has an established dictionary and supports 5The [Open Steno Project](http://www.openstenoproject.org/) has built an open-source program called Plover that provides real-time translation of steno strokes into words and commands. It has an established dictionary and supports
6 6
7## Plover with QWERTY Keyboard 7## Plover with QWERTY Keyboard :id=plover-with-qwerty-keyboard
8 8
9Plover can work with any standard QWERTY keyboard, although it is more efficient if the keyboard supports NKRO (n-key rollover) to allow Plover to see all the pressed keys at once. An example keymap for Plover can be found in `planck/keymaps/default`. Switching to the `PLOVER` layer adjusts the position of the keyboard to support the number bar. 9Plover can work with any standard QWERTY keyboard, although it is more efficient if the keyboard supports NKRO (n-key rollover) to allow Plover to see all the pressed keys at once. An example keymap for Plover can be found in `planck/keymaps/default`. Switching to the `PLOVER` layer adjusts the position of the keyboard to support the number bar.
10 10
11To use Plover with QMK just enable NKRO and optionally adjust your layout if you have anything other than a standard layout. You may also want to purchase some steno-friendly keycaps to make it easier to hit multiple keys. 11To use Plover with QMK just enable NKRO and optionally adjust your layout if you have anything other than a standard layout. You may also want to purchase some steno-friendly keycaps to make it easier to hit multiple keys.
12 12
13## Plover with Steno Protocol 13## Plover with Steno Protocol :id=plover-with-steno-protocol
14 14
15Plover also understands the language of several steno machines. QMK can speak a couple of these languages, TX Bolt and GeminiPR. An example layout can be found in `planck/keymaps/steno`. 15Plover also understands the language of several steno machines. QMK can speak a couple of these languages, TX Bolt and GeminiPR. An example layout can be found in `planck/keymaps/steno`.
16 16
@@ -20,26 +20,26 @@ In this mode Plover expects to speak with a steno machine over a serial port so
20 20
21> Note: Due to hardware limitations you may not be able to run both a virtual serial port and mouse emulation at the same time. 21> Note: Due to hardware limitations you may not be able to run both a virtual serial port and mouse emulation at the same time.
22 22
23### TX Bolt 23### TX Bolt :id=tx-bolt
24 24
25TX Bolt communicates the status of 24 keys over a very simple protocol in variable-sized (1-5 byte) packets. 25TX Bolt communicates the status of 24 keys over a very simple protocol in variable-sized (1-5 byte) packets.
26 26
27### GeminiPR 27### GeminiPR :id=geminipr
28 28
29GeminiPR encodes 42 keys into a 6-byte packet. While TX Bolt contains everything that is necessary for standard stenography, GeminiPR opens up many more options, including supporting non-English theories. 29GeminiPR encodes 42 keys into a 6-byte packet. While TX Bolt contains everything that is necessary for standard stenography, GeminiPR opens up many more options, including supporting non-English theories.
30 30
31## Configuring QMK for Steno 31## Configuring QMK for Steno :id=configuring-qmk-for-steno
32 32
33Firstly, enable steno in your keymap's Makefile. You may also need disable mousekeys, extra keys, or another USB endpoint to prevent conflicts. The builtin USB stack for some processors only supports a certain number of USB endpoints and the virtual serial port needed for steno fills 3 of them. 33Firstly, enable steno in your keymap's Makefile. You may also need disable mousekeys, extra keys, or another USB endpoint to prevent conflicts. The builtin USB stack for some processors only supports a certain number of USB endpoints and the virtual serial port needed for steno fills 3 of them.
34 34
35```Makefile 35```makefile
36STENO_ENABLE = yes 36STENO_ENABLE = yes
37MOUSEKEY_ENABLE = no 37MOUSEKEY_ENABLE = no
38``` 38```
39 39
40In your keymap create a new layer for Plover. You will need to include `keymap_steno.h`. See `planck/keymaps/steno/keymap.c` for an example. Remember to create a key to switch to the layer as well as a key for exiting the layer. If you would like to switch modes on the fly you can use the keycodes `QK_STENO_BOLT` and `QK_STENO_GEMINI`. If you only want to use one of the protocols you may set it up in your initialization function: 40In your keymap create a new layer for Plover. You will need to include `keymap_steno.h`. See `planck/keymaps/steno/keymap.c` for an example. Remember to create a key to switch to the layer as well as a key for exiting the layer. If you would like to switch modes on the fly you can use the keycodes `QK_STENO_BOLT` and `QK_STENO_GEMINI`. If you only want to use one of the protocols you may set it up in your initialization function:
41 41
42```C 42```c
43void matrix_init_user() { 43void matrix_init_user() {
44 steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT 44 steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT
45} 45}
@@ -49,37 +49,37 @@ Once you have your keyboard flashed launch Plover. Click the 'Configure...' butt
49 49
50On the display tab click 'Open stroke display'. With Plover disabled you should be able to hit keys on your keyboard and see them show up in the stroke display window. Use this to make sure you have set up your keymap correctly. You are now ready to steno! 50On the display tab click 'Open stroke display'. With Plover disabled you should be able to hit keys on your keyboard and see them show up in the stroke display window. Use this to make sure you have set up your keymap correctly. You are now ready to steno!
51 51
52## Learning Stenography 52## Learning Stenography :id=learning-stenography
53 53
54* [Learn Plover!](https://sites.google.com/site/learnplover/) 54* [Learn Plover!](https://sites.google.com/site/learnplover/)
55* [QWERTY Steno](http://qwertysteno.com/Home/) 55* [QWERTY Steno](http://qwertysteno.com/Home/)
56* [Steno Jig](https://joshuagrams.github.io/steno-jig/) 56* [Steno Jig](https://joshuagrams.github.io/steno-jig/)
57* More resources at the Plover [Learning Stenography](https://github.com/openstenoproject/plover/wiki/Learning-Stenography) wiki 57* More resources at the Plover [Learning Stenography](https://github.com/openstenoproject/plover/wiki/Learning-Stenography) wiki
58 58
59## Interfacing with the code 59## Interfacing with the code :id=interfacing-with-the-code
60 60
61The steno code has three interceptible hooks. If you define these functions, they will be called at certain points in processing; if they return true, processing continues, otherwise it's assumed you handled things. 61The steno code has three interceptible hooks. If you define these functions, they will be called at certain points in processing; if they return true, processing continues, otherwise it's assumed you handled things.
62 62
63```C 63```c
64bool send_steno_chord_user(steno_mode_t mode, uint8_t chord[6]); 64bool send_steno_chord_user(steno_mode_t mode, uint8_t chord[6]);
65``` 65```
66 66
67This function is called when a chord is about to be sent. Mode will be one of `STENO_MODE_BOLT` or `STENO_MODE_GEMINI`. This represents the actual chord that would be sent via whichever protocol. You can modify the chord provided to alter what gets sent. Remember to return true if you want the regular sending process to happen. 67This function is called when a chord is about to be sent. Mode will be one of `STENO_MODE_BOLT` or `STENO_MODE_GEMINI`. This represents the actual chord that would be sent via whichever protocol. You can modify the chord provided to alter what gets sent. Remember to return true if you want the regular sending process to happen.
68 68
69```C 69```c
70bool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; } 70bool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; }
71``` 71```
72 72
73This function is called when a keypress has come in, before it is processed. The keycode should be one of `QK_STENO_BOLT`, `QK_STENO_GEMINI`, or one of the `STN_*` key values. 73This function is called when a keypress has come in, before it is processed. The keycode should be one of `QK_STENO_BOLT`, `QK_STENO_GEMINI`, or one of the `STN_*` key values.
74 74
75```C 75```c
76bool postprocess_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t mode, uint8_t chord[6], int8_t pressed); 76bool postprocess_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t mode, uint8_t chord[6], int8_t pressed);
77``` 77```
78 78
79This function is called after a key has been processed, but before any decision about whether or not to send a chord. If `IS_PRESSED(record->event)` is false, and `pressed` is 0 or 1, the chord will be sent shortly, but has not yet been sent. This is where to put hooks for things like, say, live displays of steno chords or keys. 79This function is called after a key has been processed, but before any decision about whether or not to send a chord. If `IS_PRESSED(record->event)` is false, and `pressed` is 0 or 1, the chord will be sent shortly, but has not yet been sent. This is where to put hooks for things like, say, live displays of steno chords or keys.
80 80
81 81
82## Keycode Reference 82## Keycode Reference :id=keycode-reference
83 83
84As defined in `keymap_steno.h`. 84As defined in `keymap_steno.h`.
85 85