You are here

README.txt in Content locking (anti-concurrent editing) 6.2

Same filename in this branch
  1. 6.2 README.txt
  2. 6.2 modules/content_lock_timeout/README.txt
Same filename and directory in other branches
  1. 6 README.txt
  2. 7.3 README.txt
  3. 7 README.txt
  4. 7.2 README.txt
content_lock

-- SUMMARY --

The purpose of this module is to avoid the situation where two people
are editing a single node at the same time. On busy sites with dynamic
content, edit collisions are a problem and may frustrate editors with
an error stating that the node was already modified and can't be
updated. This module implements a pessimistic locking strategy, which
means that content will be exclusively locked whenever a user starts
editing it. The lock will be automatically released when the user
submits the form or navigates away from the edit page.

Content locks that have been "forgotten" can be automatically released
after a configurable time span using the bundled content_lock_timeout
submodule.

For a full description, visit the project page:
  http://drupal.org/project/content_lock
Bug reports, feature suggestions, and latest developments:
  http://drupal.org/project/issues/content_lock
For integrating modules with content_lock, see:
  http://drupalcontrib.org/api/drupal/contributions--content_lock--content_lock.api.inc

-- INSTALLATION --

1. Install as usual, see http://drupal.org/node/70151 for further information.

2. Configure user permissions at User management >> Permissions:

   check out documents - This enables content locking when a user starts
     editing it.  Note that even *without* this permission, users are still
     able to edit node contents and are *not* protected from concurrent
     editing.

   administer checked out documents - View and release locked contents
     of all users.  This enables the administrative tab on Content
     management >> Content. Note users can manage their own content
     locks on their profile page *without* this permission in their
     profile page. This is intended for administrators or moderators
     only.

3. Configure the module at Site Configuration >> Content lock.

    Use javascript to detect leaving the node form - Automatically unlock nodes
      when users navigate away from a node edit page by clicking miscellaneous
      links.

      Confirm that the user really wants to leave the node form with a
        Javascript popup - when the user navigates away from a node edit page
        without having saved the node, ask the user to confirm that
        choice. Disable this if you find the confirmation dialog box annoying.

      Javascript popup message text - If the user is asked to confirm leaving
        the node edit page, use this text in the dialog box. Note that most
        browsers have taken to ignoring the Javascript-supplied text and will
        merely ask the user if the user is sure the user intends to navigate
        away.

    Show lock / unlock message - Make content_lock more verbose, informing a
      user when he locks a node and about his inconsideration when he visits
      one node while he has kept another node locked.

    Add cancel button - Adds a link in a node's edit form to cancel the edit,
      letting the user intentionally navigate away from the Edit page without
      being asked for confirmation by a javascript dialog.

    Lockable content types - You may choose to limit content_lock's effects
      to specific node types instead of across the board. Do not select any
      content types to ensure that all content types are protected.

    Lockable text formats - You may choose what type of node input formats
      may be lockable. Do not select any input types if content_lock should
      protect all input types.

4. If you want stale locks to time out, enable the content_lock_timeout
    ("Content Locking (edit lock) timeouts") module. Then return to the
    Content Lock settings page and configure the timeout.

5. View and administer locked nodes Content management >> Content >>
    Locked Documents.

-- CREDITS --
Current maintainers:
Nathan Phillip Brink (ohnobinki) http://drupal.org/user/108406
Eugen Mayer http://drupal.org/user/108406

This module is a fork/continuation of
http://drupal.org/project/checkout which was written and maintained
by:

Stefan M. Kudwien
Joël Guesclin

File

README.txt
View source
  1. content_lock
  2. -- SUMMARY --
  3. The purpose of this module is to avoid the situation where two people
  4. are editing a single node at the same time. On busy sites with dynamic
  5. content, edit collisions are a problem and may frustrate editors with
  6. an error stating that the node was already modified and can't be
  7. updated. This module implements a pessimistic locking strategy, which
  8. means that content will be exclusively locked whenever a user starts
  9. editing it. The lock will be automatically released when the user
  10. submits the form or navigates away from the edit page.
  11. Content locks that have been "forgotten" can be automatically released
  12. after a configurable time span using the bundled content_lock_timeout
  13. submodule.
  14. For a full description, visit the project page:
  15. http://drupal.org/project/content_lock
  16. Bug reports, feature suggestions, and latest developments:
  17. http://drupal.org/project/issues/content_lock
  18. For integrating modules with content_lock, see:
  19. http://drupalcontrib.org/api/drupal/contributions--content_lock--content_lock.api.inc
  20. -- INSTALLATION --
  21. 1. Install as usual, see http://drupal.org/node/70151 for further information.
  22. 2. Configure user permissions at User management >> Permissions:
  23. check out documents - This enables content locking when a user starts
  24. editing it. Note that even *without* this permission, users are still
  25. able to edit node contents and are *not* protected from concurrent
  26. editing.
  27. administer checked out documents - View and release locked contents
  28. of all users. This enables the administrative tab on Content
  29. management >> Content. Note users can manage their own content
  30. locks on their profile page *without* this permission in their
  31. profile page. This is intended for administrators or moderators
  32. only.
  33. 3. Configure the module at Site Configuration >> Content lock.
  34. Use javascript to detect leaving the node form - Automatically unlock nodes
  35. when users navigate away from a node edit page by clicking miscellaneous
  36. links.
  37. Confirm that the user really wants to leave the node form with a
  38. Javascript popup - when the user navigates away from a node edit page
  39. without having saved the node, ask the user to confirm that
  40. choice. Disable this if you find the confirmation dialog box annoying.
  41. Javascript popup message text - If the user is asked to confirm leaving
  42. the node edit page, use this text in the dialog box. Note that most
  43. browsers have taken to ignoring the Javascript-supplied text and will
  44. merely ask the user if the user is sure the user intends to navigate
  45. away.
  46. Show lock / unlock message - Make content_lock more verbose, informing a
  47. user when he locks a node and about his inconsideration when he visits
  48. one node while he has kept another node locked.
  49. Add cancel button - Adds a link in a node's edit form to cancel the edit,
  50. letting the user intentionally navigate away from the Edit page without
  51. being asked for confirmation by a javascript dialog.
  52. Lockable content types - You may choose to limit content_lock's effects
  53. to specific node types instead of across the board. Do not select any
  54. content types to ensure that all content types are protected.
  55. Lockable text formats - You may choose what type of node input formats
  56. may be lockable. Do not select any input types if content_lock should
  57. protect all input types.
  58. 4. If you want stale locks to time out, enable the content_lock_timeout
  59. ("Content Locking (edit lock) timeouts") module. Then return to the
  60. Content Lock settings page and configure the timeout.
  61. 5. View and administer locked nodes Content management >> Content >>
  62. Locked Documents.
  63. -- CREDITS --
  64. Current maintainers:
  65. Nathan Phillip Brink (ohnobinki) http://drupal.org/user/108406
  66. Eugen Mayer http://drupal.org/user/108406
  67. This module is a fork/continuation of
  68. http://drupal.org/project/checkout which was written and maintained
  69. by:
  70. Stefan M. Kudwien
  71. Joël Guesclin