Each Emacs Lisp package should have one main customization group which contains all the options, faces and other groups in the package. If the package has a small number of options and faces, use just one group and put everything in it. When there are more than twelve or so options and faces, then you should structure them into subgroups, and put the subgroups under the package's main customization group. It is ok to have some of the options and faces in the package's main group alongside the subgroups.
The package's main or only group should be a member of one or more of
the standard customization groups. Type press C-h p to display a
list of finder keywords; them choose some of them add your group to each
of them, using the :group
keyword.
The way to declare new customization groups is with defgroup
.
The arguments members can be an alist whose elements specify
members of the group; however, normally members is nil
, and
you specify the group's members by using the :group
keyword when
defining those members.
In addition to the common keywords (see section Common Keywords for All Kinds of Items), you can
use this keyword in defgroup
:
:prefix prefix
The :prefix
feature is currently turned off, which means that
:prefix
currently has no effect. We did this because we found
that discarding the specified prefixes often led to confusing names for
options. This happened because the people who wrote the defgroup
definitions for various groups added :prefix
keywords whenever
they make logical sense--that is, whenever they say that there was a
common prefix for the option names in a library.
In order to obtain good results with :prefix
, it is necessary to
check the specific effects of discarding a particular prefix, given the
specific items in a group and their names and documentation. If the
resulting text is not clear, then :prefix
should not be used in
that case.
It should be possible to recheck all the customization groups, delete
the :prefix
specifications which give unclear results, and then
turn this feature back on, if someone would like to do the work.
Go to the first, previous, next, last section, table of contents.