modules/biblio_facets/README.txt

$Id: README.txt,v 1.4 2008/04/05 23:03:47 davidlesieur Exp $

README file for the Biblio Facets Drupal module.


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

Biblio Facets integrates with Faceted Search to allow users to browse Biblio
types and fields as facets.


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

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

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

- Biblio (http://drupal.org/project/biblio).

- Biblio Normalize (http://drupal.org/project/biblio_normalize). Actually, this
  module is only needed if you wish to expose Biblio's multiple-values fields
  (for example, the Authors and the Keywords fields), but most people using
  Biblio Facets will want this.


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

1. Extract the 'biblio_facets module directory into your Drupal modules
   directory.

2. Go to the Administer > Site building > Modules page. If you wish to expose
   Biblio types as facets, enable the Biblio Type Facet module. If you wish to
   expose Biblio fields as facets, enable the Biblio Facets modules.

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

   CAUTION: If you want to expose a multiple-values field as a facet, you should
   enable its normalization first through Biblio Normalize.

   CAUTION: Biblio Facets hands you over the responsibility of deciding what
   field is appropriate for use as a facet. Full-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.

4. If you wish to fully replace Biblio's search and filtering capabilities with
   Biblio Facets, you'll want to override Biblio's theming functions to replace
   the links that are normally provided.


Support
*******

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

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


Credits
*******

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

1	$Id: README.txt,v 1.4 2008/04/05 23:03:47 davidlesieur Exp $
2
3	README file for the Biblio Facets Drupal module.
4
5
6	Description
7	***********
8
9	Biblio Facets integrates with Faceted Search to allow users to browse Biblio
10	types and fields as facets.
11
12
13	Requirements
14	************
15
16	- Drupal 5.x (http://drupal.org/project/drupal).
17
18	- Faceted Search (http://drupal.org/project/faceted_search).
19
20	- Biblio (http://drupal.org/project/biblio).
21
22	- Biblio Normalize (http://drupal.org/project/biblio_normalize). Actually, this
23	module is only needed if you wish to expose Biblio's multiple-values fields
24	(for example, the Authors and the Keywords fields), but most people using
25	Biblio Facets will want this.
26
27
28	Installation
29	************
30
31	1. Extract the 'biblio_facets module directory into your Drupal modules
32	directory.
33
34	2. Go to the Administer > Site building > Modules page. If you wish to expose
35	Biblio types as facets, enable the Biblio Type Facet module. If you wish to
36	expose Biblio fields as facets, enable the Biblio Facets modules.
37
38	3. Go to the Administer > Site configuration > Faceted Search page, choose to
39	edit the faceted search environment that shall expose Biblio facets. In the
40	environment editing form, check each facet you wish to expose.
41
42	CAUTION: If you want to expose a multiple-values field as a facet, you should
43	enable its normalization first through Biblio Normalize.
44
45	CAUTION: Biblio Facets hands you over the responsibility of deciding what
46	field is appropriate for use as a facet. Full-text fields should never be
47	used as facets, since their values are too long to be usable in the Guided
48	search, and might exceed the maximum URL length in browsers or servers.
49
50	4. If you wish to fully replace Biblio's search and filtering capabilities with
51	Biblio Facets, you'll want to override Biblio's theming functions to replace
52	the links that are normally provided.
53
54
55	Support
56	*******
57
58	For support requests, bug reports, and feature requests, please use the
59	project's issue queue on http://drupal.org/project/issues/biblio_facets.
60
61	Please DO NOT send bug reports through e-mail or personal contact forms, use the
62	aforementioned issue queue instead.
63
64
65	Credits
66	*******
67
68	* Sponsored by Laboratoire NT2 (http://www.labo-nt2.uqam.ca).
69