Table of Contents
Plugin Survey 2011 - Events
(This is a part of the plugin survey 2011)
A survey of DokuWiki plugins would not be complete without answering ”Who uses this Event?” The event system allows custom handling in addition to or instead of the standard processing. In the analyzed code there are 325 plugins (39% of all plugins) using 68 different events.
Here is the top 5 list, which have contained the same events since first survey in 2009:
Event | Plugins |
---|---|
TPL_METAHEADER_OUTPUT | 68 plugins |
ACTION_ACT_PREPROCESS | 67 plugins |
TOOLBAR_DEFINE | 41 plugins |
DOKUWIKI_STARTED | 40 plugins |
TPL_ACT_RENDER | 39 plugins |
See also the complete list of events at time of survey (including unused).
Deprecated events
Events surrounding the usage of namespace templates when a new page is loaded into the editor has changed more than once. The original HTML_PAGE_FROMTEMPLATE was changed to COMMON_PAGE_FROMTEMPLATE and then to COMMON_PAGETPL_LOAD creating a dependency between plugins and specific DokuWiki releases. Two plugins currently support both latest events, one even all three of the events.
Before 2010-03-10 | Last compatible release 2009-12-25c “Lemming” | |
---|---|---|
HTML_PAGE_FROMTEMPLATE | 5 | newpagetemplate, pagetemplate, regex_template, userhomepage, wysiwyg |
During 2010-03-10 – 2011-02-03 | Only compatible with DokuWiki 2010-11-07a “Anteater” | |
COMMON_PAGE_FROMTEMPLATE | 2 | fckglite, newpagetemplate |
Since 2011-02-03 | Compatible with DokuWiki 2011-05-25 “Rincewind” and later | |
COMMON_PAGETPL_LOAD | 2 | fckglite, newpagetemplate |
Non-action plugins
Although mostly used by action_plugins, events can be included in any plugin or template script. The events called by these plugins may not be executed immediately or at all for any given page and execution pathway.
Event | Plugins (other than Action) | |
---|---|---|
TPL_CONTENT_DISPLAY | 1 | fckg |
DOKUWIKI_STARTED | 2 | fckglite, folded |
PARSER_HANDLER_DONE | 1 | folded |
PARSER_METADATA_RENDER | 1 | pageredirect |
Plugin specific events
It is also possible to introduce plugin specific events not included in the events_list as shown by these developers. They may be signaled from the plugin itself or from another plugin.
Undocumented events | Plugins | |
---|---|---|
ACTION_HEADER_SEND | 1 | smartcache |
ACTION_LINKBACK_HAM | 1 | linkback |
ACTION_LINKBACK_RECEIVED | 1 | linkback |
ACTION_LINKBACK_SPAM | 1 | linkback |
FULLTEXT_SNIPPET_GETTEXT | 1 | searchtext |
HTMLOK_ACCESS_EVENT | 1 | htmlokay |
HTML_EDITFORM_INJECTION | 7 | captcha, codehighlight, fckg, fckglite, recaptcha, tagentry, virtualkeyboard |
HTML_REGISTERFORM_INJECTION | 2 | captcha, recaptcha |
HTML_TOC_ITEM | 1 | xhtmlruby |
JQUERY_READY | 3 | googleplusone, jquery, translation2 |
TEMPORARY_CHANGELOG_UPGRADE_EVENT | 1 | importoldchangelog |
TEMPORARY_INDEX_UPGRADE_EVENT | 1 | importoldindex |
TPL_CSS_CACHEOK | 1 | usercss |
TPL_CSS_OUTPUT | 1 | usercss |
DokuWiki events
And now for the complete list of events found at time of survey. Events are merged with the events_list showing 'unused' events. Disclaimer - this list was generated by a script, there may be plugins that are missing.
Continue to ⇒ friendliness