org.eclipse.help/schema/contexts.exsd - platform/eclipse.platform.ua - Git at Google

 <?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="contexts" name="Contexts"/>
       </appInfo>
       <documentation>
          For defining context-sensitive help for an
 individual plug-in.
       </documentation>
    </annotation>

    <element name="extension">
       <complexType>
          <sequence>
             <element ref="contexts" 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>
             </annotation>
          </attribute>
       </complexType>
    </element>

    <element name="contexts">
       <complexType>
          <attribute name="file" type="string" use="required">
             <annotation>
                <documentation>
                   the name of the manifest file which contains the context-sensitive help documentation for this plug-in.
 &lt;p&gt;
 &lt;i&gt;&lt;b&gt;Configuration Markup for what goes into the
 contexts manifest file:&lt;/b&gt;&lt;/i&gt;
 &lt;p&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ELEMENT contexts (context)* ) &gt;&lt;/tt&gt;
 &lt;p&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ELEMENT context (description?,topic*) &gt;&lt;/tt&gt;
 &lt;br&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ATTLIST context id ID #REQUIRED &gt;&lt;/tt&gt;
 &lt;p&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ELEMENT description (#PCDATA)&gt;&lt;/tt&gt;
 &lt;p&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 label CDATA #REQUIRED &gt;&lt;/tt&gt;
 &lt;br&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;!ATTLIST topic href CDATA #IMPLIED &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 identify the currently active context. The context definitions
 with matching IDs are then retrieved. The IContext object is then created
 by help system that contains descriptions and topics from all context definitions
 for a given ID.&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.
 &lt;/p&gt;
                </documentation>
                <appInfo>
                   <meta.attribute kind="resource"/>
                </appInfo>
             </annotation>
          </attribute>
          <attribute name="plugin" type="string">
             <annotation>
                <documentation>
                   Plugin to which its context definitions are extended with extra information.
 &lt;p&gt;If a plugin defines some context id&apos;s, one can extend the description or related links of a context by declaring another context with the same id.&lt;/p&gt;
                </documentation>
             </annotation>
          </attribute>
       </complexType>
    </element>

    <annotation>
       <appInfo>
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
          The following is an example of using the contexts
 extension point:
 &lt;br&gt;
 (in file &lt;tt&gt;plugin.xml&lt;/tt&gt;)
 &lt;p&gt;
 &lt;pre&gt;
    &lt;extension point=&quot;org.eclipse.help.contexts&quot;&gt;
       &lt;contexts file=&quot;xyzContexts.xml&quot;/&gt;
    &lt;/extension&gt;
 &lt;/pre&gt;
 &lt;/p&gt;

 &lt;p&gt;(in file &lt;tt&gt;xyzContexts.xml&lt;/tt&gt;)
 &lt;p&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;contexts&gt;&lt;/tt&gt;
 &lt;br&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;context&amp;nbsp; id=&quot;generalContextId&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;lt;description&gt; This
 is a sample F1 help string.&amp;lt;/description&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;lt;topic href=&quot;contexts/RelatedContext1.html&quot;&amp;nbsp;
 label=&quot;Help Related Topic 1&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;lt;topic href=&quot;contexts/RelatedContext2.html&quot;&amp;nbsp;
 label=&quot;Help Related Topic 2&quot;/&gt;&lt;/tt&gt;
 &lt;br&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;/context&gt;&lt;/tt&gt;
 &lt;br&gt;&lt;tt&gt;&amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;lt;/contexts&gt;&lt;/tt&gt;
 &lt;br&gt;&amp;nbsp;
 &lt;/p&gt;

 &lt;b&gt;&lt;em&gt;Externalizing Strings&lt;/em&gt;&lt;/b&gt;
 The Context XML files can be translated and the resulting copy (with translated
 descriptions labels) should be placed in nl/&amp;lt;language&gt;/&amp;lt;country&gt;
 or nl/&amp;lt;language&gt; directory.&amp;nbsp; The &amp;lt;language&gt; and &amp;lt;country&gt;
 stand for two letter language and country codes as used in locale codes.&amp;nbsp;
 For example, Traditional Chinese translations should be placed in the nl/zh/TW
 directory.&amp;nbsp; The nl/&amp;lt;language&gt;/&amp;lt;country&gt; directory has a higher
 priority than nl/&amp;lt;language&gt;.&amp;nbsp; 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.&amp;nbsp; The the root
 directory of a plugin will be searched last.
 &lt;p&gt;The related topics contained in doc.zip can be localized by creating
 a doc.zip file with translated version of documents, and placing doc.zip
 in
 &lt;br&gt;nl/&amp;lt;language&gt;/&amp;lt;country&gt; or nl/&amp;lt;language&gt; directory. The help
 system will look for the files under this directories before defaulting
 to plugin directory.
       </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
 file(s) mentioned in the plugin.xml file.
       </documentation>
    </annotation>

    <annotation>
       <appInfo>
          <meta.section type="implementation"/>
       </appInfo>
       <documentation>
          The optional default implementation of the help
 system UI supplied with the Eclipse platform
 fully supports the &lt;samp&gt;contexts&lt;/samp&gt; extension point.
       </documentation>
    </annotation>

    <annotation>
       <appInfo>
          <meta.section type="copyright"/>
       </appInfo>
       <documentation>
          Copyright (c) 2000, 2003 IBM Corporation and others.&lt;br&gt;
 All rights reserved. This program and the accompanying materials are made
 available under the terms of the Common Public License v1.0 which accompanies
 this distribution, and is available at &lt;a href=&quot;http://www.eclipse.org/legal/cpl-v10.html&quot;&gt;http://www.eclipse.org/legal/cpl-v10.html&lt;/a&gt;
       </documentation>
    </annotation>

 </schema>
	<?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="contexts" name="Contexts"/>
	</appInfo>
	<documentation>
	For defining context-sensitive help for an
	individual plug-in.
	</documentation>
	</annotation>

	<element name="extension">
	<complexType>
	<sequence>
	<element ref="contexts" 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>
	</annotation>
	</attribute>
	</complexType>
	</element>

	<element name="contexts">
	<complexType>
	<attribute name="file" type="string" use="required">
	<annotation>
	<documentation>
	the name of the manifest file which contains the context-sensitive help documentation for this plug-in.
	<p>
	<i><b>Configuration Markup for what goes into the
	contexts manifest file:</b></i>
	<p><tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT contexts (context)* ) ></tt>
	<p><tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT context (description?,topic*) ></tt>
	<br><tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST context id ID #REQUIRED ></tt>
	<p><tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT description (#PCDATA)></tt>
	<p><tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT topic EMPTY ></tt>
	<br><tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST topic label CDATA #REQUIRED ></tt>
	<br><tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST topic href CDATA #IMPLIED ></tt>
	<p>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 identify the currently active context. The context definitions
	with matching IDs are then retrieved. The IContext object is then created
	by help system that contains descriptions and topics from all context definitions
	for a given ID.&nbsp; The description is to be displayed to the user, and
	related topics might be useful to the user for understanding the current
	context.&nbsp; The related topic are html files packaged in doc.zip, together
	with topics that are part of on line help.
	</p>
	</documentation>
	<appInfo>
	<meta.attribute kind="resource"/>
	</appInfo>
	</annotation>
	</attribute>
	<attribute name="plugin" type="string">
	<annotation>
	<documentation>
	Plugin to which its context definitions are extended with extra information.
	<p>If a plugin defines some context id's, one can extend the description or related links of a context by declaring another context with the same id.</p>
	</documentation>
	</annotation>
	</attribute>
	</complexType>
	</element>

	<annotation>
	<appInfo>
	<meta.section type="examples"/>
	</appInfo>
	<documentation>
	The following is an example of using the contexts
	extension point:
	<br>
	(in file <tt>plugin.xml</tt>)
	<p>
	<pre>
	<extension point="org.eclipse.help.contexts">
	<contexts file="xyzContexts.xml"/>
	</extension>
	</pre>
	</p>

	<p>(in file <tt>xyzContexts.xml</tt>)
	<p><tt>&nbsp;&nbsp;&nbsp; &lt;contexts></tt>
	<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;context&nbsp; id="generalContextId"></tt>
	<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;description> This
	is a sample F1 help string.&lt;/description></tt>
	<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;topic href="contexts/RelatedContext1.html"&nbsp;
	label="Help Related Topic 1"/></tt>
	<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;topic href="contexts/RelatedContext2.html"&nbsp;
	label="Help Related Topic 2"/></tt>
	<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/context></tt>
	<br><tt>&nbsp;&nbsp;&nbsp; &lt;/contexts></tt>
	<br>&nbsp;
	</p>

	<b><em>Externalizing Strings</em></b>
	The Context XML files can be translated and the resulting copy (with translated
	descriptions labels) should be placed in nl/&lt;language>/&lt;country>
	or nl/&lt;language> directory.&nbsp; The &lt;language> and &lt;country>
	stand for two letter language and country codes as used in locale codes.&nbsp;
	For example, Traditional Chinese translations should be placed in the nl/zh/TW
	directory.&nbsp; The nl/&lt;language>/&lt;country> directory has a higher
	priority than nl/&lt;language>.&nbsp; Only if no file is found in the nl/&lt;language>/&lt;country>,
	the file residing in nl/&lt;language> will be used.&nbsp; The the root
	directory of a plugin will be searched last.
	<p>The related topics contained in doc.zip can be localized by creating
	a doc.zip file with translated version of documents, and placing doc.zip
	in
	<br>nl/&lt;language>/&lt;country> or nl/&lt;language> directory. The help
	system will look for the files under this directories before defaulting
	to plugin directory.
	</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
	file(s) mentioned in the plugin.xml file.
	</documentation>
	</annotation>

	<annotation>
	<appInfo>
	<meta.section type="implementation"/>
	</appInfo>
	<documentation>
	The optional default implementation of the help
	system UI supplied with the Eclipse platform
	fully supports the <samp>contexts</samp> extension point.
	</documentation>
	</annotation>

	<annotation>
	<appInfo>
	<meta.section type="copyright"/>
	</appInfo>
	<documentation>
	Copyright (c) 2000, 2003 IBM Corporation and others.<br>
	All rights reserved. This program and the accompanying materials are made
	available under the terms of the Common Public License v1.0 which accompanies
	this distribution, and is available at <a href="http://www.eclipse.org/legal/cpl-v10.html">http://www.eclipse.org/legal/cpl-v10.html</a>
	</documentation>
	</annotation>

	</schema>