pipelimit Add section IDs to xml documentation

modules/pipelimit/README

@@ -12,11 +12,11 @@ Edited by
 
 Daniel-Constantin Mierla
 
-   Copyright © 2013 VoIPEmbedded Inc.
+   Copyright © 2013 VoIPEmbedded Inc.
 
-   Copyright © 2010 Asipto.com
+   Copyright © 2010 Asipto.com
 
-   Copyright © 2006 Freenet Cityline GmbH
+   Copyright © 2006 Freenet Cityline GmbH
      __________________________________________________________________
 
    Table of Contents
@@ -169,7 +169,7 @@ Chapter 1. Admin Guide
 
    URL of the database server to be used.
 
-   Default value is “mysql://kamailio:kamailiorw@localhost/kamailio�.
+   Default value is "mysql://kamailio:kamailiorw@localhost/kamailio".
 
    Example 1.1. Set db_url parameter
 ...
@@ -180,7 +180,7 @@ modparam("pipelimit", "db_url", "dbdriver://username:password@dbhost/dbname")
 
    Name of DB table where data definition for pipes is stores.
 
-   Default value is “pl_pipes�.
+   Default value is "pl_pipes".
 
    Example 1.2. Set plp_table_name parameter
 ...
@@ -191,7 +191,7 @@ modparam("pipelimit", "plp_table_name", "mypipes")
 
    Name of 'pipeid' column.
 
-   Default value is “pipeid�.
+   Default value is "pipeid".
 
    Example 1.3. Set plp_pipeid_column parameter
 ...
@@ -202,7 +202,7 @@ modparam("pipelimit", "plp_pipeid_column", "name")
 
    Name of 'limit' column.
 
-   Default value is “limit�.
+   Default value is "limit".
 
    Example 1.4. Set plp_limit_column parameter
 ...
@@ -213,7 +213,7 @@ modparam("pipelimit", "plp_limit_column", "name")
 
    Name of 'algorithm' column.
 
-   Default value is “algorithm�.
+   Default value is "algorithm".
 
    Example 1.5. Set plp_algorithm_column parameter
 ...
@@ -273,7 +273,7 @@ kamcmd cfg.set_now_string pipelimit reply_reason "Limiting"
    4.1. pl_check(name)
    4.2. pl_drop([ [min ], max ])
 
-4.1.  pl_check(name)
+4.1. pl_check(name)
 
    Check the current request against the 'name' pipe. The pipe name can be
    provided via a pseudo variabile.
@@ -325,7 +325,7 @@ with unexpected retcode=$var(check_result)\n");
         }
 ...
 
-4.2.  pl_drop([ [min ], max ])
+4.2. pl_drop([ [min ], max ])
 
    For the current request, a "503 - Server Unavailable" reply is sent
    back. The reply may or may not have a "Retry-After" header. If no
@@ -360,9 +360,9 @@ with unexpected retcode=$var(check_result)\n");
    5.5. pl_get_pid
    5.6. pl_push_load
 
-5.1.  pl_stats
+5.1. pl_stats
 
-   Lists the parameters and variabiles in the pipelimit module.
+   Lists the parameters and variables in the pipelimit module.
 
    Name: pl_stats
 
@@ -372,7 +372,7 @@ with unexpected retcode=$var(check_result)\n");
                 :pl_stats:_reply_fifo_file_
                 _empty_line_
 
-5.2.  pl_set_pipe
+5.2. pl_set_pipe
 
    Sets the pipe parameters for the given pipe id.
 
@@ -390,7 +390,7 @@ with unexpected retcode=$var(check_result)\n");
                 10
                 _empty_line_
 
-5.3.  pl_get_pipes
+5.3. pl_get_pipes
 
    Gets the list of in use pipes.
 
@@ -402,7 +402,7 @@ with unexpected retcode=$var(check_result)\n");
                 :pl_get_pipes:_reply_fifo_file_
                 _empty_line_
 
-5.4.  pl_set_pid
+5.4. pl_set_pid
 
    Sets the PID Controller parameters for the Feedback Algorithm.
 
@@ -420,7 +420,7 @@ with unexpected retcode=$var(check_result)\n");
                 0.5
                 _empty_line_
 
-5.5.  pl_get_pid
+5.5. pl_get_pid
 
    Gets the list of in use PID Controller parameters.
 
@@ -432,7 +432,7 @@ with unexpected retcode=$var(check_result)\n");
                 :pl_get_pid:_reply_fifo_file_
                 _empty_line_
 
-5.6.  pl_push_load
+5.6. pl_push_load
 
    Force the value of the load parameter. This command is useful for
    testing the Feedback algorithm.
@@ -457,7 +457,7 @@ with unexpected retcode=$var(check_result)\n");
    6.5. pl.get_pid
    6.6. pl.push_load
 
-6.1.  pl.stats
+6.1. pl.stats
 
    Lists the parameters and variabiles in the pipelimit module: pipe id,
    pipe load and pipe couter.
@@ -469,7 +469,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.stats
 
-6.2.  pl.set_pipe
+6.2. pl.set_pipe
 
    Sets the pipe parameters for the given pipe id.
 
@@ -483,7 +483,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.set_pipe 2 RED 10
 
-6.3.  pl.get_pipes
+6.3. pl.get_pipes
 
    Gets the list of in use pipes.
 
@@ -494,7 +494,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.get_pipes
 
-6.4.  pl.set_pid
+6.4. pl.set_pid
 
    Sets the PID Controller parameters for the Feedback Algorithm.
 
@@ -508,7 +508,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.set_pid 0.5 0.5 0.5
 
-6.5.  pl.get_pid
+6.5. pl.get_pid
 
    Gets the list of in use PID Controller parameters.
 
@@ -519,7 +519,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.get_pid
 
-6.6.  pl.push_load
+6.6. pl.push_load
 
    Force the value of the load parameter. This command is useful for
    testing the Feedback algorithm.

modules/pipelimit/doc/pipelimit_admin.xml

@@ -65,7 +65,7 @@
 	</section>
 	<section>
 	<title>Parameters</title>
-	<section>
+	<section id="pipelimit.p.db_url">
 	    <title><varname>db_url</varname> (string)</title>
 	    <para>
 		URL of the database server to be used.
@@ -85,7 +85,7 @@ modparam("pipelimit", "db_url", "&exampledb;")
 	    </example>
 	</section>
 
-	<section>
+	<section id="pipelimit.p.plp_table_name">
 	    <title><varname>plp_table_name</varname> (string)</title>
 	    <para>
 			Name of DB table where data definition for pipes is stores.
@@ -105,7 +105,7 @@ modparam("pipelimit", "plp_table_name", "mypipes")
 	    </example>
 	</section>
 
-	<section>
+	<section id="pipelimit.p.plp_pipeid_column">
 	    <title><varname>plp_pipeid_column</varname> (string)</title>
 	    <para>
 		Name of 'pipeid' column.
@@ -125,7 +125,7 @@ modparam("pipelimit", "plp_pipeid_column", "name")
 	    </example>
 	</section>
 
-	<section>
+	<section id="pipelimit.p.plp_limit_column">
 	    <title><varname>plp_limit_column</varname> (string)</title>
 	    <para>
 		Name of 'limit' column.
@@ -145,7 +145,7 @@ modparam("pipelimit", "plp_limit_column", "name")
 	    </example>
 	</section>
 
-	<section>
+	<section id="pipelimit.p.plp_algorithm_column">
 	    <title><varname>plp_algorithm_column</varname> (string)</title>
 	    <para>
 		Name of 'algorithm' column.
@@ -165,7 +165,7 @@ modparam("pipelimit", "plp_algorithm_column", "name")
 	    </example>
 	</section>
 
-	<section>
+	<section id="pipelimit.p.timer_interval">
 		<title><varname>timer_interval</varname> (integer)</title>
 		<para>
 		The initial length of a timer interval in seconds. All amounts of
@@ -190,7 +190,7 @@ modparam("pipelimit", "timer_interval", 5)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="pipelimit.p.reply_code">
 		<title><varname>reply_code</varname> (integer)</title>
 		<para>
 		The code of the reply sent by &kamailio; while limiting.
@@ -221,7 +221,7 @@ modparam("pipelimit", "reply_code", 505)
 		</programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="pipelimit.p.reply_reason">
 		<title><varname>reply_reason</varname> (string)</title>
 		<para>
 		The reason of the reply sent by &kamailio; while limiting.
@@ -254,7 +254,7 @@ modparam("pipelimit", "reply_reason", "Limiting")
 	</section>
 	<section>
 	<title>Functions</title>
-	<section>
+	<section id="pipelimit.f.pl_check">
 		<title>
 		<function moreinfo="none">pl_check(name)</function>
 		</title>
@@ -319,7 +319,7 @@ with unexpected retcode=$var(check_result)\n");
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="pipelimit.f.pl_drop">
 		<title>
 		<function moreinfo="none">pl_drop([ [min ], max ])</function>
 		</title>
@@ -366,12 +366,12 @@ with unexpected retcode=$var(check_result)\n");
 
 	<section>
 	<title>MI Commands</title>
-	<section>
+	<section id="pipelimit.m.pl_stats">
 		<title>
 		<function moreinfo="none">pl_stats</function>
 		</title>
 		<para>
-		Lists the parameters and variabiles in the pipelimit module.
+		Lists the parameters and variables in the pipelimit module.
 		</para>
 		<para>
 		Name: <emphasis>pl_stats</emphasis>
@@ -385,7 +385,7 @@ with unexpected retcode=$var(check_result)\n");
 		_empty_line_
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.m.pl_set_pipe">
 		<title>
 		<function moreinfo="none">pl_set_pipe</function>
 		</title>
@@ -420,7 +420,7 @@ with unexpected retcode=$var(check_result)\n");
 		_empty_line_
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.m.pl_get_pipes">
 		<title>
 		<function moreinfo="none">pl_get_pipes</function>
 		</title>
@@ -439,7 +439,7 @@ with unexpected retcode=$var(check_result)\n");
 		_empty_line_
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.m.pl_set_pid">
 		<title>
 		<function moreinfo="none">pl_set_pid</function>
 		</title>
@@ -472,7 +472,7 @@ with unexpected retcode=$var(check_result)\n");
 		_empty_line_
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.m.pl_get_pid">
 		<title>
 		<function moreinfo="none">pl_get_pid</function>
 		</title>
@@ -491,12 +491,12 @@ with unexpected retcode=$var(check_result)\n");
 		_empty_line_
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.m.pl_push_load">
 		<title>
 		<function moreinfo="none">pl_push_load</function>
 		</title>
 		<para>
-		Force the value of the load parameter.  This command is useful
+		Force the value of the load parameter. This command is useful
 		for testing the Feedback algorithm.
 		</para>
 		<para>
@@ -522,7 +522,7 @@ with unexpected retcode=$var(check_result)\n");
 	
 	<section>
 	<title>RPC Commands</title>
-	<section>
+	<section id="pipelimit.r.pl.stats">
 		<title>
 		<function moreinfo="none">pl.stats</function>
 		</title>
@@ -541,7 +541,7 @@ with unexpected retcode=$var(check_result)\n");
 	kamcmd pl.stats
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.r.pl.set_pipe">
 		<title>
 		<function moreinfo="none">pl.set_pipe</function>
 		</title>
@@ -572,7 +572,7 @@ with unexpected retcode=$var(check_result)\n");
 	kamcmd pl.set_pipe 2 RED 10
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.r.pl.get_pipes">
 		<title>
 		<function moreinfo="none">pl.get_pipes</function>
 		</title>
@@ -590,7 +590,7 @@ with unexpected retcode=$var(check_result)\n");
 	kamcmd pl.get_pipes
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.r.pl.set_pid">
 		<title>
 		<function moreinfo="none">pl.set_pid</function>
 		</title>
@@ -619,7 +619,7 @@ with unexpected retcode=$var(check_result)\n");
 	kamcmd pl.set_pid 0.5 0.5 0.5
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.r.pl.get_pid">
 		<title>
 		<function moreinfo="none">pl.get_pid</function>
 		</title>
@@ -637,12 +637,12 @@ with unexpected retcode=$var(check_result)\n");
 	kamcmd pl.get_pid
 		</programlisting>
 	</section>
-	<section>
+	<section id="pipelimit.r.pl.push_load">
 		<title>
 		<function moreinfo="none">pl.push_load</function>
 		</title>
 		<para>
-		Force the value of the load parameter.  This command is useful
+		Force the value of the load parameter. This command is useful
 		for testing the Feedback algorithm.
 		</para>
 		<para>