modules/cck_facets/README.txt

$Id: README.txt,v 1.10 2009/01/04 22:24:18 davidlesieur Exp $

README file for the CCK Facets Drupal module package.


Description
***********

CCK Facets is a bundle of modules that integrate with Faceted Search to expose
Content Construction Kit (CCK) fields as facets. This allows users to browse
field values and to filter search results with those values.

The supported CCK field types are:

- Text
- Number
- Node Reference
- User Reference
- Date
- Datestamp
- Computed Field


Requirements
************

- Drupal 6.x (http://drupal.org/project/drupal).

- Faceted Search (http://drupal.org/project/faceted_search).

- Content Construction Kit (CCK) (http://drupal.org/project/cck).


Installation
************

1. Extract the cck_facets package directory into your Drupal modules directory.

2. Go to the Administer > Site building > Modules page, and enable the CCK
   Facets module.

3. Enable any of the following modules, depending on the types of CCK fields you
   wish to expose as facets:

   - CCK Text Facets (for Text fields).
   - CCK Number Facets (for Number fields).
   - CCK Reference Facets (for Node Reference or User Reference fields).
   - CCK Date Facets (for Date or Datestamp fields).
   - CCK Computed Facets (for Computed fields). Note that in order to be
     accessible to CCK Computed Facets, a computed field must be configured to
     store its values in the database.

   Only the above types of fields are supported at the moment.

4. Go to the Administer > Site configuration > Faceted Search page, edit the
   faceted search environment that shall expose CCK-based facets. In the
   environment editing form, check each facet you wish to expose.

   CAUTION: This system hands you over the responsibility of deciding what field
   is appropriate for use as a facet. Long text fields should never be used as
   facets, since their values are too long to be usable in the Guided search,
   and might exceed the maximum URL length in browsers or servers when used as
   search criteria.


Support
*******

For support requests, bug reports, and feature requests, please use the
project's issue queue on http://drupal.org/project/issues/cck_facets.

Please DO NOT send bug reports through e-mail or personal contact forms, use the
aforementioned issue queue instead.


Credits
*******

- Sponsored in part by Laboratoire NT2 (http://www.labo-nt2.uqam.ca).

1	$Id: README.txt,v 1.10 2009/01/04 22:24:18 davidlesieur Exp $
2
3	README file for the CCK Facets Drupal module package.
4
5
6	Description
7	***********
8
9	CCK Facets is a bundle of modules that integrate with Faceted Search to expose
10	Content Construction Kit (CCK) fields as facets. This allows users to browse
11	field values and to filter search results with those values.
12
13	The supported CCK field types are:
14
15	- Text
16	- Number
17	- Node Reference
18	- User Reference
19	- Date
20	- Datestamp
21	- Computed Field
22
23
24	Requirements
25	************
26
27	- Drupal 6.x (http://drupal.org/project/drupal).
28
29	- Faceted Search (http://drupal.org/project/faceted_search).
30
31	- Content Construction Kit (CCK) (http://drupal.org/project/cck).
32
33
34	Installation
35	************
36
37	1. Extract the cck_facets package directory into your Drupal modules directory.
38
39	2. Go to the Administer > Site building > Modules page, and enable the CCK
40	Facets module.
41
42	3. Enable any of the following modules, depending on the types of CCK fields you
43	wish to expose as facets:
44
45	- CCK Text Facets (for Text fields).
46	- CCK Number Facets (for Number fields).
47	- CCK Reference Facets (for Node Reference or User Reference fields).
48	- CCK Date Facets (for Date or Datestamp fields).
49	- CCK Computed Facets (for Computed fields). Note that in order to be
50	accessible to CCK Computed Facets, a computed field must be configured to
51	store its values in the database.
52
53	Only the above types of fields are supported at the moment.
54
55	4. Go to the Administer > Site configuration > Faceted Search page, edit the
56	faceted search environment that shall expose CCK-based facets. In the
57	environment editing form, check each facet you wish to expose.
58
59	CAUTION: This system hands you over the responsibility of deciding what field
60	is appropriate for use as a facet. Long text fields should never be used as
61	facets, since their values are too long to be usable in the Guided search,
62	and might exceed the maximum URL length in browsers or servers when used as
63	search criteria.
64
65
66	Support
67	*******
68
69	For support requests, bug reports, and feature requests, please use the
70	project's issue queue on http://drupal.org/project/issues/cck_facets.
71
72	Please DO NOT send bug reports through e-mail or personal contact forms, use the
73	aforementioned issue queue instead.
74
75
76	Credits
77	*******
78
79	- Sponsored in part by Laboratoire NT2 (http://www.labo-nt2.uqam.ca).
80