You are here

function scheduler_help in Scheduler 6

Same name and namespace in other branches
  1. 8 scheduler.module \scheduler_help()
  2. 5 scheduler.module \scheduler_help()
  3. 7 scheduler.module \scheduler_help()
  4. 2.x scheduler.module \scheduler_help()

Implementation of hook_help().

File

./scheduler.module, line 98

Code

function scheduler_help($section) {
  $output = '';
  switch ($section) {
    case 'admin/settings/scheduler':
      $output = '<p>' . t('Adjust the settings for the scheduler module.') . '</p>';
      break;
    case 'admin/settings/scheduler/cron':
      $output = '<p>' . t("When you have set up Drupal's standard crontab job cron.php then Scheduler will be executed during each cron run. " . "However, if you would like finer granularity to scheduler, but don't want to run Drupal's cron more often then you can use the " . "lightweight cron handler provided by Scheduler. This is an independent cron job which only runs the scheduler process and does not " . "execute any cron tasks defined by Drupal core or any other modules.") . '</p>' . '<p>' . t("Scheduler's cron is at /scheduler/cron and a sample crontab entry to run scheduler every minute might look like:") . '</p>' . '<code>* * * * * /usr/bin/wget -O - -q "http://example.com/scheduler/cron"</code>' . '<p>' . t('or') . '</p>' . '<code>* * * * * curl "http://example.com/scheduler/cron" > /dev/null 2>&1</code>';
      break;
    case 'admin/modules#description':
    case 'admin/help#scheduler':

      // This is shown at the top of admin/help/scheduler.
      $output = '<p>' . t('The Scheduler module is used to automate the publishing and unpublishing of nodes.') . '</p>';
      break;
    default:
  }
  return $output;
}