README.txt 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. You may want to visit the handbook of this module, at:
  2. http://drupal.org/handbook/modules/flag
  3. The Flag module is a flexible flagging system whose primary goal is
  4. to give all the control to the administrator. Using this module, the
  5. site administrator can provide an arbitrary number of 'flags'.
  6. A flag is really just a boolean toggle that is set on an entity such as a node,
  7. comment, or user. Flags may be per-user, meaning that each user can flag an item
  8. individually, or global, meaning that the item is either flagged or it
  9. is not flagged, and any user who changes that changes it for everyone.
  10. In this way, additional flags (similar to 'published' and 'sticky') can
  11. be put on nodes, or other items, and dealt with by the system however
  12. the administration likes.
  13. Each flag allows the administrator to choose the 'flag this' text, and
  14. the place where the user interface for flagging the item will appear
  15. (For example: for nodes, whether a flagging link appears on the node
  16. teaser as well on the full node view).
  17. Each flag can be restricted to use only by certain roles. Each
  18. flag provides data to the Views module, and provides a default
  19. view to list 'My bookmarks'. These default views are somewhat crude,
  20. but are easily tailored to whatever the system administrator would like
  21. it to do.
  22. Each flag also provides an 'argument' to the Views module that can be
  23. used to allow a user to view other people's flagged content. This isn't
  24. turned on by default anywhere, though, and the administrator will need
  25. to construct a view in order to take advantage of it.
  26. The Flag Bookmark module provides a simple flag called "bookmarks" and
  27. a simple view for 'My bookmarks'. This is a default view provided by the
  28. Flag module, but can be customized to fit the needs of your site. To
  29. customize this view, go to admin/structure/views and find the
  30. 'flags_bookmarks' view. Click the 'Add' action to customize the view.
  31. Once saved, the new version of the view will be used rather than the one
  32. provided by Flag.
  33. Besides editing the default view that comes with the module, Flag
  34. provides many views filters, fields, and sort criteria to make all sorts of
  35. displays possible relating to the number of times an item has been flagged.
  36. This module was formerly known as Views Bookmark, which was originally was
  37. written by Earl Miles. Flag was written by Nathan Haug and mystery man Mooffie.
  38. This module built by robots: http://www.lullabot.com
  39. Recommended Modules
  40. -------------------
  41. - Views
  42. - Session API
  43. - Token, which is required for Flag to provide tokens on flagged entities.
  44. Installation
  45. ------------
  46. 1) Copy the flag directory to the modules folder in your installation.
  47. 2) Enable the module using Administer -> Modules (/admin/modules)
  48. Optional Installation
  49. ---------------------
  50. 1) The ability for anonymous users to flag content is provided by the Session
  51. API module, available at http://drupal.org/project/session_api.
  52. Configuration
  53. -------------
  54. The configuration for Flag is spread between Views configuration
  55. and the Flag site building page. To configure:
  56. 1) Configure the flags for your site at
  57. Administer -> Structure -> Flags (/admin/structure/flags)
  58. You can create and edit flags on this page. Descriptions for the various
  59. options are provided below each field on the flag edit form.
  60. 2) Go to the Views building pages at
  61. Administer -> Site Building -> Views (/admin/structure/views)
  62. A default view is provided to get you started organizing your flags. You
  63. can override the view or use it as a template to control the display of your
  64. flags.
  65. Support
  66. -------
  67. If you experience a problem with flag or have a problem, file a
  68. request or issue on the flag queue at
  69. http://drupal.org/project/issues/flag. DO NOT POST IN THE FORUMS.
  70. Posting in the issue queues is a direct line of communication with the module
  71. authors.
  72. No guarantee is provided with this software, no matter how critical your
  73. information, module authors are not responsible for damage caused by this
  74. software or obligated in any way to correct problems you may experience.
  75. Licensed under the GPL 2.0.
  76. http://www.gnu.org/licenses/gpl-2.0.txt