# jEdit 2.6 User's Guide

Next, Prev

## Chapter 11. Developing Plugins

# Plugin Documentation

jEdit queries various properties to get information about plugins. Defining these properties is highly recommended. In the below property names, `plugin` should be the class name of your `EditPlugin` implementation.

- plugin.`plugin`.name - the name of the plugin (required for plugin to appear in help index)

- plugin.`plugin`.author - the plugin's author

- plugin.`plugin`.version - the plugin version (defining this property is highly recommended; otherwise the plugin manager's "update" function will not work)

- plugin.`plugin`.docs - the filename, relative to the plugin's JAR root, where the documentation is stored in HTML format (required for plugin to appear in help index)

Here is an example of setting these properties for a plugin named `HelloWorldPlugin`:

    plugin.HelloWorldPlugin.name=Hello World!
    plugin.HelloWorldPlugin.author=Joe Random Hacker
    plugin.HelloWorldPlugin.version=1.0
    plugin.HelloWorldPlugin.docs=index.html

Home, Up
Prev: Plugin Properties
Next: Plugin Dependencies