Browse code

lost: doc edits

- fixed typos
- added test information

Wolfgang Kampichler authored on 08/07/2020 20:30:09
Showing 2 changed files
... ...
@@ -25,7 +25,7 @@
25 25
 	    </editor>
26 26
 	</authorgroup>
27 27
 	<copyright>
28
-		<year>20018-2020</year>
28
+		<year>2018-2020</year>
29 29
 		<holder>Wolfgang Kampichler</holder>
30 30
 	</copyright>
31 31
 	</bookinfo>
... ...
@@ -69,8 +69,8 @@
69 69
                 loaded first in order to initialize connections properly.
70 70
                 </para></listitem>
71 71
                 <listitem><para>
72
-                TLS - if you use TLS connections (https) the tls module should be
73
-                loaded first in order to initialize &openssl; properly.
72
+                TLS - if you use TLS connections (https) the tls module
73
+                should be loaded first in order to initialize &openssl; properly.
74 74
                 </para></listitem>
75 75
 			    </itemizedlist>
76 76
             </para>
... ...
@@ -98,14 +98,14 @@
98 98
 	<section id="lost.p.general">
99 99
 		<title>Parameters</title>
100 100
         <para>
101
-        Besides parameters listed, this module uses <emphasis>http_client</emphasis> therefore
102
-        according parameters may apply.
101
+        Besides parameters listed, this module uses <emphasis>http_client</emphasis>
102
+        therefore according parameters may apply.
103 103
         </para>
104 104
         <section id="lost.p.exact_type">
105 105
             <title><varname>exact_type</varname> (int)</title>
106 106
             <para>
107
-            Indicates to the location server that the contents of the "location_type" parameter must
108
-            be strictly followed. Values are 0 (false) or 1 (true).
107
+            Indicates to the location server that the contents of the "location_type"
108
+            parameter must be strictly followed. Values are 0 (false) or 1 (true).
109 109
             </para>
110 110
             <para>
111 111
             Default: 0 (false)
... ...
@@ -181,8 +181,8 @@
181 181
 				<function moreinfo="none">lost_held_query(con, [id,] pidf-lo, url, error)</function>
182 182
 			</title>
183 183
 			<para>
184
-			Sends a HELD locationRequest to a given connection. The device identity is either specified,
185
-            or the P-A-I header value, or the From header value.
184
+			Sends a HELD locationRequest to a given connection. The device identity is either
185
+            specified, or the P-A-I header value, or the From header value.
186 186
 	    	</para>
187 187
 			    <itemizedlist>
188 188
 				    <listitem><para>
... ...
@@ -200,7 +200,7 @@
200 200
                     <listitem><para>
201 201
 						<emphasis>url</emphasis> - the location reference returned
202 202
                         in the HELD locationRequest response - this reference may be
203
-                        added as Geolocation header value and forwarded downstream
203
+                        added as Geolocation header value and forwarded downstream.
204 204
                         Note: to work properly, it is required to include "locationURI"
205 205
                         in the location_type parameter.
206 206
                     </para></listitem>
... ...
@@ -325,15 +325,20 @@ xlog("L_INFO", "LOST findService: Result code $var(res)\nUri: $var(uri)\nName: $
325 325
             (via http_client) and in case if you are using CentOS 6, be aware that
326 326
             standard libcurl-7.19.7-52 has a memory leak. To fix this memory, install
327 327
             libcurl from city-fan repository. More details at:
328
-            <ulink url="https://www.digitalocean.com/community/questions/how-to-upgrade-curl-in-centos6">
329
-            https://www.digitalocean.com/community/questions/how-to-upgrade-curl-in-centos6</ulink>
328
+            <ulink url="https://www.digitalocean.com/community/questions/how-to-upgrade-curl-in-centos6"></ulink>.
330 329
         </para>
331 330
         <para>
332 331
             Note: http_client_query exported by the http_client API returns by default the first line of
333 332
             the HTTP response, but the lost module requires the complete response message, otherwise
334 333
             dereferencing location via the HTTP URL provided with the Geolocation header causes an error.
335
-            Therefore, to work properly, it is required to set the http_client module parameter query_result to 0. More details at:
334
+            Therefore, to work properly, it is required to set the http_client module parameter query_result
335
+            to 0. More details at:
336 336
             <ulink url="https://www.kamailio.org/docs/modules/devel/modules/http_client.html#http_client.p.query_result"></ulink>.
337 337
         </para>
338
+        <para>
339
+            Note: to test the module with a mapping service (LOST), an API key may be requested under the
340
+            following link (search for "GET ACCESS"):
341
+            <ulink url="https://gridgears.at/"></ulink>.
342
+        </para>
338 343
     </section>
339 344
 </chapter>