modules/userreview/README.txt

OVERVIEW
This module enables users to post a review of any node.  This module is inspired by some of the ubiquitous user review functionality seen in the internet, such as amazon.com.
A userreview consists of a voting widget (scale of 0-10), a title, and a review_text field.  Administrators configure which node types should
be reviewable.  This module places voting results, review forms, and paginated lists of user reviews after each
node of these types.  Each user may submit a single review for each node.  

Although this module currently permits voting on a 0-10 scale, it should not be hard to have a more flexible scale,
such as A+ through F, or any sequence of numbers.  This module supports voting on a single axis only (and does
not support voting on multiple independent factors like price, customer service).

It uses the votingapi to handle voting values, and it uses the views module to list user reviews under each reviewed
node.  Since votingapi supporting views module as well, you can generate interesting blocks or pages of 
top rated nodes of a given type in a given category, etc.

UPDATES
2006/5/3 - updated to work with latest changes to votingapi module.
Please be sure to also update to the latest release of votingapi.
Also changed the tagging to (a) comply better with votingapi standards and
and (b) better identify userreview votes as coming from userreview, permitting
overlapping voting systems.

2006/4/14 - improved layout.  All userreview forms and reviews appear in collapsed field sets.  
Userreview forms & data is now easily accessible but unobtrusive.  Only average vote for each node still 
appears uncollapsed.

2006/12/18 - added some display features. It now is possible to hide the current user's review, have the reviews be teasered,
and have a 'add a review' link. Some bugs regarding support for the view module have been fixed and exprimental PostgreSQL 
support has been added (thanks to Chris Brown, http://drupal.org/user/65954).

2007/02/08 - added setting to change the number of decimal places on vite result and a css class dependend on the result. The module 
now integrates with pathauto, too, and the last annoyances about the default views view have been removed.

DEPENDENCIES
This module works in Drupal 4.7.  It requires the votingapi module and the views module to function.  
PostgreSQL support is experimental.

INSTALLATION
(1) Place the userreview folder in your modules direcotry.  This folder should contain userreview.module, 
userreview.css, userreview.js
(2) In your site, navigate to admin/modules, and enable the userreview module.

CONFIGURATION
(1) Go to admin/access to set permissions.  Typically you would grant authenticated users the right to 
"create user reviews" and to "edit own user reviews"
(2) Go to admin/settings/userreview to set configuration options.  Settings you can configure here include
	(a) which node types to expose to user reviewing
	(b) the number of nodes to display per page under each reviewed node,
	(c) whether the title and/or review_text fields should be required
	(d) the labels you wish to be displayed in several locations.
	
OUTPUT FIELDS
When viewing a reviewed node, this module adds content to the $node->body field.  It also makes the elements
of the content avaialable as separate fields:
$node->userreview->average_vote - contains the HTML displaying the average vote value, when votes have been cast
$node->userreview->current_user_review - contains the HTML displaying the current user's review, when the current
user has submitted a review for this node
$node->userreview->review_form - contains the HTML displaying the form to submit a user review, when the current
user has not submitted a review for this node
$node->userreview->review_list - contains the HTML showing the list of user reviews, when reviews have been submitted

INTEROPERATION WITH OTHER MODULES
Userreviews are nodes, and thus they work well with userpoints module.  To grant points for submitting a userreview,
simply set the points for the userreview node in the admin/settings/userpoints area.

CONTRIBUTORS
Gerd Riesselmann (userreview@gerd-riesselmann.net) - this module
Chris Brown (http://drupal.org/user/65954) - PostgreSQL support
David Donohue (dado@drupal.org) - initial development of this module
Jeff Eaton (eaton@drupal.org) - votingapi module
Earl Miles (merlinofchaos@drupal.org) - views module
1	OVERVIEW
2	This module enables users to post a review of any node. This module is inspired by some of the ubiquitous user review functionality seen in the internet, such as amazon.com.
3	A userreview consists of a voting widget (scale of 0-10), a title, and a review_text field. Administrators configure which node types should
4	be reviewable. This module places voting results, review forms, and paginated lists of user reviews after each
5	node of these types. Each user may submit a single review for each node.
6
7	Although this module currently permits voting on a 0-10 scale, it should not be hard to have a more flexible scale,
8	such as A+ through F, or any sequence of numbers. This module supports voting on a single axis only (and does
9	not support voting on multiple independent factors like price, customer service).
10
11	It uses the votingapi to handle voting values, and it uses the views module to list user reviews under each reviewed
12	node. Since votingapi supporting views module as well, you can generate interesting blocks or pages of
13	top rated nodes of a given type in a given category, etc.
14
15	UPDATES
16	2006/5/3 - updated to work with latest changes to votingapi module.
17	Please be sure to also update to the latest release of votingapi.
18	Also changed the tagging to (a) comply better with votingapi standards and
19	and (b) better identify userreview votes as coming from userreview, permitting
20	overlapping voting systems.
21
22	2006/4/14 - improved layout. All userreview forms and reviews appear in collapsed field sets.
23	Userreview forms & data is now easily accessible but unobtrusive. Only average vote for each node still
24	appears uncollapsed.
25
26	2006/12/18 - added some display features. It now is possible to hide the current user's review, have the reviews be teasered,
27	and have a 'add a review' link. Some bugs regarding support for the view module have been fixed and exprimental PostgreSQL
28	support has been added (thanks to Chris Brown, http://drupal.org/user/65954).
29
30	2007/02/08 - added setting to change the number of decimal places on vite result and a css class dependend on the result. The module
31	now integrates with pathauto, too, and the last annoyances about the default views view have been removed.
32
33	DEPENDENCIES
34	This module works in Drupal 4.7. It requires the votingapi module and the views module to function.
35	PostgreSQL support is experimental.
36
37	INSTALLATION
38	(1) Place the userreview folder in your modules direcotry. This folder should contain userreview.module,
39	userreview.css, userreview.js
40	(2) In your site, navigate to admin/modules, and enable the userreview module.
41
42	CONFIGURATION
43	(1) Go to admin/access to set permissions. Typically you would grant authenticated users the right to
44	"create user reviews" and to "edit own user reviews"
45	(2) Go to admin/settings/userreview to set configuration options. Settings you can configure here include
46	(a) which node types to expose to user reviewing
47	(b) the number of nodes to display per page under each reviewed node,
48	(c) whether the title and/or review_text fields should be required
49	(d) the labels you wish to be displayed in several locations.
50
51	OUTPUT FIELDS
52	When viewing a reviewed node, this module adds content to the $node->body field. It also makes the elements
53	of the content avaialable as separate fields:
54	$node->userreview->average_vote - contains the HTML displaying the average vote value, when votes have been cast
55	$node->userreview->current_user_review - contains the HTML displaying the current user's review, when the current
56	user has submitted a review for this node
57	$node->userreview->review_form - contains the HTML displaying the form to submit a user review, when the current
58	user has not submitted a review for this node
59	$node->userreview->review_list - contains the HTML showing the list of user reviews, when reviews have been submitted
60
61	INTEROPERATION WITH OTHER MODULES
62	Userreviews are nodes, and thus they work well with userpoints module. To grant points for submitting a userreview,
63	simply set the points for the userreview node in the admin/settings/userpoints area.
64
65	CONTRIBUTORS
66	Gerd Riesselmann (userreview@gerd-riesselmann.net) - this module
67	Chris Brown (http://drupal.org/user/65954) - PostgreSQL support
68	David Donohue (dado@drupal.org) - initial development of this module
69	Jeff Eaton (eaton@drupal.org) - votingapi module
70	Earl Miles (merlinofchaos@drupal.org) - views module