You are here

function messaging_help in Messaging 5

Same name and namespace in other branches
  1. 6.4 messaging.module \messaging_help()
  2. 6 messaging.module \messaging_help()
  3. 6.2 messaging.module \messaging_help()
  4. 6.3 messaging.module \messaging_help()
  5. 7 messaging.module \messaging_help()

Implementation of hook_help().

File

./messaging.module, line 23

Code

function messaging_help($section) {
  switch ($section) {
    case 'admin/help#messaging':
      $output = '<p>' . t('The messaging module is the engine that handles outgoing messages and message queueing for different sending methods.') . '</p>';
      $output .= '<p>' . t('You need to enable one or more of the included plug-ins to be able to actually take advantage of it.') . '</p>';
      return $output;
    case 'admin/messaging/template':
      $output = '<p>' . t('Configure the templates for different types of messages. Each message group is defined by other modules using the Messaging Framework.') . '</p>';
      return $output;
    default:
      if (arg(0) == 'admin') {
        if (arg(1) == 'settings' && arg(2) == 'filters') {
          return '<p>' . t('Filters are used also for messaging. If the input format is to be used only for messaging you don\'t need to allow any role for it.') . '</p>';
        }
        if (arg(1) == 'messaging' && arg(2) == 'template' && arg(3) == 'edit' && ($group = arg(4))) {
          $output = '<p>' . t('These are the message parts for %group. Leave blank to use the default texts or use \'%empty\' for an empty message part, preventing fallback to default message texts.', array(
            '%group' => messaging_message_group($group, 'name'),
            '%empty' => MESSAGING_EMPTY,
          )) . '</p>';
          if ($help = messaging_message_group($group, 'help')) {
            $output .= '<p>' . $help . '</p>';
          }
          return $output;
        }
      }
  }
}