Acrolinx for MadCap Sidebar Edition - Version 1.2 (17 August 2018)
This is an update to add support for MadCap Flare version 2018. We’ve also improved the Sidebar and added the Embed Check Data feature.
The Sidebar is now your one-stop shop! We’ve improved the Sidebar, so that you don’t have to go anywhere else to enter your options or find more information. The Acrolinx menu now has the only option you’ll need, ‘Show Sidebar’. All the rest, like options, help, and log file access, are now available from the Sidebar.
Embed Check Data
If your Acrolinx administrator enables the Embed Check Data feature, Acrolinx saves check data as a meta tag within the head element of your XML document. If your document doesn't already have a head element, Acrolinx creates one while embedding check data.
Here’s an example of how embedded check data looks for XML documents:
<meta name="acrolinxCheckData" timeStarted="2018-06-05T12:26:31Z" score="83"
To learn more about activating and using the Embed Check Data feature, see our article on Embed Check Data for Sidebar Edition Integrations .
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. Note that due to a limitation with the MadCap API, you can't check a selection of your content in a table.
Log File is Now in a Better Place
We moved the log file to a better place so it's easier to find.
In version 1.1, the log file was here:
For consistency across other Acrolinx integrations, it's now here:
Acrolinx Settings Saved to Acrolinx Local Storage
Acrolinx for Flare and Contributor now saves your settings under the following registry path:
Acrolinx Couldn’t Find a Supported Installation of MadCap Flare
If you install MadCap Flare without activating it via their activation wizard, then you can't install Acrolinx for MadCap. Acrolinx now shows you a reminder message during installation if you haven't activated MadCap Flare.
We added support for MadCap Flare 2018, and removed support for MadCap Flare 2016.
Acrolinx for MadCap requires the following:
- Acrolinx Server version 5.3.1 and later
- Guidance Package 5.3 and later
Acrolinx for MadCap Sidebar Edition - Version 1.1 SR1 (18 September 2017)
This is a minor release but includes an important fix for MadCap Flare.
Acrolinx Now Correctly Highlights and Replaces Text
You might have seen Acrolinx highlight and replace issues incorrectly if you use one of the following features in your content:
- track changes
- comment tags
- multiple-line comments
- whitespace inside node elements
We’ve now fixed highlighting and replacing so that it works with all these features in your content. And even when you edit your content in the text editor view.
Acrolinx works with the following versions of MadCap Flare:
- 2016 r2
- 2017 r2
- 2017 r3
Acrolinx for MadCap Sidebar Edition - Version 1.1 (03 July 2017)
This is a minor release, but we're excited to offer support for MadCap Contributor and version support for 2017.
Acrolinx Now Available for MadCap Contributor
You can now use Acrolinx for MadCap with Contributor as well as Flare. You can install them both at the same time with one installer. We support MadCap Contributor version 8.
Dropped support for Version 12
We've dropped official support for Flare 12 to focus on newer versions.
Added support for 2017 and 2017 r2
We've added support for MadCap Flare versions 2017 and 2017 r2. So, we now support all of the following versions:
- 2016 r2
- 2017 r2
Acrolinx for MadCap Flare Sidebar Edition - Version 1.0 (25 November 2016)
The new sidebar edition of Acrolinx for MadCap Flare gives you a new way of checking and correcting your content. If you've been using the classic edition and you'd like to learn about the differences between the two editions, see the article in this help center.
Major New Features
Brand New Sidebar Edition
We've created a whole new experience for how you can review and edit your content with Acrolinx.
We show you the issues in a sidebar instead of highlighting the issues directly in the text. This means that Acrolinx doesn't interfere with your text and you can review the issues side by side with your content. You'll have quicker access to all the Acrolinx features that you're used to, because our sidebar is always by your side in a very unobtrusive way.
Check out the sidebar release notes to see all the new stuff. Remember that you have to update to the 5.1 server to get the 14.2 sidebar.
Use Enterprise Federated Authentication to Authenticate Acrolinx Users with Your Identity Management Service
Update from Classic to Sidebar Edition
You can install both the classic and the sidebar editions at the same time, but we recommend running one at a time.
Check with Acrolinx in XML Editor Mode
You can only check with Acrolinx in the XML Editor mode. However, you can use either the XML Editor or Text Editor modes to edit your content. Just switch to XML Editor view to run a check.
Manage Extraction Settings on the Server
If you're used to the Acrolinx classic edition, you'll have configured your extraction settings directly in the plug-in. For all sidebar edition plug-ins, you configure the extraction settings in the Acrolinx Server . Your guidance package includes default Context Segmentation Definition (CSD) and context definition files specific to Acrolinx for MadCap Flare. You'll need to update to a new guidance package or get these files from Acrolinx and install them separately.
You'll need to request a new license to get the sidebar edition activated for your server.
We've tested this version of the Acrolinx plug-in with MadCap Flare 12.0.5939 and 2016 r2 on Windows 8.1 and Windows 10 . Other versions might work but haven't been tested.
The plug-in requires Internet Explorer browser version 11.
The plug-in requires the following Acrolinx products:
- Acrolinx server version 5.0 or later
- Acrolinx guidance package version 5.0 or later
- Acrolinx Sidebar version 14.1 or later.