LiveWords extension for Magento 1

Transcription

1 LiveWords extension for Magento 1 Version 1.0 (beta) Compatible with Magento CE 1.9.X User instructions Brought to you by LiveWords B.V. Burgemeester Haspelslaan NB Amstelveen, The Netherlands info@livewords.com Developed and supported by Tauros Media Nederland B.V. Van Baerlestraat 124, 1071 BD Amsterdam +31 (0) info@taurosmedia.com LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 1

2 LiveWords is cloud software for better translation management. It automates the change process with managing multilingual content by adding capabilities such as change detection, content distribution, reusing translations and translation analytics. LiveWords lets webshop owners translate and run their existing website or webshop in a number of additional languages like Spanish or Chinese. It creates a controlled translation workflow that eliminates manually moving content between translators and content creators, and signals any changes to translated content. It s a translation environment for translators to author, review, search for, share and reuse translations with a focus on web content. Translations are shared across the webshop team, and are available for publication immediately after they have been saved or reviewed. Both human and machine translation is supported by LiveWords. Also, LiveWords fully supports HTML within translatable strings. This means you can easily translate WYSIWYG-enabled fields as well. This LiveWords extension can connect your Magento CE platform with your LiveWords account and will help you in translating your content (products, categories, CMS pages and CMS static blocks). The extension is compatible with Magento CE 1.9.X versions. Note that you need to be registered on LiveWords to be able to use this Magento-LiveWords extension. This document provides user instructions and information about for LiveWords-Magento extension. Note: It is assumed that the user/developer trying to install and configure this LiveWords extension has basic understanding of Magento CE 1.9.X backend and LiveWords back-office. Reference links for users: 1. Magento CE official user guide: e.pdf 2. LiveWords user guides: 1. LiveWords source configuration: Source-Configuration-Magento LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 2

3 1. USER INSTRUCTIONS 1.1 General configuration From extension s general configuration section, all features of this extension can be controlled. It can be accessed at Magento backend > System > Configuration > LiveWords (left column) > Translations >... Let s take up each configuration section one by one: General options Enabled = Yes / No This settings will enable/disable the Magento-LiveWords extension. Select Yes if you want to keep the extension active. Select No to disable it API options In this section you can enter your LiveWords API details. You need to be registered on LiveWords to obtain an account domain & API key. Note: Make sure that everything entered here is correct, otherwise the extension will not be able to connect to LiveWords system and translations will not work. - URL: Enter LiveWords API URL here. You can get it from LiveWords account. Demo: Production: - Account Domain: Enter your LiveWords API Account-Domain here. You can get it from LiveWords account. - API key: Enter your LiveWords API key here. You can get it from LiveWords account interface. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 3

4 - Debug: This option is for developers and can be used to log the functioning/errors of the translation extension. You can get these details from Account section of your LiveWords account interface, as shown below: Once you enter and save API details, you also need to configure the language settings for each of your store-views in Magento backend. Source language is the language of your Magento store in which all your current content is saved. For example, if your site and its content is saved in English right now, then English is your source language. There is no separate setting required for Source language in this extension. We use the language that you have set as Locale language in your Magento store settings. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 4

5 Target language is the language in which the content of a particular store-view needs to be translated into. So if the store-view is to be in German and its content has to be translated in German, then your target language of that store-view should be German. Note that these target languages should be the same that you have setup in LiveWords side of settings too. Please refer to section 1.2. LiveWords configuration of this same document to know more about those settings. To set the Target language in Magento, you need to go to Magento backend > System > Manage Stores > You will see all your stores listed in that section. Then you need to open each of your store-views one by one and select correct Target language for it and save that store-view. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 5

6 Once you have selected correct target language for each of your store-view then you can go back to general settings of the LiveWords extension and configure it further. Ie. Go to System > Configuration > LiveWords (left column) > Translations > Category options From this section, you can control translations of your product category content. You can choose to translate category fields like Name, description, Meta-description, Metakeywords, Page titles etc. If you do not select any category field here, its content will not be considered for translations. - Translation update: Yes will enable sending of translation request when you edit and save any product category in Magento. Note that this setting will only work if you have saved category content in default scope active in 'entity edit form'. If you select any store-view scope and make changes to the category content, the request will not be sent to LiveWords. The extension operates on assumption that there is a default base language set for all entities. Also, this particular setting does not apply to new categories, it works only when you save an already existing category. - Target language: From this field, you can select all target languages in which your product category content needs to be translated into. ie, if you select French and German here, your category content will be submitted for French and German translations to LiveWords and same will be sent back once translated. This is a global configuration and will be used only when target language is not selected at category level. - Fields: This list will show all category attributes/fields that hold text content. You can select which ones you want to include for translations. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 6

7 Product options From this section, you can control translations of product content. You can select to translate any or all text fields (name, description, short description etc.) that are available per product. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 7

8 - Translation update: Yes will enable sending of translation request when you save any product. Note that this setting will only work if you have saved product content in default scope active in 'entity edit form'. If you select any other store-view scope and make changes to the product content, the request will not be sent to LiveWords. The extension operates on assumption that there is a default base language set for all entities. Also, this particular setting does not gets applied to new products, it works only when you save an already existing product. - Target language: From this field, you can select all target languages in which product content needs to be translated into. ie, if you select French and German here, your product content will be submitted for French and German translations to LiveWords and same will be sent back once translated. This is a global configuration and will be used only when target language is not selected at product level. - Fields: This list will show all product attributes/fields that have text content. You can select the ones you want to include for translations. If you do not select a field here, it will not be considered for translations CMS page options From this section, you can control translations of content of your CMS pages. You can select to translate text fields like content, title, heading, meta-fields of CMS pages. - Translation update: Yes will enable the sending of translation request when you save any page. - Target language: From this field, you can select all target languages in which CMS page content needs to be translated into. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 8

9 ie, if you select French and German here, your page content will be submitted for French and German translations to LiveWords and same will be sent back once translated. This is a global configuration and will be used only when target language is not selected at individual page level. - Fields: This list will show all fields that have text content. You can select the ones you want to include for translations. If you do not select a field here, it will not be considered for translations CMS block options From this section, you can control translations of content of your CMS static blocks. You can select to translate text fields like title and content of static-blocks. - Translation update: Yes will enable the sending of translation request when you save any block. - Target language: From this field, you can select all target languages in which CMS static-block content needs to be translated into. ie, if you select French and German here, your CMS static-block content will be submitted for French and German translations to LiveWords and same will be sent back once translated. This is a global configuration and will be used only when target language is not selected at individual static-block level. - Fields: This list will show all fields that have text content. You can select the ones you want to include for translations. If you do not select a field here, it will not be considered for translations. Once you are done configuring the extension, you need to make sure that it is connected and configured on LiveWords end as well. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 9

10 1.2. LIVEWORDS CONFIGURATIONS Some settings need to be done in LiveWords interface as well before you can start with translating your webshop content. - Feed configuration: It is strongly advised that you consult with LiveWords for exact instructions and you can also refer to following article. - Callback configuration: The callback URL can be configured in Sources. When you select a source, you see that every target has a link "//to-be-defined". If you click this link you can edit it and replace it with the callback URL. The callback URL has to end with a forward slash. A user must add callback URL to every source target in order to receive published items. The URL must be in form LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 10

11 1.3. TRANSLATIONS Now that Magento-LiveWords extension is configured and is connected with your LiveWords account, you can start with submitting translation request for content of your Magento webshop. As you already know, Magento holds all its content in Products, Product categories, CMS pages and CMS static-blocks. Let s take up each type of entity one by one Translate products You can manage your product content from Magento backend > Catalog > Manage products > All your products will be listed. After LiveWords extension installation, there will be a new column titled Translation status. This column will display an overview of status of translations of your product content. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 11

12 You can then open your products one by one and submit their content for translation using translate button as shown in below screenshot. On individual product level, you can select LiveWords target language for this particular product. Ie. If you select French and German here, the content of this product will be translated into French and German. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 12

13 This setting over-rides the global configuration that you set in general extension configurations. Once you select required languages here, you can save your selection using Save and continue button. Then you can click on Translate button to send translation request of this product content to LiveWords API. The grey tab to the left of this translate button will always show latest status of the translation. Ex: [ Translated: FR, EN Submitted: NL Not submitted: IT ] Mass translation of products: You can also initiate mass translation for all/multiple products at once. From product list page in backend, you can tick-select certain or all products and then click on Actions dropdown and select Translate option. You can then click on Submit button to submit translation request to LiveWords. This will send content of all selected products to LiveWords system for it to be translated and sent back to Magento s correct store. Note: If a product is not assigned to a website in Magento then the module cannot send its content for translation to Livewords. This LiveWords extension exchanges translations on basis of websites, so it is important that your products are assigned to websites correctly in Magento backend. It is assumed that you would have taken care of this website association setting already for all your products. It is a core configuration and without it your products will not show up on website frontend. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 13

14 You can check if all your products are assigned to a website or not from product list section in Magento backend Translate product categories You can manage content of your categories and sub-categories from Magento backend > Catalog > Manage categories > Click and select your category from tree in left column. On category level, you can again select LiveWords target language for each category. Ie. If you select French and German as target language, the content of this category fields will be translated into French and German. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 14

15 This setting overrides the global configuration that you set in general extension configurations. Once you select required language, you can save the selection. Then you can click on Translate button to send translation request to LiveWords API. The grey tab to the left of translate button will always show latest status of the translation. Ex: [ Translated: FR, EN Submitted: NL Not submitted: IT ] You can then open your categories one by one and submit their content for translation using the dropdown and translate button as shown in above screenshot Translate CMS pages You can manage content of your CMS pages from Magento backend > CMS > Pages > all your existing CMS pages will be listed below LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 15

16 Click and select the one you want to translate. On individual page level, you can again select LiveWords target language for each page. Ie. If you select French and German here, the content of this page will be translated into French and German. This setting over-rides the global configuration that you set in general extension configuration. Once you select required language, you can save this selection. Then you can click on Translate button to send translation request to LiveWords API. The grey tab to the left of translate button will always show status of the translation. Ex: [Translated: FR, EN Submitted: NL Not submitted: IT ] You can then open your CMS pages one by one and submit their content for translation using the dropdown and translate button as shown in above screenshot. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 16

17 Translate CMS static blocks In addition to pages, static blocks are also widely used to display content in different sections of Magento frontend. You can read more about it: You can manage content of your CMS static blocks from Magento backend > CMS > Static blocks > all your existing CMS static-blocks will be listed below Click and select the block one you want to translate and it will open that block. On block level, you can again select LiveWords target language. Ie. If you select French and German here, the content of this block will be translated into French and German. This setting overrides the global configuration that you set in general extension configurations. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 17

18 Once you select required language, you can save the selection. Then you can click on Translate button to send translation request to LiveWords API. The grey tab to the left of translate button will always show status of the translation. Ex: [ Translated: FR, EN Submitted: NL Not submitted: IT ] You can then open your CMS static-blocks one by one and submit their content for translation using the translate button as shown in above screenshot. This completes out tour of LiveWords-Magento extension backend configuration and features explanation. You can now use and repeat the same steps as many times as you want for all your content. 2. CONTACT AND SUPPORT We are always available to answer your translation or extension related queries and we strive to provide prompt technical as well as configuration support. You can contact us using our contact form at: You can write to us at info@livewords.com Or you can also call us at: or Feel free to give us a visit at: LiveWords Burgemeester Haspelslaan 15, 1181 NB Amstelveen The Netherlands Your feedback and suggestions for our LiveWords extension are always welcome and will be appreciated by our team. LIVEWORDS EXTENSION FOR MAGENTO CE 1.9.X USER INSTRUCTIONS 18