function spam_help in Spam 5

Same name and namespace in other branches

1. 5.3 spam.module \spam_help()
2. 6 spam.module \spam_help()

Drupal _help hook. Provides help and informational text about the spam module.

@path Current display path

Return value

Text appropriate for current $path

File

./spam.module, line 197

Code

function spam_help($path) {
  switch ($path) {
    case 'admin/help#spam':
      $output .= '<p>' . t("The spam module is a powerful collection of tools designed to help website administrators to automatically deal with spam. Spam is any content that is posted to a website that is unrelated to the subject at hand, usually in the form of advertising and links back to the spammer's own website. This module can automatically detect spam, instantly unpublish it, and send notification to the site administrator.") . '</p>';
      break;
    case 'admin/settings/spam':
      $output .= '<p>' . t("These are the global settings controlling the Spam module.") . '</p>';
      break;
    case 'admin/content/comment/list/spam':
    case 'admin/spam/comments':
      $output .= '<p>' . t('The following comments have been marked as spam.') . '</p>';
      break;
    case 'admin/content/comment/list/reported':
      $output .= '<p>' . t('The following comments have been reported as spam.') . '</p>';
      break;
    case 'admin/content/node/list/spam':
    case 'admin/spam/node':
      $output .= '<p>' . t('The following content has been marked as spam.') . '</p>';
      break;
    case 'admin/content/node/list/reported':
      $output .= '<p>' . t('The following content has been reported as spam.') . '</p>';
      break;
    case 'admin/logs/spam':
      $output .= t('If enabled, the spam module will log the various filter actions that lead up to site content being marked as spam or not spam.  These logs can be helpful in understanding why certain content was or was not marked as spam.');
      break;
    case 'admin/logs/spam/blockedips':
      $output .= t('The following IPs have been marked as blocked.');
      break;
    case 'admin/settings/spam/filter':
      $output .= t('This page allows you to select which type of postings will be checked for spam.');
      break;
    case 'admin/settings/spam/limits':
      $output .= t('This page allows you to set limits for the spam module.');
      break;
    case 'admin/settings/spam/actions':
      $output .= t('This page allows you to select which actions should be taken when spam is detected.');
      break;
    case 'admin/settings/spam/advanced':
      $output .= t('This page allows you to specify additional options for the spam module.');
      break;
    case 'admin/settings/spam/custom':
      $output .= t('Custom filters allow you to define words, phrases and/or regular expressions to be tested against new content on your site.  If your custom filter matches, you can cause this to increase or decrease the probability that the given content is spam.  For example, if a comment about "viagra" is completely out of place on your site, you can create a custom filter such that any comment with the word "viagra" in it will always be marked as spam.');
      break;
    case 'admin/settings/spam/url':
      $output .= t('The spam filter\'s Bayesian logic automatically learns spammer web domains.  Any new comment or other content containing one of the web domain names listed below will be automatically marked as spam.  For example, if "spam.com" is listed below, a new comment containing the text "http://spam.com/great/deals" will be marked as spam.');
      $output .= "<p>";
      $output .= t('The advantage that url filters offer is that they are automatically learned by the bayesian filter.  However, it is possible to instead block spammer domains by defining an appropriate custom filter.');
      break;
  }
  return $output;
}