From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Ramin Honary Newsgroups: gmane.emacs.help Subject: I'd like to request a change to the Emacs Info documentation Date: Fri, 21 Jan 2022 12:38:36 +0900 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="38635"; mail-complaints-to="usenet@ciao.gmane.io" To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jan 21 04:39:18 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 1nAkli-0009tZ-HI for geh-help-gnu-emacs@m.gmane-mx.org; Fri, 21 Jan 2022 04:39:18 +0100 Original-Received: from localhost ([::1]:56558 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nAklg-0005nj-V2 for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 20 Jan 2022 22:39:16 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:56996) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nAklJ-0005nb-03 for help-gnu-emacs@gnu.org; Thu, 20 Jan 2022 22:38:53 -0500 Original-Received: from [2a00:1450:4864:20::530] (port=39690 helo=mail-ed1-x530.google.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nAklG-0003Yl-Iw for help-gnu-emacs@gnu.org; Thu, 20 Jan 2022 22:38:52 -0500 Original-Received: by mail-ed1-x530.google.com with SMTP id u18so23202837edt.6 for ; Thu, 20 Jan 2022 19:38:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cross-compass-com.20210112.gappssmtp.com; s=20210112; h=mime-version:from:date:message-id:subject:to; bh=lMcEF4iY7wa2MAzv92j5I3m9mQA16EvtrYD1XY1E1Fs=; b=O/4jC/KeOxzFQiHHiS47V1BKVzf6uB7bgoEYhJ9tcg9rlwPVeqDgsrmHUaKrupmtHN WPCzG8dgg5yj/uPzIAjZY9bMaEXaxxy8P+JA52vxf3cAcmtYJgAQdEU28oHHu/Sp/F4l c92VmMTO+cOVHtBUQ3+rXWRaxT211HTjX9RmS59Z+SHFOGZHilTHH8SEtxN/nWCE68Jo va1j9kZH3iSiHaJZQUDcyoLFRHpx9E+cKCJIP3CeKtKwD+1O0Ves38DcJSyrW92dewqD luVYCfGGcQCEyJk7IF6/mHs59md3pqpb7zizrmPQjhH03pvEpXVc9VQbx3P44H7GvTAy 3NrQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=lMcEF4iY7wa2MAzv92j5I3m9mQA16EvtrYD1XY1E1Fs=; b=XJ+Ero/s+JdAXn35J/BsLDl9mpIoJfK9u3jHdysA6iGL33souVQN1BL1l6becwZcFM BGGADkDzC/JF+JJuy7LN2VQK+H/zvm5O4U09oXfOD1XNnRQPF7LReYvCdavxYskWVD+H i5Kcfaa0WiaRzOiCfuD3mdhE3TcaI2rpDPxB16+ROSFltSN0vYecnZbqFJplA7ja+ueR s9BWC6f65q73D7c1MAZOzS5IDSaTMfou7bOp7GjMNuaHMEUsOTp/k9LqckWYu1LYJslR gLi7qRuwIEAnMvC2Ltqm5tgjaezogmSNNHdtv+7bQuSCC9q9CENFkINLy6LMlnD66ZYx 2o8g== X-Gm-Message-State: AOAM531idxaFgPZ7oy23lxzC8NwJngEmpwEkzXpkefqekpJciGaPMlWL gyeokFh3vC6feYUZDR9WgwlWGap7V8vHh7+cBzAlPToVESmhzw== X-Google-Smtp-Source: ABdhPJy8bR6k8Dxn714XlsgfzeucW0laS8o1Qw8vZN37drrn0kYrCwHAPuJ/9lTbuml48AKgGxn5tb2ylBH/pJi7xtQ= X-Received: by 2002:a50:d710:: with SMTP id t16mr2489210edi.50.1642736326819; Thu, 20 Jan 2022 19:38:46 -0800 (PST) X-Host-Lookup-Failed: Reverse DNS lookup failed for 2a00:1450:4864:20::530 (failed) Received-SPF: pass client-ip=2a00:1450:4864:20::530; envelope-from=ramin.honary@cross-compass.com; helo=mail-ed1-x530.google.com X-Spam_score_int: -10 X-Spam_score: -1.1 X-Spam_bar: - X-Spam_report: (-1.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, PDS_HP_HELO_NORDNS=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action 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:135463 Archived-At: 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.