DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

Our Privacy Policy

devel:plugin_survey:events

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.

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.

Event Plugins
ACTION_ACT_PREPROCESS 67 404manager, adminhomepage, autosearch, autostart, blog, blogtng, bookcreator, captcha, cite, conflictmerger, data, diffpreview, discussion, distribute, do, dokubookmark, dokugource, dokusioc, dw2pdf, edittable, editx, eventline, farm, favoris, fckw, googlesearch, hipchat, html2pdf, iptrust, issuetracker, linkback, listeabo, log, login_redirector, loglog, logoutconvenience, lytebox, mailto, message, multilingual, mypage, new_page_dialog, notfound, noticeboard, nsexport, openid, phpbblinks, preservefilenames, projects, pxxo, rater, recaptcha, saveandedit, searchformgoto, semanticdata, sendpagecontent, siteexport, spatialhelper, starred, supa, svgedit, tag, task, templateconfhelper, userhomepage, userpagecreate, userspagecreate
ACTION_EXPORT_POSTPROCESS not found in any examined plugin
ACTION_HANDLE_SUBSCRIBE not found in any examined plugin
ACTION_HEADERS_SEND 11 blogtng, cspheader, directions, linkback, logstats, nftr, noticeboard, random_page, showinitpage, upload, zenlogin
ACTION_HEADER_SEND 1 smartcache
ACTION_LINKBACK_HAM 1 linkback
ACTION_LINKBACK_RECEIVED 1 linkback
ACTION_LINKBACK_SPAM 1 linkback
ACTION_SHOW_REDIRECT 5 dokusioc, edittable, include, mediasyntax, wikicalendar
AJAX_CALL_UNKNOWN 21 ac, ajaxloader, blogtng, bureaucracy, data, discussion, do, fckw, freesync, lastfm, nsexport, popupviewer, preservefilenames, refnotes, securelogin, semanticdata, siteexport, snippets, starred, translator, twistienav
AUTH_LOGIN_CHECK 3 maintenancemessage, securelogin, zenlogin
AUTH_USER_CHANGE 1 zenlogin
COMMON_NOTIFY_ADDRESSLIST not found in any examined plugin
COMMON_PAGETPL_LOAD 2 fckglite, newpagetemplate
COMMON_PAGE_FROMTEMPLATE 2 fckglite, newpagetemplate
COMMON_WORDBLOCK_BLOCKED not found in any examined plugin
DOKUWIKI_DONE 2 cronojob, news
DOKUWIKI_STARTED 40 aceeditor, anonip, autoindentcontrol, badbehaviour, blogtng, crypto, cryptsign, do, editsections, fancysearch, fckg, fckglite, fckw, flex, imageflow, ipban, ipgroup, keywordvoting, loadskin, mredirect, multilingual, newpagetemplate, nohighlight, openas, pageredirect, publish, redirect, scrum, shorturl, siteexport, skydoku, smartcache, translation, translation2, translation3, translator, userspagecreate, virtualgroup, vkeyboard, wikicalendar
FEED_DATA_PROCESS not found in any examined plugin
FEED_ITEM_ADD 4 blog, blogtng, feedmod, mailrss
FEED_MODE_UNKNOWN 1 blogtng
FEED_OPTS_POSTPROCESS 3 blogtng, feedauth, ipgroup
FETCH_MEDIA_STATUS 3 projects, siteexport, templateconfhelper
FULLTEXT_SNIPPET_CREATE 3 asiansearch, nohighlight, searchcombinedgoogle
FULLTEXT_SNIPPET_GETTEXT 1 searchtext
HTMLOK_ACCESS_EVENT 1 htmlokay
HTML_CONFLICTFORM_OUTPUT 2 include, mediasyntax
HTML_DRAFTFORM_OUTPUT 2 include, mediasyntax
HTML_EDITFORM_INJECTION 7 captcha, codehighlight, fckg, fckglite, recaptcha, tagentry, virtualkeyboard
HTML_EDITFORM_OUTPUT 17 blogtng, captcha, codehighlight, conflictmerger, diffpreview, fckg, fckglite, include, linkback, lists_improved, mediasyntax, noticeboard, publish, recaptcha, saveandedit, tagentry, wikicalendar
HTML_EDIT_FORMSELECTION 3 data, edittable, semanticdata
HTML_LOGINFORM_OUTPUT 1 openid
HTML_PAGE_FROMTEMPLATE 5 newpagetemplate, pagetemplate, regex_template, userhomepage, wysiwyg
HTML_RECENTFORM_OUTPUT 1 publish
HTML_REGISTERFORM_INJECTION 2 captcha, recaptcha
HTML_REGISTERFORM_OUTPUT 2 captcha, recaptcha
HTML_RESENDPWDFORM_OUTPUT not found in any examined plugin
HTML_REVISIONSFORM_OUTPUT 1 publish
HTML_SECEDIT_BUTTON 5 data, editsections, edittable, include, semanticdata
HTML_SUBSCRIBEFORM_OUTPUT not found in any examined plugin
HTML_TOC_ITEM 1 xhtmlruby
HTML_UPDATEPROFILEFORM_OUTPUT 1 openid
HTML_UPLOADFORM_OUTPUT 1 archiveupload
HTTPCLIENT_REQUEST_SEND not found in any examined plugin1)
INDEXER_PAGE_ADD 4 discussion, searchtext, spatialhelper, subjectindex
INDEXER_TASKS_RUN 4 clearhistory, popularity, qc, safefnrecode
INDEXER_TEXT_PREPARE not found in any examined plugin
INDEXER_VERSION_GET not found in any examined plugin
IO_NAMESPACE_CREATED 1 projects
IO_NAMESPACE_DELETED 1 projects
IO_WIKIPAGE_READ 2 fckg, wysiwyg
IO_WIKIPAGE_WRITE 20 autolink2, autolink3, autotweet, daftdrafts, data, distributedacl, do, dokugource, geotag, gtime, indexmenu, listeabo, projects, publish, semanticdata, spatialhelper, tag, underconstruction, wikisign, wysiwyg
JQUERY_READY 3 googleplusone, jquery, translation2
MAIL_MESSAGE_SEND 1 swiftmail
MEDIAMANAGER_CONTENT_OUTPUT 4 imageshack, mediarename, preservefilenames, supa
MEDIAMANAGER_STARTED 4 imageshack, ipgroup, preservefilenames, supa
MEDIA_DELETE_FILE 2 dlcount, preservefilenames
MEDIA_SENDFILE 5 dlcount, ireflect, preservefilenames, siteexport, svgimg2
MEDIA_UPLOAD_FINISH 3 archiveupload, dlcount, preservefilenames
PARSER_CACHE_USE 25 changes, datatemplate, dwcommits, editsections, fckg, fckglite, htmlokay, include, indexmenu, indexmenu2, lightbox, log, mediasyntax, navi, odp, odt, prolog, qna, qstat, randominc, refnotes, sos, source, twitter, upload
PARSER_HANDLER_DONE 15 columns, editsections, fckg, folded, include, inlineeditor, linebreak, macros, mediasyntax, preservefilenames, qna, quickedit, refnotes, tabtables, uparrow
PARSER_METADATA_RENDER 7 blogtng, daftdrafts, include, mediasyntax, pageredirect, projects, underconstruction
PARSER_WIKITEXT_PREPROCESS 8 autolink2, hiddenheader, linebreak, macros, markdownextra, mytemplate, relativelinks, tabtables
PLUGIN_CONFIG_PLUGINLIST not found in any examined plugin
PLUGIN_PLUGINMANAGER_PLUGINLIST not found in any examined plugin
RENDERER_CONTENT_POSTPROCESS 9 hiddenheader, hyphenation, inlinetoc, linkback, oddeven, preservefilenames, tablewidth, userspagecreate, xhtmlruby
SEARCH_QUERY_FULLPAGE 5 asiansearch, nohighlight, nssearch, searchcombinedgoogle, searchstats
SEARCH_QUERY_PAGELOOKUP 4 ipgroup, nssearch, translation, translation3
SITEMAP_GENERATE 1 spatialhelper
SITEMAP_PING 1 spatialhelper
TEMPORARY_CHANGELOG_UPGRADE_EVENT 1 importoldchangelog
TEMPORARY_INDEX_UPGRADE_EVENT 1 importoldindex
TOOLBAR_DEFINE 41 alignment, bahnde, barcode, blockquote, codebutton, codebutton2, codebutton_ext, colorpicker, creole, crypto, custombuttons, daftdrafts, discussion, divalign2, edittable, eventum, fontcolor, fontsize2, formatplus, geotag, googlechart, highlightjs, imageflow, itrackviewer, jalbum, keyboard, mediasyntax, newline, noprint, openlayersmap, orgapp, plantuml, snippets, stars2, symbols, tableedit, tag, todo, translatebutton, underconstruction, wrap
TPL_ACT_RENDER 39 404manager, animation, asiansearch, bloglinks, blogmeta, blogtng, bookcreator, bookmarkme, classificationbanner, daftdrafts, database, discussion, editx, farm, fckg, fckglite, fckw, force_preview, fullindex, gtime, indexmenu, indexmenu2, linkback, maintenancemessage, noticeboard, ondeniedlogin, pageredirect, projects, publish, searchformgoto, sidebar, skydoku, syntaxhighlighter2, syntaxhighlighter3, tagging, toc, tools, userannotations, vkeyboard
TPL_ACT_UNKNOWN 17 adminhomepage, cite, conflictmerger, diffpreview, editx, favoris, googlesearch, issuetracker, listeabo, mailto, mypage, nsexport, openid, rater, sendpagecontent, spatialhelper, tag
TPL_CONTENT_DISPLAY 25 autoincludeindex, dblclickedit, divalign2, dlcount, docsearch, fckg, fckglite, fontface, highlightjs, indexmenu, loadskin, lytebox, maintenancemessage, modalpopup, newpagetemplate, noiewarning, notfound, pagetemplater, pdfex, showlogin, showlogin2, sidebarng, sphinxsearch, stats, toc
TPL_CSS_CACHEOK 1 usercss
TPL_CSS_OUTPUT 1 usercss
TPL_IMG_DISPLAY not found in any examined plugin
TPL_METAHEADER_OUTPUT 68 aceeditor, animation, asciimath, autlogin, badbehaviour, bloglinks, blogtng, code3, codehighlight, crypto, description, discussion, dokumicrobugtracker, dokureflection, dokusioc, encryptedpasswords, eventline, facebook, facebooklike, farm, fbcomments, fckg, fckglite, fckw, fontface, geotag, googleanalytics, googlemap3, googleplusone, grclip, indexmenu, indexmenu2, inlinetoc, jquery-syntax, jquery, keywords, linkback, loadskin, lytebox, mathjax, meta_yaml, metaheaders, multitemplate_styleman, new_page_dialog, nftr, oiddelegate, openlayersmap, operawidget, osm, permissionstyles, pxxo, referrers, refnotes, scriptheader, skydoku, statistics, syntaxhighlighter, syntaxhighlighter2, syntaxhighlighter3, tableedit, tag, translatebutton, userfly, virtualkeyboard, vkeyboard, webmaster, wysiwyg, yahoomediaplayer
TPL_TOC_RENDER 2 discussion, hiddenheader
XMLRPC_CALLBACK_REGISTER not found in any examined plugin

Continue to ⇒ friendliness

devel/plugin_survey/events.txt · Last modified: 2012-07-20 14:37 by Klap-in