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