emacs-devel
[Top][All Lists]
Advanced

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

Re: generate 2) other pages for Info


From: Eli Zaretskii
Subject: Re: generate 2) other pages for Info
Date: Sun, 23 Sep 2007 21:18:42 +0200

> From: Bastien <address@hidden>
> Date: Sun, 23 Sep 2007 16:17:40 +0200
> Cc: address@hidden, address@hidden
> 
> 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 via email to

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