You are here

Home » API reference » Favorites 6

README.txt in Favorites 6

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
--------------------------------------------------------------------------------
  Favorites Module for Drupal
  http://drupal.org/project/favorites

  Drupal 6.x Version by:
    Ezra Barnet Gildesgame | ezra-g | http://growingventuresolutions.com
    David Herminghaus | http://drupal.org/user/833794
--------------------------------------------------------------------------------

CONTENTS
========

1. ABOUT
2. INSTALLATION/SETUP
3. USAGE
4. KNOWN ISSUES

1. ABOUT
========
The Favorites allows users with the appropriate permission to add any page on
the site to "user favorites" block. Favorites are stored as a path (such as
'search') with the query string (such as '?abc=123&def=234'). 

2. INSTALLATION/SETUP
=====================
Just install the module as usual, set the user permissions and place the block
into the region of your choice. Done.

3. USAGE
========
* Adding a page:
  Open the "add this page" section, eventually modify the proposed page title
  and click "add".
* Removing a page:
  Click on the trailing "x".
* Altering an item's title:
  Navigate to the target and simply add it again.

4. KNOW ISSUES
==============
If you are using any extensions which modify form submit buttons or otherwise
dynamically act on block content (e.g. http://drupal.org/project/blajax ),
make sure they will not interfere with the "add favorites" form.

E.g. for the "hide submit" module, make sure you add

favorites_add_favorite_form

to the "Form-id exclusion list" which can be found at admin/settings/hide-submit
within the "advanced" section near the page bottom. Otherwise, strange results
might occur.

Alternatively to all this, you may disable Ajax support in the favorites block settings
(see admin/build/block/configure/favorites/0).

File

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

  2.   Favorites Module for Drupal

  3.   http://drupal.org/project/favorites

  4. 

  5.   Drupal 6.x Version by:

  6.     Ezra Barnet Gildesgame | ezra-g | http://growingventuresolutions.com

  7.     David Herminghaus | http://drupal.org/user/833794

  8. --------------------------------------------------------------------------------

  9. 

  10. CONTENTS

  11. ========

  12. 

  13. 1. ABOUT

  14. 2. INSTALLATION/SETUP

  15. 3. USAGE

  16. 4. KNOWN ISSUES

  17. 

  18. 1. ABOUT

  19. ========

  20. The Favorites allows users with the appropriate permission to add any page on

  21. the site to "user favorites" block. Favorites are stored as a path (such as

  22. 'search') with the query string (such as '?abc=123&def=234'). 

  23. 

  24. 2. INSTALLATION/SETUP

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

  26. Just install the module as usual, set the user permissions and place the block

  27. into the region of your choice. Done.

  28. 

  29. 3. USAGE

  30. ========

  31. * Adding a page:

  32.   Open the "add this page" section, eventually modify the proposed page title

  33.   and click "add".

  34. * Removing a page:

  35.   Click on the trailing "x".

  36. * Altering an item's title:

  37.   Navigate to the target and simply add it again.

  38. 

  39. 4. KNOW ISSUES

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

  41. If you are using any extensions which modify form submit buttons or otherwise

  42. dynamically act on block content (e.g. http://drupal.org/project/blajax ),

  43. make sure they will not interfere with the "add favorites" form.

  44. 

  45. E.g. for the "hide submit" module, make sure you add

  46. 

  47. favorites_add_favorite_form

  48. 

  49. to the "Form-id exclusion list" which can be found at admin/settings/hide-submit

  50. within the "advanced" section near the page bottom. Otherwise, strange results

  51. might occur.

  52. 

  53. Alternatively to all this, you may disable Ajax support in the favorites block settings

  54. (see admin/build/block/configure/favorites/0).