Home

Taporware 1.0 Download Page

    Introduction

    TAPoRware 1.0 is a set of text analysis tools that enables users to perform text analysis on XML, HTML and plain text files. This set of prototype tools is made available so that educational users can download and install TAPoRware on their own machines. For information about copyright, see our copyright notice.

    TAPoRware is written in Ruby. The current version is based on version 1.8.1. You can try the tools from our server at TAPoRware Prototype.

    You may need to install Adobe SVG viewer to see the SVG image generated by the distribution tool. (Windows and Mac only;  there is currently no support for Unix/Linux). Your browser needs also to be Java enabled to view the Java applets generated by the fixed phrase tools.


    System Requirements

    For Unix Users

    Unix users need to have an extra user account named "taporware" (all lowercase) on a machine running the Apache web server and the Ruby interpreter. You also need to be able to run Ruby scripts under the "taporware" account. To make sure you can use the TAPoRware tools you will need:

    • A new Unix user account called "taporware" (specially created for these tools and which you should own) in addition to your own personal user account. The taporware tools will be placed here.
    • A directory called "public_html" or "pubhtml" under the "taporware" account (determined by UserDir directive of your Apache web server. Check with your web administrator.) This directory will be referred as the "taporware web root". Make this directory executable for everyone.
    • Ask your web administrator to enable cgi scripts execution for the directory named "cgi-bin" under the taporware web root.
    • Ask your web administrator to enable Apache SSI (Server Side Include) to support suffix .shtml. Add "index.shtml" at the end of the "DirectoryIndex" directive of the Apache configuration file "httpd.conf".
    • The Ruby interpreter and associated libraries for REXML, Ruby/Google and Ruby/SVG, etc. Ask your Unix administrator to download and install the following packages:
    • Ruby1.8.1 Package
      Ruby REXML Package
      Ruby SVG Package
      Ruby Google Package
      Ruby XSLT Package
    • Some of the packages depend on other Ruby packages or libraries. Check and install the dependent packages as well.

      1. To use the google package, you can either register in google web service and get your own a google license key(put the google-key in a file called .google_key and put this file under directory /home/taporware/public_html), or share the google-key with us. Remember that only 1,000 connections are allowed for each google license key. See Ruby-google package document for details. (If your taporware web root is not /home/taporware/public_html, after taporware tools package is installed, go to the taporware-web-root/cgi-bin/prototype directory, open the file taporGoogle.rb, and change the path in line 8 to the corresponding path.

      2. The hypergraph tool depends on the Ruby-xslt package which requires the newest version of system libraries libxslt and libxml. If the Ruby-xslt package cannot pass compilation, we recommend using the hypergraph tool in our server. (Note: If the hypergraph tool works in your machine, it will save xml files to taporware-web-root/cgi-bin/prototype/tmp directory. You may need to manually delete these xml files or use cron utility to delete the xml files periodically).

    For Windows Users

    Windows installers will need:

    • The Apache web server (version 2.0 is recommended). (Download the binary installer of the Apache web server for Windows from here and install it. Start the server and make sure that it works properly.)
    • Configure the web server to permit Server Side Include (SSI) and support suffix .shtml. For SSI documentation, see here
    • The Ruby interpreter and libraries. Download the Ruby interpreter 1.8.1.x executable for Windows from here. Double click on the download .exe file and then follow the install instructions (Note: Install it under the directory c:\ruby.)
    • Set the user environment variable for Ruby interpreter.
      • For Windows NT, XP or 2000, do this:
             start-->setting-->control panel-->system-->advanced(tab)--> environment variables(button).
        If there is a variable called "path", click "edit" to add the Ruby path (for example: c:\ruby\bin) to the end of "path" variable (note, separate each path with a semicolon ";"). If there is no "path" variable, click "new". In the variable name field, type in "path" (no quotation marks) and type in your Ruby path (c:\ruby\bin for example) in the variable value field.
      • For earlier versions of Windows: Select
             start-->run
        then type in "sysedit" and press Enter. Cascaded windows will open (Warning: These windows contain system settings, so do not change them!) Find the window called "autoexec.bat". If you see the "path" variable in this window, add the Ruby path to the end of it (for example: c:\ruby\bin).  Otherwise, add a new line such as "path=c:\ruby\bin" depending on your Ruby path. Save the change and exit. Restart the computer to enable the environment variables.
    • Test that Ruby works. Open a DOS console and type in the following command:
           ruby -v.
      If the output is:
           Ruby is not recognized as ......,
      then type in the following command:
           echo %PATH%.
      If the output contains a Ruby path, the path may be wrong. Check and modify. Otherwise, consult an expert.
    • Download the REXML package here and unzip it (you need WinZip or other Zip utilities to do this). Then open a DOS console. Change to the unzipped folder and type  the following command:
           ruby bin\install.rb.
      If you see a full screen of text such as "chmod 0644 c:\ruby\......". congratulations! Otherwise, consult an expert.
    • Download Ruby-SVG package here.  Unzip it to a folder. Open a Dos console and change to the directory of your unzipped folder. You will see a file called install.rb. Now type in the following commands in order:
           ruby install.rb config,
           ruby install.rb setup and
           ruby install.rb install.
      If your commands all work properly, you will see "install.rb: install done" in  the last line of the last command. Otherwise, consult an expert.
    • Download and install Ruby/Google package in the same way described above. Note: This package is dependent  upon several other Ruby packages (See the companion document.). Download and install these packages as well. To use the google package,  register at the  google web service and get a google license key. Put the the license key in a file and save it somewhere. (After the taporware tools package is installed, go to Apache-home/cgi-bin/prototype directory, and open the file taporGoogle.rb. Modify the path in line eight and make it point to the google license key file. NOTE: If google key file can not be found, taporware will generate an error). See Ruby-google document for details.
    • The hypergraph tool requires the  Ruby-xslt package and linux system libraries libxslt and libxml. We did not test it in the Windows platform but it is available for testing. It is recommended this tool be used in our server.

    Download and Install Taporware

    Now you are ready to install the TAPoRware tools.

    For Unix Users

    • Download the taporware.tar file and place it into the newly created user account "taporware" web root.
    • Untar it by entering the command:
           tar xvf taporware.tar
    • Enter the command: which ruby. If it is "/usr/local/bin/ruby", you don't need to do anything more. Use your browser and point to http://your.domain.name/~taporware to play with TAPoRware. (Note: "your.domain.name" should be your server's URL address).
    • If your which Ruby command gives you something other than "/usr/local/bin/ruby", switch to the directory ./cgi-bin/prototype and change "/usr/local/bin/ruby" in the first line of all the .cgi files to whatever the which ruby command returns.
    • Then play with TAPoRware.

    • Note: If you see a server error message, please go to the Apache error_log file (located at Apache_home/logs directory) and see the reason.

    For Windows Users

    • Download the taporware.zip file.
    • Extract (or unzip) the contents of taporware.zip into the "htdocs" directory of your Apache installation.
    • Change to the "htdocs\cgi-bin" directory of your Apache server and copy the directory "prototype" with its contents to "cgi-bin" directory of your Apache installation. For example, if your Apache installation is located at: "C:\Program Files\Apache Group\Apache2", move the folder "C:\Program Files\Apache Group\Apache2\htdocs\cgi-bin\prototype" to folder "C:\Program Files\Apache Group\Apache2\cgi-bin"
    • Switch to directory "prototype", change the Ruby interpreter command path in the first line of all the .cgi file to your machine's Ruby interpreter command path, for example: c:/ruby/bin/ruby.
    • Create a folder named "tmp" under your C: drive.
    • Open your browser and point to "http://localhost" and play with taporware.

    • Note: If you see a server error message, please go to the Apache error_log file (located at Apache_home/logs directory) and see the reason.

    Help and Warning

    These tools are made available without support. They can be accessed and used off of our server at TAPoRware Prototype without being installed. Anyone planning to install them should be an experienced server administrator.

    Version 1.0 is our second release of the prototype tools. It is a modified version of the first release and we have fixed some of the bugs in the earlier version. We have also added some new tools. This version has not been intensively tested at other locations. If you would like to work with us to improve the tools and test them,  e-mail Lian Yan at lyan (at) mcmaster (dot) ca. We are looking for computing humanists who are willing to extend, improve and test these tools, and we will support a limited number of appropriate users.