[Zope-Checkins] CVS: Zope/lib/python/Products/PluginIndexes/TopicIndex/help - TopicIndex_searchResults.stx:1.2

Andreas Jung andreas@digicool.com
Thu, 28 Feb 2002 10:31:42 -0500


Update of /cvs-repository/Zope/lib/python/Products/PluginIndexes/TopicIndex/help
In directory cvs.zope.org:/tmp/cvs-serv29886/help

Added Files:
	TopicIndex_searchResults.stx 
Log Message:
added TopicIndexes to trunk (merge from ajung-topicindex branch)


=== Zope/lib/python/Products/PluginIndexes/TopicIndex/help/TopicIndex_searchResults.stx 1.1 => 1.2 ===
+  
+    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' 
+