Skip to content

Commit

Permalink
presence_dialoginfo: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Nov 13, 2023
1 parent 90c2fea commit 537e830
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions src/modules/presence_dialoginfo/doc/presence_dialoginfo.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@
</copyright>
</bookinfo>
<toc></toc>

<xi:include href="presence_dialoginfo_admin.xml"/>


</book>


42 changes: 21 additions & 21 deletions src/modules/presence_dialoginfo/doc/presence_dialoginfo_admin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,40 +10,40 @@
<!-- Module User's Guide -->

<chapter>


<title>&adminguide;</title>

<section>
<title>Overview</title>
<para>
The module enables the handling of "Event: dialog" (as defined
<para>
The module enables the handling of "Event: dialog" (as defined
in RFC 4235) inside of the presence module. This can be used
distribute the dialog-info status to the subscribed watchers.
</para>
<para>
The module does not currently implement any authorization
rules. It assumes that publish requests are only issued by
an authorized application and subscribe requests only by
authorized users. Authorization can thus be easily done in
&kamailio; configuration file before calling handle_publish()
authorized users. Authorization can thus be easily done in
&kamailio; configuration file before calling handle_publish()
and handle_subscribe() functions.
</para>
<para>
Note: This module only activates the processing of the "dialog"
in the presence module. To send dialog-info to watchers you also
Note: This module only activates the processing of the "dialog"
in the presence module. To send dialog-info to watchers you also
need a source which PUBLISH the dialog info to the presence module.
For example you can use the pua_dialoginfo module or any external
component. This approach allows to have the presence server and the
dialog-info aware publisher (e.g. the main proxy) on different
dialog-info aware publisher (e.g. the main proxy) on different
&kamailio; instances.
</para>
<para>
This module by default does body aggregation. That means, if the presence
This module by default does body aggregation. That means, if the presence
module received PUBLISH from multiple presentities (e.g. if the entity has
multiple dialogs the pua_dialoginfo will send multiple PUBLISH), the
module will parse all the received (and still valid, depending on the Expires
header in the PUBLISH request) XML documents and generate a single
module will parse all the received (and still valid, depending on the Expires
header in the PUBLISH request) XML documents and generate a single
XML document with multiple "dialog" elements. This is perfectly valid, but
unfortunately not supported by all SIP phones, e.g. Linksys SPA962 crashes
when it receives dialog-info with multiple dialog elements. In this case use
Expand Down Expand Up @@ -107,14 +107,14 @@ alice@example presence bob@example watcher@example
PUBLISH is received and handled by presence module. Presence
module updates the "presentity". Presence module checks for active watchers
of the presentity. It gives all the XML documents to presence_dialoginfo
module to aggregate them into a single XML document. Then it sends the
module to aggregate them into a single XML document. Then it sends the
NOTIFY with the aggregated XML document to all active watchers.
</para></listitem>
</itemizedlist>

The presence server can also be separated from the main proxy by using a separate
The presence server can also be separated from the main proxy by using a separate
&kamailio; instance as shown in the following figure. (Either set the outbound_proxy
parameter of pua module or make sure to route the "looped" PUBLISH requests from the
parameter of pua module or make sure to route the "looped" PUBLISH requests from the
main proxy to the presence server).

<programlisting format="linespecific">
Expand Down Expand Up @@ -153,7 +153,7 @@ alice@example server server bob@example watcher@example
Known issues:
<itemizedlist>
<listitem><para>
The "version" attribute is increased for every NOTIFY, even
The "version" attribute is increased for every NOTIFY, even
if the XML document has not changed. This is of course valid,
but not very smart.
</para></listitem>
Expand Down Expand Up @@ -187,7 +187,7 @@ alice@example server server bob@example watcher@example
</para>
</section>
</section>

<section>
<title>Parameters</title>

Expand All @@ -201,13 +201,13 @@ alice@example server server bob@example watcher@example
</para>
<para>
If this parameter is set, only the dialog element with the
currently most interesting dialog state will be put into the
currently most interesting dialog state will be put into the
dialog-info document. Thus, the dialog-info element will contain
only a single "dialog" element. The algorithm chooses the state
based on the following order of priority (least important first):
terminated, trying, proceeding, confirmed, early. Note: I consider
the "early" state more interesting than confirmed as often you might
want to pickup a call if the original callee is already busy in a
want to pickup a call if the original callee is already busy in a
call.
</para>
<para>
Expand All @@ -226,8 +226,8 @@ modparam("presence_dialoginfo", "force_single_dialog", 1)
<section>
<title><varname>force_dummy_dialog</varname> (int)</title>
<para>
By default the module returns null body
if there are no bodies to aggregate.
By default the module returns null body
if there are no bodies to aggregate.
some sip clients like Bria expect at least one dialog.
you can activate this parameter to send a dummy dialog.
</para>
Expand Down

0 comments on commit 537e830

Please sign in to comment.