Term Variants

The Acrolinx integrations can recognize small differences between how a term is written in a document compared to how a term is entered in the Terminology Manager. This feature eliminates the need to enter minor variations of a term in the Terminology Manager.

Term variants can fall into one of two categories:

  • Legal variants
  • Illegal variants

You can influence how the Acrolinx integrations categorize a term variant by configuring term variant exceptions.

Legal Variants

A legal variant is a term variant with one or more of the following criteria:

  • It is permitted at the beginning of a sentence or in a title.
  • It contains branding-related symbols such as '®', '©', or '™'.
  • It is an exception configured in the term variant settings.

The Acrolinx integrations do not mark legal variants unless you select the checking option Valid Terms.

Example:

  • You have entered the term 'terminology management' in the Terminology Manager.
  • In a document, you write the sentence 'Terminology management is an important process.'

The term as it appears in the document has a first capital letter, but in the Terminology Manager the term is all lowercase. This kind of term variant is regarded as legal because a word at the beginning of a sentence must always have a first capital letter.

Illegal Variants

An illegal variant is a term variant which is not allowed under most circumstances. The Acrolinx integrations mark illegal variants with the deprecated color.

Example:

  • You have entered the term 'terminology management' in the Terminology Manager.
  • In a document, you write the sentence 'Many companies regard Terminology Management as an important process.'

The term as it appears in the document has each word capitalized, but in the Terminology Manager the term is all lowercase. This term variant is illegal because the term differs from how it is entered in the Terminology Manager and the context in the sentence does not require any special capitalization.

In general, the Acrolinx integrations mark term variants in the following situations:

  • The case of one or more characters in the written term is different to the term entry.
  • One instance of the term has a space where the other instance does not.
  • One instance of the term has a hyphen where the other instance does not.

Configuring Term Variant Exceptions

Term variants are orthographic variations on how terms are written. In most cases, Acrolinx highlights any word which is orthographically different to the entered term.

There are several exceptions to this behavior which you can configure on a term level or a global level.

If you notice that Acrolinx does not highlight some term variants correctly, you can perform the following actions:

  • Use the Advanced Term Edit Page to configure variant exceptions for an individual term.
  • Use the Term Variants Page to configure variant exceptions for all terms.

Configuring Term Variant Exceptions for All Terms

The global term variant rules on the Term Variants Page enable you to configure variant exceptions for all terms. Global term variant rules are useful when Acrolinx incorrectly highlights variants which are permitted for most of your terms.

You can use the global term variant rules to prevent generally permitted variants from being highlighted. Additionally, you can use the Advanced Term Edit Page to override a global variant rule in cases where a generally permitted variant should be highlighted for a particular term.

The Terminology Manager comes installed a standard set of term variant rules.

The following table explains the function of each global term variant rule.

NameUse to
Highlight VariantsTurn all variant highlighting on or off for all terms.

When this setting is off, all term variant rules which you have activated globally, or for a specific term, are ignored.

You can also use the Advanced Term Edit Page to turn variant highlighting on or off for single terms.

Require Uppercase at Beginning of SentenceHighlight any term which appears at the beginning of a sentence but is not written in the correct form for the beginning of a sentence. The correct form for a term at the beginning of a sentence is usually uppercase.
Allow Title Form Anywhere
Allow the variant form which is used in titles to be written anywhere in a sentence.

Activating this rule allows the term to be written with a first capital letter for each word in any part of the sentence. Additionally, any special title forms which you have defined at term level are also allowed anywhere in a sentence.

Use this rule if Acrolinx highlights too many titles incorrectly. This behavior usually occurs when there are too many different title contexts for Acrolinx to identify.

The Acrolinx linguistic team configures the title context definitions during the setup of your guidance package. During the setup process, Acrolinx identifies any paragraph formats and XML elements which constitute a title in customer documentation.
Require uppercase after hyphen in titlesRequire all words within hyphenated terms to have a first capital letter when in the title context.
Allow First Word CapitalizedAllow the form used at the beginning of the sentence to be written in any part of a sentence or document. This form is typically the first word of the term capitalized.
Allow Hyphen Between WordsAllow a hyphen to be used within all terms.
Allow All UppercaseAllow the term to be written in all uppercase letters.
Strict POS RestrictionOnly highlight inflections of the term when:
  • the inflected form is a valid form of the Acrolinx dictionary part of speech.

and

  • the part speech used in the sentence matches the Acrolinx dictionary part of speech.

For more information, see the topic About Morphosyntactic Restriction.

To configure a term variant exception for a specific term, follow these steps:

  1. Navigate to the page Terminology > Customize > Term Variants
  2. In the Term Variant Table, select the checkbox in the Value column to activate a rule.
  3. Click Save.

    Important: To make the change available for checking, the server administrator must reload the server configuration for the relevant language servers.

Configuring Term Variant Exceptions for a Single Term

The term variant rules on the Advanced Term Edit Page enable you to configure variant exceptions for individual terms and to override the global term variant rules.

The Terminology Manager comes installed with a standard set of term variant rules.

The following table explains the function of each term variant rule.

NameInputUse to
Form at Beginning of SentenceA single word, or a comma-separated list of words.
Define which variants should be allowed when they appear at the beginning of a sentence.

If you do not activate this rule, Acrolinx allows the term to be written with a first capital letter when it appears at the beginning of a sentence.

Example: Term management

Acrolinx uses punctuation or xml segmentation to identify the beginning of a sentence.
Title FormsA single word, or a comma-separated list of words.
Define which variants should be allowed when they appear in a title context.

If you do not activate this rule, Acrolinx allows the term to be written with a capital letter for each word when it appears in a title.

Example: Term Management

The Acrolinx linguistic team configures the title context definitions during the setup of your guidance package. During the setup process, Acrolinx identifies any paragraph formats and XML tags which constitute a title in customer documentation.
Always HighlightA comma-separated list of words.

Define which variants should be highlighted regardless of where they are in the document.

Example: term Management

Never HighlightA comma-separated list of words.Define which variants should never be highlighted regardless of where they are in the document.

Example: term management

Highlight Variants
  • On
  • Off
  • Use the Global Setting
Turn all variant highlighting on or off for a specific term.

When this setting is off, all term variant rules which you have activated globally, or for a specific term, are ignored.

Require Uppercase at Beginning of Sentence
  • On
  • Off
  • Use the Global Setting
Highlight any term which appears at the beginning of a sentence but is not written in the correct form for the beginning of a sentence. The correct form for a term at the beginning of a sentence is usually uppercase.
Allow First Word Capitalized
  • On
  • Off
  • Use the Global Setting
Allow the form used at the beginning of the sentence to be written in any part of a sentence or document. This form is typically the first word of the term capitalized.
Allow Title Form Anywhere
  • On
  • Off
  • Use the Global Setting
Allow all variants which you have defined in the Title Forms rule to be written in any part of a sentence or document.
Require uppercase after hyphen in titles
  • On
  • Off
  • Use the Global Setting
Require all words within hyphenated terms to have a first capital letter when in the title context.
Allow Hyphen Between Words
  • On
  • Off
  • Use the Global Setting
Allow a hyphen to be used within the term.
Allow All Uppercase
  • On
  • Off
  • Use the Global Setting
Allow the term to be written in all uppercase letters.
Strict POS Restriction
  • On
  • Off
  • Use the Global Setting
Only highlight inflections of the term when:
  • the inflected form is a valid form of the Acrolinx dictionary part of speech.

and:

  • the part of speech used in the sentence matches the Acrolinx dictionary part of speech.

For more information, see the topic About Morphosyntactic Restriction.


To configure a term variant exception for a specific term, follow these steps:

  1. Open the Term Edit Page for a term, and click the Advanced Term Edit tab.
  2. Enter the required input for the rule in the Value column.
  3. Click Save.

    Important: To make the change available for checking, the server administrator must reload the server configuration for the relevant language servers.