HIPE Plug-in User Manual

This is the user manual for HIPE Plug-ins. It describes what plug-ins are, where to get them, how to install them, and how to get rid of them.

If you are interested in creating plug-ins yourself, please refer to the Plug-in Developer's Manual [TBD]. For the motivation behind design choices made when building the Plug-in Framework for HIPE, see the Design Document.

Introduction: What's a plug-in and what's it for

Plug-ins are intended to make it easy to share software (written in Java and/or Jython) and to share data in the form of LocalStores. A secondary purpose is to allow existing applications to be "plugged into HIPE": A plug-in for an existing application can add menus and menu items to HIPE. The user can then use those menus to use the application, within HIPE.

The plug-in framework was designed to make it very easy for users to install and use plug-ins, while at the same time making it simple for creators of plug-ins to produce the plug-ins. In most cases, creating a plug-in is a matter of zipping or jarring whatever it is you want to share, and putting it on-line. The user gets the URL of the plug-in, puts it into HIPE and hits install. In many case (nearly all, I hope), this will be enough. Clearly, it will require more work to create a plug-in that adds menus, Views, Perspectives, and so on, but for the user this doesn't make a difference. Installation is one-click in principle. A plug-in developer may construct a custom installer for a plug-in allowing more configuration, but requiring more clicks from the user.

How to get plug-ins

Anyone can be put a plug-in on-line anywhere, but we have created a Wiki page that is intended as a repository, or at least a starting point for finding the plugins. The Wiki is DpHipePlugins. It is not necessary to bookmark or remember the address of this page. If you select Plug-ins from the Tools menu in HIPE, the Plug-ins panel opens. This panel shows the currently installed plug-ins and has two links at the top: One for finding new plug-ins and one for installing new plug-ins. Clicking the "find new plug-ins" link opens a web-browser and navigates to the DpHipePlugins Wiki.

Using the URL where a plug-in is offered (the plug-in download URL, so to speak), you can install the plug-in. In the Plug-ins panel click the link to Install a new plug-in. Enter the URL in the URL field and click Install. That's all!

The "download URL" for a plug-in may be HTTP, HTTPS, FTP or even a file: URL pointing at a regular file. If you have a plug-in downloaded onto your disk though, you will probably find it easier to browse to point it out. For this, click the Browse button next to the URL field.

Plug-ins on your system

After installing a plug-in, you can see the file as they are installed by selecting the plug-in in the Plug-ins panel and clicking Browse. As you will see, by default the plug-ins are installed in $HOME/.hcss/apps/hipe/plugins. This directory is independent of the HIPE version. This means that if you upgrade to a new version of HIPE, it won't be necessary to reinstall your plug-ins. They will be kept and show up in the next version of HIPE automatically.

A side-effect of this is that your plug-ins are shared between your HIPE versions if you have multiple version of HIPE installed.

-- PaulBalm - 17 Aug 2010

Edit | Attach | Watch | Print version | History: r9 | r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r2 - 2010-08-17 - PaulBalm
This site is powered by the TWiki collaboration platform Powered by Perl