/* $Id */

-- SUMMARY --

Drupal, by default, does not take into account the possibility of multiple
users wanting to update the same document (node) at the same time. There is
consequently a danger that two users try to edit a node at the same time (a
race condition), with one user overwriting the other's modifications.

The checkout module offers active protection against concurrent edits. When a 
user begins to modify a document, it is considered being 'checked out' of the
system for exclusive editing access by that user. It only becomes available to
other users once the editor navigates out of the edit page - by submitting the
content, viewing the node, or selecting another menu item.

For a full description visit the project page:
  http://drupal.org/project/checkout
Bug reports, feature suggestions and latest developments:
  http://drupal.org/project/checkout/issues


-- REQUIREMENTS --

* The module depends on users having individual id's on the system -
  it cannot distinguish between two users logged on with the same id.

* Crontab, if you wish to make use of automated check-ins. If your hoster
  doesn't allow you to access cron take a look at Poormanscron
  (http://drupal.org/project/poormanscron).


-- INSTALLATION --

1. Copy the check-out module to your modules directory and enable it on the
   Modules page (admin/build/modules).

2. Give some roles permission to check out documents at the Access control page
   (admin/user/access). The following permissions can be controlled:

   check out documents - Whether a document can be checked out when a user
     starts editing it. Even without this permission it will be possible to
     edit contents, the user is just not protected against concurrent edits.

   keep documents checked out - Whether to allow users to manually keep
     documents checked out using a checkbox on the node edit page.

   administer checked out documents - View all checked out documents and check
     them back in.

3. Configure the module at Content management > Post settings
   (admin/content/node-settings). The only configurable setting currently is
   the automatic check-in time period.

4. Enable cron to make use of automated check-ins.


-- CONTACT --

Author:
Joel Guesclin

The Drupal 5 port is maintained by
Stefan Kudwien (smk-ka) - http://www.unleashedmind.com