Plugin Repository

The DokuWiki plugins are now managed through its own plugin here at www.dokuwiki.org.

New plugins now need to have a descriptional page in the plugin namespace here in the Wiki containing a block like this at the start:

---- plugin ----
description: Just an example to prove the point
author     : Joe Blow
email      : joe@example.com
type       : syntax, action
lastupdate : 2007-12-17
compatible : devel > 2007-10-06
depends    : 
conflicts  : sample
similar    : 
tags       : example, sample

downloadurl: http://github.com/example/dokuwiki-plugin-sample/zipball/master
bugtracker : http://github.com/example/dokuwiki-plugin-sample/issues
sourcerepo : http://github.com/example/dokuwiki-plugin-sample/
donationurl: https://www.paypal.com/...
----

The info is stored in a database and used to build a dynamic repository browser (at plugins).

About the fields:

  • description – should be a short description of what the plugin does
  • author – the plugin's main author
  • email – email address of the plugin's main author
  • type – One or more of the plugin types (syntax, action, admin, helper, render)
  • lastupdate – The date when the newest version of the plugin was provided in YYYY-MM-DD format
  • compatible – give the DokuWiki version(s) your plugin is compatible to
  • depends – comma separated list of plugin dependencies if any
  • conflicts – comma separated list of plugins which conflict your plugin
  • similar – comma separated list of plugins with a similar task
  • tags – categorize your plugin here
  • securityissue – only add this field when there is a security problem with the plugin. enter a short description here and inform the author.
  • downloadurl – this should be the direct URL to the download compatible with the most current release
  • bugtracker – a link to the bug tracker for this plugin, leave empty if none available
  • sourcerepo – a link to the webinterface of a source code management system like git or darcs, leave empty if none available
  • donationurl – a link to paypal, an Amazon wishlist or similar thing where people can donate to you, leave empty if none available

A plugin similar to this one but with more flexibility is now available. It's called the data plugin.

 
plugin/repository.txt · Last modified: 2010/01/09 15:49 by andi
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Imprint Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki
WikiForumIRCBugsGitXRefTranslate