function clock_help in Clock 7.2

Same name and namespace in other branches

1. 6 clock.module \clock_help()
2. 7 clock.module \clock_help()

Implements hook_help().

File

./clock.module, line 153

Display clocks on your site.

Code

function clock_help($path, $arg) {
  switch ($path) {
    case 'admin/help#clock':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Clock module allows the display of muliple clocks on your site.') . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Administering the clocks') . '</dt>';
      $output .= '<dd>' . t('Since the clocks are a block, they can be administered via their <a href="@clock-settings">block settings page</a> which is accessible from the <a href="@block-admin">block administration page</a>. In addition to the usual block configuration options you can add new blocks, edit or delete existing ones and reorder the clocks.', array(
        '@clock-settings' => url('admin/structure/block/manage/clock/clock/configure'),
        '@block-admin' => url('admin/structure/block'),
      )) . '</dd>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding a clock') . '</dt>';
      $output .= '<dd>' . t('If you wish to add a new clock, you can choose its time zone type and its date type. Following options are available for the time zone type:');
      $output .= '<ul>';
      $output .= '<li>' . t('<em>Site time zone:</em> The time zone that has been set on the <a href="@regional-admin">regional settings page</a>.', array(
        '@regional-admin' => url('admin/config/regional/settings'),
      )) . '</li>';
      $output .= '<li>' . t('<em>User time zone:</em> This option will only show up, if user-configurable time zones are enabled (see the <a href="@regional-admin">regional settings page</a>). The time zone the user has selected.', array(
        '@regional-admin' => url('admin/config/regional/settings'),
      )) . '</li>';
      $output .= '<li>' . t('<em>Local time zone:</em> The local time zone on the computer of the visiting user (anonymous or authenticated). Since JavaScript is used to calculate this time, it falls back to the site time zone if the visitor has JavaScript disabled.') . '</li>';
      $output .= '<li>' . t('<em>Custom time zone:</em> A custom time zone that can be selected in the select box below.') . '</li>';
      $output .= '</ul>';
      $output .= t('For the date type all of the date types that have been set on the <a href="@format-admin">date and time settings page</a> are available.', array(
        '@format-admin' => url('admin/config/regional/date-time'),
      )) . '</dd>';
      $output .= '</dl>';
      $output .= '</dl>';
      return $output;
  }
}