Browse Source

Changing database URL example to use entity

Making it easier when we change from "openserrw" to "kamailiorw"
Olle E. Johansson 13 years ago
parent
commit
827e2d4bba

+ 34 - 34
modules/carrierroute/README

@@ -12,7 +12,7 @@ Henning Westerholt
 
 
    1&1 Internet AG
    1&1 Internet AG
 
 
-   Copyright © 2007 1&1 Internet AG
+   Copyright © 2007 1&1 Internet AG
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -271,7 +271,7 @@ Chapter 1. Admin Guide
    use the lcr and dispatcher module.
    use the lcr and dispatcher module.
 
 
    Starting with version 3.1 , if you want to use this module in failure
    Starting with version 3.1 , if you want to use this module in failure
-   routes, it is not needed to call“append_branch()� after rewriting the
+   routes, it is not needed to call"append_branch()" after rewriting the
    request URI in order to relay the message to the new target. Its also
    request URI in order to relay the message to the new target. Its also
    supportes the usage of database derived failure routing descisions with
    supportes the usage of database derived failure routing descisions with
    the carrierfailureroute table.
    the carrierfailureroute table.
@@ -289,7 +289,7 @@ Chapter 1. Admin Guide
        needs the capability to issue raw queries. Its not possible to use
        needs the capability to issue raw queries. Its not possible to use
        the dbtext or db_berkeley module at the moment.
        the dbtext or db_berkeley module at the moment.
      * The tm module, when you want to use the $T_reply_code
      * The tm module, when you want to use the $T_reply_code
-       pseudo-variable in the “cr_next_domain� function.
+       pseudo-variable in the "cr_next_domain" function.
 
 
 2.2. External Libraries or Applications
 2.2. External Libraries or Applications
 
 
@@ -316,7 +316,7 @@ Chapter 1. Admin Guide
 
 
    The name of the table containing the subscribers
    The name of the table containing the subscribers
 
 
-   Default value is “subscriber�.
+   Default value is "subscriber".
 
 
    Example 1.1. Set subscriber_table parameter
    Example 1.1. Set subscriber_table parameter
 ...
 ...
@@ -328,7 +328,7 @@ modparam("carrierroute", "subscriber_table", "subscriber")
    The name of the column in the subscriber table containing the
    The name of the column in the subscriber table containing the
    usernames.
    usernames.
 
 
-   Default value is “username�.
+   Default value is "username".
 
 
    Example 1.2. Set subscriber_user_col parameter
    Example 1.2. Set subscriber_user_col parameter
 ...
 ...
@@ -340,7 +340,7 @@ modparam("carrierroute", "subscriber_user_col", "username")
    The name of the column in the subscriber table containing the domain of
    The name of the column in the subscriber table containing the domain of
    the subscriber.
    the subscriber.
 
 
-   Default value is “domain�.
+   Default value is "domain".
 
 
    Example 1.3. Set subscriber_domain_col parameter
    Example 1.3. Set subscriber_domain_col parameter
 ...
 ...
@@ -352,7 +352,7 @@ modparam("carrierroute", "subscriber_domain_col", "domain")
    The name of the column in the subscriber table containing the carrier
    The name of the column in the subscriber table containing the carrier
    id of the subscriber.
    id of the subscriber.
 
 
-   Default value is “cr_preferred_carrier�.
+   Default value is "cr_preferred_carrier".
 
 
    Example 1.4. Set subscriber_carrier_col parameter
    Example 1.4. Set subscriber_carrier_col parameter
 ...
 ...
@@ -364,7 +364,7 @@ modparam("carrierroute", "subscriber_carrier_col", "cr_preferred_carrier")
    Specifies whether the module loads its config data from a file or from
    Specifies whether the module loads its config data from a file or from
    a database. Possible values are file or db.
    a database. Possible values are file or db.
 
 
-   Default value is “file�.
+   Default value is "file".
 
 
    Example 1.5. Set config_source parameter
    Example 1.5. Set config_source parameter
 ...
 ...
@@ -375,7 +375,7 @@ modparam("carrierroute", "config_source", "file")
 
 
    Specifies the path to the config file.
    Specifies the path to the config file.
 
 
-   Default value is “/etc/kamailio/carrierroute.conf�.
+   Default value is "/etc/kamailio/carrierroute.conf".
 
 
    Example 1.6. Set config_file parameter
    Example 1.6. Set config_file parameter
 ...
 ...
@@ -387,7 +387,7 @@ modparam("carrierroute", "config_file", "/etc/kamailio/carrierroute.conf")
    The name of the carrier tree used per default (if the current
    The name of the carrier tree used per default (if the current
    subscriber has no preferred tree)
    subscriber has no preferred tree)
 
 
-   Default value is “default�.
+   Default value is "default".
 
 
    Example 1.7. Set default_tree parameter
    Example 1.7. Set default_tree parameter
 ...
 ...
@@ -400,7 +400,7 @@ modparam("carrierroute", "default_tree", "default")
    use the domain part for user matching or not. This parameter is tunable
    use the domain part for user matching or not. This parameter is tunable
    via the ser cfg framework.
    via the ser cfg framework.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
    Example 1.8. Set use_domain parameter
    Example 1.8. Set use_domain parameter
 ...
 ...
@@ -414,7 +414,7 @@ modparam("carrierroute", "use_domain", 0)
    1, the default tree is used. Otherwise, cr_user_rewrite_uri returns an
    1, the default tree is used. Otherwise, cr_user_rewrite_uri returns an
    error. This parameter is tunable via the ser cfg framework.
    error. This parameter is tunable via the ser cfg framework.
 
 
-   Default value is “1�.
+   Default value is "1".
 
 
    Example 1.9. Set fallback_default parameter
    Example 1.9. Set fallback_default parameter
 ...
 ...
@@ -429,7 +429,7 @@ modparam("carrierroute", "fallback_default", 1)
    The database driver must support the fetch_result() capability. This
    The database driver must support the fetch_result() capability. This
    parameter is tunable via the ser cfg framework.
    parameter is tunable via the ser cfg framework.
 
 
-   Default value is “2000�.
+   Default value is "2000".
 
 
    Example 1.10. Set fetch_rows parameter
    Example 1.10. Set fetch_rows parameter
 ...
 ...
@@ -445,7 +445,7 @@ modparam("carrierroute", "fetch_rows", 3000)
    matching. Please be aware that memory requirements for storing the
    matching. Please be aware that memory requirements for storing the
    routing tree in shared memory will also increase by a factor of 12.8.
    routing tree in shared memory will also increase by a factor of 12.8.
 
 
-   Default value is “10�.
+   Default value is "10".
 
 
    Example 1.11. Set match_mode parameter
    Example 1.11. Set match_mode parameter
 ...
 ...
@@ -482,13 +482,13 @@ cr_user_rewrite_uri(uri, domain)
 cr_tree_rewrite_uri(tree, domain)
 cr_tree_rewrite_uri(tree, domain)
 -> cr_route(tree, domain, "$rU", "$rU", "call_id")
 -> cr_route(tree, domain, "$rU", "$rU", "call_id")
 
 
-4.1.  cr_user_carrier(user, domain, dstavp)
+4.1. cr_user_carrier(user, domain, dstavp)
 
 
    This function loads the carrier and stores it in an AVP. It cannot be
    This function loads the carrier and stores it in an AVP. It cannot be
    used in the config file mode, as it needs a mapping of the given user
    used in the config file mode, as it needs a mapping of the given user
    to a certain carrier. The is derived from a database entry belonging to
    to a certain carrier. The is derived from a database entry belonging to
    the user parameter. This mapping must be available in the table that is
    the user parameter. This mapping must be available in the table that is
-   specified in the “subscriber_table� variable. This data is not cached
+   specified in the "subscriber_table" variable. This data is not cached
    in memory, that means for every execution of this function a database
    in memory, that means for every execution of this function a database
    query will be done.
    query will be done.
 
 
@@ -499,7 +499,7 @@ cr_tree_rewrite_uri(tree, domain)
        string any pseudo-variable could be used as input.
        string any pseudo-variable could be used as input.
      * dstavp - Name of the AVP where to store the carrier id.
      * dstavp - Name of the AVP where to store the carrier id.
 
 
-4.2.  cr_route(carrier, domain, prefix_matching, rewrite_user, hash_source,
+4.2. cr_route(carrier, domain, prefix_matching, rewrite_user, hash_source,
 descavp)
 descavp)
 
 
    This function searches for the longest match for the user given in
    This function searches for the longest match for the user given in
@@ -518,7 +518,7 @@ descavp)
 
 
    If flags and masks values are specified in the routing rule, they will
    If flags and masks values are specified in the routing rule, they will
    be compared by this function to the message flags. Specify a flag and
    be compared by this function to the message flags. Specify a flag and
-   mask value of “0� to match to all possible message flags (this is the
+   mask value of "0" to match to all possible message flags (this is the
    default value). If flags and mask are not zero, and no match to the
    default value). If flags and mask are not zero, and no match to the
    message flags is possible, no routing will be done. The calculation of
    message flags is possible, no routing will be done. The calculation of
    the hash and the load-balancing is done after the flags matching.
    the hash and the load-balancing is done after the flags matching.
@@ -541,7 +541,7 @@ descavp)
      * decsavp - Name of the AVP where to store the description. This
      * decsavp - Name of the AVP where to store the description. This
        parameter is optional.
        parameter is optional.
 
 
-4.3.  cr_nofallback_route(carrier, domain, prefix_matching, rewrite_user,
+4.3. cr_nofallback_route(carrier, domain, prefix_matching, rewrite_user,
 hash_source, descavp)
 hash_source, descavp)
 
 
    This function searches for the longest match for the user given in
    This function searches for the longest match for the user given in
@@ -582,7 +582,7 @@ hash_source, descavp)
      * descavp - Name of the AVP where to store the description. This
      * descavp - Name of the AVP where to store the description. This
        parameter is optional.
        parameter is optional.
 
 
-4.4.  cr_next_domain(carrier, domain, prefix_matching, host, reply_code,
+4.4. cr_next_domain(carrier, domain, prefix_matching, host, reply_code,
 dstavp)
 dstavp)
 
 
    This function searches for the longest match for the user given in
    This function searches for the longest match for the user given in
@@ -827,7 +827,7 @@ failure_route[1] {
    Don't use a hash index value of zero. If you ommit the hash completly,
    Don't use a hash index value of zero. If you ommit the hash completly,
    the module gives them a autogenerated value, starting from one.
    the module gives them a autogenerated value, starting from one.
 
 
-   Use the “NULL� prefix to specify an empty prefix in the config file.
+   Use the "NULL" prefix to specify an empty prefix in the config file.
    Please note that the prefix is matched against the request URI (or to
    Please note that the prefix is matched against the request URI (or to
    URI), if they did not contain a valid (numerical) URI, no match is
    URI), if they did not contain a valid (numerical) URI, no match is
    possible. So for loadbalancing purposes e.g. for your registrars, you
    possible. So for loadbalancing purposes e.g. for your registrars, you
@@ -918,21 +918,21 @@ domain register {
 +----+---------+--------+-------------+-------+------+---------------+
 +----+---------+--------+-------------+-------+------+---------------+
 ...
 ...
 
 
-   This table contains three routes to two gateways for the “49� prefix,
+   This table contains three routes to two gateways for the "49" prefix,
    and a default route for other prefixes over carrier 2 and carrier 1.
    and a default route for other prefixes over carrier 2 and carrier 1.
    The gateways for the default carrier will be used for functions that
    The gateways for the default carrier will be used for functions that
    don't support the user specific carrier lookup. The routing rules for
    don't support the user specific carrier lookup. The routing rules for
-   carrier 1 and carrier 2 for the “49� prefix contains a additional rule
+   carrier 1 and carrier 2 for the "49" prefix contains a additional rule
    with the domain 2, that can be used for example as fallback if the
    with the domain 2, that can be used for example as fallback if the
    gateways in domain 1 are not reachable. Two more fallback rules (domain
    gateways in domain 1 are not reachable. Two more fallback rules (domain
    3 and 4) for carrier 1 are also supplied to support the functionality
    3 and 4) for carrier 1 are also supplied to support the functionality
    of the carrierfailureroute table example that is provided in the next
    of the carrierfailureroute table example that is provided in the next
    section.
    section.
 
 
-   This table provides also a “carrier 1� routing rule for the “49�
+   This table provides also a "carrier 1" routing rule for the "49"
    prefix, that is only choosen if some message flags are set. If this
    prefix, that is only choosen if some message flags are set. If this
-   flags are not set, the other two rules are used. The “strip�, “mask�
-   and “comment� colums are omitted for brevity.
+   flags are not set, the other two rules are used. The "strip", "mask"
+   and "comment" colums are omitted for brevity.
 
 
    Example 1.21. Example database content - simple carrierfailureroute
    Example 1.21. Example database content - simple carrierfailureroute
    table
    table
@@ -945,10 +945,10 @@ domain register {
 +----+---------+--------+---------------+------------+-------------+
 +----+---------+--------+---------------+------------+-------------+
 ...
 ...
 
 
-   This table contains two failure routes for the “gw.carrier1-1� and “-2�
+   This table contains two failure routes for the "gw.carrier1-1" and "-2"
    gateways. For any (failure) reply code the respective next domain is
    gateways. For any (failure) reply code the respective next domain is
    choosen. After that no more failure routes are available, an error will
    choosen. After that no more failure routes are available, an error will
-   be returned from the “cr_next_domain� function. Not all table colums
+   be returned from the "cr_next_domain" function. Not all table colums
    are show here for brevity.
    are show here for brevity.
 
 
    For each failure route domain and carrier that is added to the
    For each failure route domain and carrier that is added to the
@@ -1011,7 +1011,7 @@ domain register {
 
 
 7.3. User specific routing
 7.3. User specific routing
 
 
-   For a functional routing the “cr_preferred_carrier� column must be
+   For a functional routing the "cr_preferred_carrier" column must be
    added to the subscriber table (or to the table and column that you
    added to the subscriber table (or to the table and column that you
    specified as modul parameter) to choose the actual carrier for the
    specified as modul parameter) to choose the actual carrier for the
    users.
    users.
@@ -1063,7 +1063,7 @@ Chapter 2. Module parameter for database access.
 
 
    URL to the database containing the data.
    URL to the database containing the data.
 
 
-   Default value is “mysql://openserro:openserro@localhost/openser�.
+   Default value is "mysql://openserro:openserro@localhost/openser".
 
 
    Example 2.1. Set db_url parameter
    Example 2.1. Set db_url parameter
 ...
 ...
@@ -1074,7 +1074,7 @@ modparam("carrierroute", "db_url", "dbdriver://username:password@dbhost/dbname")
 
 
    Name of the carrierroute table for the carrierroute module.
    Name of the carrierroute table for the carrierroute module.
 
 
-   Default value is “carrierroute�.
+   Default value is "carrierroute".
 
 
    Example 2.2. Set carrierroute_table parameter
    Example 2.2. Set carrierroute_table parameter
 ...
 ...
@@ -1217,7 +1217,7 @@ modparam("carrierroute", "carrierroute_description_col", "description")
 
 
    Name of the carrierfailureroute table for the carrierroute module.
    Name of the carrierfailureroute table for the carrierroute module.
 
 
-   Default value is “carrierfailureroute�.
+   Default value is "carrierfailureroute".
 
 
    Example 2.15. Set carrierfailureroute_table parameter
    Example 2.15. Set carrierfailureroute_table parameter
 ...
 ...
@@ -1328,7 +1328,7 @@ modparam("carrierroute", "carrierfailureroute_description_col", "description")
 
 
    Name of the carrier_name table for the carrierroute module.
    Name of the carrier_name table for the carrierroute module.
 
 
-   Default value is “carrier_name�.
+   Default value is "carrier_name".
 
 
    Example 2.26. Set carrier_name_table parameter
    Example 2.26. Set carrier_name_table parameter
 ...
 ...
@@ -1357,7 +1357,7 @@ modparam("carrierroute", "carrier_name_carrier_col", "carrier")
 
 
    Name of the domain_name table for the carrierroute module.
    Name of the domain_name table for the carrierroute module.
 
 
-   Default value is “domain_name�.
+   Default value is "domain_name".
 
 
    Example 2.29. Set domain_name_table parameter
    Example 2.29. Set domain_name_table parameter
 ...
 ...

+ 1 - 1
modules/carrierroute/doc/carrierroute_db.xml

@@ -23,7 +23,7 @@ ALL CHANGES DONE HERE WILL BE LOST IF THE FILE IS REGENERATED
     <title><varname>db_url</varname> (String)</title>
     <title><varname>db_url</varname> (String)</title>
     <para>URL to the database containing the data.</para>
     <para>URL to the database containing the data.</para>
     <para>
     <para>
-      <emphasis>Default value is <quote>mysql://openserro:openserro@localhost/openser</quote>.</emphasis>
+      <emphasis>Default value is <quote>&defaultrodb;</quote>.</emphasis>
     </para>
     </para>
     <example>
     <example>
       <title>Set <varname>db_url</varname> parameter</title>
       <title>Set <varname>db_url</varname> parameter</title>

+ 22 - 22
modules/dialplan/README

@@ -12,9 +12,9 @@ Edited by
 
 
 Juha Heinanen
 Juha Heinanen
 
 
-   Copyright © 2007-2008 Voice Sistem SRL
+   Copyright © 2007-2008 Voice Sistem SRL
 
 
-   Copyright © 2008-2010 Juha Heinanen
+   Copyright © 2008-2010 Juha Heinanen
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -127,11 +127,11 @@ Chapter 1. Admin Guide
 
 
    This module implements generic string translations based on matching
    This module implements generic string translations based on matching
    and replacement rules. It can be used to manipulate Request URI or a PV
    and replacement rules. It can be used to manipulate Request URI or a PV
-   and to translated to a new format/value.
+   and to translate to a new format/value.
 
 
 2. How it works
 2. How it works
 
 
-   At startup, the module will load a set of transformation rules from a
+   At startup the module will load a set of transformation rules from a
    database. Every database row will be stored in memory as a translation
    database. Every database row will be stored in memory as a translation
    rule. Each rule will describe how the matching should be made, how the
    rule. Each rule will describe how the matching should be made, how the
    input value should be modified and which attributes should be set for
    input value should be modified and which attributes should be set for
@@ -146,15 +146,15 @@ Chapter 1. Admin Guide
    to the rule, this will be returned to the script along with the output
    to the rule, this will be returned to the script along with the output
    value.
    value.
 
 
-   The first matching rule will be processed.
+   Only the first matching rule will be processed.
 
 
 3. Usage cases
 3. Usage cases
 
 
-   The module can be used to implement dialplans - do to auto completion
-   of the dial numbers (like national to international), to convert
+   The module can be used to implement dialplans - to do auto completion
+   of the dialed numbers (like national to international), to convert
    generic numbers to specific numbers (like for emergency numbers).
    generic numbers to specific numbers (like for emergency numbers).
 
 
-   The module can also be used for detecting range or sets of numbers
+   The module can also be used for detecting a range or sets of numbers
    mapped on a service/case - attribute string can be used here to store
    mapped on a service/case - attribute string can be used here to store
    extra information about the service/case.
    extra information about the service/case.
 
 
@@ -200,7 +200,7 @@ Chapter 1. Admin Guide
 
 
    The translation rules will be loaded using this database URL.
    The translation rules will be loaded using this database URL.
 
 
-   Default value is “mysql://openser:openserrw@localhost/openser�.
+   Default value is "mysql://openser:openserrw@localhost/openser".
 
 
    Example 1.1. Set db_url parameter
    Example 1.1. Set db_url parameter
 ...
 ...
@@ -211,7 +211,7 @@ modparam("dialplan", "db_url", "mysql://user:passwb@localhost/db")
 
 
    The table's name from which to load the translation rules.
    The table's name from which to load the translation rules.
 
 
-   Default value is “dialplan�.
+   Default value is "dialplan".
 
 
    Example 1.2. Set table_name parameter
    Example 1.2. Set table_name parameter
 ...
 ...
@@ -222,7 +222,7 @@ modparam("dialplan", "table_name", "my_table")
 
 
    The column name used to store the dialplan ID group.
    The column name used to store the dialplan ID group.
 
 
-   Default value is “dpid�.
+   Default value is "dpid".
 
 
    Example 1.3. Set dpid_col parameter
    Example 1.3. Set dpid_col parameter
 ...
 ...
@@ -234,7 +234,7 @@ modparam("dialplan", "dpid_col", "column_name")
    The column name used to store the priority of the corresponding rule
    The column name used to store the priority of the corresponding rule
    from the database row.
    from the database row.
 
 
-   Default value is “pr�.
+   Default value is "pr".
 
 
    Example 1.4. Set pr_col parameter
    Example 1.4. Set pr_col parameter
 ...
 ...
@@ -245,7 +245,7 @@ modparam("dialplan", "pr_col", "column_name")
 
 
    The column name used to store the type of matching of the rule.
    The column name used to store the type of matching of the rule.
 
 
-   Default value is “match_op�.
+   Default value is "match_op".
 
 
    Example 1.5. Set match_op_col parameter
    Example 1.5. Set match_op_col parameter
 ...
 ...
@@ -256,7 +256,7 @@ modparam("dialplan", "match_op_col", "column_name")
 
 
    The column name to store the rule match expression.
    The column name to store the rule match expression.
 
 
-   Default value is “match_exp�.
+   Default value is "match_exp".
 
 
    Example 1.6. Set match_exp_col parameter
    Example 1.6. Set match_exp_col parameter
 ...
 ...
@@ -268,7 +268,7 @@ modparam("dialplan", "match_exp_col", "column_name")
    The column name to store the length of a string matching the match
    The column name to store the length of a string matching the match
    expression.
    expression.
 
 
-   Default value is “match_len�.
+   Default value is "match_len".
 
 
    Example 1.7. Set pr_col parameter
    Example 1.7. Set pr_col parameter
 ...
 ...
@@ -279,7 +279,7 @@ modparam("dialplan", "match_len_col", "column_name")
 
 
    The column name to store the rule's substitution expression.
    The column name to store the rule's substitution expression.
 
 
-   Default value is “subst_exp�.
+   Default value is "subst_exp".
 
 
    Example 1.8. Set pr_col parameter
    Example 1.8. Set pr_col parameter
 ...
 ...
@@ -290,7 +290,7 @@ modparam("dialplan", "subst_exp_col", "column_name")
 
 
    The column name to store the rule's replacement expression.
    The column name to store the rule's replacement expression.
 
 
-   Default value is “repl_exp�.
+   Default value is "repl_exp".
 
 
    Example 1.9. Set repl_exp_col parameter
    Example 1.9. Set repl_exp_col parameter
 ...
 ...
@@ -302,7 +302,7 @@ modparam("dialplan", "repl_exp_col", "column_name")
    The column name to store the rule's attributes to be set to the
    The column name to store the rule's attributes to be set to the
    message.
    message.
 
 
-   Default value is “attrs�.
+   Default value is "attrs".
 
 
    Example 1.10. Set attrs_col parameter
    Example 1.10. Set attrs_col parameter
 ...
 ...
@@ -315,7 +315,7 @@ modparam("dialplan", "attrs_col", "column_name")
    (dp_translate() succeeds). This parameter can be an AVP or a SCRIPT
    (dp_translate() succeeds). This parameter can be an AVP or a SCRIPT
    VAR.
    VAR.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
    Example 1.11. Set attrs_pvar parameter
    Example 1.11. Set attrs_pvar parameter
 ...
 ...
@@ -326,7 +326,7 @@ modparam("dialplan", "attrs_pvar", "$avp(s:dest)")
 
 
    The number of rows to be fetched at once from database
    The number of rows to be fetched at once from database
 
 
-   Default value is “1000�.
+   Default value is "1000".
 
 
    Example 1.12. Set fetch_rows parameter
    Example 1.12. Set fetch_rows parameter
 ...
 ...
@@ -337,11 +337,11 @@ modparam("dialplan", "fetch_rows", 4000)
 
 
    6.1. dp_translate(id, [src[/dest]])
    6.1. dp_translate(id, [src[/dest]])
 
 
-6.1.  dp_translate(id, [src[/dest]])
+6.1. dp_translate(id, [src[/dest]])
 
 
    Will try to translate src into dest according to the translation rules
    Will try to translate src into dest according to the translation rules
    with dialplan ID equal to id. If src/dest is missing the default
    with dialplan ID equal to id. If src/dest is missing the default
-   parameter “ruri.user/ruri.user� will be used, thus translating the
+   parameter "ruri.user/ruri.user" will be used, thus translating the
    request uri user part. If only dest is missing, only matching and
    request uri user part. If only dest is missing, only matching and
    storing of matching rule's attributes is done.
    storing of matching rule's attributes is done.
 
 

+ 7 - 7
modules/dialplan/doc/dialplan_admin.xml

@@ -18,14 +18,14 @@
 	<para>
 	<para>
 	This module implements generic string translations based on matching and
 	This module implements generic string translations based on matching and
 	replacement rules. It can be used to manipulate Request URI or a PV and to 
 	replacement rules. It can be used to manipulate Request URI or a PV and to 
-	translated to a new format/value.
+	translate to a new format/value.
 	</para>
 	</para>
 	</section>
 	</section>
 
 
 	<section>
 	<section>
 	<title>How it works</title>
 	<title>How it works</title>
 	<para>
 	<para>
-	At startup, the module will load a set of transformation rules from a 
+	At startup the module will load a set of transformation rules from a 
 	database. Every database row will be stored in memory as a translation 
 	database. Every database row will be stored in memory as a translation 
 	rule. Each rule will describe how the matching should be made, how the 
 	rule. Each rule will describe how the matching should be made, how the 
 	input value should be modified and which attributes should be set for 
 	input value should be modified and which attributes should be set for 
@@ -42,19 +42,19 @@
 	the output value.
 	the output value.
 	</para>
 	</para>
 	<para>
 	<para>
-	<emphasis> The first matching rule will be processed.</emphasis>
+	<emphasis> Only the first matching rule will be processed.</emphasis>
 	</para>
 	</para>
 	</section>
 	</section>
 
 
 	<section>
 	<section>
 	<title>Usage cases</title>
 	<title>Usage cases</title>
 	<para>
 	<para>
-	The module can be used to implement dialplans - do to auto completion of 
-	the dial numbers (like national to international), to convert generic 
+	The module can be used to implement dialplans - to do auto completion of 
+	the dialed numbers (like national to international), to convert generic 
 	numbers to specific numbers (like for emergency numbers).
 	numbers to specific numbers (like for emergency numbers).
 	</para>
 	</para>
 	<para>
 	<para>
-	The module can also be used for detecting range or sets of numbers mapped 
+	The module can also be used for detecting a range or sets of numbers mapped 
 	on a service/case - attribute string can be used here to store extra 
 	on a service/case - attribute string can be used here to store extra 
 	information about the service/case.
 	information about the service/case.
 	</para>
 	</para>
@@ -113,7 +113,7 @@
 		<para>
 		<para>
 		<emphasis>
 		<emphasis>
 			Default value is 
 			Default value is 
-				<quote>mysql://openser:openserrw@localhost/openser</quote>.
+				<quote>&defaultdb;</quote>.
 		</emphasis>
 		</emphasis>
 		</para>
 		</para>
 		<example>
 		<example>

+ 10 - 80
modules/matrix/README

@@ -11,7 +11,7 @@ Henning Westerholt
    1&1 Internet AG
    1&1 Internet AG
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2008 1&1 Internet AG
+   Copyright © 2008 1&1 Internet AG
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -44,14 +44,6 @@ Henning Westerholt
 
 
               6.1. Database setup
               6.1. Database setup
 
 
-   2. Module parameter for database access.
-
-        1. db_url (String)
-        2. matrix_table (String)
-        3. matrix_first_col (string)
-        4. matrix_second_col (string)
-        5. matrix_res_col (string)
-
    List of Examples
    List of Examples
 
 
    1.1. Set db_url parameter
    1.1. Set db_url parameter
@@ -62,11 +54,6 @@ Henning Westerholt
    1.6. matrix usage
    1.6. matrix usage
    1.7. reload_matrix usage
    1.7. reload_matrix usage
    1.8. Example database content - matrix table
    1.8. Example database content - matrix table
-   2.1. Set db_url parameter
-   2.2. Set matrix_table parameter
-   2.3. Set matrix_first_col parameter
-   2.4. Set matrix_second_col parameter
-   2.5. Set matrix_res_col parameter
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
 
 
@@ -139,18 +126,18 @@ Chapter 1. Admin Guide
 
 
    The URL for the database connection.
    The URL for the database connection.
 
 
-   Default value is “mysql://openserro:openserro@localhost/openser�.
+   Default value is "mysql://openserro:openserro@localhost/openser".
 
 
    Example 1.1. Set db_url parameter
    Example 1.1. Set db_url parameter
 ...
 ...
-modparam("matrix", "db_url", "mysql://openserro:openserro@localhost/openser")
+modparam("matrix", "db_url", "mysql://user:password@hostname/mydatabase")
 ...
 ...
 
 
 3.2. matrix_table (string)
 3.2. matrix_table (string)
 
 
    The name of the table containing the matrix data.
    The name of the table containing the matrix data.
 
 
-   Default value is “matrix�.
+   Default value is "matrix".
 
 
    Example 1.2. Set matrix_table parameter
    Example 1.2. Set matrix_table parameter
 ...
 ...
@@ -161,7 +148,7 @@ modparam("matrix", "matrix_table", "matrix")
 
 
    The name of the column containing the first row in the matrix.
    The name of the column containing the first row in the matrix.
 
 
-   Default value is “first�.
+   Default value is "first".
 
 
    Example 1.3. Set matrix_first_col parameter
    Example 1.3. Set matrix_first_col parameter
 ...
 ...
@@ -172,7 +159,7 @@ modparam("matrix", "matrix_first_col", "first")
 
 
    The name of the column containing the second row in the matrix.
    The name of the column containing the second row in the matrix.
 
 
-   Default value is “second�.
+   Default value is "second".
 
 
    Example 1.4. Set matrix_second_col parameter
    Example 1.4. Set matrix_second_col parameter
 ...
 ...
@@ -183,7 +170,7 @@ modparam("matrix", "matrix_second_col", "second")
 
 
    The name of the column containing the result ID to be used.
    The name of the column containing the result ID to be used.
 
 
-   Default value is “res�.
+   Default value is "res".
 
 
    Example 1.5. Set matrix_res_col parameter
    Example 1.5. Set matrix_res_col parameter
 ...
 ...
@@ -194,7 +181,7 @@ modparam("matrix", "matrix_res_col", "res")
 
 
    4.1. matrix (string first, string second, string dstavp)
    4.1. matrix (string first, string second, string dstavp)
 
 
-4.1.  matrix (string first, string second, string dstavp)
+4.1. matrix (string first, string second, string dstavp)
 
 
    Looks up the desired result ID in the matrix for the given column and
    Looks up the desired result ID in the matrix for the given column and
    value and saves the result in dstavp. Returns false if the cell is not
    value and saves the result in dstavp. Returns false if the cell is not
@@ -213,7 +200,7 @@ cr_route("$avp(route_tree)", "$rd", "$rU", "$rU", "call_id");
 
 
    5.1. reload_matrix
    5.1. reload_matrix
 
 
-5.1.  reload_matrix
+5.1. reload_matrix
 
 
    Reloads the internal matrix representation from the database. This is
    Reloads the internal matrix representation from the database. This is
    necessary after entries in the database have been changed.
    necessary after entries in the database have been changed.
@@ -250,61 +237,4 @@ kamctl fifo reload_matrix
 +---------+--------------+---------+
 +---------+--------------+---------+
 ...
 ...
 
 
-Chapter 2. Module parameter for database access.
-
-   Table of Contents
-
-   1. db_url (String)
-   2. matrix_table (String)
-   3. matrix_first_col (string)
-   4. matrix_second_col (string)
-   5. matrix_res_col (string)
-
-1. db_url (String)
-
-   URL to the database containing the data.
-
-   Default value is “mysql://openserro:openserro@localhost/openser�.
-
-   Example 2.1. Set db_url parameter
-...
-modparam("matrix", "db_url", "dbdriver://username:password@dbhost/dbname")
-...
-
-2. matrix_table (String)
-
-   Name of the matrix table for the matrix module.
-
-   Default value is “matrix�.
-
-   Example 2.2. Set matrix_table parameter
-...
-modparam("matrix", "matrix_table", "matrix")
-...
-
-3. matrix_first_col (string)
-
-   The row index in the matrix
-
-   Example 2.3. Set matrix_first_col parameter
-...
-modparam("matrix", "matrix_first_col", "first")
-...
-
-4. matrix_second_col (string)
-
-   The column index in the matrix
-
-   Example 2.4. Set matrix_second_col parameter
-...
-modparam("matrix", "matrix_second_col", "second")
-...
-
-5. matrix_res_col (string)
-
-   The resource contained in the matrix
-
-   Example 2.5. Set matrix_res_col parameter
-...
-modparam("matrix", "matrix_res_col", "res")
-...
+   <xi:include></xi:include>

+ 2 - 2
modules/matrix/doc/matrix_admin.xml

@@ -69,14 +69,14 @@
 	  </para>
 	  </para>
 	  <para>
 	  <para>
 			<emphasis>
 			<emphasis>
-				Default value is <quote>mysql://openserro:openserro@localhost/openser</quote>.
+				Default value is <quote>&defaultrodb;</quote>.
 		  </emphasis>
 		  </emphasis>
 	  </para>
 	  </para>
 	  <example>
 	  <example>
 		  <title>Set <varname>db_url</varname> parameter</title>
 		  <title>Set <varname>db_url</varname> parameter</title>
 		  <programlisting format="linespecific">
 		  <programlisting format="linespecific">
 ...
 ...
-modparam("matrix", "db_url", "mysql://openserro:openserro@localhost/openser")
+modparam("matrix", "db_url", "mysql://user:password@hostname/mydatabase")
 ...
 ...
 		  </programlisting>
 		  </programlisting>
 	  </example>
 	  </example>

+ 1 - 1
modules/matrix/doc/matrix_db.xml

@@ -14,7 +14,7 @@ ALL CHANGES DONE HERE WILL BE LOST IF THE FILE IS REGENERATED
     <title><varname>db_url</varname> (String)</title>
     <title><varname>db_url</varname> (String)</title>
     <para>URL to the database containing the data.</para>
     <para>URL to the database containing the data.</para>
     <para>
     <para>
-      <emphasis>Default value is <quote>mysql://openserro:openserro@localhost/openser</quote>.</emphasis>
+      <emphasis>Default value is <quote>&defaultrodb;</quote>.</emphasis>
     </para>
     </para>
     <example>
     <example>
       <title>Set <varname>db_url</varname> parameter</title>
       <title>Set <varname>db_url</varname> parameter</title>