diff --git a/help/Vocabulary.py b/help/Vocabulary.py index 83604696..6f7037aa 100644 --- a/help/Vocabulary.py +++ b/help/Vocabulary.py @@ -98,10 +98,12 @@ def query(self, pattern): Query Vocabulary for words matching pattern. + Pattern format -- XXX + """ - def insert(self, word=''): + def insert(self, word): """ Insert a word in the Vocabulary. diff --git a/help/ZCatalog.py b/help/ZCatalog.py index 3163c01f..2089f64b 100644 --- a/help/ZCatalog.py +++ b/help/ZCatalog.py @@ -89,22 +89,28 @@ class ZCatalog: ZCatalog object - A ZCatalog contains arbirary index like references to Zope + A ZCatalog contains arbitrary index like references to Zope objects. ZCatalog's can index either 'Field' values of object, 'Text' values, or 'KeyWord' values: + Indexes + + Text -- XXX + + Field -- XXX + + Keyword -- XXX + + Meta-data + + XXX + ZCatalog does not store references to the objects themselves, but rather to a unique identifier that defines how to get to the - object. In Zope, this unique idenfier is the object's relative + object. In Zope, this unique identifier is the object's relative path to the ZCatalog (since two Zope object's cannot have the same URL, this is an excellent unique qualifier in Zope). - Most of the dirty work is done in the _catalog object, which is an - instance of the Catalog class. An interesting feature of this - class is that it is not Zope specific. You can use it in any - Python program to catalog objects. - - """ def catalog_object(self, obj, uid): @@ -147,7 +153,7 @@ def getobject(self, rid, REQUEST=None): def schema(self): """ - Returns a sequence of names that corespond to columns in the + Returns a sequence of names that correspond to columns in the meta-data table. """ @@ -155,7 +161,7 @@ def schema(self): def indexes(self): """ - Returns a sequence of names that corespond to indexes. + Returns a sequence of names that correspond to indexes. """ @@ -172,5 +178,13 @@ def searchResults(self, REQUEST=None, **kw): Search the catalog. Search terms can be passed in the REQUEST or as keyword arguments. + + XXX search grammar, how terms are combined, special search + terms, format of returned results XXX + """ + def __call__(self, REQUEST=None, **kw): + """ + Search the catalog, the same way as 'searchResults'. + """