Note: The help system is still under development and can be expected to change somewhat before reaching stability. It is being made available at this stage to solicit feedback from early adopters, on the understanding that the details of the contribution mechanisms might change in breaking ways.

Browser

Identifier: org.eclipse.help.ui.browser

Description: For providing web browsers capable of displaying html documents at given URL
This extension point was added in 2.0.

Configuration Markup:

   <!ELEMENT browser EMPTY>
   <!ATTLIST browser id CDATA #REQUIRED >
   <!ATTLIST browser factoryclass CDATA #REQUIRED>
   <!ATTLIST browser name CDATA #REQUIRED >

id - the unique ID of the browser.

factoryclass - the implementation class for the browser factory. This class must implement the org.eclipse.help.ui.IBrowserFactory interface.

name - the name of the browser (translatable).

Examples:

The following is a sample usage of the browser extension point:

(in file plugin.xml)

<extension point="org.eclipse.help.ui.browser">
   <browser id="org.eclipse.myPlugin.myBrowserID"
     factoryclass="org.eclipse.myPlugin.myPackage.MyFactoryClass"
     name="My Browser" />
</extension>

API Information: The supplied factory class must implement the org.eclipse.help.ui.IBrowserFactory interface. Methods in that interface determine whether the factory is available on the given system, i.e. is capable of supplying browser instances, and create browser instances that implement IBrowser interface.

Supplied Implementation: The org.eclipse.help.ui plug-in contains implementation of a browsers on common platforms. Other plugins can provide different implementation. In the preferences, user can select the default browser from among available browsers.