- modules documentation migrated from sgml to xml docbook format

- many thanks to Edson <4lists (at) gmail (dot) com> for providing script to replace headers and rename files - contact updated - follows re-sync with todays changes and update of Makefile to generate README and html files from XML git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3886 689a6050-402a-0410-94f2-e92a70836424
2600hz-archive · Mar 7, 2008 · d77df08 · d77df08
1 parent 6baa764
commit d77df08
Show file tree

Hide file tree

Showing 274 changed files with 6,945 additions and 7,274 deletions.
diff --git a/modules_k/acc/README b/modules_k/acc/README
diff --git a/modules_k/acc/doc/acc.sgml → modules_k/acc/doc/acc.xml b/modules_k/acc/doc/acc.sgml → modules_k/acc/doc/acc.xml
@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?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 user SYSTEM "acc_user.sgml">
-<!ENTITY faq SYSTEM "acc_faq.sgml">
+<!ENTITY user SYSTEM "acc_admin.xml">
+<!ENTITY faq SYSTEM "acc_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -51,8 +53,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

diff --git a/modules_k/acc/doc/acc_user.sgml → modules_k/acc/doc/acc_admin.xml b/modules_k/acc/doc/acc_user.sgml → modules_k/acc/doc/acc_admin.xml
@@ -15,7 +15,7 @@
 	<para>
 		To account a transaction and to choose which set of backends to be 
 		used, the script writer just has to set some flags (see the module
-		parameters section for flag definitions <xref linkend="ACC-param-id">).
+		parameters section for flag definitions <xref linkend="ACC-param-id"/>).
 		If the accouting flag for a specific backend is set, the acc module 
 		will then report on completed transaction. A typical usage of the 
 		module takes no acc-specific script command -- the functionality 
@@ -28,7 +28,7 @@
 		The accouting module will log by default a fixed set of attributes 
 		for the transaction - if you customize you accouting by adding more
 		information to be logged, please see the next chapter about extra
-		accouting - <xref linkend="ACC-extra-id">.
+		accouting - <xref linkend="ACC-extra-id"/>.
 	</para>
 	<para>
 		The fixed minimal accouting information is: 
@@ -136,7 +136,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
         exit;
     }
 
-    if (method=="INVITE" & !check_from()) {
+    if (method=="INVITE" &amp;&amp; !check_from()) {
         log("from!=digest\n");
         sl_send_reply("403","Forbidden");
     }
@@ -163,7 +163,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 			<title>Definitions and syntax</title>
 			<para>
 			Selection of extra information is done via 
-			<emphasis>xxx_extra<emphasis> parameters by specifying the names
+			<emphasis>xxx_extra</emphasis> parameters by specifying the names
 			of additional information you want to log. This information is 
 			defined via pseudo-variables and may include headers or AVPs values
 			or other message or system values. The syntax of the parameter is:
@@ -193,14 +193,14 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 				</para></listitem>
 				<listitem><para><emphasis>DB accounting</emphasis> - log_name 
 				will be the name of the DB column where the data will be 
-				stored.<emphasis>IMPORTANT<emphasis>: add in db 
+				stored.<emphasis>IMPORTANT</emphasis>: add in db 
 				<emphasis>acc</emphasis> table the columns corresponding to 
 				each extra data;
 				</para></listitem>
 				<listitem><para><emphasis>RADIUS accounting</emphasis> - 
 				log_name will be the AVP name used for packing the data into 
 				RADIUS message. The log_name will be translated to AVP number 
-				via the dictionary. <emphasis>IMPORTANT<emphasis>: add in 
+				via the dictionary. <emphasis>IMPORTANT</emphasis>: add in 
 				RADIUS dictionary the <emphasis>log_name</emphasis> attribute.
 				</para></listitem>
 				<listitem><para><emphasis>DIAMETER accounting</emphasis> - 
@@ -335,6 +335,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 			<para>
 			The following libraries or applications must be installed 
 			before running &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>radiusclient-ng</emphasis> 0.5.0 or higher -- 
@@ -442,7 +443,7 @@ modparam("acc", "detect_direction", 1)
 		<title><varname>multi_leg_info</varname> (string)</title>
 		<para>
 		Defines the AVP set to be used in per-call-leg accoutning.
-		See <xref linkend="multi-call-legs"> for a 
+		See <xref linkend="multi-call-legs"/> for a 
 		detailed description of the Multi Call-Legs accounting.
 		</para>
 		<para>

diff --git a/modules_k/acc/doc/acc_faq.sgml → modules_k/acc/doc/acc_faq.xml b/modules_k/acc/doc/acc_faq.sgml → modules_k/acc/doc/acc_faq.xml
@@ -34,7 +34,8 @@
 
 	<qandaentry>
 		<question>
-		<para>What happend with old src_leg_avp_id & dst_leg_avp_id parameters</para>
+			<para>What happend with old src_leg_avp_id and dst_leg_avp_id
+				parameters</para>
 		</question>
 		<answer>
 		<para>

diff --git a/modules_k/alias_db/README b/modules_k/alias_db/README
@@ -2,16 +2,18 @@ ALIAS_DB Module
 
 Daniel-Constantin Mierla
 
-   voice-system.ro
-
 Edited by
 
 Daniel-Constantin Mierla
 
    Copyright � 2005 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -34,16 +36,18 @@ Daniel-Constantin Mierla
 
               1.4.1. alias_db_lookup(table_name)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set db_url parameter
-   1-2. Set user_column parameter
-   1-3. Set domain_column parameter
-   1-4. Set alias_user_column parameter
-   1-5. Set alias_domain_column parameter
-   1-6. Set use_domain parameter
-   1-7. Set domain_prefix parameter
-   1-8. alias_db_lookup() usage
-     __________________________________________________________
+
+   1.1. Set db_url parameter
+   1.2. Set user_column parameter
+   1.3. Set domain_column parameter
+   1.4. Set alias_user_column parameter
+   1.5. Set alias_domain_column parameter
+   1.6. Set use_domain parameter
+   1.7. Set domain_prefix parameter
+   1.8. alias_db_lookup() usage
 
 Chapter 1. User's Guide
 
@@ -58,24 +62,19 @@ Chapter 1. User's Guide
    the provisioning is easier. With very fast databases like MySQL
    the speed penalty can be lowered. Also, the search can be
    performed on different tables in the same script.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * database module (mysql, dbtext, ...).
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -85,59 +84,54 @@ Chapter 1. User's Guide
 
    Default value is "DEFAULT_RODB_URL".
 
-   Example 1-1. Set db_url parameter
+   Example 1.1. Set db_url parameter
 ...
 modparam("alias_db", "db_url", "mysql://user:passwd@localhost/openser")
 ...
-     __________________________________________________________
 
 1.3.2. user_column (str)
 
    Name of the column storing username.
 
    Default value is "username".
 
-   Example 1-2. Set user_column parameter
+   Example 1.2. Set user_column parameter
 ...
 modparam("alias_db", "user_column", "susername")
 ...
-     __________________________________________________________
 
 1.3.3. domain_column (str)
 
    Name of the column storing user's domain.
 
    Default value is "domain".
 
-   Example 1-3. Set domain_column parameter
+   Example 1.3. Set domain_column parameter
 ...
 modparam("alias_db", "domain_column", "sdomain")
 ...
-     __________________________________________________________
 
 1.3.4. alias_user_column (str)
 
    Name of the column storing alias username.
 
    Default value is "alias_username".
 
-   Example 1-4. Set alias_user_column parameter
+   Example 1.4. Set alias_user_column parameter
 ...
 modparam("alias_db", "alias_user_column", "auser")
 ...
-     __________________________________________________________
 
 1.3.5. alias_domain_column (str)
 
    Name of the column storing alias domain.
 
    Default value is "alias_domain".
 
-   Example 1-5. Set alias_domain_column parameter
+   Example 1.5. Set alias_domain_column parameter
 ...
 modparam("alias_db", "alias_domain_column", "adomain")
 ...
-     __________________________________________________________
 
 1.3.6. use_domain (int)
 
@@ -147,11 +141,10 @@ modparam("alias_db", "alias_domain_column", "adomain")
 
    Default value is "o".
 
-   Example 1-6. Set use_domain parameter
+   Example 1.6. Set use_domain parameter
 ...
 modparam("alias_db", "use_domain", 1)
 ...
-     __________________________________________________________
 
 1.3.7. domain_prefix (str)
 
@@ -160,15 +153,14 @@ modparam("alias_db", "use_domain", 1)
 
    Default value is "NULL".
 
-   Example 1-7. Set domain_prefix parameter
+   Example 1.7. Set domain_prefix parameter
 ...
 modparam("alias_db", "domain_prefix", "sip.")
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. alias_db_lookup(table_name)
+1.4.1.  alias_db_lookup(table_name)
 
    The function takes the R-URI and search to see whether it is an
    alias or not. If it is an alias for a local user, the R-URI is
@@ -178,13 +170,45 @@ modparam("alias_db", "domain_prefix", "sip.")
    by user's SIP uri.
 
    Meaning of the parameters is as follows:
-
      * table_name - the name of the table where to search for
        alias.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-8. alias_db_lookup() usage
+   Example 1.8. alias_db_lookup() usage
 ...
 alias_db_lookup("dbaliases");
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       Where can I post a question about this module?
+
+       First at all check if your question was already answered on one
+       of our mailing lists:
+         * User Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER release should be sent to
+       <users@openser.org> and e-mails regarding development versions
+       should be sent to <devel@openser.org>.
+
+       If you want to keep the mail private, send it to
+       <team@openser.org>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.
diff --git a/modules_k/alias_db/doc/alias_db.sgml → modules_k/alias_db/doc/alias_db.xml b/modules_k/alias_db/doc/alias_db.sgml → modules_k/alias_db/doc/alias_db.xml
@@ -1,14 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?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 user SYSTEM "alias_db_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "alias_db_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!ENTITY aliasdbsql SYSTEM "alias_db.sql">
 
-<!ENTITY developeremail "daniel@voice-system.ro">
-
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -21,16 +21,15 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
 		<address>
-		<email>&developeremail;</email>
+		<email>miconda@gmail.com</email>
 		</address>
 	    </author>
 	    <editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
 		<address>
-		<email>&developeremail;</email>
+		<email>miconda@gmail.com</email>
 		</address>
 	    </editor>
 	</authorgroup>
@@ -40,8 +39,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

diff --git a/modules_k/alias_db/doc/alias_db_user.sgml → modules_k/alias_db/doc/alias_db_admin.xml b/modules_k/alias_db/doc/alias_db_user.sgml → modules_k/alias_db/doc/alias_db_admin.xml