This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
Re: Doc Tasks (was RE: docstrings in Guile!)
- To: "Dale P. Smith" <dpsm at bigbird dot en dot com>
- Subject: Re: Doc Tasks (was RE: docstrings in Guile!)
- From: Maciej Stachowiak <mstachow at alum dot mit dot edu>
- Date: Fri, 17 Dec 1999 15:45:52 -0800
- CC: Telford Tendys <telford at eng dot uts dot edu dot au>, guile at sourceware dot cygnus dot com
- References: <199912171615.LAA06607@bigbird.en.com>
"Dale P. Smith" wrote:
>
> When scwm went with a sgml style markup, I wanted to say something, but since
> I am basically incoherent I didn't. I don't want to make the same mistake.
>
> Please use texinfo. Besides the above arguments, it just looks nicer. There
> is good support for it in emacs. I believe it has grown over time, features
> being added as they were needed.
>
I think the primary reason for preferring DocBook is that the documentation
people of the world generally like it better. This means that long-term,
the tools for processing DocBook will continue to improve at a much faster
rate, and that people who are good at writing and dealing with documenation
will have an easier time working with DocBook. DocBook can also leverage
the growing body of general-purpose SGML/XML tools.
I can sympathize with the complaints about the way the markup looks, but I
think that's something we can live with. Docstrings don't need a huge
amount of markup internally.
Of course, TexInfo is the official documentation format of the GNU project,
so we must ensure that the tools we believe will do the conversion work as
expected.
- Maciej