all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Bastien <bzg@altern.org>
Cc: emacs-devel@gnu.org
Subject: Re: generate 2) other pages for Info
Date: Sun, 23 Sep 2007 21:18:42 +0200	[thread overview]
Message-ID: <u1wcpyyul.fsf@gnu.org> (raw)
In-Reply-To: <87sl55a2kb.fsf@bzg.ath.cx> (message from Bastien on Sun, 23 Sep 2007 16:17:40 +0200)

> From: Bastien <bzg@altern.org>
> Date: Sun, 23 Sep 2007 16:17:40 +0200
> Cc: drew.adams@oracle.com, emacs-devel@gnu.org
> 
> Imagine someone is looking for the command that add a ChangeLog entry.
> Here are a few different searching paths he might go through:
> 
> 1. His first reflex is to go to the Emacs manual. Great! It's there.
> 
> 2. He thinks he can use `finder-by-keyword' (C-h P) for that. If he is
>    brave enough to go to the end of the list, he will find "tools", then
>    add-log.el, then he will stumble on "This facility is documented in
>    the Emacs Manual." Okay, then he should have gone there first.
> 
> 3. He is used to `apropos-command' (C-h a). He tries that and look for
>    "ChangeLog". Bad luck. He will find this:
> 
>    log-edit-add-to-changelog     M-x ... RET
>    log-edit-insert-changelog     M-x ... RET

My personal recommendation is use the Help commands in a different
order:

  1. Info-index (`i' in Info mode)

  2. M-x apropos

  3. M-x apropos-documentation

> So here is what a personal help manager could store:
> 
> | searched              | found                | manual                    |
> |-----------------------+----------------------+---------------------------|
> | Add a ChangeLog entry | add-change-log-entry | (info "(emacs)Change Log) |
> 
> (This is actually what I'm trying to use inside my org-mode file.)

After 10 years of using Emacs, this index will become so huge that it
will be unusable, I'm pretty sure.

> > I think only adding various index entries including most synonyms
> > (e.g. "revert", "refresh", "update", ...) will help to find the entry.
> 
> The main job of the personal help manager would be to be able to find
> these synonyms. I guess different people would use different synonyms
> sets (not mentionning language-dependant issues).

We could collect those synonyms for them (we actually do that today,
in the index entries we place in the manual, please take a look).

  reply	other threads:[~2007-09-23 19:18 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-09-23  9:47 generate 1) virtual index and 2) other pages for Info; 3) S-mouse-2: follow link in new window Drew Adams
2007-09-23 11:09 ` Bastien
2007-09-23 12:03   ` generate 2) other pages for Info Juri Linkov
2007-09-23 12:38     ` Lennart Borgman (gmail)
2007-09-23 14:17     ` Bastien
2007-09-23 19:18       ` Eli Zaretskii [this message]
2007-09-24  0:27         ` Bastien
2007-09-23 21:54     ` Richard Stallman
2007-09-23 11:41 ` generate 1) virtual index Juri Linkov
2007-09-23 16:43   ` Drew Adams
2007-09-23 20:42     ` Juri Linkov
2007-09-24  7:09       ` Drew Adams
2007-09-23 11:45 ` generate 2) other pages for Info Juri Linkov
2007-09-23 12:00 ` generate 3) S-mouse-2: follow link in new window Juri Linkov
2007-09-23 16:44   ` Drew Adams
2007-09-23 19:14     ` Lennart Borgman (gmail)
2007-09-23 20:42       ` Drew Adams
2007-09-24  0:20         ` Johan Bockgård
2007-09-24  1:22         ` Stefan Monnier
2007-09-24  2:01           ` Drew Adams
2007-09-24 18:20             ` Richard Stallman
2007-09-27 21:21               ` Drew Adams
2007-09-27 21:34                 ` David Kastrup
2007-09-27 21:34                 ` Stefan Monnier
2007-09-27 21:41                   ` Drew Adams
2007-09-27 21:53                 ` Drew Adams
2007-09-28 19:04                 ` Richard Stallman
2007-09-28 19:33                   ` Drew Adams
2007-09-28 22:22                     ` David Kastrup
2007-09-30  2:19                       ` Drew Adams
2007-09-30  8:54                         ` David Kastrup
2007-09-30 23:37                           ` Drew Adams
2007-09-30 23:49                             ` David Kastrup
2007-10-01  1:36                           ` Richard Stallman
2007-09-25 23:39     ` info.el patch to open node in new window [was: generate 3) S-mouse-2: follow link in new window] Drew Adams
2007-09-26  8:56       ` Juri Linkov
2007-09-26 15:02         ` Drew Adams
2007-09-29 22:44           ` info.el patch to open node in new window Juri Linkov
2007-09-30  2:19             ` Drew Adams
2007-09-29 22:41     ` generate 3) S-mouse-2: follow link " Juri Linkov
2007-09-30  2:19       ` Drew Adams
2007-09-29 22:43 ` Juri Linkov
2007-09-30  2:18   ` 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=u1wcpyyul.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=bzg@altern.org \
    --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.