Configure the Checking Behavior for Admitted Terms

Admitted terms are terms that you can use when the preferred term isn’t suitable for a specific context. You can configure how Acrolinx handles these admitted terms.

Highlighting Admitted Terms in the Deprecated Issue Color

By default, admitted terms are highlighted if you select Valid terms in the integrations. The integration then highlights preferred and admitted terms in the document in orange. You might want to do this if you're creating a glossary of terms that are in the document.

You might want to highlight admitted terms together with deprecated terms. The integration then highlights admitted terms in the same color as deprecated terms if you run a check for deprecated terms. This helps users be aware of potential terminology issues and are encouraged to check that the context of the term is correct.

Attention: In the default setting false, Acrolinx treats and evaluates admitted terms like preferred terms. This is important if you use this property together with other properties that affect admitted terms.
Tip: By default, admitted terms contribute to the Acrolinx Score when they’re highlighted in the deprecated color. However, you can configure the Core Platform to prevent admitted terms from contributing to the Acrolinx Score.



To configure admitted terms so that they're highlighted in the deprecated issue color, follow these steps:

If you're on an Acrolinx private cloud  instance, contact us and we'll configure these for you! 

  1. Open your overlay of the relevant language configuration file.

    If you haven't yet created an overlay of this file, create a new version of the file at the following location:

    %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties

    If this location doesn't yet exist, create the required subdirectories first.

  2. Add the following property:

    terminology.markAdmittedTerms=true

    When you enable this setting and users run checks with Deprecated terms selected, the integrations highlight admitted terms in the deprecated color.

    When this property isn't in the configuration file, the default behavior is false and admitted terms are highlighted in the valid term color.

  3. Save your changes and reload the language configuration on the relevant language servers.


Configuring a Separate Issue for Admitted Terms

You can configure Acrolinx to display an option to specifically check for admitted terms and highlight these terms separately from deprecated and valid terms. You can also customize the name of the admitted term status.

Remember: The behavior for admitted terms also depends on the property terminology.markAdmittedTerms.

To configure a separate issue type and customized name for admitted terms, follow these steps:


  1. Open your overlay of the core server properties file.

    You find the overlay for the core server properties file in the following location:

    %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties
  2. Add the following property:

    useCustomizableAdmittedTermFlag=true
  3. (Optional) To prevent the integrations from suggesting admitted terms as replacements for terminology issues, add the following property:

    suggestAdmittedTerms=false

    When this property isn't in the core server properties file, you'll see the admitted terms in the suggested replacements for terminology issues.

  4. Save your changes and restart the core server.
  5. (Optional) To customize the name of the admitted term status, update the status name in the Dashboard.
    1. Open the Dashboard and select Terminology > Customize > Category Manager.
    2. Rename the display name of the category admitted to the name of your choice.

      The changes are visible in your checking options after you refresh the connection to the server.


Configuring Scoring for Admitted Terms

By default, admitted terms contribute to the Acrolinx Score when they’re highlighted in the deprecated color. Admitted terms don't contribute to the Acrolinx Score when you configured a separate issue for them. Depending on your requirements, you might want to:

  • have admitted terms contribute to the score if you configured a separate issue for them, or
  • prevent admitted terms from contributing to the Acrolinx Score at all.

To configure scoring for admitted terms, follow these steps:

If you're on an Acrolinx private cloud  instance, contact us and we'll configure these for you! 

  1. Open your overlay of the relevant language configuration file.

    If you haven't yet created an overlay of this file, create a new version of the file at the following location:

    %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties

    If this location doesn't exist, create the required subdirectories first.

  2. Add the following properties:

    terminology.markAdmittedTerms=<TRUE/FALSE>
    
    terminology.scoreAdmittedTerms=<TRUE/FALSE>

    If either of these properties is set to false, admitted terms don't contribute to the Acrolinx Score.

    Only if both properties are set to true, admitted terms contribute to the Acrolinx Score.

    When these properties aren't present in the configuration file, the default behavior is markAdmittedTerms=false and scoreAdmittedTerms=true, respectively.

  3. Save your changes and reload the language configuration on the relevant language servers.