TWiki/SearchHelp.mdwn

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