Mercurial > emacs
changeset 60499:a33defc96586
(Common Keywords): Clarify :require. Mention :version here.
(Variable Definitions, Group Definitions): Not here.
(Variable Definitions): Clarify symbol arg to :initialize and :set fns.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 08 Mar 2005 03:06:04 +0000 |
parents | f779a0469755 |
children | 718a981b5dd3 |
files | lispref/customize.texi |
diffstat | 1 files changed, 20 insertions(+), 37 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/customize.texi Tue Mar 08 03:04:48 2005 +0000 +++ b/lispref/customize.texi Tue Mar 08 03:06:04 2005 +0000 @@ -84,13 +84,17 @@ not already loaded. @item :require @var{feature} -Require feature @var{feature} (a symbol) when installing a value for -this item (an option or a face) that was saved using the customization -feature. This is done by calling @code{require}. +Execute @code{(require '@var{feature})} when your saved customizations +set the value of this item. @var{feature} should be a symbol. The most common reason to use @code{:require} is when a variable enables a feature such as a minor mode, and just setting the variable won't have any effect unless the code which implements the mode is loaded. + +@item :version @var{version} +This option specifies that the item was first introduced in Emacs +version @var{version}, or that its default value was changed in that +version. The value @var{version} must be a string. @end table @node Group Definitions @@ -130,17 +134,9 @@ Useful widgets are @code{custom-variable} for a variable, @code{custom-face} for a face, and @code{custom-group} for a group. -When a new group is introduced into Emacs, use this keyword in -@code{defgroup}: - -@table @code -@item :version @var{version} -This option specifies that the group was first introduced in Emacs -version @var{version}. The value @var{version} must be a string. -@end table - -Tag the group with a version like this when it is introduced, rather -than the individual members (@pxref{Variable Definitions}). +When you introduce a new group into Emacs, use the @code{:version} +keyword in the @code{defgroup}; then you need not use it for +the individual members of the group. In addition to the common keywords (@pxref{Common Keywords}), you can also use this keyword in @code{defgroup}: @@ -223,26 +219,13 @@ @code{hook}, @code{plist} and @code{alist}. See the definition of the individual types for a description of how to use @code{:options}. -@item :version @var{version} -This option specifies that the variable was first introduced, or its -default value was changed, in Emacs version @var{version}. The value -@var{version} must be a string. For example, - -@example -(defcustom foo-max 34 - "*Maximum number of foo's allowed." - :type 'integer - :group 'foo - :version "20.3") -@end example - @item :set @var{setfunction} -Specify @var{setfunction} as the way to change the value of this option. -The function @var{setfunction} should take two arguments, a symbol and -the new value, and should do whatever is necessary to update the value -properly for this option (which may not mean simply setting the option -as a Lisp variable). The default for @var{setfunction} is -@code{set-default}. +Specify @var{setfunction} as the way to change the value of this +option. The function @var{setfunction} should take two arguments, a +symbol (the option name) and the new value, and should do whatever is +necessary to update the value properly for this option (which may not +mean simply setting the option as a Lisp variable). The default for +@var{setfunction} is @code{set-default}. @item :get @var{getfunction} Specify @var{getfunction} as the way to extract the value of this @@ -258,10 +241,10 @@ that really is stored in a Lisp variable. @item :initialize @var{function} -@var{function} should be a function used to initialize the variable when -the @code{defcustom} is evaluated. It should take two arguments, the -symbol and value. Here are some predefined functions meant for use in -this way: +@var{function} should be a function used to initialize the variable +when the @code{defcustom} is evaluated. It should take two arguments, +the option name (a symbol) and the value. Here are some predefined +functions meant for use in this way: @table @code @item custom-initialize-set