DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

devel:plugin_info

Plugin Information

Each plugin needs to provide some basic information about itself. This is done through a file called plugin.info.txt located in the plugin directory.

Here's an example how such a file should look like.

lib/plugins/example/plugin.info.txt
base   example
author My Full Name
email  me@example.com
date   2010-01-17
name   Example Plugin to do Stuff
desc   This is just an Example of how a plugin description looks like
url    https://www.dokuwiki.org/plugin:example
Parameter Description
base The technical name of the plugin. Extension Manager will install it into this directory.
author The full name of the Plugin author
email E-Mail to contact the plugin author about this plugin
date The date of the last update of this plugin in YYYY-MM-DD form. Don't forget to update this when you update your plugin! 1)
name The human readable name of the plugin
desc A description of what the plugin does
url URL to where more info about the plugin is available

Note: the plugin.info.txt replaces the old getInfo() call in your plugin components for DokuWiki 2009-12-25 “Lemming” and later. getInfo() is now implemented in the base class and will read all info from this file. It no longer needs to be implemented in your sub classes.

1)
This date should be equal to the “Last updated on” date on the plugins page in the repository. This is needed for the automated update flagging used by the Extension Manager introduced in release Ponder Stibbons
devel/plugin_info.txt · Last modified: 2014-05-17 01:34 by rene