README

eZ Star Rating extension for eZ Publish
=======================================
Star Rating is an extension that allows the addition of a rating system
to eZ publish content objects via a dedicated datatype.

ezstarating has a dependency on ezjscore, you'll find more info on it here:
http://projects.ez.no/ezjscore

The current version allows ratings between 1 and 5 stars; users can vote
once per session.

The eZ Star Rating module contains images and CSS from Komodo media 
http://komodomedia.com/blog/index.php/2007/01/20/css-star-rating-redux/#

Installation
-----------------
Follow these steps to add the eZ Star Rating module to your eZ publish installation:

  1) Extract the archive into the /extension directory

  2) Edit site.ini.append in /settings/override. Add the following to the file:

       [ExtensionSettings]
       ActiveExtensions[]=ezstarrating

     (if you already have the [ExtensionSettings] block, just add the second line)

     Alternatively activate the extension via the Admin interface.

  3) Create the table to store ratings

       mysql -u[datbase_user] -p[database-password] [databasename] < extension/ezstarrating/sql/mysql/mysql.sql

       Sql files are also provided for postgressql and oracle - refer to the
       database documentation on how to execute queries from a command-line clients

  4) Clear Cache

  5) Set up user permissions

	   For the user roles that are allowed to vote, add in the "roles and policies"
       page in the administration interfacea policy on module "ezjscore", function
       "call", with limitation "ezstarrating_rate"
     
Usage
----------------
To use, simply add a Star Rating attribute to the content class you want to be rated.

License
-----------------

This file may be distributed and/or modified under the terms of the "GNU
General Public License" version 2 as published by the Free Software Foundation

This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

The "GNU General Public License" (GPL) is available at
http://www.gnu.org/copyleft/gpl.html.