[Zope-Checkins] CVS: Zope2 - ZCatalog.stx:1.2 ZCatalog_Cataloged-Objects.stx:1.4 ZCatalog_Indexes.stx:1.3 ZCatalog_MetaData-Table.stx:1.2 ZCatalog_Parameters.stx:1.5 ZCatalog_Status.stx:1.2
Michel Pelletier
michel@digicool.com
Thu, 31 May 2001 20:18:53 -0400 (EDT)
Update of /cvs-repository/Zope2/lib/python/Products/ZCatalog/help
In directory korak.digicool.com:/tmp/cvs-serv23146/help
Modified Files:
ZCatalog.stx ZCatalog_Cataloged-Objects.stx
ZCatalog_Indexes.stx ZCatalog_MetaData-Table.stx
ZCatalog_Parameters.stx ZCatalog_Status.stx
Log Message:
some documentation tweaks on Andreas new zcat docs
--- Updated File ZCatalog.stx in package Zope2 --
--- ZCatalog.stx 2000/06/16 18:50:36 1.1
+++ ZCatalog.stx 2001/06/01 00:18:52 1.2
@@ -4,10 +4,11 @@
ZCatalogs allow you to index and search for Zope objects.
- But ZCatalog is not just simply a data managemengt system that allows
- you to search through it content. You have the choice which properties
- are stored in the Catalog and which attributes are used for searching.
+ But ZCatalog is not just simply a data managemengt system that
+ allows you to search through content. You have the choice
+ which properties are stored in the Catalog and which
+ attributes are used for searching.
- Once a set of objects is inserted into the Catalog, you will be able
- to update this object inventory by updating the objects, deleting and
- adding them.
+ Once a set of objects is inserted into the Catalog, you will
+ be able to update this object inventory by updating the
+ objects, or deleting and adding them.
--- Updated File ZCatalog_Cataloged-Objects.stx in package Zope2 --
--- ZCatalog_Cataloged-Objects.stx 2001/01/15 21:45:50 1.3
+++ ZCatalog_Cataloged-Objects.stx 2001/06/01 00:18:52 1.4
@@ -24,9 +24,9 @@
cataloged objects. These two links will only appear if you
have enough objects in the Catalog.
- 'Update' -- Clicked, Zope updates its indexes and metadata for
- the object.
+ 'Update' -- When clicked, Zope updates its indexes and
+ metadata for the object.
- 'Remove' -- Clicked, it removes all the selected objects from
- the Catalog. **Note:** No objects are deleted from the
+ 'Remove' -- When clicked, it removes all the selected objects
+ from the Catalog. **Note:** No objects are deleted from the
database.
--- Updated File ZCatalog_Indexes.stx in package Zope2 --
--- ZCatalog_Indexes.stx 2001/05/30 15:57:37 1.2
+++ ZCatalog_Indexes.stx 2001/06/01 00:18:52 1.3
@@ -5,37 +5,46 @@
This view allows you to manage the catalog indexes.
The catalog provides searching by indexing information about
- cataloged objects. Indexes record information about object attributes.
+ cataloged objects. Indexes record information about object
+ attributes.
Controls
- '[List of Indexes]' -- Each line contains one Index entry. The checkbox in the front allows
- you to mark an index for deletion. Next the Index nameis listed which
- corresponds to attribute names of various objects, is displayed.
+ '[List of Indexes]' -- Each line contains one Index entry. The
+ checkbox in the front allows you to mark an index for
+ deletion. Next the Index name is listed which corresponds to
+ attribute names of various objects.
+
+ 'Delete' -- The checkmarked Index(es) will be deleted.
+
+ 'Add Index' - Name -- Allows you to enter the name of a new
+ index.
+
+ '[Type of Index]' -- You have the choice between four types of
+ Indexes, called 'TextIndex', 'FieldIndex', 'KeywordIndex' and
+ 'PathIndex'. Please refer to the table below to see a
+ description of each Index.
- 'Delete' -- Clicked, the checkmarked Index(es) will be deleted.
-
- 'Add Index' - Name -- Allows you to enter the name of a new index.
-
- '[Type of Index]' -- You have the choice between three types of Indexes, called
-
- 'TextIndex', 'FieldIndex', and 'KeywordIndex'.
- Please refer to the table below to see a description of each Index.
-
- 'Add' -- Clicked, the new Index will be added to this catalog.
+ 'Add' -- The new Index will be added to this catalog.
- This table lists the different Index types and describes their purpose.
+ This table lists the different Index types and describes their
+ purpose.
- 'TextIndex' -- Breaks text up into individual words, and are often refered to as full-text
- indexes. Text indexes sort results by score meaning they return 'hits' in
- order from the most relevant to the lest relevant.
-
- 'FieldIndex' -- Treat the value of an objects attribute atomically, and can be used, for
- example, to track only a certain subset of object values, such as 'meta_type'.
-
- 'KeywordIndex' -- Index a sequence of objects that act as 'keywords' for an object. A Keyword
- Index will return any objects that have one or more keywords specified in a
- search query.
+ 'TextIndex' -- TextIndexes break content up into individual
+ words. These indexes are often refered to as *full-text
+ indexes*. Text indexes sort results by score, meaning they
+ return 'hits' in order from the most relevant to the lest
+ relevant.
+
+ 'FieldIndex' -- FieldIndexes treat the value of an objects
+ attribute atomically, and can be used, for example, to track
+ only a certain subset of object values, such as 'meta_type'.
+
+ 'KeywordIndex' -- KeywordIndexes index a sequence of objects
+ that act as 'keywords' for an object. A Keyword Index will
+ return any objects that have one or more keywords specified in
+ a search query.
- 'PathIndex' -- Index the physical path of a sequence of objects. A Path Index will return
- all objects that match a partitial path specified in a search query.
+ 'PathIndex' -- Index the physical path of a sequence of
+ objects. A Path Index will return all objects that match a
+ partitial path specified in a search query.
--- Updated File ZCatalog_MetaData-Table.stx in package Zope2 --
--- ZCatalog_MetaData-Table.stx 2000/06/16 18:50:36 1.1
+++ ZCatalog_MetaData-Table.stx 2001/06/01 00:18:52 1.2
@@ -2,21 +2,26 @@
Description
- This view allows you to manage the catalog record schema.
+ This view allows you to manage the catalog record schema.
- The catalog holds records which describe the cataloged objects.
- This view allows you to define columns for these records.
+ The catalog holds records which describe the cataloged
+ objects. This view allows you to define columns for these
+ records.
Controls
- '[List of Indexes]' -- Each line contains one Meta Data entry (column).
- The checkbox in the front allows you to mark a meta data entry for
- deletion. Next the meta data entry's name is listed which corresponds to
- attribute names of various objects, is displayed.
+ '[List of Indexes]' -- Each line contains one Meta Data entry
+ (column). The checkbox in the front allows you to mark a meta
+ data entry for deletion. Next the meta data entry's name is
+ listed which corresponds to attribute names of various
+ objects, is displayed.
- 'Delete' -- Clicked, the checkmarked Meta Data entries (columns) will be
- deleted.
+ 'Delete' -- When clicked, the checkmarked Meta Data entries
+ (columns) will be deleted.
- 'Meta Data name' -- Allows you to enter the name of a new meta data entry.
+ 'Meta Data name' -- Allows you to enter the name of a new meta
+ data entry.
- 'Add' -- Clicked, the new entry (column) will be added to this catalog.
+ 'Add' -- When clicked, the new entry (column) will be added to
+ this catalog.
+
--- Updated File ZCatalog_Parameters.stx in package Zope2 --
--- ZCatalog_Parameters.stx 2001/05/30 19:59:55 1.4
+++ ZCatalog_Parameters.stx 2001/06/01 00:18:52 1.5
@@ -1,41 +1,43 @@
ZCatalog - searchResults: specifying parameters for a search query
- The searchResults() method of the ZCatalog takes parameters to be passed
- to an index XXX of the ZCatalog. A query can either be passed as keyword
- argument XXX of the searchResults() call or as key of the REQUEST object.
- The value to be passed must be a mapping object (usually a dictionary or
- or Record).
+ 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.
- Keys of mapping object
+ Attributes of record objects
- 'query' -- either a sequence of objects or a single value to be passed
- as query to the index (mandatory)
+ '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').
+ 'operator' -- specifies the combination of search results when
+ query is a sequence of values. (optional, default: 'or').
Allowed values:
- 'and', 'or' -- for Keyword Indexes and Path Indexes
+ 'and', 'or' -- for Keyword Indexes and Path Indexes
'and', 'or', 'andnot', 'near' -- for Text Indexes
+ 'range' -- defines a range search on a Field Index (optional,
+ default: not set).
-
- 'range' -- defines a range search on a Field Index (optional, default: not set).
-
Allowed values:
- 'min' -- Searches for all objects with values larger than the minimum of the
- values passed in the 'query' parameter.
+ 'min' -- Searches for all objects with values larger than
+ the minimum of the values passed in the 'query' parameter.
- 'max' -- Searches for all objects with values smaller than the maximum of the
- values passed in the 'query' parameter.
+ 'max' -- Searches for all objects with values smaller than
+ the maximum of the values passed in the 'query' parameter.
- 'minmax' -- Searches for all objects with values smaller than the maximum of the
- values passed in the 'query' parameter and larger than the minimum of the values
- passwd in the 'query' parameter.
-
+ 'minmax' -- Searches for all objects with values smaller
+ than the maximum of the values passed in the 'query'
+ parameter and larger than the minimum of the values passwd
+ in the 'query' parameter.
- 'level' -- only applies to Path Index. Specifies the directory level to
- start searching. (optional, default: 0)
+ 'level' -- only applies to Path Index. Specifies the directory
+ level to start searching. (optional, default: 0)
--- Updated File ZCatalog_Status.stx in package Zope2 --
--- ZCatalog_Status.stx 2000/06/16 18:50:36 1.1
+++ ZCatalog_Status.stx 2001/06/01 00:18:52 1.2
@@ -2,22 +2,25 @@
Description
- This view allows you to control advanced catalog features.
+ This view allows you to control advanced catalog features.
- Subtransactions reduce the memory requirements of ZCatalog, but at
- the expense of speed. If you choose to enable subtransactions, you can adjust
- how often ZCatalog commits a subtransactions by adjusting the threshold. The
- index status reports how many objects are cataloged in each index.
+ Subtransactions reduce the memory requirements of ZCatalog,
+ but at the expense of speed. If you choose to enable
+ subtransactions, you can adjust how often ZCatalog commits a
+ subtransaction by adjusting the threshold. The index status
+ reports how many objects are cataloged in each index.
Controls
- 'Enable/Disable' -- If enables, the Subtransaction system is enabled and the threshold
- specified below is used.
+ 'Enable/Disable' -- If enables, the Subtransaction system is
+ enabled and the threshold specified below is used.
- 'Subtransaction Threshold' -- Allows you to specify how often the ZCatalog will commit the
- subtransactions. The default value is 10000.
+ 'Subtransaction Threshold' -- Allows you to specify how often
+ the ZCatalog will commit the subtransactions. The default
+ value is 10000.
- 'Change' -- Clicked, Zope will update the subtransaction threshold.
+ 'Change' -- Clicked, Zope will update the subtransaction
+ threshold.
- 'Index Status' List -- Each line corresponds to one Index. The line indicates how
- many objects are cataloged for each Index.
+ 'Index Status' List -- Each line corresponds to one Index. The
+ line indicates how many objects are cataloged for each Index.