| <?xml version='1.0' encoding='UTF-8'?> |
| <!-- Schema file written by PDE --> |
| <schema targetNamespace="org.eclipse.help" xmlns="http://www.w3.org/2001/XMLSchema"> |
| <annotation> |
| <appInfo> |
| <meta.schema plugin="org.eclipse.help" id="index" name="Keyword Index"/> |
| </appInfo> |
| <documentation> |
| For registering a keyword index for contributed help content. |
| </documentation> |
| </annotation> |
| |
| <element name="extension"> |
| <annotation> |
| <appInfo> |
| <meta.element /> |
| </appInfo> |
| </annotation> |
| <complexType> |
| <choice minOccurs="1" maxOccurs="unbounded"> |
| <element ref="index"/> |
| <element ref="indexProvider"/> |
| </choice> |
| <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="index"> |
| <annotation> |
| <documentation> |
| an index contribution made by supplying an XML file |
| </documentation> |
| </annotation> |
| <complexType> |
| <attribute name="file" type="string" use="required"> |
| <annotation> |
| <documentation> |
| the name of the index file which contains the list of keywords and related topics of the help content. |
| <p> |
| <i><b>Configuration Markup for index file:</b></i> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT index (entry)* ></tt><br> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT entry (entry | topic |see)* ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST entry keyword CDATA #REQUIRED ></tt><br> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT topic EMPTY ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST topic href CDATA #REQUIRED ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST topic title CDATA #IMPLIED ></tt><br> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT see (subpath)* ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST see keyword CDATA #REQUIRED ></tt><br> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT subpath EMPTY ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST subpath keyword CDATA #IMPLIED ></tt><br> |
| </p> |
| <p><b>The index element</b> |
| <p>The index element represents an instance of index. Index consists of entries, each of them corresponds to a particular keyword. All contributed indexes are merged to one master index which the Help System provides to the user. When index is built, entries are appended in alphabetical order. |
| <p><b>The entry element</b> |
| <p>The entry element represents a keyword of the index. Each entry may contain several links to help topics which associated with the keyword. Entry can also be a container for other entries (subentries) to form hierarchy of keywords. It is allowed to entry to be a container for subentries and to have topics simultaneously. |
| <p><b>The topic element</b> |
| <p>The topic element provides reference to help content related to the keyword. The href attribute is relative to the plug-in that manifest file belongs to. If you need to access a file in another plug-in, you can use the syntax |
| <p><tt>&lt;topic label="topic in another plug-in" href="../other.plugin.id/concepts/some_other_file.html"/></tt> |
| <p>The title attribute is used to name the link to help content when multiple |
| topics are associated with the single keyword. If the attribute is not |
| specified, the title comes from the label attribute if present otherwise from a TOC which owns the link. If the link does not |
| belong to any TOC, the title or label attribute must be specified, or else the title |
| becomes undefined. |
| <p><b>The see element</b> |
| The see element represents a synonym to an entry in the index. Clicking on a see link will cause the index to navigate to the index entry for which this is a synonym. The keyword attribute represents the top level element for the synonym. The <b>subpath</b> elements are used only if the synonym is not at the top level of the index and represent additional components of the synonym path. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="resource"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="indexProvider"> |
| <annotation> |
| <documentation> |
| (<b>since 3.3</b>) an index contribution made by plugging in code |
| </documentation> |
| </annotation> |
| <complexType> |
| <attribute name="class" type="string" use="required"> |
| <annotation> |
| <documentation> |
| the implementation class for the index provider. This class must implement the <samp>org.eclipse.help.AbstractIndexProvider</samp> interface. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="java" basedOn="org.eclipse.help.AbstractIndexProvider"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="since"/> |
| </appInfo> |
| <documentation> |
| 3.2 |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="examples"/> |
| </appInfo> |
| <documentation> |
| The following is an example of using the index extension point. |
| |
| <p>(in file <tt>plugin.xml</tt>) |
| <pre> |
| <extension point="org.eclipse.help.index"> |
| <indexProvider class="com.myplugin.MyIndexProvider"/> |
| </extension> |
| |
| <extension point="org.eclipse.help.index"> |
| <index file="index.xml"/> |
| </extension> |
| </pre> |
| |
| <p>(in file <tt>index.xml</tt>) |
| <blockquote><tt>&lt;index></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Vehicle"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="inventory_of_wheel.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Car"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="car.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Ship"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="ship.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Airplane"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="airplane.html" title="History of aviation"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="jet.html" title="Jet engine"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Engine"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Horse"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="horse.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Steamer"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="steamer.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Wankel engine"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="wankel.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Jet engine"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="jet.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;entry keyword="Electricity"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;topic href="electricity.html"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;/entry></tt><br> |
| <tt>&lt;/index></tt><br></blockquote> |
| |
| <p><b><em>Internationalization</em></b> The index XML files can be translated and the resulting copy (with translated keywords) should be placed in nl/&lt;language>/&lt;country> or nl/&lt;language> directory. The &lt;language> and &lt;country> stand for two letter language and country codes as used in locale codes. For example, Traditional Chinese translations should be placed in the nl/zh/TW directory. The nl/&lt;language>/&lt;country> directory has a higher priority than nl/&lt;language>. Only if no file is found in the nl/&lt;language>/&lt;country>, the file residing in nl/&lt;language> will be used. The the root directory of a plugin will be searched last. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="apiInfo"/> |
| </appInfo> |
| <documentation> |
| An implementation of <samp>org.eclipse.help.AbstractIndexProvider</samp> must be supplied if a <samp>indexProvider</samp> is used. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="implementation"/> |
| </appInfo> |
| <documentation> |
| The default implementation of the help system UI supplied with the Eclipse platform fully supports the <samp>index</samp> extension point. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="copyright"/> |
| </appInfo> |
| <documentation> |
| Copyright (c) 2006 Intel Corporation and others.<br> |
| 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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> |
| </documentation> |
| </annotation> |
| |
| </schema> |