Sample Pluglet

Identifier:
com.ibm.xtools.pluglets.ui.samplePluglet

Since:
1.5.0

Description:
Allows plug-ins to register sample pluglets. These samples can be discovered in the "Run pluglet..." dialog.

In the dialog, samples are organized into categories which usually reflect a particular problem domain. The categories defined by one plug-in can be referenced by other plug-ins using the category attribute. Uncategorized samples, as well as samples with invalid category paths, will end up in an "Other" category.

It is recommended that the source files of sample pluglets be made available to the user via the standard Eclipse mechanisms for discovering plug-in sources.

Configuration Markup:

<!ELEMENT extension (category | sample)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>


<!ELEMENT sample EMPTY>

<!ATTLIST sample

id          CDATA #REQUIRED

class       CDATA #REQUIRED

icon        CDATA #IMPLIED

category    CDATA #IMPLIED

description CDATA #IMPLIED>


Examples:


   <extension point="com.ibm.xtools.pluglets.ui.samplePluglet"> 
      <category 
        id="com.abc.xyz" 
        name="XYZ Pluglets"> 
      </category> 
      <category 
        id="com.abc.xyz.easy" 
        name="Easy Pluglets" 
        parentCategory="com.abc.xyz"> 
      </category> 
      <sample 
        id="com.abc.xyz.easy.pluglet" 
        class="com.abc.xyz.EasySamplePluglet"
        icon="icons/EasySamplePluglet.gif" 
        category="com.abc.xyz/com.abc.xyz.easy" 
        description="%EasySamplePluglet.description"> 
      </sample> 
   </extension> 


© Copyright Model RealTime Corp. 2003, 2004. All Rights Reserved