Configuration for Simple Rating
Fivestar has two completely separate modes of operation. The first is letting an end-user rate a piece of content. The settings for this are on the content type settings page. These settings let you expose a rating widget when viewing the node, not editing it. Clicking on the widget registers a vote for that node, and never anything else.
The configuration for Fivestar is spread between the content type settings page, Fivestar site settings page, and access permissions. To configure:
- Configure the site-wide setting for Fivestar, Administer -> Settings -> Fivestar.
- Activate voting on each content type. For example, if you want Fivestar to appear on story nodes, use Administer -> Content Management -> Content Types -> Story, and check the "Enable Five Star rating" box under the "Five Star ratings" heading. Repeat for each content type desired.
- Enable anonymous voting.
If you want to allow anonymous voting, you'll need to set permissions for that. Use Administer -> User Management -> Access Control, and check the "rate content" and "view ratings" checkboxes for the roles you'd like.
You'll find these permission items under the "fivestar module" heading.
Configuration as a CCK field / Advanced Rating
Fivestar has extensive CCK support, which makes it so that the user is presented with a widget to rate some node with the widget while editing a node. It does not necessary rate the current node, nor does it rate anything if no value is entered in the Node ID field when configuring the CCK field. The value is saved in the node (so when you edit it it is still there), but no vote is registered in Voting API without the Node ID field filled out.
An example of a situation where you might want to use the CCK fivestar field is creating a node type called 'review'. This review type would let users rate some particular node, and accompany their rating with a review. This could be combined with a standard rating on the target node, so that some users could rate the target node using the simple method, or write a complete review to accompany their rating.
To configure a CCK field for rating a node while creating a new 'review' node:
- Create a new node type called 'review' at Administer -> Content Management -> Content Types. Configure the type. Do NOT set any fivestar settings on the content type form! We don't want users to actually be able to rate the reviews themselves!
- Edit your new content type, then click on the "Add Field" tab while on the content type form. Add a field called 'rating' to your new type, make it of type Fivestar Rating with the Stars radio button.
- Configure the rating widget to your liking. Most field have help text which explain their purpose. The Node ID field is the most important field on the page which determines exactly what node will receive the value of the rating. In a realy simple case, you could just enter the value 10 to always rate on the same node with nid = 10. Usually you'll need to enter PHP code to dynamically select what node you want to rate. For example, if you would like to apply the ratings to a node specified in a node_reference field, use:
A common scenario is using fivestar with nodecomments to make reviews, sample code for this can be found here: http://drupal.org/node/148150
Save your field. Now when making new nodes of type 'review', the user will select a star that will register a vote on the value of the Node ID field.