modules/user_suspend/README.txt

$Id$


Description
-----------
User Suspend provides an interim step between account blocking and account 
deletion. The user record, user roles and optionally user-created nodes and 
comments are transferred to separate tables where they are not accessible by
the normal Drupal system. Suspended users can be reinstated at any time, 
recovering all of their previous settings, roles, nodes, and comments.


Prerequisites
-------------
None


Installation
------------
1. copy the user_suspend directory and all its contents to your 
   modules directory.
2. enable the module: admin/build/modules. The module will install five tables
   into your database.
3. configure the module: admin/user/settings/user_suspend


Usage
-------------
Suspend users from the default Users list (admin/user/user) by selecting 
'Suspend the selected users' from the Update options. View, reinstate and 
delete suspended users from the Suspended Users list (admin/user/user/suspend).


Known Issues
-------------
Comments are finicky. When comments from suspended users are removed or 
restored, the comment count may be inaccurate until a new comment is added. 
When comments are deleted, any comments threaded below a comment from a 
suspended user will also be deleted. This is by design of the Drupal 
comment.module to eliminate orphaned comments.

Workaround: 
  Disable 'Remove user comments?' in the User suspend settings, which will 
  detach all comments from a suspended user (uid set to 0). The drawback is 
  that suspended user comments will not be able to be reattached to the user if
  reinstated in the future.

Modules which add additional columns to the core node, comments or users tables
will lose data from these columns if a user is suspended and then unsuspended. 
We had considered replicating the changes to these core tables in the 
corresponding user suspend table, but ultimately decided it was not good 
practice to support every (any?) module that chooses to alter these tables.


Bugs/Features/Patches:
----------------------
If you want to report bugs, feature requests, or submit a patch, please do so 
at the project page on the Drupal web site.
http://drupal.org/project/user_suspend


Changlog:
----------
1.2  added check to prevent suspending self
     streamlined table copy functions to support only default schema data
     fixed install error for pgsql db
1.1  fixed bulk user reinstate/delete from User Suspend list
1.0  initial release


Todo List:
----------
None


Author
------
John Money
ossemble LLC.
http://ossemble.com

Module development sponsored by LifeWire, a subsidiary of The New York Times 
Company.
http://www.lifewire.com
1	$Id$
2
3
4	Description
5	-----------
6	User Suspend provides an interim step between account blocking and account
7	deletion. The user record, user roles and optionally user-created nodes and
8	comments are transferred to separate tables where they are not accessible by
9	the normal Drupal system. Suspended users can be reinstated at any time,
10	recovering all of their previous settings, roles, nodes, and comments.
11
12
13	Prerequisites
14	-------------
15	None
16
17
18	Installation
19	------------
20	1. copy the user_suspend directory and all its contents to your
21	modules directory.
22	2. enable the module: admin/build/modules. The module will install five tables
23	into your database.
24	3. configure the module: admin/user/settings/user_suspend
25
26
27	Usage
28	-------------
29	Suspend users from the default Users list (admin/user/user) by selecting
30	'Suspend the selected users' from the Update options. View, reinstate and
31	delete suspended users from the Suspended Users list (admin/user/user/suspend).
32
33
34	Known Issues
35	-------------
36	Comments are finicky. When comments from suspended users are removed or
37	restored, the comment count may be inaccurate until a new comment is added.
38	When comments are deleted, any comments threaded below a comment from a
39	suspended user will also be deleted. This is by design of the Drupal
40	comment.module to eliminate orphaned comments.
41
42	Workaround:
43	Disable 'Remove user comments?' in the User suspend settings, which will
44	detach all comments from a suspended user (uid set to 0). The drawback is
45	that suspended user comments will not be able to be reattached to the user if
46	reinstated in the future.
47
48	Modules which add additional columns to the core node, comments or users tables
49	will lose data from these columns if a user is suspended and then unsuspended.
50	We had considered replicating the changes to these core tables in the
51	corresponding user suspend table, but ultimately decided it was not good
52	practice to support every (any?) module that chooses to alter these tables.
53
54
55	Bugs/Features/Patches:
56	----------------------
57	If you want to report bugs, feature requests, or submit a patch, please do so
58	at the project page on the Drupal web site.
59	http://drupal.org/project/user_suspend
60
61
62	Changlog:
63	----------
64	1.2 added check to prevent suspending self
65	streamlined table copy functions to support only default schema data
66	fixed install error for pgsql db
67	1.1 fixed bulk user reinstate/delete from User Suspend list
68	1.0 initial release
69
70
71	Todo List:
72	----------
73	None
74
75
76	Author
77	------
78	John Money
79	ossemble LLC.
80	http://ossemble.com
81
82	Module development sponsored by LifeWire, a subsidiary of The New York Times
83	Company.
84	http://www.lifewire.com