Ysavourel: 1 revision imported

2016-06-04T23:19:55Z

1 revision imported

← Older revision	Revision as of 19:19, 4 June 2016
(No difference)

Ysavourel at 17:49, 17 February 2014

2014-02-17T17:49:59Z

New page

{{Rainbow TKits Header}}
__TOC__
==Overview==

The ''Generic XLIFF'' package is one of the types of translation packages you can create with the [[Rainbow Translation Kit Creation Step]]. Such package can be post-processed using the [[Rainbow Translation Kit Merging Step]].

In this package the input documents are extracted into corresponding standard [[XLIFF|XLIFF 1.2 documents]].
* Existing and leveraged translation are output into different TMX files. They can also, optionally, be included directly in the XLIFF documents as <code><alt-trans></code> elements.
* Segmented text units are represented using the standard XLIFF 1.2 representation.
* Inline codes are represented using either the placeholder notation (<code><g>/<x/>/<bx>/<ex></code>) or the encapsulation notation (<code><bpt>/<ept>/<ph>/<it></code>).

The XLIFF documents generated in this package can be translated using any XLIFF-capable translation tool. Several of these tools (free and commercial) are described in the "[[How to Translate XLIFF Documents]]" page.

==Options==

<cite>Include non-translatable text units</cite> — Set this options to include the text units marked as non-translatable in the translation package. They will be marked also as non-translatable (<code>translate='no'</code>) there. Providing non-translatable text is sometimes useful for context.

<cite>Set approved entries as non-translatable</cite> — Set this option to mark any entry that is approved in the original file as a non-translatable entry in the XLIFF output. This option is available only if the option <cite>Include non-translatable text units</cite> is set.

<cite>Use <g></g> and <x/> notation</cite> — Set this option to create an XLIFF output where inline codes are coded as place-holders that do not include the original data. Some file formats have inline codes that correspond to large chunk of data that are not useful for the translator: This notation allows you to not include them in the XLIFF output.

If this option is not set, the encapsulation notation (<code><bpt>/<ept>/<ph>/<it></code>) will be used and includes the original data.

For example, given an original text like this:

Text in <span style='123'>bold and italics</span>

With the option set you will get:

Text in <g id="1">bold and italics</g>

Without the option set you will get:

Text in <bpt id="1">&lt;span style='123'></bpt>bold and italics<ept id="1">&lt;/span></ept>

<cite>Copy source text in target if no target is available</cite> — Set this option to fill the <code><target></code> element with the source text if no translation is available. This is useful to generate XLIFF documents that can be translated by tools that are not specifically XLIFF-enabled but can work with XML documents.

<cite>Include <alt-trans> elements</cite> — Set this option to include <code><alt-trans></code> elements for the entries that have leveraged translation.

<cite>Include extended code attributes</cite> — Set this option to include <code>ctype</code> and <code>equiv-text</code> attributes in inline codes.

<cite>Include ITS markup</cite> — Set this option to include [[ITS|ITS markup]] in inline codes.

==Details==

===Sub-Directories===

The extracted files are stored in the same directory structure as the original files, relative to the root of the file set.

For example if you have two files named <code>index.html</code> in two different sub-directories, they will be both extracted as <code>index.html.xlf</code> but each on its corresponding sub-directory.

===Inline Codes===

Inline codes are stored using either the placeholder notation (<code><g>/<x/>/<bx>/<ex></code>) or the (<code><bpt>/<ept>/<ph>/<it></code>) depending on what you have selected in the options.

The placeholder notation is often more user-friendly, especially for some complex document-type formats like Word, InDesign, etc.

===Segmentation===

Segmented entries use the XLIFF standard representation with <code><seg-source></code> as described in the [http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html#Struct_Segmentation XLIFF 1.2 specification].

If a translation is present, it follows also the standard representation as well, using <code><mrk mtype="seg"></code> elements in the <code><target></code> elements. Note that some of those segments may be empty if only some segments have been leveraged.

===Pre-Translation===

Translatable entries can be pre-translted different ways. In this package, the result of pre-translation is as follows:

* Existing translations marked as '''approved''' are put in the <code><target></code> element and the attribute <code>approved</code> is set to <code>yes</code>. These entries are also put in the <code>approved.tmx</code> file.
* Existing translations without flag are put in the <code>unapproved.tmx</code> file.
* Existing translations coming from alternate-translation constructs in the original file (for example the <code><alt-trans></code> elements of an XLIFF document) are put in the <code>alternates.tmx</code> file.
* Translations coming from some leveraging steps are put in the <code>leverage.tmx</code> file.

In addition, if the option is set, alternate-translations and leveraged translations are also put in <code><alt-trans></code> elements for each given <code><trans-unit></code>.

==Package Layout==

Assuming that your package name is <code>pack1</code>, your input root ends with <code>main</code>, the target language is French, you have selected to use the same filenames as the input files for the output files, and you have the following source files:

--- main
|
+--- index.html
+--- myFile.idml
+--- subDir
|
+--- index.html

The layout of this package after creation will be:

--- pack1
|
+--- manifest.rkm
+--- *.tmx
+--- original
| |
| +--- index.html
| +--- myFile.idml
| +--- subDir
| |
| +--- index.html
|
+--- work
|
+--- index.html.xlf
+--- myFile.idml.xlf
+--- subDir
|
+--- index.html.xlf

* <code>original</code> contains a copy of the original source documents. You needs those files for post-processing.
* <code>work</code> contains the documents that are to be translated. The translation is expected to be saved into those files.

After post-processing it will be:

--- pack1
|
+--- done
| |
| +--- index.html
| +--- myFile.idml
| +--- subDir
| |
| +--- index.html
|
+... (same as after creation)

* <code>done</code> contains the merged translated documents. This directory is created during post-processing.

==Limitations==

* None known

[[Category:ITS]] [[Category:Translation Formats]] [[Category:Rainbow TKits]] [[Category:XLIFF]]

Rainbow TKit - Generic XLIFF - Revision history

Ysavourel: 1 revision imported

Ysavourel at 17:49, 17 February 2014