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. Enable taxonomy.module.
  3. Get views.module and install it.
  4. Install this module in the normal way.
  5. Go to "administer" > "site configuration" > "audit" to configure
     which vocabularies the module will use to keep track of auditing
     progress.
  6. Go to "administer" > "user management" > "access control" to configure
     user permissions.
  7. Create an audit process, as described below.

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

  1. Create a new audit process by going to "create content" > "audit
     process".
  2. Create views that list unprocessed, processed, bookmarked, and
     in-progress content.  The views must be named "audit_(nid)_(status)",
     e.g. "audit_2533_processed". You will get reminders if the views do not
     exist.

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

  *  views module (Not included. http://drupal.org/project/views)
     The audit system depends on four user-created views per audit process.
     The views should list 'unprocessed', 'in-process', 'processed', and
     'bookmarked' content for each audit.  If you know a way to automatically
     create these views, I would like to see your code.

  *  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)

  *  taxonomy module (Included with Drupal)
     The audit system uses the taxonomy module to categorize content.  Audited
     content are sorted into 'processed', 'in-process', and 'bookmarked'
     categories.

-----------------------------------------------------------------------------
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.

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

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

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

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	2. Enable taxonomy.module.
13	3. Get views.module and install it.
14	4. Install this module in the normal way.
15	5. Go to "administer" > "site configuration" > "audit" to configure
16	which vocabularies the module will use to keep track of auditing
17	progress.
18	6. Go to "administer" > "user management" > "access control" to configure
19	user permissions.
20	7. Create an audit process, as described below.
21
22	-----------------------------------------------------------------------------
23	CREATE AN AUDIT PROCESS
24
25	1. Create a new audit process by going to "create content" > "audit
26	process".
27	2. Create views that list unprocessed, processed, bookmarked, and
28	in-progress content. The views must be named "audit_(nid)_(status)",
29	e.g. "audit_2533_processed". You will get reminders if the views do not
30	exist.
31
32	-----------------------------------------------------------------------------
33	REQUIRED
34
35	* views module (Not included. http://drupal.org/project/views)
36	The audit system depends on four user-created views per audit process.
37	The views should list 'unprocessed', 'in-process', 'processed', and
38	'bookmarked' content for each audit. If you know a way to automatically
39	create these views, I would like to see your code.
40
41	* jQuery 1.1.1 (Not included. http://jquery.com/src/jquery-1.1.1.pack.js)
42	Drupal 5.1 ships with jQuery 1.0.2, which is not compatible. Upgrading
43	may cause problems with collapse.js, textarea.js, and others. See
44	http://drupal.org/project/issues/drupal for suggested workarounds.
45
46	* The scroll-related methods in the Interface plugin for jQuery (Included)
47
48	* The jQuery Form module (Included)
49
50	* The jQuery dimensions plugin (Included)
51
52	* taxonomy module (Included with Drupal)
53	The audit system uses the taxonomy module to categorize content. Audited
54	content are sorted into 'processed', 'in-process', and 'bookmarked'
55	categories.
56
57	-----------------------------------------------------------------------------
58	LOGS FOR RECORD KEEPING
59
60	* User actions are recorded. Go to "administer" > "logs" > "recent log
61	entries" to view the records. You can filter for audit-type events or go
62	directly to http://example.com/admin/logs/watchdog/audit.
63
64	* The records will be discarded, unless you save them. Adjust your system
65	settings to keep the records longer. Go to "administer" > "site
66	configuration" > "error reporting".
67
68	-----------------------------------------------------------------------------
69	UNINSTALLING
70
71	1. In Drupal, go to "administer" > "site building" > "modules" to disable
72	this module.
73	2. After disabling, select the "unistall" tab at the top of the same page.
74	3. Uninstall this module, which will delete all vocabularies and content
75	used by this module. Logs will not be removed.
76
77	-----------------------------------------------------------------------------
78	LOCALE
79
80	* The file js/audit.en.js contains static localized strings.
81
82	-----------------------------------------------------------------------------
83	KNOWN BUGS
84
85	1. File attachments do not work in the auditing screen.
86
87	-----------------------------------------------------------------------------
88	SUPPORT
89
90	* http://drupal.org/project/audit
91
92	-----------------------------------------------------------------------------
93