function brb_help in Browser Bouncer (brb) 7

Display help and module information

Parameters

path which path of the site we're displaying help:

arg array that holds the current path as would be returned from arg() function:

Return value

help text for the path

File

./brb.module, line 19

Display a message to let the user knows his/her browser is not supported. This message also offer to the user different browsers that can be used instead.

Code

function brb_help($path, $arg) {
  $output = '';

  //declare your output variable
  switch ($path) {
    case "admin/help#brb":
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Browser Bouncer (BrB) module displays a message to users informing them that their browser is not supported. For more information, see the online handbook entry for <a href="@brb">Browser Bouncer (BrB)</a>.', array(
        '@brb' => 'http://drupal.org/handbook/modules/brb',
      )) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Prompting users to upgrade their browser') . '</dt>';
      $output .= '<dd>' . t('When the module is enabled, anyone using a browser that is included in the "not supported" list will see a warning message on the site.') . '</dd>';
      $output .= '<dt>' . t('Administering the module') . '</dt>';
      $output .= '<dd>' . t('The <a href="@settings">settings page</a> allows you to change: the blocked browsers, displayed text, overlay, and the list of alternative browsers.', array(
        '@settings' => url('admin/config/brb'),
      )) . '</dd>';
      $output .= '<dt>' . t('User permissions') . '</dt>';
      $output .= '<dd>' . t('The Browser Bouncer (BrB) module makes a number of permissions available for administration and browsing without the warning message, which can be set by role on the <a href="@permissions">permissions page</a>.', array(
        '@permissions' => url('admin/settings/permissions'),
      )) . '</dd>';
      $output .= '</dl>';
  }
  return $output;
}