Edit online

Uploading and Configuring Plugins

Oxygen XML Web Author includes a user-friendly Administration Page that helps you to manage plugins for the Oxygen XML Web Author.

Uploading a New Plugin

To upload a new plugin to the Oxygen XML Web Author, follow these steps:
  1. Go to your Administration Page.
  2. Select Plugins.
  3. Click Upload Plugin and choose a plugin archive to upload.
    Important: Oxygen XML Web Author does a validation check to make sure the uploaded plugin archive contains the proper extension descriptor file (plugin.xml). The archive should contain exactly one folder. Otherwise you will receive an error that the upload was denied.
    Note: If the upload would result in a duplicate plugin, Oxygen XML Web Author will load the latest version and report the older versions that were not loaded. You will also have the option to delete the older versions or you can ignore this and then delete the newly uploaded version to revert to an older version.

  4. Click OK to upload the file.

    Step Result: The plugin should appear in the list on this Plugins page. Uploaded plugins appear with a light green highlight so that you can identify them easily.

  5. Once you are finished with all of your changes, restart Oxygen XML Web Author.

Enabling or Disabling a Plugin

To enable or disable a plugin, follow these steps:
  1. Go to your Administration Page.
  2. Select Plugins.
  3. Click the Enable/Enabled checkbox on the right side of the particular plugin to toggle it to the desired state.
  4. Once you are finished with all of your changes, restart Oxygen XML Web Author.

Configuring a Plugin

If the plugin can be configured, a Configure button is displayed under its name in the Administration Page. To configure the plugin, click the button and follow the instructions in the subsequent dialog box.

Deleting a Plugin

To delete a plugin from your Oxygen XML Web Author, follow these steps:
  1. Go to your Administration Page.
  2. Select Plugins.
  3. Find the plugin you want to delete and click the Delete the plugin button on the right side of its name.
  4. Restart Oxygen XML Web Author to apply the changes.

Restoring an Original Built-in Plugin

If you have deleted or replaced one of the built-in plugins and you want to restore it to its original state, follow this procedure:
  1. Download the All Platforms distribution.
  2. Unzip the downloaded archive.
  3. Go to [OXYGEN_WEBAUTHOR_INSTALL_DIR]/tomcat/work/Catalina/localhost/oxygen-xml-web-author/plugins.
  4. Create a zip archive that contains the folder for the desired plugin (only one).
  5. Upload it using the Uploading a New Plugin procedure above.

Configuring a License for a Plugin

A developer can specify a license for a plugin that the user will need to agree with when installing the plugin. The license is either specified in the plugin.xml file using the <license> element that contains the path to the license file relative to the plugin's root folder, or if the license entry is not specified in the plugin.xml descriptor, the application then looks for a LICENSE.txt or LICENSE file in the plugin's root folder.

If a license is detected, a View License button will be displayed in the bottom-right corner of the plugin's tile in the Administration Page.