| <?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="criteriaDefinition" name="Criteria Definition"/> |
| </appInfo> |
| <documentation> |
| For registering a criteria definition for contributed help content. |
| </documentation> |
| </annotation> |
| |
| <element name="extension"> |
| <annotation> |
| <appInfo> |
| <meta.element /> |
| </appInfo> |
| </annotation> |
| <complexType> |
| <choice minOccurs="1" maxOccurs="unbounded"> |
| <element ref="criteriaDefinition"/> |
| <element ref="criteriaDefinitionProvider"/> |
| </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="criteriaDefinition"> |
| <annotation> |
| <documentation> |
| A criteria contribution made by supplying an XML file |
| </documentation> |
| </annotation> |
| <complexType> |
| <attribute name="file" type="string" use="required"> |
| <annotation> |
| <documentation> |
| the name of the criteria definition file which contains the list of criteria id and name of the help content. |
| <p> |
| <i><b>Configuration Markup for criteria definition file:</b></i> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT criteriaDefinition (criterion)* ></tt><br> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT criterion (criterion-value)* ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST criterion id CDATA #REQUIRED ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST criterion name CDATA #REQUIRED ></tt><br> |
| </p> |
| <p> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ELEMENT criterion-value EMPTY ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST criterion-value id CDATA #REQUIRED ></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp; &lt;!ATTLIST criterion-value name CDATA #REQUIRED ></tt><br> |
| </p> |
| <p><b>The criteriaDefinition element</b> |
| <p>The criteriaDefinition element represents an instance of criteria definition. CriteriaDefinition consists of criterion, each of them corresponds to a particular id and its name. |
| <p><b>The criterion element</b> |
| <p>The criterion element represents a criterion. Each criterion may contain several criterion-value which associated with the criterion. |
| <p><b>The criterion-value element</b> |
| <p>The criterion-value element provides value to the criterion category. It also has id and name associated with it. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="resource"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="criteriaDefinitionProvider"> |
| <annotation> |
| <documentation> |
| (<b>since 3.5</b>) an criteria definition contribution made by plugging in code |
| </documentation> |
| </annotation> |
| <complexType> |
| <attribute name="class" type="string" use="required"> |
| <annotation> |
| <documentation> |
| the implementation class for the criteria definition provider. This class must implement the <samp>org.eclipse.help.AbstractCriteriaDefinitionProvider</samp> interface. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="java" basedOn="org.eclipse.help.AbstractCriteriaDefinitionProvider:"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="since"/> |
| </appInfo> |
| <documentation> |
| 3.5 |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="examples"/> |
| </appInfo> |
| <documentation> |
| The following is an example of using the criteria definition extension point. |
| |
| <p>(in file <tt>plugin.xml</tt>) |
| <pre> |
| <extension point="org.eclipse.help.criteriaDefinition"> |
| <criteriaDefinition file="criteria.xml"/> |
| </extension> |
| </pre> |
| |
| <p>(in file <tt>criteria.xml</tt>) |
| <blockquote><tt>&lt;criteriaDefinition></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;criterion id="version" name ="Version"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;criterion-value id="1.0" name ="1.0"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;criterion-value id="2.0" name ="2.0"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/criterion></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&lt;criterion id="product" name ="Product"></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;criterion-value id="DB2" name ="DB2"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;criterion-value id="WAS" name ="WAS"/></tt><br> |
| <tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/criterion></tt><br> |
| <tt>&lt;/criteriaDefinition></tt><br></blockquote> |
| |
| <p><b><em>Internationalization</em></b> The criteria definition XML files can be translated and the resulting copy 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 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.AbstractCriteriaDefinitionProvider</samp> must be supplied if a <samp>criteriaDefinitionProvider</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>criteriaDefinition</samp> extension point. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="copyright"/> |
| </appInfo> |
| <documentation> |
| Copyright (c) 2010 IBM Corporation and others.<br> |
| |
| This program and the accompanying materials are made |
| available under the terms of the Eclipse Public License 2.0 which accompanies |
| this distribution, and is available at <a href="https://www.eclipse.org/legal/epl-2.0">https://www.eclipse.org/legal/epl-v20.html</a>/ |
| |
| SPDX-License-Identifier: EPL-2.0 |
| </documentation> |
| </annotation> |
| |
| </schema> |