Extendware DeeplTranslator Glossary Extension for Magento 2

Extendware DeeplTranslator Glossary Extension for Magento 2 enables seamless integration with the DeepL Translator. This extension allows users to manage glossaries directly from the Magento admin panel, offering options to create, view, and delete glossaries. These glossaries ensure consistent translation of specific terms across various languages supported by the DeepL API.

Extendware’s DeepL Translator Glossary Extends DeepL Translator to add the following features:

Glossary-Based Translation: The extension allows users to translate specific terms using the glossary entries they have defined. Glossary terms are translated exactly as specified, while other content is fetched and translated dynamically through the DeepL API.

Easily Manage Glossaries: You can create and maintain a list of glossary entries directly from the Magento admin panel via a user-friendly Glossary Grid. This feature makes it simple to add new terms and manage existing ones efficiently.

One-Click Glossary Synchronization: After adding or modifying your glossary, you can easily sync it with the DeepL Glossary API with a single click. This ensures that your local glossary is always up-to-date with the entries on DeepL’s server for consistent translations.

Interested in Extension Installation?

Visit our installation service page https://www.extendware.com/magento-extension-installation-service.html for more information

Got questions? Feel free to contact us! Support Form.

Installation Procedure

  • Download your extension package from the Download page after purchasing the extension.

  • Open the extension ZIP file you downloaded and extract it to a directory on your computer using a tool like WinRar, WinZIP or similar.

  • Upload the extracted folders and files into the root directory of your Magento installation. The root directory of Magento is the folder that contains the directories “app”, “bin”, “lib” and more. All folders should match the existing folder structure. If one of our extensions is already installed and you’re updating it, make sure to overwrite the existing files of the extension.

  • Connect via SSH and run the following commands (make sure to run them as the user who owns the Magento files!

    php bin/magento module:enable --clear-static-content Extendware_Core

php bin/magento module:enable --clear-static-content Extendware_DeeplTranslator

php bin/magento module:enable --clear-static-content Extendware_DeeplTranslatorGlossary

php bin/magento maintenance:enable

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

php bin/magento maintenance:disable

  • In case if you still do not see the extension active, Go to Admin -> System -> Cache Management and click both the ‘Flush Magento Cache’ as well as the ‘Flush Cache Storage’ button.

User Guide

We highly recommend gathering all the below information, before starting the installation.

Installation in your Magento Online Shop

Type 1: Zip file

  • Unzip the zip file in app/code/Extendware

  • Enable the module by running php bin/magento module:enable Extendware_DeeplTranslatorGlossary

  • Apply database updates by running php bin/magento setup:upgrade

  • Flush the cache by running php bin/magento cache:flush

Create a new Glossary

Navigate to Extendware -> Deepl Glossary -> Add Glossary then click on Add new Glossary.

  • Glossary Name: Allows you to set a custom name for the glossary you are creating or editing.

  • Source Language: Choose the language from which the terms in the glossary will be translated.

  • Destination Language: Select the target language into which the terms will be translated.

  • Glossary ID: A system-generated unique identifier for the glossary, created when the “Sync Glossary” button is clicked.

  • Enable: A toggle to indicate whether the glossary is ready to be used with the DeepL API.

    create_a_glossary

Additionally, there are action buttons for:

  • Delete Glossary: Removes the current glossary.

  • Sync Glossary: Synchronizes the glossary with the DeepL API.

  • Save Glossary: Saves the glossary along with its terms and translations.

GlossaryEntries Configuration

  • Select Glossary: A dropdown menu to choose an existing glossary from the available list. The selected glossary will be the one that stores the terms and their translations. This is required before entering any terms.

  • Term: A field to input the original term or word that needs to be translated.

  • Translation: A field where the translation of the term is entered.

    create_glossary_entries

Cron Schedule for DeepL Glossary

  • Enabled: A toggle to enable or disable the cron job for syncing the DeepL Glossary. When set to “Yes”, the cron job will run according to the specified schedule to update glossary data.

  • Frequency: A dropdown to specify how often the cron job should run. Options may include “Daily”, “Weekly”, or other predefined intervals. In this case, it’s set to “Daily”, meaning the cron job will execute once every day.

  • Start Time: A field where the time for the cron job to run is set. This determines the exact time of day the cron job will execute (hours: minutes: seconds). In this case, the cron job is scheduled to run at 00:00:00 (midnight).

Glossary Configuration

  • Status: A toggle to indicate whether the glossary functionality is enabled for the store view. Setting this to “Yes” means that the glossary feature is active and will be used during translation.

  • Glossary: This dropdown allows you to select the specific glossary that will be used for translation in the store view. The selected glossary (in this case, “Deepl EW Glossary - en >> de”) will ensure that terms defined in the glossary are translated as specified when content is translated from English to German (or the selected language pair).

    save_the_glossary_config

Translate CMS Pages with DeepL Glossary Integration

  • Create a new page and use the term that you have entered in the Glossary to test the translation functionality.

    create_a_new_page

  • Save the page and then select the target language from the DeepL Translator dropdown list.

    choose_target_language

  • Finally, you will see the page translated based on the terms added in the Glossary.

    verify_from_the_grid

Import glossary entries from backend

To import new search terms into Magento 2 using the backend, follow these steps:

  1. Navigate to the Dashboard:

    • Log in to your Magento 2 admin panel.

  2. Go to System:

    • From the main menu, select System.

  3. Access Import:

    • In the System section, click on Import.

import_setting

  1. Select Entity Type:

    • In the Import Settings section, select Glossary Entries from the Entity Type dropdown menu.

    • Click on Download Sample to get a sample CSV file with all required fields.

  2. Prepare Your CSV File:

  • Open the downloaded sample CSV file.

  • Fill in all the necessary fields. Below are the details for each field:

    • term (required): Add the term you want to translate.

    • translation (required): Enter the translation for the term.

    • glossary (required): Enter the glossary_id that has already been created in the Glossary settings.

  1. Upload the CSV File:

  • Return to the Import section in Magento.

  • Click on Choose File to upload your prepared CSV file.

  1. Check Data:

  • Click on Check Data to validate the CSV file for any errors.

  • If there are no errors, proceed to the next step.

  1. Import:

  • Click on Import to start importing the glossary entries into Magento.

By following these steps, you can efficiently add or update glossary entries in your Magento 2 store.

Choose_glossary_import import_glossary import_glossary glossry_via_import

Changelog

All notable changes to this project will be documented in this file.

[1.0.1]

Added

  • Introduced a feature to import glossaries seamlessly.

  • Added the ability to filter and search entries by specific terms.

  • Implemented a cron scheduler for automating glossary-related tasks.

[1.0.0]

Added

  • Initial release.