function messaging_template_admin_help in Messaging 6.3

Aditional help for admin pages, will be called from messaging_help().

All paths here start with 'admin/messaging'

1 call to messaging_template_admin_help()

messaging_template_help in messaging_template/messaging_template.module

Implementation of hook_help().

File

messaging_template/messaging_template.admin.inc, line 16

Messaging Framework - Admin UI

Code

function messaging_template_admin_help($path, $arg) {
  $read_more = t('Read more about <a href="@messaging_template">message templates and the fallback system</a>.', array(
    '@messaging_template' => url('admin/help/messaging_template'),
  ));
  switch ($path) {
    case 'admin/help#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. A typical message consists on the following parts:') . '</p>';
      $output .= '<small><table>';
      $output .= '<tr><td colspan="2"><em>' . t('Subject') . '</em></td><td>' . t('Single line with a short description') . '</td></tr>';
      $output .= '<tr><td rowspan="3">' . t('Body') . '</td><td><em>' . t('Header') . '</em></td><td>' . t('Greetings line') . '</td></tr>';
      $output .= '<tr><td><em>' . t('Content') . '</em></td><td>' . t('Message main content, usually longer with the full description') . '</td></tr>';
      $output .= '<tr><td><em>' . t('Footer') . '</em></td><td>' . t('Closing part with site information, unsubscribe links, etc...') . '</td></tr>';
      $output .= '</table></small>';
      $output .= '<p>' . t('Here you\'ll be able to configure each of these parts for each sending method. When one of these parts is left blank, there is a fallback system which goes as follows:') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('If a message part is left blank for a sending method, the text part from Default sending method will be used.') . '</li>';
      $output .= '<li>' . t('If the Default part is blank too, the fallback template (the parent in this tree) will be used.') . '</li>';
      $output .= '</ul>';
      return $output;
    case 'admin/messaging/template':
      $output = '<p>' . t('Configure the templates for different types of messages. The fallback templates are the parents on this tree.') . " {$read_more}</p>";
      return $output;
    case 'admin/messaging/settings/method':
      $output = '<p>' . t('Depending on your content format and the tokens you are using for messages it is important that you use the right filtering for the message body. Set up the filters you need using the <a href="@input_formats">Input formats</a> page', array(
        '@input_formats' => url('admin/settings/filters'),
      )) . '</p>';
      return $output;
    case 'admin/messaging/template/settings':
      $output = '<p>' . t('These are all the templates provided by enabled modules. You can enable or disable templates and change their fallbacks.') . ' ' . $read_more . '</p>';
      return $output;
    default:
      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[3] == 'edit' && ($name = $arg[4])) {

        // Edit template groups
        $output = '<p>' . t('These are the text parts to build up the message template for each sending method. You can override each part for each method or use the defaults provided.') . ' ' . $read_more . '</p>';
        return $output;
      }
  }
}