Browse code

- modules documentation migrated from sgml to xml docbook format - many thanks to Edson <4lists (at) gmail (dot) com> for providing script to replace headers and rename files - contact updated - follows re-sync with todays changes and update of Makefile to generate README and html files from XML

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3886 689a6050-402a-0410-94f2-e92a70836424

Daniel-Constantin Mierla authored on 07/03/2008 18:19:45
Showing 3 changed files
... ...
@@ -2,16 +2,18 @@ mysql Module
2 2
 
3 3
 Daniel-Constantin Mierla
4 4
 
5
-   voice-system.ro
6
-
7 5
 Edited by
8 6
 
9 7
 Daniel-Constantin Mierla
10 8
 
11 9
    Copyright � 2006 voice-system.ro
10
+   Revision History
11
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
12
+                              (Tue, 04 Mar 2008) $
12 13
      __________________________________________________________
13 14
 
14 15
    Table of Contents
16
+
15 17
    1. User's Guide
16 18
 
17 19
         1.1. Overview
... ...
@@ -29,11 +31,13 @@ Daniel-Constantin Mierla
29 31
         1.4. Exported Functions
30 32
         1.5. Installation
31 33
 
34
+   2. Frequently Asked Questions
35
+
32 36
    List of Examples
33
-   1-1. Set ping_interval parameter
34
-   1-2. Set timeout_interval parameter
35
-   1-3. Set auto_reconnect parameter
36
-     __________________________________________________________
37
+
38
+   1.1. Set ping_interval parameter
39
+   1.2. Set timeout_interval parameter
40
+   1.3. Set auto_reconnect parameter
37 41
 
38 42
 Chapter 1. User's Guide
39 43
 
... ...
@@ -41,25 +45,20 @@ Chapter 1. User's Guide
41 45
 
42 46
    This is a module which provides MySQL connectivity for OpenSER.
43 47
    It implements the DB API defined in OpenSER.
44
-     __________________________________________________________
45 48
 
46 49
 1.2. Dependencies
47 50
 
48 51
 1.2.1. OpenSER Modules
49 52
 
50 53
    The following modules must be loaded before this module:
51
-
52 54
      * No dependencies on other OpenSER modules.
53
-     __________________________________________________________
54 55
 
55 56
 1.2.2. External Libraries or Applications
56 57
 
57 58
    The following libraries or applications must be installed
58 59
    before running OpenSER with this module loaded:
59
-
60 60
      * libmysqlclient-dev - the development libraries of
61 61
        mysql-client.
62
-     __________________________________________________________
63 62
 
64 63
 1.3. Exported Parameters
65 64
 
... ...
@@ -70,11 +69,10 @@ Chapter 1. User's Guide
70 69
 
71 70
    Default value is 300 (5 min).
72 71
 
73
-   Example 1-1. Set ping_interval parameter
72
+   Example 1.1. Set ping_interval parameter
74 73
 ...
75 74
 modparam("db_mysql", "ping_interval", 600)
76 75
 ...
77
-     __________________________________________________________
78 76
 
79 77
 1.3.2. timeout_interval (integer)
80 78
 
... ...
@@ -89,11 +87,10 @@ modparam("db_mysql", "ping_interval", 600)
89 87
 
90 88
    Default value is 2 (6 sec).
91 89
 
92
-   Example 1-2. Set timeout_interval parameter
90
+   Example 1.2. Set timeout_interval parameter
93 91
 ...
94 92
 modparam("db_mysql", "timeout_interval", 2)
95 93
 ...
96
-     __________________________________________________________
97 94
 
98 95
 1.3.3. auto_reconnect (integer)
99 96
 
... ...
@@ -102,26 +99,56 @@ modparam("db_mysql", "timeout_interval", 2)
102 99
 
103 100
    Default value is 1 (1 - on / 0 - off).
104 101
 
105
-   Example 1-3. Set auto_reconnect parameter
102
+   Example 1.3. Set auto_reconnect parameter
106 103
 ...
107 104
 modparam("auto_reconnect", "auto_reconnect", 0)
108 105
 ...
109
-     __________________________________________________________
110 106
 
111 107
 1.4. Exported Functions
112 108
 
113 109
    No function exported to be used from configuration file.
114
-     __________________________________________________________
115 110
 
116 111
 1.5. Installation
117 112
 
118 113
    Because it dependes on an external library, the mysql module is
119 114
    not compiled and installed by default. You can use one of the
120 115
    next options.
121
-
122 116
      * - edit the "Makefile" and remove "db_mysql" from
123 117
        "excluded_modules" list. Then follow the standard procedure
124 118
        to install OpenSER: "make all; make install".
125 119
      * - from command line use: 'make all
126 120
        include_modules="db_mysql"; make install
127 121
        include_modules="db_mysql"'.
122
+
123
+Chapter 2. Frequently Asked Questions
124
+
125
+   2.1.
126
+
127
+       Where can I find more about OpenSER?
128
+
129
+       Take a look at http://openser.org/.
130
+
131
+   2.2.
132
+
133
+       Where can I post a question about this module?
134
+
135
+       First at all check if your question was already answered on one
136
+       of our mailing lists:
137
+         * User Mailing List -
138
+           http://openser.org/cgi-bin/mailman/listinfo/users
139
+         * Developer Mailing List -
140
+           http://openser.org/cgi-bin/mailman/listinfo/devel
141
+
142
+       E-mails regarding any stable OpenSER release should be sent to
143
+       <users@openser.org> and e-mails regarding development versions
144
+       should be sent to <devel@openser.org>.
145
+
146
+       If you want to keep the mail private, send it to
147
+       <team@openser.org>.
148
+
149
+   2.3.
150
+
151
+       How can I report a bug?
152
+
153
+       Please follow the guidelines provided at:
154
+       http://sourceforge.net/tracker/?group_id=139143.
128 155
similarity index 56%
129 156
rename from modules/db_mysql/km_doc/db_mysql.sgml
130 157
rename to modules/db_mysql/km_doc/db_mysql.xml
... ...
@@ -1,11 +1,13 @@
1
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
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" [
2 4
 
3 5
 
4
-<!ENTITY user SYSTEM "db_mysql_user.sgml">
5
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
6
+<!ENTITY user SYSTEM "db_mysql_admin.xml">
7
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
6 8
 
7 9
 <!-- Include general documentation entities -->
8
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
10
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
9 11
 %docentities;
10 12
 
11 13
 ]>
... ...
@@ -18,19 +20,15 @@
18 20
 	    <author>
19 21
 		<firstname>Daniel-Constantin</firstname>
20 22
 		<surname>Mierla</surname>
21
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
22 23
 		<address>
23
-		<email>daniel@voice-system.ro</email>
24
-		<otheraddr>
25
-		<ulink url="http://www.voice-system.ro">http://www.voice-system.ro</ulink>
26
-		</otheraddr>
24
+		<email>miconda@gmail.com</email>
27 25
 		</address>
28 26
 	    </author>
29 27
 	    <editor>
30 28
 		<firstname>Daniel-Constantin</firstname>
31 29
 		<surname>Mierla</surname>
32 30
 		<address>
33
-		    <email>danile@voice-system.ro</email>
31
+		    <email>miconda@gmail.com</email>
34 32
 		</address>
35 33
 	    </editor>
36 34
 	</authorgroup>
... ...
@@ -40,8 +38,8 @@
40 38
 	</copyright>
41 39
 	<revhistory>
42 40
 	    <revision>
43
-		<revnumber>$Revision$</revnumber>
44
-		<date>$Date$</date>
41
+		<revnumber>$Revision: 3839 $</revnumber>
42
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
45 43
 	    </revision>
46 44
 	</revhistory>
47 45
     </bookinfo>
48 46
similarity index 100%
49 47
rename from modules/db_mysql/km_doc/db_mysql_user.sgml
50 48
rename to modules/db_mysql/km_doc/db_mysql_admin.xml