DocBook Documentation

The following sections provide guidelines for editing the VE-Suite documentation using DocBook.

Typefaces

When referring to filenames, file extensions, directory names, commands, or strings of code, use the code tag to differentiate the typeface from the text around it.

Entering this:

Go to VE-Suite's <code>bin</code> directory and type <code>python velauncher.py</code>.

yields this in the DocBook output:

Go to VE-Suite's bin directory and type python velauncher.py.

To draw users' attention to an important piece of information, type NOTE: and tag it with the DocBook emphasis role bold. That is, enter this:

<emphasis role="bold">NOTE:</emphasis>

to yield this:

NOTE:

Referring to VE-Suite's Versions

When referring to a general version of VE-Suite or any application within VE-Suite, such as in a command, use x.x.x to refer to the version number rather than a number so the reference does not become outdated with future release versions. For example, in the following sentence, vesuite.x.x.x.exe and vesuite_deps.x.x.x.exe refer to the version of VE-Suite being used, and the user would change x.x.x to the appropriate version number. In addition, be sure to include the build number in the version as well. The build number is available in VE-Conductor under the About menu option.

One installer, vesuite.x.x.x.exe, contains the core VE-Suite binaries and .dll files, while vesuite_deps.x.x.x.exe contains the binaries and .dll files of the dependencies for the current release of VE-Suite.

In some cases, you might need to refer to a specific version of VE-Suite as the following example shows:

Starting VE-Suite was simplified with the release of version 1.0.0 via VE-Launcher.