Skip to content

Commit

Permalink
xcap_server: added section ids in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Nov 14, 2017
1 parent 387e2a8 commit ba3f64e
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions src/modules/xcap_server/doc/xcap_server_admin.xml
Expand Up @@ -10,9 +10,9 @@
<!-- Module User's Guide -->

<chapter>

<title>&adminguide;</title>

<section>
<title>Overview</title>
<para>
Expand Down Expand Up @@ -113,14 +113,14 @@
</section>
<section>
<title>Parameters</title>
<section>
<section id="xcap_server.p.db_url">
<title><varname>db_url</varname> (string)</title>
<para>
Database &url;.
</para>
<para>
<emphasis>
Default value is
Default value is
<quote>&defaultdb;</quote>.
</emphasis>
</para>
Expand All @@ -133,7 +133,7 @@ modparam("xcap_server", "db_url", "mysql://user:passwd@host.com/dbname")
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.p.xcap_table">
<title><varname>xcap_table</varname> (string)</title>
<para>
The name of table where to store the xcap documents.
Expand All @@ -152,7 +152,7 @@ modparam("xcap_server", "xcap_table", "xcapdocs")
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.p.xcap_root">
<title><varname>xcap_root</varname> (str)</title>
<para>
XCAP root URL.
Expand All @@ -171,7 +171,7 @@ modparam("xcap_server", "xcap_root", "/xcap-root/")
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.p.buf_size">
<title><varname>buf_size</varname> (int)</title>
<para>
Size of local buffer for handling XCAP documents.
Expand All @@ -190,7 +190,7 @@ modparam("xcap_server", "buf_size", 2048)
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.p.xml_ns">
<title><varname>xml_ns</varname> (str)</title>
<para>
Register extra XML namespaces to be used with XPath. You
Expand All @@ -214,7 +214,7 @@ modparam("xcap_server", "xml_ns",
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.p.directory_scheme">
<title><varname>directory_scheme (int)</varname></title>
<para>
Allows the scheme used in
Expand All @@ -240,7 +240,7 @@ modparam("xcap_server", "xml_ns",
<emphasis>0</emphasis> - use the HTTP scheme.
</para></listitem>
<listitem><para>
<emphasis>1</emphasis> - use the HTTPS scheme.
<emphasis>1</emphasis> - use the HTTPS scheme.
</para></listitem>
</itemizedlist>
<example>
Expand All @@ -252,7 +252,7 @@ modparam("xcap_server", "directory_scheme", 0)
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.p.directory_hostname">
<title><varname>directory_hostname (str)</varname></title>
<para>
Allows the hostname (and port) used in
Expand Down Expand Up @@ -288,7 +288,7 @@ modparam("xcap_server", "directory_hostname", "xcap.example.com")

<section>
<title>Functions</title>
<section>
<section id="xcap_server.f.xcaps_put">
<title>
<function moreinfo="none">xcaps_put(uri, path, doc)</function>
</title>
Expand All @@ -315,7 +315,7 @@ event_route[xhttp:request] {
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.f.xcaps_get">
<title>
<function moreinfo="none">xcaps_get(uri, path)</function>
</title>
Expand All @@ -342,7 +342,7 @@ event_route[xhttp:request] {
</programlisting>
</example>
</section>
<section>
<section id="xcap_server.f.xcaps_del">
<title>
<function moreinfo="none">xcaps_del(uri, path)</function>
</title>
Expand Down Expand Up @@ -372,7 +372,7 @@ event_route[xhttp:request] {
</section>

<section>
<title>Exported pseudo-variables</title>
<title>Pseudo Variables</title>
<itemizedlist>
<listitem><para>
<emphasis>$xcapuri(name=>key)</emphasis> - name can be any
Expand Down

0 comments on commit ba3f64e

Please sign in to comment.