Package TWiki::UI::Search

UI functions for searching.

StaticMethod search ($session)

Perform a search as dictated by CGI parameters:

Parameter:Sorted ascending Description: Default:
"text" Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more required
bookview="on" BookView search, e.g. show complete topic text Show topic summary
casesensitive="on" Case sensitive search Ignore case
date="..." limits the results to those pages with latest edit time in the given TimeInterval . All results
excludetopic="Web*"
excludetopic="WebHome, WebChanges"
Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
expandvariables="on" Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}% instead of the formula Raw text
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
limit="all"
limit="16"
Limit the number of results returned. This is done after sorting if order is specified All results
multiple="on" Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search Only one hit per topic
noempty="on" Suppress results for webs that have no hits. Show webs with no hits
nofinalnewline="on" If on, the search variable does not end in a line by itself. Any text continuing immediately after the search tag on the same line will be rendered as part of the table generated by the search, if appropriate. off
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nonoise="on" Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on" Off
nosearch="on" Suppress search string Show search string
nosummary="on" Show topic title only Show topic summary
nototal="on" Do not show number of topics found Show number
order="topic"
order="created"
order="modified"
order="editby"
order=
 "formfield(name)"
Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort Sort by topic name
reverse="on" Reverse the direction of the search Ascending search
scope="topic"
scope="text"
scope="all"
Search topic name (title); the text (body) of topic; or all (both) "text"
search="text" (Alternative to above) N/A
separator=", " Line separator between hits Newline "$n"
topic="WebPreferences"
topic="*Bug"
Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
type="keyword"
type="literal"
type="regex"
Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
web="Name"
web="Main, Know"
web="all"
Comma-separated list of webs to search. The special word all means all webs that doe not have the NOSEARCHALL variable set to on in their WebPreferences. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb". Current web
zeroresults="off" Suppress all output if there are no hits zeroresults="on", displays: "Number of topics: 0"

Topic revision: r3 - 2008-01-21 - 19:21:33 - TWikiContributor
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiUISearchDotPm