pgsrc/Help%2FExternalSearchPlugin

   1 Date: Mon,  1 Jun 2009 15:05:05 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FExternalSearchPlugin;
   6   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
   7   markup=2;
   8   charset=UTF-8
   9 Content-Transfer-Encoding: binary
  10
  11 The **~ExternalSearch** [[Help:WikiPlugin|plugin]] creates a form to query [[Help:InterWiki|InterWikis]] or other internet sites.
  12
  13 == Usage
  14
  15 {{{
  16 <<ExternalSearch
  17          url="InterWiki or URL"
  18          name="button text"
  19 >>
  20 }}}
  21
  22 == Arguments
  23
  24 {| class="bordered"
  25 |-
  26 ! Argument
  27 ! Description
  28 ! Default value
  29 |-
  30 | **url**
  31 | Specify a wiki from the InterWikiMap or a url. Any text entered by
  32 the user will be appended to the search url. The string placeholder
  33 '__=%s=__' can be used to insert a search query into the url rather
  34 than appending it.
  35 |
  36 |-
  37 | **name**
  38 | Text to display in the submit button.
  39 | For ~InterWiki sites the default is the wiki name, for other urls the default is the text "External Search".
  40 |-
  41 | **formsize**
  42 | Specify the input area size.
  43 | 30 characters
  44 |-
  45 | **debug**
  46 | Don't really redirect to the external site, just print out the url that would be redirected to.
  47 |
  48 |}
  49
  50 == Examples
  51
  52 {{{
  53   url="http://sunir.org/apps/meta.pl?"       name="Metawiki Search"
  54   url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search"
  55   url=php-lookup
  56   url=php-function
  57   url=PhpWiki
  58 }}}
  59
  60 Perform a full-text search on multiple wiki's:
  61 <<ExternalSearch url="http://sunir.org/apps/meta.pl?" name="Metawiki Search">>
  62
  63 Perform a full-text search on [[MeatBall:SiteSearch|MeatBall]] wiki:
  64 <<ExternalSearch url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search">>
  65
  66 Search the PHP web site for a function name:
  67 <<ExternalSearch url=php-lookup name="PHP Lookup">>
  68
  69 Enter the name of a PHP function to view the documentation page:%%%
  70 <<ExternalSearch url=php-function>>
  71
  72 Enter any existing page name on ~PhpWiki to jump to that page:
  73 <<ExternalSearch url=PhpWiki>>
  74
  75 <noinclude>
  76 ----
  77 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  78 </noinclude>