Would it be easier to automatically upload existing man pages to Wiki and then go and update them or add new docs? There are a lot of man pages that can be used.
Dossy wrote:
A quick update -- with the tremendous help of our anonymous prolific wiki updater, the AOLserver 4.0 Documentation effort is underway. The starting point is on the wiki, here:
http://panoptic.com/wiki/aolserver/Documentation
For the 6/25 milestone, the goal is to have the Tcl API docs complete on the wiki, and the roff format updated in CVS. Here's a link to the Tcl API docs:
http://panoptic.com/wiki/aolserver/TclAPI
I've only done a four or five commands so far, but it's a start and it should hopefully give a clear idea of the format that I think the documentation should take. Here's a link to an example, for the ns_addrbyhost command:
http://panoptic.com/wiki/aolserver/ns_addrbyhost
My approach to writing the documentation is to take what we currently have written (in roff format from CVS, from the various documentation efforts that have gone on in the past, etc.), then actually look at the AOLserver source to fill the gaps (undocumented subcommands, behaviors, where the docs and code disagree, etc.) -- this should at least provide us accurate documentation, again.
I'm currently working off the aolserver_v40_bp branch source (which is currently 4.0.3).
Comments? Feedback? Criticisms? Either respond on the list, on the wiki or directly to me in private email or IM. Thanks!
-- Dossy
-- Dossy Shiobara mail: [EMAIL PROTECTED] Panoptic Computer Network web: http://www.panoptic.com/ "He realized the fastest way to change is to laugh at your own folly -- then you can let go and quickly move on." (p. 70)
-- AOLserver - http://www.aolserver.com/
To Remove yourself from this list, simply send an email to <[EMAIL PROTECTED]> with the body of "SIGNOFF AOLSERVER" in the email message. You can leave the Subject: field of your email blank.
-- Vlad Seryakov 703 488-2173 office [EMAIL PROTECTED] http://www.crystalballinc.com/vlad/
-- AOLserver - http://www.aolserver.com/
To Remove yourself from this list, simply send an email to <[EMAIL PROTECTED]> with the body of "SIGNOFF AOLSERVER" in the email message. You can leave the Subject: field of your email blank.
