Difference: DpHipePluginsDeveloperManual (8 vs. 9)

Revision 92011-01-12 - PaulBalm

Line: 1 to 1
 
META TOPICPARENT name="DpHipePlugins"

Plug-in Developer Manual

Line: 116 to 115
 When sharing things with plug-ins, you are not limited the items described in the previous section. You can add anything to a plug-in, but there are a few things that would make the plug-in invalid. An invalid plug-in would fail to install.

The following would make the plug-in invalid:

Changed:
<
<
- a file called scripts, pools or jars at the top-level of the file - a file or directory called work at the top-level of the file. HIPE uses this directory as an internal workspace.
>
>
  • a file called scripts, pools or jars at the top-level of the file
  • a file or directory called work at the top-level of the file. HIPE uses this directory as an internal workspace.
 

Slightly more advanced topics

Added:
>
>

Compatibility information

It is highly recommended to include a file called plugin.xml at the top-level (root directory) of your plug-in and use it to specify the compatible HIPE versions. You do this by specifying a minimum version which with HIPE is compatible, and a maximum version. You should always specify a maximum version, because you don't know if your plug-in will be compatible with the next version of HIPE. If you distribute a plug-in when HIPE v1.0 is current, you should specify that is compatible with versions up to 1.0.*. This means that your plug-in is compatible with all builds from the 1.0 track, which means all 1.x releases. This is correct, because if 1.1 has been released now, and your plug-in is compatible, you know that it will be compatible with release 1.2 as well. No compatible changes are allowed in existing release tracks.

Note that the version is specified using build track plus build number, not with the release number. So, for example, release 4.6 was built on the 4.0 track and it's build 1467. In the version compatibility information in plugin.xml you would specify release 4.6 as 4.0.1467.

The plugin.xml allows for much more customization. An example plugin.xml, which includes compatibility information, is given in the next section.

You can also specify (for instance) "all builds on the 5.0 track", using "5.0.*". Note, however, the asterisk is not a wildcard. It's interpreted as a very high number, so it is only intended to be used to specify the upper limit of compatible versions (maxVersion). Using it in the lower limit, minVersion, is allowed, but this is normally not what you want. See the example in the next section.

Warning, important The compatibility checking was added in HIPE v7.0. Earlier versions of HIPE ignore this information.

 

Customizing your plug-in

HIPE allows for the plug-in to specify additional information about itself using a file called plugin.xml at the root-level of the plug-in jar or zip.

Line: 130 to 141
 
<?xml version="1.0" encoding="UTF-8"?>
Changed:
<
<
>
>
  This plug-in provides tasks for analysis of data. http://www.esa.int herschel/ia/gui/apps/plugin/Extension.png custom.properties
Added:
>
>
<-- Compatible starting user release 5.0 (build 1760), not with earlier builds -->
5.0.1760
<-- Compatible with all 6.x releases (all builds from the 6.0 track) -->
6.0.*
 
 
This site is powered by the TWiki collaboration platform Powered by Perl