devel:plugins
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
devel:plugins [2015-11-22 19:36] – old revision restored (2015-05-28 11:20) ach | devel:plugins [2023-11-19 23:53] (current) – plugin survey a bit too old Klap-in | ||
---|---|---|---|
Line 16: | Line 16: | ||
* [[Remote Plugins]] allow to add webservices to your plugin. | * [[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. | * [[Auth Plugins]] add additional authentication backend to the DokuWiki, which could be activated via configuration manager. | ||
+ | * [[CLI Plugins]] add command line tools to your plugin | ||
A simple plugin like [[plugin: | A simple plugin like [[plugin: | ||
=====Sources===== | =====Sources===== | ||
+ | |||
There are a number of sources especially for plugin development: | There are a number of sources especially for plugin development: | ||
* The [[devel: | * The [[devel: | ||
Line 25: | Line 27: | ||
* These [[security|security guidelines]] give some deeper understanding of common issues and presents some protection measures. | * These [[security|security guidelines]] give some deeper understanding of common issues and presents some protection measures. | ||
* Some general [[plugin programming tips]] are available, mostly good practices and pointers to handsome tools in DokuWiki. | * Some general [[plugin programming tips]] are available, mostly good practices and pointers to handsome tools in DokuWiki. | ||
+ | |||
===== Plugin Name ===== | ===== Plugin Name ===== | ||
Line 38: | Line 41: | ||
===== Plugin Wizard ===== | ===== Plugin Wizard ===== | ||
- | A Wizard to create the basic skeleton for a DokuWiki plugin can be found at http:// | + | A Wizard to create the basic skeleton for a DokuWiki plugin can be found at http:// |
If you later need to extend your plugin refer to the [[plugin_file_structure|plugin file structure]] on how files are arranged in a plugin. | If you later need to extend your plugin refer to the [[plugin_file_structure|plugin file structure]] on how files are arranged in a plugin. | ||
Line 46: | Line 49: | ||
If you created a plugin, please share it with the community. Just create a page named after your plugin in the plugin namespace. E.g. if your pluginfolder is named '' | If you created a plugin, please share it with the community. Just create a page named after your plugin in the plugin namespace. E.g. if your pluginfolder is named '' | ||
- | The page should contain all needed documentation on how to install and use the plugin and give users a pretty good idea what it does before installing the plugin. Adding screenshots might be a good idea as well((You can use the [[plugin: | + | The page should contain all needed documentation on how to install and use the plugin and give users a pretty good idea what it does before installing the plugin. Adding screenshots might be a good idea as well. When creating the new page, a namespace |
At the top of the plugin page a few metadata fields have to be filled. A description of each field can be found on [[plugin: | At the top of the plugin page a few metadata fields have to be filled. A description of each field can be found on [[plugin: | ||
- | From version Ponder Stibbons up an automated | + | Users will see that an update is available in the extension manager. For this to work properly it is necessary that the date “Last updated on” at the Plugin wiki page equals the date in the file [[devel: |
- | Uploads are not allowed on dokuwiki.org, | + | Uploads are not allowed on dokuwiki.org, |
Plugin developers can check the [[devel: | Plugin developers can check the [[devel: | ||
- | ===== Overview of Plugin Survey===== | ||
- | [[devel:plugin survey: | + | ===== Inspiration ===== |
+ | |||
+ | Already more than 1200 plugins are written for DokuWiki. To learn how things are working, you might study some existing plugins that have some similarity with your ideas. At [[https:// | ||
devel/plugins.1448217399.txt.gz · Last modified: 2015-11-22 19:36 by ach