function radioactivity_help in Radioactivity 8.3

Same name and namespace in other branches

1. 8.2 radioactivity.module \radioactivity_help()
2. 5 radioactivity.module \radioactivity_help()
3. 6 radioactivity.module \radioactivity_help()
4. 7.2 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 16

Provides a field type which can be used as a hotness metric.

Code

function radioactivity_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the radioactivity module.
    case 'help.page.radioactivity':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('With the Radioactivity module you can measure popularity of your content. In combination with Views you can makes lists of popular content.') . '</p>';
      $output .= '<h3>' . t('Configuration') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Add field') . '</dt>';
      $output .= '<dd>' . t('Attach the Radioactivity field to your entity') . '</dd>';
      $output .= '<dd>' . t('Configure field on field settings if required, default should be sufficient') . '</dd>';
      $output .= '<dt>' . t('Manage display') . '</dt>';
      $output .= '<dd>' . t('On manage display, set field as enabled') . '</dd>';
      $output .= '<dd>' . t('Configure field on manage display page setting energy and emit mode, ensure enabled on the displays you want to record activity on.') . '</dd>';
      $output .= '<dt>' . t('Cron') . '</dt>';
      $output .= '<dd>' . t('Energy will be updated when cron is run') . '</dd></ul>';
      $output .= '</dl>';
      $output .= '<h3>' . t('Using with views') . '</h3>';
      $output .= '<p>' . t("For sorting use the field associated with your entity using the 'energy' component of the field, sort using asc or desc.") . '</p>';
      return $output;
    default:
  }
}