Merge pull request #611 from ionel-cerghit/mi_xmlrpc_ng_format

mi_xmlrpc_ng: updated documentation

modules/mi_xmlrpc_ng/README

@@ -26,6 +26,7 @@ Ovidiu Sas
         1.3. Exported Parameters
 
               1.3.1. mi_xmlrpc_ng_root(string)
+              1.3.2. mi_xmlrpc_ng_format_version(integer)
 
         1.4. Exported Functions
         1.5. Known issues
@@ -34,7 +35,8 @@ Ovidiu Sas
    List of Examples
 
    1.1. Set mi_xmlrpc_ng_root parameter
-   1.2. XMLRPC request
+   1.2. Set mi_xmlrpc_ng_root parameter
+   1.3. XMLRPC request
 
 Chapter 1. Admin Guide
 
@@ -79,6 +81,22 @@ Chapter 1. Admin Guide
 modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_root", "opensips_mi_xmlrpc")
 ...
 
+1.3.2. mi_xmlrpc_ng_format_version(integer)
+
+   Specifies which formatting to be used for the output generated
+   by the module. The value of 2 will generate a response broken
+   in many tags which doesn't require string parsing, only xml
+   parsing, this is the newer version. The other accepted value is
+   1 which will generate a long simple sting response, this is the
+   older vesion.
+
+   The default value is 2.
+
+   Example 1.2. Set mi_xmlrpc_ng_root parameter
+...
+modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_format_version", 1)
+...
+
 1.4. Exported Functions
 
    No function exported to be used from configuration file.
@@ -97,7 +115,7 @@ modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_root", "opensips_mi_xmlrpc")
    This is an example showing the xmlrpc format for the
    “get_statistics net: uri:” MI commad: response.
 
-   Example 1.2. XMLRPC request
+   Example 1.3. XMLRPC request
 
 POST /xmlrpc HTTP/1.0
 Host: my.host.com

modules/mi_xmlrpc_ng/doc/mi_xmlrpc_ng_admin.xml

@@ -67,6 +67,26 @@
 ...
 modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_root", "opensips_mi_xmlrpc")
 ...
+</programlisting>
+		</example>
+	</section>
+	<section>
+	<title><varname>mi_xmlrpc_ng_format_version</varname>(integer)</title>
+	<para>
+	Specifies which formatting to be used for the output generated by the module. The 
+	value of 2 will generate a response broken in many tags which doesn't require 
+	string parsing, only xml parsing, this is the newer version. The other accepted value is 1
+	which will generate a long simple sting response, this is the older vesion.
+	</para>
+	<para>
+	<emphasis>The default value is 2.</emphasis>
+	</para>
+	<example>
+	<title>Set <varname>mi_xmlrpc_ng_root</varname> parameter</title>
+	<programlisting format="linespecific">
+...
+modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_format_version", 1)
+...
 </programlisting>
 		</example>
 	</section>