[Zope-Checkins] CVS: Zope2 - KeywordIndex_searchResults.stx:1.1

andreas@serenade.digicool.com andreas@serenade.digicool.com
Fri, 1 Jun 2001 10:15:14 -0400


Update of /cvs-repository/Zope2/lib/python/Products/PluginIndexes/KeywordIndex/help
In directory serenade:/tmp/cvs-serv28076/KeywordIndex/help

Added Files:
	KeywordIndex_searchResults.stx 
Log Message:
refactored help



--- Added File KeywordIndex_searchResults.stx in package Zope2 ---
ZCatalog - searchResults: specifying parameters for a search query
  
    The searchResults() method of the ZCatalog accepts parameters that
    define a query to be made on that catalog.  A query can either be
    passed as keyword argument to searchResults(), as a mapping, or as
    part of a Zope REQUEST object, typically from HTML forms.

    The index of the catalog to query is either the name of the
    keyword argument, a key in a mapping, or an attribute of a record
    object.

    Attributes of record objects
  
      'query' -- either a sequence of objects or a single value to be
      passed as query to the index (mandatory)

      'operator' -- specifies the combination of search results when
      query is a sequence of values. (optional, default: 'or').
       
        Allowed values:

         'and', 'or'