Plugintemplate

[Here comes the plugin header, see Plugin Repository ]

A short description of what your plugin does… and why it's useful. It should be in more detail than 'description' field of plugin header. This is marketing!

[First, last and only chance to warn users before installing (some has already done that before reading this)]

External requirements: This plugin requires the following additional components that must be installed separately:

• A banana
• Another banana

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually. The local plugin directory must have the same name as the plugin is named, otherwise the plugin won't work properly.

[Most people learn by example, so this goes first]

See the plugin in action here. The sample page shows all the styles available with the plugin.

A simple box:

<box> the box contents </box>

Some more complex boxes

<box 80% round orange|a title> the box contents</box>
<box 50% left blue>the box contents</box|a caption>
<box 60% round #f99 #fc9 #fcc #f60|title>the box contents></box|caption>

[Pictures showing the rendered result will help users to understand]

[Complete syntax]

Basic syntax:

{{actionlink>action|title}}

• action can be one of this:
  • edit — edit/create/show
  • history — old revisions

[also CSS style tips]

[downloadable blocks, development comments]

[preferable GitHub RSS feed or similar]

• 2009-01-01
  • Initial release

[this section might not be needed in case of external bug manager, or use RSS feed]

[developers roadmap]

[discussions should ideally be deleted and turned into FAQ entries along the way]

Should be placed on an external page (e.g. pluginname:discussion) to have a distinction between user comments and author docs