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:

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