Re: Faces customization group linked from mode groups

[Juri Linkov]

>     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/