* 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

diff --git a/ChangeLog b/ChangeLog
index ac23630cf901b87144b620386eab3c0cdd80a7f5..2a5884256eb2d57e57d24485179c4197aa540e53 100644 (file)
--- 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-02-29  Alexey Shchepin  <alexey@process-one.net>
 
        * src/mod_roster.erl: Fixed "from" attribute in roster pushes

diff --git a/doc/guide.html b/doc/guide.html
index bd17372c626871dfb60151df285d8152602a4918..0fcc8377937b99ca60e24e9a1877ae07dc929112 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -1510,7 +1510,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>
@@ -1625,11 +1625,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
@@ -1662,6 +1664,7 @@ Only administrators can send announcements:
   {modules,
    [
     ...
+    {mod_adhoc, []},
     {mod_announce, [{access, announce}]},
     ...
    ]}.
@@ -1676,6 +1679,7 @@ Only administrators can send announcements:
   {modules,
    [
     ...
+    {mod_adhoc, []},
     {mod_announce, [{access, announce}]},
     ...
    ]}.

diff --git a/doc/guide.tex b/doc/guide.tex
index 293ed81ac248cec3f080630ea2edfaec73a8f36f..cfc0eeef8fb2d612e9df5702aa48e0bec33e19b6 100644 (file)
--- 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 faa8f78fa7d9174cfa92a2ca5abe68eb9220d1bc..fd04c163be4702fb97b9398565806e8263a490dc 100644 (file)
--- 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,    []},