[sr-dev] git:master: Minor stylistic edits to documentation.

Alex Balashov abalashov at evaristesys.com
Thu Jan 19 13:47:56 CET 2012


Module: sip-router
Branch: master
Commit: a88d2286d84653f634721d02cb29c6d1f1067117
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a88d2286d84653f634721d02cb29c6d1f1067117

Author: Alex Balashov <abalashov at evaristesys.com>
Committer: Alex Balashov <abalashov at evaristesys.com>
Date:   Thu Jan 19 07:41:12 2012 -0500

Minor stylistic edits to documentation.

---

 modules_k/presence_profile/README                  |   32 ++++++++++++--------
 .../presence_profile/doc/presence_profile.xml      |    5 +++
 .../doc/presence_profile_admin.xml                 |   18 +++++-----
 3 files changed, 33 insertions(+), 22 deletions(-)

diff --git a/modules_k/presence_profile/README b/modules_k/presence_profile/README
index ddf8e7a..c5f670e 100644
--- a/modules_k/presence_profile/README
+++ b/modules_k/presence_profile/README
@@ -1,16 +1,22 @@
 Presence_Profile Module
 
-Mihály Mészáros
+Mihály Mészáros
 
    <misi at niif.hu>
 
 Edited by
 
-Mészáros Mihály
+Mészáros Mihály
 
    <misi at niif.hu>
 
-   Copyright © 2011 Mészáros Mihály
+Edited by
+
+Alex Balashov
+
+   <abalashov at evaristesys.com>
+
+   Copyright © 2011 Mészáros Mihály
      __________________________________________________________________
 
    Table of Contents
@@ -41,18 +47,18 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   The module extends presence server implementation with ability of
-   handling ua-profile event. When an user agent subscribes to ua-profile
-   event for its own AoR, it will retrieve profile data document via body
-   of NOTIFY request.
+   The module extends the presence server implementation, providing the
+   ability to handle the 'ua-profile' event. When a user agent subscribes
+   to ua-profile event for its own AoR, it retrieves the profile data
+   document from the body of a NOTIFY request.
 
-   The profile data document format is usually specific per user agent,
-   such documents have to be built and added to presentity table by the
-   admin or a third party application.
+   The profile data document format is usually specific to the user agent.
+   Such documents have to be built and added to presentity table by either
+   the admin or a third party application.
 
-   Warning: When you add profile data document (i.e., user agent's
-   provisioning config) to presentity table, then you must make sure that
-   you set the presentity table expires field to a time value in long
+   Warning: When you add a profile data document (i.e. the user agent's
+   provisioning config) to the presentity table, you must make sure that
+   you set the presentity table expires field to a time value far in the
    future.
 
    Read more about SIP user agent configuration framework in RFC6080:
diff --git a/modules_k/presence_profile/doc/presence_profile.xml b/modules_k/presence_profile/doc/presence_profile.xml
index 9478a57..4968ba7 100644
--- a/modules_k/presence_profile/doc/presence_profile.xml
+++ b/modules_k/presence_profile/doc/presence_profile.xml
@@ -23,6 +23,11 @@
 		<surname>Mihály</surname>
   	        <email>misi at niif.hu</email>
 	    </editor>
+	    <editor>
+		<firstname>Alex</firstname>
+		<surname>Balashov</surname>
+		<email>abalashov at evaristesys.com</email>
+	    </editor>
 	</authorgroup>
 	<copyright>
 	    <year>2011</year>
diff --git a/modules_k/presence_profile/doc/presence_profile_admin.xml b/modules_k/presence_profile/doc/presence_profile_admin.xml
index 355159f..81e1b94 100644
--- a/modules_k/presence_profile/doc/presence_profile_admin.xml
+++ b/modules_k/presence_profile/doc/presence_profile_admin.xml
@@ -17,20 +17,20 @@
 	<section>
 	  <title>Overview</title>
 	    <para> 
-		The module extends presence server implementation with ability of
-		handling ua-profile event. When an user agent subscribes to ua-profile
-		event for its own AoR, it will retrieve profile data document
-		via body of NOTIFY request.
+		The module extends the presence server implementation, providing the ability 
+		to handle the 'ua-profile' event. When a user agent subscribes to ua-profile
+		event for its own AoR, it retrieves the profile data document from the body 
+		of a NOTIFY request.
 	    </para>
 	    <para>
-		The profile data document format is usually specific per user agent, such
-		documents have to be built and added to presentity table by the admin
+		The profile data document format is usually specific to the user agent. Such
+		documents have to be built and added to presentity table by either the admin
 		or a third party application.
 	    </para>
 	    <para>
-		Warning: When you add profile data document (i.e., user agent's
-		provisioning config) to presentity table, then you must make sure that you
-		set the presentity table expires field to a time value in long future.
+		Warning: When you add a profile data document (i.e. the user agent's
+		provisioning config) to the presentity table, you must make sure that you
+		set the presentity table expires field to a time value far in the future.
 	    </para>
 	    <para>
 		  Read more about SIP user agent configuration framework in RFC6080:




More information about the sr-dev mailing list