Translation Workflow With B-Translator

Drush commands that are used for importing projects are:

btr-project-add (btrp-add)

Create a project and import its POT files into the DB. If such a project already exists (the same origine and project), it will be deleted first (related data will be erased as well).

btr-project-import (btrp-import)

Import the PO files of an origin/project/lng into the DB. Templates of the project (POT files) must have been imported first. If the corresponding template for a file does not exist, it will not be imported.

There are also commands for getting a list of projects and for deleting a project:

btr-project-ls (btrp-ls)

List imported projects, filtered by origin/project.

btr-project-del (btrp-del)

Delete everything related to the given origin and project.

To get more details about the arguments etc. use drush help command.

The scripts in the directory import/ are used to import projects from a certain origin. For example kde.sh imports (or updates) all the KDE projects, office.sh imports/updates all the LibreOffice projects, and so on.

If a list of projects is passed on the command-line to these scripts, then only the specified projects will be imported (instead of all the projects).

In the import scripts, usually the French (fr) translation files are used as template files.

This is a simple script for importing the Pingus project:

#!/bin/bash -x

### go to the script directory
cd $(dirname $0)

### set the drush alias
drush_alias=${1:-@btr_dev}
drush="drush $drush_alias"

### set some variables
origin=Test
project=Pingus
dir=$(pwd)/pingus

### create the project
$drush btrp-add $origin $project $dir/pingus-fr.po

### import the PO files of each language
for lng in fr sq
do
    $drush btrp-import $origin $project $lng $dir/pingus-$lng.po
done

In this case the project has only a single translation file (.po). If the project has more then one translation files, then the directory of these translation files will be passed as an argument to the commands drush btrp-add and drush btrp-import, instead of the translation file.

When a project is imported, an initial snapshot is created and stored in the DB as well. This initial snapshot contains the original files that were used for the import. No diff is made because there is nothing to compare with.

Immediately after the initial snapshot, another snapshot is done, by exporting files in the original mode. This snapshot will generate a diff, which contains the differences that come as a result of formating changes between the original PO format and the exported PO format. It also contains the entries that are skipped during the import. In general this diff (the first diff) contains changes that are not interesting for the translator.

Then another snapshot is made, using the most_voted mode of export, which will generate a diff that contains all the feedback and suggestions made before the import. If the import is actually an update (re-import) of the project, this diff contains the suggestions that the translator has probably rejected previously, and making this snapshot ensures that they are not suggested again to him.

This logic of the initial snapshots and diffs is implemented automatically during the import of the project.

Then, whenever a translator checks the latest diff, it is a good idea to make a snapshot as well, which will generate the diff with the previous snapshot (and store it on the DB). As a result, the translations that have been already suggested to him will not be suggested again.

btr-project-snapshot (btrp-snapshot)

Make a snapshot of the PO files for the given origin/project/lng. Also generates the diffs with the previous snapshot and saves them in DB.

btr-project-diff-ls (btrp-diff-ls)

Show a list of diffs for the given origin/project/lng.

btr-project-diff-get (btrp-diff-get)

Get the content of the specified diff.

btr-project-diff (btrp-diff)

Find differencies between the last snapshot and the current state of the project.

To get more details about the arguments etc. use drush help command.

A script like this can be used by the translators to get the diffs of the projects from the server, through the REST API.

$ utils/wget-diffs.sh

Usage: utils/wget-diffs.sh origin project lng [nr]

    Get the diffs of a project using wget and the REST API.
    If 'nr' is missing, then the list of diffs will be retrieved instead.
    If 'nr' is '-', then the latest diffs (since the last snapshot)
    will be computed and returned (it will take longer to execute, since
    the diffs are calculated on the fly).

Examples:
    utils/wget-diffs.sh KDE kdelibs sq
    utils/wget-diffs.sh KDE kdelibs sq 1
    utils/wget-diffs.sh KDE kdelibs sq 2
    utils/wget-diffs.sh KDE kdelibs sq -