Diff: Help/FullTextSearchPlugin
Note: You are viewing an old revision of this page. View the current version.
Differences between version 4 and previous revision of Help/FullTextSearchPlugin.
Other diffs: Previous Major Revision, Previous Author
Newer page: | version 4 | Last edited on 22 May 2014 3:01 | by harold | Revert |
Older page: | version 3 | Last edited on 9 September 2007 0:16 | by harold | Revert |
@@ -1,27 +1,70 @@
-_short description_
+The **~FullTextSearch** [[Help:WikiPlugin|plugin]] searches the content of all pages in this wiki.
-!
Usage
-<verbatim>
-
<?plugin
FullTextSearch ?
>
-</verbatim>
+==
Usage ==
+{{{
+<<
FullTextSearch arguments>
>
+}}}
-!
Arguments
+==
Arguments ==
-page _(default
: current pagename)_
:
- The page to execute upon.
+All [[Help
:PageList|PageList]] arguments, plus the following ones
:
-! Example
+{| class="bordered"
+|-
+
! Argument
+! Description
+! Default value
+|-
+| **s**
+| The search term
+| //none//
+|-
+| **hilight**
+| Highlight results (boolean)
+| true
+|-
+| **case_exact**
+| Search with case exact (boolean)
+| false
+|-
+| **regex**
+| Type of regular expression used for searching
+| auto
+|-
+| **sortby**
+| Sorting order for results
+| ~-hi_content
+|-
+| **noheader**
+| Do not display header (boolean)
+| false
+|-
+| **exclude**
+| Comma-separated list of glob to exclude
+| false
+|-
+| **quiet**
+| Be less verbose (boolean)
+| true
+|}
-<verbatim>
-<?plugin FullTextSearch ?>
-</verbatim>
+== Example ==
-<?plugin
FullTextSearch ?
>
+{{{
+<
<FullTextSearch>>
+}}}
-! Author
-PhpWiki:ReiniUrban
+<<FullTextSearch>>
-! See Also
+== Author ==
+* [[Help:Reini Urban|Reini Urban]]
+== See Also ==
+* [[Help:TitleSearchPlugin]]
+* [[Help:ExternalSearchPlugin]]
+* [[Help:InterWikiSearchPlugin]]
+
+<noinclude>
----
-PhpWikiDocumentation Help:WikiPlugin
+[[
PhpWikiDocumentation]] [[CategoryWikiPlugin]]
+</noinclude>
version 4
The FullTextSearch plugin searches the content of all pages in this wiki.
Usage
<<FullTextSearch arguments>>
Arguments
All PageList arguments, plus the following ones:
Argument |
Description |
Default value |
---|---|---|
s |
The search term |
none |
hilight |
Highlight results (boolean) |
true |
case_exact |
Search with case exact (boolean) |
false |
regex |
Type of regular expression used for searching |
auto |
sortby |
Sorting order for results |
-hi_content |
noheader |
Do not display header (boolean) |
false |
exclude |
Comma-separated list of glob to exclude |
false |
quiet |
Be less verbose (boolean) |
true |
Example
<<FullTextSearch>>
You must enter a search term.