Mercurial > emacs
comparison lisp/custom.el @ 42503:e95910976840
(defcustom): Documented :tag, :link and :load.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Thu, 03 Jan 2002 16:56:30 +0000 |
parents | ad017e26a4db |
children | 37d771fc6685 |
comparison
equal
deleted
inserted
replaced
42502:3822dd3de3da | 42503:e95910976840 |
---|---|
1 ;;; custom.el --- tools for declaring and initializing options | 1 ;;; custom.el --- tools for declaring and initializing options |
2 ;; | 2 ;; |
3 ;; Copyright (C) 1996, 1997, 1999, 2001 Free Software Foundation, Inc. | 3 ;; Copyright (C) 1996, 1997, 1999, 2001, 2002 Free Software Foundation, Inc. |
4 ;; | 4 ;; |
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> | 5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk> |
6 ;; Maintainer: FSF | 6 ;; Maintainer: FSF |
7 ;; Keywords: help, faces | 7 ;; Keywords: help, faces |
8 | 8 |
171 | 171 |
172 :type VALUE should be a widget type for editing the symbols value. | 172 :type VALUE should be a widget type for editing the symbols value. |
173 :options VALUE should be a list of valid members of the widget type. | 173 :options VALUE should be a list of valid members of the widget type. |
174 :group VALUE should be a customization group. | 174 :group VALUE should be a customization group. |
175 Add SYMBOL to that group. | 175 Add SYMBOL to that group. |
176 :link LINK-DATA' | |
177 Include an external link after the documentation string for this | |
178 item. This is a sentence containing an active field which | |
179 references some other documentation. | |
180 | |
181 There are three alternatives you can use for LINK-DATA: | |
182 | |
183 `(custom-manual INFO-NODE)' | |
184 Link to an Info node; INFO-NODE is a string which specifies | |
185 the node name, as in `\"(emacs)Top\"'. The link appears as | |
186 `[manual]' in the customization buffer. | |
187 | |
188 `(info-link INFO-NODE)' | |
189 Like `custom-manual' except that the link appears in the | |
190 customization buffer with the Info node name. | |
191 | |
192 `(url-link URL)' | |
193 Link to a web page; URL is a string which specifies the URL. | |
194 The link appears in the customization buffer as URL. | |
195 | |
196 You can specify the text to use in the customization buffer by | |
197 adding `:tag NAME' after the first element of the LINK-DATA; for | |
198 example, `(info-link :tag \"foo\" \"(emacs)Top\")' makes a link to the | |
199 Emacs manual which appears in the buffer as `foo'. | |
200 | |
201 An item can have more than one external link; however, most items | |
202 have none at all. | |
176 :initialize | 203 :initialize |
177 VALUE should be a function used to initialize the | 204 VALUE should be a function used to initialize the |
178 variable. It takes two arguments, the symbol and value | 205 variable. It takes two arguments, the symbol and value |
179 given in the `defcustom' call. The default is | 206 given in the `defcustom' call. The default is |
180 `custom-initialize-reset'. | 207 `custom-initialize-reset'. |
191 it does (require VALUE) first. | 218 it does (require VALUE) first. |
192 :version | 219 :version |
193 VALUE should be a string specifying that the variable was | 220 VALUE should be a string specifying that the variable was |
194 first introduced, or its default value was changed, in Emacs | 221 first introduced, or its default value was changed, in Emacs |
195 version VERSION. | 222 version VERSION. |
223 :tag LABEL | |
224 Use LABEL, a string, instead of the item's name, to label the item | |
225 a in customization menus and buffers. | |
226 :load FILE | |
227 Load file FILE (a string) before displaying this customization | |
228 item. Loading is done with `load-library', and only if the file is | |
229 not already loaded. | |
196 :set-after VARIABLE | 230 :set-after VARIABLE |
197 Specifies that SYMBOL should be set after VARIABLE when | 231 Specifies that SYMBOL should be set after VARIABLE when |
198 both have been customized. | 232 both have been customized. |
199 | 233 |
200 Read the section about customization in the Emacs Lisp manual for more | 234 Read the section about customization in the Emacs Lisp manual for more |