Edit online

Debugging a Plugin Using IntelliJ IDEA

To use IntelliJ IDEA to debug problems in the code of a plugin without having to re-bundle the plugin's Java classes in a JAR library, follow these steps:
  1. Download and install Oxygen XML Developer.
  2. Set up the Oxygen SDK following this set of instructions.
  3. Create a Java Project (for example, MyPluginProject) from one of the sample plugins (for example, the Workspace Access plugin).

  4. In the MyPluginProject folder, create a folder called myPlugin. In this new folder, copy the plugin.xml file from the sample plugin. Modify the added plugin.xml to add a library reference to the directory where IntelliJ IDEA copies the compiled output. To find out where this directory is located, go to File > Project Structure. Then select the Modules category and inspect the value of the Output path text box from the Path tab.

    Example: If the output path is C:/Users/myUser/Documents/MyPluginProject/target/classes, then in the plugin.xml, you need to add the following library reference in the runtime element: 
    <library name="../target/classes"/>
  5. Copy the plugin.dtd from the [OXYGEN_INSTALL_DIR]/plugins folder in the root MyPluginProject folder.
  6. In the MyPluginProject dependences (File > Project Structure > Modules > Dependences), add external JAR references to all the JAR libraries in the [OXYGEN_INSTALL_DIR]/lib folder. Now your MyPluginProject should compile successfully.
  7. In IntelliJ IDEA, create a new Java Application configuration for debugging (Run > Edit Configurations... > + > Application). Set the Main class box to ro.sync.exml.Oxygen and add the following code snippet in the VM options input box, making sure that the path to the plugins directory is the correct one:
    -Dcom.oxygenxml.app.descriptor=ro.sync.exml.EditorFrameDescriptor 
-Dcom.oxygenxml.editor.plugins.dir=D:\projects\MyPluginProject
    Note: If you need to configure the plugin for Oxygen XML Developer, set the com.oxygenxml.app.descriptor to ro.sync.exml.DeveloperFrameDescriptor.
  8. Add a breakpoint in the source of one of your Java classes.
  9. Debug the created configuration. When the code reaches your breakpoint, the IntelliJ IDEA debugging view should take over.