# Okapi Framework - Filters ## TS Filter (BETA)
- Overview - Processing Details - Parameters |
Filters | Developer's Guide | Okapi Framework

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=TS_Filter

## Overview

The TS Filter is an Okapi component that implements the `IFilter` interface for Qt TS (Translation Source) resource files. The filter is implemented in the class `net.sf.okapi.filters.ts.TsFilter` of the Okapi library.

The implementation is based on the TS specifications found in the TS File Format specification.

## Processing Details

TODO

### Line-Breaks

The type of line-breaks of the output is the same as the one of the original input.

## Parameters

### Options Tab

#### Processing mode

Convert <byte value="[value]"/> to raw characters -- Select this option to convert all <byte/> elements in the TS document to raw characters. If this option is not set, the elements will not be converted and will be treated as inline codes.

### Inline Codes Tab

Has inline codes as defined below: -- Set this option to use the specified regular expression to be use against the text of the extracted items. Any match will be converted to an inline code. By default the expression is:

    ((%(([-0+#]?)[-0+#]?)((\d\$)?)(([\d\*]*)(\.[\d\*]*)?)[dioxXucsfeEgGpn])
    |((\\r\\n)|\\a|\\b|\\f|\\n|\\r|\\t|\\v)
    |(\{\d.*?\}))

Add -- Click this button to add a new rule.

Remove -- Click this button to remove the current rule.

Move Up -- Click this button to move the current rule upward.

Move down -- Click this button to move the current rule downward.

[Top-right text box] -- Enter the regular expression for the current rule. Use the Modify button to enter the edit mode. The expression must be a valid regular expression. You can check the syntax (and the effect of the rule) as it automatically tests it against the test data in the text box below and shows the result in the bottom-right text box.

Modify -- Click this button to edit the expression of the current rule. This button is labeled Accept when you are in edit mode.

Accept -- Click this button to save any changes you have made to the expression and leave the edit mode. This button is labeled Modify when you are not in edit mode.

Discard -- Click this button to leave the edit mode and revert the current rule to the expression it had before you started the edit mode.

Patterns -- Click this button to display a list of "guidline" regular expression patterns then select a pattern to insert it the edit box. The inserted text replaces whatever text is currently selected.

Test using all rules -- Set this option to test all the rules at the same time. The syntax of the current rule is automatically checked. See the effect it has on the sample text. The result of the test are displayed in the bottom right result box. The parts of the text that are matches of the expressions are displayed in <> brackets. If the Test using all rules option is set, the test takes all rules of the set in account, if it is not set only the current rule is tested.

[Middle-right text box] -- Optional test data to test the regular expression for the current rule or all rules depending on the Test using all rules option.

[Bottom-right text box] -- Shows the result of the regular expression applied to the test data.