modules/signup_status/README.txt

/* $Id: README.txt,v 1.3 2009/08/23 16:55:41 dww Exp $ */

The Signup Status module extends the Signup module's functionality by
adding a feature-rich field to all signups.  This can be used so that
potential attendees indicate if they can come or not ('yes', 'no',
'maybe').  A site administrator can add any values they want, and
control which values (if any) are visible to end-users on the signup
form.  Users with permission to administer signups on signup-enabled
nodes can also set the status of a user's signup. This can be used,
for example, to mark users as "Paid" or "Completed."

This module features:
* Administrative interface for defining site-specific status values.
* Modifications to the Signup broadcast form that allows users who can
  send broadcast messages to restrict them based on signup status.
* Views module support through several fields and filters.
* Views Bulk Operations (VBO) support to alter signup status values in
  bulk on the "Administer" subtab of the "Signups" tab on a node.

Several optional modules are included in this package:

* Signup Status Certificates: Grant certificates to users based on their 
* Signup Status Invite: Allows users with sufficient permissions to
  invite other users to a specific event, in which case they are
  automatically signed up to a given status and an e-mail is sent.
* Signup Status Log: An administrative log of signup status changes.
* Signup Status Mailer: Email users when their signup status has changed.
* Signup Status Notification: Automatically subscribe users to
  notifications about nodes when they are in a certain status.

Be sure to look for a README.txt file in each directory that would
contain additional instructions and information.


------------------------
Requirements
------------------------

* Signup module (6.x-1.0-RC5 or greater): http://drupal.org/project/signup


------------------------
Recommendations
------------------------

* Views: http://drupal.org/project/views
* Views Bulk Operations (VBO): http://drupal.org/project/views_bulk_operations


------------------------
Setup
------------------------

* Enable the module and setup new permissions, if necessary:
  - manage signup status codes: Add, edit, delete signup status codes

* Navigate to Administer > Settings > Signup Status
  (admin/settings/signup_status) to add or remove custom status codes.

For an administrator to modify the status of an existing signup, there
are two options:

-- Edit each signup individually (e.g. using the 'Edit signup' link on
   the node/N/signups/admin tab on a signup-enabled node).

-- Update signup status in bulk using Views Bulk Operations (VBO).


To enable and configure VBO, you must:

1) Download, install and enable Views and VBO.

2) Go to /admin/settings/signup and in the "Advanced settings" for
   "How to display the administrative list of signed-up users" choose
   "embed a view".  In the "View to embed for the signup administrative list"
   drop down, select "signup_status_user_vbo_admin ..." to use the default
   Views Bulk Operations-enabled view for the administrative list of signed
   up users provided by Signup Status.  There are several similarly named
   views, so be SURE you are using "signup_status_user_vbo_admin".

3) Visit /node/N/signups/admin (where N is the node ID of a signup-enabled
   node).  Now, where the "Signup details" operations area used to be,
   you'll have a "Bulk operations" area that looks similar.  This is the
   Views Bulk Operations view, and it allows you to perform operations
   (from the drop down) on selected rows of this table.  You can also edit
   the View style options so that there are other operations in the list
   including canceling a Signup.

4) To alter the signup status on any signup records, click the
   checkbox next to the desired signups on this page and choose the
   "Alter signup status" operation.  Click execute.  This will bring
   you to a page where you can select the new status to give these
   signups and confirm the operation.


------------------------
Support
------------------------

Please submit any feature requests or bug reports to this project's issue
queue at http://drupal.org/project/issues/signup_status


------------------------
Credits
------------------------

The Drupal 5 version of this module was written by Jeffery Beeman
(http://drupal.org/user/16734 -- "jrbeeman").

The Drupal 6 version was fairly major rewrite and refactoring by:
- Miglius Alaburda (http://drupal.org/user/18741 -- "miglius")
- Derek Wright (http://drupal.org/user/46549 -- "dww")

1	/* $Id: README.txt,v 1.3 2009/08/23 16:55:41 dww Exp $ */
2
3	The Signup Status module extends the Signup module's functionality by
4	adding a feature-rich field to all signups. This can be used so that
5	potential attendees indicate if they can come or not ('yes', 'no',
6	'maybe'). A site administrator can add any values they want, and
7	control which values (if any) are visible to end-users on the signup
8	form. Users with permission to administer signups on signup-enabled
9	nodes can also set the status of a user's signup. This can be used,
10	for example, to mark users as "Paid" or "Completed."
11
12	This module features:
13	* Administrative interface for defining site-specific status values.
14	* Modifications to the Signup broadcast form that allows users who can
15	send broadcast messages to restrict them based on signup status.
16	* Views module support through several fields and filters.
17	* Views Bulk Operations (VBO) support to alter signup status values in
18	bulk on the "Administer" subtab of the "Signups" tab on a node.
19
20	Several optional modules are included in this package:
21
22	* Signup Status Certificates: Grant certificates to users based on their
23	* Signup Status Invite: Allows users with sufficient permissions to
24	invite other users to a specific event, in which case they are
25	automatically signed up to a given status and an e-mail is sent.
26	* Signup Status Log: An administrative log of signup status changes.
27	* Signup Status Mailer: Email users when their signup status has changed.
28	* Signup Status Notification: Automatically subscribe users to
29	notifications about nodes when they are in a certain status.
30
31	Be sure to look for a README.txt file in each directory that would
32	contain additional instructions and information.
33
34
35	------------------------
36	Requirements
37	------------------------
38
39	* Signup module (6.x-1.0-RC5 or greater): http://drupal.org/project/signup
40
41
42	------------------------
43	Recommendations
44	------------------------
45
46	* Views: http://drupal.org/project/views
47	* Views Bulk Operations (VBO): http://drupal.org/project/views_bulk_operations
48
49
50	------------------------
51	Setup
52	------------------------
53
54	* Enable the module and setup new permissions, if necessary:
55	- manage signup status codes: Add, edit, delete signup status codes
56
57	* Navigate to Administer > Settings > Signup Status
58	(admin/settings/signup_status) to add or remove custom status codes.
59
60	For an administrator to modify the status of an existing signup, there
61	are two options:
62
63	-- Edit each signup individually (e.g. using the 'Edit signup' link on
64	the node/N/signups/admin tab on a signup-enabled node).
65
66	-- Update signup status in bulk using Views Bulk Operations (VBO).
67
68
69	To enable and configure VBO, you must:
70
71	1) Download, install and enable Views and VBO.
72
73	2) Go to /admin/settings/signup and in the "Advanced settings" for
74	"How to display the administrative list of signed-up users" choose
75	"embed a view". In the "View to embed for the signup administrative list"
76	drop down, select "signup_status_user_vbo_admin ..." to use the default
77	Views Bulk Operations-enabled view for the administrative list of signed
78	up users provided by Signup Status. There are several similarly named
79	views, so be SURE you are using "signup_status_user_vbo_admin".
80
81	3) Visit /node/N/signups/admin (where N is the node ID of a signup-enabled
82	node). Now, where the "Signup details" operations area used to be,
83	you'll have a "Bulk operations" area that looks similar. This is the
84	Views Bulk Operations view, and it allows you to perform operations
85	(from the drop down) on selected rows of this table. You can also edit
86	the View style options so that there are other operations in the list
87	including canceling a Signup.
88
89	4) To alter the signup status on any signup records, click the
90	checkbox next to the desired signups on this page and choose the
91	"Alter signup status" operation. Click execute. This will bring
92	you to a page where you can select the new status to give these
93	signups and confirm the operation.
94
95
96	------------------------
97	Support
98	------------------------
99
100	Please submit any feature requests or bug reports to this project's issue
101	queue at http://drupal.org/project/issues/signup_status
102
103
104	------------------------
105	Credits
106	------------------------
107
108	The Drupal 5 version of this module was written by Jeffery Beeman
109	(http://drupal.org/user/16734 -- "jrbeeman").
110
111	The Drupal 6 version was fairly major rewrite and refactoring by:
112	- Miglius Alaburda (http://drupal.org/user/18741 -- "miglius")
113	- Derek Wright (http://drupal.org/user/46549 -- "dww")
114