PluS XML format

This is the current format of an XML plugin description for PluS. So far, the description has not altered since finishing the first prototype design. However, for future versions it may change.

DTD

<!ELEMENT plugin (library, entrypoint, prerequisites?, extensions?, extensionpoints?)>
<!ATTLIST plugin ID CDATA #REQUIRED
				vendor CDATA #IMPLIED>

<!ELEMENT library (#PCDATA)>
<!ELEMENT entrypoint (#PCDATA)>
<!ELEMENT prerequisites (prerequisite*)>
<!ELEMENT prerequisite (#PCDATA)>
<!ELEMENT extensions (extension*)>
<!ELEMENT extension (extensionpoint, extender)>
<!ATTLIST extension hostID CDATA #REQUIRED>
<!ELEMENT extensionpoints (extensionpoint*)>
<!ELEMENT extensionpoint (#PCDATA)>
<!ATTLIST extensionpoint ID CDATA #IMPLIED>
<!ELEMENT extender (#PCDATA)>

Textual Description of Elements

plugin

The root element of a plugin description

ID

The ID of this plugin

vendor

The creator of the plugin

library

The jar file containing the classes for this plugin

entrypoint

The entry point of the plugin, the class which needs to be instantiated to run the plugin

prerequisites

Dependencies. Other plugins which this plugin relies on

extensions

A list of extensions this plugin provides

extension

An extension to an existing plugin which this plugin provides

hostID

The ID of the plugin which this is extending

extensionpoint

The class from which a plugin may be extended, or the class (or ID of extension point) which is being extended

ID

An ID for this extension point

extender

The class which is extending an extension point