Browse code

all: fixed matrix doc generation and updates for &defaultdb;

Daniel-Constantin Mierla authored on 18/10/2012 12:46:37
Showing 8 changed files
... ...
@@ -113,7 +113,7 @@
113 113
 		<para>
114 114
 		<emphasis>
115 115
 			Default value is 
116
-				<quote>mysql://openser:openserrw@localhost/openser</quote>.
116
+				<quote>&defaultdb;</quote>.
117 117
 		</emphasis>
118 118
 		</para>
119 119
 		<example>
... ...
@@ -44,6 +44,14 @@ Henning Westerholt
44 44
 
45 45
               6.1. Database setup
46 46
 
47
+   2. Module parameter for database access.
48
+
49
+        1. db_url (String)
50
+        2. matrix_table (String)
51
+        3. matrix_first_col (string)
52
+        4. matrix_second_col (string)
53
+        5. matrix_res_col (string)
54
+
47 55
    List of Examples
48 56
 
49 57
    1.1. Set db_url parameter
... ...
@@ -54,6 +62,11 @@ Henning Westerholt
54 62
    1.6. matrix usage
55 63
    1.7. reload_matrix usage
56 64
    1.8. Example database content - matrix table
65
+   2.1. Set db_url parameter
66
+   2.2. Set matrix_table parameter
67
+   2.3. Set matrix_first_col parameter
68
+   2.4. Set matrix_second_col parameter
69
+   2.5. Set matrix_res_col parameter
57 70
 
58 71
 Chapter 1. Admin Guide
59 72
 
... ...
@@ -237,4 +250,61 @@ kamctl fifo reload_matrix
237 250
 +---------+--------------+---------+
238 251
 ...
239 252
 
240
-   <xi:include></xi:include>
253
+Chapter 2. Module parameter for database access.
254
+
255
+   Table of Contents
256
+
257
+   1. db_url (String)
258
+   2. matrix_table (String)
259
+   3. matrix_first_col (string)
260
+   4. matrix_second_col (string)
261
+   5. matrix_res_col (string)
262
+
263
+1. db_url (String)
264
+
265
+   URL to the database containing the data.
266
+
267
+   Default value is "mysql://openserro:openserro@localhost/openser".
268
+
269
+   Example 2.1. Set db_url parameter
270
+...
271
+modparam("matrix", "db_url", "dbdriver://username:password@dbhost/dbname")
272
+...
273
+
274
+2. matrix_table (String)
275
+
276
+   Name of the matrix table for the matrix module.
277
+
278
+   Default value is "matrix".
279
+
280
+   Example 2.2. Set matrix_table parameter
281
+...
282
+modparam("matrix", "matrix_table", "matrix")
283
+...
284
+
285
+3. matrix_first_col (string)
286
+
287
+   The row index in the matrix
288
+
289
+   Example 2.3. Set matrix_first_col parameter
290
+...
291
+modparam("matrix", "matrix_first_col", "first")
292
+...
293
+
294
+4. matrix_second_col (string)
295
+
296
+   The column index in the matrix
297
+
298
+   Example 2.4. Set matrix_second_col parameter
299
+...
300
+modparam("matrix", "matrix_second_col", "second")
301
+...
302
+
303
+5. matrix_res_col (string)
304
+
305
+   The resource contained in the matrix
306
+
307
+   Example 2.5. Set matrix_res_col parameter
308
+...
309
+modparam("matrix", "matrix_res_col", "res")
310
+...
... ...
@@ -1,3 +1,13 @@
1
+<?xml version="1.0" encoding='ISO-8859-1'?>
2
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
+
5
+<!-- Include general documentation entities -->
6
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
7
+%docentities;
8
+
9
+]>
10
+
1 11
 <!--
2 12
 WARNING:
3 13
 This file was autogenerated from the XML source file
... ...
@@ -834,7 +834,7 @@
834 834
 		<programlisting format="linespecific">
835 835
 ...
836 836
 modparam("drouting", "db_url", 
837
-	"mysql://openser:openserrw@localhost/openser")
837
+	"&defaultdb;")
838 838
 ...
839 839
 </programlisting>
840 840
 		</example>
... ...
@@ -304,7 +304,7 @@ modparam("htable", "htable", "c=&gt;size=4;autoexpire=7200;initval=1;")
304 304
 		<title>Set <varname>db_url</varname> parameter</title>
305 305
 		<programlisting format="linespecific">
306 306
 ...
307
-modparam("htable", "db_url", "mysql://openser:openserrw@localhost/openser")
307
+modparam("htable", "db_url", "&defaultdb;")
308 308
 ...
309 309
 </programlisting>
310 310
 		</example>
... ...
@@ -101,7 +101,7 @@
101 101
 		<para>
102 102
 		<emphasis>
103 103
 			Default value is 
104
-			<quote>mysql://openser:openserrw@localhost/openser</quote>.
104
+			<quote>&defaultdb;</quote>.
105 105
 		</emphasis>
106 106
 		</para>
107 107
 		<example>
... ...
@@ -368,7 +368,7 @@ modparam("uac","auth_password_avp","$avp(i:12)")
368 368
 				<programlisting format="linespecific">
369 369
 ...
370 370
 modparam("uac", "reg_db_url",
371
-    "mysql://openser:openserrw@localhost/openser")
371
+    "&defaultdb;")
372 372
 ...
373 373
 				</programlisting>
374 374
 			</example>
... ...
@@ -121,7 +121,7 @@
121 121
 		<para>
122 122
 		<emphasis>
123 123
 			Default value is 
124
-			<quote>mysql://openser:openserrw@localhost/openser</quote>.
124
+			<quote>&defaultdb;</quote>.
125 125
 		</emphasis>
126 126
 		</para>
127 127
 		<example>
... ...
@@ -339,7 +339,7 @@ loadmodule "xcap_server.so"
339 339
 
340 340
 # ----- xcap_server params -----
341 341
 modparam("xcap_server", "db_url",
342
-	"mysql://openser:openserrw@localhost/openser")
342
+	"&defaultdb;")
343 343
 
344 344
 ...
345 345