PageRenderTime 58ms CodeModel.GetById 35ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 29 lines | 29 code | 0 blank | 0 comment | 0 complexity | 8e3f8259db3d5b331e8aac7f74b4a26b MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  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.65.1"><link rel="home" href="index.html" title="jEdit 4.2 User's Guide"><link rel="up" href="plugin-implement.html" title="Chapter 18. Implementing a Simple Plugin"><link rel="previous" href="plugin-implement-options.html" title="The QuickNotepadOptionPane Class"><link rel="next" href="plugin-implement-building.html" title="Compiling the Plugin"></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></div></div><p>
    2. 

  2.   While not required by the plugin API, a help file is an essential
    3. 

  3.   element of any plugin written for public release. A single web page is
    4. 

  4.   often all that is required. There are no specific requirements on
    5. 

  5.   layout, but because of the design of jEdit's help viewer, the use of
    6. 

  6.   frames should be avoided. Topics that would be useful include
    7. 

  7.   the following:
    8. 

  8. </p><div class="itemizedlist"><ul type="disc"><li><p>
    9. 

  9.       a description of the purpose of the plugin;
    10. 

  10.     </p></li><li><p>
    11. 

  11.       an explanation of the type of input the user can supply through its
    12. 

  12.       visible interface (such as mouse action or text entry in controls);
    13. 

  13.     </p></li><li><p>
    14. 

  14.       a listing of available user actions that can be taken when the
    15. 

  15.       plugin does not have input focus;
    16. 

  16.     </p></li><li><p>
    17. 

  17.       a summary of configuration options;
    18. 

  18.     </p></li><li><p>
    19. 

  19.       information on development of the plugin (such as a change log,
    20. 

  20.       a list of &#8220;<span class="quote">to do</span>&#8221; items, and contact information for
    21. 

  21.       the plugin's author); and
    22. 

  22.     </p></li><li><p>
    23. 

  23.       licensing information, including acknowledgments for any library
    24. 

  24.       software used by the plugin.
    25. 

  25.     </p></li></ul></div><p>
    26. 

  26.  The location of the plugin's help file is stored in the
    27. 

  27.  <tt class="literal">plugin.QuickNotepad.docs</tt>
    28. 

  28.  property; see <a href="plugin-implement-properties.html" title="The Property File">the section called &#8220;The Property File&#8221;</a>.
    29. 

  29. </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"> Compiling the Plugin</td></tr></table></div></body></html>
    30. 

  30.