modules/field_indexer/README.txt

$Id: README.txt,v 1.5 2009/01/04 22:20:56 davidlesieur Exp $

README file for the Field Indexer module.


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

The Field Indexer module indexes field data into Drupal's search index. Each
field enabled for indexing becomes a type of index entry. Then, with an
appropriate search module, users may perform keyword searches restricted by
field.


Search modules
**************

The following modules implement field search based on index data generated by
Field Indexer:

- Faceted Search (http://drupal.org/project/faceted_search); this support is
  experimental, only in the dev version at this point.

One could imagine similar support being added to Views, for example, although no
one have stepped up.

[1] http://drupal.org/project/views


The package
***********

Field Indexer is in fact a bundle of modules:

- Field Indexer: Provides a configuration page where the site administrator may
  select which fields to index. This module also provides a basic API for field
  indexing modules.

- Node Field Indexer: Implements indexing for core node data (only the node
  title is supported at the moment).

- CCK Field Indexer: Implements indexing for CCK [3] fields.

Third-party modules may implement support for additional types of fields.

[3] http://drupal.org/project/cck


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

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


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

1. Extract the 'field_indexer' module directory, including all its
   subdirectories, into your Drupal modules directory.

2. Go to the Administer > Site building > Modules page, and enable the following
   modules:

   - Field Indexer
   - Node Field Indexer and/or CCK Field Indexer

3. Go to the Administer > Site configuration > Field Indexer page, and select
   the fields you wish to index. Indexing will start on the next cron run.


Support
*******

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

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

For general discussions about Field Indexer (or other Drupal search solutions),
you are invited to join the Search group on http://groups.drupal.org/node/4102.


Credits
*******

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

1	$Id: README.txt,v 1.5 2009/01/04 22:20:56 davidlesieur Exp $
2
3	README file for the Field Indexer module.
4
5
6	Description
7	***********
8
9	The Field Indexer module indexes field data into Drupal's search index. Each
10	field enabled for indexing becomes a type of index entry. Then, with an
11	appropriate search module, users may perform keyword searches restricted by
12	field.
13
14
15	Search modules
16	**************
17
18	The following modules implement field search based on index data generated by
19	Field Indexer:
20
21	- Faceted Search (http://drupal.org/project/faceted_search); this support is
22	experimental, only in the dev version at this point.
23
24	One could imagine similar support being added to Views, for example, although no
25	one have stepped up.
26
27	[1] http://drupal.org/project/views
28
29
30	The package
31	***********
32
33	Field Indexer is in fact a bundle of modules:
34
35	- Field Indexer: Provides a configuration page where the site administrator may
36	select which fields to index. This module also provides a basic API for field
37	indexing modules.
38
39	- Node Field Indexer: Implements indexing for core node data (only the node
40	title is supported at the moment).
41
42	- CCK Field Indexer: Implements indexing for CCK [3] fields.
43
44	Third-party modules may implement support for additional types of fields.
45
46	[3] http://drupal.org/project/cck
47
48
49	Requirements
50	************
51
52	- Drupal 6.x (http://drupal.org/project/drupal).
53
54
55	Installation
56	************
57
58	1. Extract the 'field_indexer' module directory, including all its
59	subdirectories, into your Drupal modules directory.
60
61	2. Go to the Administer > Site building > Modules page, and enable the following
62	modules:
63
64	- Field Indexer
65	- Node Field Indexer and/or CCK Field Indexer
66
67	3. Go to the Administer > Site configuration > Field Indexer page, and select
68	the fields you wish to index. Indexing will start on the next cron run.
69
70
71	Support
72	*******
73
74	For support requests, bug reports, and feature requests, please use Field
75	Indexer's issue queue on http://drupal.org/project/issues/field_indexer
76
77	Please DO NOT send bug reports through e-mail or personal contact forms, use the
78	aforementioned issue queue instead.
79
80	For general discussions about Field Indexer (or other Drupal search solutions),
81	you are invited to join the Search group on http://groups.drupal.org/node/4102.
82
83
84	Credits
85	*******
86
87	- Sponsored by Laboratoire NT2 (http://www.labo-nt2.uqam.ca).
88