checkterm User Manual Document version 1.0

Transcription

1 checkterm User Manual

2 Table of contents Table of contents 1 Introduction General Stemming Languages without spaces Step-by-step guide New installation Run an analysis with the SDL Trados Studio Plugin Run an analysis with the Word Plugin Installation System Requirements Installation Voice Recognition Licensing Registering a desktop or freelance license Registering a Network License Registering a server license Transferring a license Tips&Tricks Client Parameters REST API Upgrade External components checkterm client Configuration General Hotkeys Termbases View Parser Addins Analysis Exporting and importing profiles Using checkterm Adding Termbases Terminology Check Manual Search Browse Termbase Pin to top Context Menu Command-line Operation checkterm Studio Plug-in Introduction Configuration General View Studio / 108 User Manual - checkterm 6.0.1

3 Table of contents 5.3 Using checkterm checkterm dialogs Terminology Check HTML report Live check checkterm Word Plug-in Introduction Configuration General View Word Using checkterm Terminology Check Context Menu Analysis result window HTML report Live check checkterm Web Registration URL Login screen language Forgot my Password Logout Changing the user interface language User account Personal settings Analysis profiles Display options Background tasks Segment analysis Monolingual terminology check Bilingual terminology check Analysis results Document check Introduction Running a document review Retrieve old analysis results Delete analysis results Results of the document analysis Trademarks User Manual - checkterm / 108

4 Introduction 1 Introduction 1.1 General checkterm allows you to verify whether a text was written in accordance to a defined terminology. To do this reliably, checkterm will analyze the text based on morphological algorithms such as stemming and compound splitting and identify terms. You can use any MultiTerm termbase as a terminology source, both file based and server based. To integrate server-based termbases without a checkterm server, an installed MT client is required on at least one computer. File based termbases however can also be used without a MultiTerm client. You can also access Acrolinx termbases when using the checkterm Server. As an additional option, you can also establish a link to quickterm in order to file term requests directly from within checkterm. checkterm comprises the following modules: Server With the checkterm Server (a Kalcium module) you can centrally manage the configuration of the system. Also, the entire analysis is run on the server. However, checkterm also works as a stand-online program without the server. Client When you start the application, it initially minimizes itself into the system tray. You can then select text in any windows application and start the check via a hot key. SDL Trados Studio Plugin Using the Studio plugin you can either check the target translation only (monolingual check), or you can analyze the translation against the source document (bilingual check). The bilingual check will verify if for each detected term in the source language one of the respective target language terms is used in the translation. The plugin will also allow you to work your way through all the erroneous terms one by one and replace them with the potential correct terms. Microsoft Word Plugin The plugin lets you check an entire Word document, or individual pages of the document. It can highlight the detected issues directly in the document. The plugin will also allow you to work your way through all the erroneous terms one by one and replace it with the potential correct terms. NOTICE Use information on term level If you want to use checkterm to check for forbidden terminology, then your termbase needs to have a usage field on term level. 1.2 Stemming Stemming is the morphological process of reducing inflected or derived words to their word stem, base or root form, for instance fishing will be reduced to its root form fish. This allows a much more comprehensive analysis of a text than simple fuzzy term recognition. Stemming is currently supported in the following languages: Danish 4 / 108 User Manual - checkterm

5 Introduction German English Finnish French Italian Dutch Norwegian Portuguese Romanian Russian Spanish Czech Ukrainian Hungarian 1.3 Languages without spaces The analysis module of checkterm identifies words largely by the spaces that separates them. Since this is not the case for some languages (for instance Chinese), checkterm includes a parser for languages that do not have spaces or other separators between words or characters (Sciptio continua). This parser currently supports the following languages: Chinese (ZH) in all its variations Japanese User Manual - checkterm / 108

6 Step-by-step guide 2 Step-by-step guide The following sections describe common use cases with corresponding cross-references to the respective chapters. 2.1 New installation 1. Run the installation (Installation [} 7]) 2. License your application (Licensing [} 8]) 3. Add a termbase (Termbases [} 25]) 4. Configure the termbase parser settings (Parser Settings [} 30]) 5. Optionally configure the hotkeys you want to use with the desktop client (Hotkeys [} 24]) 6. Optionally adjust your analysis profile (Analysis [} 38]) 7. Optionally adjust your display settings (View [} 33]) 8. Optionally configure the add-ins (Addins [} 37]) 2.2 Run an analysis with the SDL Trados Studio Plugin 1. If necessary, install the application (New installation [} 6]) 2. If it is not started yet, start checkterm start (to set up the automatic start see chapter General [} 23]). 3. If you are using the default mode (Further information see chapter checkterm client), start the checkterm service if it is not running yet (to set up the automatic start see chapter General [} 23]) (Context Menu [} 63]). 4. Optionally adjust the display settings (View [} 65]) 5. Optionally activate and configure the real-time analysis (Studio [} 67]) 6. Run the analysis (Using checkterm [} 68]) 2.3 Run an analysis with the Word Plugin 1. If necessary, install the application (New installation [} 6]) 2. If it is not started yet, start checkterm start (to set up the automatic start see chapter General [} 23]). 3. If you are using the default mode (Further information see chapter checkterm client), start the checkterm service if it is not running yet (to set up the automatic start see chapter General [} 23]) (Context Menu [} 63]). 4. Optionally adjust the display settings (View [} 78]) 5. Optionally activate and configure the real-time analysis (Word [} 80]) 6. Run the analysis (Using checkterm [} 81]) 6 / 108 User Manual - checkterm

7 3 Installation Installation This chapter shows you how to install the client side components of checkterm. Information on the server installation can be found in the Administration Guide of Kalcium. 3.1 System Requirements General Current version of Windows update package KB Microsoft.net Framework 4.5 For server based termbases: MultiTerm 2015 or later client installed locally GroupShare 2015 or later If you will be accessing a termbase directly via SQL server, then this requires an SQL user in the db_datareader role for all MultiTerm and GroupShare databases. For the SDL Trados Studio Plugin: SDL Trados Studio 2015 or higher For the MS Word Plugin: Visual Studio 2010 Tools for Office Runtime Office 2013, Office 2016 (checkterm is tested for Office 2010 but not officially supported) 3.2 Installation This is how you install checkterm: a) Start the installer. b) Click on "Next". c) Select which installation type to choose. d) If desired, select the path where you want to store the program files. e) Click on "Install". ð checkterm will now be installed. f) Click on "Finish". ð checkterm is now installed. NOTICE Installing while Studio is running You can install the plugin even if Studio is running. For an update / upgrade, however, Studio first has to be closed. User Manual - checkterm / 108

8 Installation 3.3 Voice Recognition If you want to use the voice recognition option, then you will require the Microsoft Speech Platform SDK 11. This is how you can install it: a) Uninstall any previous versions of the Speech Platform SDK and Microsoft Speech Platform Runtime from your computer. b) Install the Speech Platform Runtime 11 on your computer. You can download the installer from the Microsoft website. c) Install the Speech Platform SDK 11 on your computer. You can download the installer from the Microsoft website. d) Install those languages from the Microsoft Speech Platform - Runtime Languages 11 which you want to use for the speech recognition. You can download these from the Microsoft website. 3.4 Licensing The following license version of checkterm are available: Server license In this case, the license resides on the Kalcium server. This licensing model requires you to have both the Kalcium license as well as client access licenses to allow users to connect their client to the checkterm server. In this licensing model, you do now need a client license at all. Desktop license In this case, activation is done directly at the workplace where the license will be used. Network license (also called floating or concurrent license) with a certain number of users accessing the application at the same time from several clients In this case the license file is stored on a network share which is accessible by all client PCs. The license will be checked out when checkterm starts. Freelance License The freelance license only allows you to use the Studio Plugin. Demo Version After the first installation, checkterm runs in a 30 day full-featured trial mode. After that, the trial will expire and you will have to activate the application. NOTICE Resetting licenses Sometimes you cannot access an already installed application anymore, for example because your hardware failed, and you want to install the product on a new system. In this case, we can reset your user license and enable you to use it again for a new installation. However, we will only reset your license up to two times per year Registering a desktop or freelance license This is how you can license checkterm: a) Select the menu item License in the Help tab of checkterm or in the context menu of the system tray application. 8 / 108 User Manual - checkterm

9 Installation ð The "License configuration" dialog box appears: a) Select Desktop license. a) Click on "Add product". ð This will open a dialog box where you can enter your serial number: b) Copy and paste the serial number you have received from Kaleidoscope into the field. c) Click on "OK". ð The start dialog of the licensing application opens. User Manual - checkterm / 108

10 Installation d) Click on "Next". ð This will open a dialog where you can choose the activation method you wish to use: e) Choose the desired method: Use online activation if your system is in the Internet and can directly connect to our license server (preferred method). Use activation if your system is not in the Internet and can not connect to our license server. In this case you have to send the with the system code to Kaleidoscope and will get another code for off-line activation back via . The following description highlights the online activation. The activation is very similar. If you have any question, please contact our support. f) Click on "Next". 10 / 108 User Manual - checkterm

11 Installation ð A dialog box opens for you to enter your registration details. The serial number will already be filled out. g) Enter at least the fields for Company, Country and Address. h) Click on "Next". ð This opens the activation dialog: User Manual - checkterm / 108

12 Installation i) Click on "Next". ð checkterm will now connect with our license server and register your instance. ð Once that is done, you will get another dialog to enter any optional activation keys. 12 / 108 User Manual - checkterm

13 Installation j) If you did get additional activation keys from us, please enter them individually and always hit Apply activation key after each one. k) Click on "Next". ð Your software is now registered Registering a Network License This is how you can license checkterm: a) Copy the original license file from your local file C:\ProgramData\Kaleidoscope \checkterm to a network share. a) Select the menu item License in the Help tab of checkterm or in the context menu of the system tray application. ð The "License configuration" dialog box appears: a) Select Network license. b) Choose the path where you have just stored the license. a) Click on "Add product". ð This will open a dialog box where you can enter your serial number: b) Copy and paste the serial number you have received from Kaleidoscope into the field. c) Click on "OK". User Manual - checkterm / 108

14 Installation ð The start dialog of the licensing application opens. d) Click on "Next". ð This will open a dialog where you can choose the activation method you wish to use: 14 / 108 User Manual - checkterm

15 Installation e) Choose the desired method: Use online activation if your system is in the Internet and can directly connect to our license server (preferred method). Use activation if your system is not in the Internet and can not connect to our license server. In this case you have to send the with the system code to Kaleidoscope and will get another code for off-line activation back via . The following description highlights the online activation. The activation is very similar. If you have any question, please contact our support. f) Click on "Next". ð A dialog box opens for you to enter your registration details. The serial number will already be filled out. g) Enter at least the fields for Company, Country and Address. h) Click on "Next". User Manual - checkterm / 108

16 Installation ð This opens the activation dialog: i) Click on "Next". ð checkterm will now connect with our license server and register your instance. 16 / 108 User Manual - checkterm

17 Installation ð Once that is done, you will get another dialog to enter any optional activation keys. j) If you did get additional activation keys from us, please enter them individually and always hit Apply activation key after each one. k) Click on "Next". ð Your software is now registered Registering a server license If you use server-based licensing, then the client components do not require any licensing. Information on the server license can be found in the Administration Guide of Kalcium Transferring a license In order to transfer the license from one system to another, proceed as follows: a) In the Settings menu click on License Details. User Manual - checkterm / 108

18 Installation ð The "License Viewer" dialog box appears: a) Click on Transfer license. ð The deactivation dialog is now displayed. b) Click on "Deactivate now". ð The "Transfer License" dialog box appears. c) Click on "Next". ð The application will now connect with our licensing server and generate a new serial number. d) Please note down the new serial number (it cannot be copied to the clipboard!). e) Close the current application. f) Use the new serial number to register the application on the new machine. Activation keys that have been applied are automatically transferred, too. 3.5 Tips&Tricks Client Parameters Log-Level The LogMode parameter is used to define the level of logging intensity. You can set it up in the file TerminologyCheckerClient.exe.config in the install directory of the checkterm client. You can set it to the following values: Standard This is the recommended setting for the normal operation. Only basic operations are logged. Verbose This is the recommended setting for troubleshooting. It increases the amount of information written to the log file. 18 / 108 User Manual - checkterm

19 Installation REST API You can call the documentation of the REST API via the URL Please replace [PORT] with the port you have configured, the default being NOTICE checkterm Service The checkterm service must be running in order to view the documentation. 3.6 Upgrade When you upgrade from checkterm to checkterm 3.1, the configuration files need to be updated. checkterm 3.1 offers you to do this when you first start the application. NOTICE Configuration conversion only possible at first client start The option to have checkterm update the old configuration is only available at the first start of the checkterm client. After that it is no longer possible to convert your existing configuration. 3.7 External components Name Version License Project URL Description Newtonsoft.Json 10.0 MIT ( raw.githubusercontent.com/jamesnk/newtonsoft.json/master/li- CENSE.md) XCEED Extended WPF Toolkit 3.1 Microsoft Public License ( licenses/ms-pl) Nunit packages/extended.wpf.toolkit/ LicProtector 5 commercial de/produkte/licence-protector/ Owin 3.0 Apache 2.0 ( github.com/owin-contrib/owin-hosting/blob/ master/license.txt) JSON processing framework for.net Collection of WPF controls Unit testing framework (Just for development) Licensing framework Middleware github.com/owin- framework contrib/owin-host- ing/ User Manual - checkterm / 108

20 Installation Name Version License Project URL Description MahApps 1.6 MIT ( MahApps/MahApps.Metro/blob/develop/LICENSE) github.com/mahapps/mahapps.metro Fluent 3.6 MIT github.com/fluentribbon/fluent.ribbon Hardcodet.Wpf.Taskbaproject.com/info/ CPOL ( Notification cpol10.aspx) packages/hardcodet.wpf.taskbar Notification/ HtmlAgilityPack MIT ( zzzprojects/html-agility- pack/blob/master/li- CENSE) HtmlRenderer ArthurHub/HTML-Ren- derer/blob/master/li- CENSE Microsoft.Speech 11 Microsoft Speech Platform SDK 11 License.rtf Swashbuckle 1.0 MIT ( raw.githubusercontent.com/domaindrivendev/swashbuckle.asp- NetCore/master/LI- CENSE) AsyncBridge blob/master/license.txt A toolkit for creating metro-style WPF applications. Office-like user interface SysTray icon HTML parsing pack.net/?z=code- plex github.com/ ArthurHub/HTML- Renderer hh361572(v=office.14).aspx github.com/domaindrivendev/ Swashbuckle SharpZipLib GPL ( SharpZipLib/ github.com/tejacques/ AsyncBridge Stemming XX HTML display control Speech recognizer API explorer / swagger Handling archives Async lib for older.net framework Stemming Algorithms declarations. The algorithms are not implemented for C# (only for JAVA, python). Languages: English, French, Spanish, Portuguese, 20 / 108 User Manual - checkterm

21 Installation Name Version License Project URL Description Italian, Romanian, German, Dutch, Swedish, Norwegian, Danish User Manual - checkterm / 108

22 checkterm client 4 checkterm client Illustration 1: Startup dialog When starting checkterm, you first have to select in which mode you want to use it: Normal mode Using this mode, you can set up all basic configurations in the desktop client itself. This includes the termbase configuration. Kalcium mode Using this mode, then all the basic configurations are managed on the Kalcium server. This mode requires an active connection to a Kalcium server. Server URL Address of your Kalcium server. User name Your user name on the Kalcium server. Password Your password on the Kalcium server. You can have checkterm remember the mode and the configurations by selecting the option Remember settings. If you want to reset the selection, choose the Logout option in the context menu of checkterm in the system tray. 4.1 Configuration You can open the configuration screen in one of two ways: 1. You can use the context menu of the application. To do so, right mouse click the application icon in the system tray of the task bar. Then select Show options. 2. Directly in the application itself Click on Show options in the File menu. 22 / 108 User Manual - checkterm

23 checkterm client General Illustration 2: Options - General tab Application Options User interface language Here you can select the language of the user interface. Launch application on Windows startup By selecting this option, checkterm will automatically load every time the system is started. Check updates on application startup By selecting this option, checkterm will automatically check if any updates are available every time you start it. This option is only available if you have a valid support and maintenance contract and have received an activation key. Voice Recognition Enable voice recognition This option enables voice recognition Installed voice recognizers This list contains all the voice recognition engines installed on your computer. Choose the engine you want to use with checkterm. Service configuration Start service at application startup User Manual - checkterm / 108

24 checkterm client By selecting this option, the checkterm service will automatically start every time you start the application. Port" Lets you define which port to use for the checkterm services. (Default: 1992) Hotkeys Illustration 3: Options - Hotkeys dialog Default hotkey combinations When you press the default hotkey, any text that you have currently selected will be passed to checkterm for analysis. The analysis will run in the language set up for this hotkey. Change With this button you can change an already existing hot key definition for a language. 24 / 108 User Manual - checkterm

25 Language Hotkey Options checkterm client In this part of the dialog you can set up language-specific hot keys for checkterm. Add Lets you add another hot key for a different language. Remove Lets you remove a hot key. Change With this button you can change an already existing hot key definition for a language. You can assign more than one language (for instance language variants) to the same hotkey, too. Custom Hotkey Options Lets you define hot keys for additional custom search providers such as Google. Add Lets you add another hot key for a different search provider. Remove Lets you remove a hot key. Change With this button you can change an already existing hot key definition for a search provider Termbases This section is only available in the normal mode. In the Kalcium mode, these settings are defined on the Kalcium server centrally. NOTICE Applying changes Please note that all changes in this area of the configuration are applied immediately. Changes cannot be undone. User Manual - checkterm / 108

26 checkterm client Illustration 4: Options - Termbases tab General Termbase Options The list shows all currently attached termbases. The change date shows when the termbase was last refreshed. Used termbases Lists all defined termbase connections and allows you to choose which termbases you want to use for the check. You can select more than one term base. Add Termbase With this button you can add additional termbases to checkterm (see chapter Adding Termbases). Remove termbase Lets you remove the highlighted termbase from the list of available termbases in checkterm. Edit configuration Lets you change the configuration for the selected termbase via the configuration screen (see chapter Configuring the Termbases). The configuration includes parameters such as used filters or setting up the usage field. 26 / 108 User Manual - checkterm

27 checkterm client Refresh termbase Lets you re-load the termbase into the checkterm memory. Refresh in background Lets you re-load the termbase into the checkterm memory as a background process. Once the caching process is finished, the user will be alerted via a popup in the system tray. Refresh all termbases Lets you re-load all termbases into the checkterm memory. Advanced Termbase Options Prefetch search indexes for all languages Checking this option means that the termbase search index of all languages will be loaded when you start the application. This reduces the initial wait time when you run a check. However, it uses up more memory. Prefetch termbase search index for all registered hotkeys languages (not available if the option Prefetch search indexes for all languages is selected) By selecting this option, checkterm will load the termbase search index for those language, for which you have defined a hot key. It will load that index automatically when you start the application. This reduces the initial wait time when you run a check. However, it uses up more memory. Load used termbase(s) on application startup Checking this option means that all termbases will be loaded when you start the application. This reduces the initial wait time when you run a check. However, it uses up more memory. Cache online termbase(s) to local file system If this option is selected, server-based termbases will be cached locally to the file system. This reduces the initial wait time when you run a check. However, the locally cached termbases will have to be updated manually. Use custom termbase cache folder (only available if Cache online termbase(s) to local file system is selected) This option lets you define a custom file path to store the cache, rather than the default path. This can also be a network share for several clients used on different computers. The field beneath this option allows you to set up a path. After setting up the path, the local termbases can be found in this folder. You can select the termbase you want to use. This can also be done later by clicking on. NOTICE Adding termbases in the user defined path. If you manually add a termbase to the custom user defined path, then checkterm detects this new termbase at the next application startup and asks the user if this termbase should be added. Enable auto-refresh termbases If this option is selected, checkterm will automatically re-load all termbases in a defined interval. This update will be performed in the background. If checkterm is not running during the time of the scheduled refresh, then the refresh will be done when checkterm is launched the next time. User Manual - checkterm / 108

28 checkterm client Parser profile management In this dialog you can manage (create, edit, delete) parser profiles. Choose the profile you want to edit. The following operations are now available: Button With this button you can load an existing parse profile into the application s configuration. Button With this button you can store the current parse settings in a new profile. You can then load this parse profile again at a later point. Default Value Lets you set up the default usage of a term of no value is actually specified in the usage field. Usage field This lets you select which field in your termbase actually contains the usage information. Field value Lets you define each possible value of the usage field in your termbase. Usage Value Lets you set up if this value indicates that the term is approved, not approved or even forbidden. Add Usage button By clicking this button, the new field value and its mapping are stored. Remove button Lets you remove a mapping from the list. By clicking on By clicking on By clicking on you can create a copy of the current profile. you can delete the current profile. you can create a new profile. 28 / 108 User Manual - checkterm

29 checkterm client Termbase Settings Termbase Information Information Illustration 5: Edit termbase settings - Information dialog Termbase Information Here you can enter the required information for the termbase, including the connection setup: Termbase name Name of the termbase Termbase path Path containing the locally cached version of the termbase. User name The user name used to log in to the MultiTerm server. Password The password used to log in to the MultiTerm server. URL Address of your MultiTerm server. User Manual - checkterm / 108

30 checkterm client Test connection button By clicking on this button, the connection data you have entered will be verified Parser Settings Parsing Illustration 6: Edit termbase settings - Parsing dialog In this tab you can set up the usage fields contained in your termbase. In addition to the normal parsing, you can set up a custom xslt transformation for the termbase. This is useful, for example, if the usage information of a term is not simply retrievable from one single field. You can find a sample transformation script in the subdirectory SampleTransformations of the installation directory. We recommend copying this sample and customize it according to your needs. Parser settings for information about an entry Current Transformation Displays the currently used transformation file. Add transformation button You can add additional xslt files by clicking on this button and selecting a file from your file system. This file will be added to the configuration of the termbase connection. Remove transformation button 30 / 108 User Manual - checkterm

31 checkterm client You can remove the currently applied transformation script by clicking on this button. Parser settings for term usage Button With this button you can load an existing parse profile into the application s configuration. Button With this button you can store the current parse settings in a new profile. You can then load this parse profile again at a later point. Default Value Lets you set up the default usage of a term of no value is actually specified in the usage field. Usage field This lets you select which field in your termbase actually contains the usage information. Field value Lets you define each possible value of the usage field in your termbase. Usage Value Lets you set up if this value indicates that the term is approved, not approved or even forbidden. Add Usage button By clicking this button, the new field value and its mapping are stored. Remove button Lets you remove a mapping from the list. User Manual - checkterm / 108

32 checkterm client MultiTerm Filter Filters Illustration 7: Edit termbase settings - Filters dialog MultiTerm Filter Settings Selected filter Lets you define a MultiTerm filter to use during the check. Source language Lets you define the source language in case the selected filter uses the source language criterion. "Target language" Lets you define the target language in case the selected filter uses the source language criterion. 32 / 108 User Manual - checkterm

33 checkterm client View Illustration 8: Options - Display tab General Display Options Show the highest similarity result over the best matching result During the analysis process a morphological stemming operation is performed. For composite nouns this can lead to false positive matches in the termbase. While this is correct from an analysis point of view, it is confusing for the user. So if you select this option, the more complete termbase result is always ranked above the analysis result after stemming. View style Here you can select between a more writer -oriented or a more linguistic display style for the analysis results. Writer View User Manual - checkterm / 108

34 checkterm client This view only highlights problematic hits, independent of their linguistic analysis result. Linguistic view This view highlights all hits depending on their linguistic properties. Linguistic View Options Lets you set up which kind of search result should be highlighted in which color. By selecting Hide you can deactivate the highlighting of this type of analysis result. These options are only available if you have selected Linguistic view in the general view options. Writers View Options Lets you set up the color to be used for potential problems in your content. These options are only available if you have selected Writers view in the general view options. Displayed languages Here you can define which languages you want to display in the terminology entries. Available languages Here you have a list of all languages that available for you. The list is built automatically when you import a termbase. Once you add a language from this list to the Displayed languages", it will disappear from the available languages list. Displayed languages This list contains the languages that will be shown in the entry viewers of checkterm, provided that a term exists in that language. Adding new languages: In order to add all available languages to the list of displayed languages, click on. Otherwise, highlight the languages you want to add in the available languages list and click on in order to copy the language from left to right (=displayed). You can also just drag and drop languages from one list to the other. Removing languages: In order to remove all languages from the list of displayed languages, click on. Otherwise, highlight the languages you want to remove in the displayed languages list and click on in order to move the language from right to left (=not displayed). You can also just drag and drop languages from one list to the other. Sorting languages: You can set the sequence in which you want to display the languages by selecting the one you want to move and pressing the and buttons. You can also just drag and drop languages to a different position in the list. Entry display style Here you can define how you want to show terminology entries in checkterm. 34 / 108 User Manual - checkterm

35 checkterm client Styles This lets you define how you want the terminology to be displayed in checkterm. Normally, only default is available as an option. If you also have an installation of quick- Term, then you can export stylesheets from quickterm and reuse them in checkterm. Please consult the quickterm documentation on how to export a stylesheet. To import an existing quickterm stylesheet into checkterm, click the select the stylesheet file you received. button and then To delete an existing stylesheet, click on Parser XML parser With the XML parser you can check terminology directly from an XML document. The parser will remove all XML Tags to avoid them disrupting the checking process. Illustration 9: Options - Parser - XML parser dialog Enabled User Manual - checkterm / 108

36 checkterm client This option turns on the parser for subsequent analyses. Remove tags containing numbers only With this option you can skip the check for any elements where the only content is a number. For example: <text>this documentation contains at least <pages>123</ pages> pages.</text> HTML Parser With the HTML parser you can check terminology directly from an HTML document. The parser will remove all HTML Tags to avoid them disrupting the checking process. Illustration 10: Options - Parser - HTMLparser dialog Enabled This option turns on the parser for subsequent analyses. 36 / 108 User Manual - checkterm

37 checkterm client Addins Illustration 11: Options - Addins dialog quickterm Addin Options Show quickterm If selected, then the quickterm buttons are displayed in the checkterm interface. Server URL If you want to use the quickterm Addin, then you need to indicate the URL of your quickterm server. User Manual - checkterm / 108

38 checkterm client Analysis NOTICE Applying changes Please note that all changes in this area of the configuration are applied immediately. Changes cannot be undone. In the Kalcium mode this also means that any changes in the analysis profile are immediately stored in the Kalcium server Adding an analysis profile To add an analysis profile: ü checkterm has to be running. a) Open the options dialog in the desktop client. b) Select the analysis option. ð All available analysis profiles are shown. a) Click on "Add". b) Enter a name for the new profile. c) Click on "OK". ð The base settings of the new analysis profile are displayed. d) Edit the fields accordingly (Further information see chapter Field descriptions of analysis profiles [} 39]). e) Click on "Save" to save the changes to the settings. ð The new analysis profile has been created Editing an analysis profile To edit an existing analysis profile: ü checkterm has to be running. a) Open the options dialog in the desktop client. b) Select the analysis option. ð All available analysis profiles are shown. a) Select the profile. b) Click on "Edit". ð The settings of the selected analysis profile are displayed. c) Edit the fields accordingly (Further information see chapter Field descriptions of analysis profiles [} 39]). d) Click on "Save" to save the changes to the settings. ð The changes will be stored Copying an analysis profile To copy an existing analysis profile: ü checkterm has to be running. a) Open the options dialog in the desktop client. b) Select the analysis option. 38 / 108 User Manual - checkterm

39 checkterm client ð All available analysis profiles are shown. a) Select the profile. b) Click on "Copy ". c) Enter a name for the new profile. d) Click on "OK". ð The analysis profile has been copied Deleting an analysis profile To delete an existing analysis profile: ü checkterm has to be running. a) Open the options dialog in the desktop client. b) Select the analysis option. ð All available analysis profiles are shown. a) Select the profile. b) Click on delete. ð Confirm the deletion in the following dialog. c) Click on "OK". ð The analysis profile has been deleted Exporting or importing an analysis profile Profiles can be exported and imported. This is useful to transfer all settings from one PC to the next. See chapter Exporting and importing profiles Updating an analysis profile NOTICE Kalcium mode This section is only relevant if you are using checkterm in Kalcium mode. During startup, the checkterm desktop client loads a list of analysis profiles and their settings from the Kalcium server. If you want to apply new or changed analysis profiles without restarting checkterm, then you need to update the analysis profiles. To update the analysis profiles: ü checkterm has to be running. a) Open the options dialog in the desktop client. b) Select the analysis option. ð All available analysis profiles are shown. a) Click on "Update". ð The analysis profiles are updated Field descriptions of analysis profiles This chapter contains information relevant to the analysis profiles. User Manual - checkterm / 108

40 checkterm client Table The analysis profiles table contains the following columns: Name Name of the analysis profiles Termbases The termbases loaded in the analysis profile (Further information see chapter Such- OptionenSearch Options [} 40]). "Search type" The selected search type in the analysis profile (Further information see chapter Such- OptionenSearch Options [} 40]). Stemming General Whether or not stemming is selected in the analysis profile (Further information see chapter Search Options [} 40]). Name Name of the check profile. You can change the name by clicking on the (unless it is the default profile or a write-protected profile). Enable tokenization button This settings lets you decide whether or not to use tokenization. This is required for languages without spaces, such as Chinese. In order to achieve maximum analysis performance, only activate this feature if it is required. Tokenization tape (only available if the option Enable tokenization is selected) This option lets you define how sensitive the analysis of spaceless languages should be. Exact The error tolerance is 0. That means only terms that match the MultiTerm term 100% will be used in the analysis. "Fuzzy" The error tolerance is dependent on the length of the word. The fuzzy option allows checkterm to also analyze terms that are just misspelt or slightly wrong. Terms up to 3 characters: 0 errors Terms between 4 and 9 characters: 1 error Terms over 10 characters: 2 errors Search Options Used termbase Select the termbase you want to use for the analysis. "Search type" Lets you set up which mode should be used while analyzing a text: "Fuzzy" Retrieves all terms that are similar based on their characters "Normal" Only retrieves terms that match a word in your text 100% 40 / 108 User Manual - checkterm

41 checkterm client Custom Uses the following match settings: Difference rate Allows you to set up the match rate or similarity a term has to have with a word in your text in order to be retrieved. Enable stemming Lets you enable or disable the stemming algorithm. This algorithm reduces performance but increases the detection rate. The improvement is very language-dependent. Enable caching search results (This option is not required in Kalcium mode and this will not be available when using the server). Lets you define that search results should be written to the cache. This improves performance, but changes done in the termbase will not have an immediate impact until the cache is reloaded. The cache is always reloaded during the application start Analysis options Enable detect compositions Lets you set up whether or not compositions should be retrieved during the check Only words longer than two characters will be considered. Enable 3-character compositions By activating this option, you also allow words with 3 characters, such as MHDmark. Enable detect partial compositions Lets you set up whether or not partial compositions should be retrieved during the check Partial compositions are compounds which are either formed by hyphens or when not all parts of the compound are actually terms in the termbase. Enable exhausting composition search (This option is not required in Kalcium mode and this will not be available when using the server). Lets you enable or disable the exhaustive compound search. If you do not select this option, then only compounds made up of single terms are detected. However, if you activate this option, then the application will also detect compounds containing multi-word terms. For example: Entry 1: photo printer Entry 2: toner cartridge If the text now uses the unlikely compound photoprintertonercartridge, then only the exhaustive compound search will detect it. Enable exhaustive analysis Selecting this option reduces the performance of the system but applies a more precise algorithm. Match case Lets you set up if the case should be matched when you search in the termbase. Ignore case at the beginning of sentence Lets you define whether the capitalization of the first word in a sentence should be taken into account in case-sensitive analysis. Select forbidden terms over approved terms User Manual - checkterm / 108

42 checkterm client This setting lets you determine what to do if a term is approved in one entry but forbidden in another entry. For example: Term X is approved in entry 1, but forbidden in entry 2. If you deactivate this option, then the term is returned as approved in the text analysis. If you activate this option, then the term is returned as forbidden in the text analysis. Enable show similar compound terms Lets you set up whether or not similar compounds should be displayed. These are compound terms made up of terms where no 100% match can be found for any of the individual terms. Minimum character number Lets you set up how many characters such a similar compound must at least have Term filter settings This feature lets you set up filters on term level. It allows you to filter on terms based on the terms metadata. To create a term filter profile, proceed as follows: a) Select the termbases which you want to filter on term level. b) Select the field which will serve as a filter criterion. c) Select the respective field value which you want to filter on. d) Click on the Add button to add a term filter. e) You can then decide whether only one criterion has to be met to include the term, or all criteria have to be met (and vs. or) Exporting and importing profiles The export and import of profiles allows you to copy the configuration somewhere else. This is useful for instance in the following scenarios: 1. You want to transfer the settings to another system. 2. You want to keep a backup of your configuration. Export This is how you export the configuration: a) If you have not already done so, click on Apply configuration to store any changes you might have done into the profile. b) Click on "Export". 42 / 108 User Manual - checkterm

43 checkterm client ð The export dialog box opens. c) Select the folder where you want to store the export file. d) Optionally, assign a file name for the export file. This file name automatically gets the suffix cte. If you do not provide a file name, checkterm will generate one. e) Select whether you want to include the termbase. This is useful if the target system cannot access your termbase. If you store the termbase in a shared location, then do not induce the termbase in the export. Rather, the import on the target system will import the path to the central termbase and will access it there. f) Select whether you want to include the parser profiles. g) Select whether you want to include the display stylesheet. h) Select which profiles you want to export. i) As an option, you can select to export them write protected. That means that the target system will not be able to change them. j) Click on "OK". ð checkterm now exports the entire profile. Import This is how you import the configuration: a) If you have not already done so, click on Apply configuration to store any changes you might have done into the profile. b) Click on "Import". User Manual - checkterm / 108

44 checkterm client ð This will open a dialog where you can select the configuration file to be imported. c) Select the one you want to import. ð checkterm will analyze the configuration file. If this process detects elements that already exist in the target system, then a dialog will pop up allowing you to define which one should be kept. d) Highlight the elements you want to overwrite. e) Click on "OK". ð The configuration will now be imported. NOTICE Backup If the import of the configuration file is done on the same system as the export, and if this overwrites the existing configuration (meaning you are reloading your configuration from a previous version), then checkterm will remove the read only mark. 44 / 108 User Manual - checkterm

45 checkterm client 4.2 Using checkterm Adding Termbases You can add termbases via the Options - Termbases dialog (see chapter Termbases). You have the following options for adding termbases: Load a termbase through MultiTerm server Load a termbase directly from the SQL server of MultiTerm Loading server based termbases via SQL is faster than through the MultiTerm API, but it requires an SQL user on the database. Please refer to the system requirements on which rights the SQL user needs. Load a local termbase See also 2 Termbase Settings [} 29] Load a termbase from MultiTerm Server This is how you can add termbases: ü Navigate to the Termbases tab in the Options dialog a) Click on "Add termbase". User Manual - checkterm / 108

46 checkterm client ð The "Add termbase" dialog box opens. b) Select Load termbase from MultiTerm Server c) Enter the connection data for your MultiTerm server (user name, password and Server-URL), or select an analysis profile ((Further information see chapter Profiles [} 47]). d) Click on "Connect". ð checkterm now reads the termbases which are available for that user. e) Select the desired termbase. f) Select Use custom termbase cache folder if you want to store the local cache in the folder you have set up in the previous options. That way checkterm stores the cache in your folder and not in the standard folder of the system. Make sure you have set up this local folder (see chapter Termbases). g) You can select the option Cache later. This means that the termbase will be added to the list of termbases, but the terms will only be imported when they are first needed. h) Click on Add termbase or on Add in background Add Termbase When you select this option, the termbase will immediately be read and cached into a local copy. While this is running, checkterm is not available. Add in background When you select this option, the termbase will be read in the background and cached into a local copy. The termbase is added to the list of 46 / 108 User Manual - checkterm

47 checkterm client termbases immediately, but it is marked as not yet available. However, you can continue to use checkterm using this option. Once the caching process is finished, the user will be alerted via a popup in the system tray. ð The termbase has now been added to the pool of termbases available for check- Term. A dialog to select the parser profile appears: i) Select the parser profile and click on Apply. Or switch to the manual configuration by clicking on Assign manually (see also Configuring the Termbases). ð This completes the parser configuration Profiles You can store connection data in a profile. This is particularly relevant for project managers who need several different connections in their project work. Once you have stored a profile, you can load it by selecting it in the Profile drop-down. The data of this profile will be imported into the current connection settings dialog. Creating a New Profile To create a new profile, proceed as follows a) Click on the button to open the profile editor window. User Manual - checkterm / 108

48 checkterm client ð This window allows you to enter the relevant profile data: b) Enter your required information for this profile. c) Then click on "Add" to add this new profile. ð The profile will now be available in the profile dropdown. Saving already entered connection data as a new profile To create a new profile, proceed as follows a) Click on the button to open the profile editor window. 48 / 108 User Manual - checkterm

49 checkterm client ð This window allows you to enter the relevant profile data. The connection data you had entered already is copied into the respective fields. : b) Enter a name for the new profile. c) Then click on "Add" to add this new profile. ð The profile will now be available in the profile dropdown. Deleting an existing profile To delete an existing profile, proceed as follows a) Select the profile you want to delete in the drop-down. b) Click on the button to delete the selected profile. ð The profile will now be deleted Load a MultiTerm termbase directly from SQL Server This is how you can add termbases: ü Navigate to the Termbases tab in the Options dialog a) Click on "Add termbase". User Manual - checkterm / 108

50 checkterm client ð The "Add termbase" dialog box opens. b) Select the option Load termbase from MultiTerm Server via SQL c) Enter the connection details for the SQL server (User name, password, Server-URL and database name of the termbase). d) Click on "Connect". e) Select Use custom termbase cache folder if you want to store the local cache in the folder you have set up in the previous options. That way checkterm stores the cache in your folder and not in the standard folder of the system. Make sure you have set up this local folder (see chapter Termbases). f) Click on Add termbase or on Add in background Add Termbase When you select this option, the termbase will immediately be read and cached into a local copy. While this is running, checkterm is not available. Add in background When you select this option, the termbase will be read in the background and cached into a local copy. The termbase is added to the list of termbases immediately, but it is marked as not yet available. However, you can continue to use checkterm using this option. Once the caching process is finished, the user will be alerted via a popup in the system tray. 50 / 108 User Manual - checkterm

51 checkterm client ð The termbase has now been added to the pool of termbases available for check- Term. A dialog to select the parser profile appears: g) Select the parser profile and click on Apply. Or switch to the manual configuration by clicking on Assign manually (see also Configuring the Termbases). ð This completes the parser configuration Load termbase from local file This is how you can add termbases: ü Navigate to the Termbases tab in the Options dialog a) Click on "Add termbase". User Manual - checkterm / 108

52 checkterm client ð The "Add termbase" dialog box opens. b) Select Load termbase from local file c) Click on "Browse". ð The "open file" dialog box opens. d) Select the desired termbase file. e) Select Use custom termbase cache folder if you want to store the local cache in the folder you have set up in the previous options. That way checkterm stores the cache in your folder and not in the standard folder of the system. Make sure you have set up this local folder (see chapter Termbases). f) Click on Add termbase or on Add in background Add Termbase When you select this option, the termbase will immediately be read and cached into a local copy. While this is running, checkterm is not available. Add in background When you select this option, the termbase will be read in the background and cached into a local copy. The termbase is added to the list of termbases immediately, but it is marked as not yet available. However, you can continue to use checkterm using this option. Once the caching process is finished, the user will be alerted via a popup in the system tray. 52 / 108 User Manual - checkterm

53 checkterm client ð The termbase has now been added to the pool of termbases available for check- Term. A dialog to select the parser profile appears: g) Select the parser profile and click on Apply. Or switch to the manual configuration by clicking on Assign manually (see also Configuring the Termbases). ð This completes the parser configuration Terminology Check Make sure you have started and configured the checkterm application (see Configuration) before using the hot key. This is how you can check your text for terminology: a) Highlight the text you want to check. b) Click on the hotkey you have set up (see Hotkey) or drag and drop the selected text into the analysis window. User Manual - checkterm / 108

54 checkterm client ð checkterm will launch, load the text, and highlight any detected issues: Hitlist Which color codings you can see depends on the setup of the respective types and colors (see View). The Matching Hits pane displays all terms found for the selected word in the text. By clicking on a hit in the hit list, the corresponding terminological entry is displayed next to it. See also 2 Exporting the report [} 57] 2 Displaying the report [} 56] 2 Text editor [} 58] Command bar Fields This field lets you select the potential replacement term for the selected issue. The number next to the issue (e.g. ) shows how many identical issues there are in the text. Buttons You can navigate from one issue to the next with the arrow keys. 54 / 108 User Manual - checkterm

55 checkterm client By selecting this button, checkterm automatically selects the first correct term of the selected entry as a replacement candidate. By clicking on this button, the text highlighted in the analysis window is replaced with the term you have selected in the dropdown. By clicking on this button you can ignore the current issue. Once you do that, check- Term considers all of these issues as correct. By clicking on this button, the current issue will be automatically corrected: check- Term uses the first available allowed term from the corresponding termbase entry. By clicking on this button you can carry out the replacement for all items where you have selected a replacement candidate but have not actually done the replacement yet. By clicking on this button you can ignore the current and all identical issues. Once you do that, checkterm considers all of these issues as correct. By clicking on this button you can create an HTML report based on the current analysis results (Further information see chapter Exporting the report [} 57]). By clicking on, checkterm opens the report directly (Further information see chapter Displaying the report [} 56]). This button copies the corrected text back to the clipboard, from where you can paste it back to the original document. Clicking on this button opens the source text editor (Further information see chapter Text editor [} 58]). See also 2 Exporting the report [} 57] Report After the analysis, you can display a compact view of all issues as a report, or you can export that report as a dynamic HTML file. User Manual - checkterm / 108

56 checkterm client Displaying the report By clicking on you can open the precise report of the last analysis. Illustration 12: checkterm report window In this dynamic view you can configure which hits to display or hide (see chapter View). By clicking on the icon, you can display the hits of the corresponding segment. 56 / 108 User Manual - checkterm

57 checkterm client Illustration 13: checkterm report - hit list window Exporting the report By clicking on you can create a precise report of the last analysis as a dynamic HTML file. In this HTML file you can configure which hits to display or hide (see chapter View). By clicking on the icon, you can display the hits of the corresponding segment File a quickterm Term Request In order to file term requests to quickterm, make sure you have configured the quick- Term connection (See Integration). Click on the quickterm request button in checkterm. The highlighted word and the source language are automatically entered. Please refer to your quickterm manual or terminology information in your company about all further quickterm functionality Show Entry in quickterm In order to display entries directly in quickterm, make sure you have configured the quickterm connection (See Integration). User Manual - checkterm / 108

58 checkterm client Click on the Show in quickterm button to display the entire entry in checkterm Quick Options The quick options feature lets you quickly change settings and reprocess the text. You can open the quick options by clicking on the button in the menu bar or double clicking any blank window area in the client. Illustration 14: Quick Options After changing the options the way you want to, you can simply click on Reprocess to run a new analysis on the same text based upon the changed options. You can find information on all the available options in the chapter Analyze Text editor By clicking on you can open the text editor. This button is only available if you have analyzed a text before. The text editor allows you to freely edit the text and then re-analyze it, or copy it back to the clipboard. 58 / 108 User Manual - checkterm

59 checkterm client Illustration 15: "Edit segment" dialog Click on Set to paste the text back into the analysis window. checkterm automatically re-analyzes the new text. By clicking on you can copy the text back into the clipboard. From there you can paste it back to the source document or any other Windows application using the standard copy/paste functionality Editor mode As an alternative to the standard mode, the editor mode allows interactively editing the source text while fixing the issues. This is useful whenever replacing terms in a document also requires additional adaptation of the text, for instance in languages with strong morphology, gender etc. You can switch between the two modes with the icon in the title back of checkterm. User Manual - checkterm / 108

60 checkterm client Illustration 16: Editor mode screen In the editor mode, the issues are not highlighted in the text itself. Instead, there is a feature-rich hit list. The buttons you have available in the editor mode work just like in the standard mode. By clicking on you can see the termbase entry for the respective issue. This entry contains all the details for this term from the termbase. 60 / 108 User Manual - checkterm

61 checkterm client Manual Search Illustration 17: Manual Search The manual search feature lets you search a term in the termbase, completely independent of any text you are analyzing. To do this, proceed as follows: a) Select the required Language. b) Select the profile which contains the termbases you want to use. c) Enter the search expression in the search field. d) Select the search mode you want to apply. e) Click on the button to run the search. ð checkterm lists all hits from the selected termbase(s) in the hit list. f) Select the one you want to display. ð checkterm will show the entire entry in the entry viewer next to the hit list Browse Termbase In this tab you can browse the entire termbase content. User Manual - checkterm / 108

62 checkterm client Illustration 18: Browse Termbase tab This is how you can browse the termbase: a) Select the Browse Termbase tab. b) Select the desired termbase. c) Select the required Language. checkterm will search the termbase and list all entries alphabetically. ð With the icons on the right hand side you can select whether you want the term list grouped by the first letter, or as a flat list alphabetically (ascending or descending). d) If you want to display an en, simply click on it. ð checkterm will display the entry in the entry pane next to the term list Pin to top By clicking on the icon in the title bar, you can pin checkterm to the top of the windows, making it always visible. In this mode, the checkterm window is always the frontmost window. You can turn this mode off by clicking on the icon again. 62 / 108 User Manual - checkterm

63 4.2.6 Context Menu The context menu of the system tray offers the following features: Show window Opens the checkterm desktop client. checkterm client Start / stop service (only available in normal mode (Further information see chapter checkterm client)), Starts or stops the local checkterm service on your machine. Show options Opens the configuration editor of checkterm. See Configuration [} 22]. License Opens the license viewer. In this dialog you can check the active licenses and register additional modules. Save log Allows you to generate a ZIP file with all relevant log files of checkterm. About Opens a dialog with the precise version info of checkterm. Exit Closes the checkterm desktop client and stops the service Command-line Operation Some processes in checkterm can be automated via the Windows command line interface. Syntax for refreshing termbases: CheckTerm.Client.Assistant.exe refresh -termbase "termbase1" "termbase2" The refresh parameter allows you to refresh a specific termbase in checkterm. You can list the termbases you want to refresh using the - termbase parameter. CheckTerm.Client.Assistant.exe refreshall The parameter refreshall allows you to refresh all termbases at once. User Manual - checkterm / 108

64 checkterm Studio Plug-in 5 checkterm Studio Plug-in 5.1 Introduction If you want to use the plug-in in the normal mode, you must first start the local check- Term service (Further information see chapter checkterm client). If it is not yet running, you can have it automatically started when the first function is called (for example analysis, options). To do that, you can set up the autostart option in the configuration (Further information see chapter General [} 23]). 5.2 Configuration All dialogs of the plug-in can be opened via keyboard shortcuts. Please follow the steps in the Trados Studio documentation to enable this General All the general settings, such as termbases, quickterm integration etc., are set up in the desktop client centrally. See Configuration. NOTICE Refreshing the plugin configuration Any changes done in the central configuration are automatically applied to the plugin every time it is started. If you change the configuration while a plugin is already running, you need to restart that plugin to reflect the configuration changes. To do so, restart the application where you are using the plugin, for example MS Word. 64 / 108 User Manual - checkterm

65 checkterm Studio Plug-in View Illustration 19: Options - Display dialog Button By clicking on this button, the current display options of the desktop client will be imported into the plugin. Button By clicking on this button, the display options of the plugin will be reset to the default. General Display Options Show the highest similarity result over the best matching result During the analysis process a morphological stemming operation is performed. For composite nouns this can lead to false positive matches in the termbase. While this is correct from an analysis point of view, it is confusing for the user. So if you select this option, the more complete termbase result is always ranked above the analysis result after stemming. User Manual - checkterm / 108

66 checkterm Studio Plug-in View style Here you can select between a more writer -oriented or a more linguistic display style for the analysis results. Writer View This view only highlights problematic hits, independent of their linguistic analysis result. Linguistic view This view highlights all hits depending on their linguistic properties. Linguistic View Options Lets you set up which kind of search result should be highlighted in which color. By selecting Hide you can deactivate the highlighting of this type of analysis result. These options are only available if you have selected Linguistic view in the general view options. Writers View Options Lets you set up the color to be used for potential problems in your content. These options are only available if you have selected Writers view in the general view options. NOTICE Available colors You can only select colors which are available in SDL Trados Studio for highlighting text. 66 / 108 User Manual - checkterm

67 checkterm Studio Plug-in Studio Illustration 20: Options - Studio dialog Live check options Check on segment s confirmation level changed Activates the terminology check every time a segment changes status (for instance when confirming it). Check on selected segment changed Activates the terminology check every time a new segment is selected. The check is always for the previous segment, meaning the one that was just confirmed, for example. Check on segment content changed Activates the terminology check while typing (changing the segment content). The check always lags a few seconds behind the actual typing. Analysis profile Select which analysis profile you want to use for live checking. Analysis type User Manual - checkterm / 108

68 checkterm Studio Plug-in Select the analysis type: Target only This checks only the target language, not taking into account the source segment. So for instance, this will not check if a term that is used in the source language was translated using the respective target term. Extended In addition to just checking the target language, this will also run a check on the source language. "Translation" This checks whether the terms used in the source language was translated using the respective target term. In addition, it checks the target terminology by itself, too, even if it is not used in the source language. "Search type" Lets you set up which mode should be used while analyzing a text: "Fuzzy" Retrieves all terms that are similar based on their characters "Normal" Only retrieves terms that match a word in your text 100% Custom In this search mode, checkterm uses the match values set up in the options (see Search Options in the configuration - analysis section). Use document s languages If this option is selected, then the language combination of the current document in Studio will also be used for the check. Use language dialects (only available if the option Use document s languages has been selected) If you select this option, then Studio will also take into account sublanguage variations (locales) when comparing the language settings. Target languages (only available if the option Use document s languages has NOT been selected) Here you can select the target languages to be used for the live check. Source languages (only available if the option Use document s languages has NOT been selected) Here you can select the source languages to be used for the live check. 5.3 Using checkterm checkterm dialogs You can rearrange the checkterm dialogs (for instance, the analysis results) like any other SDL Trados Studio window. To find out how to do this, refer to the SDL Trados Studio documentation. We recommend a setup something like this: 68 / 108 User Manual - checkterm

69 checkterm Studio Plug-in Illustration 21: checkterm windows in SDL Trados Studio Terminology Check You can check the terminology of your document in two ways: Analysis After checking the text, checkterm will display the results in a window or a side bar. From this window you can interactively work on the issues. Report Analysis After checking the text in the exact same way as above, checkterm will create an HTML report which you can send to the author or translator to fix the issues. To run an analysis, proceed as follows: a) Open a bilingual file in SDL Trados Studio. b) Click on Analyze document in the Add-Ins ribbon of SDL Trados Studio. Or type the keyboard shortcut you have assigned in your installation (see Configuration). User Manual - checkterm / 108

70 checkterm Studio Plug-in ð The "Start analysis" dialog opens. c) Select the analysis profile you want to use for the document (see chapter Analysis). d) Select the analysis type: "Only source language": This checks only the source language, not taking into account the target language. So for instance, this will not check if a term that is used in the source language was translated using the respective target term. Target only This checks only the target language, not taking into account the source segment. So for instance, this will not check if a term that is used in the source language was translated using the respective target term. Extended In addition to just checking the target language, this will also run a check on the source language. "Translation" This checks whether the terms used in the source language were translated using the respective target term. In addition, it checks the target terminology by itself, too, even if it is not used in the source language. e) Select the target language of the document. checkterm automatically suggests the current document target language. f) Select the source language of the document (only if you have selected the extended analysis). checkterm automatically suggests the current document source language. g) Select the search mode you want to apply for your analysis (See also Analyze). a) Click on "Analyze". ð The plugin will now analyze the document according to your settings and display the result in the Analysis result window Report To create an analysis report, proceed as follows: a) Open a bilingual file in SDL Trados Studio. b) Click on Analyze document in the Add-Ins ribbon of SDL Trados Studio. Or type the keyboard shortcut you have assigned in your installation (see Configuration). 70 / 108 User Manual - checkterm

71 checkterm Studio Plug-in ð The "Start analysis" dialog opens. c) Select the analysis profile you want to use for the document (see chapter Analysis). d) Select the analysis type: "Only source language": This checks only the source language, not taking into account the target language. So for instance, this will not check if a term that is used in the source language was translated using the respective target term. Target only This checks only the target language, not taking into account the source segment. So for instance, this will not check if a term that is used in the source language was translated using the respective target term. Extended In addition to just checking the target language, this will also run a check on the source language. "Translation" This checks whether the terms used in the source language were translated using the respective target term. In addition, it checks the target terminology by itself, too, even if it is not used in the source language. e) Select the target language of the document. checkterm automatically suggests the current document target language. f) Select the source language of the document (only if you have selected the extended analysis). checkterm automatically suggests the current document source language. g) Select the search mode you want to apply for your analysis (See also Analyze). a) Click on "Create report". ð The plugin will now analyze the document according to your settings and create an HTML report file. It will also open the folder where this HTML report has been stored Analysis result window This window shows the result of the analysis. User Manual - checkterm / 108

72 checkterm Studio Plug-in Illustration 22: checkterm - Analysis result window Every encountered issue is listed as a block in the result list. The number next to it (e.g. ) shows how often this issue occurs in the text. By clicking on this button you can ignore the current issue. Once you do that, check- Term considers all of these issues as correct. By clicking on this button you can ignore the current and all identical issues. Once you do that, checkterm considers all of these issues as correct. Fields This field lets you select the potential replacement term for the selected issue. Buttons You can navigate from one issue to the next with the arrow keys. By selecting this button you can display details about the termbase entry. You can define how many issues per page should be displayed. You can select which kinds of issues should be displayed (missing source language term, missing target language term, empty target language segment). 72 / 108 User Manual - checkterm

73 checkterm Studio Plug-in By selecting this button, checkterm automatically selects the first correct term of the selected entry as a replacement candidate. By clicking on this button, the text highlighted in the analysis window is replaced with the term you have selected in the dropdown. By clicking on this button you can carry out the replacement for all items where you have selected a replacement candidate but have not actually done the replacement yet. By clicking on this button, the current issue will be automatically corrected: check- Term uses the first available allowed term from the corresponding termbase entry. By clicking this button you can create an HTML report (Further information see chapter HTML report). By clicking on this button you can display a report of the issues in the current document ((Further information see chapter Displaying the report [} 74]). By clicking on this button you can re-run the analysis for the current document with the same settings. By clicking on this button you can open the configuration dialog for the plugin (Further information see chapter Configuration). See also 2 HTML report [} 75] User Manual - checkterm / 108

74 checkterm Studio Plug-in Displaying the report Illustration 23: checkterm report window In this dynamic view you can configure which hits to display or hide (see chapter View). By clicking on the icon, you can display the hits of the corresponding segment. 74 / 108 User Manual - checkterm

75 checkterm Studio Plug-in Illustration 24: checkterm report - hit list window HTML report There are several ways you can create an HTML report in the plugin: You can create it instead of a complete analysis (Further information see chapter Report). You can create it after a complete analysis (Further information see chapter Analysis result window [} 71]). In the HTML file you can configure which hits to display or hide (Further information see chapter View [} 33]). By clicking on the icon, you can display the hits of the corresponding segment Live check The live check runs the terminology verification while you translate. In order to use the live check, you need to set up the following: 1. It needs to be configured. See chapter Studio [} 67]. 2. The dialog Live check needs to be displayed. Click on Live check in the Add-Ins ribbon of SDL Trados Studio to open the live check dialog. Or type the keyboard shortcut you have assigned in your installation (see Configuration). User Manual - checkterm / 108

76 checkterm Studio Plug-in Illustration 25: Studio - Live check window NOTICE Features of the live check The various features of the live check largely match those of the analysis results dialog. See chapter Analysis result window. 76 / 108 User Manual - checkterm

77 checkterm Word Plug-in 6 checkterm Word Plug-in 6.1 Introduction If you want to use the plug-in in the normal mode, you must first start the local check- Term service (Further information see chapter checkterm client). If it is not yet running, you can have it automatically started when the first function is called (for example analysis, options). To do that, you can set up the autostart option in the configuration (Further information see chapter General [} 23]). 6.2 Configuration General All the general settings, such as termbases, quickterm integration etc., are set up in the desktop client centrally. See Configuration. NOTICE Refreshing the plugin configuration Any changes done in the central configuration are automatically applied to the plugin every time it is started. If you change the configuration while a plugin is already running, you need to restart that plugin to reflect the configuration changes. To do so, restart the application where you are using the plugin, for example MS Word. User Manual - checkterm / 108

78 checkterm Word Plug-in View Illustration 26: Options - Display dialog Button By clicking on this button, the current display options of the desktop client will be imported into the plugin. Button By clicking on this button, the display options of the plugin will be reset to the default. General Display Options Show the highest similarity result over the best matching result During the analysis process a morphological stemming operation is performed. For composite nouns this can lead to false positive matches in the termbase. While this is correct from an analysis point of view, it is confusing for the user. So if you select this option, the more complete termbase result is always ranked above the analysis result after stemming. 78 / 108 User Manual - checkterm

79 checkterm Word Plug-in View style Here you can select between a more writer -oriented or a more linguistic display style for the analysis results. Writer View This view only highlights problematic hits, independent of their linguistic analysis result. Linguistic view This view highlights all hits depending on their linguistic properties. Linguistic View Options Lets you set up which kind of search result should be highlighted in which color. By selecting Hide you can deactivate the highlighting of this type of analysis result. These options are only available if you have selected Linguistic view in the general view options. Writers View Options Lets you set up the color to be used for potential problems in your content. These options are only available if you have selected Writers view in the general view options. NOTICE Available colors You can only select colors which are available in Microsoft Word for highlighting text. User Manual - checkterm / 108

80 checkterm Word Plug-in Word Illustration 27: Options - Word dialog NOTICE Live check in Word Unfortunately live checking in Word is not technologically possible. However, the live check allows you to highlight a part of the document and have it checked in real-time. Options for the real-time analysis Analysis profile Select which analysis profile you want to use for live checking. "Search type" Lets you set up which mode should be used while analyzing a text: "Fuzzy" Retrieves all terms that are similar based on their characters "Normal" 80 / 108 User Manual - checkterm

81 checkterm Word Plug-in Only retrieves terms that match a word in your text 100% Custom In this search mode, checkterm uses the match values set up in the options (see Search Options in the configuration - analysis section). "Source language" Select the language you want to use for the live check, 6.3 Using checkterm Terminology Check You can check the terminology of your document in two ways: Analysis After checking the text, checkterm will display the results in a window or a side bar. From this window you can interactively work on the issues. Report Analysis After checking the text in the exact same way as above, checkterm will create an HTML report which you can send to the author or translator to fix the issues. This is how you can run an analysis: a) Open a file in MS Word. b) Click on "Analyze document" in the "Add-In" Tab of Word. ð The "Start analysis" dialog opens. c) Select the analysis profile you want to use. d) Select the language in which your document was written. e) Select the search mode you want to apply for your analysis (See also Analyze). User Manual - checkterm / 108

82 checkterm Word Plug-in f) Now select whether you want to analyze the entire document or only individual pages. g) Select whether or not to include headers and footers in the analysis. h) If you want to remove highlights (for instance from a previous analysis) from the document before running the next analysis. WARNING! The plugin can not differentiate between intentional, manual highlights and those done by the plugin itself. Selecting this option will remove all highlights in the document. a) Click on "Analyze". ð The plugin will now analyze the document according to your settings and display the result in the Analysis result window Report To create an analysis report, proceed as follows: a) Open a file in MS Word. b) Click on "Analyze document" in the "Add-In" Tab of Word. ð The "Start analysis" dialog opens. c) Select the analysis profile you want to use. d) Select the language in which your document was written. e) Select the search mode you want to apply for your analysis (See also Analyze). f) Now select whether you want to analyze the entire document or only individual pages. g) Select whether or not to include headers and footers in the analysis. h) If you want to remove highlights (for instance from a previous analysis) from the document before running the next analysis. WARNING! The plugin can not differentiate between intentional, manual highlights and those done by the plugin itself. Selecting this option will remove all highlights in the document. a) Click on "Create report". 82 / 108 User Manual - checkterm

83 checkterm Word Plug-in ð The plugin will now analyze the document according to your settings and create an HTML report file. It will also open the folder where this HTML report has been stored Context Menu You can use the context menu in MS Word to search for a word in quickterm or to file a term request. This feature is only available if the quickterm connection is set up (see Addins). NOTICE Highlights The fact that a term was highlighted by checkterm is not sufficient to select this word for a term request or search. You actually need to highlight the text again using the mouse or keyboard. Search a term This is how you can search a term in quickterm: a) Select the text you want to search in quickterm. b) Right click the selection to open the context menu. c) Then select Show in quickterm. ð This will open quickterm in a web browser and automatically run a search on the text you had highlighted. The source language for the term is the one you have set up for checking the document. Request a term This is how you can request a term in quickterm: a) Select the text you want to file as a term request in quickterm: b) Right click the selection to open the context menu. c) Then select quickterm term request. ð This will open the term request dialog of quickterm in a web browser. The source language for the term request is the one you have set up for checking the document Analysis result window This window shows the result of the analysis. User Manual - checkterm / 108

84 checkterm Word Plug-in Illustration 28: Analysis result window Every encountered issue is listed as a block in the result list. The number next to it (e.g. ) shows how often this issue occurs in the text. By clicking on this button you can ignore the current issue. Once you do that, check- Term considers all of these issues as correct. 84 / 108 User Manual - checkterm

85 checkterm Word Plug-in By clicking on this button you can ignore the current and all identical issues. Once you do that, checkterm considers all of these issues as correct. Fields This field lets you select the potential replacement term for the selected issue. Buttons You can navigate from one issue to the next with the arrow keys. You can define how many issues per page should be displayed. By selecting this button, checkterm automatically selects the first correct term of the selected entry as a replacement candidate. By clicking on this button, the text highlighted in the analysis window is replaced with the term you have selected in the dropdown. By clicking on this button you can carry out the replacement for all items where you have selected a replacement candidate but have not actually done the replacement yet. By clicking on this button, the current issue will be automatically corrected: check- Term uses the first available allowed term from the corresponding termbase entry. By clicking on this button you can create an HTML report (Further information see chapter HTML report [} 87]). By clicking on this button you can display a report of the issues in the current document ((Further information see chapter Report). By clicking on this button you can re-run the analysis for the current document with the same settings. By clicking on this button you can open the configuration dialog for the plugin (Further information see chapter Configuration). User Manual - checkterm / 108

86 checkterm Word Plug-in By clicking on this button you can highlight all terminology hits in the current document itself. By clicking on this button you can remove all highlights in the word document, whether they were added by checkterm or manually Displaying the report Illustration 29: checkterm report window In this dynamic view you can configure which hits to display or hide (see chapter View). By clicking on the icon, you can display the hits of the corresponding segment. 86 / 108 User Manual - checkterm

87 checkterm Word Plug-in Illustration 30: checkterm report - hit list window HTML report There are several ways you can create an HTML report in the plugin: Instead of running the analysis (Further information see chapter Report) After running the analysis (Further information see chapter "Analysis result window [} 83]) In the HTML file you can configure which hits to display or hide (Further information see chapter View [} 78]). By clicking on the icon, you can display the hits of the corresponding segment Live check a) Open a file in MS Word. b) Click on "Live check" in the "Add-In" Ribbon of Word. User Manual - checkterm / 108

88 checkterm Word Plug-in ð The Live check results sidebar opens. c) Highlight the text you want to check. d) Right-mouseclick the selected text. e) Select the option Live check from the context menu. ð checkterm now analyzes the selected text and displays the results in the Live check results side bar. NOTICE Features of the live check The various features of the live check largely match those of the analysis results dialog. See chapter Analysis result window. 88 / 108 User Manual - checkterm

89 checkterm Web 7 checkterm Web 7.1 Registration This is how you can log into Kalcium: ü You have started a web browser. a) Enter the URL of your server in the browser (Further information see chapter URL [} 89]). ð The Kalciumlogin dialog box appears b) Enter your user name. c) Enter your password. d) If you want to bypass the authentication next time, click on Remember me. Kalcium will remember your login information and will automatically log you in when you browse to the application URL the next time. e) Click on "Login". ð You have now been signed into Kalcium URL You can use several URLs to log into the Kalcium application in your browser. 1. [Server name]/login/admin This URL is used for administrative logins. 2. [Server name]/login/[tenant name] This URL is used to log into a specific tenant. 3. [Server name]/login User Manual - checkterm / 108

90 checkterm Web This URL is used to log into your default tenant. Please consult with your IT department to find out which URL you need to use specifically Login screen language You can change the language of the login screen: ü You have the login screen open (Further information see chapter Registration [} 89]). a) Select the button Select language ð The list of available user interface languages is displayed: b) Select the language you want to use. ð The login dialog is now displayed in the selected language Forgot my Password To request a new password, proceed as follows: ü You have the login screen open (Further information see chapter Registration [} 89]). a) Select the link Forgot password?. ð The "Reset password" screen appears: b) Enter your user name. c) Click on Request password reset. ð You will receive an with a new password. 90 / 108 User Manual - checkterm

91 7.2 Logout checkterm Web This is how you can log out of Kalcium: ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð This will display the context menu of your user account. b) Click on "Logout". c) This will sign you out of Kalcium. 7.3 Changing the user interface language You can change the language of the Kalcium user interface: ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð The list of available user interface languages is displayed: b) Select the required Language. ð The Kalcium application is now displayed in the selected language. 7.4 User account Personal settings Changing personal settings You can change the personal settings of your user: ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð This will display the context menu of your user account. b) Click on "My account". a) This opens the Personal settings screen. ð You can check your current personal settings. User Manual - checkterm / 108

92 checkterm Web a) You can also directly edit these personal settings (Further information see chapter Field descriptions of the personal settings [} 93]). a) Click on "Save" to save the changes to the settings. ð The changes will be stored. See also 2 Registration [} 89] Changing your password You can change the password of your user: ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð This will display the context menu of your user account. b) Click on "My account". a) This opens the Personal settings screen. ð You can check your current personal settings. a) Click on Change password. ð This opens the Change password screen: b) You must first enter your current password. c) Then you can enter the new password. d) Retype the personal password in the third field. e) Click on "Save password" to change your password to the new value. 92 / 108 User Manual - checkterm

93 checkterm Web ð Your password has been changed. NOTICE Password policy If your administrator has set up a password policy, then your new password must match these requirements. Please check the current policy with your Kalcium administrator if you are having problems. See also 2 Registration [} 89] Change avatar You can change the avatar image of your user: ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð This will display the context menu of your user account. b) Click on "My account". a) This opens the Personal settings screen. ð You can check your current personal settings. a) Simply click on your current avatar. For new users, the default avatar is a green circle with a white person icon. ð This will open a file browser. b) Select an image to use for your avatar. ð Your avatar image has been changed. NOTICE Size limits of your avatar image The size of the image file must not exceed 5 MB. The image will be resized to 48 x 48 pixels. See also 2 Registration [} 89] Field descriptions of the personal settings This chapter contains information relevant to the personal settings. Account settings User name The system name of the user. This value can not be changed for existing users. Full name The first and last name of the user. The user s address. User Manual - checkterm / 108

94 checkterm Web Analysis profiles This configuration section allows you to manage checkterm analysis profiles for each user Adding an analysis profile To add a new profile for a Kalcium tenant, proceed as follows: ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð This will display the context menu of your user account. b) Click on "My account". a) Select the Terminology tab. a) Open the Analysis profiles section. a) Click on Create new profile". ð This will open a dialog box where you can create a new analysis profile: b) Enter the name of the new analysis profile. c) Click on "Create". ð The new analysis profile has been created. The application will now display the screen with the settings of the new profile. d) Configure the settings (Further information see chapter Field descriptions of analysis profiles [} 97]). a) Click on "Save" to save the changes to the settings. ð The changes will be stored Editing an analysis profile ü You are signed into Kalcium (Further information see chapter Registration [} 89]). a) Click the icon in the header of the Kalcium application. ð This will display the context menu of your user account. b) Click on "My account". a) Select the Terminology tab. a) Open the Analysis profiles section. a) Select the profile. b) Click on "Edit". 94 / 108 User Manual - checkterm