Re: [PATCH] mod_mbox module documentation

2005-08-30 Thread Maxime Petazzoni
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.orgHTTPd developers/author
+titleMailing list archives browser/title
+  /properties
+body
+
+section
+  titleMailing list archives browser/title
+  p
+ttmod_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
+liA dynamic browsing interface, using AJAX (Asynchronous Javascript And 
XML)/li
+liA flat, Javascript-less interface, using static XHTML/li
+liMail attachments and MIME parts viewing and downloading/li
+liFull text search (still to be submitted, though)/li
+  /ul
+/section
+
+section
+  titleAuthors/title
+  p
+ttmod_mbox/tt was originally written by strongJustin
+Erenkrantz/strong in 2001, and strongPaul Querna/strong also
+worked on the module from time to time. More recently,
+strongMaxime Petazzoni/strong and strongRussell
+Johnson/strong joined the team as a Summer Of Code
+students. Russell implemented the full text search in
+ttmod_mbox/tt, while Maxime worked on improving the module's
+user interface.
+  /p
+/section
+
+section
+  titleNews/title
+  p
+bJuly and August 2005/b - Summer Of Code projects
+(tthttpd-mbox-if/tt and tthttpd-mbox-search/tt) renew and
+improve the module.
+  /p
+  p
+bJuly 17, 2001/b - First ttmod_mbox/tt release.
+  /p
+/section
+
+section
+  titleMailing 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#64;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#64;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
+  titleSubversion 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
+
+  precode
+% 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
+liWebsite: a href=http://httpd.apache.org/mod_mbox;mod_mbox/a/li
 liSource: a 
href=https://svn.apache.org/repos/asf/httpd/mod_mbox/trunk;mod_mbox/a/li
 liViewCVS: a 
href=http://svn.apache.org/viewcvs.cgi/httpd/mod_mbox/;mod_mbox/a/li
-liMailing list: a href=mailto:[EMAIL 
PROTECTED]mbox-dev@httpd.apache.org/a/li
+liMailing 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 

Re: [PATCH] mod_mbox module documentation

2005-08-30 Thread Justin Erenkrantz
On Wed, Aug 31, 2005 at 04:36:59AM +0200, Maxime Petazzoni wrote:
 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.

Yup.

I've adjusted your commit privs to be able to commit to the site
repository.  (All committers to any httpd project are supposed to be
able to commit there.)

 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.

After committing, log into people.apache.org, ensure your umask is set
to 002 and run 'svn up' in /www/httpd.apache.org.  In a few hours, your
change will be live on http://httpd.apache.org/.

 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 ?

I would just stick the stuff in the website; but, honestly, go with it
as you see fit.  -- justin


Re: [PATCH] mod_mbox module documentation

2005-08-30 Thread Maxime Petazzoni
Hi,

 I've adjusted your commit privs to be able to commit to the site
 repository.  (All committers to any httpd project are supposed to be
 able to commit there.)

Thanks, it will be easier for me to commit the documentation.

 After committing, log into people.apache.org, ensure your umask is set
 to 002 and run 'svn up' in /www/httpd.apache.org.  In a few hours, your
 change will be live on http://httpd.apache.org/.

Yup, I read the README file, but thanks for remind it to me, I really
don't want to make something wrong and screw the whole HTTPd website.

I've just ended the procedure, /var/httpd.apache.org/ is updated to
revision 264927.

 I would just stick the stuff in the website; but, honestly, go with it
 as you see fit.  -- justin

Maybe I'll find what to do in my dreams :) Good night and thanks for the
help.

- Sam

-- 
Maxime Petazzoni (http://www.bulix.org)
 -- gone crazy, back soon. leave message.


signature.asc
Description: Digital signature