function fivestar_help in Fivestar 6.2

Same name and namespace in other branches

1. 8 fivestar.module \fivestar_help()
2. 5 fivestar.module \fivestar_help()
3. 6 fivestar.module \fivestar_help()
4. 7.2 fivestar.module \fivestar_help()

Implementation of hook_help().

File

./fivestar.module, line 11

A simple n-star voting widget, usable in other forms.

Code

function fivestar_help($path, $arg) {
  $output = '';
  switch ($path) {
    case 'admin/settings/fivestar':
      $output = t('This page is used to configure site-wide features of the Fivestar module. To setup Fivestar to rate content:');
      $steps = array(
        t('Configure site-wide settings for Fivestar below.'),
        t('Go to <a href="!types">admin/content/types</a> and edit the type you would like to rate.', array(
          '!types' => url('admin/content/types'),
        )),
        t('On the settings page for the content type, a set of options is available for fivestar, where you can enable rating for that type and set rating options.'),
      );
      $output .= theme('item_list', $steps, NULL, 'ol');
      break;
    case 'admin/content/node-type/' . $arg[3] . '/fivestar':
      $arg[5] = 'vote';
    case 'admin/content/node-type/' . $arg[3] . '/fivestar/' . $arg[5]:
      $output = t('Use the settings on this page to set up Fivestar rating for the %type content type. These settings specifically affect the %axis rating axis. If needing to set up different criteria for voting, see the main <a href="@url">Fivestar settings page</a>.', array(
        '%type' => node_get_types('name', $arg[3]),
        '%axis' => $arg[5],
        '@url' => url('admin/settings/fivestar'),
      ));
      break;
  }
  return $output;
}