function jquery_countdown_help in jQuery Countdown 6

Same name and namespace in other branches

1. 5 jquery_countdown.module \jquery_countdown_help()

Implementation of hook_help().

File

./jquery_countdown.module, line 32

provides the jquery_countdown theme function and serversync callback

Code

function jquery_countdown_help($path, $args) {
  switch ($path) {
    case 'admin/help#jquery_countdown':
      $output = '<p>' . t('The <a href="@jquerycountdown">jQuery Countdown</a> plugin provides a live countdown timer. The following are some examples of it in use...', array(
        '@jquerycountdown' => 'http://keith-wood.name/countdown.html',
      )) . '</p>';

      // In this example, we use the theme function.
      $output .= '<p>' . theme('jquery_countdown', array(
        'since' => 'January 1, 2009',
        'format' => 'YOWDHMS',
        'description' => t('Since New Year'),
      )) . '</p>';

      // Provide the div and add the countdown timer to count from 10.
      $output .= '<h3>' . t('Blast off in 10 seconds') . '</h3><div id="countdownfrom20"></div>';
      jquery_countdown_add('#countdownfrom20', array(
        'until' => 10,
        // Numbers are counted as seconds.
        'format' => 'S',
        // Just display seconds.
        'expiryText' => t('<h1>Blast Off!</h1>'),
      ));

      // Provide the div and add the countdown timer to count until February 12th, 2020.
      $output .= '<h3>' . t('Countdown to February 12th, 2020') . '</h3><div id="countdownto2020"></div>';
      jquery_countdown_add('#countdownto2020', array(
        'until' => 'February 12, 2020',
      ));

      // Provide the div and add the countdown timer to count until 2010.
      $output .= '<h3>' . t('Countdown to 2030') . '</h3><div id="countdownto2030"></div>';
      jquery_countdown_add('#countdownto2030', array(
        'until' => array(
          2030,
          0,
          0,
        ),
      ));
      return $output;
      break;
  }
}