Because of a lapse in government funding, the information on this website may not be up to date, transactions submitted via the website may not be processed, and the agency may not be able to respond to inquiries until appropriations are enacted. The NIH Clinical Center (the research hospital of NIH) is open. For more details about its operating status, please visit cc.nih.gov. Updates regarding government operating status and resumption of normal operations can be found at OPM.gov.

Visual Tagging Tool

Manual Installation Instructions



Introduction

This page shows what the Visual Tagging Tool installation script does. A manually installation can be performed to replace the installation script. This step by step instruction can be used to install VTT on platforms other than Linux or MS Windows, such as Mac or Unix. It is not recommended for general end users to install the Visual Tagging Tool manually. You may skip this section if you use the VTT script for the installation. Please refer to installation instructions for installing the Visual Tagging Tool.

Prerequisites

Setup

  1. Create a new directory for the Visual Tagging Tool on your machine.
  2. Download the zip archive: vtt2010.tgz, and place it in the newly created directory. "2010" is the version identification (year).
  3. Uncompress or unzip the archive. Be careful to use a version of unzip that allows long filenames and that will recreate the full directory structure.

    You should now have three files and seven sub-directories under vtt2010, as shown in follows:

    • build.xml
    • overview.xml
    • ReadMe.txt

    • /bin
    • /data
    • /docs
    • /install
    • /lib
    • /logs
    • /sources
  4. Make sure your Java version is 1.6.0_18 or later (java -version)

Manual Install

  1. Let's say the path of top directory of vtt2010 is ${VTT_DIR}, such as: 
    /Users/vtt/vtt2010

  2. Edit configuration file, ${VTT_DIR}/data/config/vtt.properties:
    • VTT_DIR: Change the value to the full path of the top directory of vtt2010
    • VTT_FILE_DIR: Change the value to the full path of VTT file directory
    • TAGS_FILE: Change the value to the full path of VTT tags file

    For example, if the ${VTT_DIR} is /Users/vtt/vtt2010, the modified variable should look like: 

    VTT_DIR=/Users/vtt/vtt2010/
VTT_FILE_DIR=/Users/vtt/vtt2010/data/vtt
TAGS_FILE=/Users/vtt/vtt2010/data/config/tags.data

    Please refer to configuration setup for details

  3. Edit vtt executable file, ${VTT_DIR}/bin/vtt:
    • VTT_DIR: Change the value to the full path of the top directory of vtt2010

    For example, if the ${VTT_DIR} is /Users/vtt/vtt2010, the modified variable should look like: 

    VTT_DIR="/Users/vtt/vtt2010/"

Test Run

Now you are ready to run VTT, for example:

  1. Run VTT: 
    shell> ${VTT_DIR}/bin/vtt
  2. Open a demo file (${VTT_DIR}/data/vtt/test.vtt) 
    Vtt -> Open (o) -> test.vtt -> open

Please refer to VTT documents for how to use VTT (Help -> Documents (h))

Others

Please note that the vtt executable file includes:

  1. ${VTT_DIR}/lib/vtt2010.jar file in the CLASSPATH environment variable to include all VTT Java classes

  2. ${VTT_DIR}, the full path of the top directory of vtt2010, in the CLASSPATH environment variable. This allows VTT to find the default configuration file, data/config/vtt.properties