[Zope-Checkins] CVS: Zope/lib/python/Products/ZCatalog/help - Vocabulary.py:1.7 ZCatalog.py:1.14
Martijn Pieters
mj@zope.com
Wed, 14 Aug 2002 18:25:46 -0400
Update of /cvs-repository/Zope/lib/python/Products/ZCatalog/help
In directory cvs.zope.org:/tmp/cvs-serv27658/ZCatalog/help
Modified Files:
Vocabulary.py ZCatalog.py
Log Message:
Clean up indentation and trailing whitespace.
=== Zope/lib/python/Products/ZCatalog/help/Vocabulary.py 1.6 => 1.7 ===
--- Zope/lib/python/Products/ZCatalog/help/Vocabulary.py:1.6 Wed Nov 28 10:51:09 2001
+++ Zope/lib/python/Products/ZCatalog/help/Vocabulary.py Wed Aug 14 18:25:15 2002
@@ -1,21 +1,21 @@
##############################################################################
#
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE
-#
+#
##############################################################################
def manage_addVocabulary(id, title, globbing=None, REQUEST=None):
"""
Add a Vocabulary object to an ObjectManager.
-
+
"""
@@ -28,7 +28,7 @@
A Vocabulary manages words and language rules for text indexing.
Text indexing is done by the ZCatalog and other third party
Products.
-
+
"""
__constructor__=manage_addVocabulary
@@ -39,7 +39,7 @@
Query Vocabulary for words matching pattern.
"""
-
+
def insert(word):
"""
@@ -47,12 +47,10 @@
Insert a word in the Vocabulary.
"""
-
+
def words():
"""
Return list of words.
"""
-
-
=== Zope/lib/python/Products/ZCatalog/help/ZCatalog.py 1.13 => 1.14 ===
--- Zope/lib/python/Products/ZCatalog/help/ZCatalog.py:1.13 Wed Aug 14 15:10:14 2002
+++ Zope/lib/python/Products/ZCatalog/help/ZCatalog.py Wed Aug 14 18:25:15 2002
@@ -1,14 +1,14 @@
##############################################################################
#
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
-#
+#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE
-#
+#
##############################################################################
def manage_addZCatalog(id, title, vocab_id=None):
@@ -43,20 +43,20 @@
Keyword -- Keyword indexes index sequences of values. The index
can be used to search for objects that match one or more of the
search terms.
-
+
Path -- Path indexes index URI paths. They allow you to find objects
based on their placement in a hierarchy.
-
+
Date -- Date indexes index date and type data. They are a type of field
index specifically optimized for indexing dates.
Date Range -- Date range indexes index time intervals. They are designed
for efficient searching of dates falling between two boundaries
(such as effective / expiration dates).
-
+
Topic -- Topic indexes store prefiltered sets of documents. They are used
- to optimize complex queries into a single fast query by prefiltering
- documents by an expression
+ to optimize complex queries into a single fast query by prefiltering
+ documents by an expression
The ZCatalog can maintain a table of extra data about cataloged
objects. This information can be used on search result pages to
@@ -69,7 +69,7 @@
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 identifier is the object's relative
- path to the ZCatalog (since two Zope objects cannot have the same
+ path to the ZCatalog (since two Zope objects cannot have the same
URL, this is an excellent unique qualifier in Zope).
"""
@@ -99,18 +99,18 @@
def getpath(rid):
"""
-
+
Return the path to a cataloged object given a
'data_record_id_'
-
+
"""
def getobject(rid, REQUEST=None):
"""
-
+
Return a cataloged object given a 'data_record_id_'
-
+
"""
def schema():
@@ -123,24 +123,24 @@
def index_objects():
"""
-
+
Returns a sequence of actual index objects.
-
+
NOTE: This returns unwrapped indexes! You should probably use
getIndexObjects instead. Some indexes expect to be wrapped.
-
+
"""
-
+
def getIndexObjects():
"""
-
+
Returns a list of acquisition wrapped index objects
-
+
"""
def searchResults(REQUEST=None, **kw):
"""
-
+
Search the catalog. Search terms can be passed in the REQUEST
or as keyword arguments.
@@ -206,9 +206,8 @@
documented in The Zope Book.
"""
-
+
def __call__(REQUEST=None, **kw):
"""
Search the catalog, the same way as 'searchResults'.
"""
-