[Zope-Checkins] CVS: Zope2 - README.txt:1.1.2.2

[andreas@serenade.digicool.com]

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

Modified Files:
      Tag: ajung-dropin-registry
	README.txt 
Log Message:




--- Updated File README.txt in package Zope2 --
--- README.txt	2001/05/25 14:56:25	1.1.2.1
+++ README.txt	2001/05/25 17:00:21	1.1.2.2
@@ -33,6 +33,9 @@
 
  Changes to KeywordIndex:
 
+  - default search operator 'or' may be overridden by secifying a new one as
+    'operator' (see below)
+
   - internal changes
 
  Changes to FieldIndex:
@@ -44,6 +47,11 @@
 
   - internal changes
 
+ Changes for PathIndex:
+ 
+  - new index type
+
+
  Changes to TextIndex:
 
   - ZMI allows to select a different vocabulary. To use a vocabulary different
@@ -53,6 +61,11 @@
 
   - internal support for user-provided splitters
 
+  - the default operator might be overridden by specifying a new one
+    as 'operator' (see below)
+
+  - usage of the 'textindex_operator' is deprecated
+
   - lots of internal rework
 
 
@@ -63,6 +76,43 @@
 
   - added ZCatalogIndexes.py to provide access to indexes with pluggable
     index interface
+
+  
+  Parameter passing to the ZCatalog
+
+    Parameter passing to the ZCatalog/Catalog has been enhanced and unified
+    and is now much more logical.
+
+    - Method 1: The old way to pass a query including parameters to an index XXX
+      was to specify the query as value in the request dictionary. Additional 
+      parameters were passed XXX_parameter : <value> in the request dictionary.
+      (This method is deprecated).
+
+    - Method 2: The query and all parameters to be passed to an index XXX are
+      passed as dictionary inside the request dictionary. Example:
+      
+        old: <dtml-in myCatalog(myindex='xx yy',myindex_usage':'blabla')
+        new: <dtml-in myCatalog(myindex={'query':'xx yy','usage':'....'})
+
+    - Method 3: Inside a formular you can use Record as types for parameter passing.
+      Example:
+
+            <form action=...>
+            <input type=text name="person.query:record" value="">
+            <input type=hidden name="person.operator:record" value="and">
+            ..</form>
+
+            and in the DTML method:
+
+             <dtml-in myCatalog(person=person)>
+
+            This example will pass both parameters as a Record instance to the index
+            'person'. 
+
+   All index types of Zope support all three methods. On the DTML level only
+   method 3 type parameter should be used. 
+
+
 
 
 Backward compatibility: