function privatemsg_help in Privatemsg 7

Same name and namespace in other branches

1. 5.3 privatemsg.module \privatemsg_help()
2. 5 privatemsg.module \privatemsg_help()
3. 7.2 privatemsg.module \privatemsg_help()

Implements hook_help()

File

./privatemsg.module, line 24

Allows users to send private messages to other users.

Code

function privatemsg_help($path, $arg) {
  $output = '';
  switch ($path) {
    case 'admin/help#privatemsg':
      $output .= '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Privatemsg module is designed to be a flexible and powerful system for sending and receiving internal messages. This includes user-to-user messages, user-to-role messages, messages from the site administrator, and much more. If you want some or all users on your site to have their own "mailbox"--and other users with the proper permissions to be able to message them through this mailbox--then this is the module for you.') . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<p>' . t('One of the strengths of Privatemsg is that it has a broad feature set and a modular architecture. The core Private Message module includes features such as threaded conversations (making it easier to keep track of messages and replies), search capability, new message alerts (via Drupal messages and blocks), and message tokens (similar to a mail merge).') . '</p>';
      $output .= '<dl>';
      $output .= '<dt>' . t('<h6>Configuration Steps</h6>') . '</dt>';
      $output .= '<dd>' . t('1. Go to People > Permissions (admin/people/permissions) and find the relevant module permissions underneath the "Private messages" section. If you are not logged in as user #1, you must give at least one role (probably the administrator role) the "Administer privatemsg" permission to configure this module.') . '</dd>';
      $output .= '<dd>' . t('2. On this same Permissions page, give at least one role the "Read private messages" permission and the "Write new private messages" permission.  This will allow members of that role to read and write private messages.') . '</dd>';
      $output .= '<dd>' . t('3. Go to Configuration > Private messages (admin/config/messaging/privatemsg) and configure the module settings per your requirements. If you have various sub-modules enabled, their settings pages may appear as tabs on this page. ') . '</dd>';
      $output .= '<dd>' . t('4. Login as a user with the role we specified in Step #2. Visit /messages to see the user&apos;s mailbox. Visit /messages/new to write a new message.') . '</dd>';
      $output .= '</dl>';
  }
  return $output;
}