Module: sip-router
Branch: janakj/postgres
Commit: b7e455c5cedde68bb979bc0d9506f9f1781f1f47
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b7e455c…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)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(a)openser.org> and e-mails regarding development versions
+ should be sent to <devel(a)openser.org>.
+
+ If you want to keep the mail private, send it to
+ <team(a)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>
Module: sip-router
Branch: janakj/postgres
Commit: 9a643843f917a64533b117224f398abccd196de8
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9a64384…
Author: Henning Westerholt <henning.westerholt(a)1und1.de>
Committer: Henning Westerholt <henning.westerholt(a)1und1.de>
Date: Tue Mar 4 13:15:47 2008 +0000
- change module docs FAQ link to a common one in the doc dir
- remove module specific FAQ content from the file in doc, this way no FAQ
content will be created
- credits for the patch/ the change scripts goes to Edson Gellert Schubert,
4lists at gmail dot com
- update all READMEs, for most module docs the FAQ and devel information were
now removed
git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3839 689a6050-402a-0410-94f2-e92a70836424
---
modules/db_postgres/km_README | 42 ----------------------
modules/db_postgres/km_doc/db_postgres.sgml | 4 +--
modules/db_postgres/km_doc/db_postgres_user.sgml | 3 +-
3 files changed, 2 insertions(+), 47 deletions(-)
diff --git a/modules/db_postgres/km_README b/modules/db_postgres/km_README
index ea5d68a..ffd49a6 100644
--- a/modules/db_postgres/km_README
+++ b/modules/db_postgres/km_README
@@ -23,9 +23,6 @@ Greg Fausak
1.3. Exported Parameters
1.4. Exported Functions
1.5. Installation & Running
-
- 2. Developer's Guide
- 3. Frequently Asked Questions
__________________________________________________________
Chapter 1. User's Guide
@@ -65,42 +62,3 @@ Chapter 1. User's Guide
1.5. Installation & Running
Notes about installation and running.
- __________________________________________________________
-
-Chapter 2. Developer's Guide
-
- The module does not provide any API to use in other OpenSER
- modules.
- __________________________________________________________
-
-Chapter 3. Frequently Asked Questions
-
- 3.1. Where can I find more about OpenSER?
- 3.2. Where can I post a question about this module?
- 3.3. How can I report a bug?
-
- 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
- <users(a)openser.org> and e-mails regarding development versions
- should be sent to <devel(a)openser.org>.
-
- If you want to keep the mail private, send it to
- <team(a)openser.org>.
-
- 3.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.sgml
index 0db3261..6fee313 100644
--- a/modules/db_postgres/km_doc/db_postgres.sgml
+++ b/modules/db_postgres/km_doc/db_postgres.sgml
@@ -2,8 +2,7 @@
<!ENTITY user SYSTEM "db_postgres_user.sgml">
-<!ENTITY devel SYSTEM "db_postgres_devel.sgml">
-<!ENTITY faq SYSTEM "db_postgres_faq.sgml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
@@ -46,7 +45,6 @@
<toc></toc>
&user;
- &devel;
&faq;
</book>
diff --git a/modules/db_postgres/km_doc/db_postgres_user.sgml b/modules/db_postgres/km_doc/db_postgres_user.sgml
index ab27eeb..a2b3350 100644
--- a/modules/db_postgres/km_doc/db_postgres_user.sgml
+++ b/modules/db_postgres/km_doc/db_postgres_user.sgml
@@ -1,8 +1,7 @@
<!-- Module User's Guide -->
<chapter>
- <chapterinfo>
- </chapterinfo>
+
<title>User's Guide</title>
<section>
Module: sip-router
Branch: janakj/postgres
Commit: 3407efd5f859e1f72ce2442bf778cf33c743afd1
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=3407efd…
Author: Henning Westerholt <henning.westerholt(a)1und1.de>
Committer: Henning Westerholt <henning.westerholt(a)1und1.de>
Date: Wed Feb 27 13:53:33 2008 +0000
- first round of cleanups for documentation
- remove all FAQ and DEVEL files considered empty in content (no content at all
or just the default lines)
- remove of the <RevHistory>/</RevHistory> tag (and of course anything between
them)
- remove the comments at the end of the file that begins with
"<!-- Keep this element at the end of the file"
- credits for the patch/ the change scripts goes to Edson Gellert Schubert,
4lists at gmail dot com
git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3769 689a6050-402a-0410-94f2-e92a70836424
---
modules/db_postgres/km_doc/db_postgres_devel.sgml | 22 -------
modules/db_postgres/km_doc/db_postgres_faq.sgml | 70 ---------------------
modules/db_postgres/km_doc/db_postgres_user.sgml | 11 ---
3 files changed, 0 insertions(+), 103 deletions(-)
diff --git a/modules/db_postgres/km_doc/db_postgres_devel.sgml b/modules/db_postgres/km_doc/db_postgres_devel.sgml
deleted file mode 100644
index d1f73c6..0000000
--- a/modules/db_postgres/km_doc/db_postgres_devel.sgml
+++ /dev/null
@@ -1,22 +0,0 @@
-<!-- Module Developer's Guide -->
-
-<chapter>
- <chapterinfo>
- <revhistory>
- <revision>
- <revnumber>$Revision$</revnumber>
- <date>$Date$</date>
- </revision>
- </revhistory>
- </chapterinfo>
- <title>Developer's Guide</title>
- <para>
- The module does not provide any <acronym>API</acronym> to use in other &ser; modules.
- </para>
-</chapter>
-
-<!-- Keep this element at the end of the file
-Local Variables:
-sgml-parent-document: ("postgres.sgml" "book" "chapter")
-End:
--->
diff --git a/modules/db_postgres/km_doc/db_postgres_faq.sgml b/modules/db_postgres/km_doc/db_postgres_faq.sgml
deleted file mode 100644
index 195942f..0000000
--- a/modules/db_postgres/km_doc/db_postgres_faq.sgml
+++ /dev/null
@@ -1,70 +0,0 @@
-<!-- Module FAQ -->
-
-<chapter>
- <chapterinfo>
- <revhistory>
- <revision>
- <revnumber>$Revision$</revnumber>
- <date>$Date$</date>
- </revision>
- </revhistory>
- </chapterinfo>
- <title>Frequently Asked Questions</title>
- <qandaset defaultlabel="number">
- <qandaentry>
- <question>
- <para>Where can I find more about OpenSER?</para>
- </question>
- <answer>
- <para>
- Take a look at &serhomelink;.
- </para>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Where can I post a question about this module?</para>
- </question>
- <answer>
- <para>
- First at all check if your question was already answered on one of
- our mailing lists:
- </para>
- <itemizedlist>
- <listitem>
- <para>User Mailing List - &seruserslink;</para>
- </listitem>
- <listitem>
- <para>Developer Mailing List - &serdevlink;</para>
- </listitem>
- </itemizedlist>
- <para>
- E-mails regarding any stable &ser; release should be sent to
- &serusersmail; and e-mails regarding development versions
- should be sent to &serdevmail;.
- </para>
- <para>
- If you want to keep the mail private, send it to
- &serhelpmail;.
- </para>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>How can I report a bug?</para>
- </question>
- <answer>
- <para>
- Please follow the guidelines provided at:
- &serbugslink;.
- </para>
- </answer>
- </qandaentry>
- </qandaset>
-</chapter>
-
-<!-- Keep this element at the end of the file
-Local Variables:
-sgml-parent-document: ("postgres.sgml" "Book" "chapter")
-End:
--->
diff --git a/modules/db_postgres/km_doc/db_postgres_user.sgml b/modules/db_postgres/km_doc/db_postgres_user.sgml
index a55545b..ab27eeb 100644
--- a/modules/db_postgres/km_doc/db_postgres_user.sgml
+++ b/modules/db_postgres/km_doc/db_postgres_user.sgml
@@ -2,12 +2,6 @@
<chapter>
<chapterinfo>
- <revhistory>
- <revision>
- <revnumber>$Revision$</revnumber>
- <date>$Date$</date>
- </revision>
- </revhistory>
</chapterinfo>
<title>User's Guide</title>
@@ -65,8 +59,3 @@
</section>
</chapter>
-<!-- Keep this element at the end of the file
-Local Variables:
-sgml-parent-document: ("postgres.sgml" "Book" "chapter")
-End:
--->