Re: [Chicken-users] Topics and a main index (was: egg documentation)

[Vincent Manis]

On 2008 Feb 19, at 04:39, Tobia Conforto wrote:

> Vincent Manis wrote:
> > By the way, on the subject of wiki markup, I'd like to put in a  
> > plug for marking index entries.
>
>
> As I see it, with Alejandro's solution we are already marking index  
> entries, at least for procedures, macros, records, and SRFI-39  
> parameters.  On the other hand, the contents of <read> and  
> <signature> don't have a fixed syntax that can be easily extracted  
> (they aren't a single s-expr whose car is to be indexed) so maybe an  
> index="" attribute would have its uses, in case the author feels  
> like putting a name for the entry in the aforementioned main index.   
> Or maybe not.
>
> If instead you mean index links, as in "this macro is useful in  
> conjunction with [[index:stream-xcons]]", that's a good idea.  We  
> could again fix the syntax and use it in the forthcoming  
> documentation review, delaying implementation to when we write the  
> main index itself.

That's pretty much where I was going with it. I'm particularly  
interested in indexing
the Chicken manual itself, though the same mechanism is useful for  
eggs. Automatic
indexing is a good start, but there's always a need to add entries  
manually, for example,

  List procedures
    alist-ref
    append-reverse (SRFI-1)
    ,,,

The same mechanism that makes for a good searchable index a la the  
CLHS also makes it
possible to produce a nice printed index.

-- v