Acrolinx for Oxygen - Version 1.0 (30 November 2017)
We're really excited to introduce Acrolinx for Oxygen - Sidebar Edition. Take a look at all that it has to offer.
Installing Acrolinx for Oxygen
If you want to install Acrolinx for Oxygen manually, then you can get a .zip or a dropin package depending on whether you’re installing for Oxygen Author or Oxygen Eclipse. Otherwise, you can install Acrolinx for Oxygen automatically from the update sites. Here are the update site URLs:
- Standalone: https://updates.acrolinx.com/sidebar/oxygen/standalone/updateSite.xml
- Eclipse: https://updates.acrolinx.com/sidebar/oxygen/eclipse/site.xml
Open Acrolinx Sidebar from Menu or Ribbon
The Acrolinx Classic edition came with menu items and buttons. Now, there's only one button to access the Sidebar and you’ll find everything you need in the Sidebar itself.
Sidebar Start Page
When you make the transition to using the Sidebar in Oxygen, you’ll probably wonder where you can find all the things that you’re used to. 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, then you can take a look at this troubleshooting article , which you can also open from the start page.
Use Checking Profiles in Oxygen with the Sidebar
Now, with the Sidebar edition, you can select Checking Profiles in the Options section in the Sidebar. You couldn’t do this in the Classic edition even if Checking Profiles were enabled. That’s a win for the Sidebar!
Specify the Address of an Acrolinx Server
If your administrator wants to automate the installation of Acrolinx, they can also now specify the address of an Acrolinx Server. So, writers don't have to enter this information themselves. To set that Acrolinx server address, use the property ACROLINX_SERVER_ADDRESS. For more information see the section 'What does my Acrolinx Administrator need to do?' in Acrolinx for Oxygen.
Add Custom Information in Sidebar
In the Sidebar, you can update your user profile with your custom information or your document information anytime. You couldn’t do this with the Oxygen Classic edition. That’s another win for the Sidebar!
So, if your Acrolinx administrator configured custom fields on the Acrolinx Server, and they’re required fields, you’ll see them pop up in the Sidebar for you to fill out before you check.
Sidebar Works Best in Author Mode
We support text mode but we recommend that you use Author mode for the best experience. In Oxygen Author or Editor, you’ll see one Sidebar but if you’re using Oxygen Eclipse then you can open one Sidebar per application window.
Embed Check Data
Embed check data to see the Acrolinx Score for each piece of content in your CMS. When you embed the checking data into an XML document, and run a check on the whole document, Acrolinx inserts a processing instruction containing the checking data. A typical processing instruction might look like the following example:
acrolinxCheckData score="82" scorecardUrl= "<SERVER_ADDRESS>/output/en/gear_pump_xhtml_admin_38616c5a5ff3e6fe_1_report.html" timeStarted="2017-10-10T06:24:03Z" status="green"
Acrolinx Interface in Your Preferred Language
You can use Acrolinx in any one of our supported languages, which are: German, English, French, and Japanese. If you’re using Oxygen standalone, then Acrolinx uses the application language. For Eclipse, Acrolinx uses the system language.
Acrolinx Reads Multiple File Types
Acrolinx supports: .html = HTML, .xhtml = HTML, .txt = text, .xml = XML, .dita = XML, MARKDOWN = .md.
Update your license to activate Acrolinx for Oxygen Eclipse and Standalone Sidebar edition.
Manage Extraction Settings on the Server
If you're used to the Acrolinx Classic edition, you'll have configured your extraction settings directly in Acrolinx for Oxygen. For all Sidebar editions, you now configure Content Profiles in the Acrolinx Server. 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. 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.
We've developed and tested Acrolinx for Oxygen - Version 1.0 with Oxygen standalone versions 18.1, 19.0, and 19.1.
- Oxygen XML Author and Oxygen XML Editor
- We recommend using Eclipse version 4.6. Earlier versions may work but haven't been fully tested with Acrolinx.
- Java Runtime Environment (JRE) version 1.8
- On Windows, you'll need Internet Explorer 11.
- Support for Windows, macOS, and Linux.
Acrolinx for Oxygen - Version 1.0 requires the following Acrolinx products:
- Acrolinx server 5.3 or later.
- Acrolinx guidance package version 5.3 or later.
- Acrolinx Sidebar version 14.5 or later.