Criteria Definition

Identifier:

org.eclipse.help.criteriaDefinition

Since:

3.5

Description:

For registering a criteria definition for contributed help content.

Configuration Markup:

<!ELEMENT extension (criteriaDefinition | criteriaDefinitionProvider)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT criteriaDefinition EMPTY>

<!ATTLIST criteriaDefinition

file CDATA #REQUIRED>

A criteria contribution made by supplying an XML file

file - the name of the criteria definition file which contains the list of criteria id and name of the help content.
Configuration Markup for criteria definition file:

    <!ELEMENT criteriaDefinition (criterion)* >

    <!ELEMENT criterion (criterion-value)* >
    <!ATTLIST criterion id CDATA #REQUIRED >
    <!ATTLIST criterion name CDATA #REQUIRED >

    <!ELEMENT criterion-value EMPTY >
    <!ATTLIST criterion-value id CDATA #REQUIRED >
    <!ATTLIST criterion-value name CDATA #REQUIRED >

The criteriaDefinition element
The criteriaDefinition element represents an instance of criteria definition. CriteriaDefinition consists of criterion, each of them corresponds to a particular id and its name.
The criterion element
The criterion element represents a criterion. Each criterion may contain several criterion-value which associated with the criterion.
The criterion-value element
The criterion-value element provides value to the criterion category. It also has id and name associated with it.

<!ELEMENT criteriaDefinitionProvider EMPTY>

<!ATTLIST criteriaDefinitionProvider

class CDATA #REQUIRED>

(since 3.5) an criteria definition contribution made by plugging in code

class - the implementation class for the criteria definition provider. This class must implement the org.eclipse.help.AbstractCriteriaDefinitionProvider interface.

Examples:

The following is an example of using the criteria definition extension point.

(in file plugin.xml)


 <extension point="org.eclipse.help.criteriaDefinition">
     <criteriaDefinition file="criteria.xml"/>
 </extension>

(in file criteria.xml)

<criteriaDefinition>
    <criterion id="version" name ="Version">
        <criterion-value id="1.0" name ="1.0"/>
        <criterion-value id="2.0" name ="2.0"/>
        </criterion>
    <criterion id="product" name ="Product">
        <criterion-value id="DB2" name ="DB2"/>
        <criterion-value id="WAS" name ="WAS"/>
        </criterion>
</criteriaDefinition>

Internationalization The criteria definition XML files can be translated and the resulting copy should be placed in nl/<language>/<country> or nl/<language> directory. The <language> and <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/<language>/<country> directory has a higher priority than nl/<language>. Only if no file is found in the nl/<language>/<country>, the file residing in nl/<language> will be used. The root directory of a plugin will be searched last.

API Information:

An implementation of org.eclipse.help.AbstractCriteriaDefinitionProvider must be supplied if a criteriaDefinitionProvider is used.

Supplied Implementation:

The default implementation of the help system UI supplied with the Eclipse platform fully supports the criteriaDefinition extension point.

Copyright (c) 2010 IBM Corporation and others.
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 https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0