Beebox XLIFF Format

Beebox uses XLIFF in these places:

  • To export translation jobs to translation teams or translation management systems. 
  • To download selected segments from the translation editor.
  • When retrieving segments with the API.

Example

The following is a sample translation job containing a single segment. Obviously, a job may contain many <file> and <trans-unit> nodes:

<?xml version="1.0" encoding="UTF-8"?>
<xliff xmlns:wb="http://www.wordbee.com/Xliff" version="1.2" 
		wb:sender="My company" 
		wb:projectkey="93f522ff-74e7-4522-a886-8af737082059" 
		wb:jobname="Beeboxlinks 9 - fr" 
		wb:jobkey="4541ac4e-bdf8-44c4-88f9-ed83e86aeb78">

   <file original="R-Cautions.htm" datatype="x-beebox" source-language="en" target-language="fr" 
			date="2014-11-10T10:01:22.1353775Z" 
			wb:folder="" 
			wb:file="R-Cautions.htm" 
			tool-id="Beebox">
      <body>
         <trans-unit id="0" translate="yes" approved="yes" wb:editor="MachineTranslation" wb:words="1" wb:key="note">
            <source xml:space="preserve">Hello world.</source>
            <target xml:space="preserve">Bonjour tout le monde.</target>
         </trans-unit>
      </body>
   </file>

</xliff>

File Nodes

The Xliff uses <file> nodes to group segments coming from the same source file.

If the file contains segments from 10 different source files, you will see 10 <file> nodes.

Standard and Custom Attributes

The Beebox uses these attributes. Beebox custom attributes are prefixed with namespace "wb".

Xml node

Attribute

Description

 

xliff

wb:sender

Your company name. This is a Beebox specific extension to Xliff.

xliff

wb:projectkey

The unique Beebox project id. This is a Beebox specific extension to Xliff.

xliff

wb:jobname

The job name. This is a Beebox specific extension to Xliff.

xliff

wb:jobkey

The job id. This is a Beebox specific extension to Xliff.

file

datatype

Standard xliff attribute. Always contains “x-beebox”.

file

original

The name and relative path of the original file. Example "folder1/game.docx" or "mypage.html".

file

wb:file

The name of the original file, same as the “original” attribute. This is a Beebox specific extension to Xliff.

file

wb:folder

Always empty. This is a Beebox specific extension to Xliff.

file

tool-id

Standard xliff attribute. Contains “Beebox”.

filewb:***

If you include an instructions file (.beebox) with the source file you can include file-level meta information.

These will be stored as attributes here.

For example, if the instructions file contains this node with a file-level field:

"metadata": ["id""url""value""http://mine.com/page199.htm""type""file""title""Page URL" }]

Then, this attribute is added to the <file> node:

<file .... wb:url="http://mine.com/page199.htm" ....>

   

trans-unit

id

A sequential number assigned by the Beebox.

trans-unit

wb:editor

A code indicating the origin of a translation, if any. This is a Beebox specific extension to Xliff.

trans -unit

wb-words

Total source words of segment. This is a Beebox specific extension to Xliff.

trans-unitwb-chminMinimum allowed characters for translation. Included if specified only. This value can be assigned during reading the original file, refer to the text filter settings.
trans-unitwb-chmaxMaximum allowed characters for translation. Included if specified only. This value can be assigned during reading the original file, refer to the text filter settings.

trans -unit

wb-***

Optional meta-information included with the original segment: Hyperlink, Footnote, etc. This is a Beebox specific extension to Xliff.

For example, if the instructions file contains this node with a segment-level field:

"metadata": ["id""reference""value""AX-1024""type""segment""title""Reference" }]

Then, this attribute is added to the <file> node:

<trans-unit .... wb:reference="AX-1024" ....>

 

Encoding of Markup

If a source file contains markup then this markup is preserved during export. The Beebox uses regular XLIFF nodes to encode the markup.

 

 

 

Copyright Wordbee - Buzzin' Outside the Box since 2008