annotate mod_default_bookmarks.wiki @ 469:da42de0ae310

Created wiki page through web user interface. Sorry Link Mauve.
author MWild1@gmail.com
date Sat, 26 Jul 2014 21:51:40 +0000
parents f9b80a58366f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
304
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary Default bookmarked chatrooms
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 = Introduction =
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 This module allows you to add default bookmarks for users. It only kicks in when the user has no existing bookmarks, so users are free to add, change or remove them.
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 = Details =
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 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". If this list is empty, as it would be for new users, this module would return the list supplied in the config.
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 = Configuration =
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 Add "default_bookmarks" to your modules_enabled list:
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 {{{
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 modules_enabled = {
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 -- ...other modules here... --
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 "default_bookmarks";
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 -- ...maybe some more here... --
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 }
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 }}}
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 Then add a list of the default rooms you want:
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 {{{
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 default_bookmarks = {
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 { jid = "room@conference.example.com", name = "The Room" };
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 { jid = "another-room@conference.example.com", name = "The Other Room" };
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 -- You can also use this compact syntax:
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 "yetanother@conference.example.com"; -- this will get "yetanother" as name
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 };
f9b80a58366f Add page for mod_default_bookmarks
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 }}}