pgsrc/Help%2FExternalSearchPlugin

   1 Date: Fri, 3 Jan 2003 22:00:00 -0500
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.4)
   3 X-Rcs-Id: $Id: Help%2FExternalSearchPlugin,v 1.1 2005-11-21 22:19:00 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FExternalSearchPlugin;
   6   flags=PAGE_LOCKED;
   7   pgsrc_version="2 $Revision: 1.1 $";
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 !! Synopsis
  13
  14 The ExternalSearchPlugin creates a form to query InterWiki~s or other
  15 internet sites.
  16
  17 !! Typical Usage
  18 <verbatim>
  19 <?plugin ExternalSearch
  20          url="InterWiki or URL"
  21          name="button text"
  22 ?>
  23 </verbatim>
  24
  25
  26 !! Arguments
  27 __url__:
  28   Specify a wiki from the InterWikiMap or a url. Any text entered by
  29   the user will be appended to the search url. The string placeholder
  30   '__=%s=__' can be used to insert a search query into the url rather
  31   than appending it.
  32
  33 __name__:
  34   Text to display in the submit button. For InterWiki sites the
  35   default is the wiki name, for other urls the default is the text
  36   "External Search".
  37
  38 __formsize__:
  39   Specify the input area size. (default: 30 characters)
  40
  41 __debug__:
  42   Don't really redirect to the external site, just print out the url
  43   that would be redirected to.
  44
  45
  46 !! Examples
  47
  48 <verbatim>
  49   url="http://sunir.org/apps/meta.pl?"       name="Metawiki Search"
  50   url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search"
  51   url=php-lookup
  52   url=php-function
  53   url=PhpWiki
  54 </verbatim>
  55
  56 Perform a full-text search on multiple wiki's:
  57 <?plugin ExternalSearch url="http://sunir.org/apps/meta.pl?" name="Metawiki Search" ?>
  58
  59 Perform a full-text search on  Help:l |MeatBall:SiteSearch] wiki:
  60 <?plugin ExternalSearch url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search" ?>
  61
  62 Search the PHP web site for a function name:
  63 <?plugin ExternalSearch url=php-lookup name="PHP Lookup" ?>
  64
  65 Enter the name of a PHP function to view the documentation page:%%%
  66 <?plugin ExternalSearch url=php-function ?>
  67
  68 Enter any existing page name on PhpWiki to jump to that page:
  69 <?plugin ExternalSearch url=PhpWiki ?>
  70 ----
  71 PhpWikiDocumentation Help:WikiPlugin