/[drupal]/contributions/modules/audit/README.txt
ViewVC logotype

Diff of /contributions/modules/audit/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.2, Sun Feb 25 02:05:03 2007 UTC revision 1.3, Tue Feb 27 02:53:41 2007 UTC
# Line 9  INSTALLING Line 9  INSTALLING
9    1. Replace misc/jquery.js with jQuery 1.1.1 and make Drupal's JavaScript    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       files compatible with it.  (Use the included replacements at your own
11       risk.)       risk.)
12    2. Enable taxonomy.module.    2. Get nodequeue.module and install it.
13    3. Get views.module and install it.    3. Get views.module and install it.
14    4. Install this module in the normal way.    4. Install this module in the normal way.
15    5. Go to "administer" > "site configuration" > "audit" to configure    5. Go to "administer" > "user management" > "access control" to configure
      which vocabularies the module will use to keep track of auditing  
      progress.  
   6. Go to "administer" > "user management" > "access control" to configure  
16       user permissions.       user permissions.
17    7. Create an audit process, as described below.    6. Create an audit process, as described below.
18    
19  -----------------------------------------------------------------------------  -----------------------------------------------------------------------------
20  CREATE AN AUDIT PROCESS  CREATE AN AUDIT PROCESS
21    
22    1. Create a new audit process by going to "create content" > "audit    1. Create a new audit process by going to "create content" > "audit
23       process".       process".  Make note of the node id, which we will call (id).
24    2. Create views that list unprocessed, processed, bookmarked, and  
25       in-progress content.  The views must be named "audit_(nid)_(status)",    2. Create three node queues. Their names must be like these:
26       e.g. "audit_2533_processed". You will get reminders if the views do not         "Audit #(id): In-process"
27       exist.         "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    
35  -----------------------------------------------------------------------------  -----------------------------------------------------------------------------
36  REQUIRED  REQUIRED
37    
38      *  nodequeue module (Not included. http://drupal.org/project/nodequeue)
39         The audit system depends on three queues for each audit process.
40    
41    *  views module (Not included. http://drupal.org/project/views)    *  views module (Not included. http://drupal.org/project/views)
42       The audit system depends on four user-created views per audit process.       The audit system depends on a user-created view for each 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.  
43    
44    *  jQuery 1.1.1 (Not included. http://jquery.com/src/jquery-1.1.1.pack.js)    *  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       Drupal 5.1 ships with jQuery 1.0.2, which is not compatible.  Upgrading
# Line 49  REQUIRED Line 52  REQUIRED
52    
53    *  The jQuery dimensions plugin (Included)    *  The jQuery dimensions plugin (Included)
54    
   *  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.  
   
55  -----------------------------------------------------------------------------  -----------------------------------------------------------------------------
56  LOGS FOR RECORD KEEPING  LOGS FOR RECORD KEEPING
57    
# Line 82  LOCALE Line 80  LOCALE
80  -----------------------------------------------------------------------------  -----------------------------------------------------------------------------
81  KNOWN BUGS  KNOWN BUGS
82    
83    1. File attachments do not work in the auditing screen.    1. File attachments do not work in the auditing screen because of JavaScript
84         entaglements.
85    
86  -----------------------------------------------------------------------------  -----------------------------------------------------------------------------
87  SUPPORT  SUPPORT
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.2