Browse Source

msilo minor doc updates, add section ID's

Olle E. Johansson 11 years ago
parent
commit
c1c285b308
2 changed files with 44 additions and 42 deletions
  1. 8 6
      modules/msilo/README
  2. 36 36
      modules/msilo/doc/msilo_admin.xml

+ 8 - 6
modules/msilo/README

@@ -263,7 +263,7 @@ Chapter 1. Admin Guide
 
 
    Database URL.
    Database URL.
 
 
-   Default value is "mysql://openser:openserrw@localhost/openser".
+   Default value is "mysql://kamailio:kamailiorw@localhost/kamailio".
 
 
    Example 1.1. Set the "db_url" parameter
    Example 1.1. Set the "db_url" parameter
 ...
 ...
@@ -298,8 +298,9 @@ modparam("msilo", "from_address", "sip:[email protected]")
 
 
 3.4. contact_hdr (string)
 3.4. contact_hdr (string)
 
 
-   The value of the Contact header (including header name and ending \r\n)
-   to be added in notification messages. It can contain pseudo-variables.
+   The value of the "Contact" header (including header name and ending
+   \r\n) to be added in notification messages. It can contain
+   pseudo-variables.
 
 
    Default value is "NULL".
    Default value is "NULL".
 
 
@@ -426,8 +427,8 @@ modparam("msilo", "clean_period", 3)
 
 
 3.14. use_contact (int)
 3.14. use_contact (int)
 
 
-   Turns on/off the usage of the Contact address to send notification back
-   to sender whose message is stored by MSILO.
+   Turns on/off the usage of the "Contact" address to send notification
+   back to sender whose message is stored by MSILO.
 
 
    Default value is "1 (0 = off, 1 = on)".
    Default value is "1 (0 = off, 1 = on)".
 
 
@@ -556,7 +557,8 @@ modparam("msilo", "sc_snd_time", "send_reminder_time")
 
 
    If the parameter is not set, the module does not look for this AVP. If
    If the parameter is not set, the module does not look for this AVP. If
    the value is set to a valid AVP name, then the module expects in the
    the value is set to a valid AVP name, then the module expects in the
-   AVP to be a time value in format YYYYMMDDHHMMSS (e.g., 20060101201500).
+   AVP to be a time value in format "YYYYMMDDHHMMSS" (e.g.,
+   20060101201500).
 
 
    Default value is "null".
    Default value is "null".
 
 

+ 36 - 36
modules/msilo/doc/msilo_admin.xml

@@ -93,7 +93,7 @@
 	</section>
 	</section>
 	<section>
 	<section>
 	<title>Parameters</title>
 	<title>Parameters</title>
-	<section>
+	<section id="msilo.p.db_url">
 		<title><varname>db_url</varname> (string)</title>
 		<title><varname>db_url</varname> (string)</title>
 		<para>
 		<para>
 		Database &url;.
 		Database &url;.
@@ -113,7 +113,7 @@ modparam("msilo", "db_url", "mysql://user:[email protected]/dbname")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.db_table">
 		<title><varname>db_table</varname> (string)</title>
 		<title><varname>db_table</varname> (string)</title>
 		<para>
 		<para>
 		The name of table where to store the messages.
 		The name of table where to store the messages.
@@ -132,7 +132,7 @@ modparam("msilo", "db_table", "silo")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.from_address">
 		<title><varname>from_address</varname> (string)</title>
 		<title><varname>from_address</varname> (string)</title>
 		<para>
 		<para>
 		The &sip; address used to inform users that destination of their 
 		The &sip; address used to inform users that destination of their 
@@ -155,10 +155,10 @@ modparam("msilo", "from_address", "sip:[email protected]")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.contact_hdr">
 		<title><varname>contact_hdr</varname> (string)</title>
 		<title><varname>contact_hdr</varname> (string)</title>
 		<para>
 		<para>
-		The value of the Contact header (including header name and ending
+		The value of the <quote>Contact</quote> header (including header name and ending
 		\r\n) to be added in notification messages.
 		\r\n) to be added in notification messages.
 		It can contain pseudo-variables.
 		It can contain pseudo-variables.
 		</para>
 		</para>
@@ -176,7 +176,7 @@ modparam("msilo", "contact_hdr", "Contact: &lt;sip:[email protected]&gt;\r\n")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.extra_hdrs">
 		<title><varname>extra_hdrs</varname> (string)</title>
 		<title><varname>extra_hdrs</varname> (string)</title>
 		<para>
 		<para>
 		Extra headers (each ending with	\r\n) to be added in
 		Extra headers (each ending with	\r\n) to be added in
@@ -197,7 +197,7 @@ modparam("msilo", "extra_hdrs", "X-Extra: $tu\r\nY-Extra: foo\r\n")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.offline_message">
 		<title><varname>offline_message</varname> (string)</title>
 		<title><varname>offline_message</varname> (string)</title>
 		<para>
 		<para>
 		The body of the notification message.
 		The body of the notification message.
@@ -218,7 +218,7 @@ modparam("msilo", "offline_message", "&lt;em&gt;I am offline!&lt;/em&gt;")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.content_type_hdr">
 		<title><varname>content_type_hdr</varname> (string)</title>
 		<title><varname>content_type_hdr</varname> (string)</title>
 		<para>
 		<para>
 		The value of the Content-Type header (including header name and ending
 		The value of the Content-Type header (including header name and ending
@@ -241,7 +241,7 @@ modparam("msilo", "content_type_hdr", "Content-Type: text/html\r\n")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.reminder">
 		<title><varname>reminder</varname> (string)</title>
 		<title><varname>reminder</varname> (string)</title>
 		<para>
 		<para>
 		The &sip; address used to send reminder messages. If this value
 		The &sip; address used to send reminder messages. If this value
@@ -261,11 +261,11 @@ modparam("msilo", "reminder", "sip:[email protected]")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.outbound_proxy">
 		<title><varname>outbound_proxy</varname> (string)</title>
 		<title><varname>outbound_proxy</varname> (string)</title>
 		<para>
 		<para>
 		The &sip; address used as next hop when sending the message. Very
 		The &sip; address used as next hop when sending the message. Very
-		useful when using &kamailio; with a domain name not in DNS, or when
+		useful when using &kamailio; with a domain name not in <acronym>DNS</acronym>, or when
 		using a separate &kamailio; instance for msilo processing. If not set,
 		using a separate &kamailio; instance for msilo processing. If not set,
 		the message will be sent to the address in destination URI.
 		the message will be sent to the address in destination URI.
 		</para>
 		</para>
@@ -283,7 +283,7 @@ modparam("msilo", "outbound_proxy", "sip:kamailio.org;transport=tcp")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.expire_time">
 		<title><varname>expire_time</varname> (int)</title>
 		<title><varname>expire_time</varname> (int)</title>
 		<para>
 		<para>
 		Expire time of stored messages - seconds. When this time passed, the message is
 		Expire time of stored messages - seconds. When this time passed, the message is
@@ -303,7 +303,7 @@ modparam("msilo", "expire_time", 36000)
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.check_time">
 		<title><varname>check_time</varname> (int)</title>
 		<title><varname>check_time</varname> (int)</title>
 		<para>
 		<para>
 		Timer interval to check if dumped messages are sent OK - seconds. The module keeps
 		Timer interval to check if dumped messages are sent OK - seconds. The module keeps
@@ -324,7 +324,7 @@ modparam("msilo", "check_time", 10)
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.send_time">
 		<title><varname>send_time</varname> (int)</title>
 		<title><varname>send_time</varname> (int)</title>
 		<para>
 		<para>
 		Timer interval in seconds to check if there are reminder messages.
 		Timer interval in seconds to check if there are reminder messages.
@@ -348,7 +348,7 @@ modparam("msilo", "send_time", 60)
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.clean_period">
 		<title><varname>clean_period</varname> (int)</title>
 		<title><varname>clean_period</varname> (int)</title>
 		<para>
 		<para>
 		Number of <quote>check_time</quote> cycles when to check if
 		Number of <quote>check_time</quote> cycles when to check if
@@ -368,11 +368,11 @@ modparam("msilo", "clean_period", 3)
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.use_contact">
 		<title><varname>use_contact</varname> (int)</title>
 		<title><varname>use_contact</varname> (int)</title>
 		<para>
 		<para>
-		Turns on/off the usage of the Contact address to send notification
-		back to sender whose message is stored by MSILO.
+		Turns on/off the usage of the <quote>Contact</quote> address to send notification
+		back to sender whose message is stored by <acronym>MSILO</acronym>.
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>
 		<emphasis>
@@ -389,7 +389,7 @@ modparam("msilo", "use_contact", 0)
 		</example>
 		</example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="msilo.p.sc_mid">
 		<title><varname>sc_mid</varname> (string)</title>
 		<title><varname>sc_mid</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing message id. 
 		The name of the column in silo table, storing message id. 
@@ -405,7 +405,7 @@ modparam("msilo", "sc_mid", "other_mid")
 		</example>
 		</example>
     </section>
     </section>
 
 
-	<section>
+	<section id="msilo.p.sc_from">
 		<title><varname>sc_from</varname> (string)</title>
 		<title><varname>sc_from</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the source address. 
 		The name of the column in silo table, storing the source address. 
@@ -420,7 +420,7 @@ modparam("msilo", "sc_from", "source_address")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_to">
 		<title><varname>sc_to</varname> (string)</title>
 		<title><varname>sc_to</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the destination address. 
 		The name of the column in silo table, storing the destination address. 
@@ -435,7 +435,7 @@ modparam("msilo", "sc_to", "destination_address")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_uri_user">
 		<title><varname>sc_uri_user</varname> (string)</title>
 		<title><varname>sc_uri_user</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the user name.
 		The name of the column in silo table, storing the user name.
@@ -450,7 +450,7 @@ modparam("msilo", "sc_uri_user", "user")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_uri_host">
 		<title><varname>sc_uri_host</varname> (string)</title>
 		<title><varname>sc_uri_host</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the domain. 
 		The name of the column in silo table, storing the domain. 
@@ -465,7 +465,7 @@ modparam("msilo", "sc_uri_host", "domain")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_body">
 		<title><varname>sc_body</varname> (string)</title>
 		<title><varname>sc_body</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column storing the message body in silo table. 
 		The name of the column storing the message body in silo table. 
@@ -480,7 +480,7 @@ modparam("msilo", "sc_body", "message_body")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_ctype">
 		<title><varname>sc_ctype</varname> (string)</title>
 		<title><varname>sc_ctype</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing content type.
 		The name of the column in silo table, storing content type.
@@ -495,7 +495,7 @@ modparam("msilo", "sc_ctype", "content_type")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_exp_time">
 		<title><varname>sc_exp_time</varname> (string)</title>
 		<title><varname>sc_exp_time</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the expire time of the message. 
 		The name of the column in silo table, storing the expire time of the message. 
@@ -510,7 +510,7 @@ modparam("msilo", "sc_exp_time", "expire_time")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_inc_time">
 		<title><varname>sc_inc_time</varname> (string)</title>
 		<title><varname>sc_inc_time</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the incoming time of the message. 
 		The name of the column in silo table, storing the incoming time of the message. 
@@ -525,7 +525,7 @@ modparam("msilo", "sc_inc_time", "incoming_time")
 </programlisting>
 </programlisting>
 		</example>
 		</example>
     </section>
     </section>
-	<section>
+	<section id="msilo.p.sc_snd_time">
 		<title><varname>sc_snd_time</varname> (string)</title>
 		<title><varname>sc_snd_time</varname> (string)</title>
 		<para>
 		<para>
 		The name of the column in silo table, storing the send time for the reminder. 
 		The name of the column in silo table, storing the send time for the reminder. 
@@ -541,7 +541,7 @@ modparam("msilo", "sc_snd_time", "send_reminder_time")
 		</example>
 		</example>
     </section>
     </section>
 
 
-	<section>
+	<section id="msilo.p.snd_time_avp">
 		<title><varname>snd_time_avp</varname> (str)</title>
 		<title><varname>snd_time_avp</varname> (str)</title>
 		<para>
 		<para>
 		The name of an AVP which may contain the time when to sent
 		The name of an AVP which may contain the time when to sent
@@ -550,7 +550,7 @@ modparam("msilo", "sc_snd_time", "send_reminder_time")
 		<para>
 		<para>
 		If the parameter is not set, the module does not look for this AVP. If
 		If the parameter is not set, the module does not look for this AVP. If
 		the value is set to a valid AVP name, then the module expects in the AVP
 		the value is set to a valid AVP name, then the module expects in the AVP
-		to be a time value in format YYYYMMDDHHMMSS (e.g., 20060101201500).
+		to be a time value in format <quote>YYYYMMDDHHMMSS</quote> (e.g., 20060101201500).
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>
 		<emphasis>
@@ -567,7 +567,7 @@ modparam("msilo", "snd_time_avp", "$avp(i:123)")
 		</example>
 		</example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="msilo.p.add_date">
 		<title><varname>add_date</varname> (int)</title>
 		<title><varname>add_date</varname> (int)</title>
 		<para>
 		<para>
 		Wheter to add as prefix the date when the message was stored.
 		Wheter to add as prefix the date when the message was stored.
@@ -586,7 +586,7 @@ modparam("msilo", "add_date", 0)
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.max_messages">
 		<title><varname>max_messages</varname> (int)</title>
 		<title><varname>max_messages</varname> (int)</title>
 		<para>
 		<para>
 		Maximum number of stored message for an AoR.  Value 0
 		Maximum number of stored message for an AoR.  Value 0
@@ -606,7 +606,7 @@ modparam("msilo", "max_messages", 0)
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.p.add_contact">
 		<title><varname>add_contact</varname> (int)</title>
 		<title><varname>add_contact</varname> (int)</title>
 		<para>
 		<para>
 		Wheter to add contact header to generated messages. The
 		Wheter to add contact header to generated messages. The
@@ -628,7 +628,7 @@ modparam("msilo", "add_contact", 1)
 		</example>
 		</example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="msilo.p.extra_hdrs_avp">
 		<title><varname>extra_hdrs_avp</varname> (str)</title>
 		<title><varname>extra_hdrs_avp</varname> (str)</title>
 		<para>
 		<para>
 		Name of an AVP which may contain extra headers that are
 		Name of an AVP which may contain extra headers that are
@@ -659,7 +659,7 @@ modparam("msilo", "extra_hdrs_avp", "$avp(msilo_extra_hdrs)")
 
 
 	<section>
 	<section>
 	<title>Functions</title>
 	<title>Functions</title>
-	<section>
+	<section id="msilo.f.m_store">
 		<title><function moreinfo="none">m_store([owner])</function></title>
 		<title><function moreinfo="none">m_store([owner])</function></title>
 		<para>
 		<para>
 		The method stores certain parts of the current &sip; request (it 
 		The method stores certain parts of the current &sip; request (it 
@@ -693,7 +693,7 @@ m_store("$tu");
 </programlisting>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-	<section>
+	<section id="msilo.f.m_dump">
 		<title><function moreinfo="none">m_dump([owner])</function></title>
 		<title><function moreinfo="none">m_dump([owner])</function></title>
 		<para>
 		<para>
 		The method sends stored messages for the &sip; user that is going to 
 		The method sends stored messages for the &sip; user that is going to