Skip to content

Commit

Permalink
Many small structured text fixes, typos fixes, and small wording and …
Browse files Browse the repository at this point in the history
…formatting corrections. Some of these were pointed out by Tom Deprez.
  • Loading branch information
latteier committed Apr 17, 2001
1 parent 20f0589 commit 0c06e03
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 24 deletions.
8 changes: 4 additions & 4 deletions help/Vocabulary.py
Expand Up @@ -83,7 +83,7 @@
#
##############################################################################

def manage_addVocabulary(self, id, title, globbing=None, REQUEST=None):
def manage_addVocabulary(id, title, globbing=None, REQUEST=None):
"""
Add a Vocabulary object to an ObjectManager.
Expand All @@ -105,22 +105,22 @@ class Vocabulary:

__constructor__=manage_addVocabulary

def query(self, pattern):
def query(pattern):
"""
Query Vocabulary for words matching pattern.
"""


def insert(self, word):
def insert(word):
"""
Insert a word in the Vocabulary.
"""

def words(self):
def words():
"""
Return list of words.
Expand Down
39 changes: 19 additions & 20 deletions help/ZCatalog.py
Expand Up @@ -83,7 +83,7 @@
#
##############################################################################

def manage_addZCatalog(self, id, title, vocab_id=None):
def manage_addZCatalog(id, title, vocab_id=None):
"""
Add a ZCatalog object.
Expand All @@ -106,7 +106,8 @@ class ZCatalog:
objects. ZCatalog's can index either 'Field' values of object,
'Text' values, or 'KeyWord' values:
Indexes
ZCatalogs have three types of
indexes:
Text -- Text indexes index textual content. The index can be
used to search for objects containing certain words.
Expand All @@ -118,15 +119,13 @@ class ZCatalog:
can be used to search for objects that match one or more of the
search terms.
Meta-data
The ZCatalog can maintain a table of extra data about cataloged
objects. This information can be used on search result pages to
show information about a search result.
The ZCatalog can maintain a table of extra data about cataloged
objects. This information can be used on search result pages to
show information about a search result.
The meta-data table schema is used to build the schema for
ZCatalog Result objects. The objects have the same attributes
as the column of the meta-data table.
The meta-data table schema is used to build the schema for
ZCatalog Result objects. The objects have the same attributes
as the column of the meta-data table.
ZCatalog does not store references to the objects themselves, but
rather to a unique identifier that defines how to get to the
Expand All @@ -138,28 +137,28 @@ class ZCatalog:

__constructor__=manage_addZCatalog

def catalog_object(self, obj, uid):
def catalog_object(obj, uid):
"""
Catalogs the object 'obj' with the unique identifier 'uid'.
"""

def uncatalog_object(self, uid):
def uncatalog_object(uid):
"""
Uncatalogs the object with the unique identifier 'uid'.
"""

def uniqueValuesFor(self, name):
def uniqueValuesFor(name):
"""
returns the unique values for a given FieldIndex named 'name'.
"""

def getpath(self, rid):
def getpath(rid):
"""
Return the path to a cataloged object given a
Expand All @@ -168,36 +167,36 @@ def getpath(self, rid):
"""


def getobject(self, rid, REQUEST=None):
def getobject(rid, REQUEST=None):
"""
Return a cataloged object given a 'data_record_id_'
"""

def schema(self):
def schema():
"""
Returns a sequence of names that correspond to columns in the
meta-data table.
"""

def indexes(self):
def indexes():
"""
Returns a sequence of names that correspond to indexes.
"""

def index_objects(self):
def index_objects():
"""
Returns a sequence of actual index objects.
"""

def searchResults(self, REQUEST=None, **kw):
def searchResults(REQUEST=None, **kw):
"""
Search the catalog. Search terms can be passed in the REQUEST
Expand All @@ -209,7 +208,7 @@ def searchResults(self, REQUEST=None, **kw):
"""

def __call__(self, REQUEST=None, **kw):
def __call__(REQUEST=None, **kw):
"""
Search the catalog, the same way as 'searchResults'.
"""
Expand Down

0 comments on commit 0c06e03

Please sign in to comment.