emacs-devel
[Top][All Lists]
Advanced

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

Re: standard error not in Elisp manual index


From: Eli Zaretskii
Subject: Re: standard error not in Elisp manual index
Date: Sat, 31 Mar 2007 17:57:48 +0300

> From: "Drew Adams" <address@hidden>
> Cc: <address@hidden>
> Date: Sat, 24 Mar 2007 13:54:26 -0700
> 
> > > There might be other top-level menu terms that should also be in the
> > > index.
> >
> > Yes, there might, so please tell if you find any.
> 
> 1. These terms are not in the index (at least in these forms):

I added some of these (about half of what you suggested).  Some
reasons for not adding the others:

  . Minor differences wrt to existing entries (e.g., "do something"
    when "doING something" already exists).

  . Entries that might be suitable for the user manual, not for the
    ELisp manual, whose readers are programmers looking for Lisp
    features.  Examples: copy text, cut, FOO mode, utf-8.

  . Entries for issues that people are unlikely to look up in this
    specific manual.  Example: gpl.

> 2. As a rule of thumb, it would be good for each of the top-level menu items
> to be the first or near the first hit for the keywords in that item name, or
> keywords closely associated with that item name.
> 
> For example, the node addressed by menu item _Functions_ should be among the
> first hits if you use `i function'. As it is now, that node is accessed only
> after a hundred or so uses of `,' after `i function'. Consider doing this
> for these top-level menu items:

While I agree with the feature you suggest, I don't think that its
implementation should by by tweaking index entries in the manual.
More likely, this is something Info should do when it sorts hits for
display.

So I didn't use the suggestions in this group.

> 3. These terms have no entries for the nodes in parens:
> 
> memory (Memory Usage)
> documentation (Documentation Tips)
> warning (Warning Tips)
> key binding (Key Binding Conventinos)

I'm not sure what you meant by these.  Please explain.

Thanks again for taking time to write these suggestions.




reply via email to

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