[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Chicken-users] Comprehensive documentation rewrite

From: Jim Ursetto
Subject: Re: [Chicken-users] Comprehensive documentation rewrite
Date: Tue, 12 Feb 2008 14:28:53 -0600

We /already had this/.  In the distant mists of time, we had something called
'eggdoc' which could convert to svnwiki format and Texinfo for proper
navigation.  But it was too hard to use, and it made community participation
more difficult.  It is an evolutionary dead end.  It was a good decision to
move away from it and to the wiki, even at the cost of some features.

[You can see the pdfs from every egg available at the time here. ]

Since then I've developed my own hybrid eggdoc/wiki markup which is
approximately ten thousand times easier to deal with than eggdoc, while
maintaining about the same semantic load.  But really, who hasn't?
Parsers and doc formats are a dime a dozen; it's the
infrastructure that counts.

On 2/12/08, Tobia Conforto <address@hidden> wrote:
> Graham Fawcett wrote:
> > In our audience, a regular user might not be averse to editing a
> > sexpr. I really like the wiki philosophy, but I confess I'd much
> > rather do semantic markup with sexprs than somewhat arbitrary wiki
> > tags.

> A semantically rich sexpr-based documentation format that could be
> updated with your text editor and committed through svn, following
> branches, tags, etc.

> Imagine an online (and partly offline) help system where every symbol
> is a hyperlink, every procedure is tagged by interest (so you may
> browse at all the lambdas that have something to do with ports, and
> then with threads, filter out some unwanted eggs...) No more drowning
> in the sea of SRFI and was this in extra or in posix?

reply via email to

[Prev in Thread] Current Thread [Next in Thread]