function radioactivity_help in Radioactivity 7.2

Same name and namespace in other branches

1. 8.3 radioactivity.module \radioactivity_help()
2. 8.2 radioactivity.module \radioactivity_help()
3. 5 radioactivity.module \radioactivity_help()
4. 6 radioactivity.module \radioactivity_help()
5. 7 radioactivity.module \radioactivity_help()
6. 4.0.x radioactivity.module \radioactivity_help()

Implements hook_help().

File

./radioactivity.module, line 83

Radioactivity core functionality

Code

function radioactivity_help($path, $arg) {
  $output = '';
  switch ($path) {
    case "admin/help#radioactivity":
      $output .= '<h2>' . t('Radioactivity') . '</h2>';
      $output .= '<h3>' . t('Introduction to Radioactivity') . '</h3>';
      $output .= '<p>';
      $output .= t('The radioactivity module provides a field type that measures
        the relative popularity of a particular piece of content.  It can be used
        as a measure of the hotness of a particular piece of content.  Content
        popularity is tracked is by the radioactivity energy field.  Energy can
        be added to a piece of content by a variety of ways depending on the submodule.  ');
      $output .= '</p>';
      $output .= '<h3>' . t('How to use') . '</h3>';
      $output .= '<p>';
      $output .= t('Go to <a href="admin/structure/radioactivity">admin/structure/radioactivity</a>
        and click <em>add</em>.  Then choose a profile name & description. The
        next set of fields widely depends on the submodules enabled, but two
        additional fields are part of the main radioactivity module: Incident
        storage and profile mode.  Incident storage sets when the energy levels
        will be set. Profile mode creates several types of profiles: simple, basic
        & advanced.  Simple profiles act as a view counter, basic provides rudimentary
        decay behavior and advanced allows for custom half lives graph granularity
        and cutoff energy.');
      $output .= '</p>';
      $output .= '<h3>' . t('Submodules') . '</h3>';
      $output .= '<p>';
      $output .= t('Radioactivity comes with the radioactivity defaults submodule
        that demonstrates the different decay profiles available to use.');
      $output .= '</p>';
      $output .= '<h3>' . t('Note:') . '</h3>';
      $output .= '<p>';
      $output .= t('Radioactivity has it\'s own method of hiding the field.  If the field is hidden using the regular field display method, the radioactivity counter on that content type <strong>WILL NOT WORK</strong>.  ');
      $output .= t('Furthermore, Any changes to an energy profile are not retroactive, which
        means any changes will only affect <em>future</em> energy levels.');
      $output .= '</p>';
      $output .= '<h3>' . t('More information') . '</h3>';
      $output .= '<p>';
      $output .= t('Please see the handbook page
        <a href="http://drupal.org/node/338101">http://drupal.org/node/338101</a>,
        Wonderkraut has a <a href="http://www.wunderkraut.com/blog/radioactivity-2-basics/2011-12-05">blog post on Radioactivity</a>,
        or consult #drupal-support on IRC.');
      $output .= '</p>';

      // No retroactive changes.
      break;
  }
  return $output;
}