function spamspan_help in SpamSpan filter 5

Same name and namespace in other branches

1. 8.2 spamspan.module \spamspan_help()
2. 8 spamspan.module \spamspan_help()
3. 6 spamspan.module \spamspan_help()
4. 7 spamspan.module \spamspan_help()

Implementation of hook_help().

File

./spamspan.module, line 20

This module implements the spamspan technique (http://www.spamspan.com ) for hiding email addresses from spambots. If javascript is disabled on the client-side, addresses appear as example [at] example [dot] com.

Code

function spamspan_help($section) {
  switch ($section) {
    case 'admin/modules#description':

      // This description is shown in the listing at admin/modules.
      $output = t('Disguises email addresses in an attempt to reduce spam.');
      if (module_exists('spamspan')) {
        $output .= t(' <a href="%url">more help</a>', array(
          '%url' => url('admin/help/spamspan'),
        ));
      }
      return $output;
    case 'admin/help#spamspan':
      return t('<p>The SpamSpan module obfuscates email addresses to help prevent spambots from collecting them. It will produce clickable links if JavaScript is enabled, and will show the email address as <code>example [at] example [dot] com</code> if the browser does not support JavaScript.</p><p>To configure the module, select "configure" next to the <a href="%url">input format</a> you\'d like to use. Enable "Hide Email Addresses" and submit the form. Then select the "configure" tab to choose relevant options.</p>', array(
        '%url' => url('admin/filters'),
      ));
  }
}