Install or update the term checker for ASD-STE100

Installation

The design of the term checker for ASD-STE100 shows 4 files. To make LanguageTool into a checker for STE, you will replace the LanguageTool versions of disambiguation.xml and grammar.xml with the TechScribe versions. Each TechScribe version contains the user/password data and a URL to disambiguation-ste8-2023-10-09.xml or grammar-ste8-2023-10-09xml, which 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 (not all files and directories are shown). In this example, ste8-term-checker is the installation directory:

ste8-term-checker
    \data-files
        disambiguation-projectterms.xml
        grammar-projectterms.xml
    \LanguageTool-6.3
        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

Look at the video about how to install the term checker (11 minutes 57 seconds).

Contact TechScribe for a free trial. TechScribe will send you a small compressed file (.zip) that contains disambiguation.xml and grammar.xml. These XML files customize LanguageTool to become a a checker for ASD-STE100. This example shows the content of disambiguation.xml:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!DOCTYPE doc [
<!ENTITY STE8DisambiguationRules SYSTEM "https://user:password@www.techscribe.co.uk/ste-term-checker/disambiguation-ste8-2023-10-09.xml">
<!ENTITY ProjectTermsDisambiguationRules SYSTEM "https://www.simplified-english.co.uk/disambiguation-projectterms.xml">
<!-- For the remote files version of the term checker, when you use a local file, the full path is necessary. You MUST include 'file:///'. Example: 
<!ENTITY ProjectTermsDisambiguationRules SYSTEM "file:///D:/ste8-term-checker/data-files/disambiguation-projectterms.xml">
-->
]>
<rules lang="en" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/languagetool-org/languagetool/master/languagetool-core/src/main/resources/org/languagetool/resource/disambiguation.xsd">

&STE8DisambiguationRules;

</rules>

During the installation, you will edit XML files. If possible, use an XML editor or a text editor that has syntax highlighting (https://en.wikipedia.org/wiki/Syntax_highlighting). (If necessary, you can use a text editor that does not have syntax highlighting.)
If Java 8 is not on your computer, install Java 8 (www.java.com/).
The installation instructions refer to file name extensions (.jar, .xml, .zip) and paths. To prevent confusion, make sure that you can see the file name extensions and the path. For example, in Microsoft Windows:

2. Create the directories and install LanguageTool

In a convenient location, create this directory: ste8-term-checker..
In ste8-term-checker, create this directory: data-files. (You will use this directory when you download the templates for your project terms.)
In ste8-term-checker, download LanguageTool-6.3.zip (https://languagetool.org/download/LanguageTool-6.3.zip) and decompress it:
In LanguageTool-6.3, double-click languagetool.jar and make sure that LanguageTool operates correctly. (This step is necessary to make sure that the file association is correct. 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 screenshot 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-6.3\org\languagetool\resource\en\disambiguation.xml with disambiguation.xml that TechScribe sent to you.
Replace LanguageTool-6.3\org\languagetool\rules\en\grammar.xml with grammar.xml that TechScribe sent to you.
Delete LanguageTool-6.3\org\languagetool\rules\en\style.xml. The style rules in style.xml are not applicable to ASD-STE100.
Double-click languagetool.jar.
LanguageTool will load these files: disambiguation-ste8-2023-10-09.xml, grammar-ste8-2023-10-09.xml, disambiguation-projectterms.xml, and grammar-projectterms.xml
The total file size is approximately 4.5 megabytes. Thus, if your internet connection is slow, you must wait 30 seconds (or more) for LanguageTool to start.
If LanguageTool does not automatically check the text, click Check Text.
The screenshot shows what you will see.
LanguageTool has a small number of default rules that are in the LanguageTool Java code. 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

It is possible to add an attribute to a rule to specify a Localization Quality Issue Type. The term checker uses the attribute values to add coloured backgrounds to the errors that it finds:
Errors have a coloured background

Colours show the type of error
Localization Quality Issue Type	Colour (hexadecimal value)	Meaning in the term checker	Applicable rules in ASD-STE100
Addition	#FBDEBB	One or more words is a possible proper noun, or a singular determiner is used before a non-count noun.	1.5.8, 1.5.10, 1.5.11, 1.5.15, 2.3
Characters	#FF80FF	A character is a semicolon or a non-standard character.	8.1
Grammar	#C0FFC0	The tense is not an approved tense.	1.2, 3,2, 3.3, 3.4, 3.5
Inconsistency	#E0E0C0	A not-approved word is used with a different part of speech.	1.1
Legal	#D6D6D6	Prototype rules. (The rules are not available to most users.)	None
Misspelling	#D0E0D0	A word is approved, but the spelling is not correct.	1.14
Mistranslation	#FFFF80	This error type is for semantics. One or more words are approved and the parts of speech are correct, but there is a possible semantic error.	1.3, 1.5, 1.12.4, 2.1, 2.2, 3.2 ('be to' + infinitive only), 3.6, 3.7, 7.1, 8.1, 9.2, 9.3, GR-1, GR-2, GR-4, GR-6
Non-conformance	#FFC0FF	A word contains a ligature.	None
Omission	#C0C000	A word is missing or a word is a contraction of an approved word.	2.3, 4.2
Other	#FF9800	There is a disambiguation error or a character encoding error.	None
Register	#C0FFFF	A word is approved, but it is not used with its approved part of speech.	1.2, 1.6, 1.7
Terminology	#FFC0C0	A term is not-approved or there is a possible hyphenation error.	1.1, 1.4, 8.2
Untranslated	#E0E0FF	A word is unknown in ASD-STE100.	1.1

To show error types in colour

Close LanguageTool.
Open .languagetool.cfg in a text editor. (In Windows, .languagetool.cfg is usually in C:\Users\Your Name.)
Add the line of code that follows:
```
errorColors=addition:#FBDEBB, characters:#FF80FF, grammar:#C0FFC0, inconsistency:#E0E0C0, legal:#D6D6D6, 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-6.3\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-6.3\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.

8. 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 screenshot 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-6.3\org\languagetool\resource\en\disambiguation.xml to specify the location of the disambiguation files. 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-6.3\org\languagetool\rules\en\grammar.xml to specify the location of the grammar files. 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

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

To update LanguageTool and the local files version of term checker

In ste8-term-checker, download LanguageTool version 6.3 (https://languagetool.org/download/LanguageTool-6.3.zip) and decompress 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-6.2
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml
    \LanguageTool-6.3
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml

Delete LanguageTool-6.3\org\languagetool\rules\en\style.xml. The style rules in style.xml are not applicable to ASD-STE100.
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

LanguageTool is is released 2 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.

You do not receive files from TechScribe. The files disambiguation.xml and grammar.xml contain your user/password data. You copy the files to the new version of LanguageTool. Then, you edit disambiguation.xml and grammar.xml to specify the location of the new files that are on the TechScribe website. Refer to The design of the term checker for ASD-STE100.

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

Close LanguageTool.

In ste8-term-checker, download LanguageTool version 6.3 (https://languagetool.org/download/LanguageTool-6.3.zip) and decompress it.
You will have this directory structure:

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

Delete LanguageTool-6.3\org\languagetool\rules\en\style.xml. The style rules in style.xml are not applicable to ASD-STE100.
In LanguageTool-6.2\org\languagetool\resource\en\, copy disambiguation.xml to the equivalent directory in LanguageTool-6.3.

Edit LanguageTool-6.3\org\languagetool\resource\en\disambiguation.xml to specify the new file disambiguation-ste8-2023-10-09.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-2023-10-09.xml">

[code deleted]

In LanguageTool-6.2\org\languagetool\rules\en\, copy grammar.xml to the equivalent directory in LanguageTool-6.3.
Edit LanguageTool-6.3\org\languagetool\rules\en\grammar.xml to specify the new file grammar-ste8-2023-10-09.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