Install the term checker for ASD-STE100

This page tells you how to install the term checker with the stand-alone version of LanguageTool.

Optionally, after you install the term checker, install add-ons and plug-ins to integrate LanguageTool with other software. (Installation instructions for oXygen XML Editor.)

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

ste-term-checker
    \data-files
        disambiguation-projectterms.xml
        grammar-projectterms.xml
    \LanguageTool-4.n
        languagetool.jar
        \org\languagetool\resource\en\disambiguation.xml
        \org\languagetool\rules\en\grammar.xml

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

During the installation, you will edit XML files. Thus, an XML editor or a text editor that has syntax highlighting is necessary (https://en.wikipedia.org/wiki/Syntax_highlighting).

To install the remote files version of the term checker: process

  1. Ask TechScribe for a free trial. We will send you a small compressed file (.zip) that contains disambiguation.xml and grammar.xml.
  2. Create the directories and install LanguageTool.
  3. Optional step. Change the language on the interface to English.
  4. Put the TechScribe files into LanguageTool and start the term checker.
  5. Recommended optional step. Show error types in colour.
  6. Download the templates for your project terms.
  7. Customize the rules in the templates to include the technical names and the technical verbs that your organization uses.
  8. Optional step. After you are sure that you can customize the rules correctly, install the LanguageTool n-gram data to use a statistical method to find some errors that the term checker does not find.

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

Create the directories and install LanguageTool

  1. If Java 8 is not on your computer, install Java 8 (www.java.com/).
  2. In a convenient location, create a directory ste-term-checker.
  3. In ste-term-checker, create a directory data-files. (You will use this when you download the templates for your project terms.)
  4. In ste-term-checker, download LanguageTool version 4.1 (www.languagetool.org/download/LanguageTool-4.1.zip) and extract it.
  5. Double-click languagetool.jar and make sure that LanguageTool operates correctly. (If LanguageTool does not start, refer to https://languagetool.org/issues/.)
    The screen shot shows English. You will see the default language for your operating system.
    LanguageTool
  6. Optional step. If English is not the default language of the interface, change the language on the interface to English.

Change the language on the interface to English

Initially, LanguageTool uses the default language of your operating system for the text on the interface. Optionally, change the text to English. The example shows Russian to English.

  1. Click the equivalent of Text Checking>Options.
    Russian text on the LanguageTool interface
  2. Change the GUI language to English (American).
    Russian text on the LanguageTool interface
  3. Close LanguageTool and start it again.
  4. Change the text language to English (American).
  5. Close LanguageTool.

Put the TechScribe files into LanguageTool and start the term checker

  1. In the LanguageTool stand-alone installation directory, replace ..\org\languagetool\resource\en\disambiguation.xml with disambiguation.xml that TechScribe sent to you.
  2. In the LanguageTool stand-alone installation directory, replace ..\org\languagetool\rules\en\grammar.xml with grammar.xml that TechScribe sent to you.
  3. 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.
  4. If LanguageTool does not automatically check the text, click Check Text.
    The screen shot shows what you will see.
    LanguageTool with default text
  5. LanguageTool has default rules that are not in grammar-ste7.xml. Some default LanguageTool rules give unwanted error messages, as this example shows:
    LanguageTool shows unwanted error messages
    If you write 3 or more sentences that start with the same word, you can click 'deactivate'. Alternatively, to prevent the unwanted error, deactivate the LanguageTool rule in LanguageTool Options:
    1. Click Text Checking>Options.
    2. On the Style Rules tab, in the Style group, remove the check mark from: Successive sentences beginning with the same word
      Deactivate: Successive sentences begining with the same word
  6. Optionally, to see the primary problems that the term checker identifies, use sample-text-for-ste-term-checker.txt.
  7. Close LanguageTool.

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

  1. Close LanguageTool.
  2. Open .languagetool.cfg in a text editor. (In Windows, .languagetool.cfg is usually in the folder C:\Users\Your Name.)
  3. Replace this line of code: errorColors=
    with this line of code: errorColors=characters:#FF80FF, grammar:#C0FFC0, misspelling:#D0E0D0, mistranslation:#FFFF80, non-conformance:#FFC0FF, omission:#C0C000, other:#FF9800, register:#C0FFFF, terminology:#FFC0C0, untranslated:#E0E0FF
  4. Close .languagetool.cfg.
  5. Double-click languagetool.jar. Some errors have a coloured background:
    Some errors have a coloured background
  6. Close LanguageTool.

Download the templates for your project terms

  1. Close LanguageTool.
  2. Download these files into the data-files directory:
  3. In the LanguageTool stand-alone installation directory, edit ..\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/ste-term-checker/data-files/disambiguation-projectterms.xml">
  4. In the LanguageTool stand-alone installation directory, edit ..\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.

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 http://wiki.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:

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-ste7-201n-nn-nn.zip, which contains the files disambiguation-ste7.xml and grammar-ste7.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 full version

  1. Close LanguageTool.
  2. Extract term-checker-ste7-201n-nn-nn.zip into the data-files directory.
  3. In the LanguageTool stand-alone installation directory, edit the entity declarations in ..\org\languagetool\resource\en\disambiguation.xml to 'point' to the files for ASD-STE100 issue 7. Example:
    <!ENTITY STE7DisambiguationRules SYSTEM "file:///D:/test/ste-term-checker/data-files/disambiguation-ste7.xml">
    <!ENTITY ProjectTermsDisambiguationRules SYSTEM "file:///D:/test/ste-term-checker/data-files/disambiguation-projectterms.xml">
    
  4. In the LanguageTool stand-alone installation directory, edit the entity declarations in ..\org\languagetool\rules\en\grammar.xml to 'point' to the files for ASD-STE100 issue 7. Example:
    <!ENTITY STE7GrammarRules SYSTEM "file:///D:/test/ste-term-checker/data-files/grammar-ste7.xml">
    <!ENTITY ProjectTermsGrammarRules SYSTEM "file:///D:/test/ste-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 (http://wiki.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 term checker

  1. Download LanguageTool stand-alone for your Desktop (www.languagetool.org) into the ste-term-checker directory and extract it. You will have this directory structure:
    ste-term-checker
        \data-files
            disambiguation-projectterms.xml
            disambiguation-ste7.xml
            grammar-projectterms.xml
            grammar-ste7.xml
        \LanguageTool-4.0
            languagetool.jar
            \org\languagetool\resource\en\disambiguation.xml
            \org\languagetool\rules\en\grammar.xml
        \LanguageTool-4.1
            languagetool.jar
            \org\languagetool\resource\en\disambiguation.xml
            \org\languagetool\rules\en\grammar.xml
    
  2. Copy disambiguation.xml from the old version of LanguageTool to the new version of LanguageTool.
  3. Copy grammar.xml from the old version of LanguageTool to the new version of LanguageTool.
  4. To be safe, move the current disambiguation-ste7.xml and grammar-ste7.xml files from the data-files directory to a backup location.
  5. Extract term-checker-ste7-201n-nn-nn.zip into the data-files directory.
  6. 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-ste7.xml and grammar-ste7.xml.

Update LanguageTool for the remote files version of the term checker

The term checker uses LanguageTool, which is released 4 times each year (http://wiki.languagetool.org/roadmap). If TechScribe makes new rules for the term checker that operate only with the most recent version of LanguageTool, we will tell you by e-mail and on the RSS feed.

To use the remote files version of the term checker, you must do one of these:

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

  1. Close LanguageTool.
  2. Download LanguageTool stand-alone for your Desktop (www.languagetool.org) into the ste-term-checker directory and extract it. You will have this directory structure:
    ste-term-checker
        \data-files
            disambiguation-projectterms.xml
            grammar-projectterms.xml
        \LanguageTool-4.0
            languagetool.jar
            \org\languagetool\resource\en\disambiguation.xml
            \org\languagetool\rules\en\grammar.xml
        \LanguageTool-4.1
            languagetool.jar
            \org\languagetool\resource\en\disambiguation.xml
            \org\languagetool\rules\en\grammar.xml
    
  3. Copy disambiguation.xml from the old version of LanguageTool to the new version of LanguageTool.
  4. Copy grammar.xml from the old version of LanguageTool to the new version of LanguageTool.
  5. After you are sure that the new version of LanguageTool operates with the term checker rules, delete the old version of LanguageTool.

To use the old version of the data files

  1. Close LanguageTool.
  2. In the LanguageTool stand-alone installation directory, edit ..\org\languagetool\resource\en\disambiguation.xml to 'point' to the old version of disambiguation-ste7.xml. TechScribe will tell you the date of the old file. Example:
    
    <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
    <!DOCTYPE doc [
    <!ENTITY STE7DisambiguationRules SYSTEM "https://user:password@www.techscribe.co.uk/ste-term-checker/disambiguation-ste7-2017-10-01.xml">
    
    [code deleted]
    
    
  3. In the LanguageTool stand-alone installation directory, edit ..\org\languagetool\rules\en\grammar.xml to 'point' to the old version of grammar-projectterms.xml.
RSS feed