Difference: DpHipePluginsUserManual (4 vs. 5)

Revision 52011-06-09 - PaulBalm

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

HIPE Plug-in User Manual

Line: 14 to 14
  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.
Added:
>
>
Below is a quick introduction on how to create a simple plug-in with some scripts. It's easier than you think!

 

How to get plug-ins

Anyone can 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 plug-ins. 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.

Line: 26 to 30
  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.
Changed:
<
<
A side-effect of this is that your plug-ins are shared between your HIPE versions if you have multiple version of HIPE installed.
>
>
This means that your plug-ins are shared between your HIPE versions if you have multiple version of HIPE installed. Each plug-in should indicate the versions of HIPE it is compatible with. If a plug-in does this, HIPE will automatically enable/disable the plug-in depending on the compatibility of the HIPE version running at that moment. This also works as expected if you run two different HIPE versions at the same time (a plug-in could be enabled in one version and disabled in the other).

Disabling plug-ins from the command line

It is theoretically possible that a plug-in causes a major problem during HIPE start-up, causing HIPE to fail before you get the chance to access the Plug-ins panel (under the Tools menu). Or it might be that you see HIPE failing at start-up and you want to disable the plug-ins, just to be sure that the problem lies elsewhere. For these cases we provide a script to disable plug-ins, that can be run from the command line, without starting HIPE. The script is called disable_plugins (disable_plugins.bat on Windows) and lives in the bin directory of the build (same directory as hipe). Running it with no arguments will disable all plug-ins. Running it with one or more arguments will disable those plugins whose name matches one of the arguments:

  • To disable all plug-ins: disable_plugins
  • To disable selected plug-ins: disable_plugins myplugin yourplugin ourplugin

After disabling the plug-ins, you can use the Plug-ins panel to enable them again.

Warning, important disable_plugins is available starting HIPE v8.0.

 
Changed:
<
<
-- PaulBalm - 17 Aug 2010
>
>
-- PaulBalm - 09 Jun 2011
 
This site is powered by the TWiki collaboration platform Powered by Perl