README

Automatically translate and review your content via Lokalise

DEMO VIDEO : https://www.youtube.com/watch?v=5gyPa9YW020

Overview

This extension will work as a bridge between Pimcore and Lokalise for the purpose of automating the whole translation workflow. Thus eliminating most of the manual steps in the task along with availing quality translation-review service from Lokalise.

Features

• Translation & Review - Data Objects, Documents, and Shared Translation
• Workflow management
• Translation progress tracking
• Works with Bulk Objects - Push and Pull for Translation
• Auto push on publish event in Document and Object (New)
• Individual Object Sync (New)

Requirements

• Pimcore 11

composer require pdchaudhary/lokalise-pimcore:3.0

• Pimcore 10

composer require pdchaudhary/lokalise-pimcore:2.x

• Pimcore 5.8 or 6.x

composer require pdchaudhary/lokalise-pimcore:1.0.7

Installation

1. Open Pimcore admin panel
2. Go to Setting and click on Bundles
3. Click on plus icon(+) to enable the plugin
4. Then add “lokalise_api_key” in website setting from (Setting -> Website settings)
5. Generate the api key from Lokalise with read and write access. To learn how to generate Lokalise api key please refer to Lokalise documentation.
6. Now that the Lokalise bundle is enabled and configured, to install go to Settings -> Bundles -> Install(+ icon) against the Lokalise bundle.
7. The installation process involves creating 3 projects within Lokalise one each for Documents, Objects and Shared Translations. The projects in Lokalise would be created to have the same number of languages as defined in Pimcore settings. Post creation of projects in Lokalise, their Lokalise projectids would be added to websitesettings. If in case the projects already exist in Lokalise, their projectids would be synced to websitesettings.
8. The installation is now successfully completed.

Document translation

There are two flows in the document translation.

Create Document:-

1. After opening a document. Lokalise Translate Dropdown will be available on the toolbar. A “Create” option is available in the dropdown for new documents.
2. Clicking on the “Create” button, it will open the modal form for language-navigation-title configuration. After filing this form click on the “Apply” button.
3. After clicking on the “Apply” button, it will generate keys into Lokalise and then it will change the status for the parent document to “Sent”.
4. Then to get the translations of document keys from Lokalise by the translation would have to be verified & reviewed.
5. After that you need to run document sync from proccess manager. a child document for that language is automatically generated with the received translation keys and also it will be set verified for that child document or you can also run.

Update Document:-

1. After updating the main document, click on the “Update” button in the Lokalise dropdown.
2. Note that Update option is only available when their child documents are already created from Lokalise.
3. After clicking on the “Update” button, It will update keys in Lokalise. The document state will change to “Updated”.
4. Only the updated component/keys would be sent for the update in translation. Those keys would be set to unverified at Lokalise end, and would be required to be verified in order to get them updated in Pimcore.
5. Need to Click Document sync aftet that it will check full document translation in a certain language is done. If so, a child document for that language is automatically updated with the received translation keys and also it will be set verified for that child document.

Note : Don’t push the keys if parent(path) document is not available for child documents For example: I want to generate a - > test page as de -> test page but de is not available then it will not work so first we need to generate de.

Object translation

Create Object:-

1. In Object, fields/keys creation option is available at Toolbar -> Lokalise Dropdown -> Create.
2. This will send the fields as keys to Lokalise and change the status of the Object from “New” to “Sent”.
3. Need to click on object sync to get the translations of Object fields/keys from Lokalise by setting them reviewed and verified.

Update Object:-

1. Update object works the same as Update Document.

Shared translation

There are two jobs for that

1. Generate/Update keys job (Push Shared translation)
2. Sync keys job ( Pull Shared translation) It will generate/update and sync with Lokalise with those jobs.

Auto push in document and object

Steps to enable auto push

1. Goto website settings
2. Add lokalise_auto_push setting with checkbox type
3. Enable lokalise_auto_push

List of jobs

1. Sync documents (Work as bulk pull)
2. Sync objects (Work as bulk pull)
3. Bulk Object Push
4. Generate/Update Shared Translation keys
5. Sync shared translation
6. Sync Lokalise keys with Pimcore database