Help (Now Available and Testing)

From AIBenchWiki

Problem

1. Incorporate JavaHelp files in an AIBench application.
   • The user should be able to port their application's help files writen in the JavaHelp standard.
   • The user should be able to associate help topics for operations, datatype views, etc.
   • If the was added, the Workbench should also show an additional menu in the menu bar to access the help contents, say Help->Contents
2. Be also able to link URLs to operations and views as help resources instead of help topics. The URLs should be displayed in the native browser.

Solution

1. The user should place their help files in a specified folder, say "help" in the root of the AIBench project.
2. Associate JavaHelp topics or URLs to:
   1. Operations. A new attribute in the operation-description, say "help=<help_topic_or_url>". The workbench could display a help button in the input dialogs of this operations.
   2. Datatype Views. A new attribute in the view tag say, "help=<help_topic_or_url>"
   3. Others?

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>