diff options
| author | Mickaël Rémond <mickael.remond@process-one.net> | 2006-09-05 15:53:54 +0000 |
|---|---|---|
| committer | Mickaël Rémond <mickael.remond@process-one.net> | 2006-09-05 15:53:54 +0000 |
| commit | d97eaa26d553822c3a4148c224c618418d58ad54 (patch) | |
| tree | 7404fd7e69a0eb228ad24e764bb7943993df269f /doc/guide.html | |
| parent | * src/ejabberd_socket.erl: All XML socket operations moved here (diff) | |
* src/mod_muc/mod_muc.erl: It is now possible to configure the
MUC room history feature. A new option has been added in ejabberd muc
module configuration (history_size) to define the size of the history.
0 is used to disable the feature.
* src/mod_muc/mod_muc_room.erl: Likewise.
* doc/guide.tex: Likewise.
SVN Revision: 601
Diffstat (limited to 'doc/guide.html')
| -rw-r--r-- | doc/guide.html | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/guide.html b/doc/guide.html index 554201a54..5c9558f34 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1980,7 +1980,14 @@ Options: value is <TT>none</TT>, which means that only the room creator can administer his room). By sending a message to the service JID, administrators can send service messages that will be displayed in every - active room. + active room.<BR> +<BR> +<DT CLASS="dt-description"><B><TT>history_size</TT></B><DD CLASS="dd-description"> a small history of the + current discussion is send to users when they enter the room. This option make + it possible to define the number of history messages to keep and send to the + user joining the room. The value is a integer. Setting the value to <TT>0</TT> + disable the history feature and nothing is kept in memory. The default value + is <TT>20</TT>. This value is global and affects all MUC rooms on the server. </DL> Examples: <UL CLASS="itemize"><LI CLASS="li-itemize"> @@ -1991,7 +1998,8 @@ In the first example everyone is allowed to use the Multi-User Chat sends a message such as “Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns around 23:00 UMT. We apologise for this inconvenience.” to <TT>conference.example.org</TT>, - it will be displayed in all active rooms. + it will be displayed in all active rooms. In this example the history + feature is disabled. <PRE CLASS="verbatim"> {acl, admins, {user, "admin", "example.org"}}. ... @@ -2002,7 +2010,8 @@ In the first example everyone is allowed to use the Multi-User Chat ... {mod_muc, [{access, all}, {access_create, all}, - {access_admin, muc_admins}]}, + {access_admin, muc_admins}, + {history_size, 0}]}, ... ]}. </PRE><LI CLASS="li-itemize">In the second example the Multi-User Chat service is only accessible by @@ -2012,7 +2021,9 @@ In the first example everyone is allowed to use the Multi-User Chat <TT>admin@example.org</TT> sends a message such as “Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns around 23:00 UMT. We apologise for this inconvenience.” to - <TT>conference.example.org</TT>, it will be displayed in all active rooms. + <TT>conference.example.org</TT>, it will be displayed in all active rooms. No + <TT>history_size</TT> option is used, this means that the feature is enabled + and the default value of 20 history messages will be send to the users. <PRE CLASS="verbatim"> {acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. |