[kde-doc-english] [simon] doc/simon: Adding documentation for the VRPN command plugin

[Peter Grasch]

Git commit 3fdea92000dfaf2bb28405f48edc83c064868436 by Peter Grasch.
Committed on 25/05/2014 at 15:52.
Pushed by grasch into branch 'master'.

Adding documentation for the VRPN command plugin

M  +35   -1    doc/simon/index.docbook
A  +-    --    doc/simon/vrpn_command.png
A  +-    --    doc/simon/vrpn_command_config.png

http://commits.kde.org/simon/3fdea92000dfaf2bb28405f48edc83c064868436

diff --git a/doc/simon/index.docbook b/doc/simon/index.docbook
index 40d04a9..684ca22 100644
--- a/doc/simon/index.docbook
+++ b/doc/simon/index.docbook
@@ -4123,7 +4123,7 @@ To adjust your bots personality have a look at the bot.xml and vars.xml files in
 <sect2 id="dbus_command_plugin">
   <title>D-Bus</title>
   
-  <para>With the D-Bus command, Simon can call exported methods in 3rd party applications directly.</para>
+  <para>With the D-Bus command plugin, Simon can call exported methods in 3rd party applications directly.</para>
 
   <para>The screenshot below, for example, calls the "Pause" method of the MPRIS interface of the Tomahawk music playing software.</para>
 
@@ -4156,6 +4156,40 @@ To adjust your bots personality have a look at the bot.xml and vars.xml files in
   </para>
 </sect2>
 
+<sect2 id="vrpn_command_plugin">
+  <title>VRPN</title>
+
+  <para>With the VRPN command plugin, Simon can act as a VRPN server and export voice controlled buttons.</para>
+
+
+  <para>
+  <screenshot>
+  <screeninfo>VRPN plugin configuration</screeninfo>
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="vrpn_command_config.png" format="PNG"/>
+      </imageobject>
+    </mediaobject>
+  </screenshot>
+  </para>
+  <para>The plugin configuration allows you to set the port the server should operate on and to define an arbitrary list of buttons. Each of these button objects will have exactly one "button" (in VRPN, a button may theoretically have more than one clickable item).</para>
+
+  <para>After setting up the buttons, you can now configure Simon commands to act on them. You can set the commands to either Press & Release (consecutively), Press, Release or Toggle the button they manipulate.</para>
+
+  <para>
+  <screenshot>
+  <screeninfo>VRPN command configuration</screeninfo>
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="vrpn_command.png" format="PNG"/>
+      </imageobject>
+    </mediaobject>
+  </screenshot>
+  </para>
+
+  <para>For example, the command shown in the screenshot above would press and release ("click") the VRPN button at index 0 of the button device accessible as "ButtonB at localhost".</para>
+</sect2>
+
 <!--
      Not included in this version of Simon
 <sect2 id="atspi_command_plugin">
diff --git a/doc/simon/vrpn_command.png b/doc/simon/vrpn_command.png
new file mode 100644
index 0000000..b2d4dcc
Binary files /dev/null and b/doc/simon/vrpn_command.png differ
diff --git a/doc/simon/vrpn_command_config.png b/doc/simon/vrpn_command_config.png
new file mode 100644
index 0000000..ce506e0
Binary files /dev/null and b/doc/simon/vrpn_command_config.png differ