qpsmtpd Wiki

[[plugins:example_plugin]]

You are here: start » plugins » example_plugin

Login

You are currently not logged in! Enter your authentication credentials below to log in. You need to have cookies enabled to log in.

Login

You don't have an account yet? Just get one: Register

Forgotten your password? Get a new one: Set new password

Plug-in Summary

Plug-in name: Example Plug-in Name
Info: A brief description of the plug-in
Author: Plug-in author
Email: Email address of plug-in author
Compatibility: Version(s) of qpsmtpd the plug-in is compatible with
Download: Location of plug-in

Example Plug-in Name

When adding a plug-in to the wiki please use this example plug-in template as a basis. To do this create a page in the plug-ins namespace (in accordance with the naming standard). Add content to that page using the template structure discussed in this page.

The example plug-in template uses the Templater DokuWiki plug-in to provide a default layout and some generic information for the plug-in. It also supports the indexing of plug-ins on the main plugins page.

The Templater plug-in uses some templating code at the top of the page to populate some default values for every plug-in. These values are:

Name - Name of the plug-in
Info - A brief description of the plug-in
Author - Plug-in author
Email - Email address of plug-in author
Compatability - Version(s) of qpsmtpd the plug-in is compatible with
Download - Location of plug-in

You need to place these values into the Templater code as you can see in the code block below:

{{template>plugins:plugin_template
|name=Name of the plug-in
|info=A brief description of the plug-in
|author=Plug-in author
|email=Email address of author
|compat=Version(s) of qpsmtpd the plug-in is compatible with
|download=Location of plug-in}}

The first line:

 {{template>plugin_template

Specifies the name of the template file, in this case plugin_template. The next lines allow you to specify summary information about your plug-in. When saved this will produce a page like the one you see now. You can then add more details, in addition to the contents of the Plug-in Summary box, about your plug-in to the new page.

We recommend that you provide at least the following information about your plug-in:

  1. Plug-in Description - a detailed description of your plug-in including how it operates, any pre-requisites and similar information
  2. Plug-in Configuration - including examples of any configuration options and/or configuration files
  3. Plug-in Development notes, e.g. TODO lists, bugs, ChangeLog
  4. Any other relevant information

Please try to structure your plug-in page appropriately.