Workflow Instructions: Configuring the Language Check

Owned by Claudius Hörth
Feb. 08, 2024

Intro

These instructions describe how to configure Congree Language Check rules and add unknown words to the user lexicon.

There are three parts to these instructions:

  1. Rule configuration in Congree UMMT
  2. User lexicon maintenance in Congree UMMT
  3. Linguistic Compiler: Make changes available from Congree UMMT

Part 1 - Rule configuration in Congree UMMT

Situation

Which rules are checked by the Congree Language Check is set in Congree UMMT. In Congree UMMT, unknown words are also identified (see Part 2).

Rule configuration in Congree UMMT is usually changed for the following reasons:

  • You want to verify your Style Guide, your writing specifications, or Tone of Voice guidelines with the Congree Language Check. To do this, you map your guidelines to Congree rules.

  • You want to incorporate feedback from your users and activate or deactivate rules, or you want to adjust the counter values of rules.

    Tip:

    If a rule is frequently reported by users as annoying, we recommend that you deactivate the rule. Then discuss whether and when the rule should be used and adjust the rule configuration if necessary. Enter the decision in your Style Guide.

    Note:

    On an element-specific basis (for XML documents), rules can be deactivated in the document settings, Paragraph recognition section, in the Congree Control Center.

  • You have changed your Style Guide or other guidelines and would like to update the Congree Language Check.

Procedure

To change the rule configuration, that is, to activate or deactivate individual rules, proceed as follows:

  1. Open Congree UMMT. Congree UMMT is always installed on the application server.
  2. Open a rule configuration via File - Open project. A rule configuration is preset (Compathy).
  3. Open the rule configurations (style, grammar, spelling) in the navigation section on the left. Activate or deactivate the individual rules in these sections. Some rules can also be adjusted using a counter.
    • The rules can also be configured based on the document structure or an XML structure.
    Bearbeitungsbereich-Stilregeln-2015-Ueberblick.png
  4. Save your changes via File - Save project. Do not use any other menu item.
  5. Finally, exit Congree UMMT.

For the changes to take effect, part 3 of these instructions must be performed.

Part 2 - User lexicon maintenance in Congree UMMT

Situation

The Congree Language Check is based on a morphemic dictionary that covers the test language. Special words from certain application areas may nevertheless be unfamiliar to Congree, such as the following constructs:

  • company-specific abbreviations
  • product names
  • terms in foreign languages

To avoid annoying false alarms from the Congree Language Check, you can enter these kinds of words into the user lexicon in a Style Guide.

Alternative spellings (e.g. company name in ALLCAPS) are also stored in the user lexicon.

Procedure

To add new words to the user lexicon, do the following:

  1. Open Congree UMMT. Congree UMMT is always installed on the application server.
  2. In the navigation section on the left, open the user lexicon section and the noun section in it.
  3. Enter unfamiliar words here. Extensive documentation on the user lexicon including the other sections is available online at https://documentation.congree.com/x/8pI6AQ
    Datenbestand-Benutzerwoerterbuch-Substantiv.png
  4. Save your changes via File - Save project. Do not use any other menu item.
  5. Finally, exit Congree UMMT.

For the changes to take effect, part 3 of these instructions must be performed.

Part 3 - Linguistic Compiler: Make changes available from Congree UMMT

Situation

The Congree Language Check delivers check results within milliseconds. To make natural language analysis and evaluation as fast as possible, the check configuration and other resources such as term variants and user lexicon are optimized for the computer. It works similar to a database index.

Changes to the Congree Language Check rule configuration or to the user lexicon therefore require this optimized form to be made available again. This task is performed by the Linguistic Compiler in the Congree Control Center.

Procedure

To make changes to the Congree Language Check or the user lexicon available to users, proceed as follows:

  1. Open the Congree Control Center and log in. At a minimum, the Congree Control Center is always installed on the application server.
  2. Open the SyncCenter, Linguistic Compiler section.
  3. Select all Style Guides and click the Compile button.
  4. The changes are available when the job status in the Job list (one menu to the right) indicates Successful.
  5. To ensure that the updated configuration of the Congree Language Check is applied in the editor, simply log out and log in again via the Congree toolbar. This deletes the results cached by the Congree plugin.