Skip to content

Z
Zope
Commit 8ddf3361 authored by Michel Pelletier's avatar Michel Pelletier
Browse files
Options

some documentation tweaks on Andreas new zcat docs

parent 678a93b5
Hide whitespace changes
Inline Side-by-side
Showing with 102 additions and 82 deletions
lib/python/Products/ZCatalog/help/ZCatalog.stx
View file @ 8ddf3361
...@@ -4,10 +4,11 @@ ZCatalog: Index and Search for Zope objects ...@@ -4,10 +4,11 @@ ZCatalog: Index and Search for Zope objects
ZCatalogs allow you to index and search for Zope objects. ZCatalogs allow you to index and search for Zope objects.
But ZCatalog is not just simply a data managemengt system that allows But ZCatalog is not just simply a data managemengt system that
you to search through it content. You have the choice which properties allows you to search through content. You have the choice
are stored in the Catalog and which attributes are used for searching. 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 Once a set of objects is inserted into the Catalog, you will
to update this object inventory by updating the objects, deleting and be able to update this object inventory by updating the
adding them. objects, or deleting and adding them.
lib/python/Products/ZCatalog/help/ZCatalog_Cataloged-Objects.stx
View file @ 8ddf3361
...@@ -24,9 +24,9 @@ ZCatalog - Cataloged Objects: Manage catalog entries ...@@ -24,9 +24,9 @@ ZCatalog - Cataloged Objects: Manage catalog entries
cataloged objects. These two links will only appear if you cataloged objects. These two links will only appear if you
have enough objects in the Catalog. have enough objects in the Catalog.
'Update' -- Clicked, Zope updates its indexes and metadata for 'Update' -- When clicked, Zope updates its indexes and
the object. metadata for the object.
'Remove' -- Clicked, it removes all the selected objects from 'Remove' -- When clicked, it removes all the selected objects
the Catalog. **Note:** No objects are deleted from the from the Catalog. **Note:** No objects are deleted from the
database. database.
lib/python/Products/ZCatalog/help/ZCatalog_Indexes.stx
View file @ 8ddf3361
...@@ -5,37 +5,46 @@ ZCatalog - Indexes: Manage Catalog Indexes ...@@ -5,37 +5,46 @@ ZCatalog - Indexes: Manage Catalog Indexes
This view allows you to manage the catalog indexes. This view allows you to manage the catalog indexes.
The catalog provides searching by indexing information about 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 Controls
'[List of Indexes]' -- Each line contains one Index entry. The checkbox in the front allows '[List of Indexes]' -- Each line contains one Index entry. The
you to mark an index for deletion. Next the Index nameis listed which checkbox in the front allows you to mark an index for
corresponds to attribute names of various objects, is displayed. deletion. Next the Index name is listed which corresponds to
attribute names of various objects.
'Delete' -- Clicked, the checkmarked Index(es) will be deleted. 'Delete' -- The checkmarked Index(es) will be deleted.
'Add Index' - Name -- Allows you to enter the name of a new index. '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 '[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.
'TextIndex', 'FieldIndex', and 'KeywordIndex'. 'Add' -- The new Index will be added to this catalog.
Please refer to the table below to see a description of each Index.
'Add' -- Clicked, 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 'TextIndex' -- TextIndexes break content up into individual
order from the most relevant to the lest relevant. words. These indexes are often refered to as *full-text
indexes*. Text indexes sort results by score, meaning they
'FieldIndex' -- Treat the value of an objects attribute atomically, and can be used, for return 'hits' in order from the most relevant to the lest
example, to track only a certain subset of object values, such as 'meta_type'. relevant.
'KeywordIndex' -- Index a sequence of objects that act as 'keywords' for an object. A Keyword 'FieldIndex' -- FieldIndexes treat the value of an objects
Index will return any objects that have one or more keywords specified in a attribute atomically, and can be used, for example, to track
search query. 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 'PathIndex' -- Index the physical path of a sequence of
all objects that match a partitial path specified in a search query. objects. A Path Index will return all objects that match a
partitial path specified in a search query.
lib/python/Products/ZCatalog/help/ZCatalog_MetaData-Table.stx
View file @ 8ddf3361
...@@ -2,21 +2,26 @@ ZCatalog - MetaData Table: Manage Catalog record schema ...@@ -2,21 +2,26 @@ ZCatalog - MetaData Table: Manage Catalog record schema
Description 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. The catalog holds records which describe the cataloged
This view allows you to define columns for these records. objects. This view allows you to define columns for these
records.
Controls Controls
'[List of Indexes]' -- Each line contains one Meta Data entry (column). '[List of Indexes]' -- Each line contains one Meta Data entry
The checkbox in the front allows you to mark a meta data entry for (column). The checkbox in the front allows you to mark a meta
deletion. Next the meta data entry's name is listed which corresponds to data entry for deletion. Next the meta data entry's name is
attribute names of various objects, is displayed. listed which corresponds to attribute names of various
objects, is displayed.
'Delete' -- Clicked, the checkmarked Meta Data entries (columns) will be 'Delete' -- When clicked, the checkmarked Meta Data entries
deleted. (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.
lib/python/Products/ZCatalog/help/ZCatalog_Parameters.stx
View file @ 8ddf3361
ZCatalog - searchResults: specifying parameters for a search query ZCatalog - searchResults: specifying parameters for a search query
The searchResults() method of the ZCatalog takes parameters to be passed The searchResults() method of the ZCatalog accepts parameters that
to an index XXX of the ZCatalog. A query can either be passed as keyword define a query to be made on that catalog. A query can either be
argument XXX of the searchResults() call or as key of the REQUEST object. passed as keyword argument to searchResults(), as a mapping, or as
The value to be passed must be a mapping object (usually a dictionary or part of a Zope REQUEST object, typically from HTML forms.
or Record).
Keys of mapping object 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.
Attributes of record objects
'query' -- either a sequence of objects or a single value to be passed 'query' -- either a sequence of objects or a single value to be
as query to the index (mandatory) passed as query to the index (mandatory)
'operator' -- specifies the combination of search results when query 'operator' -- specifies the combination of search results when
is a sequence of values. (optional, default: 'or'). query is a sequence of values. (optional, default: 'or').
Allowed values: 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 '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: Allowed values:
'min' -- Searches for all objects with values larger than the minimum of the 'min' -- Searches for all objects with values larger than
values passed in the 'query' parameter. the minimum of the values passed in the 'query' parameter.
'max' -- Searches for all objects with values smaller than the maximum of the 'max' -- Searches for all objects with values smaller than
values passed in the 'query' parameter. the maximum of the values passed in the 'query' parameter.
'minmax' -- Searches for all objects with values smaller than the maximum of the 'minmax' -- Searches for all objects with values smaller
values passed in the 'query' parameter and larger than the minimum of the values than the maximum of the values passed in the 'query'
passwd in the 'query' parameter. 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 'level' -- only applies to Path Index. Specifies the directory
start searching. (optional, default: 0) level to start searching. (optional, default: 0)
lib/python/Products/ZCatalog/help/ZCatalog_Status.stx
View file @ 8ddf3361
...@@ -2,22 +2,25 @@ ZCatalog - Status: Control advanced Catalog features ...@@ -2,22 +2,25 @@ ZCatalog - Status: Control advanced Catalog features
Description 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 Subtransactions reduce the memory requirements of ZCatalog,
the expense of speed. If you choose to enable subtransactions, you can adjust but at the expense of speed. If you choose to enable
how often ZCatalog commits a subtransactions by adjusting the threshold. The subtransactions, you can adjust how often ZCatalog commits a
index status reports how many objects are cataloged in each index. subtransaction by adjusting the threshold. The index status
reports how many objects are cataloged in each index.
Controls Controls
'Enable/Disable' -- If enables, the Subtransaction system is enabled and the threshold 'Enable/Disable' -- If enables, the Subtransaction system is
specified below is used. enabled and the threshold specified below is used.
'Subtransaction Threshold' -- Allows you to specify how often the ZCatalog will commit the 'Subtransaction Threshold' -- Allows you to specify how often
subtransactions. The default value is 10000. 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 'Index Status' List -- Each line corresponds to one Index. The
many objects are cataloged for each Index. line indicates how many objects are cataloged for each Index.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7