The Acrolinx Sidebar makes it easy for you to create amazing content. As you write, Acrolinx shows you how to tune your content for your audience with just a few clicks. From tweaking terminology to tightening your text, the Acrolinx Sidebar helps you create content that your audience will love.
How to Use the Sidebar Cards
When Acrolinx finds some issues, you'll get the results as cards in the Sidebar. Each Sidebar card offers you guidance but you can decide what to do with each issue.
For each issue, Acrolinx displays a colored card. The colors help you to identify the different issue types at a glance.
Depending on your Writing Guide and Options settings you might see the following colors:
Here is what you can do with the Sidebar cards:
|Action||Highlight the issue in your content.|
|Description||To see the issue highlighted in your content, click the title of the issue in the Sidebar card.|
View your options.
|Description||To see your options, click on the three dots on the right side of the card.|
Select a replacement.
The replacements Acrolinx suggests appear in green. To insert a suggestion that fits, click it. If there are more than three replacements provided, clickto display the other possibilities. Then, click the replacement you want.
To help you with your decision, you'll see anext to any preferred terms and a next to any admitted terms. Preferred terms appear at the top of the list of suggestions, followed by admitted terms. Note that you'll only see these icons if there are any preferred or admitted terms that relate to your issue.
|Description||If you want to replace all occurrences of the issue with the replacement you want, select the option Replace all occurrences and click the fitting suggestion.|
Ignore an issue.
To temporarily ignore the issue and remove the card from the list, click theicon.
Ignore an issue in the whole document.
To temporarily ignore all identical occurrences of the issue, click theicon. Acrolinx then hides all cards that correspond to the same issue.
Contribute a new term.
|Description||You can send a new term to the terminology database. To contribute a new term, hover over the card and click the arrow icon. A comment field will open where you can enter why this term should be included to the database.|
Add term to a permanent spelling exception list.
You can add the term as a permanent spelling exception, so that it will never show up as a spelling issue again. You'll only see this option on spelling issues.
There are three different lists of spelling exceptions. You might not see all of them if your Acrolinx administrator has disabled some lists.
Get more information.
The cards often provide helpful insights on the found issue. Additionally, you can click MORE INFORMATION.
Alternatively you can hover over the card and click the info icon.
|Description||Sometimes the cards in the Sidebar show you where to find the issue in your content. In the cards above, the spelling issues are in a list and a table respectively. This helps you to find issues faster.|
Some Sidebar Cards Look a Bit Different
Sometimes Acrolinx finds an issue but can't suggest a replacement or can't replace it. But don't worry, Acrolinx still guides you through your content. The Sidebar cards offer you a lot of information that helps you solve these kinds of issues.
Here is what the Sidebar cards tell you in certain situations:
Style and clarity issues
|Description||Acrolinx can't always suggest a replacement for some types of issues, especially style and clarity issues. For example, Acrolinx doesn't suggest anything when the issue covers a whole sentence. In this case, Acrolinx tells you that the sentence could be improved. But it's up to you to decide how to improve it.|
Sometimes, Acrolinx checks part of your content but can't highlight the issue or automatically insert suggestions. This can happen when your content is protected in some way. For example, when your content is read-only, has restricted access, or is digitally signed. It can also happen when there’s a limitation with the Integration, for example due to an editor's API limitations.
If this happens, the Sidebar card appears inactive and shows a padlock icon.You might also see the following message:
Often, you can still edit each issue directly in the text.
Grayed out card
|Description||Sometimes the Sidebar cards appear grayed out. This happens when you've edited your content and the card isn’t up-to-date anymore. You might want to run another check to refresh your Sidebar.|
You might also see a grayed out card if you've clicked on an inactive card. In this case, you can still read all the information you need to edit your content directly in the text.