From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.devel Subject: Re: Faces customization group linked from mode groups Date: Thu, 17 Nov 2005 09:46:35 +0200 Organization: JURTA Message-ID: <87oe4kxfaw.fsf@jurta.org> References: <436BDAC7.2090704@student.lu.se> <87hdarodih.fsf@jurta.org> <436D0F14.7000908@student.lu.se> <87irv4d00h.fsf@jurta.org> <87u0eeam1d.fsf@jurta.org> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1132215051 11022 80.91.229.2 (17 Nov 2005 08:10:51 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Thu, 17 Nov 2005 08:10:51 +0000 (UTC) Cc: lennart.borgman.073@student.lu.se, emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Nov 17 09:10:49 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1EceqM-0006t6-8c for ged-emacs-devel@m.gmane.org; Thu, 17 Nov 2005 09:10:06 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1EceqK-0007Du-P6 for ged-emacs-devel@m.gmane.org; Thu, 17 Nov 2005 03:10:05 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Eceg7-0004QG-Di for emacs-devel@gnu.org; Thu, 17 Nov 2005 02:59:31 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Eceg5-0004Pp-Dp for emacs-devel@gnu.org; Thu, 17 Nov 2005 02:59:29 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Eceg4-0004Pj-Bu for emacs-devel@gnu.org; Thu, 17 Nov 2005 02:59:28 -0500 Original-Received: from [194.126.101.111] (helo=mail.neti.ee) by monty-python.gnu.org with esmtp (Exim 4.34) id 1Eceg2-0006O0-LI; Thu, 17 Nov 2005 02:59:27 -0500 Original-Received: from mail.neti.ee (80-235-34-68-dsl.mus.estpak.ee [80.235.34.68]) by Relayhost1.neti.ee (Postfix) with ESMTP id AA22437DD; Thu, 17 Nov 2005 09:59:35 +0200 (EET) Original-To: rms@gnu.org In-Reply-To: (Richard M. Stallman's message of "Tue, 15 Nov 2005 18:21:11 -0500") User-Agent: Gnus/5.110004 (No Gnus v0.4) Emacs/22.0.50 (gnu/linux) X-Virus-Scanned: by amavisd-new-2.2.1 (20041222) (Debian) at neti.ee X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:46145 Archived-At: > From all these link types only four are documented in the Emacs Lisp > manual in the node (info "(elisp)Common Keywords"): custom-manual, > info-link, url-link and emacs-commentary-link. What about documenting > remaining six types: custom-group-link, function-link, variable-link, > file-link, emacs-library-link and documentation-link? > > In principle it sounds good. Please write a patch we could consider. Index: lispref/customize.texi =================================================================== RCS file: /cvsroot/emacs/emacs/lispref/customize.texi,v retrieving revision 1.48 diff -c -r1.48 customize.texi *** lispref/customize.texi 17 Oct 2005 06:46:14 -0000 1.48 --- lispref/customize.texi 17 Nov 2005 07:45:35 -0000 *************** *** 51,75 **** This is a sentence containing an active field which references some other documentation. ! There are four alternatives you can use for @var{link-data}: @table @code @item (custom-manual @var{info-node}) Link to an Info node; @var{info-node} is a string which specifies the node name, as in @code{"(emacs)Top"}. The link appears as ! @samp{[manual]} in the customization buffer. @item (info-link @var{info-node}) Like @code{custom-manual} except that the link appears in the customization buffer with the Info node name. @item (url-link @var{url}) ! Link to a web page; @var{url} is a string which specifies the @acronym{URL}. ! The link appears in the customization buffer as @var{url}. @item (emacs-commentary-link @var{library}) Link to the commentary section of a library; @var{library} is a string which specifies the library name. @end table You can specify the text to use in the customization buffer by adding --- 51,97 ---- This is a sentence containing an active field which references some other documentation. ! There are several alternatives you can use for @var{link-data}: @table @code @item (custom-manual @var{info-node}) Link to an Info node; @var{info-node} is a string which specifies the node name, as in @code{"(emacs)Top"}. The link appears as ! @samp{[Manual]} in the customization buffer. When this link is ! invoked, the built-in Info reader is started on @var{info-node}. @item (info-link @var{info-node}) Like @code{custom-manual} except that the link appears in the customization buffer with the Info node name. @item (url-link @var{url}) ! Link to a web page; @var{url} is a string which specifies the ! @acronym{URL}. The link appears in the customization buffer as ! @var{url}. When this link is invoked, the WWW browser specified by ! `browse-url-browser-function' will be called with @var{url}. @item (emacs-commentary-link @var{library}) Link to the commentary section of a library; @var{library} is a string which specifies the library name. + + @item (emacs-library-link @var{library}) + Link to an Emacs Lisp library file; @var{library} is a string which + specifies the library name. + + @item (file-link @var{file}) + Link to a file; @var{file} is a string which specifies the file name. + + @item (function-link @var{function}) + Link to the documentation of a function; @var{function} is a string + which specifies the function name. + + @item (variable-link @var{variable}) + Link to the documentation of a variable; @var{variable} is a string + which specifies the variable name. + + @item (custom-group-link @var{group}) + Link to another customization group. Invoking it creates a new + customization buffer for @var{group}. @end table You can specify the text to use in the customization buffer by adding Index: lisp/custom.el =================================================================== RCS file: /cvsroot/emacs/emacs/lisp/custom.el,v retrieving revision 1.104 diff -c -r1.104 custom.el *** lisp/custom.el 24 Oct 2005 16:17:11 -0000 1.104 --- lisp/custom.el 17 Nov 2005 07:45:35 -0000 *************** *** 210,221 **** item. This is a sentence containing an active field which references some other documentation. ! There are three alternatives you can use for LINK-DATA: (custom-manual INFO-NODE) Link to an Info node; INFO-NODE is a string which specifies ! the node name, as in \"(emacs)Top\". The link appears as ! `[manual]' in the customization buffer. (info-link INFO-NODE) Like `custom-manual' except that the link appears in the --- 210,220 ---- item. This is a sentence containing an active field which references some other documentation. ! There are several alternatives you can use for LINK-DATA: (custom-manual INFO-NODE) Link to an Info node; INFO-NODE is a string which specifies ! the node name, as in \"(emacs)Top\". (info-link INFO-NODE) Like `custom-manual' except that the link appears in the *************** *** 223,229 **** (url-link URL) Link to a web page; URL is a string which specifies the URL. ! The link appears in the customization buffer as URL. You can specify the text to use in the customization buffer by adding `:tag NAME' after the first element of the LINK-DATA; for --- 222,245 ---- (url-link URL) Link to a web page; URL is a string which specifies the URL. ! ! (emacs-commentary-link LIBRARY) ! Link to the commentary section of LIBRARY. ! ! (emacs-library-link LIBRARY) ! Link to an Emacs Lisp LIBRARY file. ! ! (file-link FILE) ! Link to FILE. ! ! (function-link FUNCTION) ! Link to the documentation of FUNCTION. ! ! (variable-link VARIABLE) ! Link to the documentation of VARIABLE. ! ! (custom-group-link GROUP) ! Link to another customization GROUP. You can specify the text to use in the customization buffer by adding `:tag NAME' after the first element of the LINK-DATA; for -- Juri Linkov http://www.jurta.org/emacs/