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

- Overview
- Requirements and Installation
- Support

## Overview

This package provides an EXPERIMENTAL library to work with XLIFF 2.0 documents.

XLIFF 2.0 is currently under development at the OASIS XLIFF TC.

The schema and specification of XLIFF 2.0 are a work in progress and may change at any time without notice. This implementation may be not synchronized at all times with the draft schema and specification.

The library is under LGPL license and the source code for this package is hosted in the Okapi Framework project.

This distribution includes:

- `okapiXLIFFLib-<version>.jar` - Java library that includes an XLIFF reader class, an XLIFF writer class, and various helper classes to manipulate XLIFF data. This library has no dependency.
- `lynx.jar` - A tool to test and perform various manipulation of XLIFF documents.
- `lynx.bat` - A Windows batch file to run Lynx.
- `lynxPrompt.bat` - An helper batch file used by startLynxPrompt.
- `startLynxPrompt.bat` - A Windows batch file to start a DOS prompt from where you can call Lynx at anytime.
- `lynx.sh` - A Bash shell script to run Lynx.

Lynx is a command-line tools that can performs a few simple tasks on XLIFF 2.0 files.

To start it in Windows, just double-click on `startLynxPrompt.bat`

- The command `-r` (default) reads an XLIFF document and display the parsed components
- The command `-rw` reads an XLIFF document and re-write it.

For example to display the parsed parts of a document (assuming the distribution has been unzipped under Windows in `C:\xliff20`) type:

    C:\xliff20> lynx -r samples/hello.html_1.xlf

To get a complete list of the tool's command and options, type:

    C:\xliff20> lynx -?

Note that you can also create experimental XLIFF 2.0 output using Rainbow's extraction utility. See the Rainbow TKit - XLIFF 2.0 help page for details.

## Requirements and Installation

### Requirements

- Java 1.6 or later.

### Installation

To install the library:

1. Simply unzip the distribution in the directory where you want to use it.

### Uninstallation

To uninstall the library:

1. Simply delete the jar file from your directory.

## Support

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

- 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.
- Read and possibly post on the XLIFF lists:
  - http://lists.oasis-open.org/archives/xliff/
  - http://lists.oasis-open.org/archives/xliff-comment/
  - http://lists.oasis-open.org/archives/xliff-users/