This is the mail archive of the guile@cygnus.com mailing list for the guile project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: primitive documentation conventions



>>>>> "Marcus" == Marcus G Daniels <marcusd@cathcart.sysc.pdx.edu> writes:

>>>>> "JB" == Jim Blandy <jimb@red-bean.com> writes:
    MD> I mean, you aren't thinking of requiring that the user have
    MD> Jade, are you?

    JB> No, we're not considering that.  It's unacceptable to require
    JB> the user to have Jade installed to read docstrings.

    Marcus> And what about the manual?

The Guile manuals are written in TeXinfo, and for Guile this will
probably not change soon.  I can only see it changing when the
interchange between DocBook and TeXinfo is mature (it is non-existent
now).

With docstrings there is a chance of a fresh start, and DocBook tags
might be interesting.  If docstrings make their way into the manual
(as a "quickref" appendix, for example) they would have to use tags
with no depth that map quite easily to the equivalent TeXinfo tags.