Eeeek!
All of this is too complicated for my poor li'l ol' blonde head.
What I wanted to do is:
(and I would be working directly from source for the info to use here.)
1. create manual pages for the current 1.2.5 release for all functions
implemented:
If there is a function page already, I will use it, or possibly correct any
mistakes I find on it (spelling, typos, inaccuracies, whatever).
Fill each page out so it is independent (actually type out the list of fields
returned instead of saying (see mgd_xxxx for fields).
Make sure that all the arguments are listed and explained.
Give examples for each type of call -- each type of argument combination, with
explanations.
Then, in the UNIX man page style, we can have sections for BUGS, SEE ALSO,
whatever.
2. Do the same thing for 1.2.6 when I load it.
However -- I have bemoaned in private the problems about trying to get docbook
onto a Solaris -- docbook depends on SGML, which depends on latex, which depends
on tex (or tetex, as it happens). Trying to build teTeX is an exercise in extreme
masochism. The Makefiles are full of constructs which GNU make rejects, and have
to be fixed one by one as the errors come up. I have been doing this in
background for about 2 weeks (in deep background), and finally got everything to
compile and install and the programs mf and mpost dump core.
Probably I will go to TUG and join and buy their CD-ROM. (Hang head in geek shame
for having to install binaries....)
Meantime, should I start sending pages in, (I guess just plain text format, but
I think that is going to create a lot of work for y'all when you could be doing
more constructive things) or is there a format (with containers) that exists to
minimize your all's work when actually installing this?
cat
P.S. If we can get this working, I can start (Real Soon Now (TM Jerry Pournelle))
to document the functions for 2.0 -- hey -- documents before code? What a radical
idea........ If we got that in front of everyone, it would be a very public API.
Henri Bergius wrote:
> On 24 Jan, Darren Petersen wrote:
> > As a side note to the list in general, the archives at
> > www.progressive-comp.com
> > are an excellent resource. The basic topics (and even advanced ones) are
> > often well covered there, and between now and when the Docs are good and
> > finished, it's a good place to look first. It'll probably save Emile and the
> > rest of the gurus a little typing to check the archives out...I know that the
> > answer I'm looking for is usually there when I remember to look.
>
> Yes, there is a great deal of useful information about
> Midgard in the archives. Now, the next challenge is to
> move the relevant material from there to the manual.
>
> That is where we will need volunteers. While the work
> will be a bit time-consuming, it is also a great
> opportunity to learn about the system and contribute
> to the project. The work itself isn't too difficult,
> it just needs some patience.
>
> What would probably help there would be that one
> (or several) people would go through the archives and
> copy the relevant material in a simple question and
> answer format (as it is in the email) to a document.
> That document could then be used as a sort or FAQ
> (divide the information into topics like those found
> in the manual but not do any actual editing at this
> point).
>
> After the FAQ would be complete enough, then the next
> job would be to rewrite the information into a format
> usable in the manual. As this could be done one item
> at time, it should be quite manageable.
>
> This way of working could be a solution to our lack
> of documentation, and could enable many people to
> contribute to the project without having to put too
> much time into it.
>
> Any volunteers for beginning the work?
>
> > Darren Petersen
>
> /Bergie
>
> --
> -- Henri Bergius -- +358 40 525 1334 -- [EMAIL PROTECTED] --
> http://www.iki.fi/Henri.Bergius
>
> --
> This is The Midgard Project's mailing list. For more information,
> please visit the project's web site at http://www.midgard-project.org
>
> To unsubscribe the list, send an empty email message to address
> [EMAIL PROTECTED]
--
This is The Midgard Project's mailing list. For more information,
please visit the project's web site at http://www.midgard-project.org
To unsubscribe the list, send an empty email message to address
[EMAIL PROTECTED]
