From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "Samuel Banya" Newsgroups: gmane.emacs.help Subject: Re: I'd like to request a change to the Emacs Info documentation Date: Fri, 21 Jan 2022 09:03:58 -0500 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="38727"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Cyrus-JMAP/3.5.0-alpha0-4585-ga9d9773056-fm-20220113.001-ga9d97730 To: "Emanuel Berg" Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jan 21 15:31:08 2022 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nAuwU-0009vP-NS for geh-help-gnu-emacs@m.gmane-mx.org; Fri, 21 Jan 2022 15:31:06 +0100 Original-Received: from localhost ([::1]:41928 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nAuwT-0004by-JN for geh-help-gnu-emacs@m.gmane-mx.org; Fri, 21 Jan 2022 09:31:05 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:47252) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nAuXI-0004Yi-I0 for help-gnu-emacs@gnu.org; Fri, 21 Jan 2022 09:05:05 -0500 Original-Received: from wout2-smtp.messagingengine.com ([64.147.123.25]:44481) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nAuXD-0002OE-NF for help-gnu-emacs@gnu.org; Fri, 21 Jan 2022 09:05:02 -0500 Original-Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.west.internal (Postfix) with ESMTP id 6FF4B3202195 for ; Fri, 21 Jan 2022 09:04:19 -0500 (EST) Original-Received: from imap49 ([10.202.2.99]) by compute2.internal (MEProxy); Fri, 21 Jan 2022 09:04:19 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.com; h= cc:content-type:date:date:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:sender:subject :subject:to:to; s=fm2; bh=qnfUN+rWAQtD4XPZiQpx7BnUNW+4CtkxI+2hAl 8sFes=; b=BhTyDOLZbXDvs3NBnHC4B1uVZSygyQyNs6SxjMAot83D4DTLOBtmCJ Ryzgyt8eAv2w4rjS/P8KEB+eU+MGi7qPznGaX+9sthRRa0zqP1N9hFTwZtHpT/67 k9151SFqYDYvLZbfp1Y7P6rVpKjQZc0C6qABgtbvMQfbWnIqb+R+C2WRXHrSovOI txeHrZS5W7DcYC6wYzI04D+J1NZBimMUbCUGuTtN5C+1mFwz8cmbQDwDyC1FkbFU EnR8eVRldLxN3ttsKKstfKr2NlPYVfMHDsJfikmTiDttiaK7u2prN+Y1dS9HaKjF yfQoj8W2rP4dbrGkPBJXimE7bwS6FOrQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=qnfUN+rWAQtD4XPZi Qpx7BnUNW+4CtkxI+2hAl8sFes=; b=dz7rgfK6fFjZIx7pg9hyNIRb4TtaP5aLt DIFqasgU6809lCeL/mSFRtsl/Hqj9pwdaFOGJqZqx3Zq01DME5KQFwRRPCPuuCs1 zkDd6kYQXfOsTVgEhcfX5hxHq438M7Kw02fly/drBDIbHI/7vL2ElCXJzOanmTxA WUNCs7q8NXsJigkFIj+ERu6CrEhfJeOwgjtLSAdSIOCy8DQfWPlHlAty8O7QQbv7 BNf9+oC62G81jZpyzcbj6AQ0KEH0bCDXtCts9Mu+eAKbeF+CB6a0Kliy7nuhv+uZ sTnnZYXlgobOWn4A9/i0Z3DwiEgeoErUGEg5QH41nrKPhrBSXOpKg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvvddrvddtgdehlecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhepofgfggfkjghffffhvffutgesrgdtre erreertdenucfhrhhomhepfdfurghmuhgvlhcuuegrnhihrgdfuceoshgsrghnhigrsehf rghsthhmrghilhdrtghomheqnecuggftrfgrthhtvghrnhepgfeuieetudduhefghedutd evueehueeftefhjeeltddufeefhfegkefhtedvgefhnecuffhomhgrihhnpehrvgguughi thdrtghomhenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhroh hmpehssggrnhihrgesfhgrshhtmhgrihhlrdgtohhm X-ME-Proxy: Original-Received: by mailuser.nyi.internal (Postfix, from userid 501) id 91E17F6008B; Fri, 21 Jan 2022 09:04:18 -0500 (EST) X-Mailer: MessagingEngine.com Webmail Interface In-Reply-To: Received-SPF: pass client-ip=64.147.123.25; envelope-from=sbanya@fastmail.com; helo=wout2-smtp.messagingengine.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Content-Filtered-By: Mailman/MimeDel 2.1.29 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:135478 Archived-At: Hey Ramin, I think its a good idea to just ask the 'emacs-devel@gnu.org' mailing list to see if they can incorporate it into the manual. I think its a good idea in general, so go for it! ~ Sam On Thu, Jan 20, 2022, at 10:38 PM, Ramin Honary wrote: > 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. > > 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) > - Press `s` to do a full text search. > -------------------------------------------- > - Press `q` to quit (close this screen) > - Press `H` for more help with keyboard shortcuts. > > The justification is that search is considered essential functionality > in documentation nowadays, if people do not find search functionality > *immediately* they go to Google to search instead. Ideally, the > documentation would present an interactive search at the very top, as > most modern documentation browsers do. But failing that, the next best > thing is to put up an easy-to-read sign about how to do search. > > As it is now, if you follow the instructions at the top of the Emacs > manual, it merely tells you to press "h" to learn more about how to > use the Info documentation browser, and pressing "h" only takes you to > section 1.2 of the Info manual. How to search is not listed anywhere > in section 1 of the Info manual, it is listed in section 2 under the > "Advanced" functionality, so not only is search NOT the first thing an > end user sees, they would likely have a hard time finding it. > > 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 first brought it up online on Reddit in this thread: > https://www.reddit.com/r/emacs/comments/s4za7y/comment/hsz1cqb/ and > decided to find out what I can do to go ahead and make this change, if > the developers find it to be a reasonable request. > > Any advice on my next steps toward making this change is appreciated. > >