function content_lock_help in Content locking (anti-concurrent editing) 7

Same name and namespace in other branches

1. 8.2 content_lock.module \content_lock_help()
2. 8 content_lock.module \content_lock_help()
3. 6.2 content_lock.module \content_lock_help()
4. 6 content_lock.module \content_lock_help()
5. 7.3 content_lock.module \content_lock_help()
6. 7.2 content_lock.module \content_lock_help()

Implementation of hook_help().

File

./content_lock.module, line 28

Allows users to lock documents for modification.

Code

function content_lock_help($path, $arg) {
  switch ($path) {
    case 'admin/help#content_lock':
      $output = '<p>' . t("Drupal's default content locking strategy is optimistic, that is, two users may start to edit the same content and the one who is hitting the save button first wins the race, while the other is displayed a message stating <em>this content has been modified by another user, changes cannot be saved</em>.  Depending on the number of editors in your organization this might not be an acceptable solution.") . '</p>';
      $output .= '<p>' . t('The Content locking module implements pessimistic locking, 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.') . '</p>';
      $output .= '<p>' . t('Users may also permanently lock content, to prevent others from editing it.  Content locks that have been "forgotten" can be automatically released after a configurable time span.') . '</p>';
      return $output;
    case 'admin/content/content_lock':
      return '<p>' . t('Below is a list of all locked documents. Click on <em>!checkin</em> to release a lock.', array(
        '!checkin' => t('release lock'),
      )) . '</p>';
    case 'user/%/content_lock':
      return '<p>' . t('Below is a list of all documents locked by you. Click on <em>!checkin</em> to release a lock.', array(
        '!checkin' => t('release lock'),
      )) . '</p>';
  }
}