Просмотр исходного кода

diversion minor doc updates, adding section ID's

Olle E. Johansson 11 лет назад
Родитель
Сommit
5236f6e662
3 измененных файлов с 21 добавлено и 23 удалено
  1. 10 10
      modules/diversion/README
  2. 8 10
      modules/diversion/doc/diversion_admin.xml
  3. 3 3
      modules/diversion/doc/diversion_devel.xml

+ 10 - 10
modules/diversion/README

@@ -60,15 +60,15 @@ Chapter 1. Admin Guide
 
 
 1. Overview
 1. Overview
 
 
-   The module implements the Diversion extensions as per
-   draft-levy-sip-diversion-08. The diversion extensions are useful in
-   various scenarios involving call forwarding. Typically one needs to
-   communicate the original recipient of the call to the PSTN gateway and
-   this is what the diversion extensions can be used for.
+   The module implements the Diversion extensions as per RFC 5806. The
+   diversion extensions are useful in various scenarios involving call
+   forwarding. Typically one needs to communicate the original recipient
+   of the call to the PSTN gateway and this is what the diversion
+   extensions can be used for.
 
 
 Warning
 Warning
 
 
-   The draft-levy-sip-diversion-08 is expired!! See IETF I-D tracker.
+   Note that RFC 5806 has historic status.
 
 
 2. Dependencies
 2. Dependencies
 
 
@@ -158,12 +158,12 @@ Content-Length: 0
 
 
 Chapter 2. Developer Guide
 Chapter 2. Developer Guide
 
 
-   According to the specification new Diversion header field should be
+   According to the specification a new "Diversion" header field should be
    inserted as the topmost Diversion header field in the message, that
    inserted as the topmost Diversion header field in the message, that
    means before any other existing Diversion header field in the message.
    means before any other existing Diversion header field in the message.
-   In addition to that, add_diversion function can be called several times
-   and each time it should insert the new Diversion header field as the
-   topmost one.
+   In addition to that, the add_diversion function can be called several
+   times and each time it should insert the new Diversion header field as
+   the topmost one.
 
 
    In order to implement this, add_diversion function creates the anchor
    In order to implement this, add_diversion function creates the anchor
    in data_lump lists as a static variable to ensure that the next call of
    in data_lump lists as a static variable to ensure that the next call of

+ 8 - 10
modules/diversion/doc/diversion_admin.xml

@@ -13,19 +13,17 @@
 	
 	
 	<title>&adminguide;</title>
 	<title>&adminguide;</title>
 	
 	
-	<section>
+	<section id="diversion.overview">
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<para>
 		The module implements the Diversion extensions as per 
 		The module implements the Diversion extensions as per 
-		draft-levy-sip-diversion-08.  The
-		diversion extensions are useful in various scenarios involving call
-		forwarding. Typically one needs to communicate the original recipient 
-		of the call to the PSTN gateway and this is what the diversion 
-		extensions can be used for.
+		RFC 5806. The diversion extensions are useful in various
+		scenarios involving call forwarding. Typically one needs to communicate
+		the original recipient of the call to the PSTN gateway and this is what
+		the diversion extensions can be used for.
 	</para>
 	</para>
 	<warning><para>
 	<warning><para>
-		The draft-levy-sip-diversion-08 is expired!! See
-		<ulink url="https://datatracker.ietf.org/public/idindex.cgi?command=id_detail&amp;and;id=6002"> IETF I-D tracker</ulink>.
+		Note that RFC 5806 has historic status.
 	</para></warning>
 	</para></warning>
 	</section>
 	</section>
 
 
@@ -52,7 +50,7 @@
 	</section>
 	</section>
 	<section>
 	<section>
 	<title>Parameters</title>
 	<title>Parameters</title>
-	<section>
+	<section id="diversion.p.suffix">
 		<title><varname>suffix</varname> (string)</title>
 		<title><varname>suffix</varname> (string)</title>
 		<para>
 		<para>
 		The suffix to be appended to the end of the header field. You can use 
 		The suffix to be appended to the end of the header field. You can use 
@@ -72,7 +70,7 @@ modparam("diversion", "suffix", ";privacy=full")
 	</section>
 	</section>
 	<section>
 	<section>
 	<title>Functions</title>
 	<title>Functions</title>
-	<section>
+	<section id="diversion.f.add_diversion">
 		<title><function moreinfo="none">add_diversion(reason [, uri])</function></title>
 		<title><function moreinfo="none">add_diversion(reason [, uri])</function></title>
 		<para>
 		<para>
 		The function adds a new diversion header field before any other 
 		The function adds a new diversion header field before any other 

+ 3 - 3
modules/diversion/doc/diversion_devel.xml

@@ -13,9 +13,9 @@
     
     
     <title>&develguide;</title>
     <title>&develguide;</title>
     <para>
     <para>
-	According to the specification new Diversion header field should be inserted as the topmost
-	Diversion header field in the message, that means before any other existing Diversion header
-	field in the message. In addition to that, <function
+	According to the specification a new <quote>Diversion</quote> header field should be inserted
+	as the topmost Diversion header field in the message, that means before any other existing
+	Diversion header field in the message. In addition to that, the <function
 	moreinfo="none">add_diversion</function> function can be called several times and each time
 	moreinfo="none">add_diversion</function> function can be called several times and each time
 	it should insert the new Diversion header field as the topmost one.
 	it should insert the new Diversion header field as the topmost one.
     </para>
     </para>