Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Goldthorpe2009-02-10 22:40:08 +0000
committerChris Goldthorpe2009-02-10 22:40:08 +0000
commitea3c5d982d12d0169c7c612bcb1bbd43d9f891e9 (patch)
treeb437067008dbe8ed39a7bf2d1cfae2b23e92a13a /org.eclipse.help/schema
parent87477bda3b5492ba95bc353ae6069089142f8b00 (diff)
downloadeclipse.platform.ua-ea3c5d982d12d0169c7c612bcb1bbd43d9f891e9.tar.gz
eclipse.platform.ua-ea3c5d982d12d0169c7c612bcb1bbd43d9f891e9.tar.xz
eclipse.platform.ua-ea3c5d982d12d0169c7c612bcb1bbd43d9f891e9.zip
Bug 255066 – [Help][Context] context xml title attribute - more documentation needed
Diffstat (limited to 'org.eclipse.help/schema')
-rw-r--r--org.eclipse.help/schema/contexts.exsd12
1 files changed, 9 insertions, 3 deletions
diff --git a/org.eclipse.help/schema/contexts.exsd b/org.eclipse.help/schema/contexts.exsd
index a5b702e17..183214a3e 100644
--- a/org.eclipse.help/schema/contexts.exsd
+++ b/org.eclipse.help/schema/contexts.exsd
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
-<schema targetNamespace="org.eclipse.help">
+<schema targetNamespace="org.eclipse.help" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
<appInfo>
<meta.schema plugin="org.eclipse.help" id="contexts" name="Contexts"/>
@@ -11,6 +11,11 @@
</annotation>
<element name="extension">
+ <annotation>
+ <appInfo>
+ <meta.element />
+ </appInfo>
+ </annotation>
<complexType>
<choice minOccurs="1" maxOccurs="unbounded">
<element ref="contexts"/>
@@ -69,7 +74,8 @@ contexts manifest file:&lt;/b&gt;&lt;/i&gt;
&lt;br&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;href CDATA #REQUIRED &gt;&lt;/tt&gt;
&lt;p&gt;The contexts manifest files provide all the information needed when
context-sensitive help is requested by the user. The id is passed by the
-platform to the help system to identify the currently active context.The context definitions with matching IDs are then retrieved. If a title is defined it will be used when context help is displayed in the Help view. The IDs in the manifest file, must not contain the period character, since the IDs are uniquely identified by pluginID.contextID string when in memory. The IContext object is then created by help system that contains descriptions and topics from all context definitions for a given ID in a plug-in.&amp;nbsp; The description is to be displayed to the user, and
+platform to the help system to identify the currently active context.The context definitions with matching IDs are then retrieved. If a title is defined it will be used when context help is displayed in the Help view, both as the title in the related topics section and also as
+the search term in the &quot;More results&quot; section. The IDs in the manifest file, must not contain the period character, since the IDs are uniquely identified by pluginID.contextID string when in memory. The IContext object is then created by help system that contains descriptions and topics from all context definitions for a given ID in a plug-in.&amp;nbsp; The description is to be displayed to the user, and
related topics might be useful to the user for understanding the current
context.&amp;nbsp; The related topic are html files packaged in doc.zip, together
with topics that are part of on line help.
@@ -111,7 +117,6 @@ with topics that are part of on line help.
</complexType>
</element>
-
<annotation>
<appInfo>
<meta.section type="examples"/>
@@ -171,6 +176,7 @@ to plugin directory.
</documentation>
</annotation>
+
<annotation>
<appInfo>
<meta.section type="implementation"/>

Back to the top