Support HammondWiki. Donate!
PayPal

The latest hacks include support for WikiPlugins.

WikiPlugins allow one to easily add new types of dynamic content (as well as other functionality) to wiki pages within PhpWiki. In this very wiki, the RecentChanges, BackLinks, LikePages and DebugInfo pages are all implemented using plugins.

I expect that the search result pages, as well as much PhpWikiAdministration will soon be implemented via plugins as well. (I think the oh-so-ugly MagicPhpWikiURLs can be replaced by plugins, too.)

Example

Currently, one invokes a plugin by putting something like:

<?plugin BackLinks?>

into a regular wiki-page. That particular example produces as list of pages which link to the current page. Here it is:

8 pages link to WikiPlugin:

(This is great for Category and Topic pages. You can use this to get an automatic in-line listing of pages in the Category or Topic.)

Details

(This is all subject to change.)

Plugins can take certain named arguments (most do). The values of these arguments can be determined four different ways. In order of precedence:

  1. The plugin invocation can specify the value for an argument, like so:

    <?plugin BackLinks page=OtherPage ?>
  2. The argument can be specified via an HTTP query argument. This doesn't happen (is not allowed) unless the argument is mentioned in the plugin invocation:

    <?plugin BackLinks page ?>
  3. Default values specified in the plugin invocation:

    <?plugin BackLinks page||=OtherPage ?>
  4. The plugin must supply default values for each argument it uses. (The BackLinks plugin uses the current page as the default value for the page argument.

Existing Plugins

More Ideas for Plugins


Pages in this category:


PhpWikiDocumentation

The content of this page is Copyright (C) 2000, 2001, 2002 Geoffrey T. Dairiki and the other authors of the content, whoever they may be.
This is free information and you are welcome redistribute it under certain conditions; see http://www.dairiki.org/HammondWiki/opl.html for details.
Absolutely no warrantee is made as to the correctness of the information on this page.