# Browser

###### Identifier:

org.eclipse.help.base.browser

###### Since:

3.0 (originally added in release 2.0 as org.eclipse.help.ui.browser)

###### Description:

For providing web browsers capable of displaying html documents at a given URL.

Note: since 3.1, help system uses workbench browser support (see `org.eclipse.ui.browserSupport`). The extension point described in this document remains to be used for standalone help only. Any custom browser adapters that need to work in the workbench mode need to be moved to the workbench extension point.

###### Configuration Markup:

<!ELEMENT extension (browser*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED

>

<!ELEMENT browser (factoryclass?)>

<!ATTLIST browser

id CDATA #REQUIRED

factoryclass CDATA #IMPLIED

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.browser.IBrowserFactory` interface. This attribute may be omitted, and the nested `factoryclass` element may be provided instead.
- name - the name of the browser (translatable).

<!ELEMENT factoryclass (parameter*)>

<!ATTLIST factoryclass

class CDATA #REQUIRED

>

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

<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name CDATA #REQUIRED

value CDATA #REQUIRED

>

- name - name of a parameter passed to the implementation class
- value - value of a parameter passed to the implementation class

###### Examples:

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

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

###### API Information:

The supplied factory class must implement the `org.eclipse.help.browser.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.base` and `org.eclipse.help.ui` plug-ins contain implementation of browsers on common platforms. Other plug-ins can provide different implementations. In the preferences, the user can select the default browser from among available browsers.

Copyright (c) 2000, 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html