DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:plugins

This is an old revision of the document!


Plugin Development

It is very easy to write a DokuWiki plugin. Before writing your own, remember to search for similar plugins among plugins already written and read through security guidelines for plugin authors.

DokuWiki has a flexible plugin API which allows developers to extend its functionality, be it additional syntax modes, custom action modes, new export formats, and a lot more. Depending on the plugin's purpose, a plugin can either consist of one, or more, components of the following plugin types.

Plugin Types

At the moment DokuWiki features seven different plugin types.

  • Syntax Plugins extend DokuWiki's basic syntax.
  • Action Plugins can be used to extend or replace many aspects of DokuWiki's core operations, from saving wikipages to adding new action modes.
  • Admin Plugins can provide administration functionality for DokuWiki - these plugins are accessible to superusers and managers via the Admin button.
  • Helper Plugins can be used to provide functionality to many other plugins, so each plugin doesn't have to re-implement a certain function over and over again.
  • Renderer Plugins allow to create new export modes and to replace the standard DokuWiki XHTML renderer.
  • Remote Plugins allow to add webservices to your plugin.
  • Auth Plugins add additional authentication backend to the DokuWiki, which could be activated via configuration manager.

A simple plugin like color plugin may only consist of a single file, syntax.php. More advanced plugins consist of several components, for example the structured data plugin have the syntax handling split in “data entry” and “table view” components, an action component for the special edit button attached to every data entry and an admin interface for database maintenance.

Sources

There are a number of sources especially for plugin development:

poker online is the promoter of poker games online with real money in Asia, safe and easy as facebook poker chips can be cashed at any time.

Plugin Wizard

A Wizard to create the basic skeleton for a DokuWiki plugin can be found at http://pluginwizard.dokuwiki.org/ and is recommended to be used for starting the development.

If you later need to extend your plugin refer to the plugin file structure on how files are arranged in a plugin.

agen poker a poker websites online with the biggest discounts and fast processing.

Overview of Plugin Survey

Plugin Survey is a developers overview of all plugins present in the plugin namespace of www.dokuwiki.org. Data was collected by an automated script 2010-09-05 with some additional manual data download and mining. A total of 697 plugin pages containing 672 plugins was examined and source code for 647 plugins (96%) downloaded and parsed.

devel/plugins.1453800045.txt.gz · Last modified: 2016-01-26 10:20 by 36.79.234.203

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki