History | Edit

Packing a Plugin or Framework as an Add-on

This procedure is suitable for developers who want a better control over the add-on package or those who want to automate some of the steps:
  1. Pack the plugin or framework as a ZIP file or a Java Archive. Note that you should pack the entire root directory not just its contents.
  2. Digitally sign the package. Note that you can perform this step only if you have created a Java Archive at the previous step. You will need a certificate signed by a trusted authority. To sign the JAR you can either use the jarsigner command line tool inside Oracle's Java Development Kit. ([JDK_DIR]/bin/jarsigner.exe) or, if you are working with Apache Ant, you can use the signjar task (a front for the jarsigner command line tool).
    Note: The benefit of having a signed add-on is that you can verify the integrity of the add-on issuer. If you do not have such a certificate you can generate one yourself using the keytool command line tool. This approach is mostly recommended for tests since anyone can create a self signed certificate.
  3. Create a descriptor file. You can use a template that Oxygen XML Editor provides. To use this template, go to File > New and select the Oxygen add-ons update site template. Once deployed, this descriptor file is referenced as update site.
Alternatively, you can use the Add-ons Packager plugin by following this procedure:
  1. Install the Add-ons Packager plugin from https://www.oxygenxml.com/InstData/Addons/optional/updateSite.xml as described in the Installing Add-ons procedure.
  2. Restart Oxygen XML Editor. If the add-on is correctly installed, the Add-ons packager toolbar action is available.
  3. Invoke the Add-ons packager toolbar action and input the required information in the displayed dialog box.
  4. Press OK to complete the packaging process.

Deploying an Add-on

To deploy an add-on, copy the ZIP or Java Archive file and the descriptor file to an HTTP server. The URL to this location serves as the Update Site URL.