[SR-Dev] git:janakj/postgres: - improved documentation system

Module: sip-router Branch: janakj/postgres Commit: 842ca23a570cab666a178a2dee13f4d53fb2f33f URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=842ca23… Author: Jan Janak &lt;jan(a)iptel.org&gt; Committer: Jan Janak &lt;jan(a)iptel.org&gt; Date: Sat Jul 23 23:21:36 2005 +0000 - improved documentation system - documentation makefiles - proper documentation dependency tracking in makefiles - XML-based dialect of docbook used with xi:include inclusions --- 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, 0 insertions(+), 251 deletions(-) diff --git a/modules/db_postgres/doc/postgres.sgml b/modules/db_postgres/doc/postgres.sgml deleted file mode 100644 index b814928..0000000 --- a/modules/db_postgres/doc/postgres.sgml +++ /dev/null @@ -1,52 +0,0 @@ -<!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> - &lt;email&gt;greg(a)august.net&lt;/email&gt; - </address> - </author> - <editor> - <firstname>Greg</firstname> - <surname>Fausak</surname> - <address> - &lt;email&gt;greg(a)august.net&lt;/email&gt; - </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 deleted file mode 100644 index 9983429..0000000 --- a/modules/db_postgres/doc/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 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 deleted file mode 100644 index 9322cc4..0000000 --- a/modules/db_postgres/doc/postgres_faq.sgml +++ /dev/null @@ -1,67 +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 &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 deleted file mode 100644 index 2d68cfe..0000000 --- a/modules/db_postgres/doc/postgres_user.sgml +++ /dev/null @@ -1,110 +0,0 @@ -<!-- 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: --->