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 |
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 |
minphp | Minimum PHP version required by this plugin. Empty for same as DokuWiki. Only Major.Minor version, eg. 8.2 , not 8.2.3 may be provided! |
maxphp | Maximum PHP version supported by this plugin. Empty for same as DokuWiki. Only Major.Minor version, eg. 8.2 , not 8.2.3 may be provided! |
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: 2023-10-10 10:24 by andi