Okapi Components

Overview

Okapi filters are components allowing you to access the translatable parts of files in a given format through a single common interface.

The filters currently offered through the Okapi Framework are the following:

HTML Filter - For HTML documents. (Alpha only)
Illustrator Filter - For Illustrator CS files. (Requires Illustrator CS (version 11))
InfoString Filter - For InfoString files.
INX Filter - For InDesign Interchange files.
JSON Filter - For JSON (JavaScript Object Notation) files.
NETRes Filter - For .NET ResX and compiled .resources files.
PO Filter - For Portable Object files.
Properties Filter - For Properties files.
RC Filter - For Windows RC files.
Script Filter - For text-based files, using regular expressions.
Table Filter - For table-type files (like CSV files).
Trados Text Filter - For Trados Text TM files.
Wordfast Filter - For Wordfast TM files.
XMLFilter - For XML documents. (Beta only, but usable for projects)

And more filters are being developed...

Properties

Each filter may have different properties. For example some will allow you to use either files or strings for input while other can use only files. The following table gives you a list of the different defined properties. You can use the QueryProperty method with the values listed in the Query column to know if the filter has or not a given property.

Capability	Query	Description
INPUTFILE	0	Allows to use files as input.
INPUTSTRING	1	Allows to use strings as input.
BILINGUALINPUT	2	Indicates that the filter may provide both source and target text.
TEXTBASED	3	Indicates that the filter is supporting a text-based file format.
OUTPUTFILE	4	Allows to output files.
OUTPUTSTRING	5	Allows to output strings.
ANCILLARYOUTPUT	6	Indicates that the filter may be capable of generating ancillary files (such as images) when processed.
XMLOUTPUT	7	Indicates that the filter is capable of generating its file or string output in XML.
RTFOUTPUT	8	Indicates that the filter is capable of generating its file or string output in RTF.
USEKEY	9	Indicates that the filter is currently using a protection key. (This property is never used in the Okapi Framework filters).
ISINDEMOMODE	10	Indicates that the filter is currently in demonstration mode. (This property is never used in the Okapi Framework filters).

See the help of each filter for a list of the properties it offers.

Interface

The same interface is used to expose the functionalities of the filters. This way you can write applications that make use of only one type of input, and can take advantage of all the current or upcoming filters that implement that interface.

The interface is also exposed as a COM interface. This allow you to use the filters in any application or programming language that supports COM/ActiveX, for example: Microsoft Word or Excel, JavaScript, VBScript, Perl, C#, Python, etc.

For more information about the interface, see the Okapi Filter Interface and, more generally, the Okapi Interfaces pages.