- docbook templates for writing module documentation

doc/template/module/module.sgml

@@ -0,0 +1,59 @@
+<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+
+<!ENTITY parentsgml "module.sgml">
+<!ENTITY copyrightholder "FhG FOKUS">
+<!ENTITY ser "SER">
+<!ENTITY sername "SIP Express Router">
+<!ENTITY serhomeweb "http://www.iptel.org/ser/">
+<!ENTITY serbugsweb "http://www.iptel.org/ser/bugs/">
+<!ENTITY serhelpmail "[email protected]">
+<!ENTITY serusersmail "[email protected]">
+<!ENTITY serusersweb "http://mail.iptel.org/mailman/listinfo/serusers/">
+<!ENTITY serdevmail "[email protected]">
+<!ENTITY serdevweb "http://mail.iptel.org/mailman/listinfo/serdev/">
+<!ENTITY user SYSTEM "module_user.sgml">
+<!ENTITY devel SYSTEM "module_devel.sgml">
+<!ENTITY faq SYSTEM "module_faq.sgml">
+
+]>
+
+<book>
+    <bookinfo>
+	<title>Module's Name</title>
+	<productname class="trade">&sername;</productname>
+	<authorgroup>
+	    <author>
+		<firstname>AuthorFirstname</firstname>
+		<surname>AuthorLastname</surname>
+		<affiliation><orgname>Organization Name</orgname></affiliation>
+		<address>
+		<email>[email protected]</email>
+		</address>
+	    </author>
+	    <editor>
+		<firstname>EditorFirstname</firstname>
+		<surname>EditorLastname</surname>
+		<address>
+		<email>[email protected]</email>
+		</address>
+	    </editor>
+	</authorgroup>
+	<copyright>
+	    <year>2003</year>
+	    <year>2004</year>
+	    <holder>&copyrightholder;</holder>
+	</copyright>
+	<revhistory>
+	    <revision>
+		<revnumber>$Revision$</revnumber>
+		<date>$Date$</date>
+	    </revision>
+	</revhistory>
+    </bookinfo>
+    <toc></toc>
+    
+    &user;
+    &devel;
+    &faq;
+
+</book>

doc/template/module/module_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: ("&parentsgml;" "book" "chapter")
+End:
+-->

doc/template/module/module_faq.sgml

@@ -0,0 +1,74 @@
+<!-- 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 
+			<ulink url="&serhomeweb;">&serhomeweb;</ulink>.
+		</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: 
+			SER-Users
+		</para>
+		<para>
+			(<ulink url="&serusersweb;">&serusersweb;</ulink>)
+		</para>
+		<para>
+			or SER-Developers
+		</para>
+		<para>
+			(<ulink url="&serdevweb;">&serdevweb;</ulink>).
+		</para>
+		<para>
+			Any mails regarding a stable SER release must be sent to 
+			<email>&serusersmail;</email> while
+			<email>&serdevmail;</email> must be used for under-developing
+			version.
+		</para>
+		<para>
+			If you want to keep the mail private, send it to 
+			<email>&serhelpmail;</email>.
+		</para>
+	    </answer>
+	</qandaentry>
+	<qandaentry>
+	    <question>
+		<para>How can I report a bug?</para>
+	    </question>
+	    <answer>
+		<para>
+			Please follow the guidelines provided at:
+			<ulink url="&serbugsweb;">&serbugsweb;</ulink>.
+		</para>
+	    </answer>
+	</qandaentry>
+    </qandaset>
+</chapter>
+
+<!-- Keep this element at the end of the file
+Local Variables:
+sgml-parent-document: ("&parentsgml;" "Book" "chapter")
+End:
+-->

doc/template/module/module_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 next modules must be loaded before this module:
+	    	<itemizedlist>
+			<listitem>
+			    <para>
+				<emphasis>none</emphasis>.
+				</para>
+			</listitem>
+	    	</itemizedlist>
+		</para>
+		</section>
+		<section>
+	    	<title>External libraries or applications</title>
+		<para>
+		    The next libraries or applications must be installed before running
+			&ser; with this module:
+	    	<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 the <quote>param_name</quote> 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_name 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: ("&parentsgml;" "Book" "chapter")
+End:
+-->