function radioactivity_help in Radioactivity 4.0.x

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.2 radioactivity.module \radioactivity_help()
6. 7 radioactivity.module \radioactivity_help()

Implements hook_help().

File

./radioactivity.module, line 17

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 radioactivity field') . '</dt>';
      $output .= '<dd>' . t('Two Radioactivity fields are available. When you start with Radioactivity module, you are advised to use the Radioactivity Reference field. The Radioactivity field (General section) is for existing sites and will de deprecated in the future.') . '</dd>';
      $output .= '<dd>' . t('Attach the Radioactivity (Reference) field to your entity.') . '</dd>';
      $output .= '<dd>' . t('Configure the field settings if required, default should be sufficient. A detailed explanation is available in README.txt.') . '</dd>';
      $output .= '<dt>' . t('Manage form display') . '</dt>';
      $output .= '<dd>' . t('Enable the widget to allow editors to change the energy value.') . '</dd>';
      $output .= '<dt>' . t('Manage display') . '</dt>';
      $output .= '<dd>' . t('Use the Emitter widget in the view modes that should be measured for popularity. Disable the widget in view modes that are not relevant for popularity.') . '</dd>';
      $output .= '<dd>' . t('Configure the Emitter with the amount of energy that will be added per view.') . '</dd>';
      $output .= '<dt>' . t('Use cron') . '</dt>';
      $output .= '<dd>' . t('Cron must be enabled to update the energy levels.') . '</dd>';
      $output .= '</dl>';
      $output .= '<h3>' . t('Using with views') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Configure display') . '</dt>';
      $output .= '<dd>' . t('When using the Radioactivity Reference field, use the Relation ship "Radioactivity referenced from ..." to include the Radioactivity data into your Content view.') . '</dd>';
      $output .= '<dd>' . t('To sorting the view on popularity sort the results on descending "energy".') . '</dd>';
      $output .= '</dl>';
      return $output;
    default:
  }
}