[[PageOutline(2-5,Contents,pullout)]]

= Star rating system for wiki pages and tickets

== Description

This plugin lets users vote for a Trac resource, including Wiki pages, tickets, milestones, by using a five-star rating system. This plugin is a modified version of the VotePlugin, but except for having up and down arrows, this plugin uses a five-star approach to rate resources:

[[Image(wiki:FiveStarVotePlugin:fivestarvote.jpg, border=2)]]

While it has been forked from VotePlugin code in October 2008, and some bugs fixed (#3298, #3808), current development has pushed !VotePlugin ahead significantly. Applying similar changes here too is certainly possible, but merging the code might become the option of choice for improved long-term support.
 
== Bugs/Feature Requests

Existing bugs and feature requests for FiveStarVotePlugin are 
[report:9?COMPONENT=FiveStarVotePlugin here].

If you have any issues, create a 
[/newticket?component=FiveStarVotePlugin new ticket].

[[TicketQuery(component=FiveStarVotePlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:fivestarvoteplugin here].

== Source

You can check out FiveStarVotePlugin from [/svn/fivestarvoteplugin here] using Subversion, or [source:fivestarvoteplugin browse the source] with Trac.

== Installation

Install the plugin:

{{{#!sh
$ pip install svn+https://trac-hacks.org/svn/fivestarvoteplugin/1.0
}}}

Add the following to the `[components]` section of [wiki:TracIni trac.ini] or enable the plugin though the !WebAdmin panel:
{{{#!ini
[components]
fivestarvote.* = enabled
}}}

== Configuration

The following option can be specified in [wiki:TracIni trac.ini] (default value shown):
{{{#!ini
[fivestarvote]
paths = '^/$,^/wiki*,^/ticket*'  #List of URL paths to allow voting on. Globs are supported.
}}}

Grant users the `VOTE_VIEW` and `VOTE_MODIFY` permission where appropriate. `VOTE_MODIFY` will not work for anonymous users:

{{{#!sh
trac-admin [trac environment pathname] permission add anonymous VOTE_VIEW
}}}
{{{#!sh
trac-admin [trac environment pathname] permission add authenticated VOTE_MODIFY
}}}

You may need to run:
{{{#!sh
trac-admin [trac environment pathname] upgrade
}}}

== Recent Changes

[[ChangeLog(fivestarvoteplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:davglass] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''