data/TWiki/SearchHelp.txt
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/SearchHelp.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,46 @@
     1.4 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
     1.5 +%META:TOPICPARENT{name="WebSearch"}%
     1.6 +---+!! Search Help
     1.7 +
     1.8 +%TOC%
     1.9 +
    1.10 +---++ Search Pages
    1.11 +
    1.12 +There are two search pages; WebSearch offers basic search features, while
    1.13 +WebSearchAdvanced offers more control over searches.
    1.14 +
    1.15 +By default searches are keyword based like in a typical search engine:
    1.16 +   * Specify word(s) you want to find
    1.17 +   * Multiple words form an *AND* search, =intranet web service= returns all pages that have the three words anywhere in the page
    1.18 +   * Optionally specify plus signs for *AND* search, like =intranet +web +service=
    1.19 +   * Enclose words in double quotes to form a *literal search*, like ="web service"=
    1.20 +   * Specify a minus sign to *exclude* a word, like =soap -shampoo=
    1.21 +   * Use double quotes if you want to search for a leading minus sign, like ="-nowarn"=
    1.22 +   * *Stop words* are excluded from a keyword search:
    1.23 +      * Stop words are common words and characters such as ="how"= and ="where"=, defined in the SEARCHSTOPWORDS setting in the TWikiPreferences
    1.24 +      * If you want to search for a word in the stop word list, prefix the word with a plus sign
    1.25 +   * *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=
    1.26 +
    1.27 +Regular expression search searches for a set of regular expression patterns:
    1.28 +   * Patterns are separated by semicolons
    1.29 +   * An AND search is performed for the list of patterns
    1.30 +   * An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like =!web service=
    1.31 +   * If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like =\!shampoo=
    1.32 +   * *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=
    1.33 +
    1.34 +---++ Formatted Searches
    1.35 +
    1.36 +You can embed a nicely [[FormattedSearch][formatted search]] in a topic by using the =%<nop>SEARCH{}%= variable described in VarSEARCH.
    1.37 +
    1.38 +---++ Search Preferences
    1.39 +
    1.40 +TWikiPreferences defines these search preferences:
    1.41 +
    1.42 +   * =SEARCHDEFAULTTTYPE=: Default search type for search forms which calls the =search= script
    1.43 +      * Currently =%SEARCHDEFAULTTTYPE%=
    1.44 +   * =SEARCHVARDEFAULTTYPE=: Default search type for =%<nop>SEARCH{}= variable 
    1.45 +      * Currenty =%SEARCHVARDEFAULTTYPE%=
    1.46 +   * =SEARCHSTOPWORDS=: List of stop words (common words and characters to exclude from a keyword search)
    1.47 +      * Currently =%SEARCHSTOPWORDS%=
    1.48 +
    1.49 +__Related Topics:__ UserDocumentationCategory