event system revision

This is a major revision of DokuWiki's event system. There are changes to class names,
function names, function parameters and their order and event names.

For action plugin

event system revision

This is a major revision of DokuWiki's event system. There are changes to class names,
function names, function parameters and their order and event names.

For action plugin writers the following changes are important:

- <event_name> is no longer signalled, only <event_name>_BEFORE and <event_name>_AFTER.
- note the case change for _BEFORE and _AFTER
- calling stopPropagation while processing a _BEFORE signal no longer prevents an
_AFTER signal. The events _continue value is reset before the _AFTER signal is made.
- events have a new readonly property, canPreventDefault. This lets the event handling
hook know whether or not the event honours preventDefault calls.

- parameters have changed for the register_hook method, parameters are now
$event_name,
$advise (can be 'BEFORE' or 'AFTER')
$object
$method
$param (this parameter is now optional)
- parameter order has changed for the hook event handler callback functions
&$event
$param (can now be left off)

Event names have changed, they are now structured
<dokuwiki name>_<event data name>_<action_name or state if no action>

DOKUWIKI_START

darcs-hash:20060424220152-9b6ab-00e366288f7ec8a85b85dc83694a5f43a07aa082.gz

show more ...

just a few symbols in the picker added

darcs-hash:20060424214448-7ad00-9ddb03ba739930555538c942de12cd28b5ac7097.gz

GeShi Update to 1.0.7.9

darcs-hash:20060424213806-7ad00-05b1ae64e442ef72b94f0cc900530336ea70f3bd.gz

events.php require added to feed.php

darcs-hash:20060419162307-0ad7b-b0d52123d32f81c024a0ac9e336baedff95b8738.gz

inc.lang.it-patch

spelling and gender corrections - added all missing translations
for dir. inc/lang/it

darcs-hash:20060418173433-6f5f9-090be4bcb32b4075358de113941cf491e2cde215.gz

added missing SimplePie.php

darcs-hash:20060418201132-7ad00-fd1a73238470a55a245ee873479fa391a4a4bb53.gz

faroese translation

darcs-hash:20060418183353-7ad00-4a5f2fbe0bf1524cf279d15110d80688d31bfe0f.gz

changed man> interwikilink to reflect recent changes

darcs-hash:20060417164547-7ad00-7270f4d88b027d179b1f600fc347eea8db8a8f83.gz

Allow styles sheets that apply to "all" media

darcs-hash:20060417003153-a90f0-4792fd7b946f62d3696b979f8debfa73587d353a.gz

add missing FeedParser.php #782

darcs-hash:20060417160453-7ad00-e54322159dbe1c1c75cd2c8494fda14a3f4bc021.gz

event ACTION_TEMPLATE minor update

darcs-hash:20060415162247-9b6ab-d6c05736c0e4fb05331bc1cf06e48c5d61c64d5b.gz

events TPL_ACTION_HTML & TPL_DISPLAY_HTML

event TPL_ACTION_HTML
data $ACT
action tpl_content_core (formerly tpl_content)

This event is a wrapper for tpl_content() (now tpl_content_core()) and

events TPL_ACTION_HTML & TPL_DISPLAY_HTML

event TPL_ACTION_HTML
data $ACT
action tpl_content_core (formerly tpl_content)

This event is a wrapper for tpl_content() (now tpl_content_core()) and as such is a
full trigger, meaning it issues three advises:
- TPL_ACTION_HTML_before
- TPL_ACTION_HTML
- TPL_ACTION_HTML_after

Event handlers can output HTML before and/or after the main Dokuwiki page output and
can prevent the default dokuwiki page generation taking place.

Example uses could include:
- replacements for dokuwiki command handlers like index.
- appending a discussion section to the page by handling TPL_ACTION_HTML_after

event TPL_DISPLAY_HTML
data html output produced by tpl_content_core[1]
action send output to browser

Event handlers can post process the HTML output before it is sent to the client
browser. This is a full trigger, meaning it issues three advises
- TPL_DISPLAY_HTML_before
- TPL_DISPLAY_HTML
- TPL_DISPLAY_HTML_after

darcs-hash:20060415160847-9b6ab-d7affcb1aaf49aecfaf9bc1e78a82ceb8ae409f7.gz

show more ...

event SEND_HEADERS

Event data an array of headers dokuwiki will send[1].
The default action is to output all the headers in order using the header() function.

This event is a full trigger, meaning

event SEND_HEADERS

Event data an array of headers dokuwiki will send[1].
The default action is to output all the headers in order using the header() function.

This event is a full trigger, meaning there are three advises:
- SEND_HEADERS_before
- SEND_HEADERS
- SEND_HEADERS_after

Handlers of this event can add/modify/delete the headers in the event data. The event
data must remain an array, even if emptied.

[1] There is one dokuwiki header 'Content-Type: text/html; charset

darcs-hash:20060415160210-9b6ab-841bd034b797c7f1b8d4bbc66f90185a16e5a043.gz

show more ...

add events, DOKUWIKI_START & DOKUWIKI_END

event DOKUWIKI_START

This event is advisory only.
There is no event data
There is no default action

The event is signalled after Dokuwiki has completed it

add events, DOKUWIKI_START & DOKUWIKI_END

event DOKUWIKI_START

This event is advisory only.
There is no event data
There is no default action

The event is signalled after Dokuwiki has completed its initialisation phase and
before it closes the session. Most Dokuwiki globals will have been created and
populated, the global $_SESSION var will still be in existence.

Note: Even after $_SESSION has been closed a plugin can reopen the session to
access session data - as long as headers have not already been sent. For more
information refer to lib/plugins/config/admin.php.

event DOKUWIKI_END

This event is advisory only.
There is no event data
There is no default action

The event is signalled after all processing has been completed as the last thing
doku.php does before exiting. It is possible that under certain circumstances
dokuwiki will exit without returning to doku.php and this event may not then be
signalled.

darcs-hash:20060415152444-9b6ab-1e41d0265f2a6660ad497dd387c7930251dc4030.gz

show more ...

new metadata renderer; functions p_get_metadata() and p_set_metadata()

darcs-hash:20060415104627-283c4-c7d35620fc9dbc21b8a47089692b76d35a9f9ca8.gz

event ACTION_TEMPLATE

This event is advisory only.
Event data is the $ACT variable
The default action is to display an "unknown action" message

The event is triggered by tpl_content if it does not

event ACTION_TEMPLATE

This event is advisory only.
Event data is the $ACT variable
The default action is to display an "unknown action" message

The event is triggered by tpl_content if it does not recognise the $ACT value. It is
the complement to event 'ACTION_DISPATCH'. Handlers of this event can output XHTML
which will be displayed in the main dokuwiki window - ie. where the wiki page would
normally be displayed.

darcs-hash:20060414201705-9b6ab-f8ede6a2fb601d734c115ee09bb57195ad7d1e2b.gz

show more ...

event HANDLER_FINALISED

This event is advisory only.
Event data is the handler object.
There is no default action to prevent.

The event is signalled by the handler during its finalisation of the in

event HANDLER_FINALISED

This event is advisory only.
Event data is the handler object.
There is no default action to prevent.

The event is signalled by the handler during its finalisation of the instruction list.
At the time of signalling the instruction list is complete except for three instrucitons,
meta, document_start & document_end.

Syntax plugins could register for this event to finalise processing of their data knowing
it is complete, e.g. an alternate footnote plugin.

darcs-hash:20060414201101-9b6ab-eba2d096ed3b82e1ec6b24ee90caaa9849f16093.gz

show more ...

add ACTION_DISPATCH event

The 'ACTION_DISPATCH' event[1] is triggered prior to any processing of the $ACT
variable[2]. This gives custom content the opportunity to add new "do" commands
and to proce

add ACTION_DISPATCH event

The 'ACTION_DISPATCH' event[1] is triggered prior to any processing of the $ACT
variable[2]. This gives custom content the opportunity to add new "do" commands
and to process any custom form data.

This event is advisory only (there are no '_before' or '_after' advise)

Preventing default action will skip Dokuwiki's own processing of the $ACT value, this
includes its cleansing of the $ACT variable.

[1] also refer ACTION_TEMPLATE event
[2] $ACT is the do variable from the query string

darcs-hash:20060414195601-9b6ab-8ae62d2c3a7c6f8c09c77436d9adbaba5404f51b.gz

show more ...

action plugins

This patch adds events and a third plugin type, "action" plugins, to DokuWiki.

The patch doesn't include any event signalling, that will be added in later patches.

Action plugins ar

action plugins

This patch adds events and a third plugin type, "action" plugins, to DokuWiki.

The patch doesn't include any event signalling, that will be added in later patches.

Action plugins are loaded before most Dokuwiki processing takes place and at the
same time are given the opportunity to register handlers (or hooks) to receive
specific dokuwiki events.

Other parts of Dokuwiki (e.g. templates and syntax plugins) can also register
handlers to receive events.

Any part of Dokuwiki can create and signal events, including templates and plugins.

This patch also revises the admin plugin class by making it an extension of a
new class, DokuWiki_Plugin. The DokuWiki_Plugin_Action class also extends this
new class.

Further details of events, their signalling and handling, and of action plugins will
be added to wiki.splitbrain.org in due course :-)

darcs-hash:20060414193737-9b6ab-f23d3d9b93e4c50a3ad97ced03eabc6c0363650b.gz

show more ...

relative upper links

Now allows links like [[..:..:page]]

darcs-hash:20060414150358-7ad00-88394caabc6ee2ce7137694e2a0c0c98e7534ea5.gz

magpie files removed

darcs-hash:20060414110517-7ad00-a942f845647f301255365b162a22826cd9a983f6.gz

feed aggregation revamped

Feeds are now parsed with SimplePie. The feed syntax was enhanced

darcs-hash:20060414110047-7ad00-6dd4b96845baab8683a2f837d6ad6fcb2fd53131.gz

consistent filetype icons

Now all filetype icons have the same style and work on light and dark
backgrounds. A test file was added to lib/images/fileicons/index.php

darcs-hash:20060412195703-7ad00-

consistent filetype icons

Now all filetype icons have the same style and work on light and dark
backgrounds. A test file was added to lib/images/fileicons/index.php

darcs-hash:20060412195703-7ad00-4d31a65788e8da0255ea6e064382595e8ae183ff.gz

show more ...

even faster header parsing using strspn

darcs-hash:20060412184125-7ad00-e51f8d531bf3011d230f62cb99fd18de8f150c41.gz

releaxed header syntax

darcs-hash:20060411182721-7ad00-0f34803c6228eb2918f0049284e6290a47ce51bd.gz