View Source: WikiPlugin - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

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.

!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

Plugins can take certain named arguments (most do). The values of these arguments 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.

!Existing Plugins

Some of these plugins are documented on their respective pages. In other cases, look at the page source to see how to use it.

* BackLinks
* CalendarPlugin
* DebugInfo
* FullTextSearch
* LikePages
* MostPopular
* PageHistory
* RecentChanges
* text2png
* TitleSearch
* walkabout

-----
PhpWikiDocumentation

5 pages link to WikiPlugin:

Last edited on Monday, June 22, 2009 11:53:46 pm by AristotlePagaltzis

Edit PageHistory Diff Info LikePages