Difference: SearchHelp (r2 vs. r1)

Search Help

Basic Search Form Pages

The There are two search pages; WebSearchform offers basic search features: features, while WebSearchAdvanced offers more control over searches.

  • Search field: Enter one or more keywords
  • All webs flag: Check the flag if you want to search all public webs, not just the current web
  • Scope: Select if you want to search the topic title, text body or both

By default searches are keyword based like in a typical search engine:

The search is keyword based like in a typical search engine:

  • Specify word(s) you want to find
  • Multiple words form an AND search, intranet web service returns all pages that have the three words anywhere in the page
  • Optionally specify plus signs for AND search, like intranet +web +service
  • Enclose words in double quotes to form a literal search, like "web service"
  • Specify a minus sign to exclude a word, like soap -shampoo
  • Use double quotes if you want to search for a leading minus sign, like "-nowarn"
  • Stop words are excluded from a keyword search:
    • Stop words are common words and characters such as "how" and "where", defined in the SEARCHSTOPWORDS setting in the TWikiPreferences
    • If you want to search for a word in the stop word list, prefix the word with a plus sign
  • Example: To search for all topics that contain "SOAP", "WSDL", a literal "web service", but not "shampoo",
    enter this: soap +wsdl "web service" -shampoo

Advanced Search Form

Regular expression search searches for a set of regular expression patterns:

The WebSearchAdvanced form offers more control over search.

  • Patterns are separated by semicolons
  • An AND search is performed for the list of patterns
  • An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like !web service
  • If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like \!shampoo
  • Example: To search for all topics that contain "SOAP", "WSDL", a literal "web service", but not "shampoo",
    enter this: soap;wsdl;web service;!shampoo

TWiki supports three types of searches:

  • keyword: The basic search type
  • literal: Simple search where text is searched literally
  • regex: A RegularExpression search for power users

TWiki's regex search is a set of regular expression patterns:

  • Patterns are delimited by a semicolon
  • An AND search is performed for the list of patterns
  • An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like !web service
  • If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like \!shampoo
  • Example: To search for all topics that contain "SOAP", "WSDL", a literal "web service", but not "shampoo",
    enter this: soap;wsdl;web service;!shampoo

Formatted Searches

You can embed a nicely formatted search in a topic by using the %SEARCH{}% variable described in TWikiVariables TWikiVariables#VarSEARCH .

Search Preferences

The TWikiPreferenceshas defines these settings: search preferences:

  • SEARCHDEFAULTTTYPE: Default search type for search forms which calls the search script
    • Currently %SEARCHDEFAULTTTYPE%
  • SEARCHVARDEFAULTTYPE: Default search type for %SEARCH{} variable
    • Currenty literal
  • SEARCHSTOPWORDS: List of stop words (common words and characters to exclude from a keyword search)
    • Currently a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z

-- Related Topics:TWiki:Main.PeterThoeny - 18 Jan 2004UserDocumentationCategory

View topic | View difference side by side | History: r5 < r4 < r3 < r2 | More topic actions
 
This site is powered by the TWiki collaboration platformCopyright © 1999-2019 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.SearchHelp.