bug-texinfo
[Top][All Lists]
Advanced

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

Re: info --index not finding all indexed entries


From: Ralf Wildenhues
Subject: Re: info --index not finding all indexed entries
Date: Wed, 18 Aug 2010 20:17:15 +0200
User-agent: Mutt/1.5.20 (2010-04-22)

Hello again,

* Eli Zaretskii wrote on Fri, Jul 30, 2010 at 08:26:33PM CEST:
> > > Which means the Automake manual needs to be fixed.  Having more than
> > > one index entry in different places is not a good idea, and this
> > > thread is just another instance of the proof.
> > 
> > I wasn't aware that this is considered a bad idea in general, and I'm
> > not quite convinced yet: checked now, the Automake manual contains more
> > than hundred duplicate entries, the Autoconf roughly 60, the Texinfo
> > manual at least three dozen.  Are those all bugs?
> 
> Not bugs, just not the best style.  It makes it harder to use the
> indices efficiently.

> > > One of the entries should be qualified, like
> > > 
> > >   @findex AM_INIT_AUTOMAKE, how to ...

I'm trying to improve the manual based on your good suggestions, but
have more questions that I don't find answered in the Texinfo manual:

For functions or macros like above, where there is typically one
definition in the manual but several potentially interesting places
a user might want to look up, do you recommend putting only the
actual definition in the function index @findex, and all other, more
qualified ones, in the concept index @cindex, or would you say it's
better to add all of them to the function index?  Or at least up to
the point where the macro name is more important in the index entry
than some idea or concept surrounding it?

This is probably far from an all-or-nothing answer, but some guidance
could help.

Then, I noticed that
  @ftable
  @item function(args)
  ...
  @end ftable

causes 'function(args)' to be indexed, not just 'function'.  Bug or
feature?  If the latter, is there a way to avoid it without rewriting
the whole (large) table to not use @ftable?

More generally, is it possible to have @item's in an @ftable which
aren't indexed (so I could override the index entry manually), and
if not, any chance such functionality could be added?

Thanks,
Ralf



reply via email to

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