nsq: restructured the sections for functions and parameters

- keep them directly under Functions and Parameters chapters, being
  required to be properly parsed for alphabetic indexes from wiki
- added in description of each one a note if they are nsq or presence
  related

modules/nsq/README

@@ -10,7 +10,7 @@ Emmanuel Schmidbauer
 
    <[email protected]>
 
-   Copyright © 2016 Weave Communications
+   Copyright © 2016 Weave Communications
      __________________________________________________________________
 
    Table of Contents
@@ -30,31 +30,24 @@ Emmanuel Schmidbauer
 
         4. Parameters
 
-              4.1. NSQ related
-
-                    4.1.1. lookupd_address(str)
-                    4.1.2. lookupd_port(int)
-                    4.1.3. nsqd_address(str)
-                    4.1.4. nsqd_port(int)
-                    4.1.5. consumer_use_nsqd(int)
-                    4.1.6. consumer_event_key(str)
-                    4.1.7. consumer_event_sub_key(str)
-                    4.1.8. max_in_flight(int)
-                    4.1.9. consumer_workers(int)
-                    4.1.10. topic_channel(str)
-
-              4.2. Presence Related
-
-                    4.2.1. db_url(str)
-                    4.2.2. presentity_table(str)
+              4.1. lookupd_address(str)
+              4.2. lookupd_port(int)
+              4.3. nsqd_address(str)
+              4.4. nsqd_port(int)
+              4.5. consumer_use_nsqd(int)
+              4.6. consumer_event_key(str)
+              4.7. consumer_event_sub_key(str)
+              4.8. max_in_flight(int)
+              4.9. consumer_workers(int)
+              4.10. topic_channel(str)
+              4.11. db_url(str)
+              4.12. presentity_table(str)
 
         5. Functions
 
-              5.1. Presence Pelated
-
-                    5.1.1. nsq_pua_publish(json_payload)
+              5.1. nsq_pua_publish(json_payload)
 
-        6. Exported pseudo-variables
+        6. Pseudo Variables
         7. Transformations
 
    List of Examples
@@ -92,31 +85,24 @@ Chapter 1. Admin Guide
 
    4. Parameters
 
-        4.1. NSQ related
-
-              4.1.1. lookupd_address(str)
-              4.1.2. lookupd_port(int)
-              4.1.3. nsqd_address(str)
-              4.1.4. nsqd_port(int)
-              4.1.5. consumer_use_nsqd(int)
-              4.1.6. consumer_event_key(str)
-              4.1.7. consumer_event_sub_key(str)
-              4.1.8. max_in_flight(int)
-              4.1.9. consumer_workers(int)
-              4.1.10. topic_channel(str)
-
-        4.2. Presence Related
-
-              4.2.1. db_url(str)
-              4.2.2. presentity_table(str)
+        4.1. lookupd_address(str)
+        4.2. lookupd_port(int)
+        4.3. nsqd_address(str)
+        4.4. nsqd_port(int)
+        4.5. consumer_use_nsqd(int)
+        4.6. consumer_event_key(str)
+        4.7. consumer_event_sub_key(str)
+        4.8. max_in_flight(int)
+        4.9. consumer_workers(int)
+        4.10. topic_channel(str)
+        4.11. db_url(str)
+        4.12. presentity_table(str)
 
    5. Functions
 
-        5.1. Presence Pelated
+        5.1. nsq_pua_publish(json_payload)
 
-              5.1.1. nsq_pua_publish(json_payload)
-
-   6. Exported pseudo-variables
+   6. Pseudo Variables
    7. Transformations
 
 1. Overview
@@ -232,30 +218,25 @@ event_route[nsq:consumer-event]
 
 4. Parameters
 
-   4.1. NSQ related
-
-        4.1.1. lookupd_address(str)
-        4.1.2. lookupd_port(int)
-        4.1.3. nsqd_address(str)
-        4.1.4. nsqd_port(int)
-        4.1.5. consumer_use_nsqd(int)
-        4.1.6. consumer_event_key(str)
-        4.1.7. consumer_event_sub_key(str)
-        4.1.8. max_in_flight(int)
-        4.1.9. consumer_workers(int)
-        4.1.10. topic_channel(str)
-
-   4.2. Presence Related
-
-        4.2.1. db_url(str)
-        4.2.2. presentity_table(str)
-
-4.1. NSQ related
-
-4.1.1. lookupd_address(str)
+   4.1. lookupd_address(str)
+   4.2. lookupd_port(int)
+   4.3. nsqd_address(str)
+   4.4. nsqd_port(int)
+   4.5. consumer_use_nsqd(int)
+   4.6. consumer_event_key(str)
+   4.7. consumer_event_sub_key(str)
+   4.8. max_in_flight(int)
+   4.9. consumer_workers(int)
+   4.10. topic_channel(str)
+   4.11. db_url(str)
+   4.12. presentity_table(str)
+
+4.1. lookupd_address(str)
 
    The nsqlookupd address.
 
+   Usage: nsq related.
+
    Default value is 127.0.0.1
 
    Example 1.2. Set lookupd_address parameter
@@ -263,10 +244,12 @@ event_route[nsq:consumer-event]
 modparam("nsq", "lookupd_address", "nsqlookupd.mydomain.com")
 ...
 
-4.1.2. lookupd_port(int)
+4.2. lookupd_port(int)
 
    The nsqlookupd TCP port.
 
+   Usage: nsq related.
+
    Default value is 4161.
 
    Example 1.3. Set lookupd_port parameter
@@ -274,11 +257,13 @@ modparam("nsq", "lookupd_address", "nsqlookupd.mydomain.com")
 modparam("nsq", "lookupd_port", 4161)
 ...
 
-4.1.3. nsqd_address(str)
+4.3. nsqd_address(str)
 
    The nsqd address. You can specify connecting directly to nsqd instead
    of using nsqlookupd.
 
+   Usage: nsq related.
+
    Default value is 127.0.0.1
 
    Example 1.4. Set nsqd_address parameter
@@ -286,10 +271,12 @@ modparam("nsq", "lookupd_port", 4161)
 modparam("nsq", "nsqd_address", "nsqd.mydomain.com")
 ...
 
-4.1.4. nsqd_port(int)
+4.4. nsqd_port(int)
 
    The nsqd TCP port.
 
+   Usage: nsq related.
+
    Default value is 4150.
 
    Example 1.5. Set nsqd_port parameter
@@ -297,10 +284,12 @@ modparam("nsq", "nsqd_address", "nsqd.mydomain.com")
 modparam("nsq", "nsqd_port", 4150)
 ...
 
-4.1.5. consumer_use_nsqd(int)
+4.5. consumer_use_nsqd(int)
 
    Set to 1 if you'd like to connect to nsqd instead of nsqlookupd.
 
+   Usage: nsq related.
+
    Default value is 0.
 
    Example 1.6. Set consumer_use_nsqd parameter
@@ -308,35 +297,41 @@ modparam("nsq", "nsqd_port", 4150)
 modparam("nsq", "consumer_use_nsqd", 1)
 ...
 
-4.1.6. consumer_event_key(str)
+4.6. consumer_event_key(str)
 
    The default name of the field in json payload to compose the event name
    1st part
 
-   Default value is “Event-Category�.
+   Usage: nsq related.
+
+   Default value is "Event-Category".
 
    Example 1.7. Set consumer_event_key parameter
 ...
 modparam("nsq", "consumer_event_key", "My-JSON-Field-Name")
 ...
 
-4.1.7. consumer_event_sub_key(str)
+4.7. consumer_event_sub_key(str)
 
    The default name of the field in json payload to compose the event name
    2nd part
 
-   Default value is “Event-Name�.
+   Usage: nsq related.
+
+   Default value is "Event-Name".
 
    Example 1.8. Set consumer_event_sub_key parameter
 ...
 modparam("nsq", "consumer_event_sub_key", "My-JSON-SubField-Name")
 ...
 
-4.1.8. max_in_flight(int)
+4.8. max_in_flight(int)
 
    The number of messages the consumer can receive before nsqd expects a
    response.
 
+   Usage: nsq related.
+
    Default value is 1.
 
    Example 1.9. Set max_in_flight parameter
@@ -344,10 +339,12 @@ modparam("nsq", "consumer_event_sub_key", "My-JSON-SubField-Name")
 modparam("nsq", "max_in_flight", 2)
 ...
 
-4.1.9. consumer_workers(int)
+4.9. consumer_workers(int)
 
    Number of consumer connections to NSQ per topic_channel.
 
+   Usage: nsq related.
+
    Default value is 4.
 
    Example 1.10. Set consumer_workers parameter
@@ -355,13 +352,15 @@ modparam("nsq", "max_in_flight", 2)
 modparam("nsq", "consumer_workers", 2)
 ...
 
-4.1.10. topic_channel(str)
+4.10. topic_channel(str)
 
-   The NSQ Topic and Channel. Delimiter-separated by “:�. It be set
+   The NSQ Topic and Channel. Delimiter-separated by ":". It be set
    multiple times to subscribe to multiple topics and channels. The value
    of consumer_workers is allocated per topic_channel.
 
-   Default value is “Kamailio-Topic:Kamailio-Channel�.
+   Usage: nsq related.
+
+   Default value is "Kamailio-Topic:Kamailio-Channel".
 
    Example 1.11. Set topic_channel parameter
 ...
@@ -369,27 +368,27 @@ modparam("nsq", "topic_channel", "My-NSQ-Topic:My-NSQ-Channel")
 modparam("nsq", "topic_channel", "My-NSQ-Topic-2:My-NSQ-Channel-2")
 ...
 
-4.2. Presence Related
-
-4.2.1. db_url(str)
+4.11. db_url(str)
 
    The database for the presentity table.
 
    If set, the nsq_pua_publish function will update the presentity status
    in the database.
 
-   Default value is “NULL�.
+   Usage: presence related.
+
+   Default value is "NULL".
 
    Example 1.12. Set db_url parameter
 ...
 modparam("nsq", "db_url", "mysql://kamailio:kamailiorw@localhost/kamailio")
 ...
 
-4.2.2. presentity_table(str)
+4.12. presentity_table(str)
 
    The name of the presentity table in the database.
 
-   Default value is “presentity�.
+   Default value is "presentity".
 
    Example 1.13. Set presentity_table parameter
 ...
@@ -398,17 +397,15 @@ modparam("nsq", "presentity_table", "my_presentity_table")
 
 5. Functions
 
-   5.1. Presence Pelated
+   5.1. nsq_pua_publish(json_payload)
 
-        5.1.1. nsq_pua_publish(json_payload)
-
-5.1. Presence Pelated
-
-5.1.1.  nsq_pua_publish(json_payload)
+5.1. nsq_pua_publish(json_payload)
 
    The function build presentity state from json_payload and updates
    presentity table.
 
+   Usage: presence related.
+
    This function can be used from ANY ROUTE.
 
    Example 1.14. nsq_pua_publish usage
@@ -423,7 +420,7 @@ ackage})", 1);
 }
 ...
 
-6. Exported pseudo-variables
+6. Pseudo Variables
 
      * $nsqE Contains the payload of a consumed message
 

modules/nsq/doc/nsq_admin.xml

@@ -182,254 +182,275 @@ event_route[nsq:consumer-event]
 	<section>
 		<title>Parameters</title>
 		<section>
-			<title>NSQ related</title>
-			<section>
-				<title><varname>lookupd_address</varname>(str)</title>
-				<para>
-					The nsqlookupd address.
-				</para>
-				<para>
-					<emphasis>Default value is 127.0.0.1</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>lookupd_address</varname> parameter</title>
+			<title><varname>lookupd_address</varname>(str)</title>
+			<para>
+				The nsqlookupd address.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 127.0.0.1</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>lookupd_address</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "lookupd_address", "nsqlookupd.mydomain.com")
 ...
 </programlisting>
-				</example>
-			</section>
-			<section>
-				<title><varname>lookupd_port</varname>(int)</title>
-				<para>
-					The nsqlookupd TCP port.
-				</para>
-				<para>
-					<emphasis>Default value is 4161.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>lookupd_port</varname> parameter</title>
+			</example>
+		</section>
+		<section>
+			<title><varname>lookupd_port</varname>(int)</title>
+			<para>
+				The nsqlookupd TCP port.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 4161.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>lookupd_port</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "lookupd_port", 4161)
 ...
-					</programlisting>
-				</example>
-			</section>
+				</programlisting>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>nsqd_address</varname>(str)</title>
-				<para>
-					The nsqd address. You can specify connecting directly to nsqd instead of using nsqlookupd.
-				</para>
-				<para>
-					<emphasis>Default value is 127.0.0.1</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>nsqd_address</varname> parameter</title>
+		<section>
+			<title><varname>nsqd_address</varname>(str)</title>
+			<para>
+				The nsqd address. You can specify connecting directly to nsqd instead of using nsqlookupd.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 127.0.0.1</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>nsqd_address</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "nsqd_address", "nsqd.mydomain.com")
 ...
 </programlisting>
-				</example>
-			</section>
-			<section>
-				<title><varname>nsqd_port</varname>(int)</title>
-				<para>
-					The nsqd TCP port.
-				</para>
-				<para>
-					<emphasis>Default value is 4150.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>nsqd_port</varname> parameter</title>
+			</example>
+		</section>
+		<section>
+			<title><varname>nsqd_port</varname>(int)</title>
+			<para>
+				The nsqd TCP port.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 4150.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>nsqd_port</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "nsqd_port", 4150)
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>consumer_use_nsqd</varname>(int)</title>
-				<para>
-					Set to 1 if you'd like to connect to nsqd instead of nsqlookupd.
-				</para>
-				<para>
-					<emphasis>Default value is 0.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>consumer_use_nsqd</varname> parameter</title>
+		<section>
+			<title><varname>consumer_use_nsqd</varname>(int)</title>
+			<para>
+				Set to 1 if you'd like to connect to nsqd instead of nsqlookupd.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 0.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>consumer_use_nsqd</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "consumer_use_nsqd", 1)
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>consumer_event_key</varname>(str)</title>
-				<para>
-					The default name of the field in json payload to compose the event name 1st part
-				</para>
-				<para>
-					<emphasis>Default value is <quote>Event-Category</quote>.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>consumer_event_key</varname> parameter</title>
+		<section>
+			<title><varname>consumer_event_key</varname>(str)</title>
+			<para>
+				The default name of the field in json payload to compose the event name 1st part
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is <quote>Event-Category</quote>.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>consumer_event_key</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "consumer_event_key", "My-JSON-Field-Name")
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>consumer_event_sub_key</varname>(str)</title>
-				<para>
-					The default name of the field in json payload to compose the event name 2nd part
-				</para>
-				<para>
-					<emphasis>Default value is <quote>Event-Name</quote>.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>consumer_event_sub_key</varname> parameter</title>
+		<section>
+			<title><varname>consumer_event_sub_key</varname>(str)</title>
+			<para>
+				The default name of the field in json payload to compose the event name 2nd part
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is <quote>Event-Name</quote>.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>consumer_event_sub_key</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "consumer_event_sub_key", "My-JSON-SubField-Name")
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>max_in_flight</varname>(int)</title>
-				<para>
-					The number of messages the consumer can receive before nsqd expects a response.
-				</para>
-				<para>
-					<emphasis>Default value is 1.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>max_in_flight</varname> parameter</title>
+		<section>
+			<title><varname>max_in_flight</varname>(int)</title>
+			<para>
+				The number of messages the consumer can receive before nsqd expects a response.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 1.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>max_in_flight</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "max_in_flight", 2)
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>consumer_workers</varname>(int)</title>
-				<para>
-					Number of consumer connections to NSQ per topic_channel.
-				</para>
-				<para>
-					<emphasis>Default value is 4.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>consumer_workers</varname> parameter</title>
+		<section>
+			<title><varname>consumer_workers</varname>(int)</title>
+			<para>
+				Number of consumer connections to NSQ per topic_channel.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is 4.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>consumer_workers</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "consumer_workers", 2)
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>topic_channel</varname>(str)</title>
-				<para>
-					The NSQ Topic and Channel. Delimiter-separated by <quote>:</quote>. It be set multiple times to subscribe to multiple topics and channels. The value of consumer_workers is allocated per topic_channel.
-				</para>
-				<para>
-					<emphasis>Default value is <quote>Kamailio-Topic:Kamailio-Channel</quote>.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>topic_channel</varname> parameter</title>
+		<section>
+			<title><varname>topic_channel</varname>(str)</title>
+			<para>
+				The NSQ Topic and Channel. Delimiter-separated by <quote>:</quote>. It be set multiple times to subscribe to multiple topics and channels. The value of consumer_workers is allocated per topic_channel.
+			</para>
+			<para>
+				Usage: nsq related.
+			</para>
+			<para>
+				<emphasis>Default value is <quote>Kamailio-Topic:Kamailio-Channel</quote>.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>topic_channel</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "topic_channel", "My-NSQ-Topic:My-NSQ-Channel")
 modparam("nsq", "topic_channel", "My-NSQ-Topic-2:My-NSQ-Channel-2")
 ...
-					</programlisting>
-				</example>
-			</section>
-
+				</programlisting>
+			</example>
 		</section>
 
 		<section>
-			<title>Presence Related</title>
-			<section>
-				<title><varname>db_url</varname>(str)</title>
-				<para>
-					The database for the presentity table.
-				</para>
-				<para>If set, the nsq_pua_publish function will update the presentity status in the database.
-				</para>
-				<para>
-					<emphasis>Default value is <quote>NULL</quote>.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>db_url</varname> parameter</title>
+			<title><varname>db_url</varname>(str)</title>
+			<para>
+				The database for the presentity table.
+			</para>
+			<para>
+				If set, the nsq_pua_publish function will update the presentity status in the database.
+			</para>
+			<para>
+				Usage: presence related.
+			</para>
+			<para>
+				<emphasis>Default value is <quote>NULL</quote>.</emphasis>
+			</para>
+			<example>
+			<title>Set <varname>db_url</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "db_url", "&defaultdb;")
 ...
 </programlisting>
-				</example>
-			</section>
+			</example>
+		</section>
 
-			<section>
-				<title><varname>presentity_table</varname>(str)</title>
-				<para>
-					The name of the presentity table in the database.
-				</para>
-				<para>
-					<emphasis>Default value is <quote>presentity</quote>.</emphasis>
-				</para>
-				<example>
-					<title>Set <varname>presentity_table</varname> parameter</title>
+		<section>
+			<title><varname>presentity_table</varname>(str)</title>
+			<para>
+				The name of the presentity table in the database.
+			</para>
+			<para>
+				<emphasis>Default value is <quote>presentity</quote>.</emphasis>
+			</para>
+			<example>
+				<title>Set <varname>presentity_table</varname> parameter</title>
 <programlisting format="linespecific">
 ...
 modparam("nsq", "presentity_table", "my_presentity_table")
 ...
 </programlisting>
-				</example>
-			</section>
-
-
+			</example>
 		</section>
 
-
-
-
-
 	</section>
 	<section>
 		<title>Functions</title>
-
 		<section>
-			<title>Presence Pelated</title>
-			<section>
-				<title>
-					<function moreinfo="none">nsq_pua_publish(json_payload)</function>
-				</title>
-				<para>
-					The function build presentity state from json_payload and updates presentity table.
-				</para>
-				<para>
-					This function can be used from ANY ROUTE.
-				</para>
+			<title>
+				<function moreinfo="none">nsq_pua_publish(json_payload)</function>
+			</title>
+			<para>
+				The function build presentity state from json_payload and updates presentity table.
+			</para>
+			<para>
+				Usage: presence related.
+			</para>
+			<para>
+				This function can be used from ANY ROUTE.
+			</para>
 
-				<example>
-					<title><function>nsq_pua_publish</function> usage</title>
+			<example>
+				<title><function>nsq_pua_publish</function> usage</title>
 <programlisting format="linespecific">
 ...
 event_route[nsq:consumer-event-presence-update]
@@ -440,16 +461,13 @@ event_route[nsq:consumer-event-presence-update]
 }
 ...
 </programlisting>
-				</example>
-			</section>
-
-
+			</example>
 		</section>
 
 	</section>
 
 	<section>
-		<title>Exported pseudo-variables</title>
+		<title>Pseudo Variables</title>
 		<itemizedlist>
 			<listitem>
 				<para>