Diff: Help/ExternalSearchPlugin

Differences between current version and predecessor to the previous major change of Help/ExternalSearchPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,60 +1,75 @@
-!! Synopsis  
+The **~ExternalSearch** [[Help:WikiPlugin|plugin]] creates a form to query [[Help:InterWiki|InterWikis]] or other internet sites.  
  
-The ExternalSearchPlugin creates a form to query InterWiki~s or other  
-internet sites.  
+== Usage ==  
  
-!! Typical Usage  
-<verbatim>  
- <?plugin ExternalSearch 
+{{{  
+<<ExternalSearch 
  url="InterWiki or URL" 
  name="button text" 
-? >  
-</verbatim > 
+>>  
+}}}  
  
+== Arguments ==  
  
-!! Arguments  
-__ url__:  
- Specify a wiki from the InterWikiMap or a url . Any text entered by  
- the user will be appended to the search url . The string placeholder  
- '__= %s=__ ' can be used to insert a search query into the url rather  
- than appending it. 
+{| class="bordered"  
+|-  
+ ! Argument  
+ ! Description  
+! Default value  
+|-  
+| ** url**  
+| Specify a wiki from the [[ InterWikiMap]] or a URL . Any text entered by  
+the user will be appended to the search URL . The string placeholder  
+'##** %s**## ' can be used to insert a search query into the URL rather  
+than appending it.  
+|  
+|-  
+| **name**  
+| Text to display in the submit button.  
+| For ~InterWiki sites the default is the wiki name, for other URLs the default is the text “External Search”.  
+|-  
+| **formsize**  
+| Specify the input area size.  
+| 30 characters  
+|-  
+| **debug**  
+| Boolean. If true, don't really redirect to the external site, just print out the URL that would be redirected to.  
+| false  
+|}  
  
-__name__:  
- Text to display in the submit button. For InterWiki sites the  
- default is the wiki name, for other urls the default is the text  
- "External Search".  
+== Examples ==  
  
-__formsize__:  
- Specify the input area size. (default: 30 characters)  
-  
-__debug__:  
- Don't really redirect to the external site, just print out the url  
- that would be redirected to.  
-  
-  
-!! Examples  
-  
-<verbatim>  
+{{{  
  url="http://sunir.org/apps/meta.pl?" name="Metawiki Search" 
  url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search" 
  url=php-lookup 
  url=php-function 
  url=PhpWiki 
-</verbatim>  
+}}}  
  
 Perform a full-text search on multiple wiki's: 
-<?plugin ExternalSearch url="http://sunir.org/apps/meta.pl?" name="Metawiki Search" ? > 
+<< ExternalSearch url="http://sunir.org/apps/meta.pl?" name="Metawiki Search"> > 
  
-Perform a full-text search on Help:l | MeatBall:SiteSearch] wiki:  
-<?plugin ExternalSearch url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search" ? > 
+Perform a full-text search on [[ MeatBall:SiteSearch|MeatBall] ] wiki:  
+<< ExternalSearch url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search"> > 
  
 Search the PHP web site for a function name: 
-<?plugin ExternalSearch url=php-lookup name="PHP Lookup" ? > 
+<< ExternalSearch url=php-lookup name="PHP Lookup">>  
+  
+Enter the name of a PHP function to view the documentation page:  
+<<ExternalSearch url=php-function>>  
+  
+Enter any existing page name on ~PhpWiki to jump to that page:  
+<<ExternalSearch url=PhpWiki> > 
  
-Enter the name of a PHP function to view the documentation page :%%%  
-<?plugin ExternalSearch url=php-function ?>  
+== See Also ==  
+* [[Help :TitleSearchPlugin]]  
+* [[Help:FullTextSearchPlugin]]  
+* [[Help:InterWikiSearchPlugin]]  
+* [[Help:LinkSearchPlugin]]  
+* [[Help:SemanticSearchPlugin]]  
  
-Enter any existing page name on PhpWiki to jump to that page:  
- <?plugin ExternalSearch url=PhpWiki ? > 
+<noinclude > 
 ---- 
-PhpWikiDocumentation Help:WikiPlugin  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The ExternalSearch plugin creates a form to query InterWikis or other internet sites.

Usage

<<ExternalSearch
         url="InterWiki or URL"
         name="button text"
>>

Arguments

Argument

Description

Default value

url

Specify a wiki from the InterWikiMap or a URL. Any text entered by the user will be appended to the search URL. The string placeholder '%s' can be used to insert a search query into the URL rather than appending it.

name

Text to display in the submit button.

For InterWiki sites the default is the wiki name, for other URLs the default is the text “External Search”.

formsize

Specify the input area size.

30 characters

debug

Boolean. If true, don't really redirect to the external site, just print out the URL that would be redirected to.

false

Examples

  url="http://sunir.org/apps/meta.pl?"       name="Metawiki Search"
  url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search"
  url=php-lookup
  url=php-function
  url=PhpWiki

Perform a full-text search on multiple wiki's:

Perform a full-text search on MeatBall wiki:

Search the PHP web site for a function name:

Enter the name of a PHP function to view the documentation page:

Enter any existing page name on PhpWiki to jump to that page:

See Also