xemacs-beta: man/custom.texi comparison

comparison man/custom.texi @ 153:25f70ba0133c r20-3b3

Import from CVS: tag r20-3b3

author	cvs
date	Mon, 13 Aug 2007 09:38:25 +0200
parents	538048ae2ab8
children	43dd3413c7c7

comparison

equal deleted inserted replaced

-:4c132ee2d62b
+:25f70ba0133c
 @node Top, Introduction, (dir), (dir)
 @comment  node-name,  next,  previous,  up
 @top The Customization Library
-Version: 1.97
+Version: 1.98
 @menu
 * Introduction::
 * User Commands::
 * The Customization Buffer::
 This library allows customization of @dfn{user options}.  Currently two
 types of user options are supported, namely @dfn{variables} and
 @dfn{faces}.  Each user option can have four different values
 simultaneously:
 @table @dfn
-@item factory setting
+@item standard setting
 The value specified by the programmer.
 @item saved value
 The value saved by the user as the default for this variable.  This
-overwrites the factory setting when starting a new emacs.
+overwrites the standard setting when starting a new emacs.
 @item current value
 The value used by Emacs.  This will not be remembered next time you
 run Emacs.
 @item widget value
 The value entered by the user in a customization buffer, but not yet
 The following commands will create a customization buffer:
 @table @code
 @item customize
-Create a customization buffer containing a specific group, by default
+Create a customization buffer containing the @code{emacs} group.
-the @code{emacs} group.
+@item customize-group
+Create a customization buffer containing a specific group.
 @item customize-variable
 Create a customization buffer containing a single variable.
 @item customize-face
 customization options, and a line of customization buttons.  Each part
 will be described in the following.
 @menu
 * The Introductory Text::
+* The Customization Buttons::
 * The Customization Options::
 * The Variable Options::
 * The Face Options::
 * The Group Options::
 * The State Button::
-* The Customization Buttons::
 @end menu
-@node  The Introductory Text, The Customization Options, The Customization Buffer, The Customization Buffer
+@node  The Introductory Text, The Customization Buttons, The Customization Buffer, The Customization Buffer
 @comment  node-name,  next,  previous,  up
 @subsection  The Introductory Text
 The start of the buffer contains a short explanation of what it is, and
 how to get help.  It will typically look like this:
 Rather boring.  It is mostly just informative text, but the word
 @samp{help} is a button that will bring up this document when
 activated.
-@node  The Customization Options, The Variable Options, The Introductory Text, The Customization Buffer
+@node  The Customization Buttons, The Customization Options, The Introductory Text, The Customization Buffer
+@comment  node-name,  next,  previous,  up
+@subsection The Customization Buttons
+The next part of the customization buffer looks like this:
+@example
+[Set] [Save] [Reset] [Done]
+@end example
+Activating the @samp{[Set]}, @samp{[Save]}, or @samp{[Reset]}
+button will affect all modified customization items that are visible in
+the buffer.  @samp{[Done]} will bury the buffer.
+@node  The Customization Options, The Variable Options, The Customization Buttons, The Customization Buffer
 @comment  node-name,  next,  previous,  up
 @subsection The Customization Options
 Each customization option looks similar to the following text:
 @example
-*** custom-background-mode: default
+Custom Background Mode: default
-State: this item is unchanged from its factory setting.
+State: this item is unchanged from its standard setting.
-[ ] [?] The brightness of the background.
+[?] The brightness of the background.
 @end example
 The option contains the parts described below.
 @table @samp
-@item ***
+@item Custom Background Mode
-The Level Button.  The customization options in the buffer are organized
-in a hierarchy, which is indicated by the number of stars in the level
-button.  The top level options will be shown as @samp{*}.  When they are
-expanded, the suboptions will be shown as @samp{**}.  The example option
-is thus a subsuboption.
-Activating the level buttons will toggle between hiding and exposing the
-content of that option.  The content can either be the value of the
-option, as in this example, or a list of suboptions.
-@item custom-background-mode
 This is the tag of the the option.  The tag is a name of a variable, a
 face, or customization group.  Activating the tag has an effect that
 depends on the exact type of the option.  In this particular case,
 activating the tag will bring up a menu that will allow you to choose
 from the three possible values of the `custom-background-mode'
 After the tag, the options value is shown.  Depending on its type, you
 may be able to edit the value directly.  If an option should contain a
 file name, it is displayed in an editable field, i.e. you can edit it
 using the standard emacs editing commands.
-@item State: this item is unchanged from its factory setting.
+@item State: this item is unchanged from its standard setting.
 The state line.  This line will explain the state of the option,
 e.g. whether it is currently hidden, or whether it has been modified or
 not.  Activating the button will allow you to change the state, e.g. set
 or reset the changes you have made.  This is explained in detail in the
 following sections.
-@item [ ]
-The magic button.  This is an abbreviated version of the state line.
 @item [?]
 The documentation button.  If the documentation is more than one line,
 this button will be present.  Activating the button will toggle whether
 the complete documentation is shown, or only the first line.
 You can either choose to edit the value directly, or edit the lisp
 value for that variable.  The lisp value is a lisp expression that
 will be evaluated when you start emacs.  The result of the evaluation
 will be used as the initial value for that variable.  Editing the
 lisp value is for experts only, but if the current value of the
-variable is of a wrong type (i.e. a symbol where a string is expected),
+variable is of a wrong type (e.g. a symbol where a string is expected),
 the `edit lisp' mode will always be selected.
 You can see what mode is currently selected by looking at the state
-button.  If it uses parenthesises (like @samp{( )}) it is in edit lisp
+description.  It will end with @samp{(lisp)} in lisp mode.
-mode, with square brackets (like @samp{[ ]}) it is normal edit mode.
 You can switch mode by activating the state button, and select either
 @samp{Edit} or @samp{Edit lisp} from the menu.
 You can change the state of the variable with the other menu items:
 @item Reset to Saved
 Activating this item will reset the value of the variable to the last
 value you marked as permanent with `Save'.
-@item Reset to Factory Settings
+@item Reset to Standard Settings
 Activating this item will undo all modifications you have made, and
 reset the value to the initial value specified by the program itself.
 @end table
-By default, the value of large or complicated variables are hidden.   You
+By default, the value of large or complicated variables are hidden.
-can show the value by clicking on the level button.
+You can change this with the @samp{Hide} and @samp{Show} entries in the
+state menu.
 @node  The Face Options, The Group Options, The Variable Options, The Customization Buffer
 @comment  node-name,  next,  previous,  up
 @subsection The Face Options
 face attributes.  For each face attribute, there is a checkbox
 specifying whether this attribute has effect and what the value is.
 Here is an example:
 @example
-*** custom-invalid-face: (sample)
+Custom Invalid Face: (sample)
-State: this item is unchanged from its factory setting.
+State: this item is unchanged from its standard setting.
-[ ] Face used when the customize item is invalid.
+Face used when the customize item is invalid.
 [INS] [DEL] Display: [ ] Type: [ ] X [ ] PM [ ] Win32 [ ] DOS [ ] TTY
 [X] Class: [X] Color [ ] Grayscale [ ] Monochrome
 [ ] Background: [ ] Light [ ] Dark
 Attributes: [ ] Bold: off
 [ ] Italic: off
 @end example
 This has two display specifications.  The first will match all color
 displays, independently on what window system the device belongs to, and
 whether background color is dark or light.  For devices matching this
-specification, @samp{custom-invalid-face} will force text to be
+specification, @samp{Custom Invalid Face} will force text to be
 displayed in yellow on red, but leave all other attributes alone.
 The second display will simply match everything.  Since the list is
 prioritised, this means that it will match all non-color displays.  For
 these, the face will not affect the foreground or background color, but
 After modifying the face, you can activate the state button to make the
 changes take effect.  The menu items in the state button menu is similar
 to the state menu items for variables described in the previous section.
+Faces usually start out hidden, activate the @samp{State} button to show
+them.
 @node  The Group Options, The State Button, The Face Options, The Customization Buffer
 @comment  node-name,  next,  previous,  up
 @subsection The Group Options
 Since Emacs has approximately a zillion configuration options, they have
 been organized in groups.  Each group can contain other groups, thus
 creating a customization hierarchy.  The nesting of the customization
 within the visible part of this hierarchy is indicated by the number of
-stars in the level button.
+asterisks before the name of the group.
 Since there is really no customization needed for the group itself, the
 menu items in the groups state button will affect all modified group
 members recursively.  Thus, if you activate the @samp{Set} menu item,
 all variables and faces that have been modified and belong to that group
 will be applied.  For those members that themselves are groups, it will
 work as if you had activated the @samp{Set} menu item on them as well.
-@node  The State Button, The Customization Buttons, The Group Options, The Customization Buffer
+@node  The State Button,  , The Group Options, The Customization Buffer
 @comment  node-name,  next,  previous,  up
 @subsection The State Line and The Magic Button
 The state line has two purposes.  The first is to hold the state menu,
 as described in the previous sections.  The second is to indicate the
 state of each customization item.
-For the magic button, this is done by the character inside the brackets.
+There is an optional `magic button' that holds the same information in a
+more compact form.  The magic button contain a character inside the
+brackets (in edit mode) or parentheses (in lisp mode).
+@defopt custom-magic-show-button
+Show a magic button indicating the state of each customization option.
+@end defopt
 The following states have been defined, the first that applies to the
 current item will be used:
 @table @samp
 @item -
 @item :
 The current value of this option is different from the saved value.
 @item !
-The saved value of this option is different from the factory setting.
+The saved value of this option is different from the standard setting.
 @item @@
-The factory setting of this option is not known.  This occurs when you
+The standard setting of this option is not known.  This occurs when you
 try to customize variables or faces that have not been explicitly
 declared as customizable.
 @item SPC
-The factory setting is still in effect.
+The standard setting is still in effect.
 @end table
 For non-hidden group options, the state shown is the most severe state
 of its members, where more severe means that it appears earlier in the
 list above (except hidden members, which are ignored).
-@node  The Customization Buttons,  , The State Button, The Customization Buffer
-@comment  node-name,  next,  previous,  up
-@subsection The Customization Buttons
-The last part of the customization buffer looks like this:
-@example
-[Set] [Save] [Reset] [Done]
-@end example
-Activating the @samp{[Set]}, @samp{[Save]}, or @samp{[Reset]}
-button will affect all modified customization items that are visible in
-the buffer.  @samp{[Done]} will bury the buffer.
 @node   Declarations, Utilities, The Customization Buffer, Top
 @comment  node-name,  next,  previous,  up
 @section Declarations
 @xref{Sexp Types,,,widget,The Widget Library}, for information about
 widgets to use together with the @code{:type} keyword.
 @end defun
 Internally, custom uses the symbol property @code{custom-type} to keep
-track of the variables type, @code{factory-value} for the program
+track of the variables type, @code{standard-value} for the program
 specified default value, @code{saved-value} for a value saved by the
 user, and @code{variable-documentation} for the documentation string.
 Use @code{custom-add-option} to specify that a specific function is
 useful as an meber of a hook.
 @var{spec} should be an alist of the form @samp{((@var{display} @var{atts})...)}.
 @var{atts} is a list of face attributes and their values.  The possible
 attributes are defined in the variable `custom-face-attributes'.
-Alternatively, @var{atts} can be a face in which case the attributes of
-that face is used.
 The @var{atts} of the first entry in @var{spec} where the @var{display}
 matches the frame should take effect in that frame.  @var{display} can
 either be the symbol `t', which will match all frames, or an alist of
 the form @samp{((@var{req} @var{item}...)...)}@refill
 @code{custom-save-customized} is called.
 @item
 Better handling of saved but uninitialized items.
+@item
+Detect when faces have been changed outside customize.
+@item
+Activate mouse help in Emacs by default.
+@item
+Group members should be sorted, groups last.
+@item
+Add an easy way to display the standard settings when an item is modified.
 @end itemize
 @contents
 @bye

Mercurial > hg > xemacs-beta

comparison man/custom.texi @ 153:25f70ba0133c r20-3b3