Installation Instructions



Introduction

Thank you for downloading the Visual Tagging Tool Java. This package includes one compressed file -- vtt2010.tgz.

Requirements

Installation

  1. Download
    Download the vtt2010.tgz file from
    Visual Tagging Tool web site

  2. Uncompress
    Uncompress and un-archive this file into the location where you intend to have it installed. On a Linux machine, this would look like:
    shell> gtar -xzvf vtt2010.tgz
    

    If you are on a Windows platform, PKZIP and WinZip may be used to uncompress and un-archive this file. Please make sure the file you download has the right extension (tgz) before you unzip it. WinZip looks into the file to check if there is tar file within it, and it asks if it should create a temporary file with the tar file in it. The proper response is to allow this to happen. Once the temporary file has been created, WinZip reads it and displays the archive as it would any other zipped file. Unzip the resulting contents to the location you want to install to. Make sure that you preserve the directory structures when un-archiving.

    Once the files are in place, change the directory to the top level. This should be vtt2010. If you are on a windows platform, this will involve opening up a DOS command window (Start -> run -> cmd), and changing directories to where you have put these files. We will henceforth refer to this top level directory as the ${VTT_DIR} directory.

  3. Install
    From the ${VTT_DIR}, invoke the appropriate installation command. These are installation scripts appropriate to the platforms we know about:

    PlatformsInstallation Scripts
    Linuxinstall/bin/install_linux.sh
    Windowsinstall\bin\install_win.bat

    The scripts shown above will install a copy of the JRE, then proceed to alter the configuration file settings to set the install location. If you install VTT on a PC platform, choose NOT to restart your computer after JRE is installed. You may restart your computer after finishing VTT installation.

    The script will create shell files in the ${VTT_DIR} bin directory for each of the lexical tools, with the proper environment set up. Also, it creates VTT configuration file under ${VTT_DIR}/data/config/vtt.properties.

    Once done, the script will attempt to verify that the installation was successful.

    If the installation was successful, there will be a congratulation message that finishes off this process.

    If the installation is not successful, there will be a message indicating so. Please refer to the ${VTT_DIR}/logs directory for a complete transcript of the process. It is likely that there were error messages indicating the source of the failure.

After a successful installation

The Visual Tagging Tool is now ready to be used. It can be found in the ${VTT_DIR}/bin directory. On the Linux platforms, they include the following shell scripts:

On the Windows platform, they include the following batch files:

  • vtt.bat
  • vttCheck.bat

VTT may be used from any location on the machine. If you put the ${VTT_DIR}/bin path in your $PATH environment variable they do not have to be referenced with the whole path.

An Example Installation

Altering your environment to use the lexical tools, once they have been installed

You may invoke these tools from a command line. These tools are found in the ${VTT_DIR}/bin directory. You can add this ${VTT_DIR}/bin path to your ${PATH} environment variable. This would enable you to find and run these tools from any location.

In UNIX, this would be done by adding this path to your ~/.cshrc or ~/.profile startup script.

In Windows, this would be done by appending this path to the PATH variable from the "control panel\System\Advanced\Environment variable\Edit" menus.

Manual installation (for platforms other than Linux or MS Windows)

The manual installation page shows details of how the installation script configures and installs Visual Tagging Tool. Manual installation is used for developers or end users who want to install VTT in other platforms, such as Mac or Unix. Users may skip this section if they use installation script to install Visual Tagging Tool.