blob: 0c67e2de0b022a83290ccdb6c719c4049d9fa1af [file] [log] [blame]
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.ui.browser" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
<appinfo>
<meta.schema plugin="org.eclipse.ui.browser" id="browsers" name="Browsers"/>
</appinfo>
<documentation>
For providing web browsers capable of displaying html documents at a given URL.
</documentation>
</annotation>
<element name="extension">
<annotation>
<appinfo>
<meta.element />
</appinfo>
</annotation>
<complexType>
<sequence minOccurs="0" maxOccurs="unbounded">
<element ref="browser"/>
</sequence>
<attribute name="point" type="string" use="required">
<annotation>
<documentation>
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string">
<annotation>
<documentation>
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string">
<annotation>
<documentation>
</documentation>
<appinfo>
<meta.attribute translatable="true"/>
</appinfo>
</annotation>
</attribute>
</complexType>
</element>
<element name="browser">
<annotation>
<documentation>
An external web browser which will be displayed on the preference page General/Web Browsers providing the os attribute matches and a file is found in at least one of the specified locations.
</documentation>
</annotation>
<complexType>
<sequence minOccurs="0" maxOccurs="unbounded">
<element ref="location"/>
</sequence>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
the unique ID of the browser.
</documentation>
</annotation>
</attribute>
<attribute name="factoryclass" type="string">
<annotation>
<documentation>
the implementation class for the browser factory. This class must implement the &lt;samp&gt;org.eclipse.ui.browser.BrowserFactory&lt;/samp&gt; interface.
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn="org.eclipse.help.browser.IBrowserFactory"/>
</appinfo>
</annotation>
</attribute>
<attribute name="name" type="string" use="required">
<annotation>
<documentation>
the name of the browser (translatable).
</documentation>
<appinfo>
<meta.attribute translatable="true"/>
</appinfo>
</annotation>
</attribute>
<attribute name="os" type="string">
<annotation>
<documentation>
comma separated list of operating systems on which to search for this browser at the specified locations. Only browsers with matching OS will be used.
</documentation>
</annotation>
</attribute>
<attribute name="executable" type="string">
<annotation>
<documentation>
the executable filename
</documentation>
</annotation>
</attribute>
</complexType>
</element>
<element name="location" type="string">
<annotation>
<documentation>
Default install locations. these locations should not contain the initial path, as it will be substituted with all known drives. (e.g. on Windows, a location of &quot;test.exe&quot; would look for &quot;c:\test.exe&quot;, &quot;d:\test.exe&quot;, etc. for all known drives.
</documentation>
</annotation>
</element>
<annotation>
<appinfo>
<meta.section type="since"/>
</appinfo>
<documentation>
3.0 (originally added in release 2.0 as org.eclipse.help.ui.browser)
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="examples"/>
</appinfo>
<documentation>
The following is a sample usage of the browsers extension point:
&lt;p&gt;
&lt;pre&gt;
&lt;extension point=&quot;org.eclipse.ui.browser.browsers&quot;&gt;
&lt;browser
id=&quot;org.eclipse.ui.browser.firefox&quot;
name=Firefox
os=&quot;Win32&quot;
executable=&quot;firefox.exe&quot;
factoryclass=&quot;org.eclipse.ui.internal.browser.browsers.MozillaFactory&quot;&gt;
&lt;location&gt;Program Files\mozilla.org\Firefox\firefox.exe&lt;/location&gt;
&lt;location&gt;Program Files\Mozilla Firefox\firefox.exe&lt;/location&gt;
&lt;/browser&gt;
&lt;/extension&gt;
&lt;/pre&gt;
&lt;/p&gt;
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="apiInfo"/>
</appinfo>
<documentation>
The supplied factory class must implement the &lt;samp&gt;org.eclipse.help.browser.IBrowserFactory&lt;/samp&gt; 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.
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="implementation"/>
</appinfo>
<documentation>
The &lt;samp&gt;org.eclipse.help.base&lt;/samp&gt; and &lt;samp&gt;org.eclipse.help.ui&lt;/samp&gt; 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.
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="copyright"/>
</appinfo>
<documentation>
Copyright (c) 2000, 2005 IBM Corporation and others.&lt;br&gt;
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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
</documentation>
</annotation>
</schema>