modules/project_issue_voting/INSTALL.txt

$Id: INSTALL.txt,v 1.1 2008/08/16 12:32:01 dww Exp $

It is assumed that you have Drupal up and running.  Be sure to check
the http://drupal.org web site if you need assistance.  If you run
into problems, you should always read the INSTALL.txt that comes with
the Drupal package and read the online documentation.

0. Always backup your database before you enable a new contributed module!


1. This module depends on:
   Project issue tracking (http://drupal.org/project/project_issue)
   Voting API (http://drupal.org/project/votingapi)
   Download and install those modules as per their own instructions.


2. Place all of the modules in the appropriate 'modules' directory for
   your site.


3. Enable the modules at: Administer > Site building > Modules


4. Grant the proper access control to users on the site at:
   Administer > User management > Access control

   'administer issue voting':
     Allows users to modify administrative settings for issue voting.

   'view issue votes:
     Allows users to view information about issue votes.

   'vote on issues:
     Allows users to vote on issues.


5. To configure the site-wide optins for the module, navigate to:
   Administer > Project administration > Project issue voting

   Here you can define the total number of votes each user can
   allocate at any given time, control which kinds of issues can
   accept votes, and control the appearance of the voting interface.


6. Optional: install Views (http://drupal.org/project/views) and
   Panels2 (http://drupal.org/project/panels).  The Project issue
   voting module exports some default views and panel pages that
   provide a dashboard of issue voting on the site if these modules
   are present.

   NOTE: In views 5.x-*, it is not possible to restrict access to a
   view based directly on a permission.  So, if you restrict access to
   the 'view issue votes' permission, be sure to restrict access to
   the default view(s) and panel page(s) exported by this module using
   the appropriate user roles for your site.


Once everything is properly enabled and configured, you will find all
the pages and views provided by this module at "project/issues/votes",
for example:

http://example.com/project/issues/votes

There will also be an "Issue votes" tab on your user profile pages,
for example:

http://example.com/user/1/project-issue-votes

Finally, on any project issue that is configured to allow issue
voting, you'll see a voting widget, and, permissions and configuration
allowing a "Votes" tab to see all the votes on that particular issue.
1	$Id: INSTALL.txt,v 1.1 2008/08/16 12:32:01 dww Exp $
2
3	It is assumed that you have Drupal up and running. Be sure to check
4	the http://drupal.org web site if you need assistance. If you run
5	into problems, you should always read the INSTALL.txt that comes with
6	the Drupal package and read the online documentation.
7
8	0. Always backup your database before you enable a new contributed module!
9
10
11	1. This module depends on:
12	Project issue tracking (http://drupal.org/project/project_issue)
13	Voting API (http://drupal.org/project/votingapi)
14	Download and install those modules as per their own instructions.
15
16
17	2. Place all of the modules in the appropriate 'modules' directory for
18	your site.
19
20
21	3. Enable the modules at: Administer > Site building > Modules
22
23
24	4. Grant the proper access control to users on the site at:
25	Administer > User management > Access control
26
27	'administer issue voting':
28	Allows users to modify administrative settings for issue voting.
29
30	'view issue votes:
31	Allows users to view information about issue votes.
32
33	'vote on issues:
34	Allows users to vote on issues.
35
36
37	5. To configure the site-wide optins for the module, navigate to:
38	Administer > Project administration > Project issue voting
39
40	Here you can define the total number of votes each user can
41	allocate at any given time, control which kinds of issues can
42	accept votes, and control the appearance of the voting interface.
43
44
45	6. Optional: install Views (http://drupal.org/project/views) and
46	Panels2 (http://drupal.org/project/panels). The Project issue
47	voting module exports some default views and panel pages that
48	provide a dashboard of issue voting on the site if these modules
49	are present.
50
51	NOTE: In views 5.x-*, it is not possible to restrict access to a
52	view based directly on a permission. So, if you restrict access to
53	the 'view issue votes' permission, be sure to restrict access to
54	the default view(s) and panel page(s) exported by this module using
55	the appropriate user roles for your site.
56
57
58	Once everything is properly enabled and configured, you will find all
59	the pages and views provided by this module at "project/issues/votes",
60	for example:
61
62	http://example.com/project/issues/votes
63
64	There will also be an "Issue votes" tab on your user profile pages,
65	for example:
66
67	http://example.com/user/1/project-issue-votes
68
69	Finally, on any project issue that is configured to allow issue
70	voting, you'll see a voting widget, and, permissions and configuration
71	allowing a "Votes" tab to see all the votes on that particular issue.