pgsrc/WikiPlugin

   1 Mime-Version: 1.0 (Produced by PhpWiki 1.3.2-jeffs-hacks+carsten's-binary-hack)
   2 X-RCS_ID: $Id: WikiPlugin,v 1.3 2002-01-13 15:55:23 rurban Exp $
   3 Content-Type: application/x-phpwiki;
   4   pagename=WikiPlugin;
   5   flags="";
   6   lastmodified=1010856094;
   7 Content-Transfer-Encoding: binary
   8
   9 The latest hacks include support for !WikiPlugins.
  10
  11 !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.
  12 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.)
  13
  14 !Example
  15
  16 Currently, one invokes a plugin by putting something like:
  17
  18   <?''''plugin !BackLinks?>
  19
  20 into a regular wiki-page.  That particular example produces as list
  21 of pages which link to the current page.  Here it is:
  22
  23 <?plugin BackLinks?>
  24
  25 (This is great for Category and Topic pages.  You can use this to get
  26 an automatic in-line listing of pages in the Category or Topic.)
  27
  28 !Details
  29
  30 (This is all subject to change.)
  31
  32 Plugins can take certain named arguments (most do).
  33 The values of these arguments can be determined four different ways.
  34 In order of precedence:
  35 # The plugin invocation can specify the value for an argument, like so:
  36 ;;: <?''''plugin !BackLinks page=!OtherPage ?>
  37 # 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:
  38 ;;: <?''''plugin !BackLinks page ?>
  39 # Default values specified in the plugin invocation:
  40 ;;: <?''''plugin !BackLinks page||=!OtherPage ?>
  41 # The plugin must supply default values for each argument it uses.  (The BackLinks plugin uses
  42 the current page as the default value for the ''page'' argument.
  43
  44 !Existing Plugins
  45 * BackLinks
  46 * CalendarPlugin
  47 * DebugInfo
  48 * FullTextSearch
  49 * IncludePage
  50 * LikePages
  51 * MostPopular
  52 * PageHistory
  53 * RecentChanges
  54 * text2png
  55 * TitleSearch
  56 * UserPage
  57 * ViewSource
  58 * walkabout
  59
  60 !More Ideas for Plugins
  61 * Integrate Search form with individual InterWiki map entries%%%
  62   e.g. Search Php Website for:[     ] (Search)
  63 * WantedPages, OrphanedPages, other various indexing schemes.
  64 * Diff, PageHistory
  65 * Redirect plugin -- <?''''plugin Redirect target=!OtherPage ?>
  66 * 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.
  67 -----
  68 Pages in this category:
  69 <?plugin BackLinks page=[pagename] noheader=1?>
  70
  71 * FullTextSearch: FindPage
  72 * TitleSearch: LikePages (match_head, match_tail).
  73
  74 -----
  75 PhpWikiDocumentation