From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Documentation for "Clone Buffers" (corrected version) Date: 14 Mar 2004 09:36:05 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: References: <200403121634.i2CGYrZ04201@f7.net> <200403140232.i2E2WUT01565@raven.dms.auburn.edu> Reply-To: Eli Zaretskii NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1079250006 28525 80.91.224.253 (14 Mar 2004 07:40:06 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sun, 14 Mar 2004 07:40:06 +0000 (UTC) Cc: acm@muc.de, emacs-devel@gnu.org, karl@freefriends.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Sun Mar 14 08:40:00 2004 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1B2QE4-0007FV-00 for ; Sun, 14 Mar 2004 08:40:00 +0100 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1B2QE4-000149-00 for ; Sun, 14 Mar 2004 08:40:00 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.30) id 1B2Q9R-0004jr-7k for emacs-devel@quimby.gnus.org; Sun, 14 Mar 2004 02:35:13 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.30) id 1B2Q8e-0004iO-0T for emacs-devel@gnu.org; Sun, 14 Mar 2004 02:34:24 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.30) id 1B2Q84-0004Tw-Nh for emacs-devel@gnu.org; Sun, 14 Mar 2004 02:34:21 -0500 Original-Received: from [207.232.27.5] (helo=WST0054) by monty-python.gnu.org with asmtp (Exim 4.30) id 1B2Q83-0004Qx-Fh; Sun, 14 Mar 2004 02:33:47 -0500 Original-To: Luc Teirlinck In-reply-to: <200403140232.i2E2WUT01565@raven.dms.auburn.edu> (message from Luc Teirlinck on Sat, 13 Mar 2004 20:32:30 -0600 (CST)) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.4 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:20449 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:20449 > Date: Sat, 13 Mar 2004 20:32:30 -0600 (CST) > From: Luc Teirlinck > > What about the following patch to info.texi, documenting M-n, C-u m > and C-u g? Fine with me (but see the minor comments below). > I could install in the Emacs CVS version of info.texi, if desired. AFAIK, that's the master version of info.texi. > + @unnumberedsubsec @kbd{M-n} creates a cloned Info buffer in Emacs Do we really need a new section for this? > + @kindex M-n @r{(Info mode)} > + @findex clone-buffer > + @cindex cloning an Info buffer in Emacs > + If you are reading Info in Emacs, you can select a new independent > + Info buffer in another window by typing @kbd{M-n}. The new buffer is > + a ``cloned'' version of the old one. The info.texi manual is for a novice user, since Info is for reading the documentation, and a user who needs to use Info is generally not an Emacs junky. Even in its ``advanced'' sections, this manual assumes a user who is not really ``advanced'' by the Emacs standards. Such a user might not know what buffer cloning means. Hence, I think we should explain this term before we use it. In any case, the first use of "cloned" should be in @dfn (and without the quotes, as @dfn takes care of that). We should also have an xref to the section in the Emacs manual that describes cloned buffers, I think. > + @kindex C-u g @r{(Info mode)} > + @kindex C-u m @r{(Info mode)} > + In Emacs Info, you can also produce cloned Info buffers by giving a > + numeric prefix argument to the @kbd{m} and @kbd{g} commands. @kbd{C-u m} > + and @kbd{C-u g} go to a new node in exactly the same way that @kbd{m} > + and @kbd{g} do, but they do so in a new cloned Info buffer which they > + select in another window. I think this description should be copied (copied, not moved) into the part that describes `g' and `m', and then the @kindex entries should be removed. To the best of my knowledge, no other place in the Emacs manuals indexes commands starting with the prefix argument; we always document the command itself and describe there the effect of the argument.