Getting started on DeepL translation

Owned by Joël DRIGO
Last updated: Feb 26, 2024
3 min read

This page briefly explains the basic functions of the Deepl API machine translation plugin. For more details, go to Setting up the DeepL Bridge Plugin.

Plugin configuration

At least three properties must be filled in:

  • deepl_api_key this is the API connection key DeepL. Without this key, no call to the DeepL API is possible, so no translation is possible, even in free mode (you need a DeepL free key to connect).
    2024.2 If no value is specified, the Wedia key is used.

  • glossary_name this is the namespace for storing glossaries. All servers sharing the same value for this property will use the same glossaries. By default, this property is configured to be the value entered in the company.name variable.

  • token_auth_key this is the encryption key for InDesign connections. It must be identical in the InDesign plugin configuration. If no key is entered, the InDesign plugin will not be able to call the translation API, so no translation will be possible.

Configuring the WXM_ANALYTICS_V2 plugin

Analytics graphics are integrated into the "New analytics" page. When a menu list is explicitly specified for a role in the configuration of this plugin (parameter available_menus), it is necessary to add the translation value to access it.

Configuring the InDesign plugin

In the wedia.cfg file, in the /wedia/pref section (associated with a prefix), add a server entry with the following attributes:

  • key: the encryption key for the connection token (the value of plugin parameter token_auth_key)

  • url: the server url

Example :

<?xml version="1.0" encoding="UTF-8"?> <wedia> <!--Specific functional parameters for prefix dcw--> <pref prefix="dcw"> <server key="***********" url="https://dev-club-wed.wedia-group.com"/> </pref> </wedia>

Glossary management

Glossaries are lists of pairs of expressions: one expression in a source language, and its corresponding expression in the target language. There is one for each source and target language pair.

They are organized by namespace: a server is configured to use one namespace. All servers configured with the same namespace share the same glossaries.

Import a glossary into DeepL

To import a glossary into DeepL you can go to the web page at the URL _plugins/WXM_DEEPL/page/admin/upload.jspz, where you simply drag and drop TSV extension files, or ZIPs containing such files, into the dotted area. In the area below, you'll see the import logs (with errors or alerts concerning rejected expressions).

This page can be accessed from the menu at URL _plugins/WXM_DEEPL/page/admin/home.jspz, via the following feature:

image-20240206-184939.png

It is also possible to use an end point.

Managing glossaries

If needed, you can view the current glossaries and delete any superfluous ones, or export a glossary, in the page located at the URL _plugins/WXM_DEEPL/page/admin/glossaries.jspz.

This page can be accessed from the menu at URL _plugins/WXM_DEEPL/page/admin/home.jspz, via the following feature:

image-20240206-185249.png

Dedicated end points can also be used.

Direct access to administration interface

The interface functionalities menu page can be accessed directly from the engine administration menu:

 

Translation: using the InDesign translation function

See Translation service (DeepL).

DeepL Services Status

Of course, the DeepL machine translation service must be up and running for automatic translation to work. You can obtain the API status directly from the URL https://www.deeplstatus.com/.

This page can be accessed from the menu at URL _plugins/WXM_DEEPL/page/admin/home.jspz, via the following feature:

Â