Okapi Framework - Filters

Versified Text Filter

If you are using an Okapi Tool after the M9 release, you should be using the wiki online help:
http://www.opentag.com/okapi/wiki/index.php?title=Versified_Text_Filter

Overview

The Versified Text Filter is an Okapi component that implements the IFilter interface for LDS versified text documents. The filter is implemented in the class net.sf.okapi.filters.versifiedtxt.VersifiedTextFilter of the Okapi library.

A versified text file looks like the example below. The parts highlited in green are extracted.

|b000001
|cTitle
|v0
Okapi Handbook

|v1
Some text

Processing Details

Input Encoding

The filter decides which encoding to use for the input document using the following logic:

If the file has a Unicode Byte-Order-Mark:
- Then, the corresponding encoding (e.g. UTF-8, UTF-16, etc.) is used.
Otherwise, the input encoding used is the default encoding that was specified when opening the document.

Inline Codes

Any sequences {N}, where N is a number is converted as inline code.

Parameters

This filter has no parameters.