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

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

doc files slightly updated before initial public release.

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