You are here

Home » API reference » Favorites 7.2

README.txt in Favorites 7.2

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

  Drupal 7.x Version by:
    David Herminghaus | http://drupal.org/user/833794
--------------------------------------------------------------------------------

CONTENTS
========

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

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

This structure allows for bookmarks of virtually any page on your Drupal site,
this is the difference to modules like "flag". It simply works as a bookmark
storage in the users' browsers, but accessible from every computer from which
they log on to your site - if a user is registered.

If you set the appropriate permission, also unregistered users ("guests") may 
use the module. However, as they have no database access, their favorites
will not be stored in your Drupal database, but on their local PC. Although
this is actually just a clone of every browser's bookmark system, there
were several feature requests for this in order to implement simple check
or shopping lists.

2. INSTALLATION/SETUP
=====================
* Install the module as usual.
* Set the user permissions.
* 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 7.x Version by:

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

  7. --------------------------------------------------------------------------------

  8. 

  9. CONTENTS

  10. ========

  11. 

  12. 1. ABOUT

  13. 2. INSTALLATION/SETUP

  14. 3. USAGE

  15. 4. KNOWN ISSUES

  16. 

  17. 1. ABOUT

  18. ========

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

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

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

  22. 

  23. This structure allows for bookmarks of virtually any page on your Drupal site,

  24. this is the difference to modules like "flag". It simply works as a bookmark

  25. storage in the users' browsers, but accessible from every computer from which

  26. they log on to your site - if a user is registered.

  27. 

  28. If you set the appropriate permission, also unregistered users ("guests") may 

  29. use the module. However, as they have no database access, their favorites

  30. will not be stored in your Drupal database, but on their local PC. Although

  31. this is actually just a clone of every browser's bookmark system, there

  32. were several feature requests for this in order to implement simple check

  33. or shopping lists.

  34. 

  35. 2. INSTALLATION/SETUP

  36. =====================

  37. * Install the module as usual.

  38. * Set the user permissions.

  39. * Place the block into the region of your choice.

  40. * Done.

  41. 

  42. 3. USAGE

  43. ========

  44. * Adding a page:

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

  46.   and click "add".

  47. * Removing a page:

  48.   Click on the trailing "x".

  49. * Altering an item's title:

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

  51. 

  52. 4. KNOW ISSUES

  53. ==============

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

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

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

  57. 

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

  59. 

  60. favorites_add_favorite_form

  61. 

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

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

  64. might occur.

  65. 

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

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