- 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

modules/db_flatstore/km_README

@@ -9,9 +9,13 @@ Edited by
 Jan Janak
 
    Copyright © 2004, 2005 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -33,10 +37,11 @@ Jan Janak
               1.5.1. flat_rotate
 
    2. Developer's Guide
+   3. Frequently Asked Questions
 
    List of Examples
-   1-1. Set "flush" parameter
-     __________________________________________________________
+
+   1.1. Set "flush" parameter
 
 Chapter 1. User's Guide
 
@@ -86,7 +91,6 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
    the complete data for a table you can simply concatenate the
    contents of files with the same table name but different
    process id.
-     __________________________________________________________
 
 1.1.1. Rotating Log Files
 
@@ -96,7 +100,6 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
    rotation itself has to be done by another application (such as
    logrotate). Follow these steps to rotate files generated by
    flatstore module:
-
      * Rename the files that you want to rotate:
 cd /var/log/acc
 mv acc_1.log acc_1.log.20050605
@@ -116,24 +119,19 @@ openserctl fifo flat_rotate
        write. It is normal that the files will be not created
        immediately if there is no traffic on the proxy server.
      * Move the renamed files somewhere else and process them.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -143,20 +141,18 @@ openserctl fifo flat_rotate
 
    Default value is 1.
 
-   Example 1-1. Set "flush" parameter
+   Example 1.1. Set "flush" parameter
 ...
 modparam("db_flatstore", "flush", 0)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
    There are no function exported to routing script.
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
-1.5.1. flat_rotate
+1.5.1.  flat_rotate
 
    It changes the name of the files where it is written.
 
@@ -167,8 +163,40 @@ modparam("db_flatstore", "flush", 0)
    MI FIFO Command Format:
                 :flat_rotate:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
    The module implements the DB API.
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       Where can I post a question about this module?
+
+       First at all check if your question was already answered on one
+       of our mailing lists:
+         * User Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER release should be sent to
+       <[email protected]> and e-mails regarding development versions
+       should be sent to <[email protected]>.
+
+       If you want to keep the mail private, send it to
+       <[email protected]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules/db_flatstore/km_doc/db_flatstore.sgml → modules/db_flatstore/km_doc/db_flatstore.xml

@@ -1,12 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "db_flatstore_user.sgml">
-<!ENTITY devel SYSTEM "db_flatstore_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_flatstore_admin.xml">
+<!ENTITY devel SYSTEM "db_flatstore_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -39,8 +41,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>