Diff: Help/ExternalSearchPlugin
Note: You are viewing an old revision of this page. View the current version.
Differences between version 3 and predecessor to the previous major change of Help/ExternalSearchPlugin.
Other diffs: Previous Revision, Previous Author
Newer page: | version 3 | Last edited on 9 September 2007 0:16 | by harold | Revert |
Older page: | version 2 | Last edited on 22 May 2014 3:01 | by harold | Revert |
@@ -1,74 +1,60 @@
-The **~ExternalSearch** [[Help:WikiPlugin|plugin]] creates a form to query [[Help:InterWiki|InterWikis]] or other internet sites.
+!! Synopsis
-== Usage ==
+The ExternalSearchPlugin creates a form to query InterWiki~s or other
+internet sites.
-{{{
-<<ExternalSearch
+!! Typical Usage
+<verbatim>
+
<?plugin
ExternalSearch
url="InterWiki or URL"
name="button text"
->
>
-}}}
+?
>
+</verbatim>
-== Arguments ==
-{| 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**
-| Don't really redirect to the external site, just print out the url that would be redirected to.
-|
-|}
+!! 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.
-== Examples ==
+__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. (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:
-<<
ExternalSearch url="http://sunir.org/apps/meta.pl?" name="Metawiki Search">
>
+<?plugin
ExternalSearch url="http://sunir.org/apps/meta.pl?" name="Metawiki Search" ?
>
-Perform a full-text search on [[MeatBall
:SiteSearch
|MeatBall]
] wiki:
-<<
ExternalSearch url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall 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" ?
>
Search the PHP web site for a function name:
-<<
ExternalSearch url=php-lookup name="PHP Lookup">
>
+<?plugin
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>>
-
-== See Also ==
-* [[Help:TitleSearchPlugin]]
-* [[Help:FullTextSearchPlugin]]
-* [[Help:ExternalSearchPlugin]]
-* [[Help:InterWikiSearchPlugin]]
+<?plugin
ExternalSearch url=php-function ?
>
-<noinclude
>
+Enter any existing page name on PhpWiki to jump to that page:
+
<?plugin ExternalSearch url=PhpWiki ?
>
----
-[[
PhpWikiDocumentation]] [[CategoryWikiPlugin]]
-</noinclude>
+PhpWikiDocumentation Help:WikiPlugin
version 3
Synopsis
The ExternalSearchPlugin creates a form to query InterWikis or other internet sites.
Typical Usage
<?plugin ExternalSearch url="InterWiki or URL" name="button text" ?>
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.
- 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. (default: 30 characters)
- debug
- Don't really redirect to the external site, just print out the url that would be redirected to.
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 Help:l |MeatBall:SiteSearch] 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: