function notifications_help in Notifications 7

Same name and namespace in other branches

1. 6.4 notifications.admin.inc \notifications_help()
2. 6.3 notifications.module \notifications_help()

Implements hook_help().

This file will be included only for Notifications admin pages

File

./notifications.module, line 46

Notifications module

Code

function notifications_help($path, $arg) {
  $pages = array(
    '@admin-events' => url('admin/config/messaging/notifications/events'),
    '@admin-subscriptions' => url('admin/config/messaging/subscriptions'),
    '@admin-messaging' => url('admin/config/messaging/settings'),
    '@admin-methods' => url('admin/config/messaging/settings/methods'),
    '@admin-triggers' => url('admin/structure/trigger'),
  );
  switch ($path) {
    case 'admin/config/messaging/notifications/events':
      $output = '<p>' . t('To set up event actions, go to the <a href="@admin-triggers">Triggers page</a>.', $pages) . '</p>';
      return $output;
    case 'admin/config/messaging/notifications/settings':

      // Try to clarify some concepts, tell the long story short.
      $output = '<p>' . t('Users can subscribe to different objects (nodes, users, tags) by creating <strong><a href="@admin-subscriptions">Subscriptions</a></strong> for that objects. The subscription types available and the options to display will depend on additional modules enabled.', $pages) . '</p>';
      $output .= '<p>' . t('When an <a href="@admin-events">Event</a> happens (node update, comment) and it matches an existing subscription, that triggers a <strong>Notification</strong> which is a <strong>Message</strong> that will be sent to the user through one of the available <a href="@admin-methods">Sending Methods</a>.', $pages) . '</p>';
      $output .= '<p>' . t('These <strong>Notifications</strong> can be sent right away or queued to be processed on <i>cron</i>. Optionally Notifications can be digested and sent out every some <a href="@admin-intervals">time interval</a>.', $pages) . '</p>';
      return $output;
    case 'admin/messaging/notifications/subscriptions':
      $output = '<p>' . t('On this page you can define which subscription types are enabled or disabled. <strong>Disabled subscription types will not be available for users</strong>.') . '</p>';
      $output .= '<p>' . t('<strong>Existing subscriptions will be updated accordingly</strong>. They\'ll be disabled when their type is disabled or re-enabled when they were disabled and the type is enabled.') . '</p>';
      return $output;
  }
}