modules/rsvp/README.txt


This module lets users invite people to a node and maintains a list of
people who will be attending.

Requires either the event or the date module to be installed.

Installation
------------

1) Copy the rsvp directory into your Drupal modules directory.

2) Go to Administer >> Site Building >> Modules and 

   2.1 enable the RSVP module.

   2.2 enable either the 'RSVP date connector' or the 'RSVP event connector' module. Do not enable both at the same time.
   If you decide to switch from one connector to the other you have to use the uninstall option to uninstall the current connector before  
   you enable the other one.
   Be careful. Uninstalling a connector will remove all existing invitation and RSVP records. Disabling and Enabling is fine though and will not remove
   existing invitations.


Configuration
-------------
1) Enable permissions appropriate to your site.
     The rsvp module provides the following permissions:
	   "administer rsvp"      - full access
     "maintain rsvp"        - access to all invitations, but no permissions to modify the general rsvp settings.
	   "rsvp on events"       - create invitations on nodes.
	   "rsvp on own events"   - create invitations on own nodes.
	   "rsvp newsletters subscribers"  - permission to add attendees based on existing newsletters (module simplenews is required).
	   "rsvp system users"    - permission to add users based on available roles.

2) The basic difference between the event and the date module is that the date module supports reocurring events, and the creation of a Datetime or Date field 
is mandatory.

2.1)If you use the event Module:
From the RSVP perspective there is no other configuration required. You are set to create RSVPs for existing events.


2.2)If you use the date Module:
2.2.1) Create Field
   First you have to add a custom field of type "Datetime" or "Date" to all the content types that you want to utilize as potential events in the future. 
   The RSVP module can manage different "event enabled" content types, but each type needs at least one Datetime or Date field.
2.2.2) Create association(s)
   If the content types are prepared, you need to setup the content type / field associations for each content type that you want to use for RSVP's. You can do that under 
   Administrator >> Site configuration >> RSVP settings >> Assocications >> Add association. The user requires "administer rsvp" permissions to modify associations. 
   Select the content type you added a Datetime or Date field for and press the "add" link. On the following page select the field that you want to utilize. 
   If the field selection box is empty, you did not setup a proper field inside the content type.

3) Disable Wysiwig editor for the "People you like to invite" / "Add Attendees" textarea which
   is part of the manage attendees form when creating a RSVP. The Wysiwig editor should be disabled by default(Tested with FcK).

Manage invitations (Admins and Maintainers)
-------------------------------------
All invitations of all users can be found at 
   Adminstrator >> Content management >> RSVP management
   
   
Create invitations
------------------
Go to the node you want to create an invitation for and click on the Invitation tab.
  If the Invitation tab is not available, 
    - verify that this content type is enabled in the rsvp settings.
    - verify that the user has the right permissions ("rsvp on events" or "rsvp on own events")

Modify invitations
------------------
Automatic startdate adjustment is not supported yet. 
If the startdate of an event/node changes, the startdate of the related invitation needs to be changed
as well.


TODO/Features for upcoming 2.0 release:
--------------------------------------
- Tighter Integration to event nodes. Why do we need an extra Invitation page at all?? (LOW PRIO)

- more options about who can send messages to whom: checkboxes per group (invitee, respondent, attendees) (LOW PRIO)

- http://drupal.org/node/180153 : Add invitations to "MyCalendar" 

- Integration with CiviCRM 
-http://drupal.org/node/38918, http://drupal.org/node/30522: CiviCRM integration (in all the obvious ways: Personal information being added to Contacts, direct registration, events being added to "Activities")

- Email: http://drupal.org/node/84918: Send emails via privatemsg instead by email.
(send_privatemsg)

- Guest List: Add icon for regular invitees to view status (LOW PRIO).
- Add red reply button instead of link like the event manager module has(-http://em-demo.mind-sky.com/?q=node/3). (LOW PRIO)

- preview option when writing an rsvp
- automatic update of invitations startdate when startdate in node changes. (MORE COMPLICATED)

- Allow parallel usage of event connector and date connector
- allow parameters for views
- I would like to see a "reply/response" panel like in evite. Any Volunteers ?? Who can help here.
    Adding styles through the API:http://drupal.org/node/225868
http://drupal.org/node/249726

1
2	This module lets users invite people to a node and maintains a list of
3	people who will be attending.
4
5	Requires either the event or the date module to be installed.
6
7	Installation
8	------------
9
10	1) Copy the rsvp directory into your Drupal modules directory.
11
12	2) Go to Administer >> Site Building >> Modules and
13
14	2.1 enable the RSVP module.
15
16	2.2 enable either the 'RSVP date connector' or the 'RSVP event connector' module. Do not enable both at the same time.
17	If you decide to switch from one connector to the other you have to use the uninstall option to uninstall the current connector before
18	you enable the other one.
19	Be careful. Uninstalling a connector will remove all existing invitation and RSVP records. Disabling and Enabling is fine though and will not remove
20	existing invitations.
21
22
23	Configuration
24	-------------
25	1) Enable permissions appropriate to your site.
26	The rsvp module provides the following permissions:
27	"administer rsvp" - full access
28	"maintain rsvp" - access to all invitations, but no permissions to modify the general rsvp settings.
29	"rsvp on events" - create invitations on nodes.
30	"rsvp on own events" - create invitations on own nodes.
31	"rsvp newsletters subscribers" - permission to add attendees based on existing newsletters (module simplenews is required).
32	"rsvp system users" - permission to add users based on available roles.
33
34	2) The basic difference between the event and the date module is that the date module supports reocurring events, and the creation of a Datetime or Date field
35	is mandatory.
36
37	2.1)If you use the event Module:
38	From the RSVP perspective there is no other configuration required. You are set to create RSVPs for existing events.
39
40
41	2.2)If you use the date Module:
42	2.2.1) Create Field
43	First you have to add a custom field of type "Datetime" or "Date" to all the content types that you want to utilize as potential events in the future.
44	The RSVP module can manage different "event enabled" content types, but each type needs at least one Datetime or Date field.
45	2.2.2) Create association(s)
46	If the content types are prepared, you need to setup the content type / field associations for each content type that you want to use for RSVP's. You can do that under
47	Administrator >> Site configuration >> RSVP settings >> Assocications >> Add association. The user requires "administer rsvp" permissions to modify associations.
48	Select the content type you added a Datetime or Date field for and press the "add" link. On the following page select the field that you want to utilize.
49	If the field selection box is empty, you did not setup a proper field inside the content type.
50
51	3) Disable Wysiwig editor for the "People you like to invite" / "Add Attendees" textarea which
52	is part of the manage attendees form when creating a RSVP. The Wysiwig editor should be disabled by default(Tested with FcK).
53
54	Manage invitations (Admins and Maintainers)
55	-------------------------------------
56	All invitations of all users can be found at
57	Adminstrator >> Content management >> RSVP management
58
59
60	Create invitations
61	------------------
62	Go to the node you want to create an invitation for and click on the Invitation tab.
63	If the Invitation tab is not available,
64	- verify that this content type is enabled in the rsvp settings.
65	- verify that the user has the right permissions ("rsvp on events" or "rsvp on own events")
66
67	Modify invitations
68	------------------
69	Automatic startdate adjustment is not supported yet.
70	If the startdate of an event/node changes, the startdate of the related invitation needs to be changed
71	as well.
72
73
74
75
76
77	TODO/Features for upcoming 2.0 release:
78	--------------------------------------
79	- Tighter Integration to event nodes. Why do we need an extra Invitation page at all?? (LOW PRIO)
80
81	- more options about who can send messages to whom: checkboxes per group (invitee, respondent, attendees) (LOW PRIO)
82
83	- http://drupal.org/node/180153 : Add invitations to "MyCalendar"
84
85	- Integration with CiviCRM
86	-http://drupal.org/node/38918, http://drupal.org/node/30522: CiviCRM integration (in all the obvious ways: Personal information being added to Contacts, direct registration, events being added to "Activities")
87
88	- Email: http://drupal.org/node/84918: Send emails via privatemsg instead by email.
89	(send_privatemsg)
90
91	- Guest List: Add icon for regular invitees to view status (LOW PRIO).
92	- Add red reply button instead of link like the event manager module has(-http://em-demo.mind-sky.com/?q=node/3). (LOW PRIO)
93
94	- preview option when writing an rsvp
95	- automatic update of invitations startdate when startdate in node changes. (MORE COMPLICATED)
96
97	- Allow parallel usage of event connector and date connector
98	- allow parameters for views
99	- I would like to see a "reply/response" panel like in evite. Any Volunteers ?? Who can help here.
100	Adding styles through the API:http://drupal.org/node/225868
101	http://drupal.org/node/249726
102