XML on the forum

From VoxCommando
Jump to: navigation, search

The commands in your command tree are stored "behind the scenes" as XML.

You should never edit the XML directly; this is what the Command Tree Editor is for. But we have provided an easy way for users to share commands. It's as simple as copy and paste.

Importing XML to Your Command Tree

Code posted in a forum 'code box'

It is easy to copy command XML from the forum to your own command tree in VoxCommando.

  1. Select all the XML that is in the code box and copy it (you can use Ctrl-C or right-click after selecting all and choose "copy").
  2. Open your VC Command Tree Editor (as always, by clicking "Edit" in the menu).
  3. Click within the command tree window and use either Ctrl-V to paste or right-click and select paste.

If the code contains just a command, that command will be pasted into whatever command group you selected within your command tree.

Note that you must select a group to paste it into, and should not try to paste a single command into the white space of the window somewhere. The command tree structure requires commands to be contained within a group, whether you create a new group or paste it into an existing group.

If the code is a complete group, it will appear as its own group in your tree.

It is also possible to drag and drop code from the forum into your tree, but some users may find this more awkward depending on their set-up.

Please note:(On German keyboards, Ctrl = Strg)

Video tutorials

Turn on Close Captioning (CC) for captions

Below are three more very short video tutorials demonstrating three different methods for copying code from the forum to your tree.

  1. Copy & paste method (with audio instruction in English).
  2. The drag-and-drop method (with audio instruction in English--also demos the copy/paste method).
  3. Downloading an xml file and dragging into the tree (no audio, visual demo with captions).

Importing XML files

Sometimes users attach XML files to their posts rather than sharing the command xml code in a code box. In the case of an XML file, you must drag the actual file onto your tree.

  1. Save the file to your desktop or somewhere easily accessible.
  2. Open VC and click 'edit' to access your command tree.
  3. Drag the file from your desktop into your tree.

You may be asked whether you want to import the commands into an existing group or directly into the tree. Usually, if you're importing a whole command group you'll want to import directly to the command tree. (Command groups will have file names that look like "VcGrp_[something].xml"). You may wish to add individual commands to an existing group. In that case, make sure the existing group is selected before dragging the new file into your tree.

NOTE:

  1. Not all XML files found on the forum are Group/Command files. It is important to read the post. In some cases the file might be a payload XML file, not a command or command group. These cannot be dragged into the tree.
  2. Windows will sometimes prevent you from dragging files onto a program that has elevated (administrative) privileges. It will depend on which version of Windows you are using, and whether or not you have UAC enabled. Usually there is no reason why you need to run VoxCommando as administrator, so try to avoid it.
XML in a Code Block

Posting Your Code to the Forum

If you are having trouble with custom commands, you should post your command to the forum so that others can easily copy and paste your command to their tree, and then try to find potential problems.

This is often a very important step when seeking support (as is posting your log file if you're encountering errors/unexplained behaviour). It is much better, and easier, than posting a screenshot of your command.


Steps to post command XML to the forum:

  • In your command tree, right-click on the command OR command group that you want to share and copy it.
  • When writing your forum post, paste that code into a "code box". (Use the # symbol displayed above the message field to create a code box.)

The image to the right shows what a proper XML code block on the forum usually looks like. >>


The "right-click method" video demonstrates this in the second half of the video.