List Administration Manual r2.1
Hello folks,
I'm putting together a proposal for the use of mailman to a potential client and would like to deliver a complete set of documentation. The List Administration Manual looks like it's nearly finished and just needs a bit of work by a technical writer with experience in the subject area.
I've been participating in mailman lists since at least 2002 and administering and moderating successful and unsuccessful lists on my own hardware and others' since 2003.
I have also racked up about 9 months of experience developing LaTeX documents during grad school. I still consider myself a bit of a neophyte in this area and will be needing some help setting up the LaTeX environment for compiling the .dvi files. At this point, I installed the python-sphinx package (debian) and copied the /usr/share/sphinx/texinputs/howto.cls it provides to the build directory. I am getting the following error and would appreciate any insight you can provide.
Cheers,
C.J.
$ latex mailman-admin.tex This is pdfTeX, Version 3.1415926-1.40.10 (TeX Live 2009/Debian) entering extended mode (./mailman-admin.tex LaTeX2e <2009/09/24> Babel <v3.8l> and hyphenation patterns for english, usenglishmax, dumylang, noh yphenation, loaded. (./howto.cls Document Class: howto 2008/10/18 Document class (Sphinx HOWTO) (/usr/share/texmf-texlive/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/share/texmf-texlive/tex/latex/base/size10.clo))) ! Undefined control sequence. l.7 \release {1.0}
On 5/13/2011 10:01 AM, C.J. Adams-Collier KF7BMP wrote:
I have also racked up about 9 months of experience developing LaTeX documents during grad school. I still consider myself a bit of a neophyte in this area and will be needing some help setting up the LaTeX environment for compiling the .dvi files. At this point, I installed the python-sphinx package (debian) and copied the /usr/share/sphinx/texinputs/howto.cls it provides to the build directory. I am getting the following error and would appreciate any insight you can provide.
I'm not sure about the specific error you are encountering. I've never used Sphinx on these .tex files. The documentation package is built with the old Python mkhowto script. This script can be found at <http://svn.python.org/view/python/branches/release25-maint/Doc/tools/mkhowto...>. It has several dependencies, and I don't remember what they all are.
To make the various files from mailman-admin.tex, you do
mkhowto --all --dir /path/to/html/dir mailman-admin.tex
where /path/to/html/dir is the directory to receive the HTML manual.
-- Mark Sapiro <mark@msapiro.net> The highway is for gamblers, San Francisco Bay Area, California better use your sense - B. Dylan
On Fri, 2011-05-13 at 12:14 -0700, Mark Sapiro wrote:
On 5/13/2011 10:01 AM, C.J. Adams-Collier KF7BMP wrote:
I have also racked up about 9 months of experience developing LaTeX documents during grad school. I still consider myself a bit of a neophyte in this area and will be needing some help setting up the LaTeX environment for compiling the .dvi files. At this point, I installed the python-sphinx package (debian) and copied the /usr/share/sphinx/texinputs/howto.cls it provides to the build directory. I am getting the following error and would appreciate any insight you can provide.
I'm not sure about the specific error you are encountering. I've never used Sphinx on these .tex files. The documentation package is built with the old Python mkhowto script. This script can be found at <http://svn.python.org/view/python/branches/release25-maint/Doc/tools/mkhowto...>. It has several dependencies, and I don't remember what they all are.
To make the various files from mailman-admin.tex, you do
mkhowto --all --dir /path/to/html/dir mailman-admin.tex
where /path/to/html/dir is the directory to receive the HTML manual.
Thank you Mark. It seems the magic conjuration must be invoked similarly to:
$ sudo apt-get install python-old-doctools $ rm -f howto.cls $ mkdir /tmp/html $ /usr/lib/python2.5/doc/tools/mkhowto --all --dir /tmp/html mailman-admin.tex > /dev/null 2>&1 $ evince mailman-admin.pdf
Good enough for government work. Now to add some content.
On May 13, 2011, at 01:01 PM, C.J. Adams-Collier KF7BMP wrote:
Good enough for government work. Now to add some content.
Thanks C.J. for taking this on, and thanks Mark for helping out with the old doc toolset.
For Mailman 3, we are using the reStructuredText format and Sphinx tools. I wouldn't mind it if someone wanted to port the old Mailman 2.1 LaTeX documentation to reST.
Cheers, -Barry
participants (3)
-
Barry Warsaw -
C.J. Adams-Collier KF7BMP -
Mark Sapiro