Acrolinx for Arbortext - Version 1.0 (19 April 2018)
We're really excited to welcome another Acrolinx integration to the Sidebar family - this time it's Acrolinx for Arbortext! Take a look at all that the Sidebar edition has to offer.
Sidebar Start Pages
When you switch to the Sidebar edition, you might wonder where you can find all the things you're familiar with from Classic. You’ll find everything you need, from options, to help, to log files, on the Sidebar start page or in the slide-out menu.
And if you’re having trouble connecting with the Sidebar, take a look at Why Can't My Sidebar Connect to Acrolinx? , which you can also open from the start page.
Acrolinx Reads Multiple File Types
Acrolinx checks .html , .xhtml, .xml, .dita, and even .ditamap files for you. On top of that, you can extend the file types which Acrolinx checks. Find out more in the article How to Configure Acrolinx to Recognize Your File Type .
Darwin Information Typing Architecture (DITA) Map Checking
Did we say .ditamap? Yes, Acrolinx for Arbortext can check entire DITA maps. You can run a check to get an overview of the issues in your entire DITA map, and the results appear in a lighter version of Sidebar. This means the Sidebar cards give you all the information you need to improve your content, but Acrolinx doesn't highlight or replace issues for you. To edit individual topics, open the DITA files separately and edit each issue directly.
Check a Selection of Your Content
Ever felt like one particular part of your content needs more attention? With check selection, you can now select parts of your document for Acrolinx to check. We know some of you waited for this, so update to the Sidebar edition and wait no more!
Embed Check Data
If your Acrolinx administrator enables Embed Check Data, Acrolinx saves the Acrolinx Score, time stamp, and link to the Scorecard for all your checked content as a processing instruction at the end of your document. Just another way to keep track of your content quality at a glance!
A typical processing instruction might look like this:
<?acrolinxCheckData score="82" scorecardUrl= "<SERVER_ADDRESS>/output/en/gear_pump_xhtml_admin_38616c5a5ff3e6fe_1_report.html" timeStarted="2017-10-10T06:24:03Z" status="green" ?>
Sidebar Appears in Your Preferred Language
By default, the Sidebar appears in English. If your Arbortext Editor language is German, French, Japanese, or Swedish, then your Sidebar will also appear in this language.
You'll need a new license to get the Sidebar edition activated.
Manage Extraction Settings with Content ProfilesWith the Classic edition, you configured your extraction settings directly in Acrolinx for Arbortext. For all Sidebar editions, you now configure Content Profiles in the Acrolinx Dashboard. Your guidance package comes with default Content Profiles for different file types and editors. If you use a custom DTD for XML content, you'll need to customize a Content Profile. But don't worry, as part of your update delivery of Acrolinx 5.3, we'll migrate your Classic edition extraction settings to Content Profiles to work with the Sidebar edition.
Known Issues With Highlighting and Replacement
File Entities Might Cause Acrolinx Highlights to Shift
If Acrolinx detects an issue in the same paragraph as a file entity, the highlighting might appear in the wrong place.
Processing Instructions Interfere With Acrolinx Highlights and Replacements
Acrolinx has trouble with highlighting and replacement in paragraphs with processing
instruction tags (for example,
Index Terms Interfere With Long Paragraph and Sentence Highlighting
Acrolinx can let you know if a paragraph or sentence seems too long. But if that long text contains an index term, Acrolinx might highlight more than it should.
Acrolinx for Arbortext requires the following:
- Acrolinx version 5.3.1 or later
- Acrolinx guidance package version 5.3.1 or later
- Arbortext 7.0 M030 and later (64-bit), and Arbortext 7.1 (64-bit)