Add Help To AIBench Applications

From AIBenchWiki

Requisites

You have to use JavaHelp (a well-known standard for help) in Java.

Procedure

1. Place your JavaHelp files in a specified folder, say "help" in the root of the AIBench project.
2. Associate JavaHelp topics or URLs to:
   1. Operations. Use the help attribute in the operation-description tag in your plugin.xml. The Workbench will display a help button in the input dialogs of this operations.
   2. Datatype Views. Use the help attribute in the view tag in your plugin.xml

Example:

<extension uid="aibench.core" name="aibench.core.operation-definition" class="sampleplugin.Sum">
  <operation-description name="Sum Operation" path="10@Sample/1@SubmenuExample" uid= "sampleplugin.sumoperationid" help="mytopic.subtopic"/>
</extension>

<extension uid="aibench.workbench" name="aibench.workbench.view" >
  <view name="Sample Datatype View" datatype="sampleplugin.OneClass" class="sampleplugin.OneViewComponent" help="http://myapp.com/help/topic1.html"/>
</extension>