all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: emacs-devel@gnu.org
Subject: Re: standard error not in Elisp manual index
Date: Sat, 31 Mar 2007 17:57:48 +0300	[thread overview]
Message-ID: <u7isx795f.fsf@gnu.org> (raw)
In-Reply-To: <EIENLHALHGIMHGDOLMIMOECADAAA.drew.adams@oracle.com>

> From: "Drew Adams" <drew.adams@oracle.com>
> Cc: <emacs-devel@gnu.org>
> 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.

  parent reply	other threads:[~2007-03-31 14:57 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-03-23 23:22 standard error not in Elisp manual index Drew Adams
2007-03-24 16:49 ` Eli Zaretskii
2007-03-24 20:54   ` Drew Adams
2007-03-31 10:58     ` Eli Zaretskii
2007-03-31 14:57     ` Eli Zaretskii [this message]
2007-03-31 15:06       ` Drew Adams
2007-03-31 17:28         ` Eli Zaretskii
2007-03-24 23:01 ` Richard Stallman
2007-03-25  0:11   ` Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=u7isx795f.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.