Difference: DpHipePluginsDeveloperManual (31 vs. 32)

Revision 322013-10-18 - JavierDiaz

Line: 1 to 1
 
META TOPICPARENT name="DpHipePlugins"
<-- ANALYTICS CODE - DO NOT EDIT -->
<-- Google Analytics script BEGIN -->
<-- Google Analytics script END -->
Line: 123 to 123
 

How to create a plug-in with a Task

Changed:
<
<
To easiest way to avoid the hassle that is involved in "making a new task work in HIPE", is to create a plug-in with the task inside. If your Task is in Java, please refer to MyFirstJavaTask and if it's in Jython, see MyFirstJythonTask no the HIPE Community Wiki. Both these pages start by explaining how to write a task in their respective language, and both pages contain a section "Turning the task into a HIPE plug-in".
>
>
To easiest way to avoid the hassle that is involved in "making a new task work in HIPE", is to create a plug-in with the task inside. If your Task is in Java, please refer to MyFirstJavaTask and if it's in Jython, see MyFirstJythonTask on the HIPE Community Wiki. Both these pages start by explaining how to write a task in their respective language, and both pages contain a section "Turning the task into a HIPE plug-in".
 

Combinations of the above

Line: 228 to 228
  You may want to add an entry in HIPE's Help menu, that the user can use to get help about your plug-in specifically. One way to do this is to add a menu item that opens the web-browser on the user's system and directs it to an on-line resource (the Help section of your plug-in's homepage for instance). An example plug-in is attached. See the plugin.py and the helpMenu.src.jar in this plug-in for the source code of this example.
Added:
>
>

Linking to external help pages

To provide more integrated help, you can link an external web page to your tasks (for example) by implementing herschel.ia.gui.kernel.parts.ExternalHelp.

class ImportScanAmorphosTask(Task,ExternalHelp):
# ...
  def getHelpURL(self):
        return String("http://herschel.esac.esa.int/twiki/bin/view/Public/ScanAmorphosPlugin")
Thus, by typing in console
help(importScanAmorphos)
pressing the task's GUI help button, or selecting the task in the Tasks view and selecting the Help -> Help (External) menu option, your browser will open the web page you have provided.
 

Using your plug-in in HIPE batch mode (was: jylaunch)

The jylaunch command was replaced in HIPE 11 by "HIPE batch mode", which is invoked simply by calling the hipe command, followed by the filename of the script to execute.

 
This site is powered by the TWiki collaboration platform Powered by Perl