Plugin Design Documentation

Revision as of 11:14, 21 February 2006 by Watkinson (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This document outlines the requirements for plugin design documentation.

Plugin Type

Plugins can generally be categorized as one of the following:

  1. File Filter - A plugin that can read a data set from a stream.
  2. Analysis - A plugin that performs an analysis on a data set (often producing a result data set).
  3. Visualization - A plugin that creates a visualization of a data set.
  4. Interactive - A plugin that is a hybrid of Analysis and Visualization types.

Data Sets

All data sets that the plugin can operate on should be listed. If a plugin operates on a super-type data set, the sub-types need not be listed. If the plugin is capable of producing data sets, these types should be listed as well.