Page Comparison

This chapter describes how to send original files/content plus any translated files/content to the Beebox and get translations aligned. We assume that you are already familiar with the Beebox and will skip more general explanations.

Align files manually

Let us suppose that we have an English source file named “marketing\myfile.docx”. We further have existing French and Spanish translations of this file.

...

• Always copy the source file at the end. This is important in automated setups where the Beebox polls the “in” directory for new/changed source files. We want to have the Beebox poll the source file only after we have properly copied the translations and the instructions.
• Note that the translations are saved to the “out” directory and inside the language specific sub-directory. Make sure your Beebox project is configured for these exact languages.
• Note that the translated files are given the exact same relative path (name) as the source file. This is essential or otherwise the Beebox will not find your files.
• The instructions tell the Beebox that it shall extract and use the translations from the French and Spanish files. You must indicate the “locales” node with the list of languages (at least one).

Align files using the API

Instead of copying files to the “in” and “out” directories of a Beebox project, you can of course do this with the API.

...

1. Send the French translation in the body of API method:
   (PUT) /api/files/file?token=&locale=fr&folder=&filename=marketing\myfile.docx
2. Send the Spanish translation in the body of API method:
   (PUT) /api/files/file?token=&locale=es&folder=&filename=marketing\myfile.docx
3. Send the instructions file in the body of API method:
   (PUT) /api/files/file?token=&locale=en&folder=&filename=marketing\myfile.docx.beebox
   
   This file contains Json and is UTF-8 encoded:
   { "align": { "locales": ["fr", "es"]  }  }
4. Send the English original content in the body of API method:
   (PUT) /api/files/file?token=&locale=en&folder=&filename=marketing\myfile.docx

API documentation.

Example of a post-editing workflow

This is a frequent use-case for which other tools do not propose a solution and which the Beebox handles in a breeze.

...

• Initial translation:
  • Send source file to Beebox and wait until translated file is created.
  • Deliver file to customer.
     
• Post editing:
  • Customer edits the translated file and sends it back to you
     
• Second translation:
  • You save the file to the “out” directory and update the source file’s date
  • The Beebox will incorporate all the changes both in the source file (if any) and the translated file (edits, comments).
  • The Beebox will create the translated file with any further updates done by the translation team.
  • Deliver file to customer.
     
• Post editing, again:
  • If the customer does further editing, start over again…

When to use alignment

Make sure to enable alignment in an instructions file only when necessary. Alignment consumes processor resources and may slow down the Beebox:

...