annotate mod_group_bookmarks.wiki @ 390:2ad6225d937f

mod_smacks: Update to reflect Swift releases
author Kim Alvefur <zash@zash.se>
date Mon, 15 Jul 2013 02:00:29 +0200
parents f0db29e111fc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
162
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary mod_groups for chatrooms
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
2 #labels Stage-Beta
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
305
f0db29e111fc Link to mod_groups in Prosody docs
MWild1@gmail.com
parents: 163
diff changeset
6 [http://prosody.im/doc/modules/mod_groups mod_groups] allows you to insert contacts into users' contact lists. Well mod_group_bookmarks allows you to insert chatrooms into the user's bookmarks. These are fetched by their client and automatically joined when the log in.
162
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
7
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
8 In short, if you want to automatically join users to rooms when they sign in, this is the module you want.
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
10 = Details =
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
11
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
12 Most clients support storing a private list of room "bookmarks" on the server. When they log in, they fetch this list and join any that are marked as "autojoin". Without affecting normal usage of the bookmarks store this module dynamically inserts custom rooms into users' bookmarks lists.
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
13
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
14 = Usage =
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
15
305
f0db29e111fc Link to mod_groups in Prosody docs
MWild1@gmail.com
parents: 163
diff changeset
16 Similar to [http://prosody.im/doc/modules/mod_groups mod_groups], you need to make a text file in this format:
162
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
17
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
18 {{{
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
19 [room@conferenceserver]
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
20 user1@example.com=User 1
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
21 user2@example.com=User 2
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
22
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
23 [otherroom@conferenceserver]
163
85482789e90e mod_group_bookmarks: Fixed typo in example.
Waqas Hussain <waqas20@gmail.com>
parents: 162
diff changeset
24 user3@example.net=User 3
162
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
25 }}}
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
26
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
27 Add "group_bookmarks" to your modules_enabled list:
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
28 {{{
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
29 modules_enabled = {
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
30 -- ...other modules here... --
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
31 "group_bookmarks";
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
32 -- ...maybe some more here... --
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
33 }
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
34 }}}
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
35
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
36 = Configuration =
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
37 ||group_bookmarks_file||The path to the text file you created (as above).||
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
38
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
39 = Compatibility =
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
40 ||0.8||Works||
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
41 ||0.7||Should work||
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
42 ||0.6||Should work||
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
43
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
44 = Todo =
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
45
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
46 * Support for injecting into ALL users bookmarks, without needing a list
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
47 * Allow turning off the autojoin flag
926701c0f73e Created wiki page through web user interface.
MWild1
parents:
diff changeset
48 * Perhaps support a friendly name for the bookmark (currently uses the room address)