Install or update the term checker for ASD-STE100

Installation

The design of the term checker for ASD-STE100 shows 4 files. In the remote files version of the term checker, the files disambiguation-ste8.xml and grammar-ste8.xml are on the TechScribe website. When you install the term checker, you automatically agree to the legal conditions.

After you install the term checker, you will have this directory structure:

ste8-term-checker
    \data-files
        disambiguation-projectterms.xml
        grammar-projectterms.xml
    \LanguageTool-5.7
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml

The installation is not easy. Be careful. If a problem occurs, refer to Troubleshooting.

1. Before you start the installation

Before you start the installation, ask TechScribe for a free trial. TechScribe will send you a small compressed file (.zip) that contains disambiguation.xml and grammar.xml. These XML files let LanguageTool access the data that is on the TechScribe website.
During the installation, you will edit XML files. Thus, use an XML editor or a text editor that has syntax highlighting (https://en.wikipedia.org/wiki/Syntax_highlighting).
If you have an IT department, contact the IT department:
- Make sure that firewall settings will not prevent access to password-protected files on a website.
- Make sure that the Java security manager does not forbid Authenticator.setDefault(), because LanguageTool cannot access the external files that are on the TechScribe website if it does.
If Java 8 is not on your computer, install Java 8 (www.java.com/).

2. Create the directories and install LanguageTool

Create this directory: ste8-term-checker.
In ste8-term-checker, create this directory: data-files. (You will use this when you download the templates for your project terms.)
In ste8-term-checker, download LanguageTool version 5.7 (https://languagetool.org/download/LanguageTool-5.7.zip) and extract it.
In LanguageTool-5.7, double-click languagetool.jar and make sure that LanguageTool operates correctly. (If you have problems with LanguageTool, get help from https://languagetooler.freshdesk.com/en/support/home. At this stage, the problem is not related to the term checker.)
The screen shot shows English. You will see the default language for your operating system (you can change the language on the interface to English).
Optionally, install add-ons and plug-ins to integrate LanguageTool with other software. (You can do this task after you install the term checker, but it is better to make sure that the LanguageTool integrations operate correctly at this part of the installation process.)

3. Optional. Change the language on the interface to English

Initially, LanguageTool uses the default language of your operating system for the text on the interface (GUI language). Optionally, change the GUI language to English. The example shows Ukrainian to American English.

Click the equivalent of Text Checking>Options.
Change the GUI language.

4. Select American English for the STE checks

After the installation is completed, you can use British English for the STE checks (refer to Rule 1.14).

In Text Language, select English (American).
Optional step if the GUI language is not English. You will see many STE errors, because the default text is not English. Paste the default LanguageTool text into the term checker to see the default LanguageTool analysis of English text:
```
This is a example input to to show you how LanguageTool works.
```
Close LanguageTool. LanguageTool will keep the changes that you made to the GUI language and the text language.

5. Put the TechScribe files into LanguageTool and start the term checker

Replace LanguageTool-5.7\org\languagetool\resource\en\disambiguation.xml with disambiguation.xml that TechScribe sent to you.
Replace LanguageTool-5.7\org\languagetool\rules\en\grammar.xml with grammar.xml that TechScribe sent to you.
Double-click languagetool.jar.
If your internet connection is slow, you must wait 30 seconds (or more) for LanguageTool to start, because LanguageTool downloads many megabytes of data from the TechScribe website.
If LanguageTool does not automatically check the text, click Check Text.
The screen shot shows what you will see.
LanguageTool has default rules that are not in grammar-ste8.xml. Some default LanguageTool rules give unwanted error messages, as this example shows:

You can deactivate the rules that give unwanted error messages.
Optionally, to see the primary problems that the term checker identifies, use sample-text-for-ste-term-checker.txt.
Close LanguageTool.

6. Optional. Show error types in colour

The term checker maps many STE errors to Localization Quality Issue Types. Optionally, you can show these errors with a coloured background:
Some errors have a coloured background

To show error types in colour

Close LanguageTool.
Open .languagetool.cfg in a text editor. (In Windows, .languagetool.cfg is usually in the folder C:\Users\Your Name.)
Add the line of code that follows:
```
errorColors=addition:#FBDEBB, characters:#FF80FF, grammar:#C0FFC0, inconsistency:#E0E0C0, misspelling:#D0E0D0, mistranslation:#FFFF80, non-conformance:#FFC0FF, omission:#C0C000, other:#FF9800, register:#C0FFFF, terminology:#FFC0C0, untranslated:#E0E0FF
```
Put the line of code into one of these locations:
- If .languagetool.cfg contains a line errorColors=, replace the text.
- If .languagetool.cfg does not contain a line errorColors=, put the line of code at the end of the file (possibly, LanguageTool will change its position).
Close .languagetool.cfg.
Double-click languagetool.jar. Warnings about possible errors have a coloured background:
Close LanguageTool.

7. Download the templates for your project terms

Although you can use the term checker if you do not do this procedure, you cannot add your technical terms to the term checker. Also, if TechScribe changes these templates when there is a new version of the term checker and if you use the files that are on the TechScribe website, errors can occur.

Close LanguageTool.
Download these files into the data-files directory:
- disambiguation-projectterms.xml
- grammar-projectterms.xml
Edit LanguageTool-5.7\org\languagetool\resource\en\disambiguation.xml. In the line that contains ProjectTermsDisambiguationRules, change the path to the path of disambiguation-projectterms.xml on your computer.
For example, change:
<!ENTITY ProjectTermsDisambiguationRules SYSTEM "https://www.simplified-english.co.uk/disambiguation-projectterms.xml">
To:
<!ENTITY ProjectTermsDisambiguationRules SYSTEM "file:///D:/test/ste8-term-checker/data-files/disambiguation-projectterms.xml">
Edit LanguageTool-5.7\org\languagetool\rules\en\grammar.xml. Change the line that contains ProjectTermsGrammarRules to the path of grammar-projectterms.xml on your computer.

You can now customize the rules to include the technical names and the technical verbs that your organization uses.

7. Optional. Install the LanguageTool n-gram data

The term checker does not find all possible semantic errors or part-of-speech errors. For information about the errors that the term checker finds, refer to 'Rules'.

LanguageTool can use n-grams and a statistical method to find possible errors. The n-gram data is very large. Thus, the installation of the n-gram data is separate from the installation of the stand-alone version of LanguageTool. To install the n-gram data, refer to https://dev.languagetool.org/finding-errors-using-n-gram-data.

The screen shot shows examples of errors that the statistical method can find:
Some errors have a coloured background

In the example sentences, all the words are approved in ASD-STE100, but they are used incorrectly:

Do the some tests again: some is an approved adjective, but the correct adjective is same.
Remove the waist from the hangar: waist is a technical name (noun, rule 1.5.12), but the correct noun is waste.
Use a week solution of water and disinfectant: week is a technical name (noun, rule 1.5.4), and week solution is a noun cluster (compare with oil filter). The correct word is weak (adjective).
Your manager will tell your to open the door: your is an approved adjective, but the correct word is you (pronoun).
It is there problem, not the manufacturer's problem: there is an approved pronoun, but the correct word is their (pronoun).

Update the term checker to the local files version

After you buy a licence for the local files version, TechScribe will send you term-checker-ste8-202n-nn-nn.zip, which contains the files disambiguation-ste8.xml and grammar-ste8.xml. (TechScribe will also send you subsequent updates. For a list of changes to the term checker rules, refer to changes.txt.)

To update the term checker to the local files version

Close LanguageTool.
Extract term-checker-ste8-202n-nn-nn.zip into the data-files directory.

Edit the entity declarations in LanguageTool-5.7\org\languagetool\resource\en\disambiguation.xml to specify the location of the files for ASD-STE100 issue 8. Example:

<!ENTITY STE8DisambiguationRules SYSTEM "file:///D:/test/ste8-term-checker/data-files/disambiguation-ste8.xml">
<!ENTITY ProjectTermsDisambiguationRules SYSTEM "file:///D:/test/ste8-term-checker/data-files/disambiguation-projectterms.xml">

Edit the entity declarations in LanguageTool-5.7\org\languagetool\rules\en\grammar.xml to specify the location of the files for ASD-STE100 issue 8. Example:

<!ENTITY STE8GrammarRules SYSTEM "file:///D:/test/ste8-term-checker/data-files/grammar-ste8.xml">
<!ENTITY ProjectTermsGrammarRules SYSTEM "file:///D:/test/ste8-term-checker/data-files/grammar-projectterms.xml">

Update LanguageTool and the local files version of the term checker

The term checker uses LanguageTool, which is released 4 times each year (https://dev.languagetool.org/roadmap). If TechScribe supplies new rules for the term checker that operate only with the most recent version of LanguageTool, then to use the new rules, you must also update LanguageTool.

To update LanguageTool and the local files version of term checker

Download LanguageTool version 5.7 (https://languagetool.org/download/LanguageTool-5.7.zip) into the ste8-term-checker directory and extract it. You will have this directory structure:

ste8-term-checker
    \data-files
        disambiguation-projectterms.xml
        disambiguation-ste8.xml
        grammar-projectterms.xml
        grammar-ste8.xml
    \LanguageTool-5.6
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml
    \LanguageTool-5.7
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml

Copy disambiguation.xml from the old version of LanguageTool to the new version of LanguageTool.
Copy grammar.xml from the old version of LanguageTool to the new version of LanguageTool.
To be safe, move the current disambiguation-ste8.xml and grammar-ste8.xml files from the data-files directory to a backup location.
Extract term-checker-ste8-202n-nn-nn.zip into the data-files directory.
Double-click languagetool.jar to start the term checker.
After you are sure that the new version of LanguageTool operates with the term checker rules, delete the old version of LanguageTool and the backup version of disambiguation-ste8.xml and grammar-ste8.xml.

Update LanguageTool and the remote files version of the term checker

The term checker uses LanguageTool, which is released 4 times each year (https://dev.languagetool.org/roadmap). Usually, a new version of the term checker is available approximately 1 week after the LanguageTool release. We will tell you by e-mail and on the RSS feed.

To update LanguageTool and the remote files version of the term checker

Close LanguageTool.

Download LanguageTool version 5.7 (https://languagetool.org/download/LanguageTool-5.7.zip) into the ste8-term-checker directory and extract it. You will have this directory structure:

ste8-term-checker
    \data-files
        disambiguation-projectterms.xml
        grammar-projectterms.xml
    \LanguageTool-5.6
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml
    \LanguageTool-5.7
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml

In LanguageTool-5.6\org\languagetool\resource\en\, copy disambiguation.xml to the equivalent directory in LanguageTool version 5.7.

Edit LanguageTool-5.7\org\languagetool\resource\en\disambiguation.xml to specify the new file disambiguation-ste8-2022-04-04.xml. Example:


<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!DOCTYPE doc [
<!ENTITY STE8DisambiguationRules SYSTEM "https://user:password@www.techscribe.co.uk/ste8-term-checker/disambiguation-ste8-2022-04-04.xml">

[code deleted]

In LanguageTool-5.6\org\languagetool\rules\en\, copy grammar.xml to the equivalent directory in LanguageTool version 5.7.
Edit LanguageTool-5.7\org\languagetool\rules\en\grammar.xml to specify the new file grammar-ste8-2022-04-04.xml.
Double-click languagetool.jar to start the term checker.
After you are sure that the new version of LanguageTool operates with the term checker rules, delete the old version of LanguageTool.

RSS feed