Package: vocola2
SynopsisVocola is avoicecommandlanguage — a language for
creating commands to control a computer by voice — created by Rick
Mohr.  Two versions are available: Vocola 2 works with Dragon
NaturallySpeaking (DNS) and Vocola 3 works with Windows Speech
Recognition (WSR) on Windows 8, 7, and Vista.  This repository contains
the source code for Vocola 2.  While DNS and WSR handle the heavy
lifting, Vocola (pronounced "vo-CO-luh") concentrates on features and
ease of use.  In particular, Vocola offers the following:Easy to use:Simple, concise command syntax—most commands are one-linersEasy to view and modify commandsChanged commands are loaded automaticallyLarge set of useful sample commandsFreeFeatures:Create commands which capture any dictated wordsUse concise number ranges, optional words, and inline word listsSpecify different actions for variable wordsSpeak a continuous sequence of commandsRe-use work with include files and user-defined functionsComplete documentation can be found at theVocola website.ExamplesHere are four voice commands defined in Vocola:Copy That = {Ctrl+c};
Copy to WordPad = {Ctrl+a}{Ctrl+c} AppBringUp(WordPad);
1..40 (Left | Right | Up | Down) = {$2_$1};
Sort by (Date=e | Sender=n | Subject=s) = {Alt+v}o $1;The first is a simple keystroke command—saying "Copy That" sends the
keystroke Control-C, which copies the current selection to the
clipboard.  The great majority of commands needed for controlling a
computer by voice are simple keystroke commands like this.The second command, invoked by saying "Copy to WordPad", copies a window
of text (Control-A selects all text and Control-C copies it) and brings
up the WordPad editor (using the built-in function AppBringUp).The third command allows controlling the cursor, by saying for example
"3 Left" to move left three characters, or "6 Down" to move down six
lines.  Spoken words match variable terms on the left and are
substituted into the keystroke sequence on the right.  For example, when
saying "3 Left" the spoken "3" matches the numeric range1..40and the
spoken "Left" matches the alternative set(Left | Right | Up | Down).
The keystroke sequence{Left 3}is constructed and sent, and the
cursor moves left three characters.The fourth command allows sorting messages in Mozilla's Thunderbird
Mailer, by saying "Sort by Date", "Sort by Sender", or "Sort by
Subject".  The matched word "Date", "Sender", or "Subject", causes the
appropriate keystroke "e", "n", or "s" to be inserted into the keystroke
sequence, choosing the desired option in Thunderbird's View > Sort menu.Why a custom voice command language?Other systems for defining voice commands are grafted onto existing
programming languages.  This means you can program any behavior you
want, but you're stuck with the syntactic overhead of the base language.
In contrast, Vocola is designed specifically as a voice command
language, not as a general-purpose programming language.  This means you
can write quickly and concisely the great majority of voice commands you
need, and use another language in the few cases where you need more
power.When I (Rick) switched from the Dragon Macro Language to Vocola I was
able to convert all but two of my 200+ Dragon macros (achieving a source
line count reduction of roughly 6:1) and at this writing use well over
1,000 Vocola commands.InstallationNatlink and Vocola2 have been upgraded to Python 3-First install Natlink to the latest version.The current Vocola2 is partly stable, and can be installed via pip:
-pip install vocola2Instructions for installing the latest released version can be found athttp://vocola.net/v2/InstallVocola.aspInstructions for the developersTo install the version checked out in your git repository,
-first uninstall vocola:pip uninstall vocola2-In your root of your repository:pip install -e .-You can now edit the files in your (Forked) repository, the changes will reflect the state of
you packages in the site-packages directory immediately.-When you are satisfied with a release, take the following steps:
-change the release number ininit.py of vocola2.update the version number requirement of any dependancies in pyproject.toml..
-do a localpip uninstall vocola2-commit and push your git directoryThen:flit build
flit publishTestsTo be written: describe and show how to run the tests with code
examples.ContributorsTo be written: let people know how they can dive into the project,
include important links to things like issue trackers, irc, twitter
accounts if applicable.  Contact contributors.LicenseMIT (see LICENSE.txt)Location of Samplessample  commands  installed with Vocolas2 will be installed in:
the Lib\site-packages\vocola2\samples subfolder of your
Python installation.  Good ones to start with include msedge.vcl for sending commands to Microsoft Edge.