Jhargraveiii:

Filters are the components that convert input documents from their native file format into a common internal set of [[Glossary#Resource|resources]] that all Okapi components use. The extracted content can be re-written into the original file format. When using the steps, the extraction is done by the [[Raw Document to Filter Events Step]] and the re-writing by the [[Filter Events to Raw Document Step]].

Note: The [[Okapi Filters Plugin for OmegaT]] allows you to use some of the filters directly from [http://www.omegat.org OmegaT].

==List of the Filters==

The framework distribution comes with the following filters:

{| cellpadding="8" width=100%
|- valign="top"
|
* [[Archive Filter]]
* [[DTD Filter]]
* [[Doxygen Filter]]
* [[HTML Filter]]
* [[HTML5-ITS Filter]]
* [[ICML Filter]]
* [[IDML Filter]]
* [[JSON Filter]]
* [[Markdown Filter]]
* [[MIF Filter]]
* [[Moses Text Filter]]
* [[Multi-Parsers Filter]]
* [[OpenOffice Filter]]
* [[OpenXML Filter|OpenXML (MS Office) Filter]]
|
* [[PDF Filter]]
* [[Pensieve TM Filter]]
* [[PHP Content Filter]]
* [[Plain Text Filter]]
* [[PO Filter]]
* [[Properties Filter]]
* [[Rainbow Translation Kit Filter]]
* [[Regex Filter]]
* [[SDL Trados Package Filter]]
* [[Simplification Filter]]
* [[Table Filter]]
* [[TMX Filter]]
* [[Trados-Tagged RTF Filter]]
|
* [[Transifex Filter]]
* [[TS Filter]]
* [[TTX Filter]]
* [[TXML Filter]]
* [[Wiki Filter]]
* [[Vignette Filter]]
* [[XLIFF Filter]]
* [[XLIFF-2 Filter]]
* [[XML Filter]]
* [[XML Stream Filter]]
* [[YAML Filter]]
|}

==Supported File Formats==

The following is a list of some of the file formats supported by the distribution through [[Understanding Filter Configurations|pre-defined configurations]]:

{| border="1" cellpadding="6" cellspacing="0"
|+
| '''Format''' || '''Extensions''' || '''Pre-Defined Configuration''' || '''Filter''' || '''Notes'''
|- valign="top"
| Android Strings || .xml || <code>okf_xml-AndroidStrings</code> || [[XML Filter]] ||
|- valign="top"
| Apple Stringsdict || .stringsdict || <code>okf_xml-AppleStringsdict</code> || [[XML Filter]] ||
|- valign="top"
| Archive || .zip || <code>okf_archive</code> || [[Archive Filter]] || Meta filter that processes zip files with various formats as one file.
|- valign="top"
| Auto Xliff || .xlf, .xliff || <code>okf_autoxliff</code> || [[Auto Xliff Filter]] || Detects the version of an XLIFF file and then hands parsing off to the appropriate filter
|- valign="top"
| CSV (Comma-separated values files) || .csv, .txt || <code>okf_table_csv</code> || [[Table Filter]] ||
|- valign="top"
| CSV (Multiple complex sub-formats) || .csv || <code>okf_multiparsers</code> || [[Multi-Parsers Filter]] ||
|- valign="top"
| DITA || .dita, .ditamap, .xml || <code>okf_xmlstream-dita</code> || [[XML Stream Filter]] ||
|- valign="top"
| DokuWiki pages || .txt || <code>okf_wiki</code> || [[Wiki Filter]] ||
|- valign="top"
| Doxygen-commented files || .c, .h, cpp || <code>okf_doxygen</code> || [[Doxygen Filter]] ||
|- valign="top"
| DTD || .dtd || <code>okf_dtd</code> || [[DTD Filter]] ||
|- valign="top"
| Fixed-Width Columns Table || .txt || <code>okf_table_fwc</code> || [[Table Filter]] ||
|- valign="top"
| Idiom WorldServer XLIFF || .xlf || <code>okf_xliff-iws</code> || [[XLIFF Filter]] ||
|- valign="top"
| InCopy ICML || .wcml || <code>okf_icml</code> || [[ICML Filter]] ||
|- valign="top"
| InDesign IDML || .idml || <code>okf_idml</code> || [[IDML Filter]] ||
|- valign="top"
| iOS/Mac Strings|| .strings || <code>okf_regex-macStrings</code> || [[Regex Filter]] ||
|- valign="top"
| Java Properties || .properties || <code>okf_properties</code> || [[Properties Filter]] ||
|- valign="top"
| Java Properties (Output not escaped) || .properties || <code>okf_properties-outputNotEscaped</code> || [[Properties Filter]] ||
|- valign="top"
| Java XML Properties || .xml || <code>okf_xml-JavaProperties</code> || [[XML Filter]] ||
|- valign="top"
| Java XML Properties (HTML strings) || .xml || <code>okf_xmlstream-JavaPropertiesHTML</code> || [[XML Stream Filter]] ||
|- valign="top"
| JSON || .json || <code>okf_json</code> || [[JSON Filter]] ||
|- valign="top"
| Haiku CatKeys || .catkeys || <code>okf_table_catkeys</code> || [[Table Filter]] ||
|- valign="top"
| HTML (any) || .html, .htm || <code>okf_html</code> || [[HTML Filter]] ||
|- valign="top"
| HTML (Well-formed, and XHTML) || .html, .htm|| <code>okf_html-wellFormed</code> || [[HTML Filter]] ||
|- valign="top"
| HTML5 (and XHTML5) || .html, .htm|| <code>okf_itshtml5</code> || [[HTML5-ITS Filter]] ||
|- valign="top"
| Markdown || .md || <code>okf_markdown</code> || [[Markdown Filter]]
|- valign="top"
| Microsoft Excel 2007/2010 || .xlsx, .xlsm, .xltx, .xltm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| Microsoft PowerPoint 2007/2010 || .pptx, .pptm, .potx, .potm, .ppsx, .ppsm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| Microsoft Visio || .vsdx, .vsdm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| Microsoft Word 2007/2010 || .docx, .docm, .dotx, .dotm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| MIF || .mif || <code>okf_mif</code> || [[MIF Filter]] ||
|- valign="top"
| Moses Text || .txt || <code>okf_mosestext</code> || [[Moses Text Filter]] ||
|- valign="top"
| OpenOffice.org Calc || .ods, .ots || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| OpenOffice.org Draw || .odg, .otg || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| OpenOffice.org Impress || .odp, .otp || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| OpenOffice.org Writer || .odt, .ott || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| PDF || .pdf || <code>okf_pdf</code> || [[PDF Filter]] ||
|- valign="top"
| [[Pensieve TM]] || .pentm || <code>okf_pensieve</code> || [[Pensieve TM Filter]] ||
|- valign="top"
| PHP Content || .php || <code>okf_phpcontent</code> || [[PHP Content Filter]] || Can be used as a subfilter only
|- valign="top"
| Plain Text (Line = text unit) || .txt || <code>okf_plaintext</code> || [[ Plain Text Filter]] ||
|- valign="top"
| Plain Text (Paragraph = text unit) || .txt || <code>okf_plaintext_paragraphs</code> || [[Plain Text Filter]] ||
|- valign="top"
| PO || .po || <code>okf_po</code> || [[PO Filter]] ||
|- valign="top"
| PO (Monolingual style) || .po || <code>okf_po-monolingual</code> || [[PO Filter]] ||
|- valign="top"
| Rainbow Translation Kit manifests || .rkm || <code>okf_rainbowkit</code> || [[Rainbow Translation Kit Filter]] || Used as a tkit reader only
|- valign="top"
| Regex (Any text-based format) || .txt || <code>okf_regex</code> || [[Regex Filter]] ||
|- valign="top"
| RDF (Mozilla RDF) || .rdf || <code>okf_xml-MozillaRDF</code> || [[XML Filter]] ||
|- valign="top"
| RESX || .resx || <code>okf_xml-resx</code> || [[XML Filter]] ||
|- valign="top"
| SDLPPX || .sdlppx || <code>okf_sdlpackage</code> || [[SDL Trados Package Filter]] ||
|- valign="top"
| SDLRPX || .sdlrpx || <code>okf_sdlpackage</code> || [[SDL Trados Package Filter]] ||
|- valign="top"
| SDL[[XLIFF]] || .sdlxlf || <code>okf_xliff-sdl</code> || [[XLIFF Filter]] ||
|- valign="top"
| Skype Language Files || .lang || <code>okf_properties-skypeLang</code> || [[Properties Filter]] ||
|- valign="top"
| SRT (Sub-Rip Text, sub-titles files) || .srt || <code>okf_regex-srt</code> || [[Regex Filter]] ||
|- valign="top"
| Tab-Delimiter files || .tsv, .txt || <code>okf_table_tsv</code> || [[Table Filter]] ||
|- valign="top"
| Tex files || .tex || <code>okf_tex</code> || [[TEX Filter]] ||
|- valign="top"
| [[TMX]] || .tmx || <code>okf_tmx</code> || [[TMX Filter]] ||
|- valign="top"
| Transifex project || .txp || <code>okf_transifex</code> || [[Transifex Filter]] ||
|- valign="top"
| Trados-Tagged RTF || .rtf || <code>okf_tradosrtf</code> || [[Trados-Tagged RTF Filter]] ||
|- valign="top"
| TS - Qt TS files || .ts || <code>okf_ts</code> || [[TS Filter]] ||
|- valign="top"
| TTX - Trados TagEditor TTX files || .ttx || <code>okf_ttx</code> || [[TTX Filter]] ||
|- valign="top"
| TXML - Wordfast Pro TXML files || .txml || <code>okf_txml</code> || [[TXML Filter]] ||
|- valign="top"
| Vignette Export/Import Content || .xml || <code>okf_vignette</code> || [[Vignette Filter]] ||
|- valign="top"
| XHTML || .html, .htm || <code>okf_html-wellFormed</code> || [[HTML Filter]] ||
|- valign="top"
| WIX (Windows Installer XML) localization files || .wix || <code>okf_xml-WixLocalization</code> || [[XML Filter]] ||
|- valign="top"
| [[XLIFF]] v1.2 || .xlf, .xliff || <code>okf_xliff</code> || [[XLIFF Filter]] ||
|- valign="top"
| [[XLIFF]] v2 || .xlf || <code>okf_xliff2</code> || [[XLIFF-2 Filter]] ||
|- valign="top"
| XML (Generic, using [[ITS]] defaults) || .xml || <code>okf_xml</code> || [[XML Filter]] ||
|- valign="top"
| XML (Generic, using stream reader) || .xml || <code>okf_xmlstream</code> || [[XML Stream Filter]] ||
|- valign="top"
| YAML (Generic YAML filter) || .yml, .yaml || <code>okf_yaml</code> || [[YAML Filter]] ||
|}

Note that most filters allow you to [[Understanding Filter Configurations|create your own configurations]] to support more file formats.

==Code Simplification Rules==

All filters support code simplification rules. By default the [[Inline Codes Simplifier Step]], [[Simplification Filter]] and [[Post-segmentation Inline Codes Removal Step]] maximize the trimming and merging (aka simplification) of inline codes. In some cases this may not be desired. The simplification rules allow you to override the default behavior and prevent specific codes from being trimmed or merged.

===General Syntax===

The rules parser ignores irrelevant whitespace. Rules can be separated by spaces, newlines or nothing. This makes it easier to accommodate various container formats and their whitespace normalization rules. When a rule applies it means "do not simplify the match code". Uppercase tokens are constants and predefined by the rule parser. Multiple rules are always OR'ed together.

For more details see the JavaCC grammar: <code>../okapi-core/src/main/java/net/sf/okapi/core/simplifierrules/SimplifierRules.jj</code>

===Rule Examples===

If Code has any of these flags then don't simplify

<pre>if DELETABLE or ADDABLE or CLONEABLE;</pre>

"=" is string match
Match basic TAGTYPE opening, closing or standalone

<pre>if DATA = "a" and TAGTYPE = OPENING;</pre>

"~" is regex match

<pre>if DATA ~ "a.*";</pre>

You can negate any of the match operators
Don't simplify if the DATA does not match the regex

<pre>if DATA !~ "a.*";</pre>

Match on type, linebreak in this case, don't simplify

<pre>if the Code is a linebreak if TYPE = "lb";</pre>

Don't simplify any rich text types

<pre>if TYPE = "bold" or TYPE = "italic" or TYPE = "underline";</pre>

Expressions can be recursive (supports embedded parens)

<pre>if TYPE = "bold" or (DATA = "bar" or (DATA = "foo" and TYPE = "underline"));</pre>

===Filter Config Examples===

Examples of using simplifier rules within the filter config formats used by Okapi.

'''YAML:'''

<pre>
simplifierRules: |
if ADDABLE or DELETABLE or CLONEABLE;
if DATA = " " or DATA = "" or DATA = "" or DATA = "</a>";
if DATA ~ "\\<font.+" or DATA ~ "\\<img.+" or DATA ~ "\\<a.+";
</pre>

'''ITS:'''

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<its:rules xmlns:its="http://www.w3.org/2005/11/its" version="1.0" xmlns:itsx="http://www.w3.org/2008/12/its-extensions" xmlns:okp="okapi-framework:xmlfilter-options">

<its:translateRule selector="//*" translate="yes"/>
<its:withinTextRule selector="//codeph" withinText="yes"/>
<its:withinTextRule selector="//ph" withinText="yes"/>
<okp:simplifierRules>
if ADDABLE or DELETABLE or CLONEABLE; if DATA ~ ".+";
</okp:simplifierRules>
</its:rules>
</pre>

'''FPRM (Parameters):'''

<pre>
#v1
extractNotes.b=true
simplifyCodes.b=true
simplifierRules=if ADDABLE or DELETABLE or CLONEABLE; if DATA ~ ".+";
</pre>

[[Category:Filters]]

Filters

2019-12-16T19:33:33Z

Jhargraveiii:

Filters are the components that convert input documents from their native file format into a common internal set of [[Glossary#Resource|resources]] that all Okapi components use. The extracted content can be re-written into the original file format. When using the steps, the extraction is done by the [[Raw Document to Filter Events Step]] and the re-writing by the [[Filter Events to Raw Document Step]].

Note: The [[Okapi Filters Plugin for OmegaT]] allows you to use some of the filters directly from [http://www.omegat.org OmegaT].

==List of the Filters==

The framework distribution comes with the following filters:

{| cellpadding="8" width=100%
|- valign="top"
|
* [[Archive Filter]]
* [[DTD Filter]]
* [[Doxygen Filter]]
* [[HTML Filter]]
* [[HTML5-ITS Filter]]
* [[ICML Filter]]
* [[IDML Filter]]
* [[JSON Filter]]
* [[Markdown Filter]]
* [[MIF Filter]]
* [[Moses Text Filter]]
* [[Multi-Parsers Filter]]
* [[OpenOffice Filter]]
* [[OpenXML Filter|OpenXML (MS Office) Filter]]
|
* [[PDF Filter]]
* [[Pensieve TM Filter]]
* [[PHP Content Filter]]
* [[Plain Text Filter]]
* [[PO Filter]]
* [[Properties Filter]]
* [[Rainbow Translation Kit Filter]]
* [[Regex Filter]]
* [[SDL Trados Package Filter]]
* [[Simplification Filter]]
* [[Table Filter]]
* [[TMX Filter]]
* [[Trados-Tagged RTF Filter]]
|
* [[Transifex Filter]]
* [[TS Filter]]
* [[TTX Filter]]
* [[TXML Filter]]
* [[Wiki Filter]]
* [[Vignette Filter]]
* [[XLIFF Filter]]
* [[XLIFF-2 Filter]]
* [[XML Filter]]
* [[XML Stream Filter]]
* [[YAML Filter]]
|}

==Supported File Formats==

The following is a list of some of the file formats supported by the distribution through [[Understanding Filter Configurations|pre-defined configurations]]:

{| border="1" cellpadding="6" cellspacing="0"
|+
| '''Format''' || '''Extensions''' || '''Pre-Defined Configuration''' || '''Filter''' || '''Notes'''
|- valign="top"
| Android Strings || .xml || <code>okf_xml-AndroidStrings</code> || [[XML Filter]] ||
|- valign="top"
| Apple Stringsdict || .stringsdict || <code>okf_xml-AppleStringsdict</code> || [[XML Filter]] ||
|- valign="top"
| Archive || .zip || <code>okf_archive</code> || [[Archive Filter]] || Meta filter that processes zip files with various formats as one file.
|- valign="top"
| Auto Xliff || .xlf, .xliff || <code>okf_autoxliff</code> || [[Auto Xliff Filter]] || Detects the version of an XLIFF file and then hands parsing off to the appropriate filter
|- valign="top"
| CSV (Comma-separated values files) || .csv, .txt || <code>okf_table_csv</code> || [[Table Filter]] ||
|- valign="top"
| CSV (Multiple complex sub-formats) || .csv || <code>okf_multiparsers</code> || [[Multi-Parsers Filter]] ||
|- valign="top"
| DITA || .dita, .ditamap, .xml || <code>okf_xmlstream-dita</code> || [[XML Stream Filter]] ||
|- valign="top"
| DokuWiki pages || .txt || <code>okf_wiki</code> || [[Wiki Filter]] ||
|- valign="top"
| Doxygen-commented files || .c, .h, cpp || <code>okf_doxygen</code> || [[Doxygen Filter]] ||
|- valign="top"
| DTD || .dtd || <code>okf_dtd</code> || [[DTD Filter]] ||
|- valign="top"
| Fixed-Width Columns Table || .txt || <code>okf_table_fwc</code> || [[Table Filter]] ||
|- valign="top"
| Idiom WorldServer XLIFF || .xlf || <code>okf_xliff-iws</code> || [[XLIFF Filter]] ||
|- valign="top"
| InCopy ICML || .wcml || <code>okf_icml</code> || [[ICML Filter]] ||
|- valign="top"
| InDesign IDML || .idml || <code>okf_idml</code> || [[IDML Filter]] ||
|- valign="top"
| iOS/Mac Strings|| .strings || <code>okf_regex-macStrings</code> || [[Regex Filter]] ||
|- valign="top"
| Java Properties || .properties || <code>okf_properties</code> || [[Properties Filter]] ||
|- valign="top"
| Java Properties (Output not escaped) || .properties || <code>okf_properties-outputNotEscaped</code> || [[Properties Filter]] ||
|- valign="top"
| Java XML Properties || .xml || <code>okf_xml-JavaProperties</code> || [[XML Filter]] ||
|- valign="top"
| Java XML Properties (HTML strings) || .xml || <code>okf_xmlstream-JavaPropertiesHTML</code> || [[XML Stream Filter]] ||
|- valign="top"
| JSON || .json || <code>okf_json</code> || [[JSON Filter]] ||
|- valign="top"
| Haiku CatKeys || .catkeys || <code>okf_table_catkeys</code> || [[Table Filter]] ||
|- valign="top"
| HTML (any) || .html, .htm || <code>okf_html</code> || [[HTML Filter]] ||
|- valign="top"
| HTML (Well-formed, and XHTML) || .html, .htm|| <code>okf_html-wellFormed</code> || [[HTML Filter]] ||
|- valign="top"
| HTML5 (and XHTML5) || .html, .htm|| <code>okf_itshtml5</code> || [[HTML5-ITS Filter]] ||
|- valign="top"
| Markdown || .md || <code>okf_markdown</code> || [[Markdown Filter]]
|- valign="top"
| Microsoft Excel 2007/2010 || .xlsx, .xlsm, .xltx, .xltm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| Microsoft PowerPoint 2007/2010 || .pptx, .pptm, .potx, .potm, .ppsx, .ppsm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| Microsoft Visio || .vsdx, .vsdm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| Microsoft Word 2007/2010 || .docx, .docm, .dotx, .dotm || <code>okf_openxml</code> || [[OpenXML Filter]] ||
|- valign="top"
| MIF || .mif || <code>okf_mif</code> || [[MIF Filter]] ||
|- valign="top"
| Moses Text || .txt || <code>okf_mosestext</code> || [[Moses Text Filter]] ||
|- valign="top"
| OpenOffice.org Calc || .ods, .ots || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| OpenOffice.org Draw || .odg, .otg || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| OpenOffice.org Impress || .odp, .otp || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| OpenOffice.org Writer || .odt, .ott || <code>okf_odf</code> || [[OpenOffice Filter]] ||
|- valign="top"
| PDF || .pdf || <code>okf_pdf</code> || [[PDF Filter]] ||
|- valign="top"
| [[Pensieve TM]] || .pentm || <code>okf_pensieve</code> || [[Pensieve TM Filter]] ||
|- valign="top"
| PHP Content || .php || <code>okf_phpcontent</code> || [[PHP Content Filter]] || Can be used as a subfilter only
|- valign="top"
| Plain Text (Line = text unit) || .txt || <code>okf_plaintext</code> || [[ Plain Text Filter]] ||
|- valign="top"
| Plain Text (Paragraph = text unit) || .txt || <code>okf_plaintext_paragraphs</code> || [[Plain Text Filter]] ||
|- valign="top"
| PO || .po || <code>okf_po</code> || [[PO Filter]] ||
|- valign="top"
| PO (Monolingual style) || .po || <code>okf_po-monolingual</code> || [[PO Filter]] ||
|- valign="top"
| Rainbow Translation Kit manifests || .rkm || <code>okf_rainbowkit</code> || [[Rainbow Translation Kit Filter]] || Used as a tkit reader only
|- valign="top"
| Regex (Any text-based format) || .txt || <code>okf_regex</code> || [[Regex Filter]] ||
|- valign="top"
| RDF (Mozilla RDF) || .rdf || <code>okf_xml-MozillaRDF</code> || [[XML Filter]] ||
|- valign="top"
| RESX || .resx || <code>okf_xml-resx</code> || [[XML Filter]] ||
|- valign="top"
| SDLPPX || .sdlppx || <code>okf_sdlpackage</code> || [[SDL Trados Package Filter]] ||
|- valign="top"
| SDLRPX || .sdlrpx || <code>okf_sdlpackage</code> || [[SDL Trados Package Filter]] ||
|- valign="top"
| SDL[[XLIFF]] || .sdlxlf || <code>okf_xliff-sdl</code> || [[XLIFF Filter]] ||
|- valign="top"
| Skype Language Files || .lang || <code>okf_properties-skypeLang</code> || [[Properties Filter]] ||
|- valign="top"
| SRT (Sub-Rip Text, sub-titles files) || .srt || <code>okf_regex-srt</code> || [[Regex Filter]] ||
|- valign="top"
| Tab-Delimiter files || .tsv, .txt || <code>okf_table_tsv</code> || [[Table Filter]] ||
|- valign="top"
| Tex files || .tex || <code>okf_tex</code> || [[TEX Filter]] ||
|- valign="top"
| [[TMX]] || .tmx || <code>okf_tmx</code> || [[TMX Filter]] ||
|- valign="top"
| Transifex project || .txp || <code>okf_transifex</code> || [[Transifex Filter]] ||
|- valign="top"
| Trados-Tagged RTF || .rtf || <code>okf_tradosrtf</code> || [[Trados-Tagged RTF Filter]] ||
|- valign="top"
| TS - Qt TS files || .ts || <code>okf_ts</code> || [[TS Filter]] ||
|- valign="top"
| TTX - Trados TagEditor TTX files || .ttx || <code>okf_ttx</code> || [[TTX Filter]] ||
|- valign="top"
| TXML - Wordfast Pro TXML files || .txml || <code>okf_txml</code> || [[TXML Filter]] ||
|- valign="top"
| Versified Text || .vrsz || <code>okf_versifiedtxt</code> || [[Versified Text Filter]] || Deprecated
|- valign="top"
| Vignette Export/Import Content || .xml || <code>okf_vignette</code> || [[Vignette Filter]] ||
|- valign="top"
| XHTML || .html, .htm || <code>okf_html-wellFormed</code> || [[HTML Filter]] ||
|- valign="top"
| WIX (Windows Installer XML) localization files || .wix || <code>okf_xml-WixLocalization</code> || [[XML Filter]] ||
|- valign="top"
| [[XLIFF]] v1.2 || .xlf, .xliff || <code>okf_xliff</code> || [[XLIFF Filter]] ||
|- valign="top"
| [[XLIFF]] v2 || .xlf || <code>okf_xliff2</code> || [[XLIFF-2 Filter]] ||
|- valign="top"
| XML (Generic, using [[ITS]] defaults) || .xml || <code>okf_xml</code> || [[XML Filter]] ||
|- valign="top"
| XML (Generic, using stream reader) || .xml || <code>okf_xmlstream</code> || [[XML Stream Filter]] ||
|- valign="top"
| YAML (Generic YAML filter) || .yml, .yaml || <code>okf_yaml</code> || [[YAML Filter]] ||
|}

Note that most filters allow you to [[Understanding Filter Configurations|create your own configurations]] to support more file formats.

==Code Simplification Rules==

All filters support code simplification rules. By default the [[Inline Codes Simplifier Step]], [[Simplification Filter]] and [[Post-segmentation Inline Codes Removal Step]] maximize the trimming and merging (aka simplification) of inline codes. In some cases this may not be desired. The simplification rules allow you to override the default behavior and prevent specific codes from being trimmed or merged.

===General Syntax===

The rules parser ignores irrelevant whitespace. Rules can be separated by spaces, newlines or nothing. This makes it easier to accommodate various container formats and their whitespace normalization rules. When a rule applies it means "do not simplify the match code". Uppercase tokens are constants and predefined by the rule parser. Multiple rules are always OR'ed together.

For more details see the JavaCC grammar: <code>../okapi-core/src/main/java/net/sf/okapi/core/simplifierrules/SimplifierRules.jj</code>

===Rule Examples===

If Code has any of these flags then don't simplify

<pre>if DELETABLE or ADDABLE or CLONEABLE;</pre>

"=" is string match
Match basic TAGTYPE opening, closing or standalone

<pre>if DATA = "a" and TAGTYPE = OPENING;</pre>

"~" is regex match

<pre>if DATA ~ "a.*";</pre>

You can negate any of the match operators
Don't simplify if the DATA does not match the regex

<pre>if DATA !~ "a.*";</pre>

Match on type, linebreak in this case, don't simplify

<pre>if the Code is a linebreak if TYPE = "lb";</pre>

Don't simplify any rich text types

<pre>if TYPE = "bold" or TYPE = "italic" or TYPE = "underline";</pre>

Expressions can be recursive (supports embedded parens)

<pre>if TYPE = "bold" or (DATA = "bar" or (DATA = "foo" and TYPE = "underline"));</pre>

===Filter Config Examples===

Examples of using simplifier rules within the filter config formats used by Okapi.

'''YAML:'''

<pre>
simplifierRules: |
if ADDABLE or DELETABLE or CLONEABLE;
if DATA = " " or DATA = "" or DATA = "" or DATA = "</a>";
if DATA ~ "\\<font.+" or DATA ~ "\\<img.+" or DATA ~ "\\<a.+";
</pre>

'''ITS:'''

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<its:rules xmlns:its="http://www.w3.org/2005/11/its" version="1.0" xmlns:itsx="http://www.w3.org/2008/12/its-extensions" xmlns:okp="okapi-framework:xmlfilter-options">

<its:translateRule selector="//*" translate="yes"/>
<its:withinTextRule selector="//codeph" withinText="yes"/>
<its:withinTextRule selector="//ph" withinText="yes"/>
<okp:simplifierRules>
if ADDABLE or DELETABLE or CLONEABLE; if DATA ~ ".+";
</okp:simplifierRules>
</its:rules>
</pre>

'''FPRM (Parameters):'''

<pre>
#v1
extractNotes.b=true
simplifyCodes.b=true
simplifierRules=if ADDABLE or DELETABLE or CLONEABLE; if DATA ~ ".+";
</pre>

[[Category:Filters]]