"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "man/custom.texi" between
xemacs-21.4.22.tar.gz and xemacs-21.4.24.tar.bz2

About: XEmacs (an alternative to GNU Emacs) is a highly customizable open source text editor and application development system (current version).

custom.texi  (xemacs-21.4.22):custom.texi  (xemacs-21.4.24.tar.bz2)
skipping to change at line 63 skipping to change at line 63
present in @code{load-history}, or a symbol which will be loaded with present in @code{load-history}, or a symbol which will be loaded with
@code{require}. @code{require}.
@item :tag @item :tag
@var{Value} should be a short string used for identifying the option in @var{Value} should be a short string used for identifying the option in
customization menus and buffers. By default the tag will be customization menus and buffers. By default the tag will be
automatically created from the options name. automatically created from the options name.
@end table @end table
@node Declaring Groups, Declaring Variables, Top, Top @node Declaring Groups, Declaring Variables, Top, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section Declaring Groups @chapter Declaring Groups
Use @code{defgroup} to declare new customization groups. Use @code{defgroup} to declare new customization groups.
@defun defgroup symbol members doc [keyword value]... @defun defgroup symbol members doc [keyword value]...
Declare @var{symbol} as a customization group containing @var{members}. Declare @var{symbol} as a customization group containing @var{members}.
@var{symbol} does not need to be quoted. @var{symbol} does not need to be quoted.
@var{doc} is the group documentation. @var{doc} is the group documentation.
@var{members} should be an alist of the form ((@var{name} @var{members} should be an alist of the form ((@var{name}
skipping to change at line 95 skipping to change at line 95
@table @code @table @code
@item :prefix @item :prefix
@var{value} should be a string. If the string is a prefix for the name @var{value} should be a string. If the string is a prefix for the name
of a member of the group, that prefix will be ignored when creating a of a member of the group, that prefix will be ignored when creating a
tag for that member. tag for that member.
@end table @end table
@end defun @end defun
@node Declaring Variables, Declaring Faces, Declaring Groups, Top @node Declaring Variables, Declaring Faces, Declaring Groups, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section Declaring Variables @chapter Declaring Variables
Use @code{defcustom} to declare user editable variables. Use @code{defcustom} to declare user editable variables.
@defun defcustom symbol value doc [keyword value]... @defun defcustom symbol value doc [keyword value]...
Declare @var{symbol} as a customizable variable that defaults to @var{value}. Declare @var{symbol} as a customizable variable that defaults to @var{value}.
Neither @var{symbol} nor @var{value} needs to be quoted. Neither @var{symbol} nor @var{value} needs to be quoted.
If @var{symbol} is not already bound, initialize it to @var{value}. If @var{symbol} is not already bound, initialize it to @var{value}.
@var{doc} is the variable documentation. @var{doc} is the variable documentation.
skipping to change at line 179 skipping to change at line 179
@defun custom-add-option symbol option @defun custom-add-option symbol option
To the variable @var{symbol} add @var{option}. To the variable @var{symbol} add @var{option}.
If @var{symbol} is a hook variable, @var{option} should be a hook If @var{symbol} is a hook variable, @var{option} should be a hook
member. For other types of variables, the effect is undefined." member. For other types of variables, the effect is undefined."
@end defun @end defun
@node Declaring Faces, Usage for Package Authors, Declaring Variables, Top @node Declaring Faces, Usage for Package Authors, Declaring Variables, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section Declaring Faces @chapter Declaring Faces
Faces are declared with @code{defface}. Faces are declared with @code{defface}.
@defun defface face spec doc [keyword value]... @defun defface face spec doc [keyword value]...
Declare @var{face} as a customizable face that defaults to @var{spec}. Declare @var{face} as a customizable face that defaults to @var{spec}.
@var{face} does not need to be quoted. @var{face} does not need to be quoted.
If @var{face} has been set with `custom-set-face', set the face attributes If @var{face} has been set with `custom-set-face', set the face attributes
as specified by that function, otherwise set the face attributes as specified by that function, otherwise set the face attributes
skipping to change at line 231 skipping to change at line 231
Internally, custom uses the symbol property @code{face-defface-spec} for Internally, custom uses the symbol property @code{face-defface-spec} for
the program specified default face properties, @code{saved-face} for the program specified default face properties, @code{saved-face} for
properties saved by the user, and @code{face-documentation} for the properties saved by the user, and @code{face-documentation} for the
documentation string.@refill documentation string.@refill
@end defun @end defun
@node Usage for Package Authors, Utilities, Declaring Faces, Top @node Usage for Package Authors, Utilities, Declaring Faces, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section Usage for Package Authors @chapter Usage for Package Authors
The recommended usage for the author of a typical emacs lisp package is The recommended usage for the author of a typical emacs lisp package is
to create one group identifying the package, and make all user options to create one group identifying the package, and make all user options
and faces members of that group. If the package has more than around 20 and faces members of that group. If the package has more than around 20
such options, they should be divided into a number of subgroups, with such options, they should be divided into a number of subgroups, with
each subgroup being member of the top level group. each subgroup being member of the top level group.
The top level group for the package should itself be member of one or The top level group for the package should itself be member of one or
more of the standard customization groups. There exists a group for more of the standard customization groups. There exists a group for
each @emph{finder} keyword. Press @kbd{C-h p} to see a list of finder each @emph{finder} keyword. Press @kbd{C-h p} to see a list of finder
keywords, and add you group to each of them, using the @code{:group} keywords, and add you group to each of them, using the @code{:group}
keyword. keyword.
@node Utilities, The Init File, Usage for Package Authors, Top @node Utilities, The Init File, Usage for Package Authors, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section Utilities @chapter Utilities
These utilities can come in handy when adding customization support. These utilities can come in handy when adding customization support.
@deffn Widget custom-manual @deffn Widget custom-manual
Widget type for specifying the info manual entry for a customization Widget type for specifying the info manual entry for a customization
option. It takes one argument, an info address. option. It takes one argument, an info address.
@end deffn @end deffn
@defun custom-add-to-group group member widget @defun custom-add-to-group group member widget
To existing @var{group} add a new @var{member} of type @var{widget}, To existing @var{group} add a new @var{member} of type @var{widget},
skipping to change at line 279 skipping to change at line 279
@defun customize-menu-create symbol &optional name @defun customize-menu-create symbol &optional name
Create menu for customization group @var{symbol}. Create menu for customization group @var{symbol}.
If optional @var{name} is given, use that as the name of the menu. If optional @var{name} is given, use that as the name of the menu.
Otherwise the menu will be named `Customize'. Otherwise the menu will be named `Customize'.
The menu is in a format applicable to @code{easy-menu-define}. The menu is in a format applicable to @code{easy-menu-define}.
@end defun @end defun
@node The Init File, Wishlist, Utilities, Top @node The Init File, Wishlist, Utilities, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section The Init File @chapter The Init File
Customizations are saved to the file specified by @code{custom-file}, as Customizations are saved to the file specified by @code{custom-file}, as
calls to @code{custom-set-variables} and @code{custom-set-faces}. calls to @code{custom-set-variables} and @code{custom-set-faces}.
When you save customizations, the current implementation removes the When you save customizations, the current implementation removes the
calls to @code{custom-set-variables} and @code{custom-set-faces}, and calls to @code{custom-set-variables} and @code{custom-set-faces}, and
replaces them with code generated on the basis of the current replaces them with code generated on the basis of the current
customization state in Emacs. customization state in Emacs.
By default @code{custom-file} is your @file{.emacs} file (for GNU Emacs By default @code{custom-file} is your @file{.emacs} file (for GNU Emacs
skipping to change at line 302 skipping to change at line 302
must explicitly load it yourself. must explicitly load it yourself.
As of XEmacs 21.4.7, when @code{custom-file} is present, it is loaded As of XEmacs 21.4.7, when @code{custom-file} is present, it is loaded
@emph{after} @file{init.el}. This is likely to change in the future, @emph{after} @file{init.el}. This is likely to change in the future,
because (1) actions in @file{init.el} often would like to depend on because (1) actions in @file{init.el} often would like to depend on
customizations for consistent appearance and (2) Custom is quite brutal customizations for consistent appearance and (2) Custom is quite brutal
about enforcing its idea of the correct values at initialization. about enforcing its idea of the correct values at initialization.
@node Wishlist, , The Init File, Top @node Wishlist, , The Init File, Top
@comment node-name, next, previous, up @comment node-name, next, previous, up
@section Wishlist @chapter Wishlist
@itemize @bullet @itemize @bullet
@item @item
Better support for keyboard operations in the customize buffer. Better support for keyboard operations in the customize buffer.
@item @item
Integrate with @file{w3} so you can get customization buffers with much Integrate with @file{w3} so you can get customization buffers with much
better formatting. I'm thinking about adding a <custom>name</custom> better formatting. I'm thinking about adding a <custom>name</custom>
tag. The latest w3 have some support for this, so come up with a tag. The latest w3 have some support for this, so come up with a
convincing example. convincing example.
 End of changes. 7 change blocks. 
7 lines changed or deleted 7 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)