Customize the Acrolinx Term Browser

The Acrolinx Term Browser is a companion to the Acrolinx Terminology Manager. It serves as a reference tool for anyone in your organization who needs quick access to information in the terminology database.

If you’ve purchased the Acrolinx Term Browser, you can use the Terminology Manager to configure the following settings:

  • Configure filters for Acrolinx Term Browser users
  • Hide brackets around base form terms in the Acrolinx Term Browser

 If you’re using the Acrolinx Term Contributor, you can also configure the following settings for the Acrolinx Term Browser:

  • Allow users to add comments to existing terms
  • Make the commenting history available to users

Customizing the Appearance of the Acrolinx Term Browser

In addition to editing the term help templates, you can also edit the CSS files to control which buttons are displayed on the Acrolinx Term Browser page.

To customize the appearance of the Acrolinx Term Browser, follow these steps:

  1. Open your overlay of the following file: term-browser.css 

    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%\server\www\gwt\css
    Don’t edit the installed version of the file. Instead, always edit your overlay in the configuration directory.
  2. Edit the file and add one or more of the following code excerpts:

    SyntaxUse to
    #helpButton{display: none;}
    Hide the Help link.
    #changeLanguageButton{display: none;}
    Hide the Change Language link.
    #contributeTermButton{color: <COLOR>;}
    Set the color of the Contribute Term link, for example green.
    #contributeTermButton img{display: none;}
    Hide the icon that is usually displayed next to the Contribute Term link.
  3. Save your changes.
    Your changes take effect after you reload the Acrolinx Term Browser.

Configuring Filters for Acrolinx Term Browser Users

In the Terminology Manager, you can save search filters which anyone can open in the Acrolinx Term Browser.

To save a filter for Acrolinx Term Browser users, follow these steps:

  1. Sign in into the Dashboard as the termbrowser user.

    You log on as the termbrowser user to ensure that you save the filters for the users of the Acrolinx Term Browser.

    The termbrowser user is a built-in user, which is enabled when you install a license that contains the Acrolinx Term Browser module
  2. Create one or more filters.
  3. Open the Acrolinx Term Browser to check that your filter is visible in the Saved Filters menu (For more information about using the Acrolinx Term Browser, see the Acrolinx Term Browser User Guide).

    Important: In the Acrolinx Term Browser, keyword searches are restricted to terms in the active filter. If you configure a default filter, keyword searches are restricted to terms within the default filter. The default filter is activated when users open the Acrolinx Term Browser. To search all terms in the database, a user must reset the filter to 'show all terms'.

To link directly to a saved filter:

  • In a web browser, enter the Acrolinx Term Browser URL with the following parameters:

    #filtername=[FILTER_NAME]&list=yes

    Example:

    http://127.0.0.1:8031/termbrowser/Standardview.html#filtername=MyValidatedTerms&list=yes

Enabling Users to Add Comments to Existing Terms

You can add a link to the term help file so that users can add comments to existing terms.

To add the link to the term help file, follow these steps:

  1. Open your overlay of the following file: term_help_template.vm 

    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\common

    Don’t edit the installed version of the file. Instead, always edit your overlay in the configuration directory.

  2. Add the following code excerpt to the appropriate section of the file: 

    #if ($comments) <a href="/termcontribution.html?addComment/termId/$id" target="blank"> Comment on this Term</a> #end
  3. Save your changes.

Enabling Acrolinx Term Browser Users to Propose Terms

You can configure the Acrolinx Term Browser to include an extra link to the autocomplete dropdown so that users can quickly propose terms that they searched for, but didn’t find in the terminology database.

There’s no visual confirmation when users click on the link. The term is automatically added to the terminology database.

To enable Acrolinx Term Browser users to propose 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: 

    termSearchLog.enableProposalSubmission=true
  3. Add the following properties: 

    termSearchLog.statusName=[STATUS_NAME]
    termSearchLog.domainName=[DOMAIN_NAME]
    termSearchLog.languageName=[LANGUAGE_NAME]
     These properties configure the default status, domain, and language of the proposed terms. The values must match the names that are used in the category manager.
  4. Save your changes and restart the core server.

Viewing the Commenting History

You can allow users to view the commenting history of a term by adding the appropriate variable to the template.

To make the commenting history available for Acrolinx Term Browser users, follow these steps:

  1. Open your overlay of the following file: term_help_template.vm 

    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\common

    Don’t edit the installed version of the file. Instead, always edit your overlay in the configuration directory.

  2. Add the follow code excerpt to the appropriate section of the file:

    #foreach($comment in $comments)
    <span style="font-weight: bold;">$comment.userName on $comment.date</span><p/> $comment.text <p/>#end     
  3. Save your changes.

Displaying Brackets Around Base Form Terms in the Acrolinx Term Browser

The term edit page enables you to check inflections for a selected word within a term. Words, which can be inflected are known as base form terms and are surrounded by square brackets when viewed in the search results table.

Example: term [management]

By default, this formatting is hidden in the Acrolinx Term Browser because Acrolinx Term Browser users are normally not familiar with the linguistic settings available in the Terminology Manager.

To show brackets around base form terms when viewed in the Acrolinx Term Browser, follow these steps:

  1. Sign in to Dashboard as the termbrowser user.
  2. Click the Settings button in the upper right-hand corner
  3. On the Settings page, select the Show brackets around base form terms in Acrolinx Term Browser option.

    The changes take effect immediately.

Adapting the Acrolinx Term Browser URL

You can add parameters to the Acrolinx Term Browser URL to change the appearance of the Acrolinx Term Browser or access-specific functions.

The following parameters apply to both the standard view and the translation view.

ParameterUse to
#list=yes
Show the results filter of the default filter as soon as you open the Acrolinx Term Browser.

Example:

http://127.0.0.1:8031/termbrowser/standardview.html#list=yes

By default, the Acrolinx Term Browser doesn’t display the results of the default filter when you first open the Acrolinx Term Browser.

Restriction: In the translation view, the parameter #list=yes only displays the results of most recent search, or all terms if you’ve started a new session.
#termDatabaseId=<TERM_ID>
Display the term help for a specific term, using the numeric term database ID.

Example:

http://127.0.0.1:8031/termbrowser/translationview.html#termDatabaseId=3

The term ID is normally displayed in the help information for a term.

This parameter can be useful to share a link to a specific term with another user.

#search=<SEARCH_TEXT>
Display the term help for a specific term, using the term name.

Example:

http://127.0.0.1:8031/termbrowser/standardview.html#search=Term Browser

You can also enter search text, which contains a wildcard.

Example:

http://127.0.0.1:8031/termbrowser/standardview.html#search=term%

This parameter can be useful to share a link to a search result with another user.

?locale=
Change the language of the Acrolinx Term Browser interface.

Example:

http://127.0.0.1:8031/termbrowser/translationview.html?locale=de#Filter=yes

The Acrolinx Term Browser is currently available in English and German.

Use the following language codes:

  • de for German
  • en for English


The following parameters apply to the standard view only.

ParameterUse to
#hide=filterbutton
Display the Acrolinx Term Browser with the filter button removed from the Search and Filter Bar.

This parameter is useful to share the Acrolinx Term Browser with users who aren’t familiar with the options displayed in the filter menu.

Example:

http://127.0.0.1:8031/termbrowser/standardview.html#hide=filterbutton&filtername=MyValidatedTerms&list=yes
Users can still open saved filters and edit filter criteria in a saved filter.
#filtername=<FILTER_NAME>
Link directly to the results of a saved filter.

Example:

&list=yes http://127.0.0.1:8031/termbrowser/standardview.html#filtername=MyValidatedTerms
Use this parameter in combination with the parameter #list=yes.