source: products/quintagroup.catalogupdater/trunk/README.txt @ 1844

Last change on this file since 1844 was 1844, checked in by olha, 10 years ago

doc files updated more.

  • Property svn:eol-style set to native
File size: 1.2 KB
Line 
1quintagroup.catalogupdater
2==========================
3
4quintagroup.catalogupdater package is intended for extending ZCatalog API
5with possiblity to update selected columns only. This package registers
6'catalog_updater' utility for that.
7
8To simplify usage of the utility, quintagroup.catalogupdater extends GenericSetup's
9ZCatalog XMLAdapter handler, which allows to *update* attribute usage in *column*
10tag of *catalog.xml* file.
11
12So, when you add a new column to the catalog, you add catalog.xml file
13in some profile with following part::
14
15 ...
16 <column value="new_column" />
17 ...
18
19This adds *new_column* metadata to the portal_catalog, BUT, this
20metadata will be empty untill you rebuild the catalog. To automate
21this step you can add 'update="True"' attribute to the tag. And this
22will lead to column update after adding. Thus, result usage should look
23like this::
24
25 ...
26 <column value="new_column" update="True" />
27 ...
28
29It also supports subtransactions, based on threshold property of ZCatalog.
30
31Installation
32------------
33
34See docs/INSTALL.txt file within product package for instructions.
35
36Requirements
37------------
38
39* Plone 3.x
40
41Author
42------
43
44* Andriy Mylenkyi
45
46
47Copyright (c) "Quintagroup": http://quintagroup.com, 2004 - 2010
Note: See TracBrowser for help on using the repository browser.