This is a plugin for the open source stenography program Plover
Requires Plover version 4.0.0 or later
Run Plover entirely inside your terminal window!
- Open Plover
- Navigate to the Plugin Manager tool
- Select
plover_console_ui
in the list - Click install
Or directly install plover_console_ui
into Plover's python environment using plover -s plover_plugins install plover_console_ui
- Note: The plover command is available under slightly different names depending on your OS, relative to your installation directory.
- Windows:
C:\Program Files (x86)\Open Steno Project\Plover 4.0.0\plover_console.exe
- macOS:/Applications/Plover.app/Contents/MacOS/Plover
- Linux:plover.AppImage
For more information on Plover's Command Line Reference, see The Plover Docs.
Start Plover with the -g option:
plover -g console
If your shell returns command not found: plover
or a similar error, refer to Getting Started to access the plover
command.
Due to some Windows workaround code (in Plover), this plugin does not work well on the packaged Windows build
Here's a launcher that works:
python -m plover -g console
Yes, it requires essentially 'run from source'... I'm sorry
If your shell returns command not found: plover
or a similar error, refer to Getting Started to access the plover
command.
Plover commands are all functional:
{PLOVER:LOOKUP}
{PLOVER:ADD_TRANSLATION}
{PLOVER:SUSPEND}
{PLOVER:RESUME}
{PLOVER:TOGGLE}
{PLOVER:FOCUS}
{PLOVER:CONFIGURE}
Note for the commands which do window manager focus:
LOOKUP
ADD_TRANSLATION
FOCUS
CONFIGURE
This console_ui
only knows which window it lives in if that window has focus on start-up
Otherwise: expect the focus feature not to work
These key commands are always available when console_ui
has focus:
Ctrl-C
orCtrl-Q
: Exits PloverPageUp/PageDown
: Scrolls theconsole
buffer up/down(Note: if anything new is added to
console
it will auto-scroll back down)
The help
command is always available and will show all the currently
available commands
If a command has the description ...
there are further commands
contained inside
Commands can be partially entered
m
to use themachine
command
Once you know your way around, you don't need to enter each menu one at a time
col for goldenrod
from the top level
Case is ignored
configure
is the same asCONFIGURE
To get back to the previous menu level, press Enter
on its own
If a command has <>
in its description it takes one or more arguments. The type
of the argument is between the <>
addtranslation
: entersADD_TRANSLATION
mode- Tab/Shift-Tab to move between
Strokes
,Output
and choose dictionary field- When in the 'choose dictionary' field you can press left/right arrows to cycle (writable) dictionaries
- Tab/Shift-Tab to move between
lookup
: entersLOOKUP
modeoutput
: toggles Plover output on/offreset
: reconnects currentmachine
(reloads dictionaries)suggestions
: toggles suggestions displaytape
: toggles paper tape displaysavetape
: saves content of tape to a filedictionaries
: configure dictionariesadd
: add a dictionary by its file pathremove
: remove a dictionary by displayed numbertoggle
: toggle a dictionary by displayed numberpriority
: prioritise a dictionary by displayed number (to its new number)
machine
: configuremachine
options
: configure current machine options- (One 'set machine' command per installed
machine
plugin)
system
: configuresystem
- (One 'set system' command per installed
system
plugin)
- (One 'set system' command per installed
configure
: Plover configuration commands (changes reload dictionaries)space_placement
: (Before Output|After Output)start_attached
: (True|False)start_capitalized
: (True|False)undo_levels
: Number of undo levelslog_file_name
: Name of the log fileenable_stroke_logging
: Enable/Disable stroke loggingenable_translation_logging
: Enable/Disable translation loggingauto_start
: If 'True' enable Plover output on start-upextensions
: Enable/Disable extension commands- (One 'toggle extension' command per installed
extension
plugin)
- (One 'toggle extension' command per installed
colors
: setconsole_ui
colorsThese commands take web color names
Color hexes are also supported (e.g.
#ffffff
for white)(Note: not all terminals support all colors)
foreground
: set foreground colorbackground
: set background color
loglevel
: configure which Plover log messages will get printed toconsole_ui
WARNING
: any logs atWARNING
or above will be printedCRITICAL
: any logs atCRITICAL
or above will be printedERROR
: any logs atERROR
or above will be printedINFO
: any logs atINFO
or above will be printedDEBUG
: any logs atDEBUG
or above will be printed
exit
: exitsconsole_ui
(and Plover)
Head to the open source repository
Issues + PRs welcome!