[sr-dev] git:master: cfg_db: added docbook params.xml file

Module: sip-router Branch: master Commit: 138402b936a435b7e6722ba1e94dcb2ec4328e8a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=138402b… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Sat Oct 1 11:37:28 2011 +0200 cfg_db: added docbook params.xml file --- modules/cfg_db/README | 23 ++++++--------- modules/cfg_db/doc/cfg_db.xml | 58 +-------------------------------------- modules/cfg_db/doc/params.xml | 60 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+), 71 deletions(-) diff --git a/modules/cfg_db/README b/modules/cfg_db/README index 3653085..48763f1 100644 --- a/modules/cfg_db/README +++ b/modules/cfg_db/README @@ -4,7 +4,7 @@ Tomas Mandys Iptel.org - Copyright © 2008 Tomas Mandys + Copyright � 2008 Tomas Mandys __________________________________________________________________ 1.1. Overview @@ -15,8 +15,7 @@ Tomas Mandys 1.3.2. transl_tbl (string) := "cfg_transl" 1.3.3. custom_tbl (string) := "cfg_custom" - 1.4. Functions - 1.5. Examples + 1.4. Examples 1.1. Overview @@ -58,14 +57,14 @@ Tomas Mandys Default database URL. The format is: - db_url = database + db_url = database Example 1. Example db_url - loadmodule("mysql.so"); - loadmodule("cfg_db.so"); - ... - modparam("cfg_db", "db_url", "mysql://SER:123@127.0.0.1:12345/SER"); - ... +loadmodule("mysql.so"); +loadmodule("cfg_db.so"); +... +modparam("cfg_db", "db_url", "mysql://SER:123@127.0.0.1:12345/SER"); +... 1.3.2. transl_tbl (string) := "cfg_transl" @@ -82,11 +81,7 @@ Tomas Mandys Name of table used for extra param declaration (group_name, name, type, min/max value, description). -1.4. Functions - - None. - -1.5. Examples +1.4. Examples Example 2. Content of tables cfg_transl table: diff --git a/modules/cfg_db/doc/cfg_db.xml b/modules/cfg_db/doc/cfg_db.xml index 0ff00a3..d6e655c 100644 --- a/modules/cfg_db/doc/cfg_db.xml +++ b/modules/cfg_db/doc/cfg_db.xml @@ -67,63 +67,7 @@ </para> </section> - - <section id="cfg_db.parameters"> - - <title>Parameters</title> - - <section id="db_url"> - <title><varname>db_url</varname> (string)</title> - <para> - Default database URL. - </para> - <para> - The format is: - </para> - <programlisting> - db_url = database - </programlisting> - <example> - <title>Example <varname>db_url</varname></title> - <programlisting> - loadmodule("mysql.so"); - loadmodule("cfg_db.so"); - ... - modparam("cfg_db", "db_url", "mysql://&ser;:123@127.0.0.1:12345/&ser;"); - ... - </programlisting> - </example> - </section> - - <section id="transl_tbl"> - <title><varname>transl_tbl</varname> (string) := "cfg_transl"</title> - <para> - Name of table used for pointing group_name+name into - configuration table. If empty/null field values are found - then default values will be used. The default - values are declared in record having <emphasis>group_name</emphasis> - called <emphasis>&lt;default&gt;</emphasis>. The C-code - "absolutely" default values ("cfg_var", "group_name", "name", "value"). - The other keyword is asterisk <emphasis>*</emphasis> which matches - all parameters and will be used if parameter is not - explicitely mentioned. - </para> - </section> - <section id="custom_tbl"> - <title><varname>custom_tbl</varname> (string) := "cfg_custom"</title> - <para> - Name of table used for extra param declaration (group_name, name, - type, min/max value, description). - </para> - </section> - </section> - - <section id="cfg_db.functions"> - <title>Functions</title> - <para> - None. - </para> - </section> + <xi:include href="params.xml"/> <section id="cfg_db.examples"> <title>Examples</title> diff --git a/modules/cfg_db/doc/params.xml b/modules/cfg_db/doc/params.xml new file mode 100644 index 0000000..466e8b6 --- /dev/null +++ b/modules/cfg_db/doc/params.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> + +<section id="cfg_db.parameters" xmlns:xi="http://www.w3.org/2001/XInclude"> + + <title>Parameters</title> + + <section id="db_url"> + <title><varname>db_url</varname> (string)</title> + <para> + Default database URL. + </para> + <para> + The format is: + </para> + <programlisting> + db_url = database + </programlisting> + <example> + <title>Example <varname>db_url</varname></title> + <programlisting> +loadmodule("mysql.so"); +loadmodule("cfg_db.so"); +... +modparam("cfg_db", "db_url", "mysql://&ser;:123@127.0.0.1:12345/&ser;"); +... + </programlisting> + </example> + </section> + + <section id="transl_tbl"> + <title><varname>transl_tbl</varname> (string) := "cfg_transl"</title> + <para> + Name of table used for pointing group_name+name into + configuration table. If empty/null field values are found + then default values will be used. The default + values are declared in record having <emphasis>group_name</emphasis> + called <emphasis>&lt;default&gt;</emphasis>. The C-code + "absolutely" default values ("cfg_var", "group_name", "name", "value"). + The other keyword is asterisk <emphasis>*</emphasis> which matches + all parameters and will be used if parameter is not + explicitely mentioned. + </para> + </section> + <section id="custom_tbl"> + <title><varname>custom_tbl</varname> (string) := "cfg_custom"</title> + <para> + Name of table used for extra param declaration (group_name, name, + type, min/max value, description). + </para> + </section> +</section> + +