[added documentation for presence_xcapdiff
Denis Bilenko <denis@ag-projects.com>**20080813130157] {
addfile ./openser/presence_xcapdiff/README
hunk ./openser/presence_xcapdiff/README 1
+Presence_XCAPDiff Module
+
+Denis Bilenko
+
+   <denis@ag-projects.com>
+
+Edited by
+
+Denis Bilenko
+
+   <denis@ag-projects.com>
+
+   Copyright © 2008 AG Projects
+   Revision History
+   Revision $Revision$ $Date$
+     __________________________________________________________
+
+   Table of Contents
+
+   1. Admin Guide
+
+        1.1. Overview
+        1.2. Dependencies
+
+              1.2.1. OpenSIPS Modules
+              1.2.2. External Libraries or Applications
+
+        1.3. Exported parameters
+
+              1.3.1. enable_presence (int)
+              1.3.2. enable_pua (int)
+
+   List of Examples
+
+   1.1. Disabling presence
+   1.2. Disabling pua
+
+Chapter 1. Admin Guide
+
+1.1. Overview
+
+   presence_xcapdiff is an OpenSIPS module that adds support for
+   "xcap-diff" event to presence and pua. At the moment, the
+   module just registers the event but doesn't do any
+   event-specific processing. Registering event with pua allows
+   OpenXCAP server to publish xcap-event when modification of a
+   document happenes. Registering event with presence allow
+   clients to subscribe for the event.
+
+1.2. Dependencies
+
+1.2.1. OpenSIPS Modules
+
+   The following modules must be loaded before this module:
+     * presence module - if enable_presence is non-zero (see below
+       the description of enable_presence).
+     * pua module - if enable_pua is non-zero (see below the
+       description of enable_pua).
+     * pua_mi module - if enable_pua is non-zero and you intent to
+       use this module with OpenXCAP.
+
+1.2.2. External Libraries or Applications
+
+   The following libraries or applications must be installed
+   before running OpenSIPS with this module loaded:
+     * None.
+
+1.3. Exported parameters
+
+1.3.1. enable_presence (int)
+
+   Boolean flag that specifies if "xcap-diff" event should be
+   registered with presence.
+
+   Default value is "1".
+
+   Example 1.1. Disabling presence
+...
+modparam("presence_xcapdiff", "enable_presence", 0)
+...
+
+1.3.2. enable_pua (int)
+
+   Boolean flag that specifies if "xcap-diff" event should be
+   registered with pua.
+
+   Default value is "1".
+
+   Example 1.2. Disabling pua
+...
+modparam("presence_xcapdiff", "enable_pua", 0)
+...
adddir ./openser/presence_xcapdiff/doc
addfile ./openser/presence_xcapdiff/doc/presence_xcapdiff.xml
hunk ./openser/presence_xcapdiff/doc/presence_xcapdiff.xml 1
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!ENTITY admin SYSTEM "presence_xcapdiff_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
+%docentities;
+
+]>
+
+<book>
+  <bookinfo>
+  <title>Presence_XCAPDiff Module</title>
+  <authorgroup>
+    <author>
+    <firstname>Denis</firstname>
+    <surname>Bilenko</surname>
+    <email>denis@ag-projects.com</email>
+    </author>
+    <editor>
+    <firstname>Denis</firstname>
+    <surname>Bilenko</surname>
+    <email>denis@ag-projects.com</email>
+    </editor>
+  </authorgroup>
+  <copyright>
+    <year>2008</year>
+    <holder>AG Projects</holder>
+  </copyright>
+  <revhistory>
+    <revision>
+    <revnumber>$Revision$</revnumber>
+    <date>$Date$</date>
+    </revision>
+  </revhistory>
+  </bookinfo>
+  <toc></toc>
+
+  &admin;
+  &faq;
+
+</book>
addfile ./openser/presence_xcapdiff/doc/presence_xcapdiff_admin.xml
hunk ./openser/presence_xcapdiff/doc/presence_xcapdiff_admin.xml 1
+<!-- Module User's Guide -->
+
+<chapter>
+  
+  <title>&adminguide;</title>
+  
+  <section>
+  <title>Overview</title>
+    <para>
+      presence_xcapdiff is an &osips; module that adds support for
+      "xcap-diff" event to presence and pua. At the moment, the module
+      just registers the event but doesn't do any event-specific processing.
+
+      Registering event with pua allows OpenXCAP server to publish xcap-event
+      when modification of a document happenes.
+      Registering event with presence allow clients to subscribe for the event.
+    </para>
+  </section>
+  
+  <section>
+  <title>Dependencies</title>
+    <section>
+    <title>&osips; Modules</title>
+      <para>
+        The following modules must be loaded before this module:
+        <itemizedlist>
+          <listitem>
+            <para>
+              <emphasis>presence</emphasis> module - if enable_presence is non-zero
+              (see below the description of enable_presence).
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <emphasis>pua</emphasis> module - if enable_pua is non-zero
+              (see below the description of enable_pua).
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <emphasis>pua_mi</emphasis> module - if enable_pua is non-zero and 
+              you intent to use this module with OpenXCAP.
+            </para>
+          </listitem>
+        </itemizedlist>
+      </para>
+    </section>
+
+    <section>
+    <title>External Libraries or Applications</title>
+      <para>
+        The following libraries or applications must be installed before
+        running &osips; with this module loaded:
+        <itemizedlist>
+          <listitem>
+            <para>
+              <emphasis>None</emphasis>.
+            </para>
+          </listitem>
+        </itemizedlist>
+      </para>
+    </section>
+  </section>
+  
+  <section>
+  <title>Exported parameters</title>
+    <section>
+    <title><varname>enable_presence</varname> (int)</title>
+      <para>
+        Boolean flag that specifies if "xcap-diff" event should be registered with presence.
+      </para>
+
+      <para>
+        <emphasis>
+          Default value is <quote>1</quote>.
+        </emphasis>
+      </para>
+
+      <example>
+      <title>Disabling presence</title>
+        <programlisting format="linespecific">
+...
+modparam("presence_xcapdiff", "enable_presence", 0)
+...
+        </programlisting>
+      </example>
+    </section>
+
+    <section>
+    <title><varname>enable_pua</varname> (int)</title>
+      <para>
+        Boolean flag that specifies if "xcap-diff" event should be registered with pua.
+      </para>
+
+      <para>
+        <emphasis>
+          Default value is <quote>1</quote>.
+        </emphasis>
+      </para>
+
+      <example>
+      <title>Disabling pua</title>
+        <programlisting format="linespecific">
+...
+modparam("presence_xcapdiff", "enable_pua", 0)
+...
+        </programlisting>
+      </example>
+    </section>
+
+
+  </section>
+
+</chapter>
+
}