Release Notes - okapi-apps @version@, @date@

Overview

The okapi-apps distribution contains:

For a list of changes since the previous release, please see the Changes Log document.

Note that parts of this project are still relatively new and still in development. Some of the classes, interfaces and internal workings presented here may change in the upcoming versions of the Okapi Framework.

lib All the files needed to run the Okapi libraries and applications.
help The help files.
config Various default configuration files (e.g. segmentation rules, additional filter configurations, etc.)
examples A few Java examples on how to use the library in your own programs. See the examples' readme file for details.
dropins The directory where you can drop plug-ins.

The latest version of all documents and help is always available on-line, at the Okapi Framework Web site.

Windows Platform

Requirements

In order to run the Okapi applications on Windows you must have a running installation of Java 1.6 or later. Sun Java, or an OpenJDK VM is recommended.

Installation

To install the Okapi applications on Windows (32- and 64-bit):

  1. Download the ZIP file of the Windows distribution.
  2. Unzip the file on any location where you have rights, for example C:\Program Files\Okapi.

To run Rainbow: simply double-click on the rainbow.exe file in the main folder.

You can also run the application with the following command line (assuming it has been unzipped in the recommended folder):

C:\>javaw -jar C:\Program Files\Okapi\lib\rainbow.jar

To run Tikal: double-click on the startTikalPrompt.bat file. This will start a command prompt from where you can invoke Tikal from any directory. If you want to run Tikal at any time, from anywhere, you should add the directory where tikal.bat is located in the PATH of your system.

Uninstallation

To uninstall:

  1. Rainbow runs independently of Windows, so to uninstall it you can simply delete the folder where you have installed it. There is no Registry information to remove.
  2. If you want you can also remove the file where the user preferences are saved. It is located in the Home folder of the user and called .Rainbow.

Linux Platforms

Requirements

In order to run the Okapi applications on Linux you must have a running installation of Java 1.6 or later. Sun Java, or an OpenJDK VM is recommended.

Installation

To install the Okapi applications on Linux (32- and 64-bit):

  1. Download the ZIP file of the Linux distribution you need (there is one for 32-bit and one for 64-bit).
  2. Extract the file on any location. Make sure to preserve the full paths when extracting.

To run, for example, Rainbow: simply double-click on the rainbow.sh file in the main directory.

You can also run the application from the command line (assuming Rainbow is installed in \home\archie\okapi):

archie@archie:~>java -jar okapi/lib/rainbow.jar

Uninstallation

To uninstall:

  1. Delete the directory where the okapi application are installed.
  2. If you want, you can also remove the files where the user preferences are saved. They are located in the Home folder of the user and called .Rainbow and .Ratel.

Macintosh Platform

Requirements

In order to run Okapi applications on Macintsoh you must have Java 1.6 installed. Note that Apple does not provide Java 1.6 for all versions and architectures of the Mac.

Installation

To install the Okapi applications on Macintosh (32- and 64-bit):

  1. Download the ZIP file of the Macintosh distribution you need (See above).
  2. Extract the ZIP file on any location. For example /Users/admin/Desktop/Okapi.

To run, for example, Rainbow:

  1. The main directory of the distribution contains a Rainbow application bundle (Rainbow.app): simply double-click on it.
  2. If you run the application for the first time since you downloaded it, you may be prompted to confirm you want to run it.

You can modify the shell file rainbow.sh that is in the /Contents/MacOS folder of the application bundle to fit your own parameters. In all cases you MUST specify the -XstartOnFirstThread option or the application may not work properly. You can make sure to run the Java VM in a specific mode using the -d32 and -d64 flags.

Tikal is a command-line tool and should be invoked from a Terminal window.

Uninstallation

To uninstall:

  1. Delete the directory where the okapi application are installed.
  2. If you want, you can also remove the files where the user preferences are saved. They are located in the Home folder of the user and called .Rainbow and .Ratel.

Support

If you have questions, suggestions or bug to report, you can do this different ways: