modules/logintoboggan/INSTALL.txt

$Id: INSTALL.txt,v 1.2 2008/03/09 01:18:45 thehunmonkgroup Exp $

*******************************************************
    INSTALL.txt for logintoboggan.module for Drupal
*******************************************************

INSTALLATION:

Place entire loggintoboggan module folder into
  (a) your sites/all/modules directory
  (b) your sites/[my site]/modules directory.

Enable the module at
Administer -> Site building - > Modules

Configure loggintoboggan settings at
Administer -> User management -> LoginToboggan.

The module changes the functionality of the login block
AND provides a new 'LoginToboggan logged in block'

Configure each block at
Administer -> Site building -> Blocks
as follows...

1. Configure the 'User login' block for LoginToboggan functionality:

Change title if required; using <none> can make for a very neat login system,
when combined with the javascript functionality: clicking upon "Login/register"
reveals the login form in neat sliding fashion. To select this functionality,
select 'Collapsible form' under "Block type".  Selecting 'Link' under "Block
type" sends user to a login form, returning them to original page after
successful login.

2. Configure 'LoginToboggan logged in block'

Tip: by leaving the title blank, the 'LoginToboggan logged in block' is slim
and neat.

Done!

CAVEATS:

1. Use the 'Delete unvalidated users after' feature with extreme caution!

   This feature can be handy, but if misconfigured can cause unexpected damage
   to your user data -- specifically deleting users!  Two things to guard
   against:

     a. Be very careful when editing the 'Non-authenticated role' setting.
        If you set it to anything other than the 'authenticated user' role,
        LoginToboggan will happily start deleting any users you have in that
        role that were created prior to the purge interval.  If you want to
        avoid problems, it's best to never change that setting after you've
        initially set it up.

     b. LoginToboggan has mechanisms in place that prevent a user from being
        re-added to the Non-authenticated role after a user has been validated.
        Note that these protections are only present in core's interface -- if
        you have another module enabled which does any role manipulation
        (either via the user interface or programatically), you must find your
        own way to ensure that it doesn't add any users back into the
        Non-authenticated role.

   Also note that the feature is only enabled if the 'Set password' option is
   also enabled.
1	$Id: INSTALL.txt,v 1.2 2008/03/09 01:18:45 thehunmonkgroup Exp $
2
3	*******************************************************
4	INSTALL.txt for logintoboggan.module for Drupal
5	*******************************************************
6
7	INSTALLATION:
8
9	Place entire loggintoboggan module folder into
10	(a) your sites/all/modules directory
11	(b) your sites/[my site]/modules directory.
12
13	Enable the module at
14	Administer -> Site building - > Modules
15
16	Configure loggintoboggan settings at
17	Administer -> User management -> LoginToboggan.
18
19	The module changes the functionality of the login block
20	AND provides a new 'LoginToboggan logged in block'
21
22	Configure each block at
23	Administer -> Site building -> Blocks
24	as follows...
25
26	1. Configure the 'User login' block for LoginToboggan functionality:
27
28	Change title if required; using <none> can make for a very neat login system,
29	when combined with the javascript functionality: clicking upon "Login/register"
30	reveals the login form in neat sliding fashion. To select this functionality,
31	select 'Collapsible form' under "Block type". Selecting 'Link' under "Block
32	type" sends user to a login form, returning them to original page after
33	successful login.
34
35	2. Configure 'LoginToboggan logged in block'
36
37	Tip: by leaving the title blank, the 'LoginToboggan logged in block' is slim
38	and neat.
39
40	Done!
41
42	CAVEATS:
43
44	1. Use the 'Delete unvalidated users after' feature with extreme caution!
45
46	This feature can be handy, but if misconfigured can cause unexpected damage
47	to your user data -- specifically deleting users! Two things to guard
48	against:
49
50	a. Be very careful when editing the 'Non-authenticated role' setting.
51	If you set it to anything other than the 'authenticated user' role,
52	LoginToboggan will happily start deleting any users you have in that
53	role that were created prior to the purge interval. If you want to
54	avoid problems, it's best to never change that setting after you've
55	initially set it up.
56
57	b. LoginToboggan has mechanisms in place that prevent a user from being
58	re-added to the Non-authenticated role after a user has been validated.
59	Note that these protections are only present in core's interface -- if
60	you have another module enabled which does any role manipulation
61	(either via the user interface or programatically), you must find your
62	own way to ensure that it doesn't add any users back into the
63	Non-authenticated role.
64
65	Also note that the feature is only enabled if the 'Set password' option is
66	also enabled.