Edit online

Installing an Oxygen XML Author Plugin

Choose one of the following methods to install a plugin in Oxygen XML Author:

Manual Method

To manually install a plugin in Oxygen XML Author, follow these steps:

  1. Go to the Oxygen XML Author installation directory and locate the plugins directory.
    Note: The plugins directory contains all the plugins available to Oxygen XML Author.
  2. In the plugins directory, create a subfolder to store the plugin files (for example, [OXYGEN_INSTALL_DIR]/plugins/myPlugin).
  3. In the new folder, place the plugin descriptor file (plugin.xml), the Java classes of the plugin, and the other files that are referenced in the descriptor file.
  4. Restart Oxygen XML Author.

Automatic Method

To install an add-on that is hosted on a remote update site, follow these steps:
  1. Go to Help > Install new add-ons.
  2. In the displayed dialog box, enter or paste the update site that hosts the add-on in the Show add-ons from field (or select it from the drop-down menu, if applicable). The default add-ons are hosted on https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml. If you want to see a list of all the default and sample add-ons that are available on the Oxygen remote update sites, choose ALL AVAILABLE SITES from the drop-down menu. The add-ons list contains the name, status, update version, Oxygen XML Author version, and the type of the add-on (either framework, or plugin). A short description of each add-on is presented under the add-ons list.
    Note: To see all the versions of the add-ons, deselect Show only compatible add-ons and Show only the latest version of the add-ons. Incompatible add-ons are shown only to acknowledge their presence on the remote update site, but you cannot install an incompatible add-on.
  3. Choose the add-ons you want to install, click the Next button, then follow the on-screen instructions.
    Note: Accepting the license agreement of the add-on is a mandatory step in the installation process.
    Note: All add-ons are installed in the extensions directory inside the Oxygen XML Author preferences directory.
Tip: As an alternate approach, you can add an Install button to a web page that links to a URL that has the syntax https://host/path/to/updateSite.xml?oxygenAddonId=addOnIDValue and drop the button into the application's main editing area.