Page tree
Skip to end of metadata
Go to start of metadata

Visit this page for example ZIP import packages.

Please note: translate5 project strives to support the TIPP format as import and export format. Any kind of support for this development is welcomed.

File structure of an import package

TypeNameUsageMandatory
DirectoryproofReadContains a files and/or a folder tree with the files, that should be imported into the segment table of translate5. The folder tree inside of proofRead will be mirrored as folder tree inside of translate5.yes
DirectoryrelaisContains a structure that mirrors the structure in proofRead. All contained files are imported as relais/pivot content for the files in proofRead. Files existing in "proofRead" but missing in "relais" are skipped.no
DirectoryreferenceFilesReference files that are attached to a task for download. Additional information for the user working on the task.no
File*.tbxContains the terminology for the task. The contained terminology is used to mark terms in the task. Must reside on the top level of the zip-file. Only the first tbx-file in the zip file is used. Please see here for information, which terms are used for a task.no
FileQM_Subsegment_Issues.xmlContains the MQM issue types, that should be used for the task. If present, overrides the default MQM issue types for this task. An example file you find here.no
Filetask-template.xmlContains a task template. Can be used to configure translate5 in an task-specific way.no
FileDEU-ENG.transitConfig

Only for import packages, that contain STAR Transit NXT files.
The first three letters of the file name must contain the transit-specific source-language file extension (in the example "DEU" for German).
The last three letters of the file name (before the file extension ".transitConfig") must contain the transit-specific target-language file extension (in the example "ENG" for English).

The file itself can be empty. It is a flag file.

no
File*.bconfThis is a batch configuration file as exported from Okapi Rainbow. With Okapi Rainbow you can create your own custom file filters, for example for special kind of xml or txt-files. If you use the Okapi plugin for translate5, you can seemlessly use Okapi in the background to convert files on import time - and convert them back on export (without the user having to touch Okapi). Please see details on the translate5 file format page and on the translate5 Okapi Plug-in page

Usage hints

  • Folders and files mentioned in the above package structure MUST reside on the top level of the zip file (NOT inside some sub-folder).
  • SDLXLIFF, openTM2 XLIFF and CSV-files can be mixed inside the proofRead folders an any needed way. STAR Transit NXT files have to be in a separate import package.
  • Please use only ASCII characters in file or directory names and no special characters or German "Umlaute".
    The Zip format does not provide any information in which encoding your operating system has saved a file or directory name. Due to this lack of the ZIP standard, it might cause errors inside translate5, if you do use file or directory names with NON-ASCII characters. Only exception to this rule: Your file system does use UFT-8 encoding (like Linux and Mac do). Addition: In September 2018 a test with Windows 10 showed, that special characters seem to be encoded also as utf-8 under windows with zip. Independent if native windows zip, winrar or 7zip was used. So maybe this issue is solved meanwhile through an always advancing Windows system (smile)
  • No labels