This page is still a beta!

1.2. User manual

Installation

Download the extension from the TYPO3 extension repository or from forge.typo3.org. Then install it with the extension manager. If you already use an older version of l10nmgr, make a backup of the extension directory. In case something fails, you'll have the possibility of re-establishing the original installation state from where you started the update.

Please note that you first need to install the extension static_info_tables.

 Platforms and versions supported

  1. Linux/Unix Server, Windows

  2. Apache, MySQL,

  3. PHP 4 (4.3 or higher) & PHP5 (recommended 5.2 or higher)- compiled with --enable-pcntl  for automation via /services- compiled with  --enable-zip for zip generation (v4)

  4. TYPO3 version 4.1.X, 4.2.X

Note: Future versions will require PHP 5.2 or higher!

Creating a Localization Manager configuation

The Localization Manager first requires a Localization Manager configuration record in which you define the scope of translation or export/import of localizable contents. The Localization Manager configuration is a record that has to be created at the starting point in the page tree from which you want to start your translation or export/import.

To create a Localization Manager configuration record, proceed as follows:

  1. Go to the backend and click on  Web > List

  2. Select the first page in the page tree from where you want to start your translation

  3. In the right window click create new record and then select Localization Manager Configuration

  4. Fill in the fields as shown in the following screenshot

  5. Save the configuration

Figure 3: Creation of localization manager configuration

Online translation

To translate online in the TYPO3 backend do the following:

  1. Go to the backend and click on Web > Localization Manager.

  2. Select your previously created localization configuration from the table and click on the name of the configuration. This opens the Localization Manager and loads settings from the configuration.

  3. Select the target language for your export from the drop-down list.

  4. Select Online translation from the drop-down list and fill in the translations into the form,

  5. Upon completion click Save to store the translations to the database.

    Figure 4: Online translation

Export

The export function allows for exporting pages and their content into a) a localization-friendly XML format or b) the MS Excel XML format.

In order to export pages and page content to be localized, proceed as follows:

  1. Go to the backend and click on Web > Localization Manager.

  2. Select your previously created localization configuration from the table and click on the name of the configuration. This opens the Localization Manager and loads settings from the configuration.

  3. Select the target language for your export from the drop-down list.

  4. Select XML Export/Import or MS Excel Export/Import from the drop-down list and click on the Export tab. For translation with professional translation tools choose XML. For translation with MS Excel or OpenOffice Calc choose Excel.

Figure 5: XML export settings

Figure 6: Excel export settings

    1. New/changed content only: Check this option if you only want to export new or changed content for translation. The comparison is always based on the default language version of an element.

    2. No hidden content: Check this option if you do not want to export hidden content elements (often content elements that are still not ready to be published).

    1. Check for already exported content: Check this option if you want to make sure that you don't export the same translation job twice.

    1. Do not check XML: Select this option if you don't want to use the inbuilt XML check. In that case Localization Manager includes content that is not XML wellformed as CDATA elements. Otherwise this contents is not exported and you will find error messages indicating the Ids of the skipped elements.

    1. Check encoding (UTF-8): Check this option if you want to make sure that the output XML file consistently used UTF-8 encoding.

    2. Force source language: Select a language from the drop-down list to choose a source language for translation other than the default language (relay translations)

    5. Click on Export to start the export.

    6. The data is now retrieved and packed into  the desired file format.

    7. Save the export file.

Download configuration files

Download configuration files

Localization Manager comes with predefined configuration files for across, DéjàVu, MemoQ, SDL TRADOS TagEditor and SDL PASSOLO. Configuration files or settings files contain information about the localization format, e.g. which tags are internal or external, which tags or attributes are translatable or not, etc. With this information translation tools are able to extract only translatable information from the file and protect non-translatable information from being touched. Download the configuration files and send them to the translator or translation service provider together with the XML.

To download the configuration files, proceed as follows:

  1. Go to Web>Localization Manager in the backend.

  2. Select a localization configuration from the table and click on the name of the configuration. This opens the Localization Manager and loads settings from the configuration.

  3. Select the target language for your export from the drop-down list.

  4. Select XML Export/Import from the drop-down list and click on the Settings tab.

  5. Download the configuration file for your translation tool with a right-click on the desired configuration > Save target as

Figure 7: Download settings files for translation tools

Import

To import the translated XML or MS Excel files, proceed as follows:

  1. Go to Web>Localization Manager in the backend.

  2. Select your previously created localization configuration from the table and click on the name of the configuration. This opens the Localization Manager and loads settings from the configuration.

  3. Select the target language for your export from the drop-down list.

  4. Select XML Export/Import or MS Excel Export/Import from the drop-down list and click on the Import tab.

  5. Set the import options:

    1. Generate preview links: Check this option to generate preview links for all imported pages. You can then send these links to translators or reviewers so they can proofread the translations.

    2. Delete previous localizations before import: Check this option to delete old translations before importing new ones.

  6. Select the file to be imported (XML) from your local hard drive.

  7. Click on Upload to start the import. Now the localized data is written to the appropriate database tables. Upon completion you will see a message on the bottom telling you how many data sets have been imported.

Figure 8: XML import settings

Note: Make sure the file to be imported is well-formed XML. If setup correctly translation tools will not modify or corrupt the XML. Anyway, sometimes translators insert non-standard entities into the XML, e.g. ® for ® leading to XML parsing errors. Just substitute the entities with their original character before import and everything works fine.

FAQs

  1. Q: When I download the localization package and open the XML file, my XML editor fails (Error: encoding is not correct UTF-8). What can I do?A: The reason might be a database and/or configuration problem. Check the TYPO3 configuration for UTF-8 database support. You might also want to set TYPO3_CONF_VARS[BE][forceCharset] = utf-8 , and check [SYS][multiplyDBfieldSize] and [SYS][UTF8filesystem]. (See http://wiki.typo3.org/index.php/UTF-8_support for more information). Localization Manager assumes that you are using UTF-8 (which is the most highly recommended for multilingual websites).

  2. Q: When I try to export localization data, I get a database error and the message: No source language given. A: Ensure that you have installed static_info_tables and that you have correctly set up your website languages.

  3. Q: I get the error message “Call-time pass-by-reference has been deprecated...” under PHP5. What can I do?A: Add “php_value allow_call_time_pass_reference 1” to your .htaccess file.

  4. Q: My exported files are not valid XML. What can I do?A: Problem is mainly due to nasty bodytext fields or other database fields where editors are allowed to insert HTML code. Try to use Tidy to clean the contents of theses fields. Or use an XML editor and fix the errors manually ;-)