From e93f2aa1e12f834a9de84382ddabd1ebe5339c52 Mon Sep 17 00:00:00 2001 From: Alexey Shchepin Date: Fri, 22 Apr 2005 16:47:16 +0000 Subject: [PATCH] * doc/guide.tex: Added mod_shared_roster documentation * src/ejabberd.hrl: Updated version SVN Revision: 326 --- ChangeLog | 8 +++ doc/guide.html | 138 ++++++++++++++++++++++++++++++++++++++++++----- doc/guide.tex | 94 +++++++++++++++++++++++++++++++- src/ejabberd.hrl | 2 +- 4 files changed, 226 insertions(+), 16 deletions(-) diff --git a/ChangeLog b/ChangeLog index 345432ebd..fc213da0c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2005-04-22 Alexey Shchepin + + * doc/guide.tex: Added mod_shared_roster documentation + + * src/ejabberd.hrl: Updated version + 2005-04-21 Alexey Shchepin * src/jd2ejd.erl: Bugfix @@ -15,6 +21,8 @@ 2005-04-18 Alexey Shchepin + * (all): ejabberd-0.9 released + * src/web/ejabberd_web_admin.erl: Added link to shared roster page * src/odbc/ejabberd_odbc.erl: ODBC connection string can be diff --git a/doc/guide.html b/doc/guide.html index 1906a6e3b..802d73d2d 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -4,7 +4,7 @@ Ejabberd Installation and Operation Guide - + @@ -101,12 +101,13 @@
  • A.13  mod_register
  • A.14  mod_roster
  • A.15  mod_service_log -
  • A.16  mod_stats -
  • A.17  mod_time -
  • A.18  mod_vcard -
  • A.19  mod_version +
  • A.16  mod_shared_roster +
  • A.17  mod_stats +
  • A.18  mod_time +
  • A.19  mod_vcard +
  • A.20  mod_version -
  • B  I18n/L10n +
  • B  I18n/L10n @@ -1007,8 +1008,8 @@ Example:

    A.5  mod_echo

    -This module acts as a service and simply returns to sender any Jabber packet. Module may be -useful for debugging.
    +This module acts as a service and simply returns to sender any Jabber +packet. Module may be useful for debugging.

    Options:
    @@ -1227,9 +1228,120 @@ Example: ... ]}. + + +

    A.16  mod_shared_roster

    + + +This module implements shared roster groups support.
    +
    +You can edit shared roster groups via web-interface. Each group has an unique +ID and the following parameters: +
    +Name
    The name of the group, which will be displayed in roster. +
    Description
    Textual description of this group, doesn't affect anything. +
    Members
    List of full JIDs of group members, entered one per line in + web-interface. +
    Displayed groups
    List of IDs of groups which will be in rosters of this + group members. +
    +For example, to have a group of users which can see each other in roster, +create a group like on table 1. +
    + + + + + + + + + + + + +
     Group `users'
    NameUsers
    Members + + + + + +
    user1@example.org
    user2@example.org
    user3@example.org
    Displayed groupsusers
    +
    +
    Table 1: Shared group example N1

    + + +
    +To have 3 groups `managers', `workgroup1', and +`workgroup2', where group `managers' can see members of all +groups, and other two groups can see `managers' group and themselves, +create groups like on table 2. +
    + + + + + + + + + + + + + + + + + + + + +
     Group `managers'Group `workgroup1'Group `workgroup2'
    NameManagersWorkgroup1Workgroup2
    Members + + + + + +
    manager1@example.org
    manager2@example.org
    manager3@example.org
    +     		+ + + + + +
    user1@example.org
    user2@example.org
    user3@example.org
    +     		+ + + + + +
    user4@example.org
    user5@example.org
    user6@example.org
    Displayed groups + + + + + +
    managers
    workgroup1
    workgroup2
    +     		+ + + +
    managers
    workgroup1
    +     		+ + + +
    managers
    workgroup2
    +
    +
    Table 2: Shared group example N2

    + + +
    -

    A.16  mod_stats

    +

    A.17  mod_stats

    This module adds support for JEP-0039 (Statistics Gathering).
    @@ -1241,7 +1353,7 @@ discipline (see A.1.1).
    -

    A.17  mod_time

    +

    A.18  mod_time

    This module answers UTC time on jabber:iq:time queries.
    @@ -1253,7 +1365,7 @@ discipline (see A.1.1). -

    A.18  mod_vcard

    +

    A.19  mod_vcard

    This module implements simple Jabber User Directory (based on user vCards) @@ -1295,7 +1407,7 @@ Example: -

    A.19  mod_version

    +

    A.20  mod_version

    This module answers ejabberd version on jabber:iq:version queries.
    @@ -1307,7 +1419,7 @@ discipline (see A.1.1). -

    B  I18n/L10n

    +

    B  I18n/L10n

    All built-in modules support xml:lang attribute inside IQ queries. diff --git a/doc/guide.tex b/doc/guide.tex index 3a0251bc2..f44570a38 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -48,6 +48,7 @@ \newcommand{\modregister}{\module{mod\_register}} \newcommand{\modroster}{\module{mod\_roster}} \newcommand{\modservicelog}{\module{mod\_service\_log}} +\newcommand{\modsharedroster}{\module{mod\_shared\_roster}} \newcommand{\modstats}{\module{mod\_stats}} \newcommand{\modtime}{\module{mod\_time}} \newcommand{\modvcard}{\module{mod\_vcard}} @@ -1014,8 +1015,8 @@ Example: \subsection{\modecho{}} \label{sec:modecho} -This module acts as a service and simply returns to sender any \Jabber{} packet. Module may be -useful for debugging. +This module acts as a service and simply returns to sender any \Jabber{} +packet. Module may be useful for debugging. Options: \begin{description} @@ -1211,6 +1212,95 @@ Example: \end{verbatim} +\subsection{\modsharedroster{}} +\label{sec:modsharedroster} + +This module implements shared roster groups support. + +You can edit shared roster groups via web-interface. Each group has an unique +ID and the following parameters: +\begin{description} +\item[Name] The name of the group, which will be displayed in roster. +\item[Description] Textual description of this group, doesn't affect anything. +\item[Members] List of full JIDs of group members, entered one per line in + web-interface. +\item[Displayed groups] List of IDs of groups which will be in rosters of this + group members. +\end{description} + +For example, to have a group of users which can see each other in roster, +create a group like on table~\ref{tab:srge1}. +\begin{table}[htbp] + \centering + \begin{tabular}{|l|l|} + & Group `\texttt{users}'\\ + Name& Users\\ + Members& + {\begin{tabular}{l} + \jid{user1@example.org}\\ + \jid{user2@example.org}\\ + \jid{user3@example.org} + \end{tabular} + }\\ + Displayed groups& \texttt{users} + \end{tabular} + \caption{Shared group example N1} + \label{tab:srge1} +\end{table} + +To have 3 groups `\texttt{managers}', `\texttt{workgroup1}', and +`\texttt{workgroup2}', where group `\texttt{managers}' can see members of all +groups, and other two groups can see `\texttt{managers}' group and themselves, +create groups like on table~\ref{tab:srge2}. +\begin{table}[htbp] + \centering + \begin{tabular}{|l|l|l|l|} + & + Group `\texttt{managers}'& + Group `\texttt{workgroup1}'& + Group `\texttt{workgroup2}'\\ + Name& Managers& Workgroup1& Workgroup2\\ + Members& + {\begin{tabular}{l} + \jid{manager1@example.org}\\ + \jid{manager2@example.org}\\ + \jid{manager3@example.org} + \end{tabular} + }& + {\begin{tabular}{l} + \jid{user1@example.org}\\ + \jid{user2@example.org}\\ + \jid{user3@example.org} + \end{tabular} + }& + {\begin{tabular}{l} + \jid{user4@example.org}\\ + \jid{user5@example.org}\\ + \jid{user6@example.org} + \end{tabular} + }\\ + Displayed groups& + {\begin{tabular}{l} + \texttt{managers}\\ + \texttt{workgroup1}\\ + \texttt{workgroup2} + \end{tabular} + }& + {\begin{tabular}{l} + \texttt{managers}\\ + \texttt{workgroup1} + \end{tabular} + }& + {\begin{tabular}{l} + \texttt{managers}\\ + \texttt{workgroup2} + \end{tabular} + } + \end{tabular} + \caption{Shared group example N2} + \label{tab:srge2} +\end{table} + \subsection{\modstats{}} \label{sec:modstats} diff --git a/src/ejabberd.hrl b/src/ejabberd.hrl index 4040b592c..cd7a4bcee 100644 --- a/src/ejabberd.hrl +++ b/src/ejabberd.hrl @@ -6,7 +6,7 @@ %%% Id : $Id$ %%%---------------------------------------------------------------------- --define(VERSION, "0.9"). +-define(VERSION, "0.9.1-alpha"). %-define(ejabberd_debug, true). %-define(DBGFSM, true).