Ok, let's start again. mod_mbox is not in the HTTPd core, so its documentation does not belong to the httpd/httpd/docs/ part of the repository.
Attached, a small patch adding a stub website for mod_mbox to the httpd/site/ directory. Module's documentation will come afterwards (I still have some thinking do to about it), but I'd love to see the third party modules page updated before mod_mbox next release. Any recommandations on how to write the documentation ? What model shoud I follow ? Should I write separate documentations (as specified in the mod_mbox's STATUS file, I plan to write three kinds of documentation : for users, admins and developpers) and just link to them, or fully integrate these docs to the mod_mbox website ? Thanks, - Sam -- Maxime Petazzoni (http://www.bulix.org) -- gone crazy, back soon. leave message.
Index: xdocs/mod_mbox/index.xml =================================================================== --- xdocs/mod_mbox/index.xml (revision 0) +++ xdocs/mod_mbox/index.xml (revision 0) @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<document> + <properties> + <author email="dev@httpd.apache.org">HTTPd developers</author> + <title>Mailing list archives browser</title> + </properties> +<body> + +<section> + <title>Mailing list archives browser</title> + <p> + <tt>mod_mbox</tt> is a mailing list archives browser, offering a + nice, featureful and effective browsing interface for mailing list + archives. Functionality includes: + </p> + <ul type="square"> + <li>A dynamic browsing interface, using AJAX (Asynchronous Javascript And XML)</li> + <li>A flat, Javascript-less interface, using static XHTML</li> + <li>Mail attachments and MIME parts viewing and downloading</li> + <li>Full text search (still to be submitted, though)</li> + </ul> +</section> + +<section> + <title>Authors</title> + <p> + <tt>mod_mbox</tt> was originally written by <strong>Justin + Erenkrantz</strong> in 2001, and <strong>Paul Querna</strong> also + worked on the module from time to time. More recently, + <strong>Maxime Petazzoni</strong> and <strong>Russell + Johnson</strong> joined the "team" as a Summer Of Code + students. Russell implemented the full text search in + <tt>mod_mbox</tt>, while Maxime worked on improving the module's + user interface. + </p> +</section> + +<section> + <title>News</title> + <p> + <b>July and August 2005</b> - Summer Of Code projects + (<tt>httpd-mbox-if</tt> and <tt>httpd-mbox-search</tt>) renew and + improve the module. + </p> + <p> + <b>July 17, 2001</b> - First <tt>mod_mbox</tt> release. + </p> +</section> + +<section> + <title>Mailing Lists</title> + <p> + This module is not important enough to justify it's own mailing + list. Discussions are made on the main HTTPd development mailing + list. + </p> + + <ul type="square"> + <li> + <a href="mailto:[EMAIL PROTECTED]">dev@httpd.apache.org</a> + - module development (<a href="http://mail-archives.apache.org/mod_mbox/httpd-dev/";>archives</a>). + </li> + <li> + <a href="mailto:[EMAIL PROTECTED]">cvs@httpd.apache.org</a> + - cvs commit logs for httpd, thus including mod_mbox + (<a href="http://mail-archives.apache.org/mod_mbox/httpd-cvs/";>archives</a>). + </li> + </ul> +</section> + +<section> + <title>Subversion repository</title> + + <p> + Development of mod_mbox can be followed through the <a + href="http://subversion.tigris.org/";>Subversion</a> + repositories. For public access you can use : + </p> + + <pre><code> + % mkdir mod_mbox + % svn checkout http://svn.apache.org/repos/asf/httpd/mod_mbox/trunk/ mod_mbox/trunk + % svn checkout http://svn.apache.org/repos/asf/httpd/mod_mbox/branches/httpd-mbox-if/ mod_mbox/httpd-mbox-if/ + </code></pre> +</section> +</body> +</document> Property changes on: xdocs/mod_mbox/index.xml ___________________________________________________________________ Name: svn:eol-style + native Index: xdocs/modules/index.xml =================================================================== --- xdocs/modules/index.xml (revision 264877) +++ xdocs/modules/index.xml (working copy) @@ -47,9 +47,10 @@ mod_mbox.</p> <ul> +<li>Website: <a href="http://httpd.apache.org/mod_mbox";>mod_mbox</a></li> <li>Source: <a href="https://svn.apache.org/repos/asf/httpd/mod_mbox/trunk";>mod_mbox</a></li> <li>ViewCVS: <a href="http://svn.apache.org/viewcvs.cgi/httpd/mod_mbox/";>mod_mbox</a></li> -<li>Mailing list: <a href="mailto:[EMAIL PROTECTED]">mbox-dev@httpd.apache.org</a></li> +<li>Mailing list: <a href="mailto:[EMAIL PROTECTED]">dev@httpd.apache.org</a></li> </ul> </section> Index: docs/mod_mbox/index.html =================================================================== --- docs/mod_mbox/index.html (revision 0) +++ docs/mod_mbox/index.html (revision 0) @@ -0,0 +1,182 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> + <meta name="author" content="HTTPd developers" /><meta name="email" content="dev@httpd.apache.org" /> + <title>Mailing list archives browser - The Apache HTTP Server Project</title> + </head> + <body bgcolor="#ffffff" text="#000000" link="#525D76"> +<p><a href="/"><img src="../images/httpd_logo_wide.gif" alt="The Apache HTTP Server Project" border="0"/></a></p> + <table border="0" width="100%" cellspacing="4"> + <tr> + <!-- LEFT SIDE NAVIGATION --> + <td valign="top" nowrap="nowrap"> + <a href="http://apachecon.com/"; + ><img src="http://apache.org/images/ac2005eu_135x50.gif"; height="50" + width="135" border="0" alt="ApacheCon Europe 2005" /></a> + <p><b>Essentials</b></p> + <menu compact="compact"> + <li><a href="/ABOUT_APACHE.html">About</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="/docs/misc/FAQ.html">FAQ</a></li> + <li><a href="/security_report.html">Security<br />Reports</a></li> + </menu> + <p><b>Download!</b></p> + <menu compact="compact"> + <li><a href="/download.cgi">from a mirror</a></li> + </menu> + <p><b><a +href="/docs-project/">Documentation</a></b></p> + <menu compact="compact"> + <li><a href="/docs/1.3/">Apache 1.3</a></li> + <li><a href="/docs/2.0/">Apache 2.0</a></li> + <li><a href="/docs/2.1/">Apache 2.1</a> (alpha)</li> + </menu> + <p><b>Get Involved</b></p> + <menu compact="compact"> + <li><a href="/lists.html">Mailing Lists</a></li> + <li><a href="/bug_report.html">Bug Reports</a></li> + <li><a href="/dev/">Developer Info</a></li> + </menu> + <p><b>Subprojects</b></p> + <menu compact="compact"> + <li><a href="/docs-project/">Docs</a></li> + <li><a href="/test/">Test</a></li> + <li><a href="/test/flood/">Flood</a></li> + <li><a href="/apreq/">libapreq</a></li> + <li><a href="/modules/">Modules</a></li> + <li><a href="/cli/">cli (.NET)</a></li> + </menu> + <p><b><a +href="/info/">Miscellaneous</a></b></p> + <menu compact="compact"> + <li><a href="/contributors/">Contributors</a></li> + <li><a href="/awards.html">Awards</a></li> + <li><a href="http://webring.com/hub?ring=apachesupport";>Support<br />Webring</a></li> + </menu> + </td> + <!-- RIGHT SIDE INFORMATION --> + <td align="left" valign="top"> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <strong>Mailing list archives browser</strong> + </font> + </td></tr> + <tr><td> + <blockquote> +<p> + <tt>mod_mbox</tt> is a mailing list archives browser, offering a + nice, featureful and effective browsing interface for mailing list + archives. Functionality includes: + </p> +<ul type="square"> + <li>A dynamic browsing interface, using AJAX (Asynchronous Javascript And XML)</li> + <li>A flat, Javascript-less interface, using static XHTML</li> + <li>Mail attachments and MIME parts viewing and downloading</li> + <li>Full text search (still to be submitted, though)</li> + </ul> + </blockquote> + </td></tr> +</table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <strong>Authors</strong> + </font> + </td></tr> + <tr><td> + <blockquote> +<p> + <tt>mod_mbox</tt> was originally written by <strong>Justin + Erenkrantz</strong> in 2001, and <strong>Paul Querna</strong> also + worked on the module from time to time. More recently, + <strong>Maxime Petazzoni</strong> and <strong>Russell + Johnson</strong> joined the "team" as a Summer Of Code + students. Russell implemented the full text search in + <tt>mod_mbox</tt>, while Maxime worked on improving the module's + user interface. + </p> + </blockquote> + </td></tr> +</table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <strong>News</strong> + </font> + </td></tr> + <tr><td> + <blockquote> +<p> + <b>July and August 2005</b> - Summer Of Code projects + (<tt>httpd-mbox-if</tt> and <tt>httpd-mbox-search</tt>) renew and + improve the module. + </p> +<p> + <b>July 17, 2001</b> - First <tt>mod_mbox</tt> release. + </p> + </blockquote> + </td></tr> +</table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <strong>Mailing Lists</strong> + </font> + </td></tr> + <tr><td> + <blockquote> +<p> + This module is not important enough to justify it's own mailing + list. Discussions are made on the main HTTPd development mailing + list. + </p> +<ul type="square"> + <li> + <a href="mailto:[EMAIL PROTECTED]">dev@httpd.apache.org</a> + - module development (<a href="http://mail-archives.apache.org/mod_mbox/httpd-dev/";>archives</a>). + </li> + <li> + <a href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</a> + - cvs commit logs for httpd, thus including mod_mbox + (<a href="http://mail-archives.apache.org/mod_mbox/httpd-cvs/";>archives</a>). + </li> + </ul> + </blockquote> + </td></tr> +</table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <strong>Subversion repository</strong> + </font> + </td></tr> + <tr><td> + <blockquote> +<p> + Development of mod_mbox can be followed through the <a href="http://subversion.tigris.org/";>Subversion</a> + repositories. For public access you can use : + </p> +<pre><code> + % mkdir mod_mbox + % svn checkout http://svn.apache.org/repos/asf/httpd/mod_mbox/trunk/ mod_mbox/trunk + % svn checkout http://svn.apache.org/repos/asf/httpd/mod_mbox/branches/httpd-mbox-if/ mod_mbox/httpd-mbox-if/ + </code></pre> + </blockquote> + </td></tr> +</table> + </td> + </tr> + <!-- FOOTER --> + <tr><td colspan="2"><hr noshade="noshade" size="1"/></td></tr> + <tr><td colspan="2" align="center"> + <font size="-1"> + <em>Copyright © 1999-2005, The Apache Software Foundation</em> + </font> + </td> + </tr> + </table> + </body> +</html> Property changes on: docs/mod_mbox/index.html ___________________________________________________________________ Name: svn:eol-style + native Index: docs/modules/index.html =================================================================== --- docs/modules/index.html (revision 264877) +++ docs/modules/index.html (working copy) @@ -117,9 +117,10 @@ <p>Do you want to setup mail archives with Apache httpd-2.0? Try out mod_mbox.</p> <ul> +<li>Website: <a href="http://httpd.apache.org/mod_mbox";>mod_mbox</a></li> <li>Source: <a href="https://svn.apache.org/repos/asf/httpd/mod_mbox/trunk";>mod_mbox</a></li> <li>ViewCVS: <a href="http://svn.apache.org/viewcvs.cgi/httpd/mod_mbox/";>mod_mbox</a></li> -<li>Mailing list: <a href="mailto:[EMAIL PROTECTED]">mbox-dev@httpd.apache.org</a></li> +<li>Mailing list: <a href="mailto:[EMAIL PROTECTED]">dev@httpd.apache.org</a></li> </ul> </blockquote> </td></tr>
signature.asc
Description: Digital signature
![http://apache.org/images/ac2005eu_135x50.gif"](http://apache.org/images/ac2005eu_135x50.gif"){kind=link}