# VoiceEditor

The idea behind this editor is to be easily controllable by voice when using Dragon Naturally Speaking.
It helps in navigating around a file, the file system and it provides a type of intellisense feature
that makes chunks of parameterisable code clickable into the tesxt.

The application is written in IronPython, which is a version of Python that is part of the .NET family
of languages, making it easy to create Microsoft Windows GUIs.


INSTALLATION

0. Demo video at : https://youtu.be/Mb6CaYB4yjI 

   Videos explaining how to use the editor in detail:
   
   Overview                                                              : https://youtu.be/q2dGTqJOZzo
   File System Navigation                                                : https://youtu.be/Nq3ZISrUzuE
   Line Editing Part 1        (Navigation inside a line)                 : https://youtu.be/zzX21ky1RqI
   Line Editing Part 2        (Committing lines)                         : https://youtu.be/l8iZXbDjIVE
   Line Editing Part 3        (Cammelback variables)                     : https://youtu.be/v6m2CXSS2XA
   File Navigation Part1      (up/down,line number, marking)             : https://youtu.be/XgYenz8Idvo
   File Navigation Part2      (scrolling, flip-flop-ing)                 : https://youtu.be/lHA9r26u5WI
   Line Filtering             (custom andpre-defined filters)            : https://youtu.be/sXjlnJrJdB8
   Line Filtering Part 2      (opertions on filtered lines)              : https://youtu.be/2kuQFT7HFCk
   Substitution               (with and without using regex)             : https://youtu.be/SKofDfuHnzE
   Templates                  (single/multiline, available)              : https://youtu.be/_qkdqAotLjI
   Templates Part2            (Template help,indetation,voice shortcuts) : https://youtu.be/_Fv2ARFDtS8
   Templates Part3            (How to create new templates)              : https://youtu.be/DbnviniTUTk
   Customizations             (Customizing VoiceEditor)                  : https://youtu.be/dmdew28x_CQ
   Installation               (How to install)                           : https://youtu.be/fEAnl1uHiak


1. Install IronPython https://ironpython.net/download/

2. Download latest VoiceEditor release and unpack.

3. Define user env variable that points to installation directory eg :

   VOICEEDITORROOT = C:%HOMEPATH%\Projects\VoiceEditorUVM

4. If you don't already haveit, then create a user env variable called IRONPYTHONPATH 
   and set/add the following directories:
   
   IRONPYTHONPATH += %VOICEEDITORROOT%\src;%VOICEEDITORROOT%\src_uvm

5. Create the snapshot of the source files. The application is run by
   invoking the snapshot. This way the editor's source can be modified
   using the editor itself.

   > cd %VOICEEDITORROOT%\run 
   > run_create_snapshot.bat

6. In the same directory as 5), invoke the editor : 

   > run.bat



EDITOR GUI ELEMENTS AND USAGE

-- Command Box

To place the cursor into this box click the button labelled "command".

Similar to VI's command mode. All commands are issued by typing them into this box and pressing return.

Entering a number into this box and pressing return causes the editor to jump to that line number.

When the cursor is placed in this box the mouse wheel can be used to scroll up and down in the file. 
Furthermore, the up arrow key will cause the editor to scroll up and down key will cause it to scroll down.


–- Edit Box

To place the cursor into this box click the button labelled "edit".

The up arrow key will cause the editor to scroll up and the down arrow key will cause it to scroll down.

This box is the only means of editing the file. The view box only displays the file content. Once an edit 
has been performed inside the edit box it can be committed into the flow of text by pressing the insert 
button or by pressing return. However, pressing return will also insert a new line.

When scrolling above the start of the file new lines will automatically be added. It is not possible to scroll
beyond the end of the file. To add lines to the end of the file you have to press return when at the ultimate line.


-- Various Buttons down the middle of the editor GUI.

Clicking the list button will list the current working directory and puts the editor into filesystem mode. 
Available options are listed in the view box and can be selected by entering their corresponding choice number 
in the command box and pressing return. Moving or copying is a two-stage process. After having selected the 
move or duplicate choice number you will need to specify the list of files to perform the operation on by 
entering comma separated list of choice numbers for nonconsecutive choices, and/or pairs of choice numbers 
separated by a colon to specify ranges (eg: 1,3,10:12). Then you need to navigate to the target directory 
and select choice number 6 (insert). At that point a Python script and associated .bat file will be created 
that you will need to explicitly run in order for the operation to be actually carried out. The file to 
run is: %VOICEEDTORROOT%\run\run_duplicate_move_delete.bat. When using the editor invoice control mode voice 
shortcut for running the script is 'run file operation'.

Lines can be cut from the flow of text by clicking the yank button. Yanked lines are stored in a buffer and 
can be reinserted by clicking the insert button.

The substitute button allows the substitution of one text by another in a defined range of lines. If the range 
of lines is left at the default settings then the substitution will be performed on the entire file. Simply 
follow the instructions in the command box.

The 'contract' button deflates the line entered into the edit box by removing all unnecessary white spaces. 
This makes it easier to enter code by voice given that Dragon NaturallySpeaking likes to insert spaces where 
they don't belong when you are trying to dictate variables and other code. Pressing the contract button also 
causes the line in the edit box to be committed into the text flow.

The expand button does the opposite of the contract button.

The filter button can be used to invoke the function that allows the lines in the file to be filtered 
(in a grep like manner). When clicking on this button you will be prompted to enter a regular expression in 
the command box. Enter return for the filtering to be actioned. Changing the regular expression in the command 
box and pressing return results in filtering on the newly entered expression. Entering an integer number is 
interpreted as a line number and causes the view box display to jump to the given line number. Clicking the 
filter button the second time causes an exit from the function.

The template button gives access to the library of templates defined in the %VOICEEDITORROOT%\templates directory.


TIP

If the editor appears to be stuck for any reason first try clicking the list button and if that doesn't work the filter button.