Browse Source

presence: clean-up whitespace

Emmanuel Schmidbauer 9 years ago
parent
commit
d332b284aa
1 changed files with 36 additions and 36 deletions
  1. 36 36
      modules/presence/doc/presence_admin.xml

+ 36 - 36
modules/presence/doc/presence_admin.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding='ISO-8859-1'?>
+ <?xml version="1.0" encoding='ISO-8859-1'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
@@ -11,12 +11,12 @@
 
 
 <chapter>
 <chapter>
 	<title>&adminguide;</title>
 	<title>&adminguide;</title>
-	
+
 	<section>
 	<section>
 	<title>Overview</title>
 	<title>Overview</title>
 	<para> The Presence module implements the core functionality of SIP event notification.
 	<para> The Presence module implements the core functionality of SIP event notification.
 	It handles PUBLISH and SUBSCRIBE messages and generates
 	It handles PUBLISH and SUBSCRIBE messages and generates
-	NOTIFY messages in a general, event independent way. It is extensible and allows registering 
+	NOTIFY messages in a general, event independent way. It is extensible and allows registering
 	events to it from other &kamailio; modules.
 	events to it from other &kamailio; modules.
 	Supported SIP event packages are presence, presence.winfo, dialog;sla from the presence_xml
 	Supported SIP event packages are presence, presence.winfo, dialog;sla from the presence_xml
 	module and message-summary from the presence_mwi module.
 	module and message-summary from the presence_mwi module.
@@ -26,7 +26,7 @@
 	For subscriptions it supports the 4 storage modes: Memory Only, Write Back,
 	For subscriptions it supports the 4 storage modes: Memory Only, Write Back,
 	Write Through and DB Only. For publishes, it stores the state documents in
 	Write Through and DB Only. For publishes, it stores the state documents in
 	database only(because of the large size) and it can store a publish cache in
 	database only(because of the large size) and it can store a publish cache in
-	memory to avoid unnecessairy database queries. Read the 
+	memory to avoid unnecessairy database queries. Read the
 	<emphasis>subs_db_mode</emphasis> and <emphasis>publ_cache</emphasis> parameter
 	<emphasis>subs_db_mode</emphasis> and <emphasis>publ_cache</emphasis> parameter
 	sections to decide which is the best storage configuration for you.
 	sections to decide which is the best storage configuration for you.
 	</para>
 	</para>
@@ -35,7 +35,7 @@
 	This mode of operation is enabled if the db_url parameter is not set to any value.
 	This mode of operation is enabled if the db_url parameter is not set to any value.
 	</para>
 	</para>
 	<para>
 	<para>
-	The &kamailio; Presence module implements the specifications in: RFC3265, RFC3856, RFC3857, 
+	The &kamailio; Presence module implements the specifications in: RFC3265, RFC3856, RFC3857,
 	RFC3858.
 	RFC3858.
 	</para>
 	</para>
 	</section>
 	</section>
@@ -78,7 +78,7 @@
 
 
 		</section>
 		</section>
 	</section>
 	</section>
-	
+
 	<section>
 	<section>
 	<title>Parameters</title>
 	<title>Parameters</title>
 	<section id="presence.p.db_url">
 	<section id="presence.p.db_url">
@@ -87,7 +87,7 @@
 		The database url.
 		The database url.
 		</para>
 		</para>
 		<para>If set, the module is a fully operational
 		<para>If set, the module is a fully operational
-		presence server. Otherwise, it is used as a 'library', for 
+		presence server. Otherwise, it is used as a 'library', for
 		its exported functions.
 		its exported functions.
 		</para>
 		</para>
 		<para>
 		<para>
@@ -97,7 +97,7 @@
 		<title>Set <varname>db_url</varname> parameter</title>
 		<title>Set <varname>db_url</varname> parameter</title>
 		<programlisting format="linespecific">
 		<programlisting format="linespecific">
 ...
 ...
-modparam("presence", "db_url", 
+modparam("presence", "db_url",
 	"&defaultdb;")
 	"&defaultdb;")
 ...
 ...
 </programlisting>
 </programlisting>
@@ -124,7 +124,7 @@ modparam("presence", "presentity_table", "presentity")
 	<section id="presence.p.active_watchers_table">
 	<section id="presence.p.active_watchers_table">
 		<title><varname>active_watchers_table</varname>(str)</title>
 		<title><varname>active_watchers_table</varname>(str)</title>
 		<para>
 		<para>
-		The name of the db table where active subscription information is stored. 
+		The name of the db table where active subscription information is stored.
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>	Default value is <quote>active_watchers</quote>.
 		<emphasis>	Default value is <quote>active_watchers</quote>.
@@ -397,7 +397,7 @@ modparam("presence", "max_expires", 3600)
 <section id="presence.p.server_address">
 <section id="presence.p.server_address">
 		<title><varname>server_address</varname> (str)</title>
 		<title><varname>server_address</varname> (str)</title>
 		<para>
 		<para>
-		The presence server address which will become the value of Contact header filed 
+		The presence server address which will become the value of Contact header filed
 		for 200 OK replies to SUBSCRIBE and PUBLISH and in NOTIFY messages.
 		for 200 OK replies to SUBSCRIBE and PUBLISH and in NOTIFY messages.
 		</para>
 		</para>
 		<example>
 		<example>
@@ -547,7 +547,7 @@ modparam("presence", "pres_htable_size", 11)
 	<section id="presence.p.send_fast_notify">
 	<section id="presence.p.send_fast_notify">
 		<title><varname>send_fast_notify</varname> (int)</title>
 		<title><varname>send_fast_notify</varname> (int)</title>
 		<para>
 		<para>
-		This parameter enables or disables the sending of an initial empty NOTIFY after a SUBSCRIBE/reSUBSCRIBE. 
+		This parameter enables or disables the sending of an initial empty NOTIFY after a SUBSCRIBE/reSUBSCRIBE.
 		This caused problems for MWI application, because some CPEs (like Samsung) fail to understand an empty
 		This caused problems for MWI application, because some CPEs (like Samsung) fail to understand an empty
 		NOTIFY to an message-summary event. This parameter is enabled by default, thus addering to the standard.
 		NOTIFY to an message-summary event. This parameter is enabled by default, thus addering to the standard.
 		</para>
 		</para>
@@ -638,8 +638,8 @@ modparam("presence", "fetch_rows", 1000)
 		with a MySQL-Databases in "DB-Only" mode.
 		with a MySQL-Databases in "DB-Only" mode.
 	    </para>
 	    </para>
 	    <para>
 	    <para>
-		In order to use the Presence-Module in "DB_ONLY"-mode with a 
-		MySQL-Backend, set this parameter to "0", otherwise the 
+		In order to use the Presence-Module in "DB_ONLY"-mode with a
+		MySQL-Backend, set this parameter to "0", otherwise the
 		MySQL-Operations will fail. The Presence-Module will generate
 		MySQL-Operations will fail. The Presence-Module will generate
 		a "500 Server error" due to the failed MySQL-queries.
 		a "500 Server error" due to the failed MySQL-queries.
 	    </para>
 	    </para>
@@ -794,17 +794,17 @@ modparam("presence", "retrieve_order", 1)
 		<function moreinfo="none">handle_publish([sender_uri])</function>
 		<function moreinfo="none">handle_publish([sender_uri])</function>
 		</title>
 		</title>
 		<para>
 		<para>
-		Handles PUBLISH requests by storing and updating 
-		published information in memory cache and database, then calls functions to send 
+		Handles PUBLISH requests by storing and updating
+		published information in memory cache and database, then calls functions to send
 		NOTIFY messages when changes in the published information occur.
 		NOTIFY messages when changes in the published information occur.
-		It takes one argument -> sender_uri. The parameter was added 
+		It takes one argument -> sender_uri. The parameter was added
 		for enabling BLA implementation. If present, notification of
 		for enabling BLA implementation. If present, notification of
 		a change in published state is not sent to the respective uri
 		a change in published state is not sent to the respective uri
 		even though a subscription exists.
 		even though a subscription exists.
 		It should be taken from the Sender header. It was left at the
 		It should be taken from the Sender header. It was left at the
-		decision of the administrator whether or not to transmit the 
-		content of this header as parameter for handle_publish, to 
-		prevent security problems.  
+		decision of the administrator whether or not to transmit the
+		content of this header as parameter for handle_publish, to
+		prevent security problems.
 		</para>
 		</para>
 		<para>
 		<para>
 		This function can be used from REQUEST_ROUTE.
 		This function can be used from REQUEST_ROUTE.
@@ -840,7 +840,7 @@ modparam("presence", "retrieve_order", 1)
 		else
 		else
 			handle_publish();
 			handle_publish();
 		t_release();
 		t_release();
-	} 
+	}
 ...
 ...
 </programlisting>
 </programlisting>
 		</example>
 		</example>
@@ -851,8 +851,8 @@ modparam("presence", "retrieve_order", 1)
 		<function moreinfo="none">handle_subscribe([watcher_uri])</function>
 		<function moreinfo="none">handle_subscribe([watcher_uri])</function>
 		</title>
 		</title>
 		<para>
 		<para>
-		The function which handles SUBSCRIBE requests. It stores or 
-		updates information in memory and database and calls functions to send NOTIFY 
+		The function which handles SUBSCRIBE requests. It stores or
+		updates information in memory and database and calls functions to send NOTIFY
 		messages when a SUBSCRIBE which initiate a dialog is received.
 		messages when a SUBSCRIBE which initiate a dialog is received.
 		</para>
 		</para>
 		<para>
 		<para>
@@ -1131,11 +1131,11 @@ pres_update_watchers("sip:[email protected]", "presence");
 
 
 <section>
 <section>
 	<title>Pseudo Variables</title>
 	<title>Pseudo Variables</title>
-		
+
 		<section>
 		<section>
 			<title><varname>$subs(attr)</varname></title>
 			<title><varname>$subs(attr)</varname></title>
 			<para>
 			<para>
-				Access the attributes of handled subscription. 
+				Access the attributes of handled subscription.
 				It must be used after a successful call of
 				It must be used after a successful call of
 				<quote>handle_subscription()</quote> or in the following events.
 				<quote>handle_subscription()</quote> or in the following events.
 			<itemizedlist>
 			<itemizedlist>
@@ -1147,7 +1147,7 @@ pres_update_watchers("sip:[email protected]", "presence");
 				<para><emphasis>present:notify-reply</emphasis> - after notify is sent
 				<para><emphasis>present:notify-reply</emphasis> - after notify is sent
 				</para>
 				</para>
 				</listitem>
 				</listitem>
-			</itemizedlist>	  
+			</itemizedlist>
 			</para>
 			</para>
 			<para>
 			<para>
 			The <quote>attr</quote> can be:
 			The <quote>attr</quote> can be:
@@ -1156,27 +1156,27 @@ pres_update_watchers("sip:[email protected]", "presence");
 				<listitem>
 				<listitem>
 				<para><emphasis>uri</emphasis> - subscription presentity uri
 				<para><emphasis>uri</emphasis> - subscription presentity uri
 				</para>
 				</para>
-				</listitem>	  
+				</listitem>
 				<listitem>
 				<listitem>
 				<para><emphasis>pres_uri</emphasis> - alias for presentity uri
 				<para><emphasis>pres_uri</emphasis> - alias for presentity uri
 				</para>
 				</para>
-				</listitem>	  
+				</listitem>
 				<listitem>
 				<listitem>
 				<para><emphasis>to_user</emphasis>
 				<para><emphasis>to_user</emphasis>
 				</para>
 				</para>
-				</listitem>	  
+				</listitem>
 				<listitem>
 				<listitem>
 				<para><emphasis>to_domain</emphasis>
 				<para><emphasis>to_domain</emphasis>
 				</para>
 				</para>
-				</listitem>	  
+				</listitem>
 				<listitem>
 				<listitem>
 				<para><emphasis>from_user</emphasis>
 				<para><emphasis>from_user</emphasis>
 				</para>
 				</para>
-				</listitem>	  
+				</listitem>
 				<listitem>
 				<listitem>
 				<para><emphasis>from_domain</emphasis>
 				<para><emphasis>from_domain</emphasis>
 				</para>
 				</para>
-				</listitem>	  
+				</listitem>
 				<listitem>
 				<listitem>
 				<para><emphasis>watcher_username</emphasis>
 				<para><emphasis>watcher_username</emphasis>
 				</para>
 				</para>
@@ -1263,18 +1263,18 @@ if(handle_subscription())
 				 </programlisting>
 				 </programlisting>
 			</example>
 			</example>
 		</section>
 		</section>
-		
+
 		<section>
 		<section>
 			<title><varname>$notify_reply(attr)</varname></title>
 			<title><varname>$notify_reply(attr)</varname></title>
 			<para>
 			<para>
-				Access the reply message received when notifying subscriber. 
+				Access the reply message received when notifying subscriber.
 				It must be used in the following events.
 				It must be used in the following events.
 			<itemizedlist>
 			<itemizedlist>
 				<listitem>
 				<listitem>
 				<para><emphasis>present:notify-reply</emphasis> - after notify is sent
 				<para><emphasis>present:notify-reply</emphasis> - after notify is sent
 				</para>
 				</para>
 				</listitem>
 				</listitem>
-			</itemizedlist>	  
+			</itemizedlist>
 			</para>
 			</para>
 			<para>
 			<para>
 			The <quote>attr</quote> can be any pseudo var that accesses attributes of msg
 			The <quote>attr</quote> can be any pseudo var that accesses attributes of msg
@@ -1320,8 +1320,8 @@ event_route[presence:notify-reply]
 	<title>Installation</title>
 	<title>Installation</title>
 	<para>
 	<para>
 	The module requires 3 tables in the &kamailio; database: "presentity",
 	The module requires 3 tables in the &kamailio; database: "presentity",
-	"active_watchers" and "watchers". The SQL 
-	syntax to create them can be found in presence-create.sql     
+	"active_watchers" and "watchers". The SQL
+	syntax to create them can be found in presence-create.sql
 	script in the database directories in the kamailio/scripts folder.
 	script in the database directories in the kamailio/scripts folder.
 	You can also find the complete database documentation on the
 	You can also find the complete database documentation on the
 	project webpage, &kamailiodbdocslink;.
 	project webpage, &kamailiodbdocslink;.