BS RealTerm


General Information & Installation

About BS RealTerm

At its heart BS RealTerm is a powerful, multilingual Terminology Manager and Glossary. Instead of relying on clunky 3rd party software that often features only service-level integration, BS RealTerm is tightly integrated into Contentserv (CS 17.0+). Its main features are:

  • Terminology Manager with: preferred, approved, and forbidden phrases

  • Glossary that features detailed and rich descriptions of terms

  • Spell Checker for more than 90 languages

  • Rule-based suggestions for e.g. sentences or words that are too long

  • Pattern Validation to find common mistakes, such as multiple spaces

  • Integration into core CS features, such as
    Workflows, Data Quality Management, and general Text Editing

 


Required License

BS RealTerm is a module for Contentserv that requires a separate license.
Depending on your CS license a BS RealTerm license costs:

  • BS RealTerm is available for both perpetual licenses as well as an Add-On for your SaaS Instance.

  • Please contact your responsible Sales Person for details.

  • BS RealTerm is subject to a yearly Maintenance, Upgrades, and Support fee.

BS RealTerm is subject to the agreed-upon EULAs and SLAs.
If no other agreements exist the following applies:

  • 1st level support by Contentserv

  • 2nd level support by Business Solutions


Installation – Local Instances

Installation of BS RealTerm is pretty straight forward. If you have a local / on-premise instance of Contentserv you simply have to add the provided folder “alanirealterm” to

/Applications/CONTENTSERV/htdocs/trunk/BSLive/modules/

Depending on your installation the actual path might look a little different.


Installation – SaaS Instances

For SaaS instances of Contentserv the BS RealTerm module is a simple Add-On that can be ordered via

https://login.contentserv.com/instances/

Add-Ons that are already enabled are shown with a magenta checkmark.


Setup

Setup – User Roles

In order for you to use BS RealTerm your user roles require the appropriate permissions. There are various individual permissions that can be set, so that one user group may be able to administer BS RealTerm, while another is limited to using it. The following options are available:

  • Access to Studio

  • Administrate

  • Use

  • Edit Terms with Status 'Approved'

  • Edit Terms with Status 'In Discussion'

  • Edit Terms with Status 'Automatically Extracted'

To set these permissions navigate to:

System Preferences/User Management/Roles

select the role you wish to edit and expand the “BS” node. Here you will find a listing labeled “RealTerm”.


Setup – Rules

Now, that you configured some roles to be able to use BS RealTerm, it’s time to set up some general rules. We’ll give a few general and common examples, but feel free to set up rules according to your own needs.

  • All rules can be assigned to a specific “Area”, which serves as a grouping mechanism to make sorting and finding specific rules easier.

  • Any rule created will have a “Severity” assigned to it. There are three different Severity Levels ranging that let you define how important a rule is. These are from lowest to highest:

    • Info

    • Warning

    • Error

  • All rules can be set up to only apply to a specific set of languages. If no Language Filter is set the respective rule will apply to all languages.

  • Rules are based on individual plug-ins, these default plug-ins can be extended with custom ones that allow BS RealTerm to talk to 3rd party Terminology Managers such as acrolinx, Trados MultiTerm, or XTM.

To set up rules navigate to:

System Preferences/BS/Terminology/Rules

Use the Plus Icon in the Toolbar to create a new rule.

Spell Check

Select “Spell Check” as your “Rule Type” to enable a dictionary-based spell check. All words not included in the dictionary will be marked as wrong. Additional words can be added to the dictionary with the
BS RealTerm Editor while verifying texts. In addition to that, you can set up various exceptions.
You can selectively tell the “Spell Check” to:

  • Ignore words in UPPERCASE

  • Ignore Terms from Glossary

  • Ignore words with up to [number value] characters

  • Ignore text with up to [number value] words

  • Ignore words [words] (enter one per line)

 

Glossary Check

Select “Glossary Check” as your “Rule Type” to enable words to be checked against your Glossary entries.
All words listed in the Glossary as a “Forbidden Phrase” will be marked as wrong. Additional phrases can be added to the Glossary with the BS RealTerm Editor while verifying texts. You can set up the “Glossary Check” to only apply to specific “Categories” using the “Category Filter”.

All Glossary entries can be assigned to a specific “Category”, which serves as a grouping mechanism to make sorting and finding specific entries easier.

 

Sentence Length / Count Words / Count Characters

Select “Count Words” as your “Rule Type” to enable sentences to be checked considering their length.
The rule can be set up either based on a maximum number of

  • words

  • characters

Sentences with more words/characters will be highlighted.

 

Pattern Check

Select “Pattern Check” as your “Rule Type” to enable sentences to be checked using Regular Expressions.
This enables you to do all kinds of different checks and verifications. The “Regular Expression” field allows you to enter your pattern check expression. The “Replacement” field lets you define what the displayed comment/error message should read. As you will see in the examples listed below, these can contain not just plain text, but variables and Regular Expressions as well.

Here are three typical examples that you may want to use:

List items with a trailing dot

Regular Expression:

1 \.</li>

Replacement using another Regular Expression:

1 </li>

 

TWo INitial CApitals

Regular Expression:

1 ([A-Z]{2}[a-z]{1})\w*

Replacement using a variable :

1 [Are you sure that "$0" is correct?]

 

Word too long

Regular Expression:

1 ([A-Za-z]{18,})

Replacement using plain text:

1 Consider simpler wording.

 


Using BS RealTerm

Now that you have successfully set up BS RealTerm you can start using it. You can access it in several different ways, all of which we will detail in the following paragraphs.

Accessing the Detailed Glossary View

To view the Glossary navigate to:

System Preferences/BS/Terminology/Glossary

Click on either Glossary, or one of the sub-nodes to either view the entire Glossary or only one of its sections.

Use the Plus Icon in the Toolbar to create a new term. Filter the list using the Filter Icon. Or simply open any term by clicking on it, giving you a detailed view of the term and its rules.

For every term you can set a host of different options:

  • Preferred Phrase: The wording that should generally be used in most contexts.

  • Category: Use this to assign that term to a subsection within the Glossary.

  • Approved Phrase: Alternative versions of the Preferred Phrase.
    For a word like “iPhone”, “iPHONE” may be an acceptable phrase if it is used in an ALL-CAPS context.

  • Forbidden Phrases: Possible variants that are explicitly forbidden.
    For a word like “iPhone”, “IPhone” may be a forbidden phrase, as the initial “i” has to be written as a lower-case character in all circumstances.

  • Forbidden Reason: Let’s you add an explanation as to WHY a phrase is not to be used.

  • Edit Language: Set the language this term applies to.

  • Status: Is this entry still “in discussion”, or already “approved”?

  • Image: Add an image to your term to give it a visual context.


Accessing the Simple Glossary View

The Simple Glossary View can be accessed by clicking the ⎋ icon in a term’s toolbar, or by clicking the Notebook 📒 icon in the sidebar on the left.

This Glossary view replaces the standard CS table view with a searchable list of terms and a Glossary overview page on the right. The list can be filtered by Language and/or Category.

Click on any term to show it’s details page that gives you a nice overview of the approved and forbidden alternatives.

In order to make changes in this view, hover your cursor over the actual term in the details page. A clickable Pen ✎icon will be displayed that opens to the familiar editor.


Working with Products and writing Texts

The most basic and natural way to access BS RealTerm is when editing products and working with texts. If you open a product and BS RealTerm is active you will see a Pilcrow ¶ icon in the product’s toolbar. If all rules are met the Pilcrow will be black. If some rules are violated it will be orange. Hover over the Pilcrow to receive a tooltip that gives you a terminology check summary.

Click on the Pilcrow and the Inspector panel will open and switch to the Terminology tab automatically. Here you will find all text attributes on the left-hand side even if they are usually spread across several different tabs. Individual words may be highlighted depending on the rules which they violate. An explanation of the issues at hand is displayed on the right.

In order to use all available screen real estate, you can click the ⎋ icon in the panel’s toolbar to move it to a separate window.

This separate window is almost identical to the version found in the Inspector panel, save for the addition of a language selector in the top right, that lets you effortlessly switch between all available languages.

In order to make changes to your text you can either click on the highlighted word itself, or on the issue description in the right column. A context menu will open and give you several different options depending on your role’s privileges and the nature of the issue.

Glossary Violations

For words that have been defined in the Glossary the reason (if one was defined) will be listed alongside the preferred term. Via the context menu you can either accept the term from the Glossary or change the wording altogether. In addition to that, you may elect to add the term to the Glossary instead of changing it, and label it as an accepted or preferred term.

You may also take a look at the term itself in the Glossary, or even edit it, using the “Term” submenu.
The “Rule” Submenu lets you edit the rule that was violated directly from the Terminology Check window.

 

Misspelled Words

For words that have been misspelled the context menu looks slightly different. Here you can select from a few suggested spellings, elect to replace the word, add it to the Dictionary, or add it to the Glossary.

Additionally you can modify the rule and, for example, add it to the list of words to be ignored by the spell-check.

 


Integration with Workflows and Workflow Actions

BS RealTerm can seamlessly be integrated into your PIM or MAM workflows.

Open a workflow action or create a new one and select “BS Terminology Check” as your “Action Component”.

This will add the “BS Terminology Check” tab to the Edit Action window.

Here you can set up

  • which terminology checks should be performed,

  • on which attributes,

  • for which languages,

  • and what should happen if warnings or errors are encountered.

For a detailed description of Contentserv’s Workflow Engine, please refer to:
https://contentserv.atlassian.net/wiki/x/7QsGTw


Integration with DQM

BS RealTerm can seamlessly be integrated into your Data Quality Management.

Open a DQM rule or create a new one and select “BS Terminology Check” as your “Plugin”.

Here you can define which rules should be checked for which attributes. A separate selection for different languages is not necessary as DQM rules are always language-dependent. As with all other DQM rules, BS RealTerm based rules can, of course, also be displayed as part of a DQM Dashboard Tile.

For a detailed description of Contentserv’s Dashboard, please refer to:
https://contentserv.atlassian.net/wiki/x/hAwGTw


Version History

Initial Release 1.0

Changelog:


In a nutshell

The following PDF gives a simple overview of the BS RealTerm Module. This PDF can be used by Salespersons, Business Users, Marketing, etc.

Click here to