You are here

Home » API reference » User Badges 5

README.txt in User Badges 5

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
  3. 7.4 README.txt
  4. 7 README.txt
  5. 7.2 README.txt
  6. 7.3 README.txt
------------------------------------------------------------------------------
  User Badges Module for Drupal
    developed by: Jeff Robbins | jjeff | robbins (att) jjeff (d0t) com
------------------------------------------------------------------------------

Description
===========
The User Badges module allows each user to be assigned 'badges', displayed as
a series of iconic images. A common use will probably be to display the badges
along with the user's information within forums, comments, or node postings.
These badges can be assigned individually by the administrator or attached to
a role so that, for example, all users in the 'admin' role will show the
'Administrator' badge which could display as any graphic.

Any badge can optionally be associated to a URL that links the image to a
description page. If a user has more than one badge, there is also a mechanism
that allows administrators to only show the most highest-level badge.
You can also set a special badge for blocked users and even override their 
role badges with this one.

User Badges can be used as a way to establish trust (in the same way as eBay's
star graphics) or as an incentive for users. They can also be a quick way to
identify moderators, administrators, or anyone with a given role.


Limitation
==========

User Badges is not compatible with the "private" file download method.


Dependencies
============
In order to upload images via the user interface, user badges depends on:

* Upload


Configuration
=============
Once the module is activated, go to Administer >> User management >> Badges
(admin/user/user_badges). Here you'll find three tabbed sections for User Badges.

* Edit user badges - allows you to add and edit badges.
* Images - where you can upload or delete images to associate with each
  badge.
* Roles - where you can associate a badge with a given role so that all users
  with that role will display the selected badge.
* Settings - where you can set the global settings of the badges on your site

Users with the 'manage badges' access permission will be shown a 'Badges' tab
when visiting user profiles. This is the place to manually assign badges to
users.


Display badges
==============
To display user badges in your theme use :

<?php print user_badges_for_uid($uid); ?>

Note: $uid means 'a user id' here, not the literal use of $uid. Most people will use
the uid of the node ($node->uid) or comment ($comment->uid) author.


Former maintainers
==================
* Jeff Robbins (http://drupal.org/user/17190)
* Chad Phillips (http://drupal.org/user/22079)
* Heine Deelstra (http://drupal.org/user/17943)


Current maintainer
===================
Nuno Veloso (http://drupal.org/user/80656)

File

README.txt
View source 
  1. ------------------------------------------------------------------------------

  2.   User Badges Module for Drupal

  3.     developed by: Jeff Robbins | jjeff | robbins (att) jjeff (d0t) com

  4. ------------------------------------------------------------------------------

  5. 

  6. Description

  7. ===========

  8. The User Badges module allows each user to be assigned 'badges', displayed as

  9. a series of iconic images. A common use will probably be to display the badges

  10. along with the user's information within forums, comments, or node postings.

  11. These badges can be assigned individually by the administrator or attached to

  12. a role so that, for example, all users in the 'admin' role will show the

  13. 'Administrator' badge which could display as any graphic.

  14. 

  15. Any badge can optionally be associated to a URL that links the image to a

  16. description page. If a user has more than one badge, there is also a mechanism

  17. that allows administrators to only show the most highest-level badge.

  18. You can also set a special badge for blocked users and even override their 

  19. role badges with this one.

  20. 

  21. User Badges can be used as a way to establish trust (in the same way as eBay's

  22. star graphics) or as an incentive for users. They can also be a quick way to

  23. identify moderators, administrators, or anyone with a given role.

  24. 

  25. 

  26. Limitation

  27. ==========

  28. 

  29. User Badges is not compatible with the "private" file download method.

  30. 

  31. 

  32. Dependencies

  33. ============

  34. In order to upload images via the user interface, user badges depends on:

  35. 

  36. * Upload

  37. 

  38. 

  39. Configuration

  40. =============

  41. Once the module is activated, go to Administer >> User management >> Badges

  42. (admin/user/user_badges). Here you'll find three tabbed sections for User Badges.

  43. 

  44. * Edit user badges - allows you to add and edit badges.

  45. * Images - where you can upload or delete images to associate with each

  46.   badge.

  47. * Roles - where you can associate a badge with a given role so that all users

  48.   with that role will display the selected badge.

  49. * Settings - where you can set the global settings of the badges on your site

  50. 

  51. Users with the 'manage badges' access permission will be shown a 'Badges' tab

  52. when visiting user profiles. This is the place to manually assign badges to

  53. users.

  54. 

  55. 

  56. Display badges

  57. ==============

  58. To display user badges in your theme use :

  59. 

  60. 

  61. 

  62. Note: $uid means 'a user id' here, not the literal use of $uid. Most people will use

  63. the uid of the node ($node->uid) or comment ($comment->uid) author.

  64. 

  65. 

  66. Former maintainers

  67. ==================

  68. * Jeff Robbins (http://drupal.org/user/17190)

  69. * Chad Phillips (http://drupal.org/user/22079)

  70. * Heine Deelstra (http://drupal.org/user/17943)

  71. 

  72. 

  73. Current maintainer

  74. ===================

  75. Nuno Veloso (http://drupal.org/user/80656)