Commit 42f70ca2 authored by Hanno Schlichting's avatar Hanno Schlichting

Removed unmaintained HelpSys documents from ZCatalog and PluginIndexes. Useful...

Removed unmaintained HelpSys documents from ZCatalog and PluginIndexes. Useful explanations are given inside the form templates.
parent ad215c3a
......@@ -35,6 +35,9 @@ Bugs Fixed
Restructuring
+++++++++++++
- Removed unmaintained HelpSys documents from ZCatalog and PluginIndexes.
Useful explanations are given inside the form templates.
- Deprecate Products.ZCatalog's current behavior of returning the entire
catalog content if no query restriction applied. In Zope 2.14 this will
result in an empty LazyCat to be returned instead.
......
......@@ -27,12 +27,8 @@ class FieldIndex(UnIndex):
meta_type="FieldIndex"
manage_options= (
{'label': 'Settings',
'action': 'manage_main',
'help': ('FieldIndex','FieldIndex_Settings.stx')},
{'label': 'Browse',
'action': 'manage_browse',
'help': ('FieldIndex','FieldIndex_Settings.stx')},
{'label': 'Settings', 'action': 'manage_main'},
{'label': 'Browse', 'action': 'manage_browse'},
)
query_options = ["query","range"]
......
ZCatalog - searchResults: specifying parameters for a search query
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.
Attributes of record objects
'query' -- either a sequence of objects or a single value to be
passed as query to the index (mandatory)
'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.
'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.
......@@ -38,12 +38,8 @@ class KeywordIndex(UnIndex):
meta_type="KeywordIndex"
manage_options= (
{'label': 'Settings',
'action': 'manage_main',
'help': ('KeywordIndex','KeywordIndex_Settings.stx')},
{'label': 'Browse',
'action': 'manage_browse',
'help': ('FieldIndex','FieldIndex_Settings.stx')},
{'label': 'Settings', 'action': 'manage_main'},
{'label': 'Browse', 'action': 'manage_browse'},
)
query_options = ("query","operator", "range")
......
ZCatalog - searchResults: specifying parameters for a search query
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.
Attributes of record objects
'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').
Allowed values:
'and', 'or'
......@@ -58,9 +58,7 @@ class PathIndex(Persistent, SimpleItem):
query_options = ('query', 'level', 'operator')
manage_options= (
{'label': 'Settings',
'action': 'manage_main',
'help': ('PathIndex','PathIndex_Settings.stx')},
{'label': 'Settings', 'action': 'manage_main'},
)
def __init__(self,id,caller=None):
......
ZCatalog - searchResults: specifying parameters for a search query
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.
Attributes of record objects
'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').
Allowed values:
'and', 'or'
'level' -- only applies to Path Index. Specifies the directory
level to start searching. (optional, default: 0)
......@@ -49,9 +49,7 @@ class TopicIndex(Persistent, SimpleItem):
query_options = ('query', 'operator')
manage_options= (
{'label': 'FilteredSets',
'action': 'manage_main',
'help': ('TopicIndex','TopicIndex_searchResults.stx')},
{'label': 'FilteredSets', 'action': 'manage_main'},
)
def __init__(self,id,caller=None):
......
ZCatalog - searchResults: specifying parameters for a search query
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.
Attributes of record objects
'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').
Allowed values:
'and', 'or'
This is just here because empty directories will be wiped out.
......@@ -23,7 +23,3 @@ def initialize(context):
ZCatalog.manage_addZCatalog),
icon='www/ZCatalog.gif',
)
context.registerHelp()
context.registerHelpTitle('Zope Help')
<dtml-var manage_page_header>
<dtml-var "manage_form_title(this(), _,
form_title='Add Index',
help_product='PluginIndexes',
help_topic='PluginIndexes.stx'
)">
<p class="form-help">
help for adding indexes....
</p>
<dtml-var "manage_form_title(this(), _, form_title='Add Index')">
<form action="manage_addIndex" method="post">
<input type=hidden name="type" value="&dtml-index_type;">
......
<dtml-var manage_page_header>
<dtml-var "manage_form_title(this(), _,
form_title='Add ZCatalog',
help_product='ZCatalog',
help_topic='ZCatalog_Add.stx'
)">
<dtml-var "manage_form_title(this(), _, form_title='Add ZCatalog')">
<FORM ACTION="manage_addZCatalog" METHOD="POST">
<table cellspacing="0" cellpadding="2" border="0">
......
##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (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):
"""Add a ZCatalog object.
'vocab_id' -- this argument is deprecated and ignored.
"""
class ZCatalog:
"""ZCatalog object
A ZCatalog contains arbitrary index like references to Zope
objects. ZCatalog's can index object attribute using a variety
of "plug-in" index types.
Several index types are included, and others may be added.
Text -- Text indexes index textual content. The index can be
used to search for objects containing certain words.
Field -- Field indexes index atomic values. The index can be
used to search for objects that have certain properties.
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
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.
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
URL, this is an excellent unique qualifier in Zope).
"""
def catalog_object(obj, uid, idxs=None, update_metadata=1):
"""Catalogs the object 'obj' with the unique identifier 'uid'.
The uid must be a physical path, either absolute or relative to
the catalog.
If provided, idxs specifies the names of indexes to update.
If update_metadata is specified (the default), the object's metadata
is updated. If it is not, the metadata is left untouched. This
flag has no effect if the object is not yet cataloged (metadata
is always added for new objects).
"""
def uncatalog_object(uid):
"""Uncatalogs the object with the unique identifier 'uid'.
The uid must be a physical path, either absolute or relative to
the catalog.
"""
def uniqueValuesFor(name):
"""returns the unique values for a given FieldIndex named 'name'.
"""
def getpath(rid):
"""Return the path to a cataloged object given a 'data_record_id_'
"""
def getrid(rid):
"""Return the 'data_record_id_' to a cataloged object given a path
"""
def getobject(rid, REQUEST=None):
"""Return a cataloged object given a 'data_record_id_'
"""
def schema():
"""Get the meta-data schema
Returns a sequence of names that correspond to columns in the
meta-data table.
"""
def indexes():
"""Returns a sequence of names that correspond to indexes.
"""
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.
Search queries consist of a mapping of index names to search
parameters. You can either pass a mapping to searchResults as
the variable 'REQUEST' or you can use index names and search
parameters as keyword arguments to the method, in other words::
searchResults(title='Elvis Exposed',
author='The Great Elvonso')
is the same as::
searchResults({'title' : 'Elvis Exposed',
'author : 'The Great Elvonso'})
In these examples, 'title' and 'author' are indexes. This
query will return any objects that have the title *Elvis
Exposed* AND also are authored by *The Great Elvonso*. Terms
that are passed as keys and values in a searchResults() call
are implicitly ANDed together. To OR two search results, call
searchResults() twice and add concatenate the results like this::
results = ( searchResults(title='Elvis Exposed') +
searchResults(author='The Great Elvonso') )
This will return all objects that have the specified title OR
the specified author.
There are some special index names you can pass to change the
behavior of the search query:
sort_on -- This parameters specifies which index to sort the
results on.
sort_order -- You can specify 'reverse' or 'descending'.
Default behavior is to sort ascending.
sort_limit -- An optimization hint to tell the catalog how many
results you are really interested in. See the limit argument
to the search method for more details.
There are some rules to consider when querying this method:
- an empty query mapping (or a bogus REQUEST) returns all
items in the catalog.
- results from a query involving only field/keyword
indexes, e.g. {'id':'foo'} and no 'sort_on' will be
returned unsorted.
- results from a complex query involving a field/keyword
index *and* a text index,
e.g. {'id':'foo','PrincipiaSearchSource':'bar'} and no
'sort_on' will be returned unsorted.
- results from a simple text index query
e.g.{'PrincipiaSearchSource':'foo'} will be returned
sorted in descending order by 'score'. A text index
cannot beused as a 'sort_on' parameter, and attempting
to do so will raise an error.
Depending on the type of index you are querying, you may be
able to provide more advanced search parameters that can
specify range searches or wildcards. These features are
documented in The Zope Book.
"""
def __call__(REQUEST=None, **kw):
"""Search the catalog, the same way as 'searchResults'.
"""
def search(query_request, sort_index=None, reverse=0, limit=None, merge=1):
"""Programmatic search interface, use for searching the catalog from
scripts.
query_request -- Dictionary containing catalog query. This uses the
same format as searchResults.
sort_index -- Name of sort index
reverse -- Boolean, reverse sort order (defaults to false)
limit -- Limit sorted result count to the n best records. This is an
optimization hint used in conjunction with a sort_index. If possible
ZCatalog will use a different sort algorithm that uses much less memory
and scales better then a full sort. The actual number of records
returned is not guaranteed to be <= limit. You still need to apply the
same batching to the results. Since the len() of the results will no
longer be the actual result count, you can use the
"actual_result_count" attribute of the lazy result object instead to
determine the size of the full result set.
merge -- Return merged, lazy results (like searchResults) or raw
results for later merging. This can be used to perform multiple
queries (even across catalogs) and merge and sort the combined results.
"""
def refreshCatalog(clear=0, pghandler=None):
"""Reindex every object we can find, removing the unreachable
ones from the index.
clear -- values: 1|0 clear the catalog before reindexing
pghandler -- optional Progresshandler as defined in ProgressHandler.py
(see also README.txt)
"""
def reindexIndex(name, REQUEST, pghandler=None):
"""Reindex a single index.
name -- id of index
REQUEST -- REQUEST object
pghandler -- optional Progresshandler as defined in ProgressHandler.py
(see also README.txt)
"""
ZCatalog: Index and Search for Zope objects
Description
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 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, or deleting and adding them.
ZCatalog - Add: Create new ZCatalog
Description
This view allows you to create a new ZCatalog.
Controls
'Id' -- Allows you to specify the id of the ZCatalog.
'Title' -- Allows you to specify the title of the ZCatalog.
'Vocabulary' -- Allows you to select whether or not you
would like to use a 'Vocabulary' and then choose the
Vocabulary from the selection list.
'Add' -- Create a new and empty Catalog.
ZCatalog - Advanced: Control advanced Catalog features
Description
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.
Controls
'Update Catalog' -- Clicked, it will update the meta data for
all of the objects in the Catalog. **Note:** The Catalog is
not being updated after each transaction.
'Clear Catalog' -- Clicked, all objects are removed from the
Catalog.
'Enable/Disable' -- If enables, the Subtransaction system is
enabled and the threshold specified below is used.
'Set Threshold' -- Allows you to specify how often the
ZCatalog will commit the subtransactions. The default value is
10000.
ZCatalog - Cataloged Objects: Manage catalog entries
Description
This view allows you to manage catalog entries.
The catalog holds records which refer to Zope objects. If the
catalog currently contains records they will be listed in this
view. For debugging purposes, you may click on the link to
the item in the Catalog and it will open a debugging view of
that entry in the Catalog.
Controls
'[List of objects]' -- Each lines describes one object. The
checkbox in the front of the line, allows you to checkmark the
object for deletion ('Delete') or to update the objects
('Update'). Next the object type is listed, followed by the
object path and the object title. Clicking on the path and
title of the object, you can examine individual catalog
records by clicking on the record name links.
'Next/Previos XX entries' -- Allows you to see more of the
cataloged objects. These two links will only appear if you
have enough objects in the Catalog.
'Update' -- When clicked, Zope updates its indexes and
metadata for the object.
'Remove' -- When clicked, it removes all the selected objects
from the Catalog. **Note:** No objects are deleted from the
database.
ZCatalog - Find Items to ZCatalog: Add records to the Catalog
Description
This view allows you to add records to the catalog.
This view operates like a normal find view (see "Folder - Find")
to locate objects for cataloging. Objects which match the find criteria
will be added to the catalog.
ZCatalog - Indexes: Manage Catalog Indexes
Description
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.
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 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 'ZCTextIndex', 'FieldIndex', 'KeywordIndex' and
'PathIndex'. Please refer to the table below to see a
description of each Index.
'Add' -- The new Index will be added to this catalog.
This table lists the different Index types and describes their
purpose.
'ZCTextIndex' -- Text indexes 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.
'TopicIndex' -- A TopicIndex is a container for so-called
FilteredSet. A FilteredSet consists of an expression and a set
of internal ZCatalog document identifiers that represent a
pre-calculated result list for performance reasons. Instead of
executing the same query on a ZCatalog multiple times it is much
faster to use a TopicIndex instead.
ZCatalog - MetaData Table: Manage Catalog record schema
Description
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.
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.
'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.
'Add' -- When clicked, the new entry (column) will be added to
this catalog.
ZCatalog - searchResults: specifying parameters for a search query
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.
Attributes of record objects
'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').
Allowed values:
'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).
Allowed values:
'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.
'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)
Parameters for searchResults():
'optimize' -- ZCatalog performs a query optimization for queries
not passed through the web (either as dictionary or mapping). To
disable this optimization set optimize to 0 (optional, default: 1).
Optimization is disabled for searches through the web.
ZCatalog - Status: Control advanced Catalog features
Description
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
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.
'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.
'Index Status' List -- Each line corresponds to one Index. The
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