aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2008-03-04 09:07:43 +0000
committerBadlop <badlop@process-one.net>2008-03-04 09:07:43 +0000
commita65273690d908a92f600f7ef3b3584634a9304fe (patch)
tree2f9e192e3a46ebac0098956edfe4dd53e9fa296c
parent* src/tls/tls.erl: recv_data/2 doesn't throw exceptions now (diff)
* doc/guide.tex: mod_announce recommends, but doesn't require
mod_adhoc (thanks to Anastasia Gornostaeva) * doc/guide.html: Likewise * src/ejabberd.cfg.example: Likewise SVN Revision: 1218
-rw-r--r--ChangeLog7
-rw-r--r--doc/guide.html14
-rw-r--r--doc/guide.tex19
-rw-r--r--src/ejabberd.cfg.example2
4 files changed, 31 insertions, 11 deletions
diff --git a/ChangeLog b/ChangeLog
index 5c148a19b..c984169b7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-03-04 Badlop <badlop@process-one.net>
+
+ * doc/guide.tex: mod_announce recommends, but doesn't require
+ mod_adhoc (thanks to Anastasia Gornostaeva)
+ * doc/guide.html: Likewise
+ * src/ejabberd.cfg.example: Likewise
+
2008-03-03 Alexey Shchepin <alexey@process-one.net>
* src/tls/tls.erl: recv_data/2 doesn't throw exceptions now
diff --git a/doc/guide.html b/doc/guide.html
index 64671b4d8..fc832fb1e 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -1508,7 +1508,7 @@ all entries end with a comma:
</P><P>The following table lists all modules included in <TT>ejabberd</TT>.</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP>Module</TD><TD ALIGN=left NOWRAP>Feature</TD><TD ALIGN=left NOWRAP>Dependencies</TD><TD ALIGN=left NOWRAP>Needed for XMPP?</TD></TR>
<TR><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>Ad-Hoc Commands (<A HREF="http://www.xmpp.org/extensions/xep-0050.html">XEP-0050</A>)</TD><TD ALIGN=left NOWRAP>&nbsp;</TD><TD ALIGN=left NOWRAP>No</TD></TR>
-<TR><TD ALIGN=left NOWRAP><TT>mod_announce</TT></TD><TD ALIGN=left NOWRAP>Manage announcements</TD><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>No</TD></TR>
+<TR><TD ALIGN=left NOWRAP><TT>mod_announce</TT></TD><TD ALIGN=left NOWRAP>Manage announcements</TD><TD ALIGN=left NOWRAP>recommends <TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>No</TD></TR>
<TR><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD><TD ALIGN=left NOWRAP>Request and cache Entity Capabilities (<A HREF="http://www.xmpp.org/extensions/xep-0115.html">XEP-0115</A>)</TD><TD ALIGN=left NOWRAP>&nbsp;</TD><TD ALIGN=left NOWRAP>No</TD></TR>
<TR><TD ALIGN=left NOWRAP><TT>mod_configure</TT></TD><TD ALIGN=left NOWRAP>Server configuration using Ad-Hoc</TD><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>No</TD></TR>
<TR><TD ALIGN=left NOWRAP><TT>mod_disco</TT></TD><TD ALIGN=left NOWRAP>Service Discovery (<A HREF="http://www.xmpp.org/extensions/xep-0030.html">XEP-0030</A>)</TD><TD ALIGN=left NOWRAP>&nbsp;</TD><TD ALIGN=left NOWRAP>No</TD></TR>
@@ -1623,11 +1623,13 @@ the "@HOST@" keyword must be used:
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc36">3.3.3</A>&#XA0;&#XA0;<TT>mod_announce</TT></H3><!--SEC END --><P>
<A NAME="modannounce"></A>
</P><P>This module enables configured users to broadcast announcements and to set
-the message of the day (MOTD). Configured users can do these actions with their
-Jabber client using Ad-hoc commands or by sending messages to specific JIDs. These JIDs are listed in
-next paragraph. The first JID in each entry will apply only to the virtual host
+the message of the day (MOTD). </P><P>Configured users can perform these actions with a
+Jabber client either using Ad-hoc commands
+or sending messages to specific JIDs.</P><P>The Ad-hoc commands are listed in the Server Discovery.
+For this feature to work, <TT>mod_adhoc</TT>must be enabled.</P><P>The specific JIDs where messages can be sent are listed listed now.
+The first JID in each entry will apply only to the specified virtual host
<TT>example.org</TT>, while the JID between brackets will apply to all virtual
-hosts:
+hosts in ejabberd:
</P><DL CLASS="description"><DT CLASS="dt-description">
<B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B></DT><DD CLASS="dd-description"> The
message is sent to all registered users. If the user is online and connected
@@ -1660,6 +1662,7 @@ Only administrators can send announcements:
{modules,
[
...
+ {mod_adhoc, []},
{mod_announce, [{access, announce}]},
...
]}.
@@ -1674,6 +1677,7 @@ Only administrators can send announcements:
{modules,
[
...
+ {mod_adhoc, []},
{mod_announce, [{access, announce}]},
...
]}.
diff --git a/doc/guide.tex b/doc/guide.tex
index 293ed81ac..cfc0eeef8 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -1897,7 +1897,7 @@ The following table lists all modules included in \ejabberd{}.
\begin{tabular}{|l|l|l|l|}
\hline Module & Feature & Dependencies & Needed for XMPP? \\
\hline \hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) & & No \\
- \hline \modannounce{} & Manage announcements & \modadhoc{} & No \\
+ \hline \modannounce{} & Manage announcements & recommends \modadhoc{} & No \\
\hline \modcaps{} & Request and cache Entity Capabilities (\xepref{0115}) & & No \\
\hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} & No \\
\hline \moddisco{} & Service Discovery (\xepref{0030}) & & No \\
@@ -2045,11 +2045,18 @@ the "@HOST@" keyword must be used:
\ind{modules!\modannounce{}}\ind{MOTD}\ind{message of the day}\ind{announcements}
This module enables configured users to broadcast announcements and to set
-the message of the day (MOTD). Configured users can do these actions with their
-\Jabber{} client using Ad-hoc commands or by sending messages to specific JIDs. These JIDs are listed in
-next paragraph. The first JID in each entry will apply only to the virtual host
+the message of the day (MOTD).
+Configured users can perform these actions with a
+\Jabber{} client either using Ad-hoc commands
+or sending messages to specific JIDs.
+
+The Ad-hoc commands are listed in the Server Discovery.
+For this feature to work, \modadhoc{} must be enabled.
+
+The specific JIDs where messages can be sent are listed bellow.
+The first JID in each entry will apply only to the specified virtual host
\jid{example.org}, while the JID between brackets will apply to all virtual
-hosts:
+hosts in ejabberd.
\begin{description}
\titem{example.org/announce/all (example.org/announce/all-hosts/all)} The
message is sent to all registered users. If the user is online and connected
@@ -2087,6 +2094,7 @@ Examples:
{modules,
[
...
+ {mod_adhoc, []},
{mod_announce, [{access, announce}]},
...
]}.
@@ -2103,6 +2111,7 @@ Examples:
{modules,
[
...
+ {mod_adhoc, []},
{mod_announce, [{access, announce}]},
...
]}.
diff --git a/src/ejabberd.cfg.example b/src/ejabberd.cfg.example
index faa8f78fa..fd04c163b 100644
--- a/src/ejabberd.cfg.example
+++ b/src/ejabberd.cfg.example
@@ -400,7 +400,7 @@
{modules,
[
{mod_adhoc, []},
- {mod_announce, [{access, announce}]}, % requires mod_adhoc
+ {mod_announce, [{access, announce}]}, % recommends mod_adhoc
{mod_caps, []},
{mod_configure,[]}, % requires mod_adhoc
{mod_disco, []},