PageRenderTime 15ms CodeModel.GetById 9ms app.highlight 2ms RepoModel.GetById 2ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/users-guide/plugin-implement-docs.html

#
HTML | 13 lines | 13 code | 0 blank | 0 comment | 0 complexity | 08933a5b8fba461314a07f8143202657 MD5 | raw file
 1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Plugin Documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="jEdit 4.3 User's Guide"><link rel="up" href="plugin-implement.html" title="Chapter 18. Implementing a Simple Plugin"><link rel="prev" href="plugin-implement-options.html" title="The QuickNotepadOptionPane Class"><link rel="next" href="plugin-implement-building.html" title="The build.xml Ant build file"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Plugin Documentation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="plugin-implement-options.html">Prev</a> </td><th width="60%" align="center">Chapter 18. Implementing a Simple Plugin</th><td width="20%" align="right"> <a accesskey="n" href="plugin-implement-building.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="plugin-implement-docs"></a>Plugin Documentation</h2></div></div></div><p>While not required by the plugin API, a help file is an essential
 2        element of any plugin written for public release. A single web page is
 3        often all that is required. There are no specific requirements on
 4        layout, but because of the design of jEdit's help viewer, the use of
 5        frames should be avoided. Topics that would be useful include the
 6        following:</p><div class="itemizedlist"><ul type="disc"><li><p>a description of the purpose of the plugin;</p></li><li><p>an explanation of the type of input the user can supply
 7                through its visible interface (such as mouse action or text
 8                entry in controls);</p></li><li><p>a listing of available user actions that can be taken when
 9                the plugin does not have input focus;</p></li><li><p>a summary of configuration options;</p></li><li><p>information on development of the plugin (such as a change
10                log, a list of &#8220;<span class="quote">to do</span>&#8221; items, and contact
11                information for the plugin's author); and</p></li><li><p>licensing information, including acknowledgments for any
12                library software used by the plugin.</p></li></ul></div><p>The location of the plugin's help file is stored in the
13        <code class="literal">plugin.QuickNotepad.docs</code> property; see <a class="xref" href="plugin-implement-properties.html" title="The Property File">the section called &#8220;The Property File&#8221;</a>.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="plugin-implement-options.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="plugin-implement.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plugin-implement-building.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The QuickNotepadOptionPane Class </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> The build.xml Ant build file</td></tr></table></div></body></html>