Diff: Help/TitleSearchPlugin

Differences between current version and previous revision of Help/TitleSearchPlugin.

Other diffs: Previous Major 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,27 +1,76 @@
-_short description_  
+The **~TitleSearch** [[Help:WikiPlugin|plugin]] displays results of pagename search.  
  
-! Usage  
-<verbatim>  
- <?plugin TitleSearch ?>  
-</verbatim>  
+If only one page is found and auto_redirect is true, this page is displayed immediately,  
+otherwise the found page list is displayed.  
  
-! Arguments  
+== Usage ==  
+{{{  
+<?plugin-form TitleSearch arguments ?>  
+}}}  
  
-page _(default: current pagename)_:  
- The page to execute upon.  
+== Arguments ==  
  
-! Example  
+All [[Help:PageList|PageList]] arguments (except //paganame//),  
+plus the following ones:  
  
-<verbatim>  
-<?plugin TitleSearch ?>  
-< /verbatim>  
+{| class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| **s**  
+| String to search  
+| //none//  
+|-  
+| **auto_redirect**  
+| Boolean. If true and only one page is found, this page is displayed immediately  
+| false  
+|-  
+| **noheader**  
+| Boolean. If true, header should be omitted.  
+| false  
+|-  
+| **exclude**  
+| Comma-separated list of pages to exclude  
+| false  
+|-  
+| **info**  
+| Info to display in the table  
+| false  
+|-  
+| **case_exact**  
+| Boolean. If true, search with case exact.  
+| false  
+|-  
+| **regex**  
+| Type of regular expression used for searching  
+| auto  
+|-  
+| **format**  
+|  
+| false  
+|}  
  
-<?plugin TitleSearch ?>  
+== Example ==  
  
-! Author  
-PhpWiki:ReiniUrban  
+{{{  
+<?plugin-form TitleSearch ?>  
+}}}  
  
-! See Also  
+<?plugin-form TitleSearch ?>  
  
+== Author ==  
+* [[Help:Reini Urban|Reini Urban]]  
+  
+== See Also ==  
+* [[Help:FullTextSearchPlugin]]  
+* [[Help:ExternalSearchPlugin]]  
+* [[Help:InterWikiSearchPlugin]]  
+* [[Help:LinkSearchPlugin]]  
+* [[Help:SemanticSearchPlugin]]  
+  
+<noinclude>  
 ---- 
-PhpWikiDocumentation Help:WikiPlugin  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The TitleSearch plugin displays results of pagename search.

If only one page is found and auto_redirect is true, this page is displayed immediately, otherwise the found page list is displayed.

Usage

<?plugin-form TitleSearch arguments ?>

Arguments

All PageList arguments (except paganame), plus the following ones:

Argument

Description

Default value

s

String to search

none

auto_redirect

Boolean. If true and only one page is found, this page is displayed immediately

false

noheader

Boolean. If true, header should be omitted.

false

exclude

Comma-separated list of pages to exclude

false

info

Info to display in the table

false

case_exact

Boolean. If true, search with case exact.

false

regex

Type of regular expression used for searching

auto

format

false

Example

<?plugin-form TitleSearch ?>

Author

See Also