View Source: WikiPlugin - Waikato Linux Users Group

You are viewing an old revision of this page. View the current version.
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:

  <verbatim>
  <?plugin BackLinks?>
  </verbatim>

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

<?plugin BackLinks?>

(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 value for an argument can be determined four different ways; in order of precedence:

* The plugin invocation can specify the value for an argument, like so:
  <verbatim>
  <?plugin BackLinks page=OtherPage ?>
  </verbatim>

* 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:
  <verbatim>
  <?plugin BackLinks page ?>
  </verbatim>

* Default values specified in the plugin invocation:
  <verbatim>
  <?plugin BackLinks page||=OtherPage ?>
  </verbatim>

* 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
* BackLinks
* CalendarPlugin
* DebugInfo
* FullTextSearch: FindPage
* IncludePage
* LikePages
* MostPopular
* OldStyleTablePlugin
* PageHistory
* RecentChanges
* text2png
* TitleSearch: LikePages (match_head, match_tail).
* ViewSource
* walkabout
* ~RedirectTo -- <tt><?''''plugin ~RedirectTo page=~OtherPage ?></tt> (or href=[URL])
* ~WlugWantedPages (used on the WantedWikis page)

!More Ideas for Plugins
* Integrate Search form with individual InterWiki map entries%%%
  e.g. Search Php Website for:[     ] (Search)
* OrphanedPages, other various indexing schemes.
* Diff, PageHistory
* Insert [XML]/[RSS]/[RDF] news content from location=xxx where location is a parameter to the plugin, maybe include some formatting control of the output generated.

-----
PhpWikiDocumentation
5 pages link to WikiPlugin:
Version 6, saved on Saturday, May 7, 2005 8:54:59 am by AristotlePagaltzis
Edit PageHistory Diff Info LikePages