TaaS Terminology as a Service

Project no. 296312

Deliverable D4.3

Integration with CAT tools

Version No. 1.0

30/03/2014

Contract no.

296312

D4.3 V 1.0 Page 2 of 17

Document Information

Deliverable number: 4.3

Deliverable title: Integration with CAT tools

Due date of deliverable: 31.03.2014

Actual submission date

of deliverable:

31.03.2014

Main Author(s): Kilgray

Participants: All

Internal reviewer: Tilde

Workpackage: 4

Workpackage title: Terminology services: usage scenarios

Workpackage leader: Kilgray

Dissemination Level: PU

Version: 1.0

Keywords: Project, terminology (collection), CAT tools, terminology

lookup, term insertion, term extraction, user

History of Versions

Version Date Status Name of the

Author

(Partner)

Contributions Description/

Approval Level

0.1 22-

24/03/

2013

Draft Kilgray First and stable drafts Ready for initial and

final internal review

0.2 27/03/

2014

Reviewed

draft

Tilde Comments on the first and

stable drafts

Ready for further

elaboration

0.3 28/03/

2014

Draft Kilgray Final draft Ready for delivery

to the coordinator

1.0 30/03/

2014

Final

version

Tilde Final revision Ready for delivery

to EC

EXECUTIVE SUMMARY

This document describes the integration of TaaS with the memoQ CAT (computer-aided

translation) tool and serves as an accompanying document to the deliverable D4.3 Integration

with CAT tools. In particular, this document describes how translators – users of CAT tools –

can use the TaaS platform without leaving their normal working environment. It also describes

how the functionality of TaaS can be used from the memoQ translation environment.

Contract no.

296312

D4.3 V 1.0 Page 3 of 17

Table of Contents

DOCUMENT INFORMATION ............................................................................................................................. 2

HISTORY OF VERSIONS ..................................................................................................................................... 2

1. OVERVIEW .................................................................................................................................................... 4

2. REQUIREMENTS............................................................................................................................................ 4

2.1. TAAS AS A PLUGIN FOR THE MEMOQ TRANSLATION ENVIRONMENT ............................................................................ 4

2.2. LOOK UP TERMINOLOGY FROM THE TAAS SERVICE ................................................................................................... 4

2.3. CONFIGURING THE TAAS PLUGIN ......................................................................................................................... 5

2.4. ADD TERMS TO SELECTED TAAS COLLECTION .......................................................................................................... 5

2.5. INITIATE TERM EXTRACTION FROM WITHIN MEMOQ, FROM DOCUMENTS, LIVEDOCS CORPORA, AND TMS ......................... 5

3. DESCRIPTION OF FUNCTIONALITY ................................................................................................................ 6

3.1. PLUGIN ARCHITECTURE AND SETTINGS .................................................................................................................. 6

3.1.1. Architecture ......................................................................................................................................... 6

3.1.2. Appearance .......................................................................................................................................... 6

3.1.3. Settings in Tools / Options ................................................................................................................... 7

3.1.4. TaaS settings in a local project ............................................................................................................ 7

3.2. AUTO LOOKUP ................................................................................................................................................. 9

3.3. MANUAL LOOKUP ........................................................................................................................................... 10

3.4. ADD AND EDIT TERM....................................................................................................................................... 10

3.5. TERM EXTRACTION: UPLOAD CONFIRMED CANDIDATES TO TAAS .............................................................................. 12

4. INSTRUCTIONS TO SET UP THE TAAS PLUGIN IN MEMOQ........................................................................... 13

Contract no.

296312

D4.3 V 1.0 Page 4 of 17

1. Overview

This document describes the implementation of the CAT (computer-aided translation) tool

integration with the TaaS services. The bulk of the contents relates to how it is implemented

with the memoQ tool.

2. Requirements

The memoQ translation environment offers the following functionality from the TaaS platform:

Number Name Priority (high / low)

1. Look up terminology from the TaaS service H

2. Configure the TaaS plugin H

3. Add terms to the selected TaaS collection through

the plugin

H

4. Include TaaS references / settings in online projects

and handoff packages

L

5. Initiate term extraction from within memoQ, from

documents, LiveDocs corpora, and TMs (translation

memories)

L

The above requirements were determined in accordance with the earlier specifications written

in Work package 1 of this project.

2.1. TaaS as a plugin for the memoQ translation environment

memoQ is a mainstream translation environment, with an integrated translation editor,

translation memories, and built-in terminology facility. memoQ can use external terminology

resources by using plugins. Through these plugins, terminology from external resources is

displayed the same way as results from local term bases. One such plugin is one that looks up

terms in the EuroTermBank platform. EuroTermBank is a cumulative terminology collection

available at http://www.eurotermbank.com, where the technology platform is also operated by

Tilde, the company leading the present consortium.

2.2. Look up terminology from the TaaS service

When the TaaS plugin is turned on, the tool provides automatic lookup results in the Translation

results pane and in the segment after a segment is scanned. The Translation results pane is an

integral part of the translation editor of the memoQ translation environment, where memoQ

displays all information it can gather about the current segment from various translation

resources. When the user enters a segment in memoQ, the words and word sequences in the

segment are checked against all terminology resources (and others), including TaaS if the plugin

is enabled. Results from TaaS appear as normal terminology matches, indicating TaaS as the

source.

Contract no.

296312

D4.3 V 1.0 Page 5 of 17

The plugin also allows the user to query TaaS from the Look up term (Ctrl+P) window. In

memoQ, the Look up term window is the means of performing a manual lookup, rather than

automatically scanning the source text in the current segment.

2.3. Configuring the TaaS plugin

To configure the TaaS plugin, the user needs to open Tools / Options, and then navigate to the

Terminology plugins section.

Under Tools / Options / Terminology plugins / TaaS, the user can perform the following actions:

- enable or disable the plugin,

- enter the TaaS API (Application Program Interface) key,

- view the list of supported languages.

When TaaS is configured and enabled, a new entry appears on the list of term bases in each

project (the Project home tab), called the ‘TaaS’ service. TaaS does not appear in Tools /

Resource console. The user can turn on and off the plugin for the project using the check next

to the name. This entry has a Properties dialog, with the following settings:

- collection choice [there are three collections for the time being: EuroTermBank, TaaS

public, TaaS private (per TaaS user)],

- domain choice (domain list + All domains drop-down).

The only settings that appear under Tools / Options / Terminology plugins / TaaS are the logon

details and whether or not the plugin is enabled.

If the TaaS plugin is not configured or enabled under Tools / Options / Terminology plugins /

TaaS, the TaaS entry does not appear in the list of term bases.

2.4. Add terms to selected TaaS collection

memoQ allows the user to add term pair to TaaS. memoQ can add term pairs only, not metadata.

To edit metadata, the user needs to open the TaaS portal in a Web browser.

As mentioned in the previous section, TaaS appears on the list of project term bases, and

memoQ allows the user to mark it as the target for new terms, similarly to other local term

bases.

2.5. Initiate term extraction from within memoQ, from documents,

LiveDocs corpora, and TMs

memoQ has a built-in term extractor. After the user runs the term extractor and confirms some

candidates, memoQ can upload the confirmed candidates with their target-language equivalents

to a private TaaS collection. There is a new button on the toolbar of memoQ’s candidate list

editor called Send to TaaS.

At present, memoQ cannot directly initiate term extraction using the TaaS portal. If the user

needs term extraction through TaaS, she needs to open the TaaS portal in a web browser, and

upload the documents manually.

Contract no.

296312

D4.3 V 1.0 Page 6 of 17

3. Description of functionality

To implement the plugin, memoQ uses the TaaS API documentation. The TaaS API description

is annexed to this document.

The TaaS API allows for authorised and unauthorised access to the TaaS service. When the

user has registered on TaaS and his/her API key was retrieved and stored by memoQ, the user

is able to access TaaS collections that he/she has permission to view. If the user has not

registered with TaaS, he/she is able to access public collections only. However, memoQ

requires a proper API key to operate and does not support accessing the public term bases

without one.

At the time of writing, the TaaS API can be called at https://api.taas-project.eu.

From the TaaS API, memoQ currently uses the following methods:

- Authentication and Authorisation

- Term lookup

- Retrieve entry

- Add new entry / Edit entry

- Retrieve list of supported languages and domains

3.1. Plugin architecture and settings

3.1.1. Architecture

The TaaS plugin uses similar technology to terminology and machine translation plugins within

the memoQ translation environment. Once the plugin is activated, memoQ can sense this, and

use the TaaS plugin for automatic and manual lookups, as well as inserting new entries.

3.1.2. Appearance

The TaaS plugin, once configured and enabled, appears as one of the entries under Project

home / Term bases, where the user can turn it on and off, and make it primary – the user needs

to choose one of his/her private collections as the target collection for new terms in the

properties window for the insertion to actually work.

Most lookup settings are configured on a per-project basis (see next section). If the user turns

TaaS on for the project, and adjusts the settings, these are saved with the project. If the TaaS

plugin is disabled after this, the TaaS item should disappear from the term base list in the

project. However, after the TaaS plugin is re-enabled, the TaaS item should come back, with

all previous settings.

If the service changes, or the permissions of the user change, and some features (e.g., inserting

a new term) become unavailable to the user or in the project, it is OK to try the operation first,

then get the exception and display an error message to the user.

Contract no.

296312

D4.3 V 1.0 Page 7 of 17

3.1.3. Settings in Tools / Options

The basic configuration of the plugin options is available under Tools Options

Terminology plugins. See the Options dialog for the TaaS plugin below (Figure 1).

Figure 1: The TaaS plugin settings dialog box in memoQ

The Click here… link opens the following URL in the default web browser: https://demo.taas-

project.eu/account/keys/create/?system=SystemUserName.

The Open my TaaS profile… link opens the root web address – and the user might need to log

on for the first time. Currently, the TaaS portal does not support requesting a specific profile

through an URL.

3.1.4. TaaS settings in a local project

If the TaaS plugin is enabled and configured with a proper user key, an entry called TaaS

appears in the Project home / Term bases list. This item can be turned on or off, and made

primary.

When the TaaS item is made the target for new terms, the target collection for new terms is the

private collection selected in the following properties dialog.

Contract no.

296312

D4.3 V 1.0 Page 8 of 17

To configure domain, lookup, and target private collection settings, the TaaS item in the term

base list has a Properties command (Figure 2).

Figure 2: The TaaS plugin settings for this project dialog box in memoQ

The Refresh list of domains link issues a new query to TaaS.

Initially, memoQ displays the list of private collections without domain restriction. (It is

possible to query this from the TaaS API.)

When the user chooses a different domain (the setting is one domain or all domains), memoQ

performs the collection query with the domain restriction.

NOTE Collections do not exist within the domains – the collection is a container, and a domain

is the property of the TaaS project (that exists in the TaaS workspace) that outputs its

term in one collection or another. So these are sort of independent co-ordinates. When

memoQ asks for a list of available collections for a domain, TaaS tells memoQ if a

collection has terms for that domain.

CAUTION A private collection is not available for all domains. If the user selects a domain

where he/she has no private collection in TaaS, memoQ displays a warning next to

the list.

Contract no.

296312

D4.3 V 1.0 Page 9 of 17

3.2. Auto lookup

If the TaaS plugin is enabled, and the TaaS entry is selected in the term base list of the project

is checked, memoQ will perform lookup in TaaS (Figure 3).

Figure 3: Terminology matches from TaaS appear in the translation editor of memoQ

The user places the cursor in a new segment, and the results from TaaS appear in the translation

results pane.

The auto lookup functionality works as follows:

- the memoQ user opens a document in the translation grid;

- memoQ sends the current segment to TaaS to perform the Term Extraction method,

indicating that term lookup is needed only, without extracting candidates;

- TaaS sends memoQ a list of extracted terms and terminology references if they exist;

- memoQ strips out any terms which do not have at least one corresponding terminology

reference (you will get the list of term base, or rather a sequence of XML (TBX) entries,

and some might be without a target-language equivalent in the current target language

in the grid.);

- when the user is working on a segment that contains a term, which has been returned

from TaaS, memoQ displays the term and the corresponding terminology reference in

the translation results window;

- the format of the resulting term entries is TBX, these are displayed same as the

EuroTermBank hits were displayed on the translation results control.

Contract no.

296312

D4.3 V 1.0 Page 10 of 17

3.3. Manual lookup

The manual lookup works using the same request and response calls as the auto lookup. The

user will request the manual lookup by selecting the command Operations / Look up term. If

the TaaS plugin is enabled, the list contains entries from it the same way as memoQ term bases.

In response to the lookup request (extraction method 4 just as with automatic lookup), the user

will get a sequence of TBX entries. These need to be displayed using a style sheet. All languages

are displayed.

3.4. Add and Edit Term

If the user has configured his/her private collection, entries can be added to the TaaS collection,

and edited existing entries, provided these are returned through automatic lookup and appear in

the Translation results list. This works only from the right-click menu of the entries in the

Translation results list – there is no separate Edit command or editing interface like for local

term bases. Figure 4 demonstrates how the user can make the TaaS collection the target of term

insertions.

Figure 4: Setting the TaaS plugin as the target of new terms in memoQ

Contract no.

296312

D4.3 V 1.0 Page 11 of 17

Figure 5 demonstrates how the user can edit an existing TaaS entry from within memoQ.

Figure 5: Editing a TaaS entry directly from memoQ. It works the same way as with local term bases, but only the

terms can be edited, not the metadata

When the user chooses View / Edit, the following dialog box appears (see Figure 6).

Figure 6: The Edit term base entry dialog box in memoQ, working on a TaaS entry

Contract no.

296312

D4.3 V 1.0 Page 12 of 17

This means that a memoQ user can edit a TaaS entry the same way as she would edit a local

memoQ term base entry. However, the metadata cannot be edited (as TaaS metadata are

different from memoQ metadata), only the source and target terms.

The Quick add term base entry command works for the TaaS collection only if it is made the

target for new terms in the term base list.

If the TaaS plugin is made the target for new terms in the project, Quick add will add the

selected term pair to the selected private TaaS collection, without offering to edit the metadata.

The regular Add command (Ctrl+E) will work if the user selects the TaaS item, even if it is not

made primary.

To add terms, the user can use the simplest dialog as for normal memoQ term bases, but adding

variants or metadata is not allowed.

Users can also edit an existing entry, but only the terms (the lemmas), not the other fields.

3.5. Term extraction: upload confirmed candidates to TaaS

One of the term extraction scenarios is when term extraction is performed by memoQ, and the

confirmed candidates get into TaaS.

The memoQ term extractor has a graphical post-editing interface where the extracted candidates

can be edited, dropped, or confirmed. memoQ also offers to perform lookups among confirmed

candidates just like in a term base, and there is also an option to export the confirmed candidates

to a term base, and another to re-run the extraction. These options appear as icons at the top

right of this interface.

There is a new icon to this row: Export to TaaS (see Figure 7).

Figure 7: The Export to TaaS button in the term candidate list editor of the memoQ term extractor feature.

Contract no.

296312

D4.3 V 1.0 Page 13 of 17

4. Instructions to set up the TaaS plugin in memoQ

To test the TaaS plugin in memoQ, one must use the memoQ setup program made available to

the TaaS consortium. To receive a serial number for testing, contact Balázs Kis of Kilgray

(balazs.kis@kilgray.com). To install and activate the memoQ program, follow the instructions

in this manual: http://kilgray.com/files/user-guide/MemoQ_InstallingActivating_6_8_EN.pdf.

As a first step, register with TaaS, available at the following address at the time of writing:

https://demo.taas-project.eu/.

For best results, create a project, and extract some terms from one or two documents to create

a private collection.

Access the API keys section of your account, and create an API key for memoQ. This will allow

memoQ to access your account. The API key will also associate your copy of memoQ with

your account, so you don’t need to specify your TaaS user name and password for memoQ (see

Figure 8).

Figure 8: Navigating to the API keys section in the TaaS user account (in a web browser)

Once the API key is generated, it is available in the API keys section of your TaaS account.

Copy the API key to the clipboard (select it, then press Ctrl+C) (Figure 9).

Figure 9: API keys section in TaaS

Contract no.

296312

D4.3 V 1.0 Page 14 of 17

Start memoQ. Choose Tools / Options, and then, in the Options dialog box, select the

Terminology plugins category (see Figure 10).

Figure 10: Configuring the TaaS plugin in memoQ

Contract no.

296312

D4.3 V 1.0 Page 15 of 17

Check the Perform terminology plugin lookups… check box, and the Enable plugin check box

in the row of the TaaS plugin. Then click Options in the same row. The TaaS plugin settings

dialog box appears (see Figure 11).

Figure 11: Configuring the TaaS plugin settings in memoQ’s options

Paste the API key in the Access key box, then click OK. Note that you can access the API keys

section directly from the dialog box – memoQ will open the TaaS portal in your default web

browser if you click the link below the Access key text box.

Click OK in the Options dialog box, too.

Contract no.

296312

D4.3 V 1.0 Page 16 of 17

To use TaaS, create a project in memoQ, and then, in Project home, navigate to the Term bases

pane. Note the TaaS entry in the list of available term bases (see Figure 12).

Figure 12: Enabling the TaaS plugin in a memoQ project

Note that in the current – unreleased – version of memoQ, you need to close the project after

you create it, and open it again. The TaaS entry does not appear immediately after the project

is created.

Contract no.

296312

D4.3 V 1.0 Page 17 of 17

Check the check box next to the TaaS entry. If you right-click this entry, you can access a

Properties dialog where you can choose a domain and also the collections you wish to work

with (see Figure 13).

Figure 13: Project-level TaaS settings in memoQ

If you have a private collection for the selected domain, you can also make TaaS the target for

new terms.

After this, you can import documents into your project, and use TaaS as a regular term base

(save for the lookup speed perhaps).