Merge branch '7.x-2.x' of git.drupal.org:project/autologout into 7.x-2.x
[project/autologout.git] / README.txt
1 README.txt file
2 ===============
3 $Id: README.txt,v 1.2 2009/04/17 14:05:51 jvandervort Exp $
4
5 Settings
6 ========
7
8 Enable module checkbox. 
9   If this is unchecked the module is NOT activated and no 
10   automated logouts will occur.
11
12 Timeout value in seconds.
13   The is the "inactivity" timeout value. It's important to note
14   that the server's only way of knowing about activity is when
15   a browser requests a page from it. If the user is happily sitting
16   there, say typing an enormous blog entry, then there's no way for the
17   server to know the actual user is very busy until he/she submits the
18   page. The server checks for any submissions (input) by the user.
19   If there is content being added, the timeout is effectivly
20   cancelled and a new session starts.
21
22 Browser refresh delta:
23   If this is set to a non zero value, this time will be added to the
24   "Timeout value in seconds" variable and be used to set a :-
25     <meta http-equiv="refresh" content="xxx">
26   line in the <head> section of the page. It's likely that clocks
27   won't be perfect so make the browser wait sometime longer than the
28   actual time out value. This effectively sends the browser back to
29   the homepage with the user logged out. Set this to 0 (zero) to disable
30   the <meta> tag.
31  
32   Note, as stated above, we test for content submission before doing
33   a logout so that users do not loose work. However, if you force a
34   meta refresh, this is not possible as the browser will refresh the
35   page without doing a submit or a preview. In this case, users may
36   loose work so use this option carefully. There's nothing more
37   annoying than loosing your work (except maybe hemorrhoids! ;)
38
39 Enable watchdog auto-logout logging:
40   Check on to have the module record when it expires a user.
41
42 Set-up your site policy by role:
43   You can specify, by role, how users are treated regarding timeout
44   issues. The three types of policy are :
45
46     Enforce: All users in this role have the timeout enforced on them
47     Exclude: All users in this role do not have the timeout enforced on them
48     By user: All users in this role have the choice to disable the timeout.
49
50 Important note! The module by default uses Enforce. However, if a user is
51 found to have any other exclusion (by role or by choice) this takes
52 precidence over any Enforce that might have been in place.
53
54 Finally, this module provides a block that displays the h,m,s left in this
55 session (hours minutes seconds). It can be enabled in Admin > blocks and
56 the title of the block can be set in the standard settings page. This block 
57 is only displayed if you have the jstimer module installed.
58
59 If a policy settings means a user is not subject to autologout (in a role
60 of Exclude or By user and user set in profile not to autologout) then the
61 block is not displayed. The block is only displayed to users who will be
62 logged out if appropiate.
63
64
65