Browse code

presence_xml: updated docs about integrated_xcap_server

(cherry picked from commit 8e35cef8716bbd0caa406a5080e93acb3c881c41)

Daniel-Constantin Mierla authored on 26/09/2013 11:23:46
Showing 2 changed files
... ...
@@ -8,7 +8,7 @@ Edited by
8 8
 
9 9
 Anca-Maria Vamanu
10 10
 
11
-   Copyright © 2007 Voice Sistem SRL
11
+   Copyright � 2007 Voice Sistem SRL
12 12
      __________________________________________________________________
13 13
 
14 14
    Table of Contents
... ...
@@ -144,7 +144,7 @@ Chapter 1. Admin Guide
144 144
 
145 145
    The database URL.
146 146
 
147
-   Default value is “mysql://openser:openserrw@localhost/openser”.
147
+   Default value is "mysql://kamailio:kamailiorw@localhost/kamailio".
148 148
 
149 149
    Example 1.1. Set db_url parameter
150 150
 ...
... ...
@@ -155,7 +155,7 @@ modparam("presence_xml", "db_url", "dbdriver://username:password@dbhost/dbname")
155 155
 
156 156
    The name of the database table where XCAP documents are stored.
157 157
 
158
-   Default value is “xcap”.
158
+   Default value is "xcap".
159 159
 
160 160
    Example 1.2. Set xcap_table parameter
161 161
 ...
... ...
@@ -166,7 +166,7 @@ modparam("presence_xml", "xcap_table", "xcaps")
166 166
 
167 167
    Set this parameter to disable the handling of the "presence" event.
168 168
 
169
-   Default value: “0”.
169
+   Default value: "0".
170 170
 
171 171
    Example 1.3. Set disable_presence parameter
172 172
 ...
... ...
@@ -178,7 +178,7 @@ modparam("presence_xml", "disable_presence", 1)
178 178
    Set this parameter to disable the handling of the "presence.winfo"
179 179
    event.
180 180
 
181
-   Default value: “0”.
181
+   Default value: "0".
182 182
 
183 183
    Example 1.4. Set disable_winfo parameter
184 184
 ...
... ...
@@ -189,7 +189,7 @@ modparam("presence_xml", "disable_winfo", 1)
189 189
 
190 190
    Set this parameter to disable the handling of the "dialog;sla" event.
191 191
 
192
-   Default value: “1” (0 - enabled, 1 - disabled).
192
+   Default value: "1" (0 - enabled, 1 - disabled).
193 193
 
194 194
    Example 1.5. Set disable_bla parameter
195 195
 ...
... ...
@@ -209,7 +209,7 @@ modparam("presence_xml", "disable_bla", 1)
209 209
    Note: When switching from one value to another, the watchers table must
210 210
    be emptied.
211 211
 
212
-   Default value is “0”.
212
+   Default value is "0".
213 213
 
214 214
    Example 1.6. Set force_active parameter
215 215
 ...
... ...
@@ -229,9 +229,9 @@ modparam("presence_xml", "force_active", 1)
229 229
    database and, if needed, send NOTIFY updates.
230 230
 
231 231
    Otherwise, it uses xcap_client module to fetch documents from the XCAP
232
-   servers with HTTP requests. This mode is currently not supported.
232
+   servers with HTTP requests.
233 233
 
234
-   Default value is “0”.
234
+   Default value is "0".
235 235
 
236 236
    Example 1.7. Set integrated_xcap_server parameter
237 237
 ...
... ...
@@ -257,7 +257,7 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
257 257
    no connection to database. Useful when needing only to use $xml(...)
258 258
    pseudoc-variable.
259 259
 
260
-   Default value: “0” (0 - active mode, 1 - passive mode).
260
+   Default value: "0" (0 - active mode, 1 - passive mode).
261 261
 
262 262
    Example 1.9. Set passive_mode parameter
263 263
 ...
... ...
@@ -274,7 +274,7 @@ modparam("presence_xml", "passive_mode", 1)
274 274
    ones defined by the RFC 3265, this parameter offers the possibility for
275 275
    the admin to decide which one he wishes to use.
276 276
 
277
-   Default value: “probation” . Since probation also accepts a retry-after
277
+   Default value: "probation" . Since probation also accepts a retry-after
278 278
    parameter to specify after at least how may seconds the client should
279 279
    reattempt to resubscribe, you can include this in the parameter also.
280 280
 
... ...
@@ -289,7 +289,7 @@ modparam("presence_xml", "xcapauth_userdel_reason", "rejected")
289 289
    4.1. pres_check_basic(presentity_uri, status)
290 290
    4.2. pres_check_activities(presentity_uri, activity)
291 291
 
292
-4.1.  pres_check_basic(presentity_uri, status)
292
+4.1. pres_check_basic(presentity_uri, status)
293 293
 
294 294
    Checks the /presence/tuple/status/basic nodes in the presentity for
295 295
    presentity_uri against the value in status.
... ...
@@ -312,7 +312,7 @@ modparam("presence_xml", "xcapauth_userdel_reason", "rejected")
312 312
     }
313 313
 ...
314 314
 
315
-4.2.  pres_check_activities(presentity_uri, activity)
315
+4.2. pres_check_activities(presentity_uri, activity)
316 316
 
317 317
    Checks whether a /presence/person/activities/activity node exists in
318 318
    the presentity for presentity_uri.
... ...
@@ -339,7 +339,7 @@ modparam("presence_xml", "xcapauth_userdel_reason", "rejected")
339 339
 
340 340
 5. Installation
341 341
 
342
-   The module requires one table in Kamailio database: “xcap”. The SQL
342
+   The module requires one table in Kamailio database: "xcap". The SQL
343 343
    syntax to create it can be found in presence-create.sql script in the
344 344
    database directories in the kamailio/scripts folder. You can also find
345 345
    the complete database documentation on the project webpage,
... ...
@@ -350,7 +350,7 @@ modparam("presence_xml", "xcapauth_userdel_reason", "rejected")
350 350
      * $xml(name=>spec)
351 351
 
352 352
    Exported pseudo-variables are documented at
353
-   http://www.kamailio.org/dokuwiki/.
353
+   http://www.kamailio.org/wiki/.
354 354
 
355 355
 Chapter 2. Developer Guide
356 356
 
... ...
@@ -235,8 +235,7 @@ modparam("presence_xml", "force_active", 1)
235 235
 		</para>
236 236
 		<para>
237 237
 		Otherwise, it uses xcap_client module to fetch documents 
238
-		from the XCAP servers with HTTP requests.  This mode is
239
-		currently not supported.</para>
238
+		from the XCAP servers with HTTP requests.</para>
240 239
 		<para>
241 240
 		<emphasis>Default value is <quote>0</quote>.
242 241
 		</emphasis>