preferred documentation format, sources for documentation in admin/www
Hi,
I'd like to document my patch for making Mailman OpenPGP and S/MIME aware ( http://non-gnu.uvt.nl/pub/mailman/ ). I'd like this documentation to integrate nicely with the official Mailman documenation. What is the preferred format for creating documentation?
I believe it's LaTeX. However, the sources for mailman-{admin,install,member}.{ps,pdf,txt} are neither in cvs/sf/mailman/mailman/admin/www nor in mailman-2.1.7.tgz . It'd help me if these sources got published somewhere.
Thanks, Bye,
Joost
-- Joost van Baal http://abramowitz.uvt.nl/ Tilburg University j.e.vanbaal@uvt.nl The Netherlands
At 4:57 PM +0100 2006-01-04, Joost van Baal wrote:
I'd like to document my patch for making Mailman OpenPGP and S/MIME aware ( http://non-gnu.uvt.nl/pub/mailman/ ).
Ideally, the patch and documentation should be uploaded to the SourceForge tracker. That way Tokio, Mark, and Barry can look over it and try to get that incorporated into the baseline code.
I'd like thisdocumentation to integrate nicely with the official Mailman documenation. What is the preferred format for creating documentation?
As for the preferred documentation format, I'll let someone who knows more about that subject provide an answer for you.
-- Brad Knowles, <brad@stop.mail-abuse.org>
"Those who would give up essential Liberty, to purchase a little temporary Safety, deserve neither Liberty nor Safety."
-- Benjamin Franklin (1706-1790), reply of the Pennsylvania
Assembly to the Governor, November 11, 1755LOPSA member since December 2005. See <http://www.lopsa.org/>.
On Wed, 2006-01-04 at 16:57 +0100, Joost van Baal wrote:
I'd like to document my patch for making Mailman OpenPGP and S/MIME aware ( http://non-gnu.uvt.nl/pub/mailman/ ). I'd like this documentation to integrate nicely with the official Mailman documenation. What is the preferred format for creating documentation?
I believe it's LaTeX. However, the sources for mailman-{admin,install,member}.{ps,pdf,txt} are neither in cvs/sf/mailman/mailman/admin/www nor in mailman-2.1.7.tgz . It'd help me if these sources got published somewhere.
LaTeX is the preferred format for the documentation source. We process our .tex files with the mkhowto program from the Python distribution. These rules apply for Mailman too:
http://www.python.org/doc/current/doc/doc.html
The source files are available in CVS, here:
http://cvs.sourceforge.net/viewcvs.py/mailman/mailman/doc/?only_with_tag=Rel...
Cheers, -Barry
Hi,
Brad and Barry: thanks for your reply!
On Thu, Jan 05, 2006 at 09:03:39PM -0500, Barry Warsaw wrote:
On Wed, 2006-01-04 at 16:57 +0100, Joost van Baal wrote:
I'd like to document my patch for making Mailman OpenPGP and S/MIME aware ( http://non-gnu.uvt.nl/pub/mailman/ ). I'd like this documentation to integrate nicely with the official Mailman documenation. What is the preferred format for creating documentation?
I believe it's LaTeX. However, the sources for mailman-{admin,install,member}.{ps,pdf,txt} are neither in cvs/sf/mailman/mailman/admin/www nor in mailman-2.1.7.tgz . It'd help me if these sources got published somewhere.
LaTeX is the preferred format for the documentation source. We process our .tex files with the mkhowto program from the Python distribution. These rules apply for Mailman too:
http://www.python.org/doc/current/doc/doc.html
The source files are available in CVS, here:
http://cvs.sourceforge.net/viewcvs.py/mailman/mailman/doc/?only_with_tag=Rel...
Oops, of course. Apparently I got confused by the rsync calls in the Makefile in admin/www, and stopped searching too early.
I'll start documenting my Secure List Server patch using this framework (it's patch #1167696, BTW).
Bye,
Joost
-- Joost van Baal http://abramowitz.uvt.nl/ Tilburg University j.e.vanbaal@uvt.nl The Netherlands
participants (3)
-
Barry Warsaw -
Brad Knowles -
Joost van Baal