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>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT category EMPTY>

<!ATTLIST category

id CDATA #REQUIRED

name CDATA #REQUIRED

parentCategory CDATA #IMPLIED>

id - a unique name that can be used to identify this category
name - a translatable name of the category that will be used in the dialog box
parentCategory - a path to another category if this category should be added as a child

<!ELEMENT sample EMPTY>

<!ATTLIST sample

id CDATA #REQUIRED

class CDATA #REQUIRED

icon CDATA #IMPLIED

category CDATA #IMPLIED

description CDATA #IMPLIED>

id - A unique name that can be used to identify this sample.
class - The fully qualified name of a pluglet class. It is recommended that the pluglet class simple name be unique.
icon - A relative path of an icon that will be used together with the simple class name to represent the sample in the dialog.
category - A slash-delimited path ('/') of category IDs. Each token in the path must represent a valid category ID previously defined by this or some other plug-in. If omitted, the sample will be added to the "Other" category.
description - A translatable description used by the Workbench to represent this sample to the user.

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>