## Synopsis
Vocola is a **vo**ice **co**mmand **la**nguage — 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-liners
* Easy to view and modify commands
* Changed commands are loaded automatically
* Large set of useful sample commands
* Free
Features:
* Create commands which capture any dictated words
* Use concise number ranges, optional words, and inline word lists
* Specify different actions for variable words
* Speak a continuous sequence of commands
* Re-use work with include files and user-defined functions
Complete documentation can be found at the <a
href="http://vocola.net/">Vocola website</a>.
## Examples
Here 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 range `1..40` and 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.
## Installation
Natlink 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 vocola2
Instructions for installing the latest released version can be found at
http://vocola.net/v2/InstallVocola.asp
## Instructions for the developers
To install the version checked out in your git repository,
-first uninstall vocola:
```
pip uninstall vocola2
```
-In your root of your repository:
```flit build
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 in __init__.py of vocola2.
- update the version number requirement of any dependancies in pyproject.toml..
-do a local `pip uninstall vocola2`
-commit and push your git directory
Then:
```
flit build
flit publish
```
## Tests
To be written: describe and show how to run the tests with code
examples.
## Contributors
To 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.
## License
MIT (see LICENSE.txt)
# Location of Samples
sample 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.
Raw data
{
"_id": null,
"home_page": "http://vocola.net/v2/",
"name": "vocola2",
"maintainer": "Quintijn Hoogenboom",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "q.hoogenboom@antenna.nl",
"keywords": "dragon,speech,dictation,dictation-toolbox,unimacro,natlink",
"author": "Mark Lillibridge",
"author_email": "mdl@alum.mit.edu",
"download_url": "https://files.pythonhosted.org/packages/23/4f/a877247c042171c22795ddd03f303687c20c59bfcd63d6b8c046ed94bfb6/vocola2-3.1.9.tar.gz",
"platform": null,
"description": "## Synopsis\n\nVocola is a **vo**ice **co**mmand **la**nguage — a language for\ncreating commands to control a computer by voice — created by Rick\nMohr. Two versions are available: Vocola 2 works with Dragon\nNaturallySpeaking (DNS) and Vocola 3 works with Windows Speech\nRecognition (WSR) on Windows 8, 7, and Vista. This repository contains\nthe source code for Vocola 2. While DNS and WSR handle the heavy\nlifting, Vocola (pronounced \"vo-CO-luh\") concentrates on features and\nease of use. In particular, Vocola offers the following:\n\nEasy to use:\n\n* Simple, concise command syntax\u2014most commands are one-liners\n* Easy to view and modify commands\n* Changed commands are loaded automatically\n* Large set of useful sample commands\n* Free\n\nFeatures:\n\n* Create commands which capture any dictated words\n* Use concise number ranges, optional words, and inline word lists\n* Specify different actions for variable words\n* Speak a continuous sequence of commands\n* Re-use work with include files and user-defined functions\n\nComplete documentation can be found at the <a\nhref=\"http://vocola.net/\">Vocola website</a>.\n\n\n## Examples\n\nHere are four voice commands defined in Vocola:\n\n Copy That = {Ctrl+c};\n Copy to WordPad = {Ctrl+a}{Ctrl+c} AppBringUp(WordPad);\n 1..40 (Left | Right | Up | Down) = {$2_$1};\n Sort by (Date=e | Sender=n | Subject=s) = {Alt+v}o $1;\n\nThe first is a simple keystroke command\u2014saying \"Copy That\" sends the\nkeystroke Control-C, which copies the current selection to the\nclipboard. The great majority of commands needed for controlling a\ncomputer by voice are simple keystroke commands like this.\n\nThe second command, invoked by saying \"Copy to WordPad\", copies a window\nof text (Control-A selects all text and Control-C copies it) and brings\nup the WordPad editor (using the built-in function AppBringUp).\n\nThe third command allows controlling the cursor, by saying for example\n\"3 Left\" to move left three characters, or \"6 Down\" to move down six\nlines. Spoken words match variable terms on the left and are\nsubstituted into the keystroke sequence on the right. For example, when\nsaying \"3 Left\" the spoken \"3\" matches the numeric range `1..40` and the\nspoken \"Left\" matches the alternative set `(Left | Right | Up | Down)`.\nThe keystroke sequence `{Left 3}` is constructed and sent, and the\ncursor moves left three characters.\n\nThe fourth command allows sorting messages in Mozilla's Thunderbird\nMailer, by saying \"Sort by Date\", \"Sort by Sender\", or \"Sort by\nSubject\". The matched word \"Date\", \"Sender\", or \"Subject\", causes the\nappropriate keystroke \"e\", \"n\", or \"s\" to be inserted into the keystroke\nsequence, choosing the desired option in Thunderbird's View > Sort menu.\n\n\n## Why a custom voice command language?\n\nOther systems for defining voice commands are grafted onto existing\nprogramming languages. This means you can program any behavior you\nwant, but you're stuck with the syntactic overhead of the base language.\nIn contrast, Vocola is designed specifically as a voice command\nlanguage, not as a general-purpose programming language. This means you\ncan write quickly and concisely the great majority of voice commands you\nneed, and use another language in the few cases where you need more\npower.\n\nWhen I (Rick) switched from the Dragon Macro Language to Vocola I was\nable to convert all but two of my 200+ Dragon macros (achieving a source\nline count reduction of roughly 6:1) and at this writing use well over\n1,000 Vocola commands.\n\n\n## Installation\n\nNatlink and Vocola2 have been upgraded to Python 3\n\n-First install Natlink to the latest version.\n\nThe current Vocola2 is partly stable, and can be installed via pip:\n-pip install vocola2\n\nInstructions for installing the latest released version can be found at\nhttp://vocola.net/v2/InstallVocola.asp\n\n## Instructions for the developers\n\nTo install the version checked out in your git repository,\n-first uninstall vocola:\n```\npip uninstall vocola2\n```\n-In your root of your repository: \n```flit build\npip install -e .\n```\n\n\n-You can now edit the files in your (Forked) repository, the changes will reflect the state of\nyou packages in the site-packages directory immediately. \n\n-When you are satisfied with a release, take the following steps:\n-change the release number in __init__.py of vocola2.\n- update the version number requirement of any dependancies in pyproject.toml..\n-do a local `pip uninstall vocola2`\n-commit and push your git directory\n\nThen: \n```\nflit build\nflit publish\n```\n\n\n## Tests\n\nTo be written: describe and show how to run the tests with code\nexamples.\n\n\n## Contributors\n\nTo be written: let people know how they can dive into the project,\ninclude important links to things like issue trackers, irc, twitter\naccounts if applicable. Contact contributors.\n\n\n## License\n\nMIT (see LICENSE.txt)\n\n\n\n\n\n\n# Location of Samples\n\nsample commands installed with Vocolas2 will be installed in:\nthe Lib\\site-packages\\vocola2\\samples subfolder of your \nPython installation. Good ones to start with include msedge.vcl for sending commands to Microsoft Edge.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Vocola",
"version": "3.1.9",
"project_urls": {
"Homepage": "http://vocola.net/v2/"
},
"split_keywords": [
"dragon",
"speech",
"dictation",
"dictation-toolbox",
"unimacro",
"natlink"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cf19f5df39cecfd153af7c0b7d433b138b137390411686345e6c9a93b664a46",
"md5": "a566288630b46391cc2a6b32883aacfe",
"sha256": "0c0ce73d227f89b59d46404430f4c5b060c11779ace9ab38df1c27640fd6e41c"
},
"downloads": -1,
"filename": "vocola2-3.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a566288630b46391cc2a6b32883aacfe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 770335,
"upload_time": "2023-11-24T17:59:15",
"upload_time_iso_8601": "2023-11-24T17:59:15.831508Z",
"url": "https://files.pythonhosted.org/packages/0c/f1/9f5df39cecfd153af7c0b7d433b138b137390411686345e6c9a93b664a46/vocola2-3.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "234fa877247c042171c22795ddd03f303687c20c59bfcd63d6b8c046ed94bfb6",
"md5": "be5bb6f36db7a2dfeb1268602f83578a",
"sha256": "caf1c06704139a610eb25f1bd18c8ebdcb986afad9bf425117912eb50d462c8e"
},
"downloads": -1,
"filename": "vocola2-3.1.9.tar.gz",
"has_sig": false,
"md5_digest": "be5bb6f36db7a2dfeb1268602f83578a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 751861,
"upload_time": "2023-11-24T17:59:17",
"upload_time_iso_8601": "2023-11-24T17:59:17.979463Z",
"url": "https://files.pythonhosted.org/packages/23/4f/a877247c042171c22795ddd03f303687c20c59bfcd63d6b8c046ed94bfb6/vocola2-3.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 17:59:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vocola2"
}
JSON