You are here

Home » API reference » Plus 1 7

README.txt in Plus 1 7

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
README.txt
==========
Plus1

A module that allows users to cast a +1 vote.
This module depends on the Voting API module.
The Voting API provides:
- Its own table to store the votes.
- Helper functions to store votes and retrieve results.
- Integration with the Views module.

Be sure to grant appropriate roles the permission to 'rate content'.

INSTALLATION
=============

To install this module:

- First install the Voting API module, following the install instructions provided with that module.
- Then copy the plus1 folder to your sites/all/modules directory.
- Enable the module on the page ?q=admin/build/modules/list.
- Be sure to grant appropriate roles the permission to 'rate content'.

INFORMATION FOR THEMERS
========================

First off, you can change the 'You voted' text on the module admin page ?q=admin/settings/plus1.

Additionally, you can override the theming function theme_plus1_widget in your theme.

From plus1.module theme_plus1_widget function header:

/**
* Theme for the voting widget.
*
* You are free to load your own CSS and JavaScript files in your
* theming function override, instead of the ones provided by default.
*
* This function adds information to the Drupal.settings.plus1 JS object,
* concerning class names used for the voting widget.
* If you override this theming function but choose to use the
* default JavaScript file, simply assign different values to
* the following variables:
*    $widget_class   (The wrapper element for the voting widget.)
*    $link_class     (The anchor element to cast a vote.)
*    $message_class  (The wrapper element for the anchor element. May contain feedback when the vote has been cast.)
*    $score_class    (The placeholder element for the score.)
* The JavaScript looks for these CSS hooks to
* update the voting widget after a vote is cast.
* Of course you may choose to write your own JavaScript.
* The JavaScript adds presentation, ie: fade in.
*
*/

AUTHOR/MAINTAINER
==================
-Caroline Schnapp at http://11heavens.com (chill35 on http://drupal.org)

File

README.txt
View source 
  1. README.txt

  2. ==========

  3. Plus1

  4. 

  5. A module that allows users to cast a +1 vote.

  6. This module depends on the Voting API module.

  7. The Voting API provides:

  8. - Its own table to store the votes.

  9. - Helper functions to store votes and retrieve results.

  10. - Integration with the Views module.

  11. 

  12. Be sure to grant appropriate roles the permission to 'rate content'.

  13. 

  14. INSTALLATION

  15. =============

  16. 

  17. To install this module:

  18. 

  19. - First install the Voting API module, following the install instructions provided with that module.

  20. - Then copy the plus1 folder to your sites/all/modules directory.

  21. - Enable the module on the page ?q=admin/build/modules/list.

  22. - Be sure to grant appropriate roles the permission to 'rate content'.

  23. 

  24. INFORMATION FOR THEMERS

  25. ========================

  26. 

  27. First off, you can change the 'You voted' text on the module admin page ?q=admin/settings/plus1.

  28. 

  29. Additionally, you can override the theming function theme_plus1_widget in your theme.

  30. 

  31. From plus1.module theme_plus1_widget function header:

  32. 

  33. /**

  34. * Theme for the voting widget.

  35. *

  36. * You are free to load your own CSS and JavaScript files in your

  37. * theming function override, instead of the ones provided by default.

  38. *

  39. * This function adds information to the Drupal.settings.plus1 JS object,

  40. * concerning class names used for the voting widget.

  41. * If you override this theming function but choose to use the

  42. * default JavaScript file, simply assign different values to

  43. * the following variables:

  44. *    $widget_class   (The wrapper element for the voting widget.)

  45. *    $link_class     (The anchor element to cast a vote.)

  46. *    $message_class  (The wrapper element for the anchor element. May contain feedback when the vote has been cast.)

  47. *    $score_class    (The placeholder element for the score.)

  48. * The JavaScript looks for these CSS hooks to

  49. * update the voting widget after a vote is cast.

  50. * Of course you may choose to write your own JavaScript.

  51. * The JavaScript adds presentation, ie: fade in.

  52. *

  53. */

  54. 

  55. AUTHOR/MAINTAINER

  56. ==================

  57. -Caroline Schnapp at http://11heavens.com (chill35 on http://drupal.org)