Better Translation Technology. XTM Connect for WordPress

Transcription

1 Better Translation Technology XTM Connect for WordPress

2 Documentation for XTM Connect for WordPress. Published by XTM International Ltd. Copyright XTM International Ltd. All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means, including photocopying, without prior written consent of XTM International Ltd. September 2018 XTM-International Ltd, PO Box 2167, Gerrards Cross, SL9 8XF, UK Tel.: +44 (0) Page 2

3 1. Table of contents 1. Table of contents Introduction Requirements and installation... 5 Requirements... 5 Supported versions of The WordPress Multilingual Plugin (WPML)... 5 Installation WordPress Multilingual Plugin (WPML)... 6 Configuration WPML Setup: Content language WPML Setup: Translation languages WPML Setup: Language switcher WPML Setup: Registration... 9 Overview Languages Translation Management String Translation XTM plugin XTM Settings Configuration Language mappings Default configuration WPML Job list XTM Project list Page 3

4 2. Introduction XTM Connect for WordPress is an auxiliary application for both XTM Cloud and XTM Suite. It connects directly to your WordPress website, automating the process of sending new or altered content to XTM and creating translation projects. When the project workflow is complete; it returns translated content to the website. XTM Connect for WordPress has several advantages, reducing the number of manual tasks, thereby decreasing costs, turnaround times, and human errors. Use of the application is provided under a separate software license and is not included in the standard XTM license or subscription agreement. Contact the XTM Sales at sales@xtm-intl.com to learn more about XTM Connect for WordPress and request a quote. Upon purchase, XTM will enable the API connection for you. XTM Connect for WordPress workflow diagram Page 4

5 3. Requirements and installation Requirements XTM Connect for WordPress is installed as an additional plugin to WordPress and requires the WordPress Multilingual Plugin (WPML) to be installed and enabled on the WordPress website. If you do not have WPML installed on your instance of WordPress, the module is available for purchase and download from Please ensure you have the PHP SOAP extension enabled in your server. For further information please go to SOAP setup documentation. You will also need your XTM API account details. For more information, please contact XTM support at Supported versions of The WordPress Multilingual Plugin (WPML) During the update of The WordPress Multilingual Plugin (WPML) from version to versions or higher several structural changes took place. For this reason, a distinction has been made into XTM Connect for WordPress for WPML versions 3.X.X and for versions and higher. The last tested and fully supported versions of WPML are and Installation The WordPress Multilingual Plugin (WPML) and XTM WMPL Connector plugins must be installed and activated on the WordPress server. 1. Purchase and download The WordPress Multilingual Plugins for WordPress from The WPML plugin modules include: WPML Multilingual CMS WPML String Translation WPML Translation Management WPML Sticky Links WPML CMS Nav 2. Install and activate the WordPress Multilingual Plugin (WPML) modules. Each WPML plugin module has to be contained in a separate zip archive and only one can be installed at a time. Open the WordPress menu, go to the Plugins tab, and click the Add New button. Click the Upload Plugin button. Select a WPML plugin module to install, then click the Install Now button. Install all of the WPML plugin modules, as listed in point 1. When all WPML plugin modules are installed, activate them on the plugins tab. 3. Install and activate the XTM WMPL Connector plugin. Open the WordPress menu, go to the Plugins tab, and click the Add New button. Click the Upload Plugin button. Select a the XTM WMPL Connector plugin and click the Install Now button. The XTM WMPL Connector plugin consists of only one zip archive. Alternatively, users with access privileges to the ftp where WordPress with the website is installed can extract the zip archives of all WPML and XTM plugin on their local drive, upload them to the servers../wp-content/plugins directory, and activate the plugin modules on the Plugins page. Page 5

6 4. WordPress Multilingual Plugin (WPML) Configuration The WordPress Multilingual Plugin must be configured before content can be translated. Open the WordPress menu, go to the Plugins tab and click the Configure WPML button, then follow the steps below. WPML plugin configuration 1. WPML Setup: Content language Select your original content language from the dropdown list. Selecting the original content language Page 6

7 2. WPML Setup: Translation languages Choose the languages in which you want to publish your content. Selecting translation languages Page 7

8 3. WPML Setup: Language switcher Configure the language switcher. WPML language switcher configuration Page 8

9 4. WPML Setup: Registration Registration is required to receive automatic updates of the WPML plugin but this can be skipped if preferred. WPML Registration Further information about the configuration of the WPML plugin is available in the WPML Getting Started guide: Any settings configured during the WPML setup can be updated later in the WPML tab of WordPress. Page 9

10 Overview The WordPress Multilingual plugin provides a number of new tabs to the WordPress menu, but only the following are essential for translation in XTM: Languages, Translation Management and String Translation. Languages Sections available in the WPML plugin The Languages section contains various language settings including those configured during the WPML setup. It is crucial to make sure Site Languages are set, and to check whether the Language switcher is configured correctly. Page 10

11 The Languages section of the WPML plugin Translation Management The Translation Management section of the WPML plugin is divided into Translation Dashboard, Translators, Translation Basket (displayed only when a job has been added to the basket), Translation Jobs, Multilingual Content Setup and Translation Notifications. Translation Dashboard The Translation Dashboard lists all page and blog items that can be translated on your website. The list provides information when an item was created, whether it is a page or a post and the publishing and translation status for specific languages. Translatable items can be filtered. A list of translatable pages and blogs Page 11

12 Page 12 XTM Connect for WordPress

13 Translation statuses: Not translated Waiting for translator In progress Complete Needs update The item is not sent for translation. The item is waiting for a translator to claim it or the translation is in progress. A project has been created in XTM and the item is in the process of translation. The item has been translated and returned. The item has been updated and requires another round of translation. Also, a list of languages set for the website is displayed below the content items. For each language it is possible to Translate, Duplicate content or Do nothing. Translate: content is translated into the specified language. Duplicate content: content is not translated. Instead, source text is copied to posts displayed for specified languages. Posts and pages with the duplicated content are then related to the source text. When the source text changes in the original post, texts in posts for the languages with duplicated content are automatically updated. Any changes introduced directly to posts with duplicated content will not be saved. Do nothing: no action will be performed for the specified languages. Content translation options Page 13

14 Translators The Translators tab contains the list of available translators, an option to add a new translator, and available translation services. When you have installed and activated the XTM plugin, the xtmwpml-connector will be visible. That is the default name for the XTM plugin. XTM Connect for WordPress only supports a WPML translator whose details are configured in the XTM plugin settings. For this reason, no other translator should be created on the Translators tab of the WPML plugin, as they will not be associated with the XTM plugin configuration. WPML Translators Translator languages It is important to check if the languages configured for the xtm-wmpl-connector translator correspond to the content and translation languages specified for the WordPress website during the WPML setup. Translator name It is possible to modify the translator s First Name, Last Name or Nickname to change how the connector is displayed on the list of translators. To do it just click the name of the connector and fill in the fields. Page 14

15 Changing name displayed for the XTM Connect application Translation Basket Jobs are added to translation basket from the Translation Dashboard and String Translation WPML tabs. The number displayed on the tab next to Translation Basket indicates the number of items in the basket. Items listed in the translation basket can be removed or sent for translation. You can change the automatic batch name and select a translator for the items. To send content to XTM, select the XTM translator displayed as xtm-wpml-connector or another name if it was changed. Page 15

16 WPML Translation Basket Translation Jobs The Translation Jobs tab lists jobs sent for translation from the translation basket. Translation jobs can be filtered by the translator assigned, by progress and by language combinations. WPML Translation Jobs Translation jobs are displayed in batches that can be expanded or collapsed. In the expanded view, it is possible to change the translators assigned to translation job items or cancel them using the Cancel selected button at the bottom of the page. Page 16

17 Cancelling translation of an item in WPML String Translation The String Translation section of the WPML plugin contains strings. These strings can come from various website elements that include theme texts visible on the website as well as texts and labels built-in in the backend of the website. Strings can be filtered by translation progress and text domain. A search functionality is provided to look for strings in all resources. Hardcoded strings are not taken for translation. In order to make a string translatable, you have to wrap it with _() or _e() function, for example: <h2>translation Management</h2> <h2><?php _e('translation Management','theme-text-domain');?></h2> WPML String translation Strings selected on the list can be added to the translation basket, deleted or their language can be changed. Page 17

18 String translation options Track where string appear on the site When this option is enabled, you can check where specific strings are displayed on the website. To view a string on the website, click the View in page icon in the View column. Auto register strings for translation WPML lists all text domains available on the website which confirms that all strings are detectable. Strings coming from text domains unintended for translation can be exclude to reduce false positive string search results. Translate texts in admin screens Sometimes the WPML incorrectly classifies a string and does not automatically display it in the string search results. In such cases, the string can be found using the Translate texts in the admin screens feature, provided that it is wrapped with the _() or _e() php function and contains a text domain. To find the string, click Translate texts in admin screens >>, expand the text domain of the string you are looking for. Then find it on the list, select it and click the Apply button at the bottom of the screen. If you are not sure what is the string s text domain, you can check it in the website html code. Adding a string to the list of translatable strings using Translate texts in admin screens Page 18

19 Finding the string just added using Translate texts in admin screens More information about the WPML plugin is available here Page 19

20 5. XTM plugin XTM Settings Configuration The connection between WordPress and XTM is configured in the XTM plugin settings. The XTM plugin automatically verifies if the details entered are correct. When it cannot connect with the XTM account, a message will be displayed. XTM Connector configuration in XTM plugin s settings XTM API URL URL of the SOAP service. In case of XTM Cloud, enter the following URL: XTM API Client name the name you enter in the Company field of the XTM login page. XTM API User ID the project creator user ID. XTM recommends to create a new user specifically for XTM Connect so that it is simple to track XTM Connect activity separately from human actions. The XTM Connect user needs to have a Project Manager role. You can check the user ID in XTM on the User list (see picture XTM User ID below). XTM API Password the password set for the project creator user. It is the normal password used by the user to log in to XTM XTM project Customer ID the customer, for which you will be creating projects. You can check the customer ID in XTM on the Customer list similar to the way it is presented on picture XTM User ID below. Project name prefix a prefix for projects automatically created by WordPress to differentiate them from projects created by Project Managers. Leave this field blank to disable the prefix. XTM User ID user response for XTM translation the address where notifications about the project will be sent. Page 20

21 Language mappings In this section, WordPress languages are mapped to XTM languages. It is important to verify that the language mappings are correct because XTM languages include variants of languages, such as English (UK), English (US) or French (France), French (Canada) or French (Switzerland). If a project is created in XTM using an incorrect language combination as a result of wrong language mapping, the customer s translation memory may not be leveraged. XTM Settings Language mappings Default configuration In this section, you can define the default settings and the behaviour of projects sent for translation using the XTM Connector. XTM Settings Default configuration Automatically move jobs from xtm translator to XTM System with default settings. When this option is enabled, any files sent to the XTM plugin from WPML are automatically processed by the connector using the default settings and a project is automatically created in XTM without any human interaction. Automatically send files to XTM from translator: First available (Local) When this option is enabled, any files requested for translation from the translation basket are sent to the XTM plugin when the selected translator is First available (Local). This option streamlines the workflow by assigning XTM by default to all translation jobs. Page 21

22 First available (Local) translator in WPML Translation Basket Default template Id The XTM plugin automatically detects any templates predefined for the customer in the XTM plugin settings. Customer predefined templates can be used to initiate a specific workflow with settings appropriate for the content at hand. WPML Job list The WPML Job list section of the XTM plugin lists jobs received from the WPML translation basket. Jobs can be handled using bulk actions and one of the project modes described above. Bulk actions include the following options: Send to XTM without template Send to XTM with template:[name of the template] The number of options depends on the number of templates defined for the customer. Also, it is possible to filter jobs by the translation progress as well as the source and target language. XTM Project list WPML Job list The XTM Project list section of the XTM plugin lists projects already created in XTM. It provides the possibility to check the translation progress and cancel a project if need be. It is also possible to perform these actions on multiple projects in one go, or on projects filtered by the project creation mode, translation progress or source and target languages. You can click the XTM project id to open your XTM login website. To check the XTM status of multiple projects or to cancel them, you can use the bulk actions option. Page 22

23 XTM project list Page 23

24 XTM International Ltd, PO Box 2167, Gerrards Cross, SL9 8XF, UK Tel.: +44 (0)