Acrolinx integration

Prerequisites

You need an Acrolinx account with the respective credentials to sign-on from censhare Web. Acrolinx rules and guidelines must be set directly in Acrolinx.

Introduction

The Acrolinx widget is available in the Content Editor of censhare Web.

The Acrolinx widget carries out grammar and spell checking, and suggests alternative terms. It checks your content for the style, tone and terminology issues. Acrolinx helps you to review content, and to maintain high quality across all text assets in your censhare platform.

The Acrolinx widget is integrated into the Content Editor of censhare Web. It connects to the Acrolinx application and retrieves the language profile from Acrolinx. A language profile contains the rules, guidelines and terminology lists for a language variant. Acrolinx provides language profiles for major languages and variants such as marketing, technical documentation, or standard.

The Acrolinx widget automatically detects the content language of the document you are editing and loads the corresponding language profile from Acrolinx.

The Acrolinx integration uses Single Sign-On (SSO). When you open the Acrolinx widget tab in the right window of the Content editor, censhare authenticates you at the Acrolinx server with your LDAP credentials. After initializing the widget, you can start to check your content:

The Acrolinx widget: (1) Run a document check, (2) Menu, (3) List the issues found in a document, (4) Findability tab, (5) Number of issues found, (6) Filter issues by category, (7) Context menu of an issue

Analyze content

To analyze and check the content, proceed as follows:

1. Open the content asset. On the Editor tab, open the Acrolinx tab in the right column. This initializes the Acrolinx widget. If the initialization was successful, the Acrolinx toolbar is shown.

2. To start the analysis, click CHECK. The document check can take a few moments. The progress bar shows that a document check is in progress. When the check is complete, the results are shown in the Acrolinx widget.

3. At the start, the content check tab (  ) is selected in the widget. It shows a list of issues that Acrolinx found in the document. The following categories are checked:

   • Spelling

   • Grammar

   • Style

   • Deprecated terms

   • Valid terms

   • Admitted terms

   • Clarity

   • Conversational tone

   • Acronym

4. To filter categories, open the filter menu (  ) and deactivate the categories you do not want to show.

5. To see a detailed analysis of the content, click the three dots and select Scorecard. The Scorecard opens in a new browser tab. 

6. To edit the keywords, go to the Findability tab (  ). On this tab, you can manage the target keywords of your content. 

Content actions

If Acrolinx detects errors or violations of your style guidelines, you can verify and correct them directly in the widget. When Acrolinx has completed a check of your document, the widget shows a list of cards. Each card refers to an issue that Acrolinx found in your document. If you click a card, it shows a short explanation.

In each card, you can perform the following actions:

The Scorecard

The Scorecard shows a more detailed view of an Acrolinx content analysis. In the top section, you see the score of your content for each category. A low score (marked red) means that you should take some action. A medium score (marked yellow) means that you should review the issues. A high score (marked green) means that your content fulfills the requirements of a category.

Below the Scorecard, expandable panels show more metrics and statistics of your content. To expand an item, click it.

The following sections show the issues that were found in your content for each category. This information is identical to the information displayed in the list of issues in the Acrolinx widget in the Content editor.

Generic rules

Acrolinx detects style and grammar issues, misspelled and deprecated terms based on a set of rules. To learn more about the rule that was applied to an issue, click More information in the respective issue. In a new browser tab, the generic rule is explained and examples of this rule are given.

Note: For the tone and clarity categories, you cannot open a generic rule. The explanation is given directly in the issue.

Findability

The Findability tab shows a list of keywords that Acrolinx found in the content. The tab also shows target keywords that are relevant to the document. Target keywords are stored in Acrolinx and help you to enhance the findability of your content. The findability check ensures that your content contains target keywords, and that they are placed prominently. For example, target keywords appear in the title, in the subheadline, or in the teaser.

Acrolinx also checks the prominence (if a keyword appears in a title or in the teaser, it is more prominent) and the frequency (how often a keyword appears in the content).

On the Findability tab, you can carry out the following actions:

• To show a list of suggested keywords, click .

• To show the target keywords, click .

• To sort keywords by prominence, frequency, or alphabetically, click the three dots and select the desired sorting option.

• To add a suggested keyword to the target keywords, go to the keyword card in the list and click .

Troubleshooting

The following errors can occur:

If one of the following errors occurs during the initialization of the widget, contact a system administrator:

Error message:

(1) It looks like this isn’t an Acrolinx Server or this server version doesn’t support the Sidebar. Ask your Acrolinx administrator to check your server version if you’re sure that the Acrolinx URL is correct.

(2) Misconfigured SSO.

Result

The Acrolinx widget checks the asset content and shows grammar and spelling errors, wrong terminology and style violations.