modules/audit/README.txt

Module: audit.module
File:   README.txt
Author: Nic Ivy (http://drupal.org/user/6194)
CVS:    $Id$

-----------------------------------------------------------------------------
INSTALLING

  1. Replace misc/jquery.js with jQuery 1.1.1 and make Drupal's JavaScript 
     files compatible with it.  (Use the included replacements at your own 
     risk.)
  2. Get nodequeue.module and install it.
  3. Get views.module and install it.
  4. Install this module in the normal way.
  5. Go to "administer" > "user management" > "access control" to configure
     user permissions.
  6. Create an audit process, as described below.

-----------------------------------------------------------------------------
CREATE AN AUDIT PROCESS

  1. Create a new audit process by going to "create content" > "audit
     process".  Make note of the node id, which we will call (id).

  2. Create three node queues. Their names must be like these:
       "Audit #(id): In-process"
       "Audit #(id): Done"
       "Audit #(id): Saved for later"
     You will get reminders if they do not exist.

  3. Create a view that lists unprocessed content.  The view must filter out
     the queues you just made.  Also, the view must be named like this:
       "audit_(id)_unprocessed"

-----------------------------------------------------------------------------
REQUIRED

  *  nodequeue module (Not included. http://drupal.org/project/nodequeue)
     The audit system depends on three queues for each audit process.

  *  views module (Not included. http://drupal.org/project/views)
     The audit system depends on a user-created view for each audit process.

  *  jQuery 1.1.1 (Not included. http://jquery.com/src/jquery-1.1.1.pack.js)
     Drupal 5.1 ships with jQuery 1.0.2, which is not compatible.  Upgrading
     may cause problems with collapse.js, textarea.js, and others.  See
     http://drupal.org/project/issues/drupal for suggested workarounds.

  *  The scroll-related methods in the Interface plugin for jQuery (Included)

  *  The jQuery Form module (Included)

  *  The jQuery dimensions plugin (Included)

-----------------------------------------------------------------------------
LOGS FOR RECORD KEEPING

  * User actions are recorded.  Go to "administer" > "logs" > "recent log
    entries" to view the records.  You can filter for audit-type events or go
    directly to http://example.com/admin/logs/watchdog/audit.

  * The records will be discarded, unless you save them.  Adjust your system
    settings to keep the records longer.  Go to "administer" > "site
    configuration" > "error reporting".

-----------------------------------------------------------------------------
UNINSTALLING

  1. In Drupal, go to "administer" > "site building" > "modules" to disable
     this module.
  2. After disabling, select the "unistall" tab at the top of the same page.
  3. Uninstall this module, which will delete all vocabularies and content 
     used by this module.  Logs will not be removed.

-----------------------------------------------------------------------------
LOCALE

  * The file js/audit.en.js contains static localized strings.

-----------------------------------------------------------------------------
KNOWN BUGS

  1. File attachments do not work in the auditing screen because of JavaScript
     entaglements.

-----------------------------------------------------------------------------
SUPPORT

  * http://drupal.org/project/audit

-----------------------------------------------------------------------------

1	njivy	1.1	Module: audit.module
2			File: README.txt
3			Author: Nic Ivy (http://drupal.org/user/6194)
4			CVS: $Id$
5
6			-----------------------------------------------------------------------------
7			INSTALLING
8
9			1. Replace misc/jquery.js with jQuery 1.1.1 and make Drupal's JavaScript
10			files compatible with it. (Use the included replacements at your own
11			risk.)
12	njivy	1.3	2. Get nodequeue.module and install it.
13	njivy	1.1	3. Get views.module and install it.
14			4. Install this module in the normal way.
15	njivy	1.3	5. Go to "administer" > "user management" > "access control" to configure
16	njivy	1.1	user permissions.
17	njivy	1.3	6. Create an audit process, as described below.
18	njivy	1.1
19			-----------------------------------------------------------------------------
20			CREATE AN AUDIT PROCESS
21
22			1. Create a new audit process by going to "create content" > "audit
23	njivy	1.3	process". Make note of the node id, which we will call (id).
24
25			2. Create three node queues. Their names must be like these:
26			"Audit #(id): In-process"
27			"Audit #(id): Done"
28			"Audit #(id): Saved for later"
29			You will get reminders if they do not exist.
30
31			3. Create a view that lists unprocessed content. The view must filter out
32			the queues you just made. Also, the view must be named like this:
33			"audit_(id)_unprocessed"
34	njivy	1.1
35			-----------------------------------------------------------------------------
36			REQUIRED
37
38	njivy	1.3	* nodequeue module (Not included. http://drupal.org/project/nodequeue)
39			The audit system depends on three queues for each audit process.
40
41	njivy	1.1	* views module (Not included. http://drupal.org/project/views)
42	njivy	1.3	The audit system depends on a user-created view for each audit process.
43	njivy	1.1
44			* jQuery 1.1.1 (Not included. http://jquery.com/src/jquery-1.1.1.pack.js)
45			Drupal 5.1 ships with jQuery 1.0.2, which is not compatible. Upgrading
46			may cause problems with collapse.js, textarea.js, and others. See
47			http://drupal.org/project/issues/drupal for suggested workarounds.
48
49			* The scroll-related methods in the Interface plugin for jQuery (Included)
50
51			* The jQuery Form module (Included)
52
53			* The jQuery dimensions plugin (Included)
54
55			-----------------------------------------------------------------------------
56			LOGS FOR RECORD KEEPING
57
58			* User actions are recorded. Go to "administer" > "logs" > "recent log
59			entries" to view the records. You can filter for audit-type events or go
60			directly to http://example.com/admin/logs/watchdog/audit.
61
62			* The records will be discarded, unless you save them. Adjust your system
63			settings to keep the records longer. Go to "administer" > "site
64			configuration" > "error reporting".
65
66			-----------------------------------------------------------------------------
67			UNINSTALLING
68
69			1. In Drupal, go to "administer" > "site building" > "modules" to disable
70			this module.
71			2. After disabling, select the "unistall" tab at the top of the same page.
72			3. Uninstall this module, which will delete all vocabularies and content
73			used by this module. Logs will not be removed.
74
75			-----------------------------------------------------------------------------
76			LOCALE
77
78			* The file js/audit.en.js contains static localized strings.
79
80			-----------------------------------------------------------------------------
81			KNOWN BUGS
82
83	njivy	1.3	1. File attachments do not work in the auditing screen because of JavaScript
84			entaglements.
85	njivy	1.1
86			-----------------------------------------------------------------------------
87			SUPPORT
88
89			* http://drupal.org/project/audit
90
91			-----------------------------------------------------------------------------
92