Internationalisation - Tech Setup

Table of Contents

  1. Overview


  1. it's easiest to translate a Seagull installation if you setup a copy of your live environment on a different host, ie
  2. the translations will eventually be committed to your source code repo, but you only activate the new languages when they're ready
  3. create an init.php file for your main customised module, let's say it's called Foo.
  4. in the init.php file create a task for adding new translators
    // define a new role for translators
    define('FOO_ROLE_TRANSLATOR',    3);
    class SGL_Task_CreateTranslators extends SGL_Task
        public function run($data)
            SGL::logMessage(null, PEAR_LOG_DEBUG);
            $aData[] = array(
                'username' => 'hugo',
                'first_name' => 'Hugo',
                'last_name' => 'french',
                'passwd' => 'my_passwd',
            // add more accounts as array elements
            $isActive  = true;
            $createdBy = SGL_ADMIN;
            $now       = SGL_Date::getTime(true);
            // process users
            foreach ($aData as $aUser) {
                $aUser['email']  = $aUser['username'];
                $aUser['passwd'] = md5($aUser['passwd']);
                // add user
                $userId = User2DAO::singleton()->addUser($aUser, $isActive,
                    FOO_ROLE_TRANSLATOR, $createdBy);
                // add prefs
                if (!PEAR::isError($userId)) {
  5. edit the config for the translation module and add languages you intend to translate. The 'onlyModules' key means only these modules will show up in your statistics screen which indicates what percentage of the translation is complete.
    extraLanguages="sv-utf-8 : swedish : swedish-utf-8,
    zh-utf-8 : chinese simplified : chinese_simplified-utf-8,
    zhtw-utf-8 : chinese traditional : chinese_traditional-utf-8,
    de-utf-8 : german : german-utf-8,
    es-utf-8 : spanish : spanish-utf-8,
    fr-utf-8: french : french-utf-8"
  6. ensure "Mark words which were not translated" is set to YES
  7. add the default data that corresponds to your new role, and its perms
  8. rebuild Seagull to activate the new roles, perms and translator users
  9. in the global filter chain add the SGL_Task_SetupExtraLanguages task after SGL_Task_CreateSession, this allows your translators to see their language translations in progress, even if their languages are not enabled in the global config
  10. if your site uses Ajax, don't forget to add the same task to your Ajax filter chain, also after SGL_Task_CreateSession
  11. create a cronjob that updates your languages files every 1/2 hour or so, eg:
    cd /var/www/html/my_site/translate/trunk;
    modules=`ls modules`;
    for module in $modules;
             svn up modules/$module/lang/;
    #updating js language files
    svn up www/foo/js/Localisation;
  12. create a cronjob that commits the language files and fixes the permissions, also every 1/2 hour or so
    cd $WEBROOT;
    chmod 777 www/foo/js/Localisation/*.js;
    #syncing js translation files
    $PHP $WEBROOT/www/index.php \
        --moduleName=translation --managerName=jstranslation \
        --action=createFiles --targetModule=foo --modulesToScan= foo,user2
    #listing files to be committed
    svn ci -m "automated commit for translation - module lang files" $moduleLangFiles;
    svn ci -m "automated commit for translation - js lang files" $jslangFiles;
    #setting correct permissions
    modules="foo user2";
    for module in $modules;
            chmod 777 modules/$module/lang/*.php;
            chmod 777 modules/$module/lang/email/*.php;