diff --git a/doc/confacls.png b/doc/confacls.png new file mode 100644 index 000000000..8c69984f9 Binary files /dev/null and b/doc/confacls.png differ diff --git a/doc/confhostname.png b/doc/confhostname.png new file mode 100644 index 000000000..c740cb861 Binary files /dev/null and b/doc/confhostname.png differ diff --git a/doc/disco.png b/doc/disco.png new file mode 100644 index 000000000..2a4ba3b66 Binary files /dev/null and b/doc/disco.png differ diff --git a/doc/discoallusers.png b/doc/discoallusers.png new file mode 100644 index 000000000..b3d80b425 Binary files /dev/null and b/doc/discoallusers.png differ diff --git a/doc/discorunnodes.png b/doc/discorunnodes.png new file mode 100644 index 000000000..2eb4f6c3d Binary files /dev/null and b/doc/discorunnodes.png differ diff --git a/doc/discorus.png b/doc/discorus.png new file mode 100644 index 000000000..17370eac2 Binary files /dev/null and b/doc/discorus.png differ diff --git a/doc/guide.html b/doc/guide.html index 1da6a5bf5..093960a09 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -296,7 +296,7 @@ password ``secret''.
Option modules defines list of modules that will be loaded after ejabberd startup. Each list element is a tuple where first element is a name of module and second is list of options to this module. See -section 5 for detailed information on each module.
+section A for detailed information on each module.

Example:
@@ -318,8 +318,8 @@ Example:
 

3.2   Online Configuration and Monitoring

To use facility of online reconfiguration of ejabberd needed to have -mod_configure loaded (see section 5.4). Also highly -recommended to load mod_disco (see section 5.5), because +mod_configure loaded (see section A.4). Also highly +recommended to load mod_disco (see section A.5), because mod_configure highly integrates with it. Also recommended to use disco- and xdata-capable client (Tkabber @@ -336,7 +336,18 @@ On disco query ejabberd returns following items:
  • List of JIDs from route table.
  • List of disco-nodes described in following subsections. - + +

    + + + + +
    +
    +
    Figure 1: Tkabber Discovery window

    + + +

    3.2.1   Node config: Global Configuration

    Under this node exists following nodes:
    @@ -345,25 +356,31 @@ Under this node exists following nodes:
    Node config/hostname
    Via jabber:x:data queries to this node possible to change host name of -this ejabberd server. (See figure 1) (Currently will work +this ejabberd server. (See figure 2) (Currently will work correctly only after restart)

    - [hostname editing window] + + + +

    -
    Figure 1: Editing of hostname

    +
    Figure 2: Editing of hostname


    Node config/acls
    Via jabber:x:data queries to this node possible to edit ACLs list. (See -figure 2) +figure 3)

    - [acls editing window] + + + +

    -
    Figure 2: Editing of ACLs

    +
    Figure 3: Editing of ACLs


    @@ -381,16 +398,36 @@ removed user is online, then he will be disconnected. Also user-related data

    3.2.2   Node online users: List of Online Users

    - + -

    3.2.3   Node all users: List of Connected User

    - +

    3.2.3   Node all users: List of Registered User

    +

    + + + + +
    +
    +
    Figure 4: Discovery all users

    + + +

    3.2.4   Node outgoing s2s: List of Outgoing S2S connections

    3.2.5   Node running nodes: List of Running ejabberd Nodes

    - +

    + + + + +
    +
    +
    Figure 5: Discovery running nodes

    + + +

    3.2.6   Node stopped nodes: List of Stopped Nodes

    TBD
    @@ -455,19 +492,21 @@ destination. If it opened on another node, then it routed to S2S manager on that node, if it opened on this node, then it routed to process that serve this connection, and if this connection not exists, then it opened and registered.

    +
    +
    -

    5   Built-in Modules

    +

    A   Built-in Modules

    -

    5.1   Common Options

    +

    A.1   Common Options

    Following options used by many modules, so they described in separate section.

    -

    5.1.1   Option iqdisc

    +

    A.1.1   Option iqdisc

    Many modules define handlers for processing IQ queries of different namespaces to this server or to user (e. g. to myjabber.org or to user@myjabber.org). This option defines processing discipline of this @@ -497,7 +536,7 @@ queries. Possible values are: ]}.
  • -

    5.1.2   Option host

    +

    A.1.2   Option host

    Some modules may act as services, and wants to have different domain name. This option explicitly defines this name.

    @@ -510,23 +549,23 @@ Example: ]}. -

    5.2   mod_register

    +

    A.2   mod_register

    -

    5.3   mod_roster

    +

    A.3   mod_roster

    -

    5.4   mod_configure

    +

    A.4   mod_configure

    -

    5.5   mod_disco

    +

    A.5   mod_disco

    -

    5.6   mod_stats

    +

    A.6   mod_stats

    This module adds support of JEP-0039 (Statistics Gathering).
    @@ -540,19 +579,19 @@ Options:
    -

    5.7   mod_vcard

    +

    A.7   mod_vcard

    -

    5.8   mod_offline

    +

    A.8   mod_offline

    -

    5.9   mod_echo

    +

    A.9   mod_echo

    -

    5.10   mod_private

    +

    A.10   mod_private

    This module adds support of JEP-0049 (Private XML @@ -564,7 +603,7 @@ Options: iqdisc
    jabber:iq:private IQ queries processing discipline. -

    5.11   mod_time

    +

    A.11   mod_time

    This module answers UTC time on jabber:iq:time queries.

    @@ -574,7 +613,7 @@ Options: iqdisc
    jabber:iq:time IQ queries processing discipline. -

    5.12   mod_version

    +

    A.12   mod_version

    This module answers ejabberd version on jabber:iq:version queries.

    @@ -582,7 +621,31 @@ Options:
    iqdisc
    jabber:iq:version IQ queries processing discipline. -
    + + +

    B   I18n/L10n

    + +Many modules supports xml:lang attribute inside IQ queries. E. g. +on figure 6 (compare with figure 1) showed reply +on following query: +
    +<iq id='5'
    +        to='e.localhost'
    +        type='get'>
    +  <query xmlns='http://jabber.org/protocol/disco#items'
    +         xml:lang='ru'/>
    +</iq>
    +

    + + + + +
    +
    +
    Figure 6: Discovery result when xml:lang='ru'

    + + +

    diff --git a/doc/guide.tex b/doc/guide.tex index f9a3e5eb5..5cea92ba6 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -5,11 +5,14 @@ \usepackage{verbatim} -\newcommand{\imgscale}{0.7} -\newcommand{\insimg}[1]{ - \imgsrc{#1}{} +\newcommand{\logoscale}{0.7} +\newcommand{\imgscale}{0.58} +\newcommand{\insimg}[1]{\insscaleimg{\imgscale}{#1}} + +\newcommand{\insscaleimg}[2]{ + \imgsrc{#2}{} \begin{latexonly} - \scalebox{\imgscale}{\includegraphics{#1}} + \scalebox{#1}{\includegraphics{#2}} \end{latexonly} } @@ -42,7 +45,7 @@ \maketitle{} {\centering - \insimg{logo.png} + \insscaleimg{\logoscale}{logo.png} \par } \end{titlepage} @@ -381,7 +384,12 @@ On disco query \ejabberd{} returns following items: \item List of JIDs from route table. \item List of disco-nodes described in following subsections. \end{itemize} - +\begin{figure}[htbp] + \centering + \insimg{disco.png} + \caption{Tkabber Discovery window} + \label{fig:disco} +\end{figure} \subsubsection{Node \texttt{config}: Global Configuration} @@ -394,7 +402,7 @@ this \ejabberd{} server. (See figure~\ref{fig:hostname}) (Currently will work correctly only after restart) \begin{figure}[htbp] \centering - [hostname editing window] + \insimg{confhostname.png} \caption{Editing of hostname} \label{fig:hostname} \end{figure} @@ -406,7 +414,7 @@ Via \ns{jabber:x:data} queries to this node possible to edit ACLs list. (See figure~\ref{fig:acls}) \begin{figure}[htbp] \centering - [acls editing window] + \insimg{confacls.png} \caption{Editing of ACLs} \label{fig:acls} \end{figure} @@ -431,12 +439,27 @@ removed user is online, then he will be disconnected. Also user-related data -\subsubsection{Node \texttt{all users}: List of Connected User} +\subsubsection{Node \texttt{all users}: List of Registered User} + +\begin{figure}[htbp] + \centering + \insimg{discoallusers.png} + \caption{Discovery all users} + \label{fig:discoallusers} +\end{figure} + \subsubsection{Node \texttt{outgoing s2s}: List of Outgoing S2S connections} \subsubsection{Node \texttt{running nodes}: List of Running \ejabberd{} Nodes} +\begin{figure}[htbp] + \centering + \insimg{discorunnodes.png} + \caption{Discovery running nodes} + \label{fig:discorunnodes} +\end{figure} + \subsubsection{Node \texttt{stopped nodes}: List of Stopped Nodes} @@ -505,6 +528,9 @@ that node, if it opened on this node, then it routed to process that serve this connection, and if this connection not exists, then it opened and registered. + +\appendix{} + \section{Built-in Modules} \label{sec:modules} @@ -648,6 +674,27 @@ Options: +\section{I18n/L10n} +\label{sec:i18nl10n} + +Many modules supports \texttt{xml:lang} attribute inside IQ queries. E.\,g.\ +on figure~\ref{fig:discorus} (compare with figure~\ref{fig:disco}) showed reply +on following query: +\begin{verbatim} + + + +\end{verbatim} + +\begin{figure}[htbp] + \centering + \insimg{discorus.png} + \caption{Discovery result when \texttt{xml:lang='ru'}} + \label{fig:discorus} +\end{figure} \end{document}