git:janakj/postgres: - docbook documentation template. - sr-dev

15 Feb 2009

Module: sip-router
Branch: janakj/postgres
Commit: 62e5f5f2c2823a53eeac94ae8633677409d2aacf
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=62e5f5f2...
Author: Jan Janak jan@iptel.org
Committer: Jan Janak jan@iptel.org
Date:   Thu Jul 24 18:17:16 2003 +0000
- docbook documentation template.
---
modules/db_postgres/doc/postgres.sgml       |   52 +++++++++++++
 modules/db_postgres/doc/postgres_devel.sgml |   22 ++++++
 modules/db_postgres/doc/postgres_faq.sgml   |   67 ++++++++++++++++
 modules/db_postgres/doc/postgres_user.sgml  |  110 +++++++++++++++++++++++++++
 4 files changed, 251 insertions(+), 0 deletions(-)

diff --git a/modules/db_postgres/doc/postgres.sgml b/modules/db_postgres/doc/postgres.sgml
new file mode 100644
index 0000000..b814928
--- /dev/null
+++ b/modules/db_postgres/doc/postgres.sgml
@@ -0,0 +1,52 @@
+<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+
+
+<!ENTITY user SYSTEM "postgres_user.sgml">
+<!ENTITY devel SYSTEM "postgres_devel.sgml">
+<!ENTITY faq SYSTEM "postgres_faq.sgml">
+
+<!-- Include general SER documentation entities -->
+<!ENTITY % serentities SYSTEM "../../../doc/ser_entities.sgml">
+%serentities;
+
+]>
+
+<book>
+    <bookinfo>
+	<title>postgres Module</title>
+	<productname class="trade">&sername;</productname>
+	<authorgroup>
+	    <author>
+		<firstname>Greg</firstname>
+		<surname>Fausak</surname>
+		<affiliation><orgname>August.net</orgname></affiliation>
+		<address>
+		    <email>greg@august.net</email>
+		</address>
+	    </author>
+	    <editor>
+		<firstname>Greg</firstname>
+		<surname>Fausak</surname>
+		<address>
+		    <email>greg@august.net</email>
+		</address>
+	    </editor>
+	</authorgroup>
+	<copyright>
+	    <year>2003</year>
+	    <holder>Greg Fausak</holder>
+	</copyright>
+	<revhistory>
+	    <revision>
+		<revnumber>$Revision$</revnumber>
+		<date>$Date$</date>
+	    </revision>
+	</revhistory>
+    </bookinfo>
+    <toc></toc>
+    
+    &user;
+    &devel;
+    &faq;
+    
+</book>
diff --git a/modules/db_postgres/doc/postgres_devel.sgml b/modules/db_postgres/doc/postgres_devel.sgml
new file mode 100644
index 0000000..9983429
--- /dev/null
+++ b/modules/db_postgres/doc/postgres_devel.sgml
@@ -0,0 +1,22 @@
+<!-- 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 sort of API 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/doc/postgres_faq.sgml b/modules/db_postgres/doc/postgres_faq.sgml
new file mode 100644
index 0000000..9322cc4
--- /dev/null
+++ b/modules/db_postgres/doc/postgres_faq.sgml
@@ -0,0 +1,67 @@
+<!-- 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 &ser;?</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>&seruserslink;</para>
+		    </listitem>
+		    <listitem>
+			<para>&serdevlink;</para>
+		    </listitem>
+		</itemizedlist>
+		<para>
+		    E-mails regarding any stable version should be sent to &serusersmail; and e-mail
+		    regarding development versions or CVS snapshots should be send 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/doc/postgres_user.sgml b/modules/db_postgres/doc/postgres_user.sgml
new file mode 100644
index 0000000..2d68cfe
--- /dev/null
+++ b/modules/db_postgres/doc/postgres_user.sgml
@@ -0,0 +1,110 @@
+<!-- Module User's Guide -->
+
+<chapter>
+    <chapterinfo>
+	<revhistory>
+	    <revision>
+		<revnumber>$Revision$</revnumber>
+		<date>$Date$</date>
+	    </revision>
+	</revhistory>
+    </chapterinfo>
+    <title>User's Guide</title>
+    
+    <section>
+	<title>Overview</title>
+	<para>Module description</para>
+    </section>
+    <section>
+	<title>Dependencies</title>
+	<section>
+	    <title>&ser; Modules</title>
+	    <para>
+		The following modules must be loaded before this module:
+	    	<itemizedlist>
+		    <listitem>
+			<para>
+			    <emphasis>No dependencies on other &ser; modules</emphasis>.
+			</para>
+		    </listitem>
+	    	</itemizedlist>
+	    </para>
+	</section>
+	<section>
+	    <title>External Libraries or Applications</title>
+	    <para>
+		The following libraries or applications must be installed before running
+		&ser; with this module loaded:
+	    	<itemizedlist>
+		    <listitem>
+			<para>
+			    <emphasis>None</emphasis>.
+			</para>
+		    </listitem>
+	    	</itemizedlist>
+	    </para>
+	</section>
+    </section>
+    <section>
+	<title>Exported Parameters</title>
+	<section>
+	    <title><varname>param_name</varname> (param_type)</title>
+	    <para>
+		Param description.
+	    </para>
+	    <para>
+		<emphasis>
+		    Default value is <quote>value</quote>.
+		</emphasis>
+	    </para>
+	    <example>
+		<title>Set <varname>param_name</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("module", "param_name", "param_value")
+...
+</programlisting>
+	    </example>
+	</section>
+    </section>
+    <section>
+	<title>Exported Functions</title>
+	<section>
+	    <title>
+		<function moreinfo="none">function_name(param1, param2)</function>
+	    </title>
+	    <para>
+		Description
+	    </para>
+	    <para>Meaning of the parameters is as follows:</para>
+	    <itemizedlist>
+		<listitem>
+		    <para><emphasis>param1</emphasis> - description.
+		    </para>
+		</listitem>
+		<listitem>
+		    <para><emphasis>param2</emphasis> - description.
+		    </para>
+		</listitem>
+	    </itemizedlist>
+	    <example>
+		<title><function>function_name</function> usage</title>
+		<programlisting format="linespecific">
+...
+function_name("sample_param1", "sample_param2");
+...
+</programlisting>
+	    </example>
+	</section>
+    </section>
+    <section>
+	<title>Installation & Running</title>
+	<para>Notes about installation and running.</para>
+    </section>
+</chapter>
+
+<!-- Keep this element at the end of the file
+Local Variables:
+sgml-parent-document: ("postgres.sgml" "Book" "chapter")
+End:
+-->

    