plugins for wvkbd using swipeGuess
Documentation: Add man pages in scdoc format
| -rw-r--r-- | SwipeBehavior.7.scd | 46 | ||||
| -rw-r--r-- | sb_picker.sh.1.scd | 25 | ||||
| -rwxr-xr-x | sb_predictor.sh | 1 | ||||
| -rw-r--r-- | sb_predictor.sh.1.scd | 27 |
4 files changed, 98 insertions, 1 deletions
diff --git a/SwipeBehavior.7.scd b/SwipeBehavior.7.scd new file mode 100644 index 0000000..79061a2 --- /dev/null +++ b/SwipeBehavior.7.scd @@ -0,0 +1,46 @@ +SwipeBehavior(7) "SwipeBehaviors" + +# NAME +SwipeBehavior - provide function for swipe keyboard + +# SYNOPSIS + +``` +wvkbd -O | sb_something.sh +``` + +# DESCRIPTION + +A _SwipeBehavior_ is a program which provides extra functionality to a swipe-capable keyboard. + +. The swipe-capable keyboard writes a line of output, representing what keys were intersected during a swipe. +. The _SwipeBehavior_ acts on that. +. This repeats as you use the keyboard. +. When the swipe-capable keyboard closes its stream, the _SwipeBehavior_ quits itself. + +A _SwipeBehavior_ could do many things +- typing words +- prompt the user for more input +- log your keystrokes for the NSA + +So, you should obviously only use trustworthy software as your _SwipeBehavior_ (i.e. free software which you have audited yourself). + +# EXAMPLES + +To use a _SwipeBehavior_ linked to by *swipeB* in SXMO-sway,++ +put this in your profile and relog. + +``` +export KEYBOARD_ARGS="-O | swipeB" +``` + +Then you can choose your preferred behavior using a symlink, e.g. + +``` +ln -s "$(which sb_something.sh)" ~/.local/bin/swipeB +``` + +and reopen the keyboard. + +# SEE ALSO +*suggpicker*(1) *wvkbd*(1) diff --git a/sb_picker.sh.1.scd b/sb_picker.sh.1.scd new file mode 100644 index 0000000..0e63b10 --- /dev/null +++ b/sb_picker.sh.1.scd @@ -0,0 +1,25 @@ +sb_picker.sh(1) "SwipeBehaviors" + +# NAME +sb_picker.sh - SwipeBehavior to pick swipeGuessed words + +# DESCRIPTION + +This *SwipeBehavior*(7) types words, and has multiple behaviors +- If a swipe has only one high-ranking match, type that word +- Otherwise, present up to 5 words in *suggpicker*(1) + +# DEPENDENCIES + +- *suggpicker*(1) +- *swipeGuess*(1) +- *mapScore*(1) +- *completelyTypeWord.sh* +- _~/.local/share/sxmo/words.txt_++ +Lexicon sorted by swipe length +- _~/.local/share/sxmo/keyboard.map.tsv_++ +tsv representation of hex-grid keyboard layout++ +used for ranking choices + +# SEE ALSO +*mapScore*(1) *suggpicker*(1) *swipeGuess*(1) *SwipeBehavior*(7) diff --git a/sb_predictor.sh b/sb_predictor.sh index 7fd4998..f78c943 100755 --- a/sb_predictor.sh +++ b/sb_predictor.sh @@ -6,7 +6,6 @@ tw="$kl/pred.tfw" complete="$XDG_RUNTIME_DIR/pred.complete.bool" words=~/.local/share/sxmo/words.txt twow=~/.local/share/sxmo/count_2w.txt -keymap=~/.local/share/sxmo/keyboard.map.tsv rm -f "$sock" "$lw" "$complete" mkdir -p "$kl" chmod 700 "$kl" diff --git a/sb_predictor.sh.1.scd b/sb_predictor.sh.1.scd new file mode 100644 index 0000000..c6ed8ec --- /dev/null +++ b/sb_predictor.sh.1.scd @@ -0,0 +1,27 @@ +sb_predictor.sh(1) "SwipeBehaviors" + +# NAME +sb_predictor.sh - SwipeBehavior to predict your next word + +# DESCRIPTION + +- All strokes are logged to remember the previous word +- On swipe, provides a multiple choice *swipeGuess*(1) with *suggpicker*(1) +- On *suggpicker*(1) choice, provide word completions or next word predictions +- On space, provides next word predictions + +# DEPENDENCIES + +- *wl-ime-type*(1) +- *suggpicker*(1) +- *swipeGuess*(1) +- *quick5* +- _~/.local/share/sxmo/words.txt_++ +Lexicon sorted by swipe length +- _~/.local/share/sxmo/count_2w.txt_++ +List of bigrams for predictions + +# SEE ALSO +*suggpicker*(1) *swipeGuess*(1) *wl-ime-type*(1) *SwipeBehavior*(7) + + |