# Release Notes - okapiFiltersForOmegaT @version@, @date@

- Overview
- Requirements and Installation
- Support

## Overview

This package provides an adapter to use several of the Okapi filters directly from the computer-assisted translation tool OmegaT. It includes the following filters:

- The IDML Filter -- for InDesign IDML files
- The JSON Filter -- for JSON files
- The Transifex Filter -- for Transifex projects.
- The TS Filter -- for Qt TS files
- The TTX Filter -- for Trados TagEditor TTX files
- The TXML Filter -- for Wordfast pro TXML files
- The XLIFF Filter -- for XLIFF files

The source code for this package is hosted in the Okapi Framework project.

See the wiki page Okapi Filters Plugin for OmegaT for more information on the filters and the plugin.

## Requirements and Installation

### Requirements

- Windows: You must have a running installation of Java 1.6 or later (Sun Java, or an OpenJDK VM are recommended).
- Linux: You must have a running installation of Java 1.6 or later (Sun Java, or an OpenJDK VM are recommended).
- Macintosh: You must have a running installation of Java 1.6 or later; which are available on Mac OS X 10.5 (Leopard) for 64-bit machines, and on Mac OS X 10.6 (Snow Leopard) for 64-bit and 32-bit machines.
- Important: in all cases you need Java 1.6 or later. OmegaT requires only Java 1.5 or later

### Installation

To install the plugin:

1. Create a `plugins` directory in the OmegaT main directory, if it does not exist yet.
2. Copy the jar `okapi` directory of the distribution in the `plugins` directory.
3. The next time you run OmegaT the new filters will be available.

#### Macintosh

On Macintosh platform the main OmegaT directory is `OmegaT.app/Contents/Resources/Java`. You can open the directory by right-clicking OmegaT.app and selecting the command Show Package Content.

You may also have to change the default version of the Java virtual machine used to start OmegaT. To do this, open the file OmegaT.app/Contents/info.plist and replace:

    <key>JVMVersion</key>
    <string>1.5</string>

By

    <key>JVMVersion</key>
    <string>1.6</string>

### Uninstallation

To uninstall the plugin:

1. Simply delete the `okapi` sub-directory from the `plugins` directory.
2. The next time you run OmegaT the filters will not be available.

## Support

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

- Browse the OmegaT Users Group (http://tech.groups.yahoo.com/group/omegat/)
- Read and post notes in the Okapi Tools users group (you need to be registered member to post, but not to read).
- Read an post issue report on the Google Code project site.