DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:plugins

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
devel:plugins [2014-05-14 19:46]
Klap-in [Publishing a Plugin on dokuwiki.org]
devel:plugins [2019-06-04 09:51] (current)
SFITCS [Publishing a Plugin on dokuwiki.org]
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:color|color plugin]] may only consist of a single file, ''syntax.php''. More advanced plugins consist of several components, for example the [[plugin:data|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. A simple plugin like [[plugin:color|color plugin]] may only consist of a single file, ''syntax.php''. More advanced plugins consist of several components, for example the [[plugin:data|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===== =====Sources=====
 +
 There are a number of sources especially for plugin development: There are a number of sources especially for plugin development:
   * The [[devel:plugin file structure]] gives overview of the naming convention and structure, and where you add [[devel:javascript|JavaScript]] and [[devel:css|CSS stylesheets]], relevant for all plugin types   * The [[devel:plugin file structure]] gives overview of the naming convention and structure, and where you add [[devel:javascript|JavaScript]] and [[devel:css|CSS stylesheets]], relevant for all plugin types
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 32: Line 35:
     * This is used to separate ''<plugin name>'' from ''<component name>''     * This is used to separate ''<plugin name>'' from ''<component name>''
     * Using underscore will also give a [[:popularity|popularity]] rating of zero.      * Using underscore will also give a [[:popularity|popularity]] rating of zero. 
-  * If same name are used by two different plugins +  * If the same name is used by two different plugins 
-    * they are mutually excluding and inherent incompatible, +    * they are mutually excluding and inherently incompatible, 
     * furthermore only one of them can have a plugin homepage on dokuwiki.org.     * furthermore only one of them can have a plugin homepage on dokuwiki.org.
  
Line 50: Line 53:
 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:repository|Repository Plugin]] page. 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:repository|Repository Plugin]] page.
  
-From version Ponder Stibbons up an automated update signalling is possible. For the update proces to work properly it is necessary that the date “Last updated on” at the Plugin wiki page equals the date in the file [[devel:plugin_info|plugin.info.txt]] in the source tarbal/zipfile. If this is not the case: the update will not take place or the “Update” signal persists.+From version Ponder Stibbons up an automated update signalling is possible. For the update process to work properly it is necessary that the date “Last updated on” at the Plugin wiki page equals the date in the file [[devel:plugin_info|plugin.info.txt]] in the source tarball/zipfile. If this is not the case: the update will not take place or the “Update” signal persists
 + 
 +Uploads are not allowed on dokuwiki.org, so you need to host your plugin files somewhere else. We recommend to manage your source with a Revision Control System like [[git]]. If you do, it's easiest to use a public repository host like [[https://github.com/|GitHub]], [[https://gitlab.com/|GitLab]] or [[https://bitbucket.org/|Bitbucket]] which offers also a bug tracker for your repository.
  
-Uploads are not allowed on dokuwiki.org, so you need to host your plugin files somewhere else. We recommend to manage your source with a Revision Control System like [[git]]. If you doit's easiest to use a public repository host like [[http://github.com|Github]] which offers also a bug tracker for your repository.+Plugin developers can check the [[devel:badextensions|bad extension page]] for differences in their github repository checkinthe [[devel:plugin_info|plugin.info.txt]] and the respective page at dokuwiki.org.
  
 ===== Overview of Plugin Survey===== ===== Overview of Plugin Survey=====
devel/plugins.1400089572.txt.gz · Last modified: 2014-05-14 19:46 by Klap-in