[SR-Dev] git:janakj/postgres: - modules documentation migrated from sgml to xml docbook format

Jan Janak jan at iptel.org
Wed Feb 18 01:26:20 CET 2009


Module: sip-router
Branch: janakj/postgres
Commit: b7e455c5cedde68bb979bc0d9506f9f1781f1f47
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b7e455c5cedde68bb979bc0d9506f9f1781f1f47

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Mar  7 18:19:45 2008 +0000

- 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_postgres/km_README                      |   51 ++++++++++++++++----
 .../km_doc/{db_postgres.sgml => db_postgres.xml}   |   14 +++--
 ...db_postgres_user.sgml => db_postgres_admin.xml} |    2 +-
 3 files changed, 50 insertions(+), 17 deletions(-)

diff --git a/modules/db_postgres/km_README b/modules/db_postgres/km_README
index fb8b0f4..062dc41 100644
--- a/modules/db_postgres/km_README
+++ b/modules/db_postgres/km_README
@@ -9,9 +9,13 @@ Edited by
 Greg Fausak
 
    Copyright © 2003 Greg Fausak
+   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
@@ -22,45 +26,72 @@ Greg Fausak
 
         1.3. Exported Parameters
         1.4. Exported Functions
-        1.5. Installation & Running
-     __________________________________________________________
+        1.5. Installation and Running
+
+   2. Frequently Asked Questions
 
 Chapter 1. User's Guide
 
 1.1. Overview
 
    Module description
-     __________________________________________________________
 
 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:
-
      * PostgreSQL library - e.g., libpq5.
      * PostgreSQL devel library - to compile the module (e.g.,
        libpq-dev).
-     __________________________________________________________
 
 1.3. Exported Parameters
 
    NONE
-     __________________________________________________________
 
 1.4. Exported Functions
 
    NONE
-     __________________________________________________________
 
-1.5. Installation & Running
+1.5. Installation and Running
 
    Notes about installation and running.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.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
+       <users at openser.org> and e-mails regarding development versions
+       should be sent to <devel at openser.org>.
+
+       If you want to keep the mail private, send it to
+       <team at openser.org>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.
diff --git a/modules/db_postgres/km_doc/db_postgres.sgml b/modules/db_postgres/km_doc/db_postgres.xml
similarity index 64%
rename from modules/db_postgres/km_doc/db_postgres.sgml
rename to modules/db_postgres/km_doc/db_postgres.xml
index 6fee313..40ab07b 100644
--- a/modules/db_postgres/km_doc/db_postgres.sgml
+++ b/modules/db_postgres/km_doc/db_postgres.xml
@@ -1,11 +1,13 @@
-<!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_postgres_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_postgres_admin.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;
 
 ]>
@@ -37,8 +39,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>
diff --git a/modules/db_postgres/km_doc/db_postgres_user.sgml b/modules/db_postgres/km_doc/db_postgres_admin.xml
similarity index 96%
rename from modules/db_postgres/km_doc/db_postgres_user.sgml
rename to modules/db_postgres/km_doc/db_postgres_admin.xml
index 85dc4e8..2a99096 100644
--- a/modules/db_postgres/km_doc/db_postgres_user.sgml
+++ b/modules/db_postgres/km_doc/db_postgres_admin.xml
@@ -59,7 +59,7 @@
 		</para>
 	</section>
 	<section>
-	<title>Installation & Running</title>
+	<title>Installation and Running</title>
 	<para>Notes about installation and running.</para>
 	</section>
 </chapter>




More information about the sr-dev mailing list