data/TWiki/SearchHelp.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
colas@0
     2
%META:TOPICPARENT{name="WebSearch"}%
colas@0
     3
---+!! Search Help
colas@0
     4
colas@0
     5
%TOC%
colas@0
     6
colas@0
     7
---++ Search Pages
colas@0
     8
colas@0
     9
There are two search pages; WebSearch offers basic search features, while
colas@0
    10
WebSearchAdvanced offers more control over searches.
colas@0
    11
colas@0
    12
By default searches are keyword based like in a typical search engine:
colas@0
    13
   * Specify word(s) you want to find
colas@0
    14
   * Multiple words form an *AND* search, =intranet web service= returns all pages that have the three words anywhere in the page
colas@0
    15
   * Optionally specify plus signs for *AND* search, like =intranet +web +service=
colas@0
    16
   * Enclose words in double quotes to form a *literal search*, like ="web service"=
colas@0
    17
   * Specify a minus sign to *exclude* a word, like =soap -shampoo=
colas@0
    18
   * Use double quotes if you want to search for a leading minus sign, like ="-nowarn"=
colas@0
    19
   * *Stop words* are excluded from a keyword search:
colas@0
    20
      * Stop words are common words and characters such as ="how"= and ="where"=, defined in the SEARCHSTOPWORDS setting in the TWikiPreferences
colas@0
    21
      * If you want to search for a word in the stop word list, prefix the word with a plus sign
colas@0
    22
   * *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=
colas@0
    23
colas@0
    24
Regular expression search searches for a set of regular expression patterns:
colas@0
    25
   * Patterns are separated by semicolons
colas@0
    26
   * An AND search is performed for the list of patterns
colas@0
    27
   * An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like =!web service=
colas@0
    28
   * If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like =\!shampoo=
colas@0
    29
   * *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=
colas@0
    30
colas@0
    31
---++ Formatted Searches
colas@0
    32
colas@0
    33
You can embed a nicely [[FormattedSearch][formatted search]] in a topic by using the =%<nop>SEARCH{}%= variable described in VarSEARCH.
colas@0
    34
colas@0
    35
---++ Search Preferences
colas@0
    36
colas@0
    37
TWikiPreferences defines these search preferences:
colas@0
    38
colas@0
    39
   * =SEARCHDEFAULTTTYPE=: Default search type for search forms which calls the =search= script
colas@0
    40
      * Currently =%SEARCHDEFAULTTTYPE%=
colas@0
    41
   * =SEARCHVARDEFAULTTYPE=: Default search type for =%<nop>SEARCH{}= variable 
colas@0
    42
      * Currenty =%SEARCHVARDEFAULTTYPE%=
colas@0
    43
   * =SEARCHSTOPWORDS=: List of stop words (common words and characters to exclude from a keyword search)
colas@0
    44
      * Currently =%SEARCHSTOPWORDS%=
colas@0
    45
colas@0
    46
__Related Topics:__ UserDocumentationCategory