Module: sip-router Branch: master Commit: c6228c19dec179abe2e143a9f162631e5748cf7c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c6228c1… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Mon Oct 4 14:08:05 2010 +0200 presence_conference: added docbook files - skeleton for module documentation --- modules_k/presence_conference/README | 105 ++++++++++++++++++- modules_k/presence_conference/doc/Makefile | 2 +- .../doc/presence_conference.xml | 34 ++++++ .../doc/presence_conference_admin.xml | 110 ++++++++++++++++++++ 4 files changed, 249 insertions(+), 2 deletions(-) diff --git a/modules_k/presence_conference/README b/modules_k/presence_conference/README index c86fdfc..f56b5eb 100644 --- a/modules_k/presence_conference/README +++ b/modules_k/presence_conference/README @@ -1,3 +1,106 @@ presence_conference Module -Bucur Marius \ No newline at end of file +Marius-Ovidiu Bucur + +Edited by + +Marius-Ovidiu Bucur + + Copyright © 2010 Marius-Ovidiu Bucur + __________________________________________________________________ + + Table of Contents + + 1. Admin Guide + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Exported Parameters + + 3.1. use_partial_states (int) + + 4. Exported MI Functions + + 4.1. conference_reset + + List of Examples + + 1.1. Set use_partial_states parameter + +Chapter 1. Admin Guide + + Table of Contents + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Exported Parameters + + 3.1. use_partial_states (int) + + 4. Exported MI Functions + + 4.1. conference_reset + +1. Overview + + This module is a mixer for presence notifications published by an audio + conference mixer as per RFC 4353: A Framework for Conferencing with SIP + and RFC 4575: A SIP Event Package for Conference State. In other words + it is presence handling of conference events - conference-info+xml + documents. + +2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + +2.1. Kamailio Modules + + The following modules must be loaded before this module: + * presence. + +2.2. External Libraries or Applications + + The following libraries or applications must be installed before + running Kamailio with this module loaded: + * libxml2 - xml handling library. + +3. Exported Parameters + + 3.1. use_partial_states (int) + +3.1. use_partial_states (int) + + Control usage of partial state notifiations. + + Default value is “0”. + + Example 1.1. Set use_partial_states parameter +... +modparam("presence_conference", "use_partial_states", 0) +... + +4. Exported MI Functions + + 4.1. conference_reset + +4.1. conference_reset + + Reset internal data. + + Name: conference_reset + + Parameters: + * none + + MI FIFO Command Format: + :conference_reset:_reply_fifo_file_ + _empty_line_ diff --git a/modules_k/presence_conference/doc/Makefile b/modules_k/presence_conference/doc/Makefile index 0298c61..2f4f7f4 100644 --- a/modules_k/presence_conference/doc/Makefile +++ b/modules_k/presence_conference/doc/Makefile @@ -1,4 +1,4 @@ -docs = presence_xml.xml +docs = presence_conference.xml docbook_dir = ../../../docbook include $(docbook_dir)/Makefile.module diff --git a/modules_k/presence_conference/doc/presence_conference.xml b/modules_k/presence_conference/doc/presence_conference.xml new file mode 100644 index 0000000..83f2ae2 --- /dev/null +++ b/modules_k/presence_conference/doc/presence_conference.xml @@ -0,0 +1,34 @@ +<?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" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <bookinfo> + <title>presence_conference Module</title> + <productname class="trade">&kamailioname;</productname> + <authorgroup> + <author> + <firstname>Marius-Ovidiu</firstname> + <surname>Bucur</surname> + </author> + <editor> + <firstname>Marius-Ovidiu</firstname> + <surname>Bucur</surname> + </editor> + </authorgroup> + <copyright> + <year>2010</year> + <holder>Marius-Ovidiu Bucur</holder> + </copyright> + </bookinfo> + <toc></toc> + + <xi:include href="presence_conference_admin.xml"/> + +</book> diff --git a/modules_k/presence_conference/doc/presence_conference_admin.xml b/modules_k/presence_conference/doc/presence_conference_admin.xml new file mode 100644 index 0000000..6d771ca --- /dev/null +++ b/modules_k/presence_conference/doc/presence_conference_admin.xml @@ -0,0 +1,110 @@ +<?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" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> + +<!-- Module User's Guide --> + +<chapter> + + <title>&adminguide;</title> + + <section> + <title>Overview</title> + <para> + This module is a mixer for presence notifications published by + an audio conference mixer as per RFC 4353: A Framework for + Conferencing with SIP and RFC 4575: A SIP Event Package for + Conference State. In other words it is presence handling of + conference events - conference-info+xml documents. + </para> + </section> + <section> + <title>Dependencies</title> + <section> + <title>&kamailio; Modules</title> + <para> + The following modules must be loaded before this module: + <itemizedlist> + <listitem> + <para> + <emphasis>presence</emphasis>. + </para> + </listitem> + </itemizedlist> + </para> + </section> + <section> + <title>External Libraries or Applications</title> + <para> + The following libraries or applications must be installed before running + &kamailio; with this module loaded: + <itemizedlist> + <listitem> + <para> + <emphasis>libxml2</emphasis> - xml handling library. + </para> + </listitem> + </itemizedlist> + </para> + </section> + </section> + <section> + <title>Exported Parameters</title> + <section> + <title><varname>use_partial_states</varname> (int)</title> + <para> + Control usage of partial state notifiations. + </para> + <para> + <emphasis> + Default value is <quote>0</quote>. + </emphasis> + </para> + <example> + <title>Set <varname>use_partial_states</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("presence_conference", "use_partial_states", 0) +... +</programlisting> + </example> + </section> + + </section> + + <section> + <title>Exported MI Functions</title> + + <section> + <title> + <function moreinfo="none">conference_reset</function> + </title> + <para> + Reset internal data. + </para> + <para> + Name: <emphasis>conference_reset</emphasis> + </para> + <para>Parameters:</para> + <itemizedlist> + <listitem><para>none</para></listitem> + </itemizedlist> + <para> + MI FIFO Command Format: + </para> + <programlisting format="linespecific"> + :conference_reset:_reply_fifo_file_ + _empty_line_ + </programlisting> + </section> + + </section> + +</chapter> +