Ysavourel: 1 revision imported

2016-06-04T23:19:58Z

1 revision imported

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

Ysavourel: /* Package Format */

2014-02-17T20:38:36Z

Package Format

New page

{{Steps Header}}
__TOC__
==Overview==

This step creates a translation package from a set of input documents. The extracted files can be merged back after translation using the [[Rainbow Translation Kit Merging Step]].

Takes: Filter events. Sends: Filter events or raw documents.

The simplest way to use this step is in a pipeline like this:

: = [[Raw Document to Filter Events Step]]
: + [[Rainbow Translation Kit Creation Step]]

But you can perform other tasks before creating the translation kits. For example: segment the text and try to pre-translate it using different [[Connectors|translation resource connectors]].

: = [[Raw Document to Filter Events Step]]
: + [[Segmentation Step]]
: + First [[Leveraging Step]]
: + Second [[Leveraging Step]]
: + [[Rainbow Translation Kit Creation Step]]

(Such pipeline is [[Rainbow - Utilities|one of the pre-defined pipelines available in Rainbow]]).

==Parameters==

===Package Format===

<cite>Type of package to create</cite> — Select the type of translation kit you want to create. The following types are available:

: - [[Rainbow TKit - Generic XLIFF|Generic XLIFF]] (The files are extracted to [[XLIFF]] documents)
: - [[Rainbow TKit - PO Package|PO Package]] (The files are extracted to PO files)
: - [[Rainbow TKit - Original with RTF|Original with RTF]] (The files get an RTF layer)
: - [[Rainbow TKit - XLIFF with RTF|XLIFF with RTF]] (The files are extracted to [[XLIFF]] then get an RTF layer)
: - [[Rainbow TKit - OmegaT Project|OmegaT Project]] (The files are extracted to a new OmegaT project)
: - [[Rainbow TKit - Transifex Project|Transifex Project]] (The files are uploaded to a new or existing Transifex project)
: - [[Rainbow TKit - ONTRAM XINI|ONTRAM XINI]] (The files are extracted to an ONTRAM XINI package)
: - [[Rainbow TKit - Translation Table|Translation Table]] (The files are extracted to tab-delimited files)
: - [[Rainbow TKit - XLIFF 2.0|XLIFF 2.0]] (The files are extracted to XLIFF v2 document)

<cite>Options</cite> — Click this button to edit the option specific to the type of package currently selected. Not all types of package have options.

<cite>More Info</cite> — Click this button to open the wiki page for the help on the type of package currently selected.

<cite>Send the prepared files to the next step</cite> — Set this option to send to the next step the prepared files as raw documents instead of the filter events of the original input file. Note that this option has no effect if the select package format that do not support one output file for each input file.

===Output Location===

<cite>Root of the output directory</cite> — Enter the directory where you want to create the package. You can use the variables <code>${rootDir}</code> and <code>${inputRootDir}</code>, as well as any of the [[Template:Locales Variables|source or target locale variables]] (<code>${srcLoc}</code>, <code>${trgloc}</code>, etc).

<cite>Name of the package</cite> — Enter the name of the package directory to create.

<cite>Create a ZIP file for the package</cite> — Set this option to create a ZIP file from the generated package. The ZIP file has the same name as the project and is placed in the same directory with a <code>.rkp</code> extension.

===Support Material===

<cite>List of the files to include in the package</cite> — Shows the list of the support material items. Each item will be copied to its specified destination.

<cite>Add</cite> — Click this button to add an item to the list. After clicking on this button, click on <cite>Accept</cite> to accept the new item and add it to the list, or click <cite>Discard</cite> to cancel.

<cite>Remove</cite> — Click this button to delete the selected item from the list.

<cite>Origin</cite> — When adding an item: enter the path of the document or document set to copy. You can use <code>*</code> and <code>?</code> as wildcard characters. For example <code>C:\myProj\myExtra.*</code> will copy all files starting with <code>myExtra.</code> of the <code>C:\myProj</code> directory into the destination. You can use the variables <code>${rootDir}</code> and <code>${inputRootDir}</code>, as well as any of the [[Template:Locales Variables|source or target locale variables]] (<code>${srcLoc}</code>, <code>${trgloc}</code>, etc) in the origin.

<cite>Destination</cite> — When adding an item: enter the location of the copy of the original file in the package directory. The path must start with <code>\</code> or <code>/</code> that indicates the root of the package's directory. use <code><same></code> to use the same filename as the original. If the origin does not use wildcard characters you can set a different name in the destination to rename the copy of the document. You can use the any of the [[Template:Locales Variables|source or target locale variables]] (<code>${srcLoc}</code>, <code>${trgloc}</code>, etc) in the destination.

==Limitations==

* If this step is used in a pipeline that modifies the input file (e.g. with a [[Search and Replace Step]]), the "original" files saved in the generated project may not be usable to merge back the translated files. For example, a search and replace may result in more or less inline codes. You would need to change those files so they reflect the content that was really used at the point the content was extracted.

[[Category:Steps]] [[Category:Rainbow TKits]]

Rainbow Translation Kit Creation Step - Revision history

Ysavourel: 1 revision imported

Ysavourel: /* Package Format */