function birthdays_help in Birthdays 7

Same name and namespace in other branches

1. 5 birthdays.module \birthdays_help()
2. 6 birthdays.module \birthdays_help()

Implements hook_help().

File

./birthdays.module, line 51

The Birthdays module allows users to add their birthday to their profile. It lists birthdays on a seperate page and in different blocks. Users can receive an email on their birthday automatically, and the administrator can receive daily reminders of…

Code

function birthdays_help($path, $arg) {
  switch ($path) {
    case 'admin/help#birthdays':
      $output = '<h3>' . t('Introduction') . '</h3>';
      $output .= '<p>' . t('The Birthdays module allows users to add their birthday to their profile. In their profile the date of birth can be shown, as well as their age and their star sign. This is all configurable.') . '</p>';
      $output .= '<p>' . t('You can also list the birthdays an blocks and pages using Views. You can filter by day, month and year, display only N upcoming birthdays and so on.') . '</p>';
      $output .= '<p>' . t('It is optional to send users an email or execute another action on their birthday, and the administrator can recieve periodic reminders of who are having their birthday next day, week or month.') . '</p>';
      $output .= '<h3>' . t('The birthday field type') . '</h3>';
      $output .= '<p>' . t('Birthdays module provides a field type for birthdays. You can use birthday fields for all entity types. Use the "Manage fields" page of your content type / entity type / bundle to add the field. You can also go thee to change the field instance settings later. These are available:') . '<p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Display during registration (if on user entity)') . '</li>';
      $output .= '<li>' . t('Allow the user to hide the year of birth or decide to always or never hide the year of birth.') . '</li>';
      $output .= '<li>' . t('Send regular emails reminding of upcoming birthdays.') . '</li>';
      $output .= '</ul>';
      $output .= '<h3>' . t('Birthdays defaults') . '</h3>';
      $output .= '<p>' . t('Adds a birthday field to the user entity type, provides a default view and a default "Happy birthday mail" action.') . '</p>';
      $output .= '<h3>' . t('Triggers and Actions') . '</h3>';
      $output .= '<p>' . t('Triggers module allows you to execute actions on birthdays. Birthday module has a tab on the Triggers configuration page, where you can assign actions to execute for each field instance.') . '</p>';
      $output .= '<p>' . t('The assigned actions are fired during cron runs.') . '</p>';
      $output .= '<p>' . t('Note that the birthday field type has also a setting, to allow the user to opt-out of triggers.') . '</p>';
      $output .= '<h3>' . t('Views') . '</h3>';
      $output .= '<p>' . t('Birthdays defaults provides a default page and block, but you can create more custom views.') . '</p>';
      $output .= '<p>' . t('You can use birthday fields as fields, for sorting and for filtering. The field has clicksort support. You can sort by absolute timestamp, time to next birthday or day of the year. You can filter by absolute values or offsets in days. Also day, month and year column are available as seperate integer columns.') . '</p>';
      return $output;
  }
}