[sr-dev] git:master:c35088bf: geoip2: docs - section ids and formatting

Module: kamailio Branch: master Commit: c35088bf31b3e3e828433bf03b6ce647a75ef8e2 URL: https://github.com/kamailio/kamailio/commit/c35088bf31b3e3e828433bf03b6ce64… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2023-07-18T16:38:20+02:00 geoip2: docs - section ids and formatting --- Modified: src/modules/geoip2/doc/geoip2_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/c35088bf31b3e3e828433bf03b6ce64… Patch: https://github.com/kamailio/kamailio/commit/c35088bf31b3e3e828433bf03b6ce64… --- diff --git a/src/modules/geoip2/doc/geoip2_admin.xml b/src/modules/geoip2/doc/geoip2_admin.xml index 50a7d855fa8..cbc6ccb1493 100644 --- a/src/modules/geoip2/doc/geoip2_admin.xml +++ b/src/modules/geoip2/doc/geoip2_admin.xml @@ -11,26 +11,25 @@ <!-- Module User's Guide --> <chapter> - + <title>&adminguide;</title> - + <section> <title>Overview</title> <para> - This module allows real-time queries against the Max Mind GeoIP2 - database to be performed from the config script. + This module allows real-time queries against the Max Mind GeoIP2 + database to be performed from the config script. </para> <para> - The Max Mind GeoIP2 database is a map of IP network address assignments + The Max Mind GeoIP2 database is a map of IP network address assignments to geographical locales that can be useful -- though approximate -- in identifying the physical location with which an IP host address is associated on a relatively granular level. </para> <para> - This database itself can be obtained on a free or commercial basis + This database itself can be obtained on a free or commercial basis from <ulink url="http://dev.maxmind.com/geoip/"> - http://dev.maxmind.com/geoip/</ulink>nk>. The - library libmaxminddb + http://dev.maxmind.com/geoip/</ulink>nk>. The library libmaxminddb that interfaces with the Max Mind API, as well as scripts to automate downloading of the on-disk version are available at <ulink url="http://dev.maxmind.com/geoip/geoip2/downloadable/"> @@ -126,10 +125,10 @@ if(geoip2_match("$si", "src")) { </example> </section> </section> - + <section> <title>Functions</title> - <section> + <section id="geoip.f.geoip2_match"> <title> <function moreinfo="none">geoip2_match(ipaddr, pvc)</function> </title> @@ -149,7 +148,7 @@ if(geoip2_match("$si", "src")) </programlisting> </example> </section> - <section> + <section id="geoip.f.geoip2_distance"> <title> <function moreinfo="none">geoip2_distance(ip_addr, latitude, longitude)</function> </title> @@ -172,7 +171,7 @@ if(geoip2_match("$si", "src")) </programlisting> </example> </section> - + </section> <section> @@ -195,13 +194,13 @@ if(geoip2_match("$si", "src")) </example> </section> </section> - - <section> + + <section id="geoip.pvs"> <title>Exported pseudo-variables</title> <itemizedlist> <listitem><para> - <emphasis>$gip2(pvc=&gt;key)</emphasis> - <emphasis>pvc</emphasis> is an - identifier for this query result; it is designated by the second + <emphasis>$gip2(pvc=&gt;key)</emphasis> - <emphasis>pvc</emphasis> is an + identifier for this query result; it is designated by the second parameter of geoip2_match(). The <emphasis>key</emphasis> can be one of the following: </para>