Plugin Documentation
Prev | Chapter 18. Implementing a Simple Plugin | Next

## Plugin Documentation

While not required by the plugin API, a help file is an essential element of any plugin written for public release. A single web page is often all that is required. There are no specific requirements on layout, but because of the design of jEdit's help viewer, the use of frames should be avoided. Topics that would be useful include the following:

- a description of the purpose of the plugin;

- an explanation of the type of input the user can supply through its visible interface (such as mouse action or text entry in controls);

- a listing of available user actions that can be taken when the plugin does not have input focus;

- a summary of configuration options;

- information on development of the plugin (such as a change log, a list of “to do” items, and contact information for the plugin's author); and

- licensing information, including acknowledgments for any library software used by the plugin.

The location of the plugin's help file is stored in the `plugin.QuickNotepad.docs` property; see the section called “The Property File”.

Prev | Up | Next
The QuickNotepadOptionPane Class | Home | Compiling the Plugin