User’s Guide For the LanguageTool Plugin For Trados Studio
What Is What
Essential terms
LanguageTool
LanguageTool is a multilingual spelling, style, and grammar checker that helps correct or paraphrase texts. LanguageTool is an open-source project that helps as an international spellchecker and paraphraser in several languages, including: English, French, Spanish, Catalan, German, Dutch, Portuguese, Polish, Ukrainian, and more than 20 other languages and dialects. This multilingual grammar, style, and spell checker is used by millions worldwide. You can use the LanguageTool through your web browser or special plugins or add-ons. Plugins are available for Windows, Microsoft Office, Firefox, Google Chrome, Trados Studio, etc. More information can be found on the following pages:
- General information: https://languagetool.org/
- List of supported languages: https://dev.languagetool.org/languages
- Information for developers: https://dev.languagetool.org/
- List and rule builder: https://community.languagetool.org/
- Community forum: https://forum.languagetool.org/
LanguageTool package
Complete LanguageTool package that includes, among other resources, an HTTP server and resources for all supported languages. You can download LanguageTool package here: https://languagetool.org/download/
LanguageTool Plugin
LanguageTool Plugin (full name: LanguageTool Plugin — Grammar And Spell Checker) is an application for Trados Studio. This global verifier is used to check for grammatical and linguistic errors in the translated files. LanguageTool Plugin connects to the LanguageTool server via RestAPI and generates a list of all errors detected by the LanguageTool server. You can download the plugin from this page, from the RWS appstore or directly from Trados Studio. More information can be found here: https://posteditacat.xyz/languagetool-plugin-for-trados-studio/.
Java Runtime Environment, JRE
The Java Runtime Environment is a runtime environment (execution environment) needed for running Java programs. The JRE consists of a Java virtual machine, base classes, and helper files.
Eclipse Temurin OpenJDK JRE
Eclipse Temurin is the open-source Java Runtime Environment based on OpenJDK by the Adoptium Working Group. Members of the Adoptium are Red Hat, Microsoft, IBM and others. Eclipse Temurin OpenJDK JRE, unlike Oracle JRE, can be used free of charge also in commercial applications. It is a great advantage, which eliminates uncertainties with the legal interpretation of licensing terms of the JRE environment from Oracle. More information can be found here: https://adoptium.net/temurin/.
Advanced features terms
LanguageTool spell checkers
LanguageTool uses Morfologik for spell checking for most languages and Hunspell for a few others. Morfologik was included because of the speed problems with Hunspell. Spell checkers use their own dictionaries for spell checking separate from POS tagged dictionaries. Users can add their own words to the built-in dictionaries, as well as remove invalid words from the dictionaries. Spelling_custom.txt and prohibit_custom.txt files are used for this purpose. You can edit these files using the LanguageTool Customization module. You can further configure the spell checker dictionaries using the properties in the .info file. The Smart Spell Checker feature of LanguageTool uses three following properties:
fsa.dict.speller.ignore-numbers— if true, words containing numbers are not checked- f
sa.dict.speller.ignore-all-uppercase— if true, all UPPERCASE words will be ignored during the spell-check fsa.dict.speller.ignore-camel-case— if true, the CamelCase words will be ignored during the spell-check.
You can edit these properties using the LanguageTool Customization module.
Smart Spell Checker
The Smart Spell Checker is a unique spell checking feature. It makes sure that the spell checker returns as few false positives as possible so we can catch actual mistakes and typos more easily. Smart Spell Checker also protects users from making hard-to-catch typos in untranslatables and checks alphanumeric expressions and acronyms. By checking both the source text and the translation, Smart Spell Checker automatically and intelligently ignores the following untranslatables: proper names, product names, untranslatables, source UI options when bilingual translated, acronyms, words in capital letters, words in mixed letters, words containing digits, and alphanumeric expressions.
Spell checker properties info file [xx_XX.info or language-name.info]
Spell checker properties file that is used to configure spell checker dictionary. The plugin uses three properties that improve the performance of the Smart Spell Checker: fsa.dict.speller.ignore-all-uppercase, fsa.dict.speller.ignore-numbers=false, fsa.dict.speller.ignore-camel-case=false. By default, this file is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\LanguageTool\org\languagetool\resource\<lang_short_code>\hunspell\<lang_long_code>\
LanguageTool Plugin maintains the backup of this file located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\UserCustomFiles\org\languagetool\resource\<lang_short_code>\hunspell\<lang_long_code>\
See https://dev.languagetool.org/hunspell-support for more about spell checking in LanguageTool, and https://dev.languagetool.org/hunspell-support#configuring-the-dictionary for more on all properties used to configure dictionaries.
Custom spelling file [spelling_custom.txt]
This file contains words that extend the spell checker. If the dictionary used by LanguageTool for spell checking does not include some words and often reports them as spelling mistakes even though they are perfectly correct, you can add those words to this file. This file adds words to the dictionary for all variants. LanguageTool uses these words to generate corrections. By default, this file is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\LanguageTool\org\languagetool\resource\<lang_short_code>\hunspell\
LanguageTool Plugin maintains the backup of this file located in the following folderc:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\LanguageTool\org\languagetool\resource\<lang_short_code>\hunspell\
See https://dev.languagetool.org/hunspell-support for more about spell checking in LanguageTool.
Custom prohibit spelling file [prohibit_custom.txt]
This file contains words that should be considered incorrect even though the spell checker would accept them. If LanguageTool does not report some words as spelling mistakes, although you think it should, you can add those words in this file. By default, this file is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\LanguageTool\org\languagetool\resource\<lang_short_code>\hunspell\
LanguageTool Plugin maintains the backup of this file located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\UserCustomFiles\org\languagetool\resource\<lang_short_code>\hunspell\
See https://dev.languagetool.org/hunspell-support for more about spell checking in LanguageTool.
POS (part-of-speech) tag
A POS (part-of-speech) tag is a tag that identifies the possible parts of speech that a word has. Usually, in LanguageTool, a part-of-speech tag also includes other information, such as whether a noun is singular or plural.
POS (part-of-speech) tagged dictionary
A POS (part-of-speech) tagged dictionary is a binary dictionary containing words with part-of-speech tagging that is used by error detection rules. With that, it can look up words, e.g., detect that “children” is a plural noun in English. This dictionary is not used for spell checking. See https://dev.languagetool.org/developing-a-tagger-dictionary for more on a tagger dictionary and https://dev.languagetool.org/tips-and-tricks#adding-words-to-the-pos-tagger for more about how to add words to the POS tagger.
Custom POS (part-of-speech) tagged dictionary [added_custom.txt]
A custom POS (part-of-speech) tagged dictionary that is used additionally to the binary POS tagged dictionary (*.dict) built-in LanguageTool. This dictionary is not used for spell checking. By default, this file is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\LanguageTool\org\languagetool\resource\<lang_short_code>\
LanguageTool Plugin maintains the backup of this file that is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\UserCustomFiles\org\languagetool\resource\<lang_short_code>\
See https://dev.languagetool.org/developing-a-tagger-dictionary for more on a tagger dictionary and https://dev.languagetool.org/tips-and-tricks#adding-words-to-the-pos-tagger for more about how to add words to the POS tagger.
Removed custom POS (part-of-speech) tagged words dictionary [removed_custom.txt]
A POS (part-of-speech) tagged dictionary opposite to the added_custom.txt. This file removes incorrect items from the binary POS tagged dictionary (*.dict) built-in LanguageTool. It is useful to remove incorrect items from the built-in dictionary without rebuilding it. This dictionary is not used for spell checking. By default, this file is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\LanguageTool\org\languagetool\resource\<lang_short_code>\
LanguageTool Plugin maintains the backup of this file located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\UserCustomFiles\org\languagetool\resource\<lang_short_code>\
See https://dev.languagetool.org/tips-and-tricks#adding-words-to-the-pos-tagger for more about how to add words to the POS tagger.
Error detection rules [grammar.xml]
Grammar.xml is the LanguageTool file containing the error detection rules that LanguageTool uses to evaluate a text. Each language uses a separate grammar.xml file. The user can extend the rules existing in this file with their own error detection rules, which they can place either in this file or in their own error detection rules file. See https://dev.languagetool.org/development-overview, https://dev.languagetool.org/development-overview, and https://dev.languagetool.org/#rule-development for more on error detection rules.
Custom user rules file [sltp_user_rules_custom.xml]
This file contains custom user rules that extend built-in LanguageTool error detection rules (grammar.xml). This file is not part of the LanguageTool package. It is maintained by LanguageTool Plugin and is located in the following folder:c:\Users\[USER]\AppData\Local\StudioLanguageToolPlugin\UserCustomFiles\org\languagetool\rules\<lang_short_code>\
Users can edit this file and add custom rules with the help of the LanguageTool Customization module of the LanguageTool Plugin. See https://dev.languagetool.org/development-overview, https://dev.languagetool.org/development-overview, and https://dev.languagetool.org/#rule-development for more on error detection rules.
Java
Java is a programming language that is also used to implement LanguageTool. See http://www.java.com.