msrp: Minor doc updates, added section ID's

modules/msrp/README

@@ -16,7 +16,7 @@ Alex Balashov
 
    <[email protected]>
 
-   Copyright © 2012 asipto.com
+   Copyright © 2012 asipto.com
      __________________________________________________________________
 
    Table of Contents
@@ -134,7 +134,7 @@ Chapter 1. Admin Guide
    the scalability and performance of Kamailio in handling TCP/TLS, this
    module reuses Kamailio's core framework to offer MSRP routing
    capabilities. Along with embedded Presence and XCAP servers, Kamailio
-   offers now a complete solution for SIP beyond VoIP.
+   now offers a complete solution for SIP beyond VoIP.
 
    One of the main benefits of this module is the ability to reuse all the
    other extensions that exist in the SIP server, including accounting,
@@ -178,10 +178,10 @@ Chapter 1. Admin Guide
 
 3.1. sipmsg (int)
 
-   If 1, the module will build a SIP message from MSRP frame headers,
-   providing it to event_route[msrp:frame-in]. All the config file
-   functions (apart from SIP request relay) that can be used in a request
-   route block can be used in msrp event_route.
+   If set to 1, the module will build a SIP message from MSRP frame
+   headers, providing it to "event_route[msrp:frame-in]". All the config
+   file functions (apart from SIP request relay) that can be used in a
+   request route block can be used in the MSRP event_route.
 
    Default value is '1'.
 
@@ -216,7 +216,7 @@ modparam("msrp", "timer_interval", 90)
 
 3.4. auth_min_expires (int)
 
-   The minimum value accepted for Expires header in AUTH requests.
+   The minimum value accepted for the "Expires" header in AUTH requests.
 
    Default value is '60'.
 
@@ -227,7 +227,7 @@ modparam("msrp", "auth_min_expiresl", 90)
 
 3.5. auth_max_expires (int)
 
-   The maximum value accepted for Expires header in AUTH requests.
+   The maximum value accepted for "Expires" header in AUTH requests.
 
    Default value is '3600'.
 
@@ -238,7 +238,7 @@ modparam("msrp", "auth_max_expiresl", 1800)
 
 3.6. use_path_addr (str)
 
-   The hostname:port to be used when building Use-Path header.
+   The hostname:port to be used when building the Path header.
 
    Default value is NULL (server IP and port are used).
 
@@ -259,11 +259,11 @@ modparam("msrp", "use_path_addr", "msrp.kamailio.org:5061")
    4.8. msrp_cmap_save()
    4.9. msrp_cmap_lookup()
 
-4.1.  msrp_relay()
+4.1. msrp_relay()
 
    Relay MSRP frame according to the To-Path. This function has to be
    executed for each MSRP request or reply that has to be forwarded. Note
-   that due to nature of MSRP transport layer, which is reliable
+   that due to nature of the MSRP transport layer, which is reliable
    (TCP/TLS), there is no retransmission of MSRP frames.
 
    This function can be used in ANY_ROUTE.
@@ -275,7 +275,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.2.  msrp_reply(code, text [, hdrs])
+4.2. msrp_reply(code, text [, hdrs])
 
    Send a reply for the current MSRP request, adding optional headers.
 
@@ -290,7 +290,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.3.  msrp_is_request()
+4.3. msrp_is_request()
 
    Return true if the MSRP frame is a request.
 
@@ -307,7 +307,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.4.  msrp_is_reply()
+4.4. msrp_is_reply()
 
    Return true if the MSRP frame is a reply.
 
@@ -324,7 +324,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.5.  msrp_set_dst(addr, sock)
+4.5. msrp_set_dst(addr, sock)
 
    Set destination attributes: addr - target address as MSRP URI; sock -
    local socket to be used (format 'proto:ip:port').
@@ -342,7 +342,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.6.  msrp_relay_flags(flags)
+4.6. msrp_relay_flags(flags)
 
    Set transport layer sending flags for forwarding current MSRP frame;
    flags - a bitmask of flags - 1 (don't create a new connection), 2
@@ -361,7 +361,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.7.  msrp_reply_flags(flags)
+4.7. msrp_reply_flags(flags)
 
    Set transport layer sending flags for replies to the current MSRP
    frame; flags - a bitmask of flags - 1 (don't create a new connection),
@@ -380,7 +380,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.8.  msrp_cmap_save()
+4.8. msrp_cmap_save()
 
    Save details of a MSRP connection upon AUTH request inside the internal
    map table, indexed by session id.
@@ -396,7 +396,7 @@ event_route[msrp:frame-in] {
 }
 ...
 
-4.9.  msrp_cmap_lookup()
+4.9. msrp_cmap_lookup()
 
    Lookup MSRP connection details for current session id.
 
@@ -432,7 +432,7 @@ event_route[msrp:frame-in] {
 
    6.1. msrp.cmaplist
 
-6.1.  msrp.cmaplist
+6.1. msrp.cmaplist
 
    List active MSRP connections.
 
@@ -448,10 +448,11 @@ kamcmd msrp.cmaplist
 
 8. Usage
 
-   When 'sipmsg' parameter is set to 1 (which is default), the module
-   internally builds a SIP request from the MSRP frame and exposes it to
-   the config file interpreter. This way, all the functions that are valid
-   for SIP requests can be used safely in event_route[msrp:frame-in].
+   When the sipmsg parameter is set to 1 (which is the default), the
+   module internally builds a SIP request from the MSRP frame and exposes
+   it to the config file interpreter. This way, all the functions that are
+   valid for SIP requests can be used safely in
+   event_route[msrp:frame-in].
 
    To build the SIP request, the module takes the first line and the
    headers from an MSRP message and appends them to a static buffer. The

modules/msrp/doc/msrp_admin.xml

@@ -13,7 +13,7 @@
 	
 	<title>&adminguide;</title>
 	
-	<section>
+	<section id="msrp.overview">
 	<title>Overview</title>
 	<para>
 		This module provides a MSRP routing engine, a.k.a. MSRP relay.
@@ -27,13 +27,13 @@
 		is negotiated via INVITE-200 OK-ACK.
 	</para>
 	<para>
-		However, MSRP is still a text-based protocol.  It uses several routing
+		However, MSRP is still a text-based protocol. It uses several routing
 		mechanisms similar to what exists in SIP. Furthermore,
 		MSRP requires TCP, and recommends TLS for confidentiality and security.
 		In light of the scalability and performance of &kamailio; in handling
 		TCP/TLS, this module reuses &kamailio;'s core framework to
 		offer MSRP routing capabilities. Along with embedded Presence and XCAP
-		servers, &kamailio; offers now a complete solution for SIP beyond VoIP.
+		servers, &kamailio; now offers a complete solution for SIP beyond VoIP.
 	</para>
 	<para>
 		One of the main benefits of this module is the ability to reuse
@@ -94,13 +94,13 @@
 	</section>
 	<section>
 	<title>Parameters</title>
-	<section>
+	<section id="msrp.p.sipmsg">
 		<title><varname>sipmsg</varname> (int)</title>
 		<para>
-			If 1, the module will build a SIP message from MSRP frame headers,
-			providing it to event_route[msrp:frame-in].  All the config
-			file functions (apart from SIP request relay) that can be used
-			in a request route block can be used in msrp event_route.
+			If set to 1, the module will build a SIP message from MSRP frame headers,
+			providing it to <quote>event_route[msrp:frame-in]</quote>.
+			All the config file functions (apart from SIP request relay) that can be used
+			in a request route block can be used in the MSRP event_route.
 		</para>
 		<para>
 		<emphasis>
@@ -116,7 +116,7 @@ modparam("msrp", "sipmsg", 1)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="msrp.p.cmap_size">
 		<title><varname>cmap_size</varname> (int)</title>
 		<para>
 		The size of connection map table, to be computed as power of 2 (e.g.,
@@ -136,7 +136,7 @@ modparam("msrp", "cmap_size", 8)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="msrp.p.timer_interval">
 		<title><varname>timer_interval</varname> (int)</title>
 		<para>
 		The timer interval in seconds to run the procedure for cleaning
@@ -156,10 +156,10 @@ modparam("msrp", "timer_interval", 90)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="msrp.p.auth_min_expires">
 		<title><varname>auth_min_expires</varname> (int)</title>
 		<para>
-		The minimum value accepted for Expires header in AUTH requests.
+		The minimum value accepted for the <quote>Expires</quote> header in AUTH requests.
 		</para>
 		<para>
 		<emphasis>
@@ -175,10 +175,10 @@ modparam("msrp", "auth_min_expiresl", 90)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="msrp.p.auth_max_expires">
 		<title><varname>auth_max_expires</varname> (int)</title>
 		<para>
-		The maximum value accepted for Expires header in AUTH requests.
+		The maximum value accepted for <quote>Expires</quote> header in AUTH requests.
 		</para>
 		<para>
 		<emphasis>
@@ -194,10 +194,10 @@ modparam("msrp", "auth_max_expiresl", 1800)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="msrp.p.use_path_addr">
 		<title><varname>use_path_addr</varname> (str)</title>
 		<para>
-		The hostname:port to be used when building Use-Path header.
+		The hostname:port to be used when building the Path header.
 		</para>
 		<para>
 		<emphasis>
@@ -217,14 +217,14 @@ modparam("msrp", "use_path_addr", "msrp.kamailio.org:5061")
 
 	<section>
 	<title>Functions</title>
-	<section>
+	<section id="msrp.f.msrp_relay">
 	    <title>
 		<function moreinfo="none">msrp_relay()</function>
 	    </title>
 	    <para>
 			Relay MSRP frame according to the To-Path. This function has to be 
 			executed for each MSRP request or reply that has to be forwarded. Note
-			that due to nature of MSRP transport layer, which is reliable
+			that due to nature of the MSRP transport layer, which is reliable
 			(TCP/TLS), there is no retransmission of MSRP frames.
 		</para>
 
@@ -243,7 +243,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_reply">
 	    <title>
 		<function moreinfo="none">msrp_reply(code, text [, hdrs])</function>
 	    </title>
@@ -268,7 +268,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_is_request">
 	    <title>
 		<function moreinfo="none">msrp_is_request()</function>
 	    </title>
@@ -295,7 +295,7 @@ event_route[msrp:frame-in] {
 	</section>
 
 
-	<section>
+	<section id="msrp.f.msrp_is_reply">
 	    <title>
 		<function moreinfo="none">msrp_is_reply()</function>
 	    </title>
@@ -321,7 +321,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_set_dst">
 	    <title>
 		<function moreinfo="none">msrp_set_dst(addr, sock)</function>
 	    </title>
@@ -349,7 +349,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_relay_flags">
 	    <title>
 		<function moreinfo="none">msrp_relay_flags(flags)</function>
 	    </title>
@@ -378,7 +378,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_reply_flags">
 	    <title>
 		<function moreinfo="none">msrp_reply_flags(flags)</function>
 	    </title>
@@ -407,7 +407,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_cmap_save">
 	    <title>
 		<function moreinfo="none">msrp_cmap_save()</function>
 	    </title>
@@ -432,7 +432,7 @@ event_route[msrp:frame-in] {
 	    </example>
 	</section>
 
-	<section>
+	<section id="msrp.f.msrp_cmap_lookup">
 	    <title>
 		<function moreinfo="none">msrp_cmap_lookup()</function>
 	    </title>
@@ -483,7 +483,7 @@ event_route[msrp:frame-in] {
 
 	<section>
 	<title>RPC Commands</title>
-	<section>
+	<section id="msrp.r.msrp.cmaplist">
 		<title>
 		<function moreinfo="none">msrp.cmaplist</function>
 		</title>
@@ -509,13 +509,13 @@ event_route[msrp:frame-in] {
 		</para>
 	</section>
 
-	<section>
+	<section id="msrp.usage">
 		<title>Usage</title>
 		<para>
-			When 'sipmsg' parameter is set to 1 (which is default), the module
-			internally builds a SIP request from the MSRP frame and exposes it to
-			the config file interpreter.  This way, all the functions that are
-			valid for SIP requests can be used safely in event_route[msrp:frame-in].
+			When the <varname>sipmsg</varname> parameter is set to 1 (which is the
+			default), the module internally builds a SIP request from the MSRP frame
+			and exposes it to the config file interpreter. This way, all the functions
+			that are valid for SIP requests can be used safely in event_route[msrp:frame-in].
 		</para>
 		<para>
 			To build the SIP request, the module takes the first line and the