all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Po Lu <luangruo@yahoo.com>
To: Ramin Honary <ramin.honary@cross-compass.com>
Cc: help-gnu-emacs@gnu.org
Subject: Re: I'd like to request a change to the Emacs Info documentation
Date: Fri, 21 Jan 2022 11:53:09 +0800	[thread overview]
Message-ID: <87zgnpycbe.fsf@yahoo.com> (raw)
In-Reply-To: <CAEcHWvoKUqwq_bj8MK_KMWC-MtcdHXMMif5Rbs9Lr4d8BOkYvg@mail.gmail.com> (Ramin Honary's message of "Fri, 21 Jan 2022 12:38:36 +0900")

Ramin Honary <ramin.honary@cross-compass.com> writes:

> Hello, everyone. I thought it would be better to ask my question here
> first, so I don't end up adding noise to the emacs-devel@gnu.org
> mailing list.

This isn't much of a question, so I think it should be sent to
bug-gnu-emacs or emacs-devel instead.

> I would like to change the top-level node of the Info document for
> Emacs so that it displays in prominent lettering how to do index
> search (bound to the "i" key) and full text search (bound to the "s"
> key) at the top of the document. I would like it to read:
>
>    SEARCH IN THIS MANUAL:
>    - Press `i` to enter an index search term
>    - Press `m` to search this "menu" (the table of contents)

Does `m' really search the menu?  I thought it just asks for a menu item
to jump to.

>    - Press `s` to do a full text search.

This should probably mention that regexps are accepted.

>    - Press `q` to quit (close this screen)

I don't understand what kind of screen you refer to here.

> Search is not an "advanced" feature, it is *essential.* And I would
> argue that any mention of the most important feature of an interactive
> documentation browser has been completely buried, which is
> unfortunate.

I-search works in Info, so most Emacs users would probably try that
first.  Secondly, I think the best place to place this information (if
the advanced search functionality is indeed as important as you say it
is, of that I have no opinion) would be somewhere in section 1 of the
Info manual, instead of some extra text at the top level of the
directory node, since that text is not generated by Emacs.

Also, doesn't this kind of change have to be coordinated with the
stand-alone Info developers?  IIRC, the same documentation is used by
both Info readers.

Thanks.



  reply	other threads:[~2022-01-21  3:53 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-21  3:38 I'd like to request a change to the Emacs Info documentation Ramin Honary
2022-01-21  3:53 ` Po Lu [this message]
2022-01-21  7:35 ` Eli Zaretskii
2022-01-21 11:57   ` Emanuel Berg via Users list for the GNU Emacs text editor
2022-01-21 10:40 ` Jean Louis
2022-01-21 11:57   ` Emanuel Berg via Users list for the GNU Emacs text editor
2022-01-21 14:03 ` Samuel Banya
2022-01-21 15:40   ` Emanuel Berg via Users list for the GNU Emacs text editor

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=87zgnpycbe.fsf@yahoo.com \
    --to=luangruo@yahoo.com \
    --cc=help-gnu-emacs@gnu.org \
    --cc=ramin.honary@cross-compass.com \
    /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.