function user_badges_help in User Badges 5

Same name and namespace in other branches

1. 8 user_badges.module \user_badges_help()
2. 6.2 user_badges.module \user_badges_help()
3. 6 user_badges.module \user_badges_help()
4. 7 user_badges.module \user_badges_help()
5. 7.2 user_badges.module \user_badges_help()
6. 7.3 user_badges.module \user_badges_help()

Implementation of hook_help().

File

./user_badges.module, line 25

@brief User Badges module file

Code

function user_badges_help($section) {
  switch ($section) {
    case 'admin/modules#description':

      // This description is shown in the listing at admin/modules.
      return t('Merit badges that administrators can assign to users.');
    case 'admin/settings/user_badges':
      return t("User badges are iconic images which can be assigned to users. They can represent accomplishments, status, or anything you'd like. These badges will show up in the user's profile, and could also be used by a theme to appear with user postings on forums, comments, or nodes. Badges can be assigned manually by an administrator by visiting a user's profile. They also can be assigned automatically by role or ecommerce purchase (if ecommerce modules are installed).");
    case 'admin/settings/user_badges/roles':
      return t("Select the badge that you'd like to associate with each role.");
    case 'admin/settings/user_badges/images':
      return t("Upload images to display as a user badge. These images can be anything you like, but it is recommended that you maintain a uniform icon size for all of your badges. Keep in mind that a user may have many badges displayed so you'll probably want to keep them as small as possible (like 16x16 pixels or smaller).");
    case 'admin/settings/user_badges/products':
      return t("For each ecommerce product listed below, select the badge that will be assigned to users upon payment completion.");
  }
}