Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCurtis D'Entremont2006-03-02 18:57:07 -0500
committerCurtis D'Entremont2006-03-02 18:57:07 -0500
commite34e11f5aff12c119fd951cec6f48ca64c686c62 (patch)
tree65148bc0f5c18bfdb7804a5323d50454a39c163b /org.eclipse.help
parent91fc982970c4146bab5fc6de759861bf92299988 (diff)
downloadeclipse.platform.ua-e34e11f5aff12c119fd951cec6f48ca64c686c62.tar.gz
eclipse.platform.ua-e34e11f5aff12c119fd951cec6f48ca64c686c62.tar.xz
eclipse.platform.ua-e34e11f5aff12c119fd951cec6f48ca64c686c62.zip
schema file for: 10087 [Help] Missing Help Index Solution
Diffstat (limited to 'org.eclipse.help')
-rw-r--r--org.eclipse.help/plugin.xml2
-rw-r--r--org.eclipse.help/schema/index.exsd168
2 files changed, 169 insertions, 1 deletions
diff --git a/org.eclipse.help/plugin.xml b/org.eclipse.help/plugin.xml
index 1531a9e62..a34431554 100644
--- a/org.eclipse.help/plugin.xml
+++ b/org.eclipse.help/plugin.xml
@@ -5,7 +5,7 @@
<extension-point id="contexts" name="%contexts_extension_point_name" schema="schema/contexts.exsd"/>
<extension-point id="toc" name="%toc_extension_point_name" schema="schema/toc.exsd"/>
<extension-point id="contentProducer" name="%content_producer_extension_point_name" schema="schema/contentProducer.exsd"/>
- <extension-point id="index" name="%index_extension_point_name"/>
+ <extension-point id="index" name="%index_extension_point_name" schema="schema/index.exsd"/>
<extension-point id="contentExtension" name="%content_extension_point_name" schema="schema/contentExtension.exsd"/>
<extension
diff --git a/org.eclipse.help/schema/index.exsd b/org.eclipse.help/schema/index.exsd
new file mode 100644
index 000000000..dada03f33
--- /dev/null
+++ b/org.eclipse.help/schema/index.exsd
@@ -0,0 +1,168 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- Schema file written by PDE -->
+<schema targetNamespace="org.eclipse.help">
+<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">
+ <complexType>
+ <sequence>
+ <element ref="index" minOccurs="0" maxOccurs="unbounded"/>
+ </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="index">
+ <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.
+&lt;p&gt;
+&lt;i&gt;&lt;b&gt;Configuration Markup for index file:&lt;/b&gt;&lt;/i&gt;
+&lt;p&gt;
+&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ELEMENT index (entry)* &gt;&lt;/tt&gt;&lt;br&gt;
+&lt;br&gt;
+&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ELEMENT entry (entry | topic)* &gt;&lt;/tt&gt;&lt;br&gt;
+&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ATTLIST entry keyword CDATA #REQUIRED &gt;&lt;/tt&gt;&lt;br&gt;
+&lt;br&gt;
+&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ELEMENT topic EMPTY &gt;&lt;/tt&gt;&lt;br&gt;
+&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ATTLIST topic href CDATA #REQUIRED &gt;&lt;/tt&gt;&lt;br&gt;
+&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ATTLIST topic title CDATA #IMPLIED &gt;&lt;/tt&gt;&lt;br&gt;
+&lt;p&gt;&lt;b&gt;The index element&lt;/b&gt;
+&lt;p&gt;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.
+&lt;p&gt;&lt;b&gt;The entry element&lt;/b&gt;
+&lt;p&gt;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.
+&lt;p&gt;&lt;b&gt;The topic element&lt;/b&gt;
+&lt;p&gt;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
+&lt;p&gt;&lt;tt&gt;&amp;lt;topic label=&quot;topic in another plug-in&quot; href=&quot;../other.plugin.id/concepts/some_other_file.html&quot;/&gt;&lt;/tt&gt;
+&lt;p&gt;The title attribute is optional. It is used to name the link to help content in the Index View in case when multiple topics are associated with the single keyword. If the attribute is not presented, the title comes from a TOC which own the link. If the attribute is not presented and the topic is not owned by any TOC, the title will be empty.
+ </documentation>
+ <appInfo>
+ <meta.attribute kind="resource"/>
+ </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.
+
+&lt;p&gt;(in file &lt;tt&gt;plugin.xml&lt;/tt&gt;)
+&lt;pre&gt;
+ &lt;extension point=&quot;org.eclipse.help.index&quot;&gt;
+ &lt;index file=&quot;index.xml&quot;/&gt;
+ &lt;/extension&gt;
+&lt;/pre&gt;
+
+&lt;p&gt;(in file &lt;tt&gt;index.xml&lt;/tt&gt;)
+&lt;blockquote&gt;&lt;tt&gt;&amp;lt;index&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Vehicle&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;inventory_of_wheel.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Car&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;car.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Ship&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;ship.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Airplane&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;airplane.html&quot; title=&quot;History of aviation&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;jet.html&quot; title=&quot;Jet engine&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Engine&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Horse&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;horse.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Steamer&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;steamer.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Wankel engine&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;wankel.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Jet engine&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;jet.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;entry keyword=&quot;Electricity&quot;&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;topic href=&quot;electricity.html&quot;/&gt;&lt;/tt&gt;&lt;br&gt;
+ &lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/entry&gt;&lt;/tt&gt;&lt;br&gt;
+&lt;tt&gt;&amp;lt;/index&gt;&lt;/tt&gt;&lt;br&gt;&lt;/blockquote&gt;
+
+&lt;p&gt;&lt;b&gt;&lt;em&gt;Internationalization&lt;/em&gt;&lt;/b&gt; The index XML files can be translated and the resulting copy (with translated keywords) should be placed in nl/&amp;lt;language&gt;/&amp;lt;country&gt; or nl/&amp;lt;language&gt; directory. The &amp;lt;language&gt; and &amp;lt;country&gt; 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/&amp;lt;language&gt;/&amp;lt;country&gt; directory has a higher priority than nl/&amp;lt;language&gt;. Only if no file is found in the nl/&amp;lt;language&gt;/&amp;lt;country&gt;, the file residing in nl/&amp;lt;language&gt; will be used. The the root directory of a plugin will be searched last.
+ </documentation>
+ </annotation>
+
+ <annotation>
+ <appInfo>
+ <meta.section type="apiInfo"/>
+ </appInfo>
+ <documentation>
+ No code is required to use this extension point. All that is needed is to supply the appropriate manifest files mentioned in the plugin.xml file.
+ </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 &lt;samp&gt;index&lt;/samp&gt; extension point.
+ </documentation>
+ </annotation>
+
+ <annotation>
+ <appInfo>
+ <meta.section type="copyright"/>
+ </appInfo>
+ <documentation>
+ Copyright (c) 2006 Intel 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>

Back to the top