1 rizwank 1.1 %META:TOPICINFO{author="PeterThoeny" date="1097558542" format="1.0" version="1.2"}%
 2             %META:TOPICPARENT{name="WebSearch"}%
 3             ---+!! Search Help
 4             
 5             %TOC%
 6             
 7             ---++ Basic Search Form
 8             
 9             The WebSearch form offers basic search features:
10             	* Search field: Enter one or more keywords
11             	* All webs flag: Check the flag if you want to search all public webs, not just the current web
12             	* Scope: Select if you want to search the topic title, text body or both
13             
14             The search is keyword based like in a typical search engine:
15             	* Specify word(s) you want to find
16             	* Multiple words form an *AND* search, =intranet web service= returns all pages that have the three words anywhere in the page
17             	* Optionally specify plus signs for *AND* search, like =intranet +web +service=
18             	* Enclose words in double quotes to form a *literal search*, like ="web service"=
19             	* Specify a minus sign to *exclude* a word, like =soap -shampoo=
20             	* Use double quotes if you want to search for a leading minus sign, like ="-nowarn"=
21             	* *Stop words* are excluded from a keyword search:
22 rizwank 1.1 		* Stop words are common words and characters such as ="how"= and ="where"=, defined in the SEARCHSTOPWORDS setting in the TWikiPreferences
23             		* If you want to search for a word in the stop word list, prefix the word with a plus sign
24             	* *Example:* To search for all topics that contain ="SOAP"=, ="WSDL"=, a literal ="web service"=, but not ="shampoo"=,%BR% enter this: =soap +wsdl "web service" -shampoo=
25             
26             ---++ Advanced Search Form
27             
28             The WebSearchAdvanced form offers more control over search.
29             
30             TWiki supports three types of searches:
31             	* =keyword=: The basic search type
32             	* =literal=: Simple search where text is searched literally
33             	* =regex=: A RegularExpression search for power users
34             
35             TWiki's regex search is a set of regular expression patterns:
36             	* Patterns are delimited by a semicolon
37             	* An AND search is performed for the list of patterns
38             	* An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like =!web service=
39             	* If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like =\!shampoo=
40             	* *Example:* To search for all topics that contain ="SOAP"=, ="WSDL"=, a literal ="web service"=, but not ="shampoo"=,%BR% enter this: =soap;wsdl;web service;!shampoo=
41             
42             ---++ Formatted Searches
43 rizwank 1.1 
44             You can embed a nicely [[FormattedSearch][formatted search]] in a topic by using the =[[TWikiSearch][%<nop>SEARCH{}%]]= variable described in TWikiVariables.
45             
46             ---++ Search Preferences
47             
48             The TWikiPreferences has these settings:
49             
50             	* =SEARCHDEFAULTTTYPE=: Default search type for search forms which calls the =search= script
51             	* =SEARCHVARDEFAULTTYPE=: Default search type for =%<nop>SEARCH{}= variable
52             	* =SEARCHSTOPWORDS=: List of stop words
53             
54             -- TWiki:Main.PeterThoeny - 18 Jan 2004
55