Contents of /contributions/modules/volunteer/README

Volunteer Module
by Josh Koenig (joshk@outlandishjosh.com)
some original code by the Brothers Moon (dustin@riseup.net, garret@riseup.net)

OVERVIEW

This code extends the event module and bridges it with CiviCRM to
allow privileged site users to act as coordinators of volunteers for
events.

Here's the process:

event creation > volunteer configurations > visitors volunteer >
coordinator approves > volunteers are reminded > coordinator rates
performance

When an event-enabled node is created, you will have an additional tab
along with "view" and "edit" called "volunteer admin." This will let
you configure which user is to coordinate for the event and how many
volunteers they're looking for.

The module interacts with CiviCRM to collect information about
prospective volunteers. When a site visitor clicks to volunteer, they
will enter some information (the fields managed by CiviCRM, which you
configure in admin > volunteer > settings) which will be stored in the
database.

The module then initiates a managed email conversation between
prospective volunteers and the coordinator. First a coordinator is
notified that a visitor has signed up to volunteer, at which point
they can confirm, deny or wait-list the visitor, who will be notified
of this decision. If the visitor is confirmed to volunteer, they will
be reminded of their commitment 48 hours before the event.

After the event is over, the coordinator has the ability to rate the
volunteer's performance. These ratings are averaged over time so that
coordinators can avoid troublesome volunteers in favor of more
reliable ones.

SETTINGS 
The settings at your disposal in the volunteer module include whether
or not all events should be volunteer-ready by default, who the
default volunteer coordinator should be and how many volunteer "slots"
should be available. You can also select which fields to display on
your volunteer forms by chosing the appropriate CiviCRM profile (note:
all volunteer fields are required, so it's best to keep this to a
minimum) as well as setting up the text of the email messages the
module will send throught the volunteer cycle.

There are also two access privileges established by the module.
"Volunteer admin" allows a user to set up events which they themselves
or other users will coordinate for. "Volunteer Coordinate" allows
users to set up events which they will coordinate, and allows them to
be designated as the coordinator for events set up by a volunteer
administrator.

Good luck! Happy volunteering!

(this module was built for musicforamerica.org)
(CiviCRM support added for civicspacelabs.org by Gerhard Killesreiter)
1	Volunteer Module
2	by Josh Koenig (joshk@outlandishjosh.com)
3	some original code by the Brothers Moon (dustin@riseup.net, garret@riseup.net)
4
5	OVERVIEW
6
7	This code extends the event module and bridges it with CiviCRM to
8	allow privileged site users to act as coordinators of volunteers for
9	events.
10
11	Here's the process:
12
13	event creation > volunteer configurations > visitors volunteer >
14	coordinator approves > volunteers are reminded > coordinator rates
15	performance
16
17	When an event-enabled node is created, you will have an additional tab
18	along with "view" and "edit" called "volunteer admin." This will let
19	you configure which user is to coordinate for the event and how many
20	volunteers they're looking for.
21
22	The module interacts with CiviCRM to collect information about
23	prospective volunteers. When a site visitor clicks to volunteer, they
24	will enter some information (the fields managed by CiviCRM, which you
25	configure in admin > volunteer > settings) which will be stored in the
26	database.
27
28	The module then initiates a managed email conversation between
29	prospective volunteers and the coordinator. First a coordinator is
30	notified that a visitor has signed up to volunteer, at which point
31	they can confirm, deny or wait-list the visitor, who will be notified
32	of this decision. If the visitor is confirmed to volunteer, they will
33	be reminded of their commitment 48 hours before the event.
34
35	After the event is over, the coordinator has the ability to rate the
36	volunteer's performance. These ratings are averaged over time so that
37	coordinators can avoid troublesome volunteers in favor of more
38	reliable ones.
39
40	SETTINGS
41	The settings at your disposal in the volunteer module include whether
42	or not all events should be volunteer-ready by default, who the
43	default volunteer coordinator should be and how many volunteer "slots"
44	should be available. You can also select which fields to display on
45	your volunteer forms by chosing the appropriate CiviCRM profile (note:
46	all volunteer fields are required, so it's best to keep this to a
47	minimum) as well as setting up the text of the email messages the
48	module will send throught the volunteer cycle.
49
50	There are also two access privileges established by the module.
51	"Volunteer admin" allows a user to set up events which they themselves
52	or other users will coordinate for. "Volunteer Coordinate" allows
53	users to set up events which they will coordinate, and allows them to
54	be designated as the coordinator for events set up by a volunteer
55	administrator.
56
57	Good luck! Happy volunteering!
58
59	(this module was built for musicforamerica.org)
60	(CiviCRM support added for civicspacelabs.org by Gerhard Killesreiter)