* doc/guide.tex: Add mod_caps and improve mod_pubsub documentation

* src/ejabberd.cfg.example: Added mod_caps enabled by default

SVN Revision: 1032

diff --git a/ChangeLog b/ChangeLog
index 59f46ab48a08c5c373789904663740f3aa7a843b..e8a92e1e0dd86f83eb0b7018518e1fdb588621ad 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-12-06  Badlop  <badlop@process-one.net>
+
+       * doc/guide.tex: Add mod_caps and improve mod_pubsub documentation
+       * src/ejabberd.cfg.example: Added mod_caps enabled by default
+
 2007-12-06  Christophe Romain <christophe.romain@process-one.net>
 
        * src/mod_pubsub/node_dispatch.erl: Correct syntax issue

diff --git a/doc/guide.tex b/doc/guide.tex
index c24326a78e90f6d4fecebb344006d52d0b89acb2..1ce9f332542bc5eeb696e3f1cfcb0aefed6f0766 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -59,6 +59,7 @@
 \newcommand{\module}[1]{\texttt{#1}}
 \newcommand{\modadhoc}{\module{mod\_adhoc}}
 \newcommand{\modannounce}{\module{mod\_announce}}
+\newcommand{\modcaps}{\module{mod\_caps}}
 \newcommand{\modconfigure}{\module{mod\_configure}}
 \newcommand{\moddisco}{\module{mod\_disco}}
 \newcommand{\modecho}{\module{mod\_echo}}
@@ -1775,6 +1776,7 @@ The following table lists all modules included in \ejabberd{}.
     \hline Module & Feature & Dependencies & Needed for XMPP? \\ 
     \hline \hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) &  & No \\ 
     \hline \modannounce{} & Manage announcements & \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 \\ 
     \hline \modecho{} & Echoes Jabber packets &  & No \\ 
@@ -1789,7 +1791,7 @@ The following table lists all modules included in \ejabberd{}.
     \hline \modprivate{} & Private XML Storage (\xepref{0049}) &  & No \\ 
     \hline \modprivateodbc{} & Private XML Storage (\xepref{0049}) & supported database (*) & No \\ 
     \hline \modproxy{} & SOCKS5 Bytestreams (\xepref{0065}) &  & No\\
-    \hline \modpubsub{} & Publish-Subscribe (\xepref{0060}) &  & No \\ 
+    \hline \modpubsub{} & Publish-Subscribe (\xepref{0060}) and PEP (\xepref{0163}) & \modcaps{} & No \\ 
     \hline \modregister{} & In-Band Registration (\xepref{0077}) &  & No \\ 
     \hline \modroster{} & Roster management &  & Yes (**) \\ 
     \hline \modrosterodbc{} & Roster management & supported database (*) & Yes (**) \\ 
@@ -2622,34 +2624,13 @@ Examples:
 \ind{modules!\modpubsub{}}\ind{protocols!XEP-0060: Publish-Subscribe}
 
 This module offers a Publish-Subscribe Service (\xepref{0060}).
-Publish-Subscribe can be used to develop (examples are taken from the XEP):
-\begin{quote}
-\begin{itemize}
-\item news feeds and content syndication,
-\item avatar management,
-\item shared bookmarks,
-\item auction and trading systems,
-\item online catalogs,
-\item workflow systems,
-\item network management systems,
-\item NNTP gateways,
-\item vCard/profile management,
-\item and weblogs.
-\end{itemize}
-\end{quote} 
-
-\ind{J-EAI}\ind{EAI}\ind{ESB}\ind{Enterprise Application Integration}\ind{Enterprise Service Bus}
-Another example is \footahref{http://www.process-one.net/en/jeai/}{J-EAI}.
-This is an XMPP-based Enterprise Application Integration (EAI) platform (also
-known as ESB, the Enterprise Service Bus). The J-EAI project builts upon
-\ejabberd{}'s codebase and has contributed several features to \modpubsub{}.
+The functionality in \modpubsub{} can be extended using plugins.
+The plugin that implements PEP (Personal Eventing via Pubsub) (\xepref{0163})
+is enabled by default, and requires \modcaps{}.
 
 Options:
 \begin{description}
 \hostitem{pubsub}
-\titem{served\_hosts} \ind{options!served\_hosts}To specify which hosts needs to
-  be served, you can use this option. If absent, only the main \ejabberd{}
-  host is served. % Not a straigtforward description! This needs to be improved!
 \titem{access\_createnode} \ind{options!access\_createnode}
   This option restricts which users are allowed to create pubsub nodes using
   ACL and ACCESS. The default value is \term{pubsub\_createnode}. % Not clear enough + do not use abbreviations.
@@ -2658,6 +2639,8 @@ Options:
 \titem{nodetree} To specify which nodetree to use. If not defined, the default pubsub
   nodetree is used. Nodetrees are default and virtual. Only one nodetree can be used
   and is shared by all node plugins. 
+\titem{served\_hosts} \ind{options!served\_hosts}
+  This option allows to create additional pubsub virtual hosts in a single module instance.
 \end{description}
 
 Example:
@@ -2665,10 +2648,11 @@ Example:
   {modules,
    [
     ...
-    {mod_pubsub, [{served_hosts, ["example.com",
-                                  "example.org"]},
+    {mod_pubsub, [
                   {access_createnode, pubsub_createnode},
-                  {plugins, ["default","pep"]}]}
+                  {plugins, ["default", "pep"]},
+                  {served_hosts, ["example.com", "example.org"]}
+                 ]}
     ...
    ]}.
 \end{verbatim}

diff --git a/src/ejabberd.cfg.example b/src/ejabberd.cfg.example
index b9f7d332ece190e76d547891b8d343694f41245b..032c0f154431a66b5e1f9b16f93b8e41e4464468 100644 (file)
--- a/src/ejabberd.cfg.example
+++ b/src/ejabberd.cfg.example
@@ -390,6 +390,7 @@
  [
   {mod_adhoc,    []},
   {mod_announce, [{access, announce}]}, % requires mod_adhoc
+  {mod_caps,     []}, 
   {mod_configure,[]}, % requires mod_adhoc
   {mod_disco,    []},
   %%{mod_echo,   [{host, "echo.localhost"}]},
@@ -407,7 +408,10 @@
   {mod_privacy,  []},
   {mod_private,  []},
   %%{mod_proxy65,[]},
-  {mod_pubsub,   [{access_createnode, pubsub_createnode},{plugins,["default","pep"]}]},
+  {mod_pubsub,   [ % requires mod_caps
+                 {access_createnode, pubsub_createnode},
+                 {plugins, ["default", "pep"]}
+                ]},
   {mod_register, [
                  %%
                  %% After successful registration, the user receives