Install Vocola

Use the following instructions for your first installation of Vocola.
Or, see below to upgrade from an earlier version of Vocola.

Installing Vocola for the first time

1. Install Dragon NaturallySpeaking, version 3.5 or later, any edition, if not already installed.

 
2. Install Python if not already installed. Version 2.3 is recommended, with 2.0 and 2.2 also supported. Earlier and later versions are not currently supported.
    
3. Install NatLink. Choose from one of two methods:
• (recommended) Use Scott Weinstein's installer (called NatPython X.X.X there) to install NatLink and Vocola simultaneously. You must have Python 2.3 to use the installer and a version of the installer containing the latest Vocola version may not be available. In the later case, you may want to use the latest version of the installer and then upgrade the installed version of Vocola to a more recent version later.
• Or, if you're using Dragon NaturallySpeaking 7.0 or earlier, download NatLink for Python 2.3, NatLink for Python 2.2 or NatLink for Python 2.0, and follow Joel Gould's instructions (don't bother with the self-tests, which often fail). (If using NatSpeak 7.0 with Python 2.2 or 2.0, try this version of EnableNL.exe.)
   
4. Install Vocola if you did not use the installer:
1. Download the relevant Vocola zip file.
    
2. Locate where NatLink is installed. You're looking for a directory named NatLink containing a subdirectory named MacroSystem. Most likely C:\NatLink or C:\Program Files\NatLink.
    
3. Exit Dragon NaturallySpeaking if it is running.
    
4. Extract the Vocola zip file into the NatLink directory. For example, if NatLink is installed in C:\NatLink, you should choose C:\NatLink as the folder to extract to. After unpacking you should see folder NatLink\Vocola, with subfolders Commands, Doc, Exec, Samples, and possibly Simpscrp.
    
5. From the Vocola\Exec folder copy the files _vocola_main.py and VocolaUtils.py to the NatLink\MacroSystem folder. Copying these files activates Vocola's built-in voice commands.
    
6. Start Dragon NaturallySpeaking.
    
5. Associate the .vcl file extension (used for Vocola command files) with your favorite text editor. This allows you to open your Vocola files using built-in voice commands. An easy way to set up this association is to right-click on any .vcl file (such as Vocola\Samples\notepad.vcl), select "Open With" or "Open", and pick your favorite text editor (for example, Notepad).
   
   Note that Scott's installer associates the .vcl file extension with the free editor Notepad2, which it also installs.
   
   Emacs users should install gnuserv and associate the .vcl file extension with gnuclientw.exe. (Make sure the directory containing gnuclientw.exe is included in your PATH environment variable.)
    
6. Test Vocola. 
1. Copy the sample command file for Notepad (Vocola\Samples\notepad.vcl) to the <My Documents>\NatLink\Vocola folder if using the installer under pre-Vista; otherwise, use the Vocola\Commands folder. 
2. Say "Start Notepad" to launch Notepad.
3. Say "Test Simple Command". The phrase "It works!" should appear.
4. Say "Edit Voice Commands". Your copy of notepad.vcl should be opened using the editor you picked in step 5.
5. Change the "Test Simple Command" command to type "It really works!"
6. Save the file, say "Switch to Notepad", and say "Test Simple Command". "It really works!" should appear.

Upgrading from an Earlier Version of Vocola

1. Locate where NatLink is installed. You're looking for a directory named NatLink containing a subdirectory named MacroSystem. Most likely C:\NatLink or C:\Program Files\NatLink. These instructions will refer to that directory by <NatLink>.
    
2. Make a backup copy of your command files (located in <NatLink>\Vocola\Commands and possibly <My Documents>\NatLink\Vocola as well).  
      
3. Update your version of NatLink if desired. This may upgrade or degrade your version of Vocola. If this results in your desired version of Vocola, stop as you are done. Note that some earlier versions of the installer may not permit independent upgrades of Vocola because they automatically "repair" any changed files by reverting them when you start Dragon NaturallySpeaking. Also, only versions of Vocola after 2.5.5 may be used to update installer installations.
    
4. Rename <NatLink>\Vocola to <NatLink>\Vocola.old. (Remove <NatLink>\Vocola.old first if it already exists.)
    
5. Download the relevant Vocola zip file.
    
6. Exit Dragon NaturallySpeaking if it is running.
    
7. Extract the Vocola zip file into <NatLink>. For example, if NatLink is installed in C:\NatLink, you should choose C:\NatLink as the folder to extract to. After unpacking you should see folder <NatLink>\Vocola, with subfolders Commands, Doc, Exec, Samples, and possibly Simpscrp.
    
8. From the <NatLink>\Vocola\Exec folder, copy the file _vocola_main.py to the <NatLink>\MacroSystem folder.
    
9. From the <NatLink>\Vocola\Exec folder, copy the file VocolaUtils.py to the <NatLink>\MacroSystem\Core folder if it exists or <NatLink>\MacroSystem if it doesn't. Both this copy and that of step 8 should replace existing files.
    
10. Copy all files from <NatLink>\Vocola.old\Commands to <NatLink>\Vocola\Commands.
     
11. Restart Dragon NaturallySpeaking