Install, Uninstall, or Update Acrolinx for Oxygen

Acrolinx is available for the many different flavors of Oxygen. You can choose between installing Acrolinx for Oxygen manually or as an add-on.

If you use Oxygen XML Author Component, you can get the Acrolinx for Oxygen dropin from your company download area and follow the instructions on Using Plugins with the Oxygen XML Author Component.

What You Should Know Before Installing

Check our Compatibility Guide if you want to know whether Acrolinx for Oxygen works with your local platforms.

Before you install Acrolinx for Oxygen, make sure that you've installed the following:

Product

Version

Acrolinx5.3.1 or later
Oxygen XML Editor18.1, 19.0, 19.1, 20.0 (Build ID: 2018042410), 20.1, 21.0
Oxygen XML Author18.1, 19.0, 19.1, 20.0 (Build ID: 2018042410), 20.1, 21.0
Java Runtime Environment (JRE)1.8

Install, Uninstall, or Update Acrolinx Manually

Install

Here's how to install Acrolinx for Oxygen:

  1. Download the latest version of Acrolinx from your company download area.
  2. Close Oxygen and unzip the installation package.
  3. Open the contents of the installation package so that you see the file 'plugin.xml' and the directory 'lib'. Copy them to the following location:

    <OXYGEN_INSTALL_DIR>\plugins\acrolinx (If the subdirectory \acrolinx doesn’t yet exist inside <OXYGEN_INSTALL_DIR>\plugins, then create it.)

    The file plugin.xml and the directory lib should be located at the top level of the acrolinx directory.

  4. The next time you start Oxygen, Acrolinx is available.

Update

The update procedure is almost identical to the installation procedure.

  1. Download the latest version of Acrolinx from your company download area.
  2. Close Oxygen and remove the contents of the Acrolinx plug-in folder:

    <OXYGEN_INSTALL_DIR>\plugins\acrolinx\

  3. Follow the standard installation procedure.

Uninstall

To uninstall Acrolinx, follow these steps:

  1. Close Oxygen.
  2. Remove the contents of the Acrolinx plug-in folder:

    <OXYGEN_INSTALL_DIR>\plugins\acrolinx\

Install, Uninstall, or Update Acrolinx as an Add-On

Install Acrolinx

Here's how to install Acrolinx:

  1. Select Help Install new add-ons... from the menu.
  2. In the Show add-ons from: field, enter the following URL and press Enter:
  3. Select Acrolinx for Oxygen.
  4. Click Next and follow the on-screen instructions.

Update Acrolinx

Here's how to update Acrolinx:

  1. Select Help Manage add-ons... from the menu.
  2. Select Acrolinx for Oxygen and click Update.
  3. Follow the on-screen instructions.

Uninstall Acrolinx

To uninstall Acrolinx, follow these steps:

  1. Select Help Manage add-ons... from the menu.
  2. Select Acrolinx for Oxygen and click Uninstall.
  3. Follow the on-screen instructions.