View Source

Category	LanguageResource
Purpose	Integrate DeepL as LanguageResource.
Bootstrap Class	editor_Plugins_DeepL_Init
Type	Plug-in (only available for companies with a Support- and Development contract)

Description

For using LanguageResources in translate5, see Basic usage - LanguageResources.

In order to use DeepL, you will be asked to enter your "DeepL PRO API Key".

Please note: Since translate5 is NOT a CAT-tool with a license-per-user model, translate5 uses the volume-based DeepL API, as agreed by the DeepL company.

You will need the "DeepL API" license key "for developers". Please see https://www.deepl.com/de/pro.html#developer. You pay a basic fee per month and on top a volume based fee.

Configuration of the DeepL- Plug-In

Config name	Values	Default	Description
Using the config in the database: runtimeOptions.plugins.DeepL.server	list	["https://api.deepl.com"]	DeepL Api Server; format: ["SCHEME://HOST:PORT"]
Using the config in the installation.ini runtimeOptions.plugins.DeepL.server[]		https://api.deepl.com
runtimeOptions.plugins.DeepL.authkey	string	(put your api key here)	The authentication key as found in your DeepL-account settings Please note: Since translate5 is NOT a CAT-tool with a license-per-user model, translate5 uses the volume-based DeepL API, as agreed by the DeepL company.. You will need the "DeepL API" license key "for developers". Please see https://www.deepl.com/de/pro.html#developer. You pay a basic fee per month and on top a volume based fee.
runtimeOptions.plugins.DeepL.matchrate	integer	70	DeepL penalty value, used as default matchrate since in MT no matchrate is available

Term collection as glossary source for DeepL language resource

The checkbox "DeepL glossary source" at the termCollections configuration decides, if the terminology of this termCollecton is automatically uploaded to DeepL. If yes for each language pair of DeepL that has a matching language combination in the termCollection and that is assigned to the same client the terminology is uploaded. If the checkbox is unchecked in the TermCollection or the client is removed from the TermCollection or the DeepL language resource or one of both language resources is deleted, the terminology on the side of DeepL is deleted.

System administrators > DeepL > image2022-7-20_9-1-26.png

Used terminology

The administrativeStatus (called "Usage status" in TermPortal) is evaluated when sending terminology to DeepL.

Only one source and target term combination can be used when creating the glossary. In the points bellow, is defined what will happen when multiple source or target matches exist:

- If the source term has multiple target alternatives in the target language, the one that has the status value preferredTerm is used
- If there are multiple target terms with the value preferredTerm, then the first one (the oldest term in the database) is used
- If there is no target term with preferredTerm, but multiple with admittedTerm, then the first one (the oldest in the database) is used
- If there are multiple source terms with exactly the same string, the one of the first termEntry (the oldest in the database) is used

Deprecated terms ignored and not used for glossary.

Supported Glossary Formats

duplicate are not allowed,
source and target term must not contain any C0 or C1 control characters (including, e.g., "\t" or "\n") or any Unicode newline,
source and target term must not contain any leading or trailing Unicode whitespace character.