# HG changeset patch
# User MWild1
# Date 1293020285 0
# Node ID 926701c0f73e92a641438373219099cc65fbe1ba
# Parent  2888c90d945152d993cf5dd3080c1fb4c36a5647
Created wiki page through web user interface.

diff -r 2888c90d9451 -r 926701c0f73e mod_group_bookmarks.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_group_bookmarks.wiki	Wed Dec 22 12:18:05 2010 +0000
@@ -0,0 +1,48 @@
+#summary mod_groups for chatrooms
+#labels Stage-Beta
+
+= Introduction =
+
+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.
+
+In short, if you want to automatically join users to rooms when they sign in, this is the module you want.
+
+= Details =
+
+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.
+
+= Usage =
+
+Similar to mod_groups, you need to make a text file in this format:
+
+{{{
+[room@conferenceserver]
+user1@example.com=User 1
+user2@example.com=User 2
+
+[otherroom@conferenceserver]
+user3:example.net=User 3
+}}}
+
+Add "group_bookmarks" to your modules_enabled list:
+{{{
+    modules_enabled = {
+               -- ...other modules here... --
+               "group_bookmarks";
+               -- ...maybe some more here... --
+    }
+}}}
+
+= Configuration =
+||group_bookmarks_file||The path to the text file you created (as above).||
+
+= Compatibility =
+||0.8||Works||
+||0.7||Should work||
+||0.6||Should work||
+
+= Todo =
+
+  * Support for injecting into ALL users bookmarks, without needing a list
+  * Allow turning off the autojoin flag
+  * Perhaps support a friendly name for the bookmark (currently uses the room address)
\ No newline at end of file