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:
XMLFilter - For XML documents. (Beta only, but usable for projects)
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.
|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.
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.
For more information about the interface, see the Okapi Filter Interface and, more generally, the Okapi Interfaces pages.