Rainbow

2021-05-25T09:41:04Z

Penyaskito: Edited links to the new distribution channel

[[Image:Rainbow3.png|thumb|Rainbow on Windows 7]]
{| cellpadding="8"
|- valign="top"
|
[[Image:RainbowIcon.png]]
|
Help Topics:
|
* [[Rainbow - Main Window|Main Window]]
* [[Rainbow - Main Menu|Main Menu]]
* [[Rainbow - Usage|Usage]]
|
* [[Rainbow - User Preferences|User Preferences]]
* [[Rainbow - Command Line|Command Line]]
* [[Rainbow - Utilities|Utilities]]
|
* [[Rainbow - Edit / Execute Pipeline|Edit / Execute Pipeline]]
* [[Rainbow - Input Document Properties|Input Document Properties]]
|}

==Overview==

Rainbow is a cross-platform application to launch different utilities to help you perform various localization-relate tasks.

Its features include for example:

* Creation of translation packages (e.g. XLIFF, OmegaT, RTF).
* Conversion of character encoding or line-breaks.
* Conversion to various file formats.
* Terminology extraction and quality check reports.
* Batch translation using various MT and TM sources.
* Pseudo-translation and various modifications of the source text for testing.
* Apply XSLT templates in batch mode and comparison between different translations.
* Search and replace on filtered text, as well as source and translation alignment.
* [[Rainbow - Utilities|And much more...]]

Like other Okapi applications, Rainbow uses the components called "[[Glossary#Filter|filters]]" that take input files in a given native format and extract its translatable content into common resources that the Okapi tools can manipulate and modify. There are filters for many formats, for example: [[OpenOffice Filter|OpenOffice]], [[XML Filter|XML]], [[HTML Filter|HTML]], [[Properties Filter|Properties]], [[DTD Filter|DTD]], [[OpenXML Filter|MS Office]], [[Table Filter|tables]], etc. Many translation-related formats are also supported: [[XLIFF Filter|XLIFF]], [[PO Filter|PO]], [[TS Filter|TS]], [[TMX Filter|TMX]], [[TTX Filter|TTX]], etc.

Rainbow also uses the Okapi components called "[[Connectors|connectors]]": They allow you to access different type of local or remote translation resources. For example: [[Google MT v2 Connector|Google MT]], [[Microsoft Translator Connector|Microsoft Translator]], [[OpenTran Translation Repository Connector|Open-Tran]], [[MyMemory TM Connector|MyMemory]], [[Translate Toolkit TM Connector|Translate Toolkit TM]], [[Apertium MT Connector|Apertium]], [[TDA Translation Repository Connector|TDA-Search]], and more.

Note that, in addition to third-party TM access, Rainbow can also use Okapi's own TM engine: the [[Pensieve TM]].
Another feature of Rainbow is to allow the user to build "[[How to Create a Pipeline in Rainbow|pipelines]]" of tasks using simple components called "[[Steps|steps]]" that perform well-defined limited actions. You can chain those steps to execute many tasks in a single process.

==Download==

Rainbow is available from the okapi-apps distribution:

* '''Stable release: https://okapiframework.org/binaries/main/

* Development release (snapshot): https://gitlab.com/okapiframework/okapi/-/jobs/artifacts/dev/browse/deployment/maven/done

[[Category:Rainbow]]

JSON Filter

2021-03-10T08:18:37Z

Penyaskito: Added examples for excluding a key or a inner JSON structure.

{{Filters Header}}
==Overview==

The JSON Filter is an Okapi component that implements the IFilter interface for JSON (Javascript Object Notation).

The implementation is based on the JSON specifications: http://www.json.org/

The following is an example of a very simple JSON file. The translatable text is highlighted:

{"menu": {
"value": "File",
"popup": {
"menuitem": [
{"value": "New"},
{"value": "Open"},
{"value": "Close"}
]
}
}}

==Processing Details==

===Input Encoding===

JSON files are normally in one of the Unicode encoding, but the filter supports any encoding. It decides which encoding to use for the input file 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.
* Else, if a header entry with a <code>charset</code> declaration exists in the first 1000 characters of the file:
** If the value of the <code>charset</code> is "<code>charset</code>" (case insensitive):
*** Then the file is likely to be a template with no encoding declared, so the current encoding (auto-detected or default) is used.
*** Else, the declared encoding is used. Note that if the encoding has been detected from a Byte-Order-Mark and the encoding declared in the header entry does not match, a warning is generated and the encoding of the Byte-Order-Mark is used.
* Otherwise, the input encoding used is the default encoding that was specified when setting the filter options.

===Output Encoding===

If the output encoding is UTF-8:

* If the input encoding was also UTF-8, a Byte-Order-Mark is used for the output document only if one was detected in the input document.
* If the input encoding was not UTF-8, no Byte-Order-Mark is used in the output document.

===Line-Breaks===

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

===Comments===

Though not technically legal in JSON these comment types are supported:
<code>
* // comment
* # comment
* /* comment */
* 
</code>

==Parameters==

=== Options Tab===

====Stand-alone strings====

<cite>Extract strings without associated key</cite> — Set this option to extract string that are not associated directly to a key value.

====Strings with keys====

<cite>Extract all key/strings pairs</cite> — Set this option to extract all strings that have a key associated. If a regular expression for exceptions is defined, the strings that have a key matching the expression are not extracted.

<cite>Do not extract key/string pairs</cite> — Set the option to not extract any string that has an associated key. If a regular expression for exceptions is defined, the strings that have a key matching the expression are extracted.

<cite>Excepted when the key matches the following regular expression</cite> — Enter a regular expression that correspond to the keys that should have a behavior inverse to the default behavior you have selected for the key/strings pairs.
For example, you could exclude a key-value with <code>key</code>.
In combination with <code>Use the full key path</code> you can exclude all nested elements in a JSON structure with <code>^.*?/excludedStructure/.*</code>

<cite>Use the key as the resname</cite> — Set this option to use the value of the key as the value of the name of the extracted item (<code>resname</code> in XLIFF).

<cite>Use the full key path</cite> — Set this option to use the full key path in the <code>resname</code>. For example: <code>/menu/value/popup/menuitem/value</code>. The use key name as resname option must be set for this option to take effect. If enabled, exception regular expressions apply to the full path.

<cite>Include leading "/" on key path</cite> — Set this option to have a leading character '/' in the full key path.

<cite>Regex matching keys that are notes, values of which to appear as <note> in XLIFF</cite> — Specify regular expression. The values of the matching keys will be transferred to <note> elements in XLIFF.

<cite>Regex matching keys who's values are added as TextUnit Metadata</cite> — Specify regular expression. The values of the matching keys will be written out as <context-group> elements in XLIFF.

===New Extraction Rules >= version M39===
If specified these will override the corresponding rules above.

<cite>Regex matching keys which are ID's (resname in XLIFF), overrides "use the key as resname"</cite> — Specify regular expression. The value of the matching key will be used as <code>resname</code> in XLIFF.

<cite>Regex matching keys who's values are extracted (overrides "extraction exceptions")</cite> — Specify regular expression. The values of the matching keys will be extracted.

===Content Processing Tab===

<cite>Process text content with this sub-filter</cite> — Specify an Okapi filter ID (e.g. <code>okf_html</code>) to process the content of all translatable text with that filter. Leave this field blank for default behavior.

<cite>Find inline codes by patterns defined below</cite> — Set this option to use the specified regular expressions on the text of the extracted items. Any match will be converted to an inline code.

'''Note:''' This option cannot be used together with the sub-filtering option.

By default the expression is:

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

{{CodeFinder Help}}

==Limitations==

Comments within a JSON string are parsed as part of the string content, not as comments. A configured subfilter will then process these as true comments (they will become part of the skeleton or whatever the filter is configured to do).
[[Category:Filters]]

Okapi Framework - User contributions [en]

Rainbow

JSON Filter