summaryrefslogtreecommitdiffstats
path: root/buddylist_ui/README.txt
blob: 323ca621fb55b2d046140e0f0db8b74d3224b8ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
********************************************************************
                     D R U P A L    M O D U L E
********************************************************************
Name: Buddylist UI
Author: Dominik Kiss <dominik.kiss[at]gmx.at> nodestroy at drupal.org
Thanks to: dkruglyak at drupal.org
Drupal Version: 5
********************************************************************
DESCRIPTION:

Buddylist UI is an user-interface for Buddy API. All listings are
done with views, so you can adapt and theme the listings how you want. 

Required Modules are:
 - usernode (to list users via views. usernode is NO profile solution)
 - views

Recommended Modules are:
 - workflow-ng
 - token

If you use workflow-ng you can easy adapt all messages over the 
workflow-ng UI. Further you are able to send mails on various buddy 
events (userA requests userB to be his buddy). Buddy_api has a few
workflow-ng configurations onboard. Just install workflow-ng to have
customizable mails and messages. Furthermore, the default buddy_api
workflow-ng configuration logs all user actions to watchdog.

Supported operation modes are:
 - one-way connections
 - two-way connections
 
That means, you can decide if there should be only one connection 
(a->b) or a double connection: a<->b (a->b AND b->a)

Supported actions:
 - one-way:
   * userA adds userB to his buddylist
   * userA deletes userB from his buddylist
   [* show buddylist of userX]
 
 - two-way:
   * show buddylist of userX
   * userA requests to add userB (with message)
   * userA cancels request to userB
   * userB accepts request
   * userB declines request
   * userA deletes userB from his buddylist

Default Views:
- buddylist 
- sent requests 
- received requests 

Default actions (all configurable via workflow_ng):
- log every buddy-action to watchdog 
- send a mail when UserA requests to add UserB
- send a mail when UserB accepts request from UserA
- show messages at every buddy action
you can add, edit and delete actions at the workflow UI

********************************************************************
INSTALLATION:

1. Download the module from drupal.org and place it into your drupal
   directory (/sites/all/modules)
   
2. Download all required modules from drupal.org and place it into 
   the same directory. (usernode + views [+ workflow-ng + token])
   
3. Enable the modules at:
   administer -> site building -> modules
   
4. Allow users to access other user profiles by activating
   "access user profiles" for authenticated users at
   administer -> user management -> access control

5. Allow users to access buddylist and maintain there buddies by
   activating "view buddy lists" and "maintain buddy lists" 
   for authenticated users at
   administer -> user management -> access control
   

[6. Activate the needed views (buddy_api_buddylist, 
   buddy_api_received_requests and buddy_api_sent_requests)
   it the views UI at
   administer -> site building -> views
   (Views UI must be enabled to do this)]
   
7. goto ?q=buddylist and see your buddylist central managing page 
   [add a menu item, which points to ?q=buddylist]

8. have fun ;)

********************************************************************
USE OF VIEWS (advanced):

NOTE: the buddylist view is integrated in every user page (by default)

- The "buddylist" view uses arguments to list the buddylist of another 
  user. To list friends of user with uid 4, you have to call the view 
  with arg 4: index.php?q=buddylisting/4
  buddylisting = name of view