James: 1 revision

2021-01-13T17:24:56Z

1 revision

Jitterjames: /* Element 2. Command Macro */

2018-03-10T17:12:13Z

‎Element 2. Command Macro

New page

[[File:mdi.png|right|400px]]
To start editing your commands click '''"Edit"''' on the top menu of the [[How_to_use_VoxCommando#Understanding_the_main_window_interface|main VoxCommando window]].

This will open the [[MDI editor interface]] and load the voice command tree.

=The "Command" Concept=

Every command has two basic elements:
# The '''input''' to the command.
# The '''macro''' — a sequence of actions — that is executed when a command is triggered.

A command is usually triggered by the user speaking the correct sequence of words, but there are other ways to trigger a command as well.

=Element 1. Command Input=
In the [[Command Tree Editor]], we organize our commands into [[Groups|groups]], and we define the ''input'' to the commands. This input will include one or more of the following:
#[[Command_Tree_Editor#Phrases|phrases]] (what we say to trigger a command) -- voice commands require at least one phrase;
#[[Command_Tree_Editor#Payloads|payloads]] (also phrases, but they allow us to specify a ''value'' that gets passed to the command when it executes, e.g., 1 to 10, or a list of phrase items whose value will be remembered for later use);
#[[Events|events]] (which allow us to trigger commands without speaking). Although the event resides under the command along with phrases and payloads, it acts independently from them, so a command that has phrases and events assigned to it can be triggered by either.

{| class="wikitable"
! style="font-weight: bold;" | Group view in versions 2.121+
! style="font-weight: bold;" | Group view in versions 2.108 & earlier

|-
| style="text-align: center;" | [[File:newlook_SimpleGroup.png]]
| style="text-align: center;" | [[File:SimpleGroup.png]]
|-
|}
<br/>

=Element 2. Command Macro=
In the [[Logical Command Builder]] (LCB), we build the ''macro'' that describes what the command will do when it is executed, and how it uses the payloads, if any.

[[File:LCB.png|360px]]

To open the LCB and edit a command's actions you can do any of the following:
* Double-click the command icon.
* Right-click a command and choose "edit-build macros" from the context menu.
* Select the command and press '''Enter'''.
* Select the command and then click the edit icon which appears to the right of the command name.

=Video Tutorials=
Various tutorials are available on the [http://www.youtube.com/playlist?list=PL5EB7936BE8F07625 VoxCommando Tutorials playlist]

In particular, for a complete tutorial on how to edit your commands, watch these two videos:

<html><iframe width="500" height="281" align=left src="//www.youtube.com/embed/lPyfxpXRr9Q?rel=0" frameborder="0" allowfullscreen></iframe><iframe width="500" height="281" style="float: right; width:500px;" src="//www.youtube.com/embed/wM67JQqfzKA?rel=0" frameborder="0" allowfullscreen></iframe>
<div style="float: left; width:400px;"><p>Also useful for new users are the <a href="http://www.youtube.com/playlist?list=PLbO9yOXGYy97cQS1m9N83Fu7F2V5M_yEC" target="_blank">Fireside Chat</a> videos.</p></div></html>

← Older revision	Revision as of 17:24, 13 January 2021
(No difference)

Customizing Commands - Revision history

James: 1 revision

Jitterjames: /* Element 2. Command Macro */