You will need a recent Eclipse EE.
This procedure describes a development environment that can be used to increase your
productivity in writing plugins for Oxygen XML Web Author Component.
Developing a plugin for Oxygen XML Web Author Component might require repetitive
coding-testing cycles. Since the process of building a whole SDK project requires a full Maven
build, the whole process might prove to be time consuming. The following procedure provide a
faster alternate way of testing the plugin:
-
Go to the following repository and follow the instructions: https://github.com/oxygenxml/web-author-plugin-archetype.
-
Run Oxygen XML Web Author Component in a Tomcat server. You can either use one of the
installation kits, or build it using the Oxygen XML SDK.
-
Look in the Tomcat logs (or in the console) for a line like "
Loading plugins
from: ${path}" and note the path of the plugins
folder.
-
In the plugins folder, create a sub-folder with a name of your
choice (for example, myplugin).
-
In that folder (myplugin), create a
plugin.redirect file that contains the path to your
plugin project (created in step 2) on a single line.
-
Import your plugin project in Eclipse.
-
Click .
-
Choose Existing Maven Project.
-
Browse for the location of your plugin.
-
Modify the plugin.xml file to add a library reference to the
directory where Eclipse places the compiled output.
With the default setup of a Maven project, this step requires that you add the
following
element:
<library name="target/classes/"/>
-
You can now open a document in the Oxygen XML Web Author Component and it will
automatically load your plugin.
Every time you make changes to the plugin sources, you will need to
restart Oxygen XML Web Author Component.
Once you are happy with the result, you need to add the plugin back in your
SDK project and follow these instructions to perform a final testing of the project.