From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Jean-Christophe Helary Newsgroups: gmane.emacs.devel Subject: Re: [ELPA] New package: transient Date: Tue, 5 May 2020 17:23:24 +0900 Message-ID: References: <87368npxw4.fsf@bernoul.li> <87v9ljo5d0.fsf@bernoul.li> <87ftcnxu5m.fsf@bernoul.li> <83y2qezlpd.fsf@gnu.org> <83tv12zjx1.fsf@gnu.org> <20200429101755.GF24737@tuxteam.de> <838sicw4do.fsf@gnu.org> <83zhaqu89z.fsf@gnu.org> <83sggiu2p9.fsf@gnu.org> <83r1w2s9wi.fsf@gnu.org> <83v9leqmss.fsf@gnu.org> <83zhapoz63.fsf@gnu.org> <0a13f7e1-61c7-1e78-22bc-a27c15c269e7@yandex.ru> <83h7wxotix.fsf@gnu.org> <18096f9a-c617-f37b-cdaa-1a6198db2e1c@yandex.ru> <83a72porka.fsf@gnu.org> <83mu6nok4v.fsf@gnu.org> Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.80.23.2.2\)) Content-Type: multipart/mixed; boundary="Apple-Mail=_C5780948-363A-4343-B12F-640FB75C9B92" Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="17142"; mail-complaints-to="usenet@ciao.gmane.io" To: Emacs developers Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue May 05 10:31:54 2020 Return-path: Envelope-to: ged-emacs-devel@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 1jVszY-0004K4-42 for ged-emacs-devel@m.gmane-mx.org; Tue, 05 May 2020 10:31:52 +0200 Original-Received: from localhost ([::1]:52708 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jVszW-0002B2-UF for ged-emacs-devel@m.gmane-mx.org; Tue, 05 May 2020 04:31:50 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35700) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jVsxX-00080Z-0L for emacs-devel@gnu.org; Tue, 05 May 2020 04:29:47 -0400 Original-Received: from relay4-d.mail.gandi.net ([217.70.183.196]:40763) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jVsxV-0006eS-1q for emacs-devel@gnu.org; Tue, 05 May 2020 04:29:46 -0400 X-Originating-IP: 128.53.210.217 Original-Received: from [10.0.1.13] (pl6361.ag0304.nttpc.ne.jp [128.53.210.217]) (Authenticated sender: jean.christophe.helary@traduction-libre.org) by relay4-d.mail.gandi.net (Postfix) with ESMTPSA id C8AD7E0011 for ; Tue, 5 May 2020 08:29:12 +0000 (UTC) In-Reply-To: <83mu6nok4v.fsf@gnu.org> X-Mailer: Apple Mail (2.3608.80.23.2.2) Received-SPF: pass client-ip=217.70.183.196; envelope-from=jean.christophe.helary@traduction-libre.org; helo=relay4-d.mail.gandi.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/05/05 04:29:41 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:248954 Archived-At: --Apple-Mail=_C5780948-363A-4343-B12F-640FB75C9B92 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 > On May 4, 2020, at 23:22, Eli Zaretskii wrote: >=20 >> From: Jean-Christophe Helary = >> Date: Mon, 4 May 2020 10:13:56 +0900 >> Cc: Dmitry Gutov , >> tomas@tuxteam.de, >> Emacs developers , >> Stefan Monnier , >> rms@gnu.org >>=20 >>> I'd rather expect that people would listen to better tools being >>> presented to them, and would consider using them to enrich their >>> experience and make their everyday's life better. >>=20 >> Would you consider that a tutorial on the information search system = provided by emacs would help in that matter ? >=20 > Maybe. I don't think I understand well enough what would such a > tutorial include. You didn't say. What a tutorial usually includes is step-by-step help with practical = examples. I'll be putting that on my todo list. > We already have some of that ion the Emacs tutorial Very little in fact: C-h t C-h i C-h f C-h v M-. =E2=86=92 "requires running etags to record all the manuals nodes" C-h p in a quote from the Emacs manual M-x apropos C-h a =E2=86=92 the example Chassell gives produces 211 results > and then we have the "Help" chapter in the Emacs manual. The Help chapter provides a "summary of help commands for accessing the = built-in documentation." That summary does not group the information by = topic but merely lists the commands in the alphabetical order of the = keys. Let me attach a patch that groups the commands by topic (tables) in that = summary. I am not sure adding a @subsection is the best way to label = such groups (tables) but I could not find a better solution. Jean-Christophe Helary ----------------------------------------------- http://mac4translators.blogspot.com @brandelune --Apple-Mail=_C5780948-363A-4343-B12F-640FB75C9B92 Content-Disposition: attachment; filename=help.texi.200505.diff Content-Type: application/octet-stream; x-unix-mode=0644; name="help.texi.200505.diff" Content-Transfer-Encoding: 7bit diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 49c53c5cbc..ee7435fc13 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -86,94 +86,139 @@ Help Summary documentation. Most of these are described in more detail in the following sections. +@subsection Commands, functions, variables, symbols + @table @kbd @item C-h a @var{topics} @key{RET} Display a list of commands whose names match @var{topics} (@code{apropos-command}). -@item C-h b -Display all active key bindings; minor mode bindings first, then those -of the major mode, then global bindings (@code{describe-bindings}). -@item C-h c @var{key} -Show the name of the command that the key sequence @var{key} is bound -to (@code{describe-key-briefly}). Here @kbd{c} stands for -``character''. For more extensive information on @var{key}, use -@kbd{C-h k}. + @item C-h d @var{topics} @key{RET} Display the commands and variables whose documentation matches @var{topics} (@code{apropos-documentation}). -@item C-h e -Display the @file{*Messages*} buffer -(@code{view-echo-area-messages}). + +@item C-h F @var{command} @key{RET} +Enter Info and go to the node that documents the Emacs command +@var{command} (@code{Info-goto-emacs-command-node}). + @item C-h f @var{function} @key{RET} Display documentation on the Lisp function named @var{function} (@code{describe-function}). Since commands are Lisp functions, this works for commands too. -@item C-h h -Display the @file{HELLO} file, which shows examples of various character -sets. -@item C-h i -Run Info, the GNU documentation browser (@code{info}). The Emacs -manual is available in Info. -@item C-h k @var{key} -Display the name and documentation of the command that @var{key} runs -(@code{describe-key}). -@item C-h l -Display a description of your last 300 keystrokes -(@code{view-lossage}). -@item C-h m -Display documentation of the current major mode and minor modes -(@code{describe-mode}). -@item C-h n -Display news of recent Emacs changes (@code{view-emacs-news}). + +@item C-h v @var{var} @key{RET} +Display the documentation of the Lisp variable @var{var} +(@code{describe-variable}). + @item C-h o @var{symbol} Display documentation of the Lisp symbol named @var{symbol} (@code{describe-symbol}). This will show the documentation of all kinds of symbols: functions, variables, and faces. + +@item C-h S @var{symbol} @key{RET} +Display the Info documentation on symbol @var{symbol} according to the +programming language you are editing (@code{info-lookup-symbol}). +@end table + +@subsection Keys + +@table @kbd +@item C-h b +Display all active key bindings; minor mode bindings first, then those +of the major mode, then global bindings (@code{describe-bindings}). + +@item C-h c @var{key} +Show the name of the command that the key sequence @var{key} is bound +to (@code{describe-key-briefly}). Here @kbd{c} stands for +``character''. For more extensive information on @var{key}, use +@kbd{C-h k}. + +@item C-h k @var{key} +Display the name and documentation of the command that @var{key} runs +(@code{describe-key}). + +@item C-h K @var{key} +Enter Info and go to the node that documents the key sequence +@var{key} (@code{Info-goto-emacs-key-command-node}). + +@item C-h w @var{command} @key{RET} +Show which keys run the command named @var{command} (@code{where-is}). +@end table + +@subsection Modes, packages + +@table @kbd @item C-h p Find packages by topic keyword (@code{finder-by-keyword}). This lists packages using a package menu buffer. @xref{Packages}. + @item C-h P @var{package} @key{RET} Display documentation about the specified package (@code{describe-package}). -@item C-h r -Display the Emacs manual in Info (@code{info-emacs-manual}). -@item C-h s -Display the contents of the current @dfn{syntax table} -(@code{describe-syntax}). The syntax table says which characters are -opening delimiters, which are parts of words, and so on. @xref{Syntax -Tables,, Syntax Tables, elisp, The Emacs Lisp Reference Manual}, for -details. -@item C-h t -Enter the Emacs interactive tutorial (@code{help-with-tutorial}). -@item C-h v @var{var} @key{RET} -Display the documentation of the Lisp variable @var{var} -(@code{describe-variable}). -@item C-h w @var{command} @key{RET} -Show which keys run the command named @var{command} (@code{where-is}). + +@item C-h m +Display documentation of the current major mode and minor modes +(@code{describe-mode}). +@end table + +@subsection Input method, coding systems, languages + +@table @kbd @item C-h C @var{coding} @key{RET} Describe the coding system @var{coding} (@code{describe-coding-system}). + @item C-h C @key{RET} Describe the coding systems currently in use. -@item C-h F @var{command} @key{RET} -Enter Info and go to the node that documents the Emacs command -@var{command} (@code{Info-goto-emacs-command-node}). + @item C-h I @var{method} @key{RET} Describe the input method @var{method} (@code{describe-input-method}). -@item C-h K @var{key} -Enter Info and go to the node that documents the key sequence -@var{key} (@code{Info-goto-emacs-key-command-node}). + @item C-h L @var{language-env} @key{RET} Display information on the character sets, coding systems, and input methods used in language environment @var{language-env} (@code{describe-language-environment}). -@item C-h S @var{symbol} @key{RET} -Display the Info documentation on symbol @var{symbol} according to the -programming language you are editing (@code{info-lookup-symbol}). + +@item C-h h +Display the @file{HELLO} file, which shows examples of various character +sets. +@end table + +@subsection Various information buffers + +@table @kbd +@item C-h l +Display a description of your last 300 keystrokes +(@code{view-lossage}). + +@item C-h r +Display the Emacs manual in Info (@code{info-emacs-manual}). + +@item C-h t +Enter the Emacs interactive tutorial (@code{help-with-tutorial}). + +@item C-h i +Run Info, the GNU documentation browser (@code{info}) where all the +installed info manuals can be found. + +@item C-h e +Display the @file{*Messages*} buffer +(@code{view-echo-area-messages}). + +@item C-h n +Display news of recent Emacs changes (@code{view-emacs-news}). + @item C-h . Display the help message for a special text area, if point is in one (@code{display-local-help}). (These include, for example, links in @file{*Help*} buffers.) + +@item C-h s +Display the contents of the current @dfn{syntax table} +(@code{describe-syntax}). The syntax table says which characters are +opening delimiters, which are parts of words, and so on. @xref{Syntax +Tables,, Syntax Tables, elisp, The Emacs Lisp Reference Manual}, for +details. @end table @node Key Help --Apple-Mail=_C5780948-363A-4343-B12F-640FB75C9B92--