[[PageOutline(2-5, Contents, pullout)]]
= Reddit-style voting on Trac resources =

== Description ==

This plugin adds a context-navigation entry, that lets users easily vote for a Trac resource, including Wiki pages, tickets, milestones, etc.

If a user has a valid session (created through the [/prefs Preferences] panel) and the `VOTE_MODIFY` permission, he/she will be able to vote.

Since `tracvote-0.2` there are some [wiki:VotePlugin/WikiMacros WikiMacros] available in addition to [source:voteplugin/trunk/SqlQueryForReport.txt example TracReports] on the `votes` db table.

== Translation ==

Please help to translate the plugin into your language: [https://www.transifex.com/projects/p/Trac_Plugin-L10N/resource/voteplugin/]

== Bugs/Feature Requests ==

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

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=VotePlugin&owner=rjollos&cc=hasienda new ticket].

== Download ==

Download the zipped source from [download:voteplugin here].

== Source ==

You can check out VotePlugin from [http://trac-hacks.org/svn/voteplugin here] using Subversion, or [source:voteplugin browse the source] with Trac.

== Installation ==
'''Note:''' Documentation has been updated to already reflect features of current `trunk` development branch, that is in preparation for next stable release `tracvote-0.2`. To get the best first-time experience you may wish to try the release candidate right now. But beware, that there is ''no down-grade'' support, while upgrading from previous plugin versions has been tested on different db back-ends and should work flawlessly.

Install the plugin:

{{{
#!sh
easy_install http://trac-hacks.org/svn/voteplugin/tags/0.1.5
}}}

If you get "error: Unexpected HTML page found at http://trac-hacks.org/svn/voteplugin/tags/0.1.5", update setuptools:

{{{
#!sh
sudo easy_install -U setuptools
}}}

Add the following to the `[components]` section of [wiki:TracIni trac.ini]:

{{{
#!ini
[components]
tracvote.* = enabled
}}}

Configure the list of URL paths to allow voting on in ''trac.ini''. Globs are supported.
{{{
#!ini
[vote]
paths = 
}}}

Grant users the `VOTE_VIEW` and `VOTE_MODIFY` permission where appropriate.

'''Note:'''
 * `VOTE_MODIFY` inherits view permission since `tracvote-0.1.5`.
 * Since `tracvote-0.2` a default set of permissions is configured once after creating the Trac database table for this plugin.

Probably you'll need to run:
{{{
#!sh
trac-admin /path/to/projenv upgrade
}}}

You will also need to restart your webserver for the plugin to be available, appear in the list of those installed, have the perms available, etc.

Example SQL statements for creating useful reports for tickets and wiki pages are included in [source:voteplugin/trunk/SqlQueryForReport.txt SqlQueryForReport.txt] in the plugin source.

== Screenshot ==

[[Image(votes.png)]]

== Recent Changes ==

[[ChangeLog(voteplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:athomas] [[BR]]
'''Maintainer:''' rjollos, hasienda [[BR]]
'''Contributors:''' [wiki:k0s], PeterLawrence