====== actionrenderer Plugin ======

---- plugin ----
description: Allow overwriting default XHTML render actions
author     : Andreas Gohr 
email      : andi@splitbrain.org 
type       : renderer
lastupdate : 2022-07-15
compatible : Greebo
depends    : 
conflicts  : 
similar    : 
tags       : xhtml, rendering

downloadurl: https://github.com/splitbrain/dokuwiki-plugin-actionrenderer/zipball/master
bugtracker : https://github.com/splitbrain/dokuwiki-plugin-actionrenderer/issues
sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-actionrenderer/
donationurl: https://donate.dokuwiki.org/actionrenderer

screenshot_img : 
----

This plugin aims to solve the problem, that only one default XHTML renderer can be used, but you sometimes want to overwrite different core renderer behaviors.

This plugin is meant to be registered as default renderer. It then provides an action hook for other plugins to modify the default XHTML behavior.

:!: Installing this plugin may slightly decrease rendering performance.

===== Installation =====

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

Then select this plugin in the [[config:renderer_xhtml|renderer_xhtml]] configuration setting.

Then install plugins making use of this functionality.

===== Developers =====

This plugin triggers an event named ''PLUGIN_ACTIONRENDERER_METHOD_EXECUTE''. It is triggered for each call to a method in the XHTML renderer. You may prevent the default action (which is the appropriate method) in the ''BEFORE'' event. You can also modify the arguments in the ''BEFORE'' event.

The passed ''data'' is an associative array with the following fields:

  * ''method'' (string) the XHTML renderer method to be called
  * ''renderer'' (object) the renderer instance, eg. an instance of this plugin (which inherits from ''Doku_Renderer_xhtml''
  * ''arguments'' (array) the arguments that will be passed to ''method''

===== Plugins using this =====

  * [[autotooltip]] plugin

See also
  * [[codesearch>PLUGIN_ACTIONRENDERER_METHOD_EXECUTE|Code related to the PLUGIN_ACTIONRENDERER_METHOD_EXECUTE event]] used in any DokuWiki's files, plugins and templates