devel:plugin_info
This is an old revision of the document!
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 http://www.dokuwiki.org/plugin:example
Parameter | Description |
---|---|
base | The technical name of the plugin. Has to reflect the directory in which your plugin needs to be installed. |
author | The full name of the Plugin author |
E-Mail to contact the plugin author about this plugin | |
date | The date of the last update of this plugin in YYY-MM-DD form. Don't forget to update this when you update your plugin! |
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. 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.
devel/plugin_info.1274120446.txt.gz · Last modified: 2010-05-17 20:20 by andi