Plug-in Developer Manual

This manual describes first how to create plug-ins for HIPE. It ends with a description of the mechanism that HIPE component developers can use to become aware of plug-ins.

Quick guide: Creating Simple Plug-ins

Plug-ins can be created to do lots of fancy things, but most of the time people will want to use to share some pools, some Jython scripts, and/or possible some Java code. These standard cases are described here. One case does not exclude the other; combining the steps from the different cases described here will work.

How to create a plug-in with some pools

How to create a plug-in with some Jython code

How to create a plug-in with some Java code

What you must avoid / Invalid plug-ins

- having a file called pools - having a file or directory called work

Slightly more advanced topics

Customizing your plug-in

the plugin.xml options

Advanced: The plug-in installation process

Using a custom installer

Using a WebStart installer

Configuring the plug-in post-installation

Advanced: Using Java code from your plug-in from Jython

Remove? Works automatically?

For HIPE component developers: Reacting to plug-ins from your component

PluginRegistry

PluginProcessor

-- PaulBalm - 27 Aug 2010